hanami-assets 1.1.1 → 1.2.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d71de2dd9edf00f8046d10907f60b555b0391d3079bc81b58bd88ec68d7eaf4
-  data.tar.gz: 823426740462f9e3d5a5357de6d6fe15d761dec2130e4e0363fe51f8b4ffebd7
+  metadata.gz: dee96814cdbdc9c4b0bf4519052da244585da7ce22f1ee9d002ef2bfde88344d
+  data.tar.gz: 7a0607dac9d21de73b5052c5b02efb7e1cf316fb278cc19fee6a197780dfb890
 SHA512:
-  metadata.gz: c6de7ae4f3605ea0ea0a823f14699ba8b6c4358652fb377e70af78fb5147ae33554352de2d40ba168c8039836f359c8769f44107d107cd1aa4cda7e04c6fb06b
-  data.tar.gz: fd1f5db6af660bfd1893495ce5059f915d8855c8b404fc648515dbadbcfc55d800f83867f9417f32a88399a86887d2a6b1da1cac07bd5b7e0af3233c697437c7
+  metadata.gz: 8a984c83ee52c5d75c9175376090b1f00bad151ca63d354d2dd626ae955defeebd685999726be12f5b884bbd6fcb5b3c49304fa8ed2425f9de1cb74708b39270
+  data.tar.gz: 13217797668cc3bba5369fbabd88f69796a16752193f0fbf57f270f990e1e332ec71616dc0c751a25691e1517845dc621ca5a3038032b4b2fac38e929fcf2a4f

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 # Hanami::Assets
 Assets management for Ruby web applications
 
+## v1.2.0.beta1 - 2018-02-28
+### Added
+- [Luca Guidi] Collect assets informations for Early Hints (103)
+- [Luca Guidi] Send automatically javascripts and stylesheets via Push Promise / Early Hints
+- [Luca Guidi] Add the ability to send audio, video, and generic assets for Push Promise / Early Hints
+
 ## v1.1.1 - 2018-02-27
 ### Added
 - [Luca Guidi] Official support for Ruby: MRI 2.5

data/hanami-assets.gemspec

@@ -20,8 +20,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.3.0'
 
-  spec.add_runtime_dependency 'hanami-utils',    '~> 1.1'
-  spec.add_runtime_dependency 'hanami-helpers',  '~> 1.1'
+  spec.add_runtime_dependency 'hanami-utils',    '1.2.0.beta1'
+  spec.add_runtime_dependency 'hanami-helpers',  '1.2.0.beta1'
   spec.add_runtime_dependency 'tilt',            '~> 2.0', '>= 2.0.2'
 
   spec.add_development_dependency 'bundler'

data/lib/hanami/assets/configuration.rb

@@ -412,6 +412,18 @@ module Hanami
         "#{@base_url}#{compile_path(source)}"
       end
 
+      # Check if the given source is linked via Cross-Origin policy.
+      # In other words, the given source, doesn't satisfy the Same-Origin policy.
+      #
+      # @see https://en.wikipedia.org/wiki/Same-origin_policy#Origin_determination_rules
+      # @see https://en.wikipedia.org/wiki/Same-origin_policy#document.domain_property
+      #
+      # @since 1.2.0
+      # @api private
+      def crossorigin?(source)
+        !source.start_with?(@base_url)
+      end
+
       # An array of crypographically secure hashing algorithms to use for
       # generating asset subresource integrity checks
       #

data/lib/hanami/assets/helpers.rb

@@ -1,5 +1,4 @@
 require 'uri'
-require 'set'
 require 'hanami/helpers/html_helper'
 require 'hanami/utils/escape'
 
@@ -97,7 +96,11 @@ module Hanami
       # name of the algorithm, then a hyphen, then the hash value of the file.
       # If more than one algorithm is used, they'll be separated by a space.
       #
+      # It makes the script(s) eligible for HTTP/2 Push Promise/Early Hints.
+      # You can opt-out with inline option: `push: false`.
+      #
       # @param sources [Array<String>] one or more assets by name or absolute URL
+      # @param push [TrueClass, FalseClass] HTTP/2 Push Promise/Early Hints flag
       #
       # @return [Hanami::Utils::Escape::SafeString] the markup
       #
