jekyll-kw-sri 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bf7b33dc9b54d2ebcec17404f4bf5548760edba5148f8bf35b78a721d307293
-  data.tar.gz: 03f1d62d5b555a4225c4d352d744de1152b8976afda0332dd7d5510b8c17a1dc
+  metadata.gz: 21baed53f8e36155187629181d0d0db471bb7e8c5002e7121998d6a2e8009a0b
+  data.tar.gz: fcce7592fcaa7901d35c418ee53f36e84747924ab3f5600749a185d8719a610d
 SHA512:
-  metadata.gz: 1a9fe066a7815dff331e10b68da1c3d83ae020afc901bdb81624aeb970d794fad34c2e53290481c4295a648dcf88e9d0c33c75fae707adf140efd81c10d34d7b
-  data.tar.gz: 4165a4c3b504a10622cc7991e13302bd3ee5c76ee8e62df7d86b28ed5a03268d87badf9c62c7881a89f6c7df25f69fdcb30b1deb008bbf258db7e5f84076d11d
+  metadata.gz: 6c50c84167e0febc7402d51df4bc66c040fb048899e9e58024847439319202fbcf89e59f8c7a9771b44f0b8f01fab290a76614728b0a094dc4a498b19c415062
+  data.tar.gz: e29ed92a20699f71a692141c25faf0b6eb79cab9e8c20d96cf4b18981a092d149211c9f80fdb493930c4d85203d979b324bcc77aa2cfbc27f7231420b2aaaa88

data/README.md

@@ -10,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:
@@ -27,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)
@@ -50,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.
@@ -92,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

@@ -11,19 +11,13 @@ module Jekyll
     class SriScssHashTag < Jekyll::Tags::IncludeRelativeTag
       # class SriScssHashTag < Liquid::Tag
 
-      alias super_render render
+      # 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
@@ -31,8 +25,6 @@ module Jekyll
       # 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,17 +36,20 @@ 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
@@ -74,15 +69,6 @@ module Jekyll
           @cached_scss[path] = compute.call
         end
       end
-
-      # https://stackoverflow.com/a/1000975
-      def strip_or_self(str)
-        str.strip! || str
-      end
-
-      def tag_includes_dirs(context)
-        [context.registers[:site].source].freeze
-      end
     end
   end
 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.0.5'
 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.0.5
 platform: ruby
 authors:
 - Nicolas Karg