hanami-assets 0.2.1 → 0.3.0

data/lib/hanami/assets/configuration.rb

@@ -12,50 +12,58 @@ module Hanami
     # Framework configuration
     #
     # @since 0.1.0
-    class Configuration
+    class Configuration # rubocop:disable Metrics/ClassLength
       # @since 0.1.0
       # @api private
-      DEFAULT_SCHEME           = 'http'.freeze
+      DEFAULT_SCHEME                          = 'http'.freeze
 
       # @since 0.1.0
       # @api private
-      DEFAULT_HOST             = 'localhost'.freeze
+      DEFAULT_HOST                            = 'localhost'.freeze
 
       # @since 0.1.0
       # @api private
-      DEFAULT_PORT             = '2300'.freeze
+      DEFAULT_PORT                            = '2300'.freeze
 
       # @since 0.1.0
       # @api private
-      DEFAULT_PUBLIC_DIRECTORY = 'public'.freeze
+      DEFAULT_PUBLIC_DIRECTORY                = 'public'.freeze
 
       # @since 0.1.0
       # @api private
-      DEFAULT_MANIFEST         = 'assets.json'.freeze
+      DEFAULT_MANIFEST                        = 'assets.json'.freeze
 
       # @since 0.1.0
       # @api private
-      DEFAULT_PREFIX           = '/assets'.freeze
+      DEFAULT_PREFIX                          = '/assets'.freeze
 
       # @since 0.1.0
       # @api private
-      URL_SEPARATOR            = '/'.freeze
+      URL_SEPARATOR                           = '/'.freeze
 
       # @since 0.1.0
       # @api private
-      HTTP_SCHEME              = 'http'.freeze
+      HTTP_SCHEME                             = 'http'.freeze
 
       # @since 0.1.0
       # @api private
-      HTTP_PORT                = '80'.freeze
+      HTTP_PORT                               = '80'.freeze
 
       # @since 0.1.0
       # @api private
-      HTTPS_SCHEME             = 'https'.freeze
+      HTTPS_SCHEME                            = 'https'.freeze
 
       # @since 0.1.0
       # @api private
-      HTTPS_PORT               = '443'.freeze
+      HTTPS_PORT                              = '443'.freeze
+
+      # @since 0.3.0
+      # @api private
+      DEFAULT_SUBRESOURCE_INTEGRITY_ALGORITHM = :sha256
+
+      # @since 0.3.0
+      # @api private
+      SUBRESOURCE_INTEGRITY_SEPARATOR         = ' '.freeze
 
       # Return a copy of the configuration of the framework instance associated
       # with the given class.
@@ -72,7 +80,7 @@ module Hanami
       # @since 0.1.0
       # @api private
       def self.for(base)
-        # TODO this implementation is similar to Hanami::Controller::Configuration consider to extract it into Hanami::Utils
+        # TODO: this implementation is similar to Hanami::Controller::Configuration consider to extract it into Hanami::Utils
         namespace = Utils::String.new(base).namespace
         framework = Utils::Class.load_from_pattern!("(#{namespace}|Hanami)::Assets")
         framework.configuration
@@ -120,6 +128,22 @@ module Hanami
         end
       end
 
+      # Subresource integrity mode
+      #
+      # Determine if the helpers should generate the integrity attribute for an
+      # asset. Usually this is turned on in production mode.
+      #
+      # @since 0.3.0
+      def subresource_integrity(*values)
+        if values.empty?
+          @subresource_integrity
+        elsif values.length == 1
+          @subresource_integrity = values.first
+        else
+          @subresource_integrity = values
+        end
+      end
+
       # CDN mode
       #
       # Determine if the helpers should always generate absolute URL.
@@ -130,7 +154,7 @@ module Hanami
         if value.nil?
           @cdn
         else
-          @cdn = !!value
+          @cdn = !!value # rubocop:disable Style/DoubleNegation
         end
       end
 
@@ -352,6 +376,13 @@ module Hanami
         sources.files
       end
 