@@ -165,12 +168,17 @@ module Hanami
       #   <%= javascript 'application' %>
       #
       #   # <script src="https://assets.bookshelf.org/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.js" type="text/javascript"></script>
-      def javascript(*sources, **options) # rubocop:disable Metrics/MethodLength
+      #
+      # @example Disable Push Promise/Early Hints
+      #
+      #   <%= javascript 'application', push: false %>
+      #   <%= javascript 'http://cdn.example.test/jquery.js', 'dashboard', push: false %>
+      def javascript(*sources, push: true, **options) # rubocop:disable Metrics/MethodLength
         options = options.reject { |k, _| k.to_sym == :src }
 
         _safe_tags(*sources) do |source|
           attributes = {
-            src:  _typed_asset_path(source, JAVASCRIPT_EXT),
+            src:  _typed_asset_path(source, JAVASCRIPT_EXT, push: push, as: :script),
             type: JAVASCRIPT_MIME_TYPE
           }
           attributes.merge!(options)
@@ -199,7 +207,12 @@ module Hanami
       # If the "subresource integrity mode" is on, <tt>integriy</tt> is the
       # name of the algorithm, then a hyphen, then the hashed value of the file.
       # If more than one algorithm is used, they'll be separated by a space.
+      #
+      # It makes the script(s) eligible for HTTP/2 Push Promise/Early Hints.
+      # You can opt-out with inline option: `push: false`.
+      #
       # @param sources [Array<String>] one or more assets by name or absolute URL
+      # @param push [TrueClass, FalseClass] HTTP/2 Push Promise/Early Hints flag
       #
       # @return [Hanami::Utils::Escape::SafeString] the markup
       #
@@ -256,12 +269,17 @@ module Hanami
       #   <%= stylesheet 'application' %>
       #
       #   # <link href="https://assets.bookshelf.org/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.css" type="text/css" rel="stylesheet">
-      def stylesheet(*sources, **options) # rubocop:disable Metrics/MethodLength
+      #
+      # @example Disable Push Promise/Early Hints
+      #
+      #   <%= stylesheet 'application', push: false %>
+      #   <%= stylesheet 'http://cdn.example.test/bootstrap.css', 'dashboard', push: false %>
+      def stylesheet(*sources, push: true, **options) # rubocop:disable Metrics/MethodLength
         options = options.reject { |k, _| k.to_sym == :href }
 
         _safe_tags(*sources) do |source|
           attributes = {
-            href: _typed_asset_path(source, STYLESHEET_EXT),
+            href: _typed_asset_path(source, STYLESHEET_EXT, push: push, as: :style),
             type: STYLESHEET_MIME_TYPE,
             rel:  STYLESHEET_REL
           }
@@ -292,6 +310,8 @@ module Hanami
       # application CDN.
       #
       # @param source [String] asset name or absolute URL
+      # @param options [Hash] HTML 5 attributes
+      # @option options [TrueClass, FalseClass] :push HTTP/2 Push Promise/Early Hints flag
       #
       # @return [Hanami::Utils::Helpers::HtmlBuilder] the builder
       #
@@ -341,11 +361,14 @@ module Hanami
       #   <%= image 'logo.png' %>
       #
       #   # <img src="https://assets.bookshelf.org/assets/logo-28a6b886de2372ee3922fcaf3f78f2d8.png" alt="Logo">
+      #
+      # @example Enable Push Promise/Early Hints
+      #
+      #   <%= image 'logo.png', push: true %>
       def image(source, options = {})
         options = options.reject { |k, _| k.to_sym == :src }
-
         attributes = {
-          src: asset_path(source),
+          src: asset_path(source, push: options.delete(:push) || false, as: :image),
           alt: Utils::String.titleize(::File.basename(source, WILDCARD_EXT))
         }
         attributes.merge!(options)
@@ -366,6 +389,8 @@ module Hanami
       # application CDN.
       #
       # @param source [String] asset name
+      # @param options [Hash] HTML 5 attributes
+      # @option options [TrueClass, FalseClass] :push HTTP/2 Push Promise/Early Hints flag
       #
       # @return [Hanami::Utils::Helpers::HtmlBuilder] the builder
       #
