Skip to content

Commit f960c82

Browse files
tdrueztdruez
committed
Rename views and templates for consistency and clarity
Signed-off-by: tdruez <tdruez@aboutcode.org>
1 parent 7290d35 commit f960c82

11 files changed

Lines changed: 64 additions & 50 deletions

scanpipe/templates/scanpipe/project_dependency_tree.html renamed to scanpipe/templates/scanpipe/dependency_tree.html

File renamed without changes.

‎scanpipe/templates/scanpipe/includes/project_summary_level.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@
7070
{{ project.resource_count|intcomma }}
7171
</a>
7272
{% if project.resource_count > 1 %}
73-
<a href="{% url 'codebase_resource_tree' project.slug %}" class="ml-2">
73+
<a href="{% url 'project_resource_tree' project.slug %}" class="ml-2">
7474
<span class="icon">
7575
<i class="fa-solid fa-folder-tree is-size-6"></i>
7676
</span>

‎scanpipe/templates/scanpipe/panels/project_codebase.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
</span>
2222
{% endif %}
2323
</div>
24-
<a href="{% url 'codebase_resource_tree' project.slug %}" class="ml-2 has-text-white has-text-decoration-none">
24+
<a href="{% url 'project_resource_tree' project.slug %}" class="ml-2 has-text-white has-text-decoration-none">
2525
<i class="fa-solid fa-folder-tree mr-1"></i>Tree view
2626
</a>
2727
</div>

‎scanpipe/templates/scanpipe/resource_list.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
</div>
1818

1919
<div id="resource-list" class="container is-fluid mb-3">
20-
<a href="{% url 'codebase_resource_tree' project.slug %}" class="is-pulled-right">
20+
<a href="{% url 'project_resource_tree' project.slug %}" class="is-pulled-right">
2121
<span class="icon">
2222
<i class="fa-solid fa-folder-tree"></i>
2323
</span>

‎scanpipe/templates/scanpipe/resource_tree.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,19 @@
2121
<div class="resizable-container is-flex">
2222
<div id="left-pane" class="left-pane px-2">
2323
<div id="resource-tree">
24-
{% include "scanpipe/panels/codebase_tree_panel.html" with children=children path=path %}
24+
{% include "scanpipe/tree/resource_left_pane_tree.html" with children=children path=path %}
2525
</div>
2626
</div>
2727
<div id="resizer" class="resizer"></div>
2828
<div id="right-pane" class="right-pane px-3">
2929
{% if path %}
3030
<div
31-
hx-get="{% url 'codebase_resource_table' project.slug %}?path={{ path }}"
31+
hx-get="{% url 'project_resource_tree_table' project.slug %}?path={{ path }}"
3232
hx-trigger="load"
3333
hx-target="this">
3434
</div>
3535
{% else %}
36-
{% include "scanpipe/panels/resource_table_panel.html" %}
36+
{% include "scanpipe/tree/resource_right_pane_table.html" %}
3737
{% endif %}
3838
</div>
3939
</div>

‎scanpipe/templates/scanpipe/tables/project_list_table.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@
5454
{{ project.codebaseresources_count|intcomma }}
5555
</a>
5656
{% if project.codebaseresources_count > 1 %}
57-
<a href="{% url 'codebase_resource_tree' project.slug %}">
57+
<a href="{% url 'project_resource_tree' project.slug %}">
5858
<span class="icon">
5959
<i class="fa-solid fa-folder-tree fa-sm"></i>
6060
</span>

scanpipe/templates/scanpipe/panels/codebase_tree_panel.html renamed to scanpipe/templates/scanpipe/tree/resource_left_pane_tree.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22
{% for node in children %}
33
<li>
44
{% if node.is_dir %}
5-
<div class="tree-node is-flex is-align-items-center px-1" data-folder data-path="{{ node.path }}"{% if node.has_children %} data-target="{{ node.path|slugify }}" data-url="{% url 'codebase_resource_tree' slug=project.slug %}?path={{ node.path }}"{% endif %}>
5+
<div class="tree-node is-flex is-align-items-center px-1" data-folder data-path="{{ node.path }}"{% if node.has_children %} data-target="{{ node.path|slugify }}" data-url="{% url 'project_resource_tree' slug=project.slug %}?path={{ node.path }}"{% endif %}>
66
<span class="icon is-small chevron mr-1{% if not node.has_children %} is-invisible{% endif %} is-clickable is-flex is-align-items-center" data-chevron>
77
<i class="fas fa-chevron-right"></i>
88
</span>
99
<span
1010
class="is-flex is-align-items-center folder-meta is-clickable"
1111
data-folder-click
1212
data-path="{{ node.path }}"
13-
hx-get="{% url 'codebase_resource_table' project.slug %}?path={{ node.path }}"
13+
hx-get="{% url 'project_resource_tree_table' project.slug %}?path={{ node.path }}"
1414
hx-target="#right-pane"
15-
hx-push-url="{% url 'codebase_resource_tree' project.slug %}?path={{ node.path }}">
15+
hx-push-url="{% url 'project_resource_tree' project.slug %}?path={{ node.path }}">
1616
<span class="icon is-small mr-2">
1717
<i class="fas fa-folder"></i>
1818
</span>
@@ -29,7 +29,7 @@
2929
data-path="{{ node.path }}"
3030
hx-get="{% url 'resource_detail' project.slug node.path %}"
3131
hx-target="#right-pane-content"
32-
hx-push-url="{% url 'codebase_resource_tree' project.slug %}?path={{ node.path }}">
32+
hx-push-url="{% url 'project_resource_tree' project.slug %}?path={{ node.path }}">
3333
<span class="icon is-small mr-2">
3434
<i class="far fa-file"></i>
3535
</span>

