Merge branch 'gh-pages' into patch-1

Author: mlinksva

.github/workflows/test.yml

@@ -1,4 +1,6 @@
 name: Build and Test
+permissions:
+  contents: read
 
 on:
   push:
@@ -12,14 +14,14 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
       with:
         submodules: true
 
     - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@4a9ddd6f338a97768b8006bf671dfbad383215f4
       with:
-        ruby-version: 2.7.4
+        ruby-version: 3.3.4
         bundler-cache: true
 
     - name: Run tests

.rubocop.yml

@@ -1,6 +1,6 @@
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.3
   Exclude:
     - _site/**/*
     - vendor/**/*

CODE_OF_CONDUCT.md

@@ -1,71 +1,51 @@
-Contributor Covenant Code of Conduct
+# Contributor Covenant Code of Conduct
 
-Our Pledge
+## Our Pledge
 
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
 
-Our Standards
 
-Examples of behavior that contributes to creating a positive environment
-include:
+## Our Standards
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+Examples of behavior that contributes to creating a positive environment include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+
+## Unacceptable Behavior
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at [email protected]. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-Attribution
-
-This Code of Conduct is adapted from the Contributor Covenant, version 1.4,
-available at http://contributor-covenant.org/version/1/4/
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insults, derogatory remarks, or personal/political attacks
+- Public or private harassment
+- Disclosure of private information (such as physical or electronic addresses) without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+
+## Attribution
+
+This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at https://contributor-covenant.org/version/1/4/

_licenses/cern-ohl-p-2.0.txt

@@ -7,7 +7,7 @@ description: A permissive license for hardware designs, with conditions only req
 
 how: Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file.
 
-note: 'CERN <a href="https://ohwr.org/project/cernohl/wikis/uploads/8a6b5d01f71c207c49493e4d114d61e6/cern_ohl_p_v2_howto.pdf">recommends</a> adding the following information in the source files: copyright and license notice, a disclaimer of warranties and a source location. You can also include the source location in a part of the design which will be visible in the end product.'
+note: 'CERN <a href="https://gitlab.com/ohwr/project/cernohl/-/wikis/uploads/8a6b5d01f71c207c49493e4d114d61e6/cern_ohl_p_v2_howto.pdf">recommends</a> adding the following information in the source files: copyright and license notice, a disclaimer of warranties and a source location. You can also include the source location in a part of the design which will be visible in the end product.'
 
 using:
   tedium: https://github.com/jboone/tedium/blob/master/LICENSE-CERN-OHL-P-v2

_licenses/cern-ohl-s-2.0.txt

@@ -7,7 +7,7 @@ description: Permissions of this strongly reciprocal license for hardware design
 
 how: Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file.
 
-note: 'CERN <a href="https://ohwr.org/project/cernohl/wikis/uploads/cf37727497ca2b5295a7ab83a40fcf5a/cern_ohl_s_v2_user_guide.pdf">recommends</a> adding the following information in the source files: copyright and license notice, a disclaimer of warranties and a source location. You can also include the source location in a part of the design which will be visible in the end product.'
+note: 'CERN <a href="https://gitlab.com/ohwr/project/cernohl/-/wikis/uploads/cf37727497ca2b5295a7ab83a40fcf5a/cern_ohl_s_v2_user_guide.pdf">recommends</a> adding the following information in the source files: copyright and license notice, a disclaimer of warranties and a source location. You can also include the source location in a part of the design which will be visible in the end product.'
 
 using:
   USB Armory: https://github.com/f-secure-foundry/usbarmory/blob/master/hardware/mark-two/LICENSE

_licenses/cern-ohl-w-2.0.txt

@@ -7,10 +7,10 @@ description: Permissions of this weakly-reciprocal license are conditioned on ma
 
 how: Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file.
 
-note: 'CERN <a href="https://ohwr.org/project/cernohl/wikis/uploads/c2e5e9d297949b5c2d324a6cbf6adda0/cern_ohl_w_v2_howto.pdf">recommends</a> adding the following information in the source files: copyright and license notice, a disclaimer of warranties and a source location. You can also include the source location in a part of the design which will be visible in the end product.'
+note: 'CERN <a href="https://gitlab.com/ohwr/project/cernohl/-/wikis/uploads/c2e5e9d297949b5c2d324a6cbf6adda0/cern_ohl_w_v2_howto.pdf">recommends</a> adding the following information in the source files: copyright and license notice, a disclaimer of warranties and a source location. You can also include the source location in a part of the design which will be visible in the end product.'
 
 using:
-  Simple PCIe FMC carrier: https://ohwr.org/project/spec/blob/master/LICENSES/CERN-OHL-W-2.0.txt
+  Simple PCIe FMC carrier: https://gitlab.com/ohwr/project/spec/blob/master/LICENSES/CERN-OHL-W-2.0.txt
   GProcessor8Bits: https://github.com/JonathSpirit/GP8B/blob/master/LICENSE
   FPGA Cores: https://github.com/suoto/fpga_cores/blob/master/LICENSE
 

_licenses/mit-0.txt

@@ -7,7 +7,7 @@ description: A short and simple permissive license with no conditions, not even
 how: Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders.
 
 using:
-  rssfs: https://github.com/dertuxmalwieder/rssfs/blob/master/LICENSE
+  Reactive Streams: https://github.com/reactive-streams/reactive-streams-jvm/blob/master/LICENSE
   SOIL2: https://github.com/SpartanJ/SOIL2/blob/master/LICENSE
   Units.NET: https://github.com/angularsen/UnitsNet/blob/master/LICENSE
 

