hanami 1.1.1 → 1.2.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d87fe440f006e096c96ad18f1c20428ba4a279df2ee1dbce4ee122cf9ff59b12
-  data.tar.gz: 8f40361860a2eef0fdbf9eea31cc88588cc3caa2bcc509b1fa40d6817060b951
+  metadata.gz: 8a9410374b4c5778d39a7929a839012e22563268752d4937c4afe6343a74cd0c
+  data.tar.gz: 9fb8af94de128436c1e1cde83c79dc52c2321baa3ddf3605da7b97cb5a5e6195
 SHA512:
-  metadata.gz: 3228003ed57778a29753c440948cc82b2b4a93f9f201ec5836372bf33a3ca8af1535acd36d4ca94eb55c227df3c2503409e2ac9c8972809184e7eafa1e3f855e
-  data.tar.gz: b57b87929454289abc9ce08d8ddcb35ab57ece912b12fd66791e486785187a222fa36a425d89853589c63e0e40950b6afca3a73f93a80f0cf5f6d540d6690c43
+  metadata.gz: 021c99d12215c9932a830cfd1b00efa6f4049eebd98513b0469f6a38a811557a7da1c6e040cf9cdbae15ace92a3fc9d4fe349c5f492817868647c65f51b61b2e
+  data.tar.gz: 04a48aedeb9a843f63b4ed5cee9523f1d94fcc088034b8335bc94c6e8774af737a3b44601979d3609312ccba403a1283d8e0e92fac3539ade749a22675735277

data/hanami.gemspec

@@ -21,15 +21,15 @@ Gem::Specification.new do |spec|
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
-  spec.add_dependency 'hanami-utils',       '~> 1.1'
-  spec.add_dependency 'hanami-validations', '~> 1.1'
-  spec.add_dependency 'hanami-router',      '~> 1.1'
-  spec.add_dependency 'hanami-controller',  '~> 1.1'
-  spec.add_dependency 'hanami-view',        '~> 1.1'
-  spec.add_dependency 'hanami-helpers',     '~> 1.1'
-  spec.add_dependency 'hanami-mailer',      '~> 1.1'
-  spec.add_dependency 'hanami-assets',      '~> 1.1'
-  spec.add_dependency 'hanami-cli',         '~> 0.1'
+  spec.add_dependency 'hanami-utils',       '1.2.0.beta1'
+  spec.add_dependency 'hanami-validations', '1.2.0.beta1'
+  spec.add_dependency 'hanami-router',      '1.2.0.beta1'
+  spec.add_dependency 'hanami-controller',  '1.2.0.beta1'
+  spec.add_dependency 'hanami-view',        '1.2.0.beta1'
+  spec.add_dependency 'hanami-helpers',     '1.2.0.beta1'
+  spec.add_dependency 'hanami-mailer',      '1.2.0.beta1'
+  spec.add_dependency 'hanami-assets',      '1.2.0.beta1'
+  spec.add_dependency 'hanami-cli',         '0.2.0.beta1'
   spec.add_dependency 'concurrent-ruby',    '~> 1.0'
   spec.add_dependency 'bundler'
 

data/lib/hanami.rb

@@ -21,6 +21,7 @@ module Hanami
   # @api private
   # @since 0.9.0
   @_mutex = Mutex.new
+  @_plugins = Concurrent::Array.new
 
   # Configure Hanami project
   #
@@ -77,6 +78,39 @@ module Hanami
     end
   end
 
+  # Configure a plugin
+  #
+  # @see Hanami.configure
+  #
+  # @since x.x.x
+  def self.plugin(&blk)
+    @_plugins << blk
+  end
+
+  # Plugins registry
+  #
+  # NOTE: We can't use `Components` registry.
+  #
+  # Plugins are loaded when Bundler requires `Gemfile` gems.
+  # During this phase the `Components` that we can resolve are erased by the
+  # first incoming request in development.
+  # They are erased by a workaround that we had to put in place in `Hanami.boot`.
+  # This workaround is `Components.release` and it was introduced because
+  # `shotgun` failed to reload components, so we have to release for each
+  # incoming request.
+  # After the `Components` registry is cleared up, Hanami is able to resolve all
+  # the components from scratch.
+  #
+  # When we'll switch to `hanami-reloader` for development, we can remove
+  # `Components.release` and we'll be able to store plugins in `Components` and
+  # remove `Hanami.plugins` as well.
+  #
+  # @since x.x.x
+  # @api private
+  def self.plugins
+    @_plugins
+  end
+
   # Boot your Hanami project
   #
   # NOTE: In case this is invoked many times, it guarantees that the boot

