hanami 2.1.0.rc1 → 2.1.0.rc3

data/lib/hanami/extensions/view.rb

@@ -7,13 +7,13 @@ module Hanami
   module Extensions
     # Integrated behavior for `Hanami::View` classes within Hanami apps.
     #
-    # This is NOT RELEASED as of 2.0.0.
-    #
     # @see Hanami::View
     #
-    # @api private
+    # @api public
+    # @since 2.1.0
     module View
       # @api private
+      # @since 2.1.0
       def self.included(view_class)
         super
 
@@ -22,8 +22,10 @@ module Hanami
       end
 
       # @api private
+      # @since 2.1.0
       module ClassMethods
         # @api private
+        # @since 2.1.0
         def configure_for_slice(slice)
           extend SliceConfiguredView.new(slice)
         end

data/lib/hanami/helpers/assets_helper.rb

@@ -11,47 +11,47 @@ module Hanami
     #
     # Inject these helpers in a view
     #
-    # @since 0.1.0
+    # @since 2.1.0
     #
     # @see http://www.rubydoc.info/gems/hanami-helpers/Hanami/Helpers/HtmlHelper
     module AssetsHelper
-      # @since 0.1.0
+      # @since 2.1.0
       # @api private
       NEW_LINE_SEPARATOR = "\n"
 
-      # @since 0.1.0
+      # @since 2.1.0
       # @api private
       WILDCARD_EXT = ".*"
 
-      # @since 0.1.0
+      # @since 2.1.0
       # @api private
       JAVASCRIPT_EXT = ".js"
 
-      # @since 0.1.0
+      # @since 2.1.0
       # @api private
       STYLESHEET_EXT = ".css"
 
-      # @since 0.1.0
+      # @since 2.1.0
       # @api private
       JAVASCRIPT_MIME_TYPE = "text/javascript"
 
-      # @since 0.1.0
+      # @since 2.1.0
       # @api private
       STYLESHEET_MIME_TYPE = "text/css"
 
-      # @since 0.1.0
+      # @since 2.1.0
       # @api private
       FAVICON_MIME_TYPE = "image/x-icon"
 
-      # @since 0.1.0
+      # @since 2.1.0
       # @api private
       STYLESHEET_REL = "stylesheet"
 
-      # @since 0.1.0
+      # @since 2.1.0
       # @api private
       FAVICON_REL = "shortcut icon"
 
-      # @since 0.1.0
+      # @since 2.1.0
       # @api private
       DEFAULT_FAVICON = "favicon.ico"
 
@@ -85,7 +85,7 @@ 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.
       #
-      # @param sources [Array<String>] one or more assets by name or absolute URL
+      # @param source_paths [Array<String, #url>] one or more assets by name or absolute URL
       #
       # @return [Hanami::View::HTML::SafeString] the markup
       #
@@ -93,64 +93,64 @@ module Hanami
       # `subresource_integrity` modes are on and the javascript file is missing
       # from the manifest
       #
-      # @since 0.1.0
+      # @since 2.1.0
       #
       # @see Hanami::Assets::Helpers#path
       #
       # @example Single Asset
       #
-      #   <%= js "application" %>
+      #   <%= javascript_tag "application" %>
       #
       #   # <script src="/assets/application.js" type="text/javascript"></script>
       #
       # @example Multiple Assets
       #
-      #   <%= js "application", "dashboard" %>
+      #   <%= javascript_tag "application", "dashboard" %>
       #
       #   # <script src="/assets/application.js" type="text/javascript"></script>
       #   # <script src="/assets/dashboard.js" type="text/javascript"></script>
       #
       # @example Asynchronous Execution
       #
-      #   <%= js "application", async: true %>
+      #   <%= javascript_tag "application", async: true %>
       #
       #   # <script src="/assets/application.js" type="text/javascript" async="async"></script>
       #
       # @example Subresource Integrity
       #
-      #   <%= js "application" %>
+      #   <%= javascript_tag "application" %>
       #
       #   # <script src="/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.js"
       #   #         type="text/javascript" integrity="sha384-oqVu...Y8wC" crossorigin="anonymous"></script>
       #
       # @example Subresource Integrity for 3rd Party Scripts
       #
-      #   <%= js "https://example.com/assets/example.js", integrity: "sha384-oqVu...Y8wC" %>
+      #   <%= javascript_tag "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
       #
-      #   <%= js "application", defer: true %>
+      #   <%= javascript_tag "application", defer: true %>
       #
       #   # <script src="/assets/application.js" type="text/javascript" defer="defer"></script>
       #
       # @example Absolute URL
       #
