Merge pull request #138 from github/sort-rules

Sort rules by label

Gemfile.lock

@@ -8,53 +8,61 @@ GEM
     colored (1.2)
     commander (4.1.5)
       highline (~> 1.6.11)
-    directory_watcher (1.4.1)
     ethon (0.6.1)
       ffi (>= 1.3.0)
       mime-types (~> 1.18)
     fast-stemmer (1.0.2)
     ffi (1.9.0)
-    github-pages (8)
+    github-pages (11)
       RedCloth (= 4.2.9)
-      jekyll (= 1.2.0)
+      jekyll (= 1.3.1)
-      kramdown (= 1.0.2)
+      kramdown (= 1.2.0)
-      liquid (= 2.5.1)
+      liquid (= 2.5.4)
       maruku (= 0.6.1)
-      rdiscount (= 1.6.8)
+      rdiscount (= 2.1.7)
-      redcarpet (= 2.2.2)
+      redcarpet (= 2.3.0)
     highline (1.6.20)
     html-proofer (0.2.3)
       colored (~> 1.2)
       nokogiri (= 1.6.0)
       typhoeus (~> 0.6.3)
-    jekyll (1.2.0)
+    jekyll (1.3.1)
       classifier (~> 1.3)
       colorator (~> 0.1)
       commander (~> 4.1.3)
-      directory_watcher (~> 1.4.1)
+      liquid (~> 2.5.2)
-      liquid (~> 2.5.1)
+      listen (~> 1.3)
-      maruku (~> 0.5)
+      maruku (~> 0.6.0)
       pygments.rb (~> 0.5.0)
-      redcarpet (~> 2.2.2)
+      redcarpet (~> 2.3.0)
-      safe_yaml (~> 0.7.0)
+      safe_yaml (~> 0.9.7)
-    kramdown (1.0.2)
+    kramdown (1.2.0)
-    liquid (2.5.1)
+    liquid (2.5.4)
+    listen (1.3.1)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+      rb-kqueue (>= 0.2)
     maruku (0.6.1)
       syntax (>= 1.0.0)
-    mime-types (1.25)
+    mime-types (1.25.1)
     mini_portile (0.5.2)
     nokogiri (1.6.0)
       mini_portile (~> 0.5.0)
     posix-spawn (0.3.6)
-    pygments.rb (0.5.2)
+    pygments.rb (0.5.4)
       posix-spawn (~> 0.3.6)
       yajl-ruby (~> 1.1.0)
     rake (10.1.0)
-    rdiscount (1.6.8)
+    rb-fsevent (0.9.3)
-    redcarpet (2.2.2)
+    rb-inotify (0.9.2)
-    safe_yaml (0.7.1)
+      ffi (>= 0.5.0)
+    rb-kqueue (0.2.0)
+      ffi (>= 0.5.0)
+    rdiscount (2.1.7)
+    redcarpet (2.3.0)
+    safe_yaml (0.9.7)
     syntax (1.0.0)
-    typhoeus (0.6.5)
+    typhoeus (0.6.6)
       ethon (~> 0.6.1)
     yajl-ruby (1.1.0)
 

_config.yml

@@ -1,3 +1,4 @@
+---
 title: ChooseALicense.com
 relative_permalinks: false
 markdown: kramdown
@@ -5,61 +6,61 @@ markdown: kramdown
 rules:
 
   required:
-    include-copyright:
+  - description: Include a copy of the license and copyright notice with the code.
-      description: Include a copy of the license and copyright notice with the code.
     label: License and copyright notice
-    document-changes:
+    tag: include-copyright
-      description: Indicate significant changes made to the code.
+  - description: Indicate significant changes made to the code.
     label: State Changes
-    disclose-source:
+    tag: document-changes
-      description: Source code must be made available when distributing the software. In the case of LGPL, the source for the library (and not the entire program) must be made available.
+  - description: Source code must be made available when distributing the software. In the case of LGPL, the source for the library (and not the entire program) must be made available.
     label: Disclose Source
-    library-usage:
+    tag: disclose-source
-      description: The library may be used within a non-open-source application.
+  - description: The library may be used within a non-open-source application.
     label: Library usage
-    rename:
+    tag: library-usage
-      description: You must change the name of the software if you modify it.
+  - description: You must change the name of the software if you modify it.
     label: Rename
+    tag: rename
 
   permitted:
