hanami 2.0.0.beta2 → 2.0.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e9e5c35a72383ba29d2523a9b30da2a3170605bba5cee20562c897025a58524
-  data.tar.gz: 328e2e6aa30db94ce7dbae5f58d3ac0ce8435ec928ed71fa058345ca3a22553f
+  metadata.gz: 52462a1be45d338394f82872ac25bd8fc6e34f5b90991e74928342d0905d377d
+  data.tar.gz: 221af8ef1ba7993d6eb0678c0536513fca19f68b83bcf13d2fa5664747b83b98
 SHA512:
-  metadata.gz: 769a484cea4c2594afaece8ae368e16003d02f988b6c015370b0b8236de477042611d71432da8d89d885ebabd3e0e013e7dd9299d0622897f44ac3d511980daf
-  data.tar.gz: e5808f8d9195cb242cbc02d136c993167ab124dabda9b239469841c981c621410d80ace966378157f22cdfd4aaf683f885257d96713561e2e12ce54cdadcab0f
+  metadata.gz: f2e0f16b7bee12601ebe28645be73219dd97647d4dc2ddfa47af25ac974092afa8d4b4ec849e0f7866e266c6dd7f39ddf31aa19b857083fb1841f19b98affdbf
+  data.tar.gz: 1b2ad0280e15291bba6fdf5efaf75bb10555eba655087ea53a9c5c7e8a5522335e0e07e0f2bf81f2b2c4ce638c14a58bbe2d8c827a792a5d2fc17111245bb75a

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 The web, with simplicity.
 
+## v2.0.0.beta3 - 2022-09-21
+
+### Changed
+
+- [Piotr Solnica] Simplify routes definition, by removing `routes` block from `config/routes.rb`
+
+### Added
+
 ## v2.0.0.beta2 - 2022-08-16
 
 ### Added
@@ -25,6 +33,7 @@ The web, with simplicity.
   Or by setting `HANAMI_SLICES=blog,shop` in the env.
 
   You can also specify arbitrarily nested slices using dot delimiters. For example, if you have an `admin` slice with nested `shop` and `blog` slices, you can specify `config.slices = %w[admin.shop]` to only load the admin slice and its nested shop slice.