+      # @since 0.3.0
+      # @api private
+      def source(file)
+        pathname = Pathname.new(file)
+        pathname.absolute? ? pathname : find(file)
+      end
+
       # Find a file from sources
       #
       # @since 0.1.0
@@ -365,9 +396,11 @@ module Hanami
       # @since 0.1.0
       # @api private
       def asset_path(source)
-        cdn ?
-          asset_url(source) :
+        if cdn
+          asset_url(source)
+        else
           compile_path(source)
+        end
       end
 
       # Absolute URL
@@ -375,7 +408,33 @@ module Hanami
       # @since 0.1.0
       # @api private
       def asset_url(source)
-        "#{ @base_url }#{ compile_path(source) }"
+        "#{@base_url}#{compile_path(source)}"
+      end
+
+      # An array of digest algorithms to use for generating asset subresource
+      # integrity checks
+      #
+      # @since 0.3.0
+      def subresource_integrity_algorithms
+        if @subresource_integrity == true
+          [DEFAULT_SUBRESOURCE_INTEGRITY_ALGORITHM]
+        else
+          # Using Array() allows us to accept Array or Symbol, and '|| nil' lets
+          # us return an empty array when @subresource_integrity is `false`
+          Array(@subresource_integrity || nil)
+        end
+      end
+
+      # Subresource integrity attribute
+      #
+      # @since 0.3.0
+      # @api private
+      def subresource_integrity_value(source)
+        if subresource_integrity
+          digest_manifest.subresource_integrity_values(
+            prefix.join(source)
+          ).join(SUBRESOURCE_INTEGRITY_SEPARATOR)
+        end
       end
 
       # Load Javascript compressor
@@ -414,13 +473,14 @@ module Hanami
 
       # @since 0.1.0
       # @api private
-      def duplicate
+      def duplicate # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
         Configuration.new.tap do |c|
           c.root                  = root
           c.scheme                = scheme
           c.host                  = host
           c.port                  = port
           c.prefix                = prefix
+          c.subresource_integrity = subresource_integrity
           c.cdn                   = cdn
           c.compile               = compile
           c.public_directory      = public_directory
@@ -433,14 +493,17 @@ module Hanami
 
       # @since 0.1.0
       # @api private
-      def reset!
+      def reset! # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
         @scheme                = DEFAULT_SCHEME
         @host                  = DEFAULT_HOST
         @port                  = DEFAULT_PORT
 
         @prefix                = Utils::PathPrefix.new(DEFAULT_PREFIX)
+        @subresource_integrity = false
         @cdn                   = false
+        @digest                = false
         @compile               = false
+        @base_url              = nil
         @destination_directory = nil
         @digest_manifest       = Config::NullDigestManifest.new(self)
 
@@ -458,7 +521,7 @@ module Hanami
       #
       # @since 0.1.0
       def load!
