jekyll-kw-sri 0.0.4 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bf7b33dc9b54d2ebcec17404f4bf5548760edba5148f8bf35b78a721d307293
-  data.tar.gz: 03f1d62d5b555a4225c4d352d744de1152b8976afda0332dd7d5510b8c17a1dc
+  metadata.gz: ce17b7850d6f74e3cba9b00d0b75a1c93bf7ab17160ab14a4747738c4d30e6a2
+  data.tar.gz: 5955abff66c1ed35c604193648fbb6cbc6498ca61b7c3213daa69efdc0cba0cd
 SHA512:
-  metadata.gz: 1a9fe066a7815dff331e10b68da1c3d83ae020afc901bdb81624aeb970d794fad34c2e53290481c4295a648dcf88e9d0c33c75fae707adf140efd81c10d34d7b
-  data.tar.gz: 4165a4c3b504a10622cc7991e13302bd3ee5c76ee8e62df7d86b28ed5a03268d87badf9c62c7881a89f6c7df25f69fdcb30b1deb008bbf258db7e5f84076d11d
+  metadata.gz: dd2ac1faad52d4d9577390f48f3ff71249f8406ebb1dac79cfd530e100a113ff68c98531f39bad583082f751b3af927bd0bcb3b8dd499f190e8bee39ab521dd4
+  data.tar.gz: 2524654da0dcfb241ff1b9b7ca218ab4c4f3f24c7b17210d5a574a62483b46003cb6094b761d355f5cfdabca3ea89d881bb2084ebc19094839431eb23c060c23

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 n13.org
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,16 +1,72 @@
 # jekyll-kw-sri
 