data/lib/hanami/app.rb

@@ -26,8 +26,10 @@ module Hanami
       @routes  = Hanami::Router.new
 
       mount(configuration)
-      middleware(environment)
+      middleware(configuration, environment)
       builder.run(routes)
+
+      @app = builder.to_app
     end
 
     # Implements Rack SPEC
@@ -39,11 +41,15 @@ module Hanami
     # @since 0.9.0
     # @api private
     def call(env)
-      builder.call(env)
+      app.call(env)
     end
 
     private
 
+    # @since x.x.x
+    # @api private
+    attr_reader :app
+
     # @since 0.9.0
     # @api private
     attr_reader :builder
@@ -62,15 +68,29 @@ module Hanami
 
     # @since 0.9.0
     # @api private
-    def middleware(environment)
+    #
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
+    def middleware(configuration, environment)
       builder.use Hanami::CommonLogger, Hanami.logger unless Hanami.logger.nil?
       builder.use Rack::ContentLength
 
+      configuration.middleware.each do |m, args, blk|
+        builder.use(m, *args, &blk)
+      end
+
+      if configuration.early_hints
+        require 'hanami/early_hints'
+        builder.use Hanami::EarlyHints
+      end
+
       if middleware = environment.static_assets_middleware # rubocop:disable Lint/AssignmentInCondition
         builder.use middleware
       end
 
       builder.use Rack::MethodOverride
     end
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize
   end
 end

data/lib/hanami/cli/commands/new.rb

@@ -299,7 +299,7 @@ module Hanami
             application_name: options.fetch(:application_name),
             application_base_url: options.fetch(:application_base_url),
             hanami_head: options.fetch(:hanami_head),
-            hanami_model_version: '~> 1.1',
+            hanami_model_version: '1.2.0.beta1',
             code_reloading: code_reloading?,
             hanami_version: hanami_version,
             project_module: Utils::String.classify(project),

data/lib/hanami/cli/commands/new/Gemfile.erb

@@ -36,6 +36,8 @@ group :development do
   # Code reloading
   # See: http://hanamirb.org/guides/projects/code-reloading
   gem 'shotgun'
+
+  gem 'hanami-webconsole'
 end
 
 <%- end -%>

data/lib/hanami/cli/commands/new/config/environment.erb

@@ -16,7 +16,7 @@ Hanami.configure do
     #    adapter :sql, 'postgresql://localhost/<%= project %>_development'
     #    adapter :sql, 'mysql://localhost/<%= project %>_development'
     #
-    adapter :<%= database_config_hash[:type] %>, ENV['DATABASE_URL']
+    adapter :<%= database_config_hash[:type] %>, ENV.fetch('DATABASE_URL')
 
     <%- if database_config.sql? -%>
     ##
@@ -43,7 +43,7 @@ Hanami.configure do
     logger level: :info, formatter: :json, filter: []
 
     mailer do
-      delivery :smtp, address: ENV['SMTP_HOST'], port: ENV['SMTP_PORT']
+      delivery :smtp, address: ENV.fetch('SMTP_HOST'), port: ENV.fetch('SMTP_PORT')
     end
   end
 end

data/lib/hanami/components/components.rb

@@ -323,7 +323,7 @@ module Hanami
     # @since 0.9.0
     # @api private
     register 'finalizers' do
-      requires 'finalizers.initializers'
+      requires 'plugins', 'finalizers.initializers'
 
       resolve { true }
     end
@@ -340,6 +340,18 @@ module Hanami
       end
     end
 
+    # Load plugins
+    #
+    # @since x.x.x
+    # @api private
+    register 'plugins' do
+      resolve do |configuration|
+        Hanami.plugins.each do |plugin_configuration|
+          configuration.instance_eval(&plugin_configuration)
+        end
+      end
+    end
+
     # Configure, load and finalize a Hanami application in the project
     #
     # @since 0.9.0