scanpipe/templates/scanpipe/panels/resource_table_panel.html renamed to scanpipe/templates/scanpipe/tree/resource_right_pane_table.html

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@
1010
{% endif %}
1111
{% if not forloop.last %}
1212
<a
13-
href="{% url 'codebase_resource_tree' project.slug %}?path={{ subpath }}"
13+
href="{% url 'project_resource_tree' project.slug %}?path={{ subpath }}"
1414
class="expand-in-tree"
1515
data-path="{{ subpath }}"
16-
hx-get="{% url 'codebase_resource_table' project.slug %}?path={{ subpath }}"
16+
hx-get="{% url 'project_resource_tree_table' project.slug %}?path={{ subpath }}"
1717
hx-target="#right-pane"
18-
hx-push-url="{% url 'codebase_resource_tree' project.slug %}?path={{ subpath }}"
18+
hx-push-url="{% url 'project_resource_tree' project.slug %}?path={{ subpath }}"
1919
{# WARNING: spaceless is not working properly so keep the label without spaces #}
2020
>{{ segment }}</a>
2121
{% else %}
@@ -48,9 +48,9 @@
4848
<tr
4949
class="expand-in-tree is-clickable"
5050
data-path="{{ parent_path }}"
51-
hx-get="{% url 'codebase_resource_table' project.slug %}{% if parent_path %}?path={{ parent_path }}{% endif %}"
51+
hx-get="{% url 'project_resource_tree_table' project.slug %}{% if parent_path %}?path={{ parent_path }}{% endif %}"
5252
hx-target="#right-pane"
53-
hx-push-url="{% url 'codebase_resource_tree' project.slug %}{% if parent_path %}?path={{ parent_path }}{% endif %}">
53+
hx-push-url="{% url 'project_resource_tree' project.slug %}{% if parent_path %}?path={{ parent_path }}{% endif %}">
5454
<td colspan="5">
5555
<div class="is-flex is-align-items-center">
5656
<span class="icon is-small mr-2">
@@ -75,19 +75,19 @@
7575
{% if resource.is_dir %}
7676
<a
7777
class="expand-in-tree"
78-
href="{% url 'codebase_resource_tree' project.slug %}?path={{ resource.path }}"
78+
href="{% url 'project_resource_tree' project.slug %}?path={{ resource.path }}"
7979
data-path="{{ resource.path }}"
80-
hx-get="{% url 'codebase_resource_table' project.slug %}?path={{ resource.path }}"
80+
hx-get="{% url 'project_resource_tree_table' project.slug %}?path={{ resource.path }}"
8181
hx-target="#right-pane"
82-
hx-push-url="{% url 'codebase_resource_tree' project.slug %}?path={{ resource.path }}">
82+
hx-push-url="{% url 'project_resource_tree' project.slug %}?path={{ resource.path }}">
8383
{{ resource.name }}
8484
</a>
8585
{% else %}
8686
<a
8787
href="{% url 'resource_detail' project.slug resource.path %}"
8888
hx-get="{% url 'resource_detail' project.slug resource.path %}"
8989
hx-target="#right-pane-content"
90-
hx-push-url="{% url 'codebase_resource_tree' project.slug %}?path={{ resource.path }}">
90+
hx-push-url="{% url 'project_resource_tree' project.slug %}?path={{ resource.path }}">
9191
{{ resource.name }}
9292
</a>
9393
{% endif %}
@@ -118,18 +118,18 @@
118118
{% if page_obj.has_previous %}
119119
<a
120120
class="pagination-previous"
121-
hx-get="{% url 'codebase_resource_table' project.slug %}?path={{ path }}&page={{ page_obj.previous_page_number }}"
121+
hx-get="{% url 'project_resource_tree_table' project.slug %}?path={{ path }}&page={{ page_obj.previous_page_number }}"
122122
hx-target="#right-pane"
123-
hx-push-url="{% url 'codebase_resource_tree' project.slug %}?path={{ path }}&page={{ page_obj.previous_page_number }}">
123+
hx-push-url="{% url 'project_resource_tree' project.slug %}?path={{ path }}&page={{ page_obj.previous_page_number }}">
124124
Previous
125125
</a>
126126
{% endif %}
127127
{% if page_obj.has_next %}
128128
<a
129129
class="pagination-next"
130-
hx-get="{% url 'codebase_resource_table' project.slug %}?path={{ path }}&page={{ page_obj.next_page_number }}"
130+
hx-get="{% url 'project_resource_tree_table' project.slug %}?path={{ path }}&page={{ page_obj.next_page_number }}"
131131
hx-target="#right-pane"
132-
hx-push-url="{% url 'codebase_resource_tree' project.slug %}?path={{ path }}&page={{ page_obj.next_page_number }}">
132+
hx-push-url="{% url 'project_resource_tree' project.slug %}?path={{ path }}&page={{ page_obj.next_page_number }}">
133133
Next page
134134
</a>
135135
{% endif %}

‎scanpipe/tests/test_views.py‎

Lines changed: 27 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1636,7 +1636,7 @@ def test_scanpipe_views_resource_tree_root_path(self):
16361636
make_resource_file(self.project1, path="child1.txt")
16371637
make_resource_file(self.project1, path="dir1")
16381638

1639-
url = reverse("codebase_resource_tree", kwargs={"slug": self.project1.slug})
1639+
url = reverse("project_resource_tree", kwargs={"slug": self.project1.slug})
16401640
response = self.client.get(url)
16411641
children = response.context["children"]
16421642
child1 = children[0]
@@ -1650,7 +1650,7 @@ def test_scanpipe_views_resource_tree_children_path(self):
16501650
make_resource_file(self.project1, path="parent/dir1")
16511651
make_resource_file(self.project1, path="parent/dir1/child2.txt")
16521652

1653-
url = reverse("codebase_resource_tree", kwargs={"slug": self.project1.slug})
1653+
url = reverse("project_resource_tree", kwargs={"slug": self.project1.slug})
16541654
response = self.client.get(url + "?path=parent&tree_panel=true")
16551655
children = response.context["children"]
16561656

@@ -1663,12 +1663,14 @@ def test_scanpipe_views_resource_tree_children_path(self):
16631663
self.assertFalse(child1.has_children)
16641664
self.assertTrue(dir1.has_children)
16651665

1666-
def test_scanpipe_views_codebase_resource_table_view_with_path_directory(self):
1666+
def test_scanpipe_views_project_resource_tree_table_view_with_path_directory(self):
16671667
make_resource_directory(self.project1, path="parent")
16681668
make_resource_file(self.project1, path="parent/child1.txt")
16691669
make_resource_file(self.project1, path="parent/child2.py")
16701670

1671-
url = reverse("codebase_resource_table", kwargs={"slug": self.project1.slug})
1671+
url = reverse(
1672+
"project_resource_tree_table", kwargs={"slug": self.project1.slug}
1673+
)
16721674
response = self.client.get(url + "?path=parent")
16731675

16741676
self.assertEqual(200, response.status_code)
@@ -1679,10 +1681,12 @@ def test_scanpipe_views_codebase_resource_table_view_with_path_directory(self):
16791681
resource_paths = [r.path for r in resources]
16801682
self.assertEqual(["parent/child1.txt", "parent/child2.py"], resource_paths)
16811683

1682-
def test_scanpipe_views_codebase_resource_table_view_with_path_file(self):
1684+
def test_scanpipe_views_project_resource_tree_table_view_with_path_file(self):
16831685
make_resource_file(self.project1, path="specific_file.txt")
16841686

1685-
url = reverse("codebase_resource_table", kwargs={"slug": self.project1.slug})
1687+
url = reverse(
1688+
"project_resource_tree_table", kwargs={"slug": self.project1.slug}
1689+
)
16861690
response = self.client.get(url + "?path=specific_file.txt")
16871691

16881692
self.assertEqual(200, response.status_code)
@@ -1691,23 +1695,27 @@ def test_scanpipe_views_codebase_resource_table_view_with_path_file(self):
16911695
self.assertEqual(1, len(resources))
16921696
self.assertEqual("specific_file.txt", resources[0].path)
16931697

1694-
def test_scanpipe_views_codebase_resource_table_view_empty_directory(self):
1698+
def test_scanpipe_views_project_resource_tree_table_view_empty_directory(self):
16951699
make_resource_directory(self.project1, path="empty_dir")
16961700

1697-
url = reverse("codebase_resource_table", kwargs={"slug": self.project1.slug})
1701+
url = reverse(
1702+
"project_resource_tree_table", kwargs={"slug": self.project1.slug}
1703+
)
16981704
response = self.client.get(url + "?path=empty_dir")
16991705

17001706
self.assertEqual(200, response.status_code)
17011707
self.assertEqual("empty_dir", response.context["path"])
17021708
resources = list(response.context["resources"])
17031709
self.assertEqual(0, len(resources))
17041710

1705-
def test_scanpipe_views_codebase_resource_table_view_with_packages(self):
1711+
def test_scanpipe_views_project_resource_tree_table_view_with_packages(self):
17061712
resource1 = make_resource_file(self.project1, path="file_with_package.txt")
17071713
package1 = DiscoveredPackage.create_from_data(self.project1, package_data1)
17081714
package1.add_resources([resource1])
17091715

1710-
url = reverse("codebase_resource_table", kwargs={"slug": self.project1.slug})
1716+
url = reverse(
1717+
"project_resource_tree_table", kwargs={"slug": self.project1.slug}
1718+
)
17111719
response = self.client.get(url + "?path=file_with_package.txt")
17121720

17131721
self.assertEqual(200, response.status_code)
@@ -1717,14 +1725,16 @@ def test_scanpipe_views_codebase_resource_table_view_with_packages(self):
17171725
resource = resources[0]
17181726
self.assertTrue(resource.discovered_packages.exists())
17191727

1720-
@mock.patch("scanpipe.views.CodebaseResourceTableView.paginate_by", 2)
1721-
def test_scanpipe_views_codebase_resource_table_view_pagination(self):
1728+
@mock.patch("scanpipe.views.ProjectResourceTreeTableView.paginate_by", 2)
1729+
def test_scanpipe_views_project_resource_tree_table_view_pagination(self):
17221730
make_resource_directory(self.project1, path="parent")
17231731
make_resource_file(self.project1, path="parent/file1.txt", parent_path="parent")
17241732
make_resource_file(self.project1, path="parent/file2.txt", parent_path="parent")
17251733
make_resource_file(self.project1, path="parent/file3.txt", parent_path="parent")
17261734

1727-
url = reverse("codebase_resource_table", kwargs={"slug": self.project1.slug})
1735+
url = reverse(
1736+
"project_resource_tree_table", kwargs={"slug": self.project1.slug}
1737+
)
17281738

17291739
response = self.client.get(url + "?path=parent")
17301740
self.assertEqual(200, response.status_code)
@@ -1739,7 +1749,7 @@ def test_scanpipe_views_codebase_resource_table_view_pagination(self):
17391749
self.assertFalse(response.context["page_obj"].has_next())
17401750
self.assertTrue(response.context["page_obj"].has_previous())
17411751

1742-
def test_scanpipe_views_codebase_resource_table_view_field_selection(self):
1752+
def test_scanpipe_views_project_resource_tree_table_view_field_selection(self):
17431753
resource = make_resource_file(
17441754
self.project1,
17451755
path="test_file.py",
@@ -1748,7 +1758,9 @@ def test_scanpipe_views_codebase_resource_table_view_field_selection(self):
17481758
detected_license_expression="MIT",
17491759
)
17501760

1751-
url = reverse("codebase_resource_table", kwargs={"slug": self.project1.slug})
1761+
url = reverse(
1762+
"project_resource_tree_table", kwargs={"slug": self.project1.slug}
1763+
)
17521764
response = self.client.get(url + "?path=test_file.py")
17531765

17541766
self.assertEqual(200, response.status_code)

‎scanpipe/urls.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -132,14 +132,14 @@
132132
name="project_codebase",
133133
),
134134
path(
135-
"project/<slug:slug>/codebase_tree/",
136-
views.CodebaseResourceTreeView.as_view(),
137-
name="codebase_resource_tree",
135+
"project/<slug:slug>/resource_tree/",
136+
views.ProjectResourceTreeView.as_view(),
137+
name="project_resource_tree",
138138
),
139139
path(
140-
"project/<slug:slug>/resource_table/",
141-
views.CodebaseResourceTableView.as_view(),
142-
name="codebase_resource_table",
140+
"project/<slug:slug>/resource_tree_table/",
141+
views.ProjectResourceTreeTableView.as_view(),
142+
name="project_resource_tree_table",
143143
),
144144
path(
145145
"run/<uuid:uuid>/",

0 commit comments

Comments
 (0)