appendix.md

@@ -11,7 +11,7 @@ If you're here to choose a license, **[start from the home page](/)** to see a f
 
 <table border style="font-size: xx-small; position: relative">
 {% assign types = "permissions|conditions|limitations" | split: "|" %}
-<tr style="position: sticky; top: 0">
+<tr style="position: sticky; top: 0; z-index: 1000001; background: color-mix(in srgb, var(--backgroundColor) 70%, transparent);">
   <th scope="col" style="text-align: center">License</th>
   {% assign seen_tags = '' %}
   {% for type in types %}
@@ -72,25 +72,24 @@ If you're here to choose a license, **[start from the home page](/)** to see a f
 
 <p>Most open source licenses also have <span class="license-limitations"><span class="license-sprite"></span></span> <b>limitations</b> that usually disclaim warranty and liability, and sometimes expressly exclude patents or trademarks from licenses' grants.</p>
 
-<dl>
-{% assign seen_tags = '' %}
 {% for type in types %}
+### {% if type == "permissions" %}Permissions{% elsif type == "conditions" %}Conditions{% else %}Limitations{% endif %}
+  <dl>
   {% assign rules = site.data.rules[type] | sort: "label" %}
   {% for rule_obj in rules %}
     {% assign req = rule_obj.tag %}
-    {% if seen_tags contains req %}
-      {% continue %}
-    {% endif %}
     <dt id="{{ req }}">{{ rule_obj.label }}</dt>
-    {% capture seen_tags %}{{ seen_tags | append:req }}{% endcapture %}
-    {% for t in types %}
-      {% assign rs = site.data.rules[t] | sort: "label" %}
-      {% for r in rs %}
-        {% if r.tag == req %}
-          <dd class="license-{{t}}"><span class="license-sprite"></span> {{ r.description }}</dd>
-        {% endif %}
-      {% endfor %}
-    {% endfor %}
+    <dd class="license-{{ type }}">
+      {% if req contains "--" %}
+        {% assign lite = " lite" %}
+      {% else %}
+        {% assign lite = "" %}
+      {% endif %}
+      <span class="{{ req | append: lite }}">
+        <span class="license-sprite {{ req }}"></span>
+      </span>
+      {{ rule_obj.description }}
+    </dd>
   {% endfor %}
+  </dl>
 {% endfor %}
-</dl>

assets/css/application.scss

@@ -6,13 +6,15 @@
 
 body {
   background: #fafafa;
+  --backgroundColor: #fafafa;
   color: #5c5855;
   font: 0.875rem/1.4 "Helvetica Neue", Helvetica, Arial, sans-serif;
 }
 
 @media (prefers-color-scheme: dark) {
   body {
     background: #212121;
+    --backgroundColor: #212121;
     color: #d0c8c1;
   }
 
@@ -462,7 +464,7 @@ strong {
 
 
 /* Hint.css Overide */
-.orverride-hint-inline {
+.override-hint-inline {
   display: block;
 }
 

assets/js/app.coffee

@@ -40,14 +40,15 @@ class Choosealicense
     # Dynamically add annotations as title attribute to rule list items
     for ruletype, rules of window.annotations
       for rule in rules
-        licenseLiElement = $(".license-#{ruletype} .#{rule["tag"]}")
+        # Exclude license elements in the legend
+        licenseLiElement = $(".license-#{ruletype} .#{rule["tag"]}").not("dd.license-#{ruletype} .#{rule["tag"]}")
         tooltipAttr = @tooltipAttributesMapperByRuleType[ruletype]
-        licenseLiElement.attr "aria-label", "#{tooltipAttr.heading}: #{rule.description}"
+        licenseLiElement.attr "aria-label", "#{rule.label} #{tooltipAttr.heading.toLowerCase()}: #{rule.description}"
         licenseLiElement.addClass("hint--bottom
                                    hint--large
                                    hint--no-animate
                                    #{tooltipAttr.color}
-                                   orverride-hint-inline")
+                                   override-hint-inline")
 
   # Initializes Clipboard.js
   initClipboard: ->
@@ -111,14 +112,9 @@ class LicenseSuggestion
 
   # Try to extract the repository full name from the user input
   parseUserInput: (userInput) ->
-    repository = /https?:\/\/github\.com\/(.*?)\/(.+)(\.git)?$/.exec userInput
+    repository = /https?:\/\/github\.com\/([^\/]+)\/([^\/\?#]+)/.exec userInput
     [_, username, project] = repository
-    project = project
-      .split /\/|\.git/
-      .filter (str) -> str
-      .slice 0, 1
-      .join ""
-    return username + '/' + project
+    return username + '/' + project.replace /(\.git)$/, ''
 
   # Displays an indicator and tooltips to the user about the current status
   setStatus: (status="", message="") =>
@@ -143,9 +139,9 @@ class LicenseSuggestion
       callback null, info
     .fail (e) ->
       if e.status == 404
-        callback new Error "Repository <b>#{repositoryFullName}</b> not found."
+        callback new Error "Repository #{repositoryFullName} not found."
       else
-        callback new Error "Network error when trying to get information about <b>#{repositoryFullName}</b>."
+        callback new Error "Network error when trying to get information about #{repositoryFullName}."
 
   # Generates a message showing that a repository is already licensed
   repositoryLicense: (repositoryFullName, license) ->