data/lib/hanami/configuration.rb

@@ -1,5 +1,4 @@
 require 'concurrent'
-require 'delegate'
 require 'hanami/application'
 require 'hanami/utils/class'
 require 'hanami/utils/string'
@@ -7,17 +6,8 @@ require 'hanami/utils/string'
 module Hanami
   # @api private
   class Configuration
-    # @api private
-    class App < SimpleDelegator
-      # @api private
-      attr_reader :path_prefix
-
-      # @api private
-      def initialize(app, path_prefix)
-        super(app)
-        @path_prefix = path_prefix
-      end
-    end
+    require "hanami/configuration/app"
+    require "hanami/configuration/middleware"
 
     # @api private
     def initialize(&blk)
@@ -107,6 +97,36 @@ module Hanami
       settings.fetch_or_store(:mounted, {})
     end
 
+    # @since x.x.x
+    def middleware
+      settings.fetch_or_store(:middleware, Configuration::Middleware.new)
+    end
+
+    # Setup Early Hints feature
+    #
+    # @since x.x.x
+    #
+    # @example Enable for all the environments
+    #   # config/environment.rb
+    #   Hanami.configure do
+    #     early_hints true
+    #   end
+    #
+    # @example Enable only for production
+    #   # config/environment.rb
+    #   Hanami.configure do
+    #     environment :production do
+    #       early_hints true
+    #     end
+    #   end
+    def early_hints(value = nil)
+      if value.nil?
+        settings.fetch(:early_hints, false)
+      else
+        settings[:early_hints] = value
+      end
+    end
+
     # @since 0.9.0
     # @api private
     def apps

data/lib/hanami/configuration/app.rb

@@ -0,0 +1,18 @@
+require "delegate"
+
+module Hanami
+  # @api private
+  class Configuration
+    # @api private
+    class App < SimpleDelegator
+      # @api private
+      attr_reader :path_prefix
+
+      # @api private
+      def initialize(app, path_prefix)
+        super(app)
+        @path_prefix = path_prefix
+      end
+    end
+  end
+end

data/lib/hanami/configuration/middleware.rb

@@ -0,0 +1,37 @@
+require "concurrent"
+
+module Hanami
+  # @api private
+  class Configuration
+    # Middleware configuration
+    class Middleware
+      # @api private
+      def initialize
+        @middleware = Concurrent::Array.new
+      end
+
+      # Use a Rack middleware
+      #
+      # @param middleware [#call] a Rack middleware
+      # @param args [Array<Object>] an optional set of options
+      # @param blk [Proc] an optional block to pass to the middleware
+      #
+      # @since x.x.x
+      #
+      # @example
+      #   # config/environment.rb
+      #   # ...
+      #   Hanami.configure do
+      #     middleware.use MyRackMiddleware
+      #   end
+      def use(middleware, *args, &blk)
+        @middleware.push([middleware, args, blk])
+      end
+
+      # @api private
+      def each(&blk)
+        @middleware.each(&blk)
+      end
+    end
+  end
+end

data/lib/hanami/early_hints.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module Hanami
+  # HTTP/2 Early Hints Rack middleware
+  #
+  # It sends extra responses **before** the main reponse is sent.
+  # These extra responses are HTTP/2 Early Hints (103).
+  # They specify the web assets (javascripts, stylesheets, etc..) to be "pushed",
+  # so modern browsers pre-fetch them in parallel with the main HTTP response.
+  #
+  # @see https://tools.ietf.org/html/draft-ietf-httpbis-early-hints-05
+  #
+  # @since x.x.x
+  # @api private
+  class EarlyHints
+    # @since x.x.x
+    # @api private
+    class NotSupportedByServerError < ::StandardError
+      # @since x.x.x
+      # @api private
+      def initialize
+        super("Current Ruby server doesn't support Early Hints.\nPlease make sure to use a web server with Early Hints enabled (only Puma for now).")
+      end
+    end
+
+    # @since x.x.x
+    # @api private
+    def initialize(app)
+      @app = app
+    end
+
+    # @param env [Hash] Rack env
+    #
+    # @return [Array,Rack::Response] a Rack response
+    #
+    # @raise [Hanami::EarlyHints::NotSupportedByServerError] if the current Ruby
+    #   server doesn't support Early Hints
+    #
+    # @since x.x.x
+    # @api private
+    def call(env)
+      @app.call(env).tap do
+        send_early_hints(env)
+      end
+    end
+
+    private
+
+    # Pushing a lot of assets may exceed the limit of HTTP headers of a single
+    # Early Hints (103) response.
+    #
+    # For this reason we send multiple Early Hints (103) responses for each `n`
+    # assets. We call this `n` number `BATCH_SIZE`.
+    #
+    # If the current page needs to push 23 assets, it will send 3 Early Hints
+    # (103) responses:
+    #
+    #   1. Response #1: 10 assets
+    #   2. Response #2: 10 assets
+    #   3. Response #3: 3 assets
+    #
+    # @since x.x.x
+    # @api private
+    BATCH_SIZE = 10
+
+    # Rack servers that support Early Hints (only Puma for now),
+    # inject an object into the Rack env to send multiple Early Hints (103)
+    # responses.
+    #
+    # @since x.x.x
+    # @api private
+    #
+    # @see https://github.com/puma/puma/pull/1403
+    RACK_EARLY_HINTS_ENV_KEY = "rack.early_hints"
+
+    # This cache key is used by `hanami-assets` to collect the assets that are
+    # eligible to be pushed.
+    #
+    # It stores these values in a thread-local variable.
+    #
+    # NOTE: if changing this key here, it MUST be changed into `hanami-assets` as well
+    #
+    # @since x.x.x
+    # @api private
+    CACHE_KEY = :__hanami_assets
+
+    # Tries to send multiple Early Hints (103) HTTP responses, if there are
+    # assets eligible.
+    #
+    # @param env [Hash] Rack env
+    #
+    # @raise [Hanami::EarlyHints::NotSupportedByServerError] if the current Ruby
+    #   server doesn't support Early Hints
+    #
+    # @since x.x.x
+    # @api private
+    def send_early_hints(env)
+      return if Thread.current[CACHE_KEY].nil?
+
+      Thread.current[CACHE_KEY].each_slice(BATCH_SIZE) do |slice|
+        link = slice.map do |asset, options|
+          ret = %(<#{asset}>; rel=preload)
+          ret += "; as=#{options[:as]}" unless options[:as].nil?
+          ret += "; crossorigin" if options[:crossorigin]
+          ret
+        end.join("\n")
+
+        send_early_hints_response(env, link)
+      end
+    end
+
+    # Tries to send an Early Hints (103) HTTP response for a batch of assets
+    #
+    # @param env [Hash] Rack env
+    # @param link [String] the serialized HTTP `Link` headers
+    #
+    # @raise [Hanami::EarlyHints::NotSupportedByServerError] if the current Ruby
+    #   server doesn't support Early Hints
+    #
+    # @since x.x.x
+    # @api private
+    def send_early_hints_response(env, link)
+      env[RACK_EARLY_HINTS_ENV_KEY].call("Link" => link)
+    rescue NoMethodError => exception
+      raise exception if env.key?(RACK_EARLY_HINTS_ENV_KEY)
+      raise NotSupportedByServerError
+    end
+  end
+end

data/lib/hanami/version.rb

@@ -6,7 +6,7 @@ module Hanami
   module Version
     # @since 0.9.0
     # @api private
-    VERSION = '1.1.1'.freeze
+    VERSION = '1.2.0.beta1'.freeze
 
     # @since 0.9.0
     # @api private

metadata

@@ -1,141 +1,141 @@
 --- !ruby/object:Gem::Specification
 name: hanami
 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-validations
   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-router
   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-controller
   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-view
   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: hanami-mailer
   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-assets
   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-cli
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.2.0.beta1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.2.0.beta1
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -344,6 +344,9 @@ files:
 - lib/hanami/config/security.rb
 - lib/hanami/config/sessions.rb
 - lib/hanami/configuration.rb
+- lib/hanami/configuration/app.rb
+- lib/hanami/configuration/middleware.rb
+- lib/hanami/early_hints.rb
 - lib/hanami/env.rb
 - lib/hanami/environment.rb
 - lib/hanami/environment_application_configurations.rb
@@ -382,9 +385,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