Merge pull request #560 from Lexpedite/project_slug

Project slug

Author: Gauntlet173

CHANGELOG.md

@@ -7,6 +7,20 @@ As of v0.2-alpha, this project is attempting to adhere to [Semantic Versioning](
 While alpha, however, any version may include breaking changes that may not be specifically noted as such,
 and breaking changes will not necessarily result in changes to the main version number.
 
+
+## [v1.6.16-alpha](https://github.com/Lexpedite/blawx/releases/tag/v1.6.16-alpha) 2023-06-26
+
+`.blawx` files created in previous versions will work with this version, but **please note that the majority of URLs are now different**.
+
+### Added
+* Projects now have a path slug based on their name, which must be unique per user. The slug can be changed in the admin interface.
+
+### Changed
+* All URLS that previously began with `/{rule_id}/` now start with `/{owner}/{rule_slug}/`
+  For example `/1/test/who_won` would now be `/jason/rock-paper-scissors-act/test/who_won`.
+  This is intended to give some predictability to the location of the API endpoints for a loaded `.blawx` file to simplify development using
+  Blawx as a legal reasoner.
+
 ## [v1.6.15-alpha](https://github.com/Lexpedite/blawx/releases/tag/v1.6.15-alpha) 2023-05-23
 
 ### Added
@@ -15,9 +29,6 @@ and breaking changes will not necessarily result in changes to the main version
 ### Changed
 * Disclaimer has been added to the GCWeb styled version of the scenario editor.
 
-### TODO
-* Update the documentation for the scenario editor.
-
 ## [v1.6.14-alpha](https://github.com/Lexpedite/blawx/releases/tag/v1.6.14-alpha) 2023-05-12
 
 ### Added

blawx/admin.py

@@ -9,7 +9,7 @@ class WorkspaceAdmin(GuardedModelAdmin):
     fields = ['ruledoc','workspace_name','xml_content','scasp_encoding']
 
 class RuleDocAdmin(GuardedModelAdmin):
-    fields = ['ruledoc_name','scasp_encoding','tutorial','akoma_ntoso','rule_text','navtree','owner','published']
+    fields = ['ruledoc_name','rule_slug','scasp_encoding','tutorial','akoma_ntoso','rule_text','navtree','owner','published']
 
 class BlawxTestAdmin(GuardedModelAdmin):
     fields = ['ruledoc','test_name','xml_content','scasp_encoding', 'tutorial', 'view', 'fact_scenario']

blawx/models.py

@@ -6,11 +6,13 @@
 from cobalt.hierarchical import Act
 from clean.clean import generate_akn
 from preferences.models import Preferences
+from django.utils.text import slugify
 
 # Create your models here.
 class RuleDoc(models.Model):
     ruledoc_name = models.CharField(max_length=200)
     rule_text = models.TextField(default="Default Act")
+    rule_slug = models.TextField()
     akoma_ntoso = models.TextField(default="",blank=True)
     navtree = models.TextField(default="",blank=True)
     scasp_encoding = models.TextField(default="",blank=True)
@@ -22,6 +24,9 @@ def __str__(self):
         return self.ruledoc_name
 
     class Meta:
+        constraints = [
+            models.UniqueConstraint(fields=['rule_slug','owner'],name='unique_owner_and_rule_slug')
+        ]
         permissions = [
             ('add_blawxtest_to_ruledoc', 'Can add Test to RuleDoc'),
             ('add_workspace_to_ruledoc', 'Can add Workspace to RuleDoc'),
@@ -31,6 +36,7 @@ class Meta:
 def update_an_nav(sender, instance, **kwargs):
     instance.akoma_ntoso = generate_akn(instance.rule_text)
     instance.navtree = generate_tree(Act(instance.akoma_ntoso).act)
+    instance.rule_slug = slugify(instance.ruledoc_name)
 
 class Workspace(models.Model):
     ruledoc = models.ForeignKey(RuleDoc, related_name='workspaces', on_delete=models.CASCADE)

blawx/reasoner.py

@@ -1,4 +1,5 @@
 from django.http import Http404, HttpResponseNotFound, HttpResponseForbidden
+from django.contrib.auth.models import User
 
 from rest_framework.decorators import api_view, permission_classes, authentication_classes
 from rest_framework.response import Response
@@ -85,9 +86,9 @@ def convertVariables(param):
   else:
     return param
 
-def even_newer_json_2_scasp(payload,ruledoc,testname):
+def even_newer_json_2_scasp(payload,user,rule,testname):
   output = ""
-  ontology = get_ontology_internal(ruledoc,testname)
+  ontology = get_ontology_internal(user,rule,testname)
   # Basically, we need to know what the predicate is, what the parameters are, whether the parameters have category types, and if they are variables.
   # So get the predicate, look up the typing, modify for negation if required, and generate the fact, testing for categories if required.
 
@@ -469,17 +470,18 @@ def format_statement_value(value,attribute_type):
 @api_view(['POST'])
 @authentication_classes([SessionAuthentication])
 @permission_classes([AllowAny])
-def run_test(request,ruledoc,test_name):
+def run_test(request,user,rule,test_name):
     # Get the data (test, facts, and workspaces)
     # ruledoctest = RuleDoc.objects.filter(pk=ruledoc,owner=request.user)
-    test = BlawxTest.objects.get(ruledoc=RuleDoc.objects.get(pk=ruledoc),test_name=test_name)
+    owner = User.objects.get(username=user)
+    test = BlawxTest.objects.get(ruledoc=RuleDoc.objects.get(rule_slug=rule,owner=owner),test_name=test_name)
     if request.user.has_perm('blawx.run',test):
       translated_facts = ""
       if request.data:
-        translated_facts = even_newer_json_2_scasp(request.data,ruledoc,test_name)
+        translated_facts = even_newer_json_2_scasp(request.data,user,rule,test_name)
         # print("Facts Generated for Run Request:\n")
         # print(translated_facts)
-      wss = Workspace.objects.filter(ruledoc=RuleDoc.objects.get(pk=ruledoc))
+      wss = Workspace.objects.filter(ruledoc=RuleDoc.objects.get(rule_slug=rule,owner=owner))
       ruleset = ""
       # for ws in wss:
       #   ruleset += "\n\n" + ws.scasp_encoding
@@ -633,9 +635,10 @@ def run_test(request,ruledoc,test_name):
     else:
       return HttpResponseForbidden()
 
-def get_ontology_internal(ruledoc,test_name):
-    wss = Workspace.objects.filter(ruledoc=RuleDoc.objects.get(pk=ruledoc))
-    test = BlawxTest.objects.get(ruledoc=RuleDoc.objects.get(pk=ruledoc),test_name=test_name)
+def get_ontology_internal(user,rule,test_name):
+    owner = User.objects.get(username=user)
+    wss = Workspace.objects.filter(ruledoc=RuleDoc.objects.get(rule_slug=rule,owner=owner))
+    test = BlawxTest.objects.get(ruledoc=RuleDoc.objects.get(rule_slug=rule,owner=owner),test_name=test_name)
     ruleset = ""
     for ws in wss:
       ruleset += "\n\n" + ws.scasp_encoding
@@ -1011,11 +1014,12 @@ def get_ontology_internal(ruledoc,test_name):
 @api_view(['GET'])
 @authentication_classes([SessionAuthentication])
 @permission_classes([IsAuthenticatedOrReadOnly])
-def get_ontology(request,ruledoc,test_name):
-    ruledoctest = RuleDoc.objects.get(pk=ruledoc)
+def get_ontology(request,user,rule,test_name):
+    owner = User.objects.get(username=user)
+    ruledoctest = RuleDoc.objects.get(rule_slug=rule,owner=owner)
     if request.user.has_perm('blawx.view_ruledoc',ruledoctest):
-      test = BlawxTest.objects.get(ruledoc=ruledoc,test_name=test_name)
-      result = get_ontology_internal(ruledoc,test_name)
+      test = BlawxTest.objects.get(ruledoc=RuleDoc.objects.get(rule_slug=rule,owner=owner),test_name=test_name)
+      result = get_ontology_internal(user,rule,test_name)
       if test.view == "":
         result['View'] = test.view
       else:
@@ -1041,9 +1045,10 @@ def simplify_rule(rule):
 @api_view(['POST'])
 @authentication_classes([SessionAuthentication])
 @permission_classes([AllowAny])
-def interview(request,ruledoc,test_name):
+def interview(request,user,rule,test_name):
     #print("Dealing with interview request.\n")
-    test = BlawxTest.objects.get(ruledoc=RuleDoc.objects.get(pk=ruledoc),test_name=test_name)
+    owner = User.objects.get(username=user)
+    test = BlawxTest.objects.get(ruledoc=RuleDoc.objects.get(rule_slug=rule,owner=owner),test_name=test_name)
     if request.user.has_perm('blawx.run',test):
 
 
@@ -1167,10 +1172,11 @@ def interview(request,ruledoc,test_name):
       # Effectively, we're going to start over.
       translated_facts = ""
       if request.data:
-        translated_facts = even_newer_json_2_scasp(request.data, ruledoc, test_name) #Generate answers INCLUDING assumptions in the submitted data
+        translated_facts = even_newer_json_2_scasp(request.data, user, rule, test_name) #Generate answers INCLUDING assumptions in the submitted data
 
-      wss = Workspace.objects.filter(ruledoc=RuleDoc.objects.get(pk=ruledoc))
-      test = BlawxTest.objects.get(ruledoc=RuleDoc.objects.get(pk=ruledoc),test_name=test_name)
+      owner = User.objects.get(username=user)
+      wss = Workspace.objects.filter(ruledoc=RuleDoc.objects.get(rule_slug=rule,owner=owner))
+      test = BlawxTest.objects.get(ruledoc=RuleDoc.objects.get(rule_slug=rule,owner=owner),test_name=test_name)
       ruleset = ""
       unique_rules = []
       for ws in wss:

blawx/settings.py

@@ -13,7 +13,7 @@
 from pathlib import Path
 
 # For adding a version identifier
-BLAWX_VERSION = "v1.6.15-alpha"
+BLAWX_VERSION = "v1.6.16-alpha"
 
 
 # Build paths inside the project like this: BASE_DIR / 'subdir'.

blawx/templates/blawx/blawx.html

@@ -11,7 +11,7 @@
 <nav aria-label="breadcrumb">
     <ol class="breadcrumb">
         <li class="breadcrumb-item"><i class="bi bi-house pe-2"></i><a href="/">Home</a></li>
-        <li class="breadcrumb-item"><i class="bi bi-journal pe-2"></i><a href="{% url 'ruledoc' ruledoc.id %}">{{ ruledoc.ruledoc_name }}</a></li>
+        <li class="breadcrumb-item"><i class="bi bi-journal pe-2"></i><a href="{% url 'ruledoc' ruledoc.owner ruledoc.rule_slug %}">{{ ruledoc.ruledoc_name }}</a></li>
         <li class="breadcrumb-item">
             <a class="dropdown-toggle" data-bs-toggle="collapse" href="#ruleNav" role="button"
                                                     aria-expanded="false" aria-controls="ruleNav">

blawx/templates/blawx/blawxtest_confirm_delete.html

@@ -4,8 +4,8 @@
 <nav aria-label="breadcrumb">
     <ol class="breadcrumb">
         <li class="breadcrumb-item"><i class="bi bi-house pe-2"></i><a href="/">Home</a></li>
-        <li class="breadcrumb-item"><i class="bi bi-journal pe-2"></i><a href="{% url 'ruledoc' blawxtest.ruledoc.id %}">{{ blawxtest.ruledoc.ruledoc_name }}</a></li>
-        <li class="breadcrumb-item"><i class="bi bi-clipboard-check pe-2"></i><a href="{% url 'test' blawxtest.ruledoc.id  blawxtest.test_name%}">{{ blawxtest.test_name }}</a></li>
+        <li class="breadcrumb-item"><i class="bi bi-journal pe-2"></i><a href="{% url 'ruledoc' blawxtest.ruledoc.owner blawxtest.ruledoc.rule_slug %}">{{ blawxtest.ruledoc.ruledoc_name }}</a></li>
+        <li class="breadcrumb-item"><i class="bi bi-clipboard-check pe-2"></i><a href="{% url 'test' blawxtest.ruledoc.owner blawxtest.ruledoc.rule_slug  blawxtest.test_name%}">{{ blawxtest.test_name }}</a></li>
         <li class="breadcrumb-item"><i class="bi bi-pencil-square pe-2"></i>Test Confirm Delete</li>
     </ul>
 </nav>

blawx/templates/blawx/blawxtest_form.html

@@ -4,7 +4,7 @@
 <nav aria-label="breadcrumb">
     <ol class="breadcrumb">
         <li class="breadcrumb-item"><i class="bi bi-house pe-2"></i><a href="/">Home</a></li>
-        <li class="breadcrumb-item"><i class="bi bi-journal pe-2"></i><a href="{% url 'ruledoc' ruledoc.id %}">{{ ruledoc.ruledoc_name }}</a></li>
+        <li class="breadcrumb-item"><i class="bi bi-journal pe-2"></i><a href="{% url 'ruledoc' ruledoc.owner ruledoc.rule_slug %}">{{ ruledoc.ruledoc_name }}</a></li>
         <li class="breadcrumb-item"><i class="bi bi-clipboard-check pe-2"></i>New Test</li>
     </ul>
 </nav>

blawx/templates/blawx/bot.html

@@ -113,7 +113,7 @@
                     </svg>
                     <span class="text">Help</span>
                 </a>
-                <a href="{% url 'test' blawxtest.ruledoc.id blawxtest %}" class="btn btn-secondary">
+                <a href="{% url 'test' blawxtest.ruledoc.owner blawxtest.ruledoc.rule_slug blawxtest %}" class="btn btn-secondary">
                     <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor"
                         class="bi bi-x-square" viewBox="0 0 16 16">
                         <path
@@ -532,7 +532,7 @@ <h5 class="card-title">Test Facts</h5>
                     return;
                 }
             }