@@ -393,7 +418,7 @@ module Hanami
       #
       # @example Custom HTML Attributes
       #
-      #   <%= favicon id: 'fav' %>
+      #   <%= favicon "favicon.ico", id: "fav" %>
       #
       #   # <link id: "fav" href="/assets/favicon.ico" rel="shortcut icon" type="image/x-icon">
       #
@@ -408,11 +433,15 @@ module Hanami
       #   <%= favicon %>
       #
       #   # <link href="https://assets.bookshelf.org/assets/favicon-28a6b886de2372ee3922fcaf3f78f2d8.ico" rel="shortcut icon" type="image/x-icon">
+      #
+      # @example Enable Push Promise/Early Hints
+      #
+      #   <%= favicon 'favicon.ico', push: true %>
       def favicon(source = DEFAULT_FAVICON, options = {})
         options = options.reject { |k, _| k.to_sym == :href }
 
         attributes = {
-          href: asset_path(source),
+          href: asset_path(source, push: options.delete(:push) || false, as: :image),
           rel:  FAVICON_REL,
           type: FAVICON_MIME_TYPE
         }
@@ -437,6 +466,8 @@ module Hanami
       # application CDN.
       #
       # @param source [String] asset name or absolute URL
+      # @param options [Hash] HTML 5 attributes
+      # @option options [TrueClass, FalseClass] :push HTTP/2 Push Promise/Early Hints flag
       #
       # @return [Hanami::Utils::Helpers::HtmlBuilder] the builder
       #
@@ -535,8 +566,20 @@ module Hanami
       #   <%= video 'movie.mp4' %>
       #
       #   # <video src="https://assets.bookshelf.org/assets/movie-28a6b886de2372ee3922fcaf3f78f2d8.mp4"></video>
+      #
+      # @example Enable Push Promise/Early Hints
+      #
+      #   <%= video 'movie.mp4', push: true %>
+      #
+      # <%=
+      #   video do
+      #     text "Your browser does not support the video tag"
+      #     source src: asset_path("movie.mp4", push: :video), type: "video/mp4"
+      #     source src: asset_path("movie.ogg"), type: "video/ogg"
+      #   end
+      # %>
       def video(source = nil, options = {}, &blk)
-        options = _source_options(source, options, &blk)
+        options = _source_options(source, options, as: :video, &blk)
         html.video(blk, options)
       end
 
@@ -556,6 +599,8 @@ module Hanami
       # application CDN.
       #
       # @param source [String] asset name or absolute URL
+      # @param options [Hash] HTML 5 attributes
+      # @option options [TrueClass, FalseClass] :push HTTP/2 Push Promise/Early Hints flag
       #
       # @return [Hanami::Utils::Helpers::HtmlBuilder] the builder
       #
@@ -654,8 +699,20 @@ module Hanami
       #   <%= audio 'song.ogg' %>
       #
       #   # <audio src="https://assets.bookshelf.org/assets/song-28a6b886de2372ee3922fcaf3f78f2d8.ogg"></audio>
+      #
+      # @example Enable Push Promise/Early Hints
+      #
+      #   <%= audio 'movie.mp4', push: true %>
+      #
+      # <%=
+      #   audio do
+      #     text "Your browser does not support the audio tag"
+      #     source src: asset_path("song.ogg", push: :audio), type: "audio/ogg"
+      #     source src: asset_path("song.wav"), type: "audio/wav"
+      #   end
+      # %>
       def audio(source = nil, options = {}, &blk)
-        options = _source_options(source, options, &blk)
+        options = _source_options(source, options, as: :audio, &blk)
         html.audio(blk, options)
       end
 
@@ -671,6 +728,8 @@ module Hanami
       # If CDN mode is on, it returns the absolute URL of the asset.
       #
       # @param source [String] the asset name
+      # @param push [TrueClass, FalseClass, Symbol] HTTP/2 Push Promise/Early Hints flag, or type
+      # @param as [Symbol] HTTP/2 Push Promise / Early Hints flag type
       #
       # @return [String] the asset path
       #
@@ -703,8 +762,12 @@ module Hanami
       #   <%= asset_path 'application.js' %>
       #
       #   # "https://assets.bookshelf.org/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.js"
