Add "lexical" and "natural" sort strategies for notation codes

model/Concept.php

@@ -558,7 +558,7 @@ public function getProperties()
                 if ($superprop) {
                     $superprop = EasyRdf\RdfNamespace::shorten($superprop) ? EasyRdf\RdfNamespace::shorten($superprop) : $superprop;
                 }
-                $sort_by_notation = $this->vocab->getConfig()->sortByNotation();
+                $sort_by_notation = $this->vocab->getConfig()->getSortByNotation();
                 $propobj = new ConceptProperty($prop, $proplabel, $prophelp, $superprop, $sort_by_notation);
 
                 if ($propobj->getLabel() !== null) {

model/ConceptProperty.php

@@ -130,8 +130,12 @@ private function sortValues()
                         return -1;
                     }
                     else {
-                        // assume that notations are unique
-                        return strnatcasecmp($anot, $bnot);
+                        // assume that notations are unique, choose strategy
+                        if ($this->sort_by_notation == "decimal") {
+                            return strcoll($anot, $bnot);
+                        } else { // natural
+                            return strnatcasecmp($anot, $bnot);
+                        }
                     }
                 });
             }

model/ConceptPropertyValue.php

@@ -33,12 +33,7 @@ public function __construct($model, $vocab, $resource, $prop, $clang = '')
 
     public function __toString()
     {
-        $label = is_string($this->getLabel()) ? $this->getLabel() : $this->getLabel()->getValue();
-        if ($this->vocab->getConfig()->sortByNotation()) {
-            $label = ltrim($this->getNotation() . ' ') . $label;
-        }
-
-        return $label;
+        return is_string($this->getLabel()) ? $this->getLabel() : $this->getLabel()->getValue();
     }
 
     public function getLang()

model/VocabularyConfig.php

@@ -178,12 +178,21 @@ public function getTitle($lang = null)
     }
 
     /**
-     * Returns a boolean value set in the config.ttl config.
-     * @return boolean
+     * Returns the sorting strategy for notation codes set in the config.ttl
+     * config: either "decimal" (default), "natural", or null if
+     * sorting by notations is disabled.
+     * @return string|bool
      */
-    public function sortByNotation()
+    public function getSortByNotation(): ?string
     {
-        return $this->getBoolean('skosmos:sortByNotation');
+        $value = $this->getLiteral('skosmos:sortByNotation');
+        if ($value == "decimal" || $value == "natural") {
+            return $value;
+        }
+        // not a special value - interpret as boolean instead
+        $bvalue = $this->getBoolean('skosmos:sortByNotation');
+        // default sorting strategy is "decimal"
+        return $bvalue ? "decimal" : null;
     }
 
     /**

resource/js/hierarchy.js

@@ -508,17 +508,21 @@ function getTreeConfiguration() {
         var bNode = this.get_node(b);
 
         // sort on notation if requested, and notations exist
-        if (window.showNotation) {
+        if (window.sortByNotation) {
             var aNotation = aNode.original.notation;
             var bNotation = bNode.original.notation;
 
             if (aNotation) {
                 if (bNotation) {
-                    if (aNotation < bNotation) {
-                        return -1;
-                    }
-                    else if (aNotation > bNotation) {
-                        return 1;
+                    if (window.sortByNotation == "decimal") {
+                        if (aNotation < bNotation) {
+                            return -1;
+                        }
+                        else if (aNotation > bNotation) {
+                            return 1;
+                        }
+                    } else { // natural
+                        return naturalCompare(aNotation, bNotation);
                     }
                 }
                 else return -1;

resource/js/scripts.js

@@ -326,7 +326,14 @@ function countAndSetOffset() {
   }
 }
 
+// return -1 if the value is negative, 1 otherwise
+// used to coerce sort values so they are compatible with the jsTree sort plugin
+function negVsPos(val) {
+  return (val < 0) ? -1 : 1;
+}
+
 // Natural sort from: http://stackoverflow.com/a/15479354/3894569
+// adapted to return only -1 or 1 using negVsPos function above
 function naturalCompare(a, b) {
   var ax = [], bx = [];
 
@@ -337,10 +344,10 @@ function naturalCompare(a, b) {
     var an = ax.shift();
     var bn = bx.shift();
     var nn = (an[0] - bn[0]) || an[1].localeCompare(bn[1], lang);
-    if(nn) return nn;
+    if(nn) return negVsPos(nn);
   }
 
-  return ax.length - bx.length;
+  return negVsPos(ax.length - bx.length);
 }
 
 function makeCallbacks(data, pageType) {

tests/VocabularyConfigTest.php

@@ -318,12 +318,43 @@ public function testShowChangeListDefaultValue() {
   }
 
   /**
-   * @covers VocabularyConfig::sortByNotation
+   * @covers VocabularyConfig::getSortByNotation
+   * @covers VocabularyConfig::getLiteral
    * @covers VocabularyConfig::getBoolean
    */
   public function testShowSortByNotationDefaultValue() {
     $vocab = $this->model->getVocabulary('test');
-    $this->assertEquals(false, $vocab->getConfig()->sortByNotation());
+    $this->assertNull($vocab->getConfig()->getSortByNotation());
+  }
+
+  /**
+   * @covers VocabularyConfig::getSortByNotation
+   * @covers VocabularyConfig::getLiteral
+   * @covers VocabularyConfig::getBoolean
+   */
+  public function testShowSortByNotationTrueIsDecimal() {
+    $vocab = $this->model->getVocabulary('test-notation-sort');
+    $this->assertEquals("decimal", $vocab->getConfig()->getSortByNotation());
+  }
+
+  /**
+   * @covers VocabularyConfig::getSortByNotation
+   * @covers VocabularyConfig::getLiteral
+   * @covers VocabularyConfig::getBoolean
+   */
+  public function testShowSortByNotationDecimal() {
+    $vocab = $this->model->getVocabulary('test-qualified-notation');
+    $this->assertEquals("decimal", $vocab->getConfig()->getSortByNotation());
+  }
+
+  /**
+   * @covers VocabularyConfig::getSortByNotation
+   * @covers VocabularyConfig::getLiteral
+   * @covers VocabularyConfig::getBoolean
+   */
+  public function testShowSortByNotationNatural() {
+    $vocab = $this->model->getVocabulary('testNotation');
+    $this->assertEquals("natural", $vocab->getConfig()->getSortByNotation());
   }
 
   /**

tests/testconfig.ttl

@@ -117,6 +117,7 @@
     void:uriSpace "http://www.skosmos.skos/test-qualified-notation/" ;
     skosmos:defaultLanguage "en" ;
     skosmos:groupClass skos:Collection ;
+    skosmos:sortByNotation "decimal" ;
     skosmos:language "en" ;
     skosmos:alphabeticalListQualifier skos:notation ;
     skosmos:sparqlGraph <http://www.skosmos.skos/test-qualified-notation/> .
@@ -337,7 +338,7 @@
     dc:subject :cat_general ;
     void:uriSpace "http://www.skosmos.skos/notationFeatures/";
     skosmos:language "fi";
-    skosmos:sortByNotation true ;
+    skosmos:sortByNotation "natural" ;
     skosmos:searchByNotation true ;
     skosmos:showNotation true ;
     skosmos:useModifiedDate "true";

view/scripts.twig

@@ -32,8 +32,9 @@ var prefLabels = [{"lang": "{{ search_results|first.label.lang }}","label": "{{
 {% if request.vocab and request.vocab.uriSpace %}
 var uriSpace = "{{ request.vocab.uriSpace }}";
 {% endif %}
-var showNotation = {% if request.vocab and request.vocab.config.showNotation == false %}false{% else %}true{% endif %};
 {% if request.vocab  %}
+var showNotation = {% if request.vocab.config.showNotation %}true{% else %}false{% endif %};
+var sortByNotation = {% if request.vocab.config.sortByNotation %}"{{ request.vocab.config.sortByNotation }}"{% else %}null{% endif %};
 var languageOrder = [{% for lang in request.vocab.config.languageOrder(request.contentLang) %}"{{ lang }}"{% if not loop.last %},{% endif %}{% endfor %}];
 var vocShortName = "{{ request.vocab.config.shortname }}";
 {% endif %}