-    commercial-use:
+  - description: This software and derivatives may be used for commercial purposes.
-      description: This software and derivatives may be used for commercial purposes.
     label: Commercial Use
-    modifications:
+    tag: commercial-use
-      description: This software may be modified.
+  - description: This software may be modified.
     label: Modification
-    distribution:
+    tag: modifications
-      description: You may distribute this software.
+  - description: You may distribute this software.
     label: Distribution
-    sublicense:
+    tag: distribution
-      description: You may grant a sublicense to modify and distribute this software to third parties not included in the license.
+  - description: You may grant a sublicense to modify and distribute this software to third parties not included in the license.
     label: Sublicensing
-    private-use:
+    tag: sublicense
-      description: You may use and modify the software without distributing it.
+  - description: You may use and modify the software without distributing it.
     label: Private Use
-    patent-grant:
+    tag: private-use
-      description: This license provides an express grant of patent rights from the contributor to the recipient.
+  - description: This license provides an express grant of patent rights from the contributor to the recipient.
     label: Patent Grant
+    tag: patent-grant
 
   forbidden:
-    trademark-use:
+  - description: While this may be implicitly true of all licenses, this license explicitly states that you may NOT use the names, logos, or trademarks of contributors.
-      description: While this may be implicitly true of all licenses, this license explicitly states that you may NOT use the names, logos, or trademarks of contributors.
     label: Use Trademark
-    no-liability:
+    tag: trademark-use
-      description: Software is provided without warranty and the software author/license owner cannot be held liable for damages.
+  - description: Software is provided without warranty and the software author/license owner cannot be held liable for damages.
     label: Hold Liable
-    no-sublicense:
+    tag: no-liability
-      description: You may not grant a sublicense to modify and distribute this software to third parties not included in the license.
+  - description: You may not grant a sublicense to modify and distribute this software to third parties not included in the license.
     label: Sublicensing
-    modifications:
+    tag: no-sublicense
-      description: This software may not be modified.
+  - description: This software may not be modified.
     label: Modification
-    distribution:
+    tag: modifications
-      description: You may not distribute this software.
+  - description: You may not distribute this software.
     label: Distribution
-    sublicense:
+    tag: distribution
-      description: You may not grant a sublicense to modify and distribute this software to third parties not included in the license.
+  - description: You may not grant a sublicense to modify and distribute this software to third parties not included in the license.
     label: Sublicensing
+    tag: sublicense
 
 exclude:
 - CNAME

_includes/license-overview.html

@@ -32,8 +32,12 @@
           {% for type in types %}
             <td>
               <ul class="license-{{ type }}">
-              {% for req in variation[type] %}
+                {% assign rules = site.rules[type] | sort: 'label' %}
-                <li class="{{ req }}">{{ site.rules[type][req].label }}</li>
+                {% for rule_obj in rules %}
+                  {% assign req = rule_obj.tag %}
+                  {% if variation[type] contains req %}
+                    <li class="{{ req }}">{{ rule_obj.label }}</li>
+                  {% endif %}
                 {% endfor %}
               </ul>
             </td>

_includes/sidebar.html

@@ -24,8 +24,12 @@
       {% for type in types %}
         <h3>{{ type | capitalize }}</h3>
         <ul class="license-{{ type }}">
-          {% for req in page[type] %}
+          {% assign rules = site.rules[type] | sort: 'label' %}
-            <li class="{{ req }}">{{ site.rules[type][req].label }}</li>
+          {% for rule_obj in rules %}
+            {% assign req = rule_obj.tag %}
+            {% if page[type] contains req %}
+              <li class="{{ req }}">{{ rule_obj.label }}</li>
+            {% endif %}
           {% endfor %}
         </ul>
       {% endfor %}

javascripts/annotations.js

@@ -4,7 +4,7 @@ var annotations = {
 {% for type_hash in site.rules %}
   "{{ type_hash[0] }}": {
     {% for rule_hash in type_hash[1] %}
-    "{{ rule_hash[0] }}" : "{{ rule_hash[1].description }}"{% if forloop.rindex0 > 0 %},{% endif %}
+    "{{ rule_hash.tag }}" : "{{ rule_hash.description }}"{% if forloop.rindex0 > 0 %},{% endif %}
     {% endfor %}
   }{% if forloop.rindex0 > 0 %},{% endif %}
 {% endfor %}