+![CI](https://github.com/n13org/jekyll-kw-sri/workflows/CI/badge.svg)
+![Coverage](https://github.com/n13org/jekyll-kw-sri/workflows/Coverage/badge.svg)
+![RuboCop](https://github.com/n13org/jekyll-kw-sri/workflows/RuboCop/badge.svg)
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/a82f10c3cd9fea769a0b/maintainability)](https://codeclimate.com/github/n13org/jekyll-kw-sri/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/a82f10c3cd9fea769a0b/test_coverage)](https://codeclimate.com/github/n13org/jekyll-kw-sri/test_coverage)
+
 [![Gem Version](https://badge.fury.io/rb/jekyll-kw-sri.svg)](https://badge.fury.io/rb/jekyll-kw-sri)
 
-A plugin for jekyll to calculate [Subresource Integrity][Wikipedia SRI] (SRI) hashes for CSS (even SCSS and SASS) and JS files during build time.
+A plugin for [jekyll][Jekyll Website] to calculate [Subresource Integrity][Wikipedia SRI] (SRI) hashes for CSS (even SCSS and SASS) and JS files during build time.
 
 > **Subresource Integrity** (SRI) is a security feature that enables browsers to verify that resources they fetch (for example, from a CDN) are delivered without unexpected manipulation. It works by allowing you to provide a cryptographic hash that a fetched resource must match.
 
 from [Mozilla docs][Mozilla Subresource Integrity]
 
-## Configuration
+## 🔥 Usage 
+
+### Usage for version `>= v0.1.0`
+
+Use the [Jekyll Includes] `kw-integrity-css.html` for css, scss and sass; and the `kw-integrity-js.html` for js. 
+
+> For static, non-rendered `css` files the hash values have to me calculated and stored in a file. See `Action Items / Shell commands` section about SRI! All the hash-files should be stored in `./_includes/integrity` so they can easy used.
+
+The markdown syntax shows the include file with one paramter "the filename". 
+
+```markdown
+{% include kw-integrity-css.html file='style.scss' %}
+```
+
+The rendered html will use the default path, the css file and the calculated hash.
+
+```html
+<link rel="stylesheet" href="/assets/css/style.css" integrity="sha384-cl6CK1yzEvoM3Sw3dL8YAm/P2VpQiD+mAFVkkb6Bh+23PP1ow2gXXGw4WnQlzO0B" crossorigin="anonymous">
+```
+
+The markdown syntax shows the include file with all paramters. All parameter can be omit. The **default values** are file = "main.scss", path = "assets/css/" and hash = "sha384".
+
+```markdown
+{% include kw-integrity-css.html file='style.scss' path='my/folder/to/css/' hash='sha512' %}
+```
+
+### Usage for version `< v0.1.0`
+
+Use the [custom tag][Jekyll Liquid] `sri_scss_hash`. 
+
+> This approach was inspired by [vcsjones.dev Blog] and [vcsjones.dev GitHub].
+
+The `html` inside the post or page markdown file, shows a usage of a `scss` file which will be compiled to a `css`. The hash of the integrity will be generated during the build time. 
+
+```html
+<link rel="stylesheet" href="{{ '/assets/css/kargware.css' | relative_url }}" integrity="{% sri_scss_hash /assets/css/kargware.scss %}" crossorigin="anonymous">
+```
+
+The result of the html inside the markdown is the `href` and the `integrity`.
+
+```html
+<link rel="stylesheet" href="/assets/css/kargware.css" integrity="sha384-cl6CK1yzEvoM3Sw3dL8YAm/P2VpQiD+mAFVkkb6Bh+23PP1ow2gXXGw4WnQlzO0B" crossorigin="anonymous">
+```
+
+## Changelog
+
+* 0.1.0 Add html include files to use them with  `{% include kw-integrity-css.html %}` or `{% include kw-integrity-js.html %}`
+* 0.0.x Add the custom tag `{% sri_scss_hash %}`
+
+## ⚙️ Configuration
 
-Add `kw-sri` section to `_config.yml` configure the plugin globally.
+Add `kw-sri` section to `_config.yml` configure the plugin globally. If you want to use defauls you can ommit the config-section.
 
 ```yaml
 kw-sri:
@@ -27,18 +83,46 @@ kw-sri:
 | hash_type                | Which kind of integrity hash                      | sha256, **sha384**, sha512 |
 | write_source_mapping_url | Add the map-file like to the css                  | false, **true**            |              
 
-Add `sri: true` to **Front Matter** of  `<page>` or `<post>` to activate the sri plugin.
+## 🚀 Action Items / Shell commands
 
-## Build gem
+Run linting and tests
 
-## Publish gem
+```sh
+bundle exec rubocop
+bundle exec rake test
+```
 
-## Run tests
+Build gem package
 
 ```sh
-bundle exec rake test
+bundle exec rake build
+```
+
+Publish gem package
+
+```sh
+bundle exec rake release
+```
+
+Calc a SRI Integrity hash of `./style.css` in format `sha256`
+
+```shell
+openssl dgst -sha256 -binary ./style.css | openssl base64 -A
 ```
 
+Calc different **SRI integrity** hash-files from `css-files` (same is valid for `js-files`) in format `sha256`, `sha384` and `sha512` inside a **Makefile**
+
+```plain
+calc-integrity-files:
+	for strength in 256 384 512 ; do \
+		cat ./assets/css/style.min.css | openssl dgst -sha$$strength -binary | openssl base64 -A > ./_includes/integrity/style.min.css.sha$$strength ; \
+		cat ./assets/css/main.css | openssl dgst -sha$$strength -binary | openssl base64 -A > ./_includes/integrity/main.css.sha$$strength ; \
+		cat ./assets/js/script.js | openssl dgst -sha$$strength -binary | openssl base64 -A > ./_includes/integrity/script.js.sha$$strength ; \
+	done
+```
+
+## 📝 Notes / Hints
+
 ### Appraisal - Gemfile Generator
 
 [GitHub](https://github.com/thoughtbot/appraisal)
@@ -50,8 +134,6 @@ bundle exec rake test
 bundle exec appraisal generate
 ```
 
-## Notes / Hints
-
 ### Site context is empty
 
 Inside the `render(context)` function of a `Liquid::Tag` there is a context object. With that context you can get the `site` object, anyhow when you want to cretae your temporry **site** and **context** you need a workaround.
@@ -92,13 +174,7 @@ converter = if defined? site.find_converter_instance
             end
 ```
 
-## SRI Integrity
-
-```shell
-openssl dgst -sha256 -binary ./style.css | openssl base64 -A
-```
-
-## Setup Steps
+### Setup Steps
 
 ```sh
 bundle init
@@ -113,5 +189,26 @@ bundle add redcarpet
 bundle add shoulda
 ```
 
+## 👋 Big Thanks to my inspiration sources
+
+* `SRI with Jekyll` [vcsjones.dev Blog] and [vcsjones.dev GitHub]
+* [GitHub Project jekyll/jekyll]
+* [GitHub Project Shopify/liquid]
+* [Medium wrap-your-assets-in-a-gem]
+* `Use jekyll filter scssify` [andreaverlicchi blog scssify]
+* [Blog How to create customizable Liquid tags in Jekyll]
+* [Ruby Module Digest]
+
+[Jekyll Website]: https://jekyllrb.com/
+[Jekyll Liquid]: https://jekyllrb.com/docs/liquid/
+[Jekyll Includes]: https://jekyllrb.com/docs/includes/
 [Wikipedia SRI]: https://en.wikipedia.org/wiki/Subresource_Integrity
-[Mozilla Subresource Integrity]: https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity
+[Mozilla Subresource Integrity]: https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity
+[vcsjones.dev Blog]: https://vcsjones.dev/2016/11/02/sri-with-jekyll/
+[vcsjones.dev GitHub]: https://github.com/vcsjones/vcsjones.dev/tree/main
+[GitHub Project jekyll/jekyll]: https://github.com/jekyll/jekyll
+[GitHub Project Shopify/liquid]: https://github.com/Shopify/liquid
+[andreaverlicchi blog scssify]: https://www.andreaverlicchi.eu/critical-css-jekyll-sass-github-pages/
+[Ruby Module Digest]: https://ruby-doc.com/stdlib/libdoc/digest/rdoc/Digest.html
+[Blog How to create customizable Liquid tags in Jekyll]: https://blog.sverrirs.com/2016/04/custom-jekyll-tags.html
+[Medium wrap-your-assets-in-a-gem]: https://medium.com/@paulfarino/wrap-your-assets-in-a-gem-3ad7ecf5b075

data/_includes/kw-integrity-css.html

@@ -0,0 +1,42 @@
+{% assign para_file = include.file | default: "main.scss" %}
+{% assign para_path = include.path | default: "assets/css/" %}
+{% assign para_hash = include.hash | default: "sha384" %}
+
+{% assign filename_no_path = para_file | split: "/" | last %}
+{% assign source_file = "/" | append: para_path | append: para_file %}
+{% assign source_file_ex = para_file | split: "." | last %}
+{% assign path_no_filename = para_file | remove: filename_no_path %}
+{% assign target_file_ex = para_file | replace: ".scss", ".css" %}
+{% assign target_file = para_path | append: target_file_ex %}
+{% assign integrity_file = "/integrity/" | append: para_file | append: "." | append: para_hash %}
+
+{% comment %}{% raw %}
+<!-- DEBUG BEGINN
+{{ para_file }}
+{{ para_path }}
+{{ para_hash }}
+{{ filename_no_path }}   
+{{ source_file }} 
+{{ source_file_ex }}    
+{{ path_no_filename }}
+{{ target_file }}
+{{ integrity_file }}
+DEBUG END -->
+{% endraw %}{% endcomment %}
+
+{% case source_file_ex %}
+  {% when "css" %}
+<link rel="stylesheet" href="{{ target_file }}" integrity="{{ para_hash }}-{% include {{ integrity_file }} %}" crossorigin="anonymous">
+  {% when "scss" %}
+<link rel="stylesheet" href="{{ target_file }}" integrity="{% sri_scss_hash {{ source_file }} %}" crossorigin="anonymous">
+  {% else %}
+<link rel="stylesheet" href="{{ target_file }}">
+{% endcase %}
+
+{% comment %}{% raw %}
+
+<!-- Trailing Slash Handling ? -->
+{% assign trainling_slash = para_path | slice: -1, 1 %}
+{% if trainling_slash = "/" %}
+
+{% endraw %}{% endcomment %}

data/_includes/kw-integrity-js.html

@@ -0,0 +1,18 @@
+{% assign para_file = include.file | default: "script.js" %}
+{% assign para_path = include.path | default: "assets/js/" %}
+{% assign para_hash = include.hash | default: "sha384" %}
+
+{% assign target_file = para_path | append: para_file %}
+{% assign integrity_file = "/integrity/" | append: para_file | append: "." | append: para_hash %}
+
+{% comment %}{% raw %}
+<!-- DEBUG BEGINN
+{{ para_file }}
+{{ para_path }}
+{{ para_hash }}
+{{ target_file }}
+{{ integrity_file }}
+DEBUG END -->
+{% endraw %}{% endcomment %}
+
+<script src="{{ target_file }}" integrity="{{ para_hash }}-{% include {{ integrity_file }} %}" crossorigin="anonymous"></script>

data/lib/jekyll-kw-sri.rb

@@ -9,30 +9,14 @@ module Jekyll
   module KargWare
     # jekyll-kw-sri custom tag
     class SriScssHashTag < Jekyll::Tags::IncludeRelativeTag
-      # class SriScssHashTag < Liquid::Tag
-
-      alias super_render render
-
       def initialize(tag_name, input, tokens)
         super
 
         raise 'Please enter a file path' if input.length <= 0
-
-        @scss_file = strip_or_self(input)
         # File.exists? is file?
-
-        @tag_name = tag_name
-
-        # puts syntax_example
       end
 
-      # def syntax_example
-      #     "{% #{@tag_name} css/main.scss %}"
-      # end
-
       def render(context)
-        # return '' unless context.registers[:page]['sri']
-
         cache_compiled_scss(@file, context, lambda {
           if context.nil? || context.registers[:site].nil?
             puts 'WARNING: There was no context, generate default site and context'
@@ -44,29 +28,25 @@ module Jekyll
             @sri_config = context.registers[:site].config['kw-sri'] || {}
           end
 
+          # Render the context with the base-class
           converter = site.find_converter_instance(Jekyll::Converters::Scss)
-
-          # var scss = render(context)
-          result = super_render(context) # super(context)
+          result = super(context) # super_render(context)
           scss = result.gsub(/^---.*---/m, '')
           data = converter.convert(scss)
 
+          # Get path out of the file object
           file = render_variable(context) || @file
           validate_file_name(file)
           path = locate_include_file(context, file, site.safe)
 
+          # Use default config for kw-sri if it is nil
+          @sri_config ||= Jekyll::KargWare::Integrity::Configuration::DEFAULT_CONFIG
+
           Integrity::Parser.new(@sri_config).calc_integrity(path, data)
         })
       end
 
       def cache_compiled_scss(path, _context, compute)
-        # @@cached_scss ||= {}
-        # if @@cached_scss.key?(path)
-        #   @@cached_scss[path]
-        # else
-        #   @@cached_scss[path] = compute.call
-        # end
-
         @cached_scss ||= {}
         if @cached_scss.key?(path)
           @cached_scss[path]
@@ -75,11 +55,7 @@ module Jekyll
         end
       end
 
-      # https://stackoverflow.com/a/1000975
-      def strip_or_self(str)
-        str.strip! || str
-      end
-
+      # Register the sccs file as include folder
       def tag_includes_dirs(context)
         [context.registers[:site].source].freeze
       end

data/lib/jekyll-kw-sri/parser.rb

@@ -19,7 +19,7 @@ module Jekyll
           data_modified = add_source_mapping_url(filename, data)
 
           # Debuging, save rendered css file as tmp file
-          File.open(".#{filename}.tmp", 'w') { |file| file.write(data_modified) } if @configuration.create_tmpfile
+          File.open("#{filename}.tmp", 'w') { |file| file.write(data_modified) } if @configuration.create_tmpfile
 
           case hash_type
           when 'sha256'

data/lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JekyllKwSri
-  VERSION = '0.0.4'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-kw-sri
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.2
 platform: ruby
 authors:
 - Nicolas Karg
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-12 00:00:00.000000000 Z
+date: 2020-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '3.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '3.8'
 description: Jekyll plugin which calculate the integrity hash of CSS (SCSS, SASS)
   and JS.
 email: rubygems.org@n13.org
@@ -32,7 +32,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
 - README.md
+- _includes/kw-integrity-css.html
+- _includes/kw-integrity-js.html
 - lib/jekyll-kw-sri.rb
 - lib/jekyll-kw-sri/configuration.rb
 - lib/jekyll-kw-sri/parser.rb
@@ -49,7 +52,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="