-            interview_request.open("POST", "{% url 'test_interview' blawxtest.ruledoc.id blawxtest %}");
+            interview_request.open("POST", "{% url 'test_interview' blawxtest.ruledoc.owner blawxtest.ruledoc.rule_slug blawxtest %}");
             interview_request.setRequestHeader("Content-Type", "application/json");
             console.log("Sending interview request")
             interview_request.setRequestHeader('X-CSRFToken', csrftoken);
@@ -686,7 +686,7 @@ <h5 class="card-title">Test Facts</h5>
             test_fact_element.innerHTML = output_html;
 
         }
-        ontology_request.open("GET", "{% url 'test_onto' blawxtest.ruledoc.id blawxtest %}", false); // This is asynchronous because the interview request doesn't work until we have the ontology.
+        ontology_request.open("GET", "{% url 'test_onto' blawxtest.ruledoc.owner blawxtest.ruledoc.rule_slug blawxtest %}", false); // This is asynchronous because the interview request doesn't work until we have the ontology.
         ontology_request.setRequestHeader('X-CSRFToken', csrftoken);
         ontology_request.send();
 

blawx/templates/blawx/index.html

@@ -72,7 +72,7 @@ <h3>Your Projects</h3>
     <ul>
     {% for ruledoc in ruledoc_list %}
         {% if user == ruledoc.owner %}    
-            <li><a href="{% url 'ruledoc' ruledoc.id %}">{{ ruledoc.ruledoc_name }}</a></li>
+            <li><a href="{% url 'ruledoc' ruledoc.owner ruledoc.rule_slug %}">{{ ruledoc.ruledoc_name }}</a></li>
         {% endif %}
     {% endfor %}
     </ul>
@@ -83,7 +83,7 @@ <h3>Published Projects</h3>
     {% for ruledoc in ruledoc_list %}
         {% get_obj_perms request.user for ruledoc as "ruledoc_perms" %}
         {% if user != ruledoc.owner and ruledoc.published and 'view_ruledoc' in ruledoc_perms %}    
-            <li><a href="{% url 'ruledoc' ruledoc.id %}">{{ ruledoc.ruledoc_name }}</a></li>
+            <li><a href="{% url 'ruledoc' ruledoc.owner ruledoc.rule_slug %}">{{ ruledoc.ruledoc_name }}</a></li>
         {% endif %}
     {% endfor %}
     </ul>