jekyll-kw-sri 0.0.1 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2973377b85291043610eda6a787a2e0b90cd8a5bacc1e97307e12141d506922c
-  data.tar.gz: 0ce8ffe029793579111eb924cd2da6ae01542b597a8a8a1203275eefa2cb4302
+  metadata.gz: 8105f15bb469e5ce9f911724cca9d4c0f91a5c5562c57cf19d0175c99f1f6937
+  data.tar.gz: 56ec904adb6f25f4e837d7666b25a6beda5fee4ce6fc61d731fee22354442282
 SHA512:
-  metadata.gz: 562282c803da6ee51304bc436d2186b5f06e9ca66dca84453207570b9db17881be5d73ffbc5fc0bffaeaf3be77e2d56d2cd99f415a0295536e98640554850c0c
-  data.tar.gz: e6c3f3650a781d0391729bac08fc3ebe812c46fee4fe81b2a836d3810da207000b08a51bd3cdfec7eb5a54a45bd70d5d3494cef6c271cdda165fa9256b390ba5
+  metadata.gz: 4c295991eb27a6f634f2781f6016d94e66651a067d0f25eaf961e6e3d3ea9597cec1793756eb34969609e7dc41627f787498a8745948bfc866c87609a67697ba
+  data.tar.gz: 802d07f5d15b93bbccc0af363e33ebff5752a7e8764bb1679a7e15e7d28f3445c90adf8eac26b3fe7a3d789ef9712619368be74e97d53ca092fd122f75838a31

data/README.md

@@ -1,5 +1,7 @@
 # jekyll-kw-sri
 
+[![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.
 
 > **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.
@@ -8,7 +10,7 @@ from [Mozilla docs][Mozilla Subresource Integrity]
 
 ## 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:
@@ -25,18 +27,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)
@@ -48,8 +78,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.
@@ -90,12 +118,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/lib/jekyll-kw-sri.rb

@@ -10,15 +10,14 @@ module Jekyll
     # 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
       end
 
       # def syntax_example
@@ -26,11 +25,6 @@ module Jekyll
       # end
 
       def render(context)
-        # return '' unless context.registers[:page]['sri']
-
-        # # Read the global configuration
-        # @sri_config = context.registers[:site].config['kw-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'
@@ -38,15 +32,25 @@ module Jekyll
             context = Liquid::Context.new({}, {}, { site: site })
           else
             site = context.registers[:site]
+            # Read the global configuration
+            @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
 
@@ -66,11 +70,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.1'
+  VERSION = '0.0.6'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-kw-sri
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.6
 platform: ruby
 authors:
 - Nicolas Karg