-        if digest && manifest_path.exist?
+        if (digest || subresource_integrity) && manifest_path.exist?
           @digest_manifest = Config::DigestManifest.new(
             JSON.load(manifest_path.read),
             manifest_path
@@ -470,6 +533,10 @@ module Hanami
 
       protected
 
+      # @since 0.3.0
+      # @api private
+      attr_writer :subresource_integrity
+
       # @since 0.1.0
       # @api private
       attr_writer :cdn
@@ -524,15 +591,15 @@ module Hanami
       # @api private
       def compile_path(source)
         result = prefix.join(source)
-        result = digest_manifest.resolve(result) if digest
+        result = digest_manifest.target(result) if digest
         result.to_s
       end
 
       # @since 0.1.0
       # @api private
       def url_port
-        ( (scheme == HTTP_SCHEME  && port == HTTP_PORT  ) ||
-          (scheme == HTTPS_SCHEME && port == HTTPS_PORT ) ) ? nil : port.to_i
+        ((scheme == HTTP_SCHEME && port == HTTP_PORT) || # rubocop:disable Style/MultilineTernaryOperator
+          (scheme == HTTPS_SCHEME && port == HTTPS_PORT)) ? nil : port.to_i
       end
     end
   end

data/lib/hanami/assets/helpers.rb

@@ -13,7 +13,7 @@ module Hanami
     # @since 0.1.0
     #
     # @see http://www.rubydoc.info/gems/hanami-helpers/Hanami/Helpers/HtmlHelper
-    module Helpers
+    module Helpers # rubocop:disable Metrics/ModuleLength
       # @since 0.1.0
       # @api private
       NEW_LINE_SEPARATOR = "\n".freeze
@@ -54,6 +54,14 @@ module Hanami
       # @api private
       DEFAULT_FAVICON = 'favicon.ico'.freeze
 
+      # @since 0.3.0
+      # @api private
+      CROSSORIGIN_ANONYMOUS = 'anonymous'.freeze
+
+      # @since 0.3.0
+      # @api private
+      ABSOLUTE_URL_MATCHER = URI::Parser.new.make_regexp
+
       include Hanami::Helpers::HtmlHelper
 
       # Inject helpers into the given class
@@ -108,6 +116,30 @@ module Hanami
       #   # <script src="/assets/application.js" type="text/javascript"></script>
       #   # <script src="/assets/dashboard.js" type="text/javascript"></script>
       #
+      # @example Asynchronous Execution
+      #
+      #   <%= javascript 'application', async: true %>
+      #
+      #   # <script src="/assets/application.js" type="text/javascript" async="async"></script>
+      #
+      # @example Subresource Integrity
+      #
+      #   <%= javascript 'application' %>
+      #
+      #   # <script src="/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.js" type="text/javascript" integrity="sha384-oqVu...Y8wC" crossorigin="anonymous"></script>
+      #
+      # @example Subresource Integrity for 3rd Party Scripts
+      #
+      #   <%= javascript 'https://example.com/assets/example.js', integrity: 'sha384-oqVu...Y8wC' %>
+      #
+      #   # <script src="https://example.com/assets/example.js" type="text/javascript" integrity="sha384-oqVu...Y8wC" crossorigin="anonymous"></script>
+      #
+      # @example Deferred Execution
+      #
+      #   <%= javascript 'application', defer: true %>
+      #
+      #   # <script src="/assets/application.js" type="text/javascript" defer="defer"></script>
+      #
       # @example Absolute URL
       #
       #   <%= javascript 'https://code.jquery.com/jquery-2.1.4.min.js' %>
@@ -125,9 +157,18 @@ module Hanami
       #   <%= javascript 'application' %>
       #
       #   # <script src="https://assets.bookshelf.org/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.js" type="text/javascript"></script>
-      def javascript(*sources)
+      def javascript(*sources, **options)
         _safe_tags(*sources) do |source|
-          html.script(src: _typed_asset_path(source, JAVASCRIPT_EXT), type: JAVASCRIPT_MIME_TYPE).to_s
+          tag_options = options.dup
+          tag_options[:src] ||= _typed_asset_path(source, JAVASCRIPT_EXT)
+          tag_options[:type] ||= JAVASCRIPT_MIME_TYPE
+
+          if _subresource_integrity? || tag_options.include?(:integrity)
+            tag_options[:integrity] ||= _subresource_integrity_value(source, JAVASCRIPT_EXT)
+            tag_options[:crossorigin] ||= CROSSORIGIN_ANONYMOUS
+          end
+
+          html.script(**tag_options).to_s
         end
       end
 
@@ -169,6 +210,18 @@ module Hanami
       #   # <link href="/assets/application.css" type="text/css" rel="stylesheet">
       #   # <link href="/assets/dashboard.css" type="text/css" rel="stylesheet">
       #
+      # @example Subresource Integrity
+      #
+      #   <%= stylesheet 'application' %>
+      #
+      #   # <link href="/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.css" type="text/css" integrity="sha384-oqVu...Y8wC" crossorigin="anonymous"></script>
+      #
+      # @example Subresource Integrity for 3rd Party Assets
+      #
+      #   <%= stylesheet 'https://example.com/assets/example.css', integrity: 'sha384-oqVu...Y8wC' %>
+      #
+      #   # <link href="https://example.com/assets/example.css" type="text/css" rel="stylesheet" integrity="sha384-oqVu...Y8wC" crossorigin="anonymous"></script>
+      #
       # @example Absolute URL
       #
       #   <%= stylesheet 'https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css' %>
@@ -186,9 +239,19 @@ module Hanami
       #   <%= stylesheet 'application' %>
       #
       #   # <link href="https://assets.bookshelf.org/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.css" type="text/css" rel="stylesheet">
-      def stylesheet(*sources)
+      def stylesheet(*sources, **options) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
         _safe_tags(*sources) do |source|
-          html.link(href: _typed_asset_path(source, STYLESHEET_EXT), type: STYLESHEET_MIME_TYPE, rel: STYLESHEET_REL).to_s
+          tag_options = options.dup
+          tag_options[:href] ||= _typed_asset_path(source, STYLESHEET_EXT)
+          tag_options[:type] ||= STYLESHEET_MIME_TYPE
+          tag_options[:rel] ||= STYLESHEET_REL
+
+          if _subresource_integrity? || tag_options.include?(:integrity)
+            tag_options[:integrity] ||= _subresource_integrity_value(source, STYLESHEET_EXT)
+            tag_options[:crossorigin] ||= CROSSORIGIN_ANONYMOUS
+          end
+
+          html.link(**tag_options).to_s
         end
       end
 
@@ -670,7 +733,7 @@ module Hanami
       # @api private
       def _asset_url(source)
         _push_promise(
-          _absolute_url?(source) ?
+          _absolute_url?(source) ? # rubocop:disable Style/MultilineTernaryOperator
             source : yield
         )
       end
@@ -678,14 +741,23 @@ module Hanami
       # @since 0.1.0
       # @api private
       def _typed_asset_path(source, ext)
-        source = "#{ source }#{ ext }" unless source.match(/#{ Regexp.escape(ext) }\z/)
+        source = "#{source}#{ext}" unless source =~ /#{Regexp.escape(ext)}\z/
         asset_path(source)
       end
 
+      def _subresource_integrity?
+        !!self.class.assets_configuration.subresource_integrity # rubocop:disable Style/DoubleNegation
+      end
+
+      def _subresource_integrity_value(source, ext)
+        source = "#{source}#{ext}" unless source =~ /#{Regexp.escape(ext)}\z/
+        self.class.assets_configuration.subresource_integrity_value(source) unless _absolute_url?(source)
+      end
+
       # @since 0.1.0
       # @api private
       def _absolute_url?(source)
-        URI.regexp.match(source)
+        ABSOLUTE_URL_MATCHER.match(source)
       end
 
       # @since 0.1.0
@@ -702,7 +774,7 @@ module Hanami
 
       # @since 0.1.0
       # @api private
-      def _source_options(src, options, &blk)
+      def _source_options(src, options, &_blk)
         options ||= {}
 
         if src.respond_to?(:to_hash)

data/lib/hanami/assets/precompiler.rb

@@ -1,3 +1,4 @@
+require 'fileutils'
 require 'hanami/assets/compiler'
 
 module Hanami
@@ -30,22 +31,35 @@ module Hanami
       # @since 0.1.0
       # @api private
       def run
-        clear_public_directory
+        clear_assets_directory
         precompile
       end
 
       private
 
-      # @since 0.1.0
+      # @since 0.3.0
       # @api private
-      def clear_public_directory
-        public_directory = @configuration.public_directory
-        public_directory.rmtree if public_directory.exist?
+      def clear_assets_directory
+        delete @configuration.manifest_path
+        delete @configuration.destination_directory
+      end
+
+      # @since 0.3.0
+      # @api private
+      def clear_manifest(manifest)
+        JSON.load(manifest).each do |_, asset_hash|
+          asset_file_name = @configuration.public_directory.join(asset_hash['target'])
+          asset_file_name.unlink if asset_file_name.exist?
+        end
+      rescue JSON::ParserError
+        $stderr.puts 'Non JSON manifest found and unlinked.'
+      ensure
+        manifest.unlink
       end
 
       # @since 0.1.0
       # @api private
-      def precompile
+      def precompile # rubocop:disable Metrics/MethodLength
         applications.each do |duplicate|
           config = if duplicate.respond_to?(:configuration)
                      duplicate.configuration
@@ -64,8 +78,17 @@ module Hanami
       # @since 0.1.0
       # @api private
       def applications
-        @duplicates.empty? ?
-          [@configuration] : @duplicates
+        if @duplicates.empty?
+          [@configuration]
+        else
+          @duplicates
+        end
+      end
+
+      # @since 0.3.0
+      # @api private
+      def delete(path)
+        FileUtils.rm_rf(path) if path.exist?
       end
     end
   end

data/lib/hanami/assets/version.rb

@@ -3,6 +3,6 @@ module Hanami
     # Defines the version
     #
     # @since 0.1.0
-    VERSION = '0.2.1'.freeze
+    VERSION = '0.3.0'.freeze
   end
 end

data/lib/hanami/assets.rb

@@ -93,22 +93,22 @@ module Hanami
     #   Hanami::Assets.sources << '/path/to/emberjs/assets'
     def self.sources
       synchronize do
-        @@sources ||= Config::GlobalSources.new
+        @@sources ||= Config::GlobalSources.new # rubocop:disable Style/ClassVars
       end
     end
 
     # Duplicate the framework and generate modules for the target application
     #
-    # @param mod [Module] the Ruby namespace of the application
+    # @param _mod [Module] the Ruby namespace of the application
     # @param blk [Proc] an optional block to configure the framework
     #
     # @return [Module] a copy of Hanami::Assets
     #
-    # @since 0.1.0
+    # @since 0.1.0
     #
     # @see Hanami::Assets#dupe
     # @see Hanami::Assets::Configuration
-    def self.duplicate(mod, &blk)
+    def self.duplicate(_mod, &blk)
       dupe.tap do |duplicated|
         duplicated.configure(&blk) if block_given?
         duplicates << duplicated
@@ -143,16 +143,18 @@ module Hanami
     # @see Hanami::Assets#dupe
     def self.duplicates
       synchronize do
-        @@duplicates ||= Array.new
+        @@duplicates ||= [] # rubocop:disable Style/ClassVars
       end
     end
 
-    private
+    class << self
+      private
 
-    # @since 0.1.0
-    # @api private
-    def self.synchronize(&blk)
-      Mutex.new.synchronize(&blk)
+      # @since 0.1.0
+      # @api private
+      def synchronize(&blk)
+        Mutex.new.synchronize(&blk)
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hanami-assets
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Luca Guidi
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-05 00:00:00.000000000 Z
+date: 2016-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hanami-utils
@@ -18,28 +18,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: hanami-helpers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: tilt
   requirement: !ruby/object:Gem::Requirement
@@ -80,14 +80,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '11'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -203,8 +203,13 @@ files:
 - hanami-assets.gemspec
 - lib/hanami/assets.rb
 - lib/hanami/assets/bundler.rb
+- lib/hanami/assets/bundler/asset.rb
+- lib/hanami/assets/bundler/compressor.rb
+- lib/hanami/assets/bundler/manifest_entry.rb
 - lib/hanami/assets/cache.rb
 - lib/hanami/assets/compiler.rb
+- lib/hanami/assets/compilers/less.rb
+- lib/hanami/assets/compilers/sass.rb
 - lib/hanami/assets/compressors/abstract.rb
 - lib/hanami/assets/compressors/builtin_javascript.rb
 - lib/hanami/assets/compressors/builtin_stylesheet.rb
@@ -236,7 +241,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -244,9 +249,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: Assets management
 test_files: []
-has_rdoc: