jekyll-kw-sri 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fefa9c1ae5b7c722c5a2fe0b530b0c58c7e612f93e54fbf57adab68f88d0ff66
-  data.tar.gz: 1493f4d4213256b518e7d6ffc2fdca9e3f5d789b746029c7e8f2ee8afb2ebd7e
+  metadata.gz: 819489bf76dbdfc30a65dea0be4194cf7e5413feb9cdf466b2fc016ebc5d548c
+  data.tar.gz: adfe552b0323b916bd2ac982f55ba77edacdd69c42c5a96c88956e579f2f3dfd
 SHA512:
-  metadata.gz: ef3d181dc9f827fc0a026a021e661ce2bfbb1f653125e5adf43f09e0937a1c87053ed96cfb5f40a7423131ed79ceaae9961d3eef4783bdad683efbb3d1dea9dd
-  data.tar.gz: 6938b41fe3adad31e1b4bd206d2d4b317ae24c895ae41a8e2aa33feed254708a64493cd0db01bc0b35c5da96443c6e005c9894d6a4bb65704ccef3caefce0797
+  metadata.gz: 9636fd290730383df237c912a2db7e0d665894a8f6fe880ffafbf6ea5e11a09fa2277cc39f86885926a14373b0309121d5d088cb7f82128f82dd1a14e4d03da3
+  data.tar.gz: 549d6ff11bc9789e295d87840339f16108482308961945d3bc22faae6b76280c6364f2521cf5e8e406a7d391b576f7153d48603249d587ddbffc1b1ddd81c480

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

@@ -8,9 +8,14 @@ A plugin for jekyll to calculate [Subresource Integrity][Wikipedia SRI] (SRI) ha
 
 from [Mozilla docs][Mozilla Subresource Integrity]
 
+## Changelog
+
+* 0.0.x Add the custom tag `{% sri_scss_hash %}`
+* 0.1.0 Add html iclude files to use them with  `{% include kw-integrity-css.html %}` or `{% include kw-integrity-js.html %}`
+
 ## 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 +32,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 +83,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,12 +123,6 @@ converter = if defined? site.find_converter_instance
             end
 ```
 
-## SRI Integrity
-
-```shell
-openssl dgst -sha256 -binary ./style.css | openssl base64 -A
-```
-
 ## Setup Steps
 
 ```sh

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 @@
+<script src="/assets/js/{{ include.file }}" integrity="sha384-{% include /integrity/{{ include.file }}.sha384 %}" crossorigin="anonymous"></script>

data/lib/jekyll-kw-sri.rb

@@ -9,25 +9,14 @@ module Jekyll
   module KargWare
     # jekyll-kw-sri custom tag
     class SriScssHashTag < Jekyll::Tags::IncludeRelativeTag
-      # class SriScssHashTag < Liquid::Tag
       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
       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'
@@ -39,24 +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)
-
-          result = super(context)
+          result = super(context) # super_render(context)
           scss = result.gsub(/^---.*---/m, '')
           data = converter.convert(scss)
 
-          Integrity::Parser.new(@sri_config).calc_integrity(@scss_file, data)
+          # 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]
@@ -65,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.2'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-kw-sri
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Nicolas Karg
@@ -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