-      def asset_path(source)
-        _asset_url(source) { _relative_url(source) }
+      #
+      # @example Enable Push Promise/Early Hints
+      #
+      #   <%= asset_path "application.js", push: :script %>
+      def asset_path(source, push: false, as: nil)
+        _asset_url(source, push: push, as: as) { _relative_url(source) }
       end
 
       # It generates the absolute URL for the given source.
@@ -719,6 +782,8 @@ module Hanami
       # If CDN mode is on, it returns the absolute URL of the asset.
       #
       # @param source [String] the asset name
+      # @param push [TrueClass, FalseClass, Symbol] HTTP/2 Push Promise/Early Hints flag, or type
+      # @param as [Symbol] HTTP/2 Push Promise / Early Hints flag type
       #
       # @return [String] the asset URL
       #
@@ -751,8 +816,12 @@ module Hanami
       #   <%= asset_url 'application.js' %>
       #
       #   # "https://assets.bookshelf.org/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.js"
-      def asset_url(source)
-        _asset_url(source) { _absolute_url(source) }
+      #
+      # @example Enable Push Promise/Early Hints
+      #
+      #   <%= asset_url "application.js", push: :script %>
+      def asset_url(source, push: false, as: nil)
+        _asset_url(source, push: push, as: as) { _absolute_url(source) }
       end
 
       private
@@ -769,18 +838,24 @@ module Hanami
 
       # @since 0.1.0
       # @api private
-      def _asset_url(source)
-        _push_promise(
-          _absolute_url?(source) ? # rubocop:disable Style/MultilineTernaryOperator
-            source : yield
-        )
+      def _asset_url(source, push:, as:)
+        url = _absolute_url?(source) ? source : yield
+
+        case push
+        when Symbol
+          _push_promise(url, as: push)
+        when TrueClass
+          _push_promise(url, as: as)
+        end
+
+        url
       end
 
       # @since 0.1.0
       # @api private
-      def _typed_asset_path(source, ext)
+      def _typed_asset_path(source, ext, push: false, as: nil)
         source = "#{source}#{ext}" if _append_extension?(source, ext)
-        asset_path(source)
+        asset_path(source, push: push, as: as)
       end
 
       # @api private
@@ -800,6 +875,13 @@ module Hanami
         ABSOLUTE_URL_MATCHER.match(source)
       end
 
+      # @since 1.2.0
+      # @api private
+      def _crossorigin?(source)
+        return false unless _absolute_url?(source)
+        self.class.assets_configuration.crossorigin?(source)
+      end
+
       # @since 0.1.0
       # @api private
       def _relative_url(source)
@@ -814,13 +896,13 @@ module Hanami
 
       # @since 0.1.0
       # @api private
-      def _source_options(src, options, &_blk)
+      def _source_options(src, options, as:, &_blk)
         options ||= {}
 
         if src.respond_to?(:to_hash)
           options = src.to_hash
         elsif src
-          options[:src] = asset_path(src)
+          options[:src] = asset_path(src, push: options.delete(:push) || false, as: as)
         end
 
         if !options[:src] && !block_given?
@@ -832,11 +914,9 @@ module Hanami
 
       # @since 0.1.0
       # @api private
-      def _push_promise(url)
-        Mutex.new.synchronize do
-          Thread.current[:__hanami_assets] ||= Set.new
-          Thread.current[:__hanami_assets].add(url.to_s)
-        end
+      def _push_promise(url, as: nil)
+        Thread.current[:__hanami_assets] ||= {}
+        Thread.current[:__hanami_assets][url.to_s] = { as: as, crossorigin: _crossorigin?(url) }
 
         url
       end

data/lib/hanami/assets/version.rb

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

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: hanami-assets
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0.beta1
 platform: ruby
 authors:
 - Luca Guidi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-27 00:00:00.000000000 Z
+date: 2018-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hanami-utils
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 1.2.0.beta1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 1.2.0.beta1
 - !ruby/object:Gem::Dependency
   name: hanami-helpers
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 1.2.0.beta1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 1.2.0.beta1
 - !ruby/object:Gem::Dependency
   name: tilt
   requirement: !ruby/object:Gem::Requirement
@@ -240,9 +240,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.5