+
 - [Tim Riley] Added `App.prepare_load_path`, which need only be called if you explicitly change your app's `config.root`. The `$LOAD_PATH` is otherwise still prepared automatically for the default `root` of `Dir.pwd`. [#1188]
 - [Marc Busqué, Tim Riley] Added `Hanami.setup` to find and load your Hanami app file (expected at `config/app.rb`). This will search in the current directory, and will search upwards through parent directories until the app file is found. [#1197]
 
@@ -62,6 +71,7 @@ The web, with simplicity.
     end
   end
   ```
+
 - [Tim Riley] Every slice has a distinct `Zeitwerk::Loader` instance at `Slice.autoloader`. This change enabled the autoloading within settings described above. [#1186]
 - [Tim Riley] `Slice.settings` reader method has been removed. Access settings via `App["settings"]` or `Slice["settings"]` (after the slice has been prepared) instead. [#1186]
 - [Tim Riley] dry-types is no longer a dependency specified in the gemspec. This is made available to generated app via a line in their `Gemfile` instead. [#1186]
@@ -133,7 +143,6 @@ The web, with simplicity.
 - [Tim Riley] Removed `Hanami::Configuration::Router#routes_path`, and `#routes_class_name` [#1175]
 - [Tim Riley] Make `Hanami::App` to inherit from `Hanami::Slice` [#1162]
 
-
 ## v2.0.0.alpha8 - 2022-05-19
 
 ### Added

data/lib/hanami/configuration/null_configuration.rb

@@ -5,8 +5,8 @@ require "dry/configurable"
 module Hanami
   class Configuration
     # NullConfiguration can serve as a fallback configuration object when out-of-gem
-    # configuration objects are not available (specifically, when the hanami-controller or
-    # hanami-view gems are not loaded)
+    # configuration objects are not available (specifically, when the
+    # hanami-controller, hanami-router or hanami-view gems are not loaded)
     class NullConfiguration
       include Dry::Configurable
     end

data/lib/hanami/configuration.rb

@@ -9,7 +9,6 @@ require "pathname"
 
 require_relative "constants"
 require_relative "configuration/logger"
-require_relative "configuration/router"
 require_relative "configuration/sessions"
 require_relative "settings/env_store"
 require_relative "slice/routing/middleware/stack"
@@ -106,20 +105,22 @@ module Hanami
 
       config.logger = Configuration::Logger.new(env: env, app_name: app_name)
 
-      @assets = load_dependent_config("hanami/assets/app_configuration") {
-        Hanami::Assets::AppConfiguration.new
-      }
+      # TODO: Make assets configuration dependent
+      require "hanami/assets/app_configuration"
+      @assets = Hanami::Assets::AppConfiguration.new
 
-      @actions = load_dependent_config("hanami/action") {
+      @actions = load_dependent_config("hanami-controller") {
         require_relative "configuration/actions"
         Actions.new
       }
 
-      @middleware = Slice::Routing::Middleware::Stack.new
-
-      @router = Router.new(self)
+      @router = load_dependent_config("hanami-router") {
+        require_relative "configuration/router"
+        @middleware = Slice::Routing::Middleware::Stack.new
+        Router.new(self)
+      }
 
-      @views = load_dependent_config("hanami/view") {
+      @views = load_dependent_config("hanami-view") {
         require_relative "configuration/views"
         Views.new
       }
@@ -209,14 +210,13 @@ module Hanami
     end
 
     # @api private
-    def load_dependent_config(require_path)
-      require require_path
-      yield
-    rescue LoadError => e
-      raise e unless e.path == require_path
-
-      require_relative "configuration/null_configuration"
-      NullConfiguration.new
+    def load_dependent_config(gem_name)
+      if Hanami.bundled?(gem_name)
+        yield
+      else
+        require_relative "configuration/null_configuration"
+        NullConfiguration.new
+      end
     end
 
     def method_missing(name, *args, &block)

data/lib/hanami/routes.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "hanami/slice/router"
+
 module Hanami
   # App routes
   #
@@ -14,38 +16,63 @@ module Hanami
   #
   #   module MyApp
   #     class Routes < Hanami::Routes
-  #       define do
-  #         root to: "home.show"
-  #       end
+  #       root to: "home.show"
   #     end
   #   end
   #
-  #   See {Hanami::Slice::Router} for the syntax allowed within the
-  #   `define` block.
+  #   See {Hanami::Slice::Router} for the syntax allowed within the `define` block.
   #
   # @see Hanami::Slice::Router
   # @since 2.0.0
   class Routes
-    # Defines app routes
-    #
-    # @yield DSL syntax to define app routes executed in the context
-    # of {Hanami::Slice::Router}
-    #
-    # @return [Proc]
-    def self.define(&block)
-      @_routes = block
-    end
-
     # @api private
     def self.routes
-      @_routes || raise(<<~MSG)
-        Routes need to be defined before being able to fetch them. E.g.,
-          define do
-            slice :main, at: "/" do
-              root to: "home.show"
+      @routes ||= build_routes
+    end
+
+    class << self
+      # @api private
+      def build_routes(definitions = self.definitions)
+        return if definitions.empty?
+
+        proc do
+          definitions.each do |(name, args, kwargs, block)|
+            if block
+              public_send(name, *args, **kwargs, &block)
+            else
+              public_send(name, *args, **kwargs)
             end
           end
-      MSG
+        end
+      end
+
+      # @api private
+      def definitions
+        @definitions ||= []
+      end
+
+      private
+
+      # @api private
+      def supported_methods
+        @supported_methods ||= Slice::Router.public_instance_methods
+      end
+
+      # @api private
+      def respond_to_missing?(name, include_private = false)
+        supported_methods.include?(name) || super
+      end
+
+      # Capture all method calls that are supported by the router DSL
+      # so that it can be evaluated lazily during configuration/boot
+      # process
+      #
+      # @api private
+      def method_missing(name, *args, **kwargs, &block)
+        return super unless respond_to?(name)
+        definitions << [name, args, kwargs, block]
+        self
+      end
     end
   end
 end

data/lib/hanami/version.rb

@@ -8,7 +8,7 @@ module Hanami
   module Version
     # @since 0.9.0
     # @api private
-    VERSION = "2.0.0.beta2"
+    VERSION = "2.0.0.beta3"
 
     # @since 0.9.0
     # @api private

data/spec/{new_integration → integration}/action/routes_spec.rb

@@ -14,12 +14,10 @@ RSpec.describe "App action / Routes", :app_integration do
       write "config/routes.rb", <<~RUBY
         module TestApp
           class Routes < Hanami::Routes
-            define do
-              root to: "home.index"
+            root to: "home.index"
 
-              slice :admin, at: "/admin" do
-                root to: "dashboard.index"
-              end
+            slice :admin, at: "/admin" do
+              root to: "dashboard.index"
             end
           end
         end

data/spec/{new_integration → integration}/container/application_routes_helper_spec.rb

@@ -16,9 +16,7 @@ RSpec.describe "App routes helper", :app_integration do
       write "config/routes.rb", <<~RUBY
         module TestApp
           class Routes < Hanami::Routes
-            define do
-              root to: "home.index"
-            end
+            root to: "home.index"
           end
         end
       RUBY

data/spec/{new_integration → integration}/rack_app/middleware_spec.rb

@@ -64,10 +64,8 @@ RSpec.describe "Hanami web app", :app_integration do
 
       module TestApp
         class Routes < Hanami::Routes
-          define do
-            slice :main, at: "/" do
-              root to: "home.index"
-            end
+          slice :main, at: "/" do
+            root to: "home.index"
           end
         end
       end
@@ -113,14 +111,12 @@ RSpec.describe "Hanami web app", :app_integration do
 
       module TestApp
         class Routes < Hanami::Routes
-          define do
-            slice :main, at: "/" do
-              use TestApp::Middlewares::AppendOne
-              use TestApp::Middlewares::Prepare, before: TestApp::Middlewares::AppendOne
-              use TestApp::Middlewares::AppendTwo, after: TestApp::Middlewares::AppendOne
+          slice :main, at: "/" do
+            use TestApp::Middlewares::AppendOne
+            use TestApp::Middlewares::Prepare, before: TestApp::Middlewares::AppendOne
+            use TestApp::Middlewares::AppendTwo, after: TestApp::Middlewares::AppendOne
 
-              root to: "home.index"
-            end
+            root to: "home.index"
           end
         end
       end
@@ -180,10 +176,8 @@ RSpec.describe "Hanami web app", :app_integration do
 
       module TestApp
         class Routes < Hanami::Routes
-          define do
-            slice :main, at: "/" do
-              root to: "home.index"
-            end
+          slice :main, at: "/" do
+            root to: "home.index"
           end
         end
       end

data/spec/{new_integration → integration}/rack_app/non_booted_rack_app_spec.rb

@@ -24,11 +24,9 @@ RSpec.describe "Running a Rack app for a non-booted app", :app_integration do
 
         module TestApp
           class Routes < Hanami::Routes
-            define do
-              slice :main, at: "/" do
-                root to: "home.show"
-                get "/articles", to: "articles.index"
-              end
+            slice :main, at: "/" do
+              root to: "home.show"
+              get "/articles", to: "articles.index"
             end
           end
         end

data/spec/{new_integration → integration}/rack_app/rack_app_spec.rb

@@ -21,9 +21,7 @@ RSpec.describe "Hanami web app", :app_integration do
       write "config/routes.rb", <<~RUBY
         module TestApp
           class Routes < Hanami::Routes
-            define do
-              root to: ->(env) { [200, {}, ["OK"]] }
-            end
+            root to: ->(env) { [200, {}, ["OK"]] }
           end
         end
       RUBY
@@ -51,8 +49,7 @@ RSpec.describe "Hanami web app", :app_integration do
       write "config/routes.rb", <<~RUBY
         module TestApp
           class Routes < Hanami::Routes
-            define do
-            end
+            root to: ->(env) { [200, {}, ["OK"]] }
           end
         end
       RUBY
@@ -65,7 +62,7 @@ RSpec.describe "Hanami web app", :app_integration do
 
       logs = -> { Pathname(dir).join("test.log").realpath.read }
 
-      expect(logs.()).to match %r{GET 404 \d+ms 127.0.0.1 /}
+      expect(logs.()).to match %r{GET 200 \d+ms 127.0.0.1 /}
     end
   end
 
@@ -89,8 +86,7 @@ RSpec.describe "Hanami web app", :app_integration do
         write "slices/main/config/routes.rb", <<~RUBY
           module Main
             class Routes < Hanami::Routes
-              define do
-              end
+              root to: ->(env) { [200, {}, ["OK"]] }
             end
           end
         RUBY
@@ -101,7 +97,7 @@ RSpec.describe "Hanami web app", :app_integration do
 
         logs = -> { Pathname(dir).join("test.log").realpath.read }
 
-        expect(logs.()).to match %r{GET 404 \d+ms 127.0.0.1 /}
+        expect(logs.()).to match %r{GET 200 \d+ms 127.0.0.1 /}
       end
     end
   end
@@ -121,20 +117,18 @@ RSpec.describe "Hanami web app", :app_integration do
       write "config/routes.rb", <<~RUBY
         module TestApp
           class Routes < Hanami::Routes
-            define do
-              get "/health", to: "health.show"
+            get "/health", to: "health.show"
 
-              get "/inline" do
-                "Inline"
-              end
+            get "/inline" do
+              "Inline"
+            end
 
-              slice :main, at: "/" do
-                root to: "home.index"
-              end
+            slice :main, at: "/" do
+              root to: "home.index"
+            end
 
-              slice :admin, at: "/admin" do
-                get "/dashboard", to: "dashboard.show"
-              end
+            slice :admin, at: "/admin" do
+              get "/dashboard", to: "dashboard.show"
             end
           end
         end
@@ -228,12 +222,10 @@ RSpec.describe "Hanami web app", :app_integration do
       write "config/routes.rb", <<~RUBY
         module TestApp
           class Routes < Hanami::Routes
-            define do
-              root to: "home.index"
+            root to: "home.index"
 
-              slice :main, at: "/" do
-                root to: "home.index"
-              end
+            slice :main, at: "/" do
+              root to: "home.index"
             end
           end
         end
@@ -295,12 +287,10 @@ RSpec.describe "Hanami web app", :app_integration do
       write "config/routes.rb", <<~RUBY
         module TestApp
           class Routes < Hanami::Routes
-            define do
-              get "/feedbacks", to: "feedbacks.index"
+            get "/feedbacks", to: "feedbacks.index"
 
-              slice :api, at: "/api" do
-                get "/people", to: "people.index"
-              end
+            slice :api, at: "/api" do
+              get "/people", to: "people.index"
             end
           end
         end
@@ -374,9 +364,7 @@ RSpec.describe "Hanami web app", :app_integration do
       write "config/routes.rb", <<~RUBY
         module TestApp
           class Routes < Hanami::Routes
-            define do
-              get "/missing", to: "missing.action"
-            end
+            get "/missing", to: "missing.action"
           end
         end
       RUBY
@@ -405,10 +393,8 @@ RSpec.describe "Hanami web app", :app_integration do
       write "config/routes.rb", <<~RUBY
         module TestApp
           class Routes < Hanami::Routes
-            define do
-              slice :admin, at: "/admin" do
-                get "/missing", to: "missing.action"
-              end
+            slice :admin, at: "/admin" do
+              get "/missing", to: "missing.action"
             end
           end
         end
@@ -437,9 +423,7 @@ RSpec.describe "Hanami web app", :app_integration do
       write "config/routes.rb", <<~RUBY
         module TestApp
           class Routes < Hanami::Routes
-            define do
-              get "/missing", to: "missing.action"
-            end
+            get "/missing", to: "missing.action"
           end
         end
       RUBY
@@ -470,10 +454,8 @@ RSpec.describe "Hanami web app", :app_integration do
       write "config/routes.rb", <<~RUBY
         module TestApp
           class Routes < Hanami::Routes
-            define do
-              slice :admin, at: "/admin" do
-                get "/missing", to: "missing.action"
-              end
+            slice :admin, at: "/admin" do
+              get "/missing", to: "missing.action"
             end
           end
         end
@@ -504,10 +486,8 @@ RSpec.describe "Hanami web app", :app_integration do
       write "config/routes.rb", <<~RUBY
         module TestApp
           class Routes < Hanami::Routes
-            define do
-              slice :foo, at: "/foo" do
-                get "/bar", to: "bar.index"
-              end
+            slice :foo, at: "/foo" do
+              get "/bar", to: "bar.index"
             end
           end
         end

data/spec/{new_integration → integration}/setup_spec.rb

@@ -55,6 +55,26 @@ RSpec.describe "Hanami setup", :app_integration do
 
         expect { setup }.not_to raise_error
       end
+
+      %w[hanami-view hanami-actions hanami-router].each do |gem_name|
+        it "works when #{gem_name} gem is not bundled" do
+          allow(Hanami).to receive(:bundled?).and_call_original
+          expect(Hanami).to receive(:bundled?).with("hanami-router").and_return(false)
+
+          with_tmp_directory(Dir.mktmpdir) do
+            write "config/app.rb", <<~RUBY
+            require "hanami"
+
+            module TestApp
+              class App < Hanami::App
+              end
+            end
+            RUBY
+
+            expect { setup }.to change { Hanami.app? }.to true
+          end
+        end
+      end
     end
 
     describe "using hanami/setup require" do

data/spec/{new_integration → integration}/slices/external_slice_spec.rb

@@ -27,10 +27,8 @@ RSpec.describe "Slices / External slices", :app_integration do
 
         module TestApp
           class Routes < Hanami::Routes
-            define do
-              slice :external, at: "/" do
-                root to: "test_action"
-              end
+            slice :external, at: "/" do
+              root to: "test_action"
             end
           end
         end

data/spec/{new_integration → integration}/slices/slice_routing_spec.rb

@@ -44,9 +44,7 @@ RSpec.describe "Slices / Slice routing", :app_integration do
 
         module TestApp
           class Routes < Hanami::Routes
-            define do
-              get "home", to: "home.show", as: :home
-            end
+            get "home", to: "home.show", as: :home
           end
         end
       RUBY
@@ -79,9 +77,7 @@ RSpec.describe "Slices / Slice routing", :app_integration do
 
         module Main
           class Routes < Hanami::Routes
-            define do
-              get "home", to: "home.show", as: :home
-            end
+            get "home", to: "home.show", as: :home
           end
         end
       RUBY
@@ -130,11 +126,9 @@ RSpec.describe "Slices / Slice routing", :app_integration do
         write "config/routes.rb", <<~'RUBY'
           module TestApp
             class Routes < Hanami::Routes
-              define do
-                root to: "home.show"
+              root to: "home.show"
 
-                slice :main, at: "/main"
-              end
+              slice :main, at: "/main"
             end
           end
         RUBY
@@ -158,9 +152,7 @@ RSpec.describe "Slices / Slice routing", :app_integration do
         write "slices/main/config/routes.rb", <<~'RUBY'
           module Main
             class Routes < Hanami::Routes
-              define do
-                root to: "home.show"
-              end
+              root to: "home.show"
             end
           end
         RUBY