-      #   <%= js "https://code.jquery.com/jquery-2.1.4.min.js" %>
+      #   <%= javascript_tag "https://code.jquery.com/jquery-2.1.4.min.js" %>
       #
       #   # <script src="https://code.jquery.com/jquery-2.1.4.min.js" type="text/javascript"></script>
       #
       # @example Fingerprint Mode
       #
-      #   <%= js "application" %>
+      #   <%= javascript_tag "application" %>
       #
       #   # <script src="/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.js" type="text/javascript"></script>
       #
       # @example CDN Mode
       #
-      #   <%= js "application" %>
+      #   <%= javascript_tag "application" %>
       #
       #   # <script src="https://assets.bookshelf.org/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.js"
       #   #         type="text/javascript"></script>
@@ -189,7 +189,7 @@ module Hanami
       # 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.
       #
-      # @param sources [Array<String>] one or more assets by name or absolute URL
+      # @param source_paths [Array<String, #url>] one or more assets by name or absolute URL
       #
       # @return [Hanami::View::HTML::SafeString] the markup
       #
@@ -197,53 +197,53 @@ module Hanami
       # `subresource_integrity` modes are on and the stylesheet file is missing
       # from the manifest
       #
-      # @since 0.1.0
+      # @since 2.1.0
       #
       # @see Hanami::Assets::Helpers#path
       #
       # @example Single Asset
       #
-      #   <%= css "application" %>
+      #   <%= stylesheet_tag "application" %>
       #
       #   # <link href="/assets/application.css" type="text/css" rel="stylesheet">
       #
       # @example Multiple Assets
       #
-      #   <%= css "application", "dashboard" %>
+      #   <%= stylesheet_tag "application", "dashboard" %>
       #
       #   # <link href="/assets/application.css" type="text/css" rel="stylesheet">
       #   # <link href="/assets/dashboard.css" type="text/css" rel="stylesheet">
       #
       # @example Subresource Integrity
       #
-      #   <%= css "application" %>
+      #   <%= stylesheet_tag "application" %>
       #
       #   # <link href="/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.css"
       #   #       type="text/css" integrity="sha384-oqVu...Y8wC" crossorigin="anonymous"></script>
       #
       # @example Subresource Integrity for 3rd Party Assets
       #
-      #   <%= css "https://example.com/assets/example.css", integrity: "sha384-oqVu...Y8wC" %>
+      #   <%= stylesheet_tag "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
       #
-      #   <%= css "https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css" %>
+      #   <%= stylesheet_tag "https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css" %>
       #
       #   # <link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css"
       #   #       type="text/css" rel="stylesheet">
       #
       # @example Fingerprint Mode
       #
-      #   <%= css "application" %>
+      #   <%= stylesheet_tag "application" %>
       #
       #   # <link href="/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.css" type="text/css" rel="stylesheet">
       #
       # @example CDN Mode
       #
-      #   <%= css "application" %>
+      #   <%= stylesheet_tag "application" %>
       #
       #   # <link href="https://assets.bookshelf.org/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.css"
       #   #       type="text/css" rel="stylesheet">
@@ -282,7 +282,7 @@ module Hanami
       # If the "CDN mode" is on, the `src` is an absolute URL of the
       # application CDN.
       #
-      # @param source [String] asset name or absolute URL
+      # @param source [String, #url] asset name, absolute URL, or asset object
       # @param options [Hash] HTML 5 attributes
       #
       # @return [Hanami::View::HTML::SafeString] the markup
@@ -291,43 +291,43 @@ module Hanami
       # `subresource_integrity` modes are on and the image file is missing
       # from the manifest
       #
-      # @since 0.1.0
+      # @since 2.1.0
       #
       # @see Hanami::Assets::Helpers#path
       #
       # @example Basic Usage
       #
-      #   <%= image "logo.png" %>
+      #   <%= image_tag "logo.png" %>
       #
       #   # <img src="/assets/logo.png" alt="Logo">
       #
       # @example Custom alt Attribute
       #
-      #   <%= image "logo.png", alt: "Application Logo" %>
+      #   <%= image_tag "logo.png", alt: "Application Logo" %>
       #
       #   # <img src="/assets/logo.png" alt="Application Logo">
       #
       # @example Custom HTML Attributes
       #
-      #   <%= image "logo.png", id: "logo", class: "image" %>
+      #   <%= image_tag "logo.png", id: "logo", class: "image" %>
       #
       #   # <img src="/assets/logo.png" alt="Logo" id="logo" class="image">
       #
       # @example Absolute URL
       #
-      #   <%= image "https://example-cdn.com/images/logo.png" %>
+      #   <%= image_tag "https://example-cdn.com/images/logo.png" %>
       #
       #   # <img src="https://example-cdn.com/images/logo.png" alt="Logo">
       #
       # @example Fingerprint Mode
       #
