hanami 2.1.0.beta2.1 → 2.1.0.rc2

data/lib/hanami/extensions/view/slice_configured_helpers.rb

@@ -3,19 +3,30 @@
 module Hanami
   module Extensions
     module View
-      # @api private
+      # Provides slice-specific helper methods any view object requiring access to helpers.
+      #
+      # @api public
+      # @since 2.1.0
       class SliceConfiguredHelpers < Module
         attr_reader :slice
 
+        # @api private
+        # @since 2.1.0
         def initialize(slice)
           super()
           @slice = slice
         end
 
+        # @api private
+        # @since 2.1.0
         def extended(klass)
           include_helpers(klass)
         end
 
+        # @return [String]
+        #
+        # @api public
+        # @since 2.1.0
         def inspect
           "#<#{self.class.name}[#{slice.name}]>"
         end

data/lib/hanami/extensions/view/slice_configured_part.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Hanami
+  module Extensions
+    module View
+      # Provides slice-specific configuration and behavior for any view part class defined within a
+      # slice's module namespace.
+      #
+      # @api public
+      # @since 2.1.0
+      class SliceConfiguredPart < Module
+        attr_reader :slice
+
+        # @api private
+        # @since 2.1.0
+        def initialize(slice)
+          super()
+          @slice = slice
+        end
+
+        # @api private
+        # @since 2.1.0
+        def extended(klass)
+          define_new
+        end
+
+        # @return [String]
+        #
+        # @api public
+        # @since 2.1.0
+        def inspect
+          "#<#{self.class.name}[#{slice.name}]>"
+        end
+
+        private
+
+        # Defines a `.new` method on the part class that provides a default `rendering:` argument of
+        # a rendering coming from a view configured for the slice. This means that any part can be
+        # initialized standalone (with a `value:` only) and still have access to all the integrated
+        # view facilities from the slice, such as helpers. This is helpful when unit testing parts.
+        #
+        # @example
+        #   module MyApp::Views::Parts
+        #     class Post < MyApp::View::Part
+        #       def title_tag
+        #         helpers.h1(value.title)
+        #       end
+        #     end
+        #   end
+        #
+        #   # Useful when unit testing parts
+        #   part = MyApp::Views::Parts::Post.new(value: hello_world_post)
+        #   part.title_tag # => "<h1>Hello world</h1>"
+        def define_new
+          slice = self.slice
+
+          define_method(:new) do |**args|
+            return super(**args) if args.key?(:rendering)
+
+            slice_rendering = Class.new(Hanami::View)
+              .configure_for_slice(slice)
+              .new
+              .rendering
+
+            super(rendering: slice_rendering, **args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hanami/extensions/view/slice_configured_view.rb

@@ -3,11 +3,11 @@
 module Hanami
   module Extensions
     module View
-      # Provides slice-specific configuration and behavior for any view class defined
-      # within a slice's module namespace.
+      # Provides slice-specific configuration and behavior for any view class defined within a
+      # slice's module namespace.
       #
-      # @api private
-      # @since 2.0.0
+      # @api public
+      # @since 2.1.0
       class SliceConfiguredView < Module
         TEMPLATES_DIR = "templates"
         VIEWS_DIR = "views"
@@ -16,17 +16,25 @@ module Hanami
 
         attr_reader :slice
 
+        # @api private
+        # @since 2.1.0
         def initialize(slice)
           super()
           @slice = slice
         end
 
+        # @api private
+        # @since 2.1.0
         def extended(view_class)
           load_app_view
           configure_view(view_class)
           define_inherited
         end
 
+        # @return [String]
+        #
+        # @api public
+        # @since 2.1.0
         def inspect
           "#<#{self.class.name}[#{slice.name}]>"
         end
@@ -108,7 +116,7 @@ module Hanami
           #   - We are a slice, and the view's inherited `paths` is identical to the parent's config
           #     (which would result in the view in a slice erroneously trying to find templates in
           #     the app)
-          if (!slice.parent && view_class.config.paths.empty?) ||
+          if view_class.config.paths.empty? ||
              (slice.parent && view_class.config.paths.map(&:dir) == [templates_path(slice.parent)])
             view_class.config.paths = templates_path(slice)
           end
@@ -178,7 +186,7 @@ module Hanami
             else
               views_namespace.const_set(:Part, Class.new(part_superclass).tap { |klass|
                 # Give the slice to `configure_for_slice`, since it cannot be inferred when it is
-                # called via `.inherited`, since the class is anonymous at this point
+                # called via `.inherited`, because the class is anonymous at this point
                 klass.configure_for_slice(slice)
               })
             end

data/lib/hanami/extensions/view/standard_helpers.rb

@@ -3,6 +3,10 @@
 module Hanami
   module Extensions
     module View
+      # Module including the standard library of Hanami helpers
+      #
+      # @api public
+      # @since 2.1.0
       module StandardHelpers
         include Hanami::View::Helpers::EscapeHelper
         include Hanami::View::Helpers::NumberFormattingHelper

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

@@ -99,62 +99,62 @@ module Hanami
       #
       # @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>
-      def javascript(*source_paths, **options)
+      def javascript_tag(*source_paths, **options)
         options = options.reject { |k, _| k.to_sym == :src }
 
         _safe_tags(*source_paths) do |source|
@@ -173,14 +173,6 @@ module Hanami
         end
       end
 
-      # @api public
-      # @since 2.1.0
-      alias_method :js, :javascript
-
-      # @api public
-      # @since 2.1.0
-      alias_method :javascript_tag, :javascript
-
       # Generate `link` tag for given source(s)
       #
       # It accepts one or more strings representing the name of the asset, if it
@@ -211,51 +203,51 @@ module Hanami
       #
       # @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">
-      def stylesheet(*source_paths, **options)
+      def stylesheet_tag(*source_paths, **options)
         options = options.reject { |k, _| k.to_sym == :href }
 
         _safe_tags(*source_paths) do |source_path|
@@ -275,14 +267,6 @@ module Hanami
         end
       end
 
-      # @api public
-      # @since 2.1.0
-      alias_method :css, :stylesheet
-
-      # @api public
-      # @since 2.1.0
-      alias_method :stylesheet_link_tag, :stylesheet
-
       # Generate `img` tag for given source
       #
       # It accepts one string representing the name of the asset, if it comes
@@ -313,40 +297,40 @@ module Hanami
       #
       # @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(source, options = {})
+      def image_tag(source, options = {})
         options = options.reject { |k, _| k.to_sym == :src }
         attributes = {
           src: asset_url(source),
@@ -357,10 +341,6 @@ module Hanami
         tag.img(**attributes)
       end
 
-      # @api public
-      # @since 2.1.0
-      alias_method :image_tag, :image
-
       # Generate `link` tag application favicon.
       #
       # If no argument is given, it assumes `favico.ico` from the application.
@@ -388,35 +368,35 @@ module Hanami
       #
       # @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">
-      def favicon(source = DEFAULT_FAVICON, options = {})
+      def favicon_tag(source = DEFAULT_FAVICON, options = {})
         options = options.reject { |k, _| k.to_sym == :href }
 
         attributes = {
@@ -429,10 +409,6 @@ module Hanami
         tag.link(**attributes)
       end
 
-      # @api public
-      # @since 2.1.0
-      alias_method :favicon_link_tag, :favicon
-
       # Generate `video` tag for given source
       #
       # It accepts one string representing the name of the asset, if it comes
@@ -466,19 +442,19 @@ module Hanami
       #
       # @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>
       #
@@ -509,36 +485,32 @@ 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(source = nil, options = {}, &blk)
+      def video_tag(source = nil, options = {}, &blk)
         options = _source_options(source, options, &blk)
         tag.video(**options, &blk)
       end
 
-      # @api public
-      # @since 2.1.0
-      alias_method :video_tag, :video
-
       # Generate `audio` tag for given source
       #
       # It accepts one string representing the name of the asset, if it comes
@@ -572,19 +544,19 @@ module Hanami
       #
       # @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>
       #
@@ -615,36 +587,32 @@ 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(source = nil, options = {}, &blk)
+      def audio_tag(source = nil, options = {}, &blk)
         options = _source_options(source, options, &blk)
         tag.audio(**options, &blk)
       end
 
-      # @api public
-      # @since 2.1.0
-      alias_method :audio_tag, :audio
-
       # It generates the relative or absolute URL for the given asset.
       # It automatically decides if it has to use the relative or absolute
       # depending on the configuration and current environment.

data/lib/hanami/routes.rb

@@ -60,6 +60,35 @@ module Hanami
       end
     end
 
+    # Wrapper class for the (otherwise opaque) proc returned from {.routes}, adding an `#empty?`
+    # method that returns true if no routes were defined.
+    #
+    # This is useful when needing to determine behaviour based on the presence of user-defined
+    # routes, such as determining whether to show the Hanami welcome page in {Slice#load_router}.
+    #
+    # @api private
+    # @since 2.1.0
+    class RoutesProc < DelegateClass(Proc)
+      # @api private
+      # @since 2.1.0
+      def self.empty
+        new(proc {}, empty: true)
+      end
+
+      # @api private
+      # @since 2.1.0
+      def initialize(proc, empty: false)
+        @empty = empty
+        super(proc)
+      end
+
+      # @api private
+      # @since 2.1.0
+      def empty?
+        !!@empty
+      end
+    end
+
     # @api private
     def self.routes
       @routes ||= build_routes
@@ -68,9 +97,9 @@ module Hanami
     class << self
       # @api private
       def build_routes(definitions = self.definitions)
-        return if definitions.empty?
+        return RoutesProc.empty if definitions.empty?
 
-        proc do
+        routes_proc = proc do
           definitions.each do |(name, args, kwargs, block)|
             if block
               public_send(name, *args, **kwargs, &block)
@@ -79,6 +108,8 @@ module Hanami
             end
           end
         end
+
+        RoutesProc.new(routes_proc)
       end
 
       # @api private