-      #   <%= image "logo.png" %>
+      #   <%= image_tag "logo.png" %>
       #
       #   # <img src="/assets/logo-28a6b886de2372ee3922fcaf3f78f2d8.png" alt="Logo">
       #
       # @example CDN Mode
       #
-      #   <%= image "logo.png" %>
+      #   <%= image_tag "logo.png" %>
       #
       #   # <img src="https://assets.bookshelf.org/assets/logo-28a6b886de2372ee3922fcaf3f78f2d8.png" alt="Logo">
       def image_tag(source, options = {})
@@ -353,7 +353,7 @@ module Hanami
       # If the "CDN mode" is on, the `href` is an absolute URL of the
       # application CDN.
       #
-      # @param source [String] asset name
+      # @param source [String, #url] asset name or asset object
       # @param options [Hash] HTML 5 attributes
       #
       # @return [Hanami::View::HTML::SafeString] the markup
@@ -362,37 +362,37 @@ module Hanami
       # `subresource_integrity` modes are on and the favicon is file missing
       # from the manifest
       #
-      # @since 0.1.0
+      # @since 2.1.0
       #
       # @see Hanami::Assets::Helpers#path
       #
       # @example Basic Usage
       #
-      #   <%= favicon %>
+      #   <%= favicon_tag %>
       #
       #   # <link href="/assets/favicon.ico" rel="shortcut icon" type="image/x-icon">
       #
       # @example Custom Path
       #
-      #   <%= favicon "fav.ico" %>
+      #   <%= favicon_tag "fav.ico" %>
       #
       #   # <link href="/assets/fav.ico" rel="shortcut icon" type="image/x-icon">
       #
       # @example Custom HTML Attributes
       #
-      #   <%= favicon "favicon.ico", id: "fav" %>
+      #   <%= favicon_tag "favicon.ico", id: "fav" %>
       #
       #   # <link id: "fav" href="/assets/favicon.ico" rel="shortcut icon" type="image/x-icon">
       #
       # @example Fingerprint Mode
       #
-      #   <%= favicon %>
+      #   <%= favicon_tag %>
       #
       #   # <link href="/assets/favicon-28a6b886de2372ee3922fcaf3f78f2d8.ico" rel="shortcut icon" type="image/x-icon">
       #
       # @example CDN Mode
       #
-      #   <%= favicon %>
+      #   <%= favicon_tag %>
       #
       #   # <link href="https://assets.bookshelf.org/assets/favicon-28a6b886de2372ee3922fcaf3f78f2d8.ico"
       #           rel="shortcut icon" type="image/x-icon">
@@ -424,7 +424,7 @@ module Hanami
       # If the "CDN mode" is on, the `src` is an absolute URL of the
       # application CDN.
       #
-      # @param source [String] asset name or absolute URL
+      # @param source [String, #url] asset name, absolute URL or asset object
       # @param options [Hash] HTML 5 attributes
       #
       # @return [Hanami::View::HTML::SafeString] the markup
@@ -436,25 +436,25 @@ module Hanami
       # @raise [ArgumentError] if source isn"t specified both as argument or
       #   tag inside the given block
       #
-      # @since 0.1.0
+      # @since 2.1.0
       #
       # @see Hanami::Assets::Helpers#path
       #
       # @example Basic Usage
       #
-      #   <%= video "movie.mp4" %>
+      #   <%= video_tag "movie.mp4" %>
       #
       #   # <video src="/assets/movie.mp4"></video>
       #
       # @example Absolute URL
       #
-      #   <%= video "https://example-cdn.com/assets/movie.mp4" %>
+      #   <%= video_tag "https://example-cdn.com/assets/movie.mp4" %>
       #
       #   # <video src="https://example-cdn.com/assets/movie.mp4"></video>
       #
       # @example Custom HTML Attributes
       #
-      #   <%= video("movie.mp4", autoplay: true, controls: true) %>
+      #   <%= video_tag("movie.mp4", autoplay: true, controls: true) %>
       #
       #   # <video src="/assets/movie.mp4" autoplay="autoplay" controls="controls"></video>
       #
@@ -485,25 +485,25 @@ module Hanami
       #
       # @example Without Any Argument
       #
-      #   <%= video %>
+      #   <%= video_tag %>
       #
       #   # ArgumentError
       #
       # @example Without src And Without Block
       #
-      #   <%= video(content: true) %>
+      #   <%= video_tag(content: true) %>
       #
       #   # ArgumentError
       #
       # @example Fingerprint Mode
       #
-      #   <%= video "movie.mp4" %>
+      #   <%= video_tag "movie.mp4" %>
       #
       #   # <video src="/assets/movie-28a6b886de2372ee3922fcaf3f78f2d8.mp4"></video>
       #
       # @example CDN Mode
       #
-      #   <%= video "movie.mp4" %>
+      #   <%= video_tag "movie.mp4" %>
       #
       #   # <video src="https://assets.bookshelf.org/assets/movie-28a6b886de2372ee3922fcaf3f78f2d8.mp4"></video>
       def video_tag(source = nil, options = {}, &blk)
@@ -526,7 +526,7 @@ module Hanami
       # If the "CDN mode" is on, the `src` is an absolute URL of the
       # application CDN.
       #
-      # @param source [String] asset name or absolute URL
+      # @param source [String, #url] asset name, absolute URL or asset object
       # @param options [Hash] HTML 5 attributes
       #
       # @return [Hanami::View::HTML::SafeString] the markup
@@ -538,25 +538,25 @@ module Hanami
       # @raise [ArgumentError] if source isn"t specified both as argument or
       #   tag inside the given block
       #
-      # @since 0.1.0
+      # @since 2.1.0
       #
       # @see Hanami::Assets::Helpers#path
       #
       # @example Basic Usage
       #
-      #   <%= audio "song.ogg" %>
+      #   <%= audio_tag "song.ogg" %>
       #
       #   # <audio src="/assets/song.ogg"></audio>
       #
       # @example Absolute URL
       #
-      #   <%= audio "https://example-cdn.com/assets/song.ogg" %>
+      #   <%= audio_tag "https://example-cdn.com/assets/song.ogg" %>
       #
       #   # <audio src="https://example-cdn.com/assets/song.ogg"></audio>
       #
       # @example Custom HTML Attributes
       #
-      #   <%= audio("song.ogg", autoplay: true, controls: true) %>
+      #   <%= audio_tag("song.ogg", autoplay: true, controls: true) %>
       #
       #   # <audio src="/assets/song.ogg" autoplay="autoplay" controls="controls"></audio>
       #
@@ -587,25 +587,25 @@ module Hanami
       #
       # @example Without Any Argument
       #
-      #   <%= audio %>
+      #   <%= audio_tag %>
       #
       #   # ArgumentError
       #
       # @example Without src And Without Block
       #
-      #   <%= audio(controls: true) %>
+      #   <%= audio_tag(controls: true) %>
       #
       #   # ArgumentError
       #
       # @example Fingerprint Mode
       #
-      #   <%= audio "song.ogg" %>
+      #   <%= audio_tag "song.ogg" %>
       #
       #   # <audio src="/assets/song-28a6b886de2372ee3922fcaf3f78f2d8.ogg"></audio>
       #
       # @example CDN Mode
       #
-      #   <%= audio "song.ogg" %>
+      #   <%= audio_tag "song.ogg" %>
       #
       #   # <audio src="https://assets.bookshelf.org/assets/song-28a6b886de2372ee3922fcaf3f78f2d8.ogg"></audio>
       def audio_tag(source = nil, options = {}, &blk)
@@ -626,7 +626,7 @@ module Hanami
       #
       # If CDN mode is on, it returns the absolute URL of the asset.
       #
-      # @param source [String] the asset name
+      # @param source_path [String, #url] the asset name or asset object
       #
       # @return [String] the asset path
       #
@@ -634,7 +634,7 @@ module Hanami
       # `subresource_integrity` modes are on and the asset is missing
       # from the manifest
       #
-      # @since 0.1.0
+      # @since 2.1.0
       #
       # @example Basic Usage
       #
@@ -666,6 +666,7 @@ module Hanami
       #
       #   # "https://assets.bookshelf.org/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.js"
       def asset_url(source_path)
+        return source_path.url if source_path.respond_to?(:url)
         return source_path if _absolute_url?(source_path)
 
         _context.assets[source_path].url
@@ -673,7 +674,7 @@ module Hanami
 
       private
 
-      # @since 0.1.0
+      # @since 2.1.0
       # @api private
       def _safe_tags(*source_paths, &blk)
         ::Hanami::View::HTML::SafeString.new(
@@ -684,7 +685,7 @@ module Hanami
       # @since 2.1.0
       # @api private
       def _typed_path(source, ext)
-        source = "#{source}#{ext}" if _append_extension?(source, ext)
+        source = "#{source}#{ext}" if source.is_a?(String) && _append_extension?(source, ext)
         asset_url(source)
       end
 
@@ -696,7 +697,7 @@ module Hanami
         _context.assets[source_path].sri
       end
 
-      # @since 0.1.0
+      # @since 2.1.0
       # @api private
       def _absolute_url?(source)
         ABSOLUTE_URL_MATCHER.match(source)
@@ -710,7 +711,7 @@ module Hanami
         _context.assets.crossorigin?(source)
       end
 
-      # @since 0.1.0
+      # @since 2.1.0
       # @api private
       def _source_options(src, options, &blk)
         options ||= {}