hanami 2.0.0.beta1.1 → 2.0.0.beta3

data/spec/integration/action/slice_configuration_spec.rb

@@ -0,0 +1,287 @@
+# frozen_string_literal: true
+
+RSpec.describe "App action / Slice configuration", :app_integration do
+  before do
+    with_directory(@dir = make_tmp_directory) do
+      write "config/app.rb", <<~'RUBY'
+        require "hanami"
+
+        module TestApp
+          class App < Hanami::App
+          end
+        end
+      RUBY
+
+      write "app/action.rb", <<~'RUBY'
+        require "hanami/action"
+
+        module TestApp
+          class Action < Hanami::Action
+          end
+        end
+      RUBY
+
+      require "hanami/setup"
+    end
+  end
+
+  def prepare_app
+    with_directory(@dir) { require "hanami/prepare" }
+  end
+
+  describe "inheriting from app-level base class" do
+    describe "app-level base class" do
+      it "applies default actions config from the app", :aggregate_failures do
+        prepare_app
+
+        expect(TestApp::Action.config.default_request_format).to eq :html
+        expect(TestApp::Action.config.default_response_format).to eq :html
+      end
+
+      it "applies actions config from the app" do
+        Hanami.app.config.actions.default_response_format = :json
+
+        prepare_app
+
+        expect(TestApp::Action.config.default_response_format).to eq :json
+      end
+
+      it "does not override config in the base class" do
+        Hanami.app.config.actions.default_response_format = :csv
+
+        prepare_app
+
+        TestApp::Action.config.default_response_format = :json
+      end
+    end
+
+    describe "subclass in app" do
+      before do
+        with_directory(@dir) do
+          write "app/actions/articles/index.rb", <<~'RUBY'
+            module TestApp
+              module Actions
+                module Articles
+                  class Index < TestApp::Action
+                  end
+                end
+              end
+            end
+          RUBY
+        end
+      end
+
+      it "applies default actions config from the app", :aggregate_failures do
+        prepare_app
+
+        expect(TestApp::Actions::Articles::Index.config.default_request_format).to eq :html
+        expect(TestApp::Actions::Articles::Index.config.default_response_format).to eq :html
+      end
+
+      it "applies actions config from the app" do
+        Hanami.app.config.actions.default_response_format = :json
+
+        prepare_app
+
+        expect(TestApp::Actions::Articles::Index.config.default_response_format).to eq :json
+      end
+
+      it "applies config from the base class" do
+        prepare_app
+
+        TestApp::Action.config.default_response_format = :json
+
+        expect(TestApp::Actions::Articles::Index.config.default_response_format).to eq :json
+      end
+    end
+
+    describe "subclass in slice" do
+      before do
+        with_directory(@dir) do
+          write "slices/admin/actions/articles/index.rb", <<~'RUBY'
+            module Admin
+              module Actions
+                module Articles
+                  class Index < TestApp::Action
+                  end
+                end
+              end
+            end
+          RUBY
+        end
+      end
+
+      it "applies default actions config from the app", :aggregate_failures do
+        prepare_app
+
+        expect(Admin::Actions::Articles::Index.config.default_request_format).to eq :html
+        expect(Admin::Actions::Articles::Index.config.default_response_format).to eq :html
+      end
+
+      it "applies actions config from the app" do
+        Hanami.app.config.actions.default_response_format = :json
+
+        prepare_app
+
+        expect(Admin::Actions::Articles::Index.config.default_response_format).to eq :json
+      end
+
+      it "applies config from the base class" do
+        prepare_app
+
+        TestApp::Action.config.default_response_format = :json
+
+        expect(Admin::Actions::Articles::Index.config.default_response_format).to eq :json
+      end
+    end
+  end
+
+  describe "inheriting from a slice-level base class, in turn inheriting from an app-level base class" do
+    before do
+      with_directory(@dir) do
+        write "slices/admin/action.rb", <<~'RUBY'
+          module Admin
+            class Action < TestApp::Action
+            end
+          end
+        RUBY
+      end
+    end
+
+    describe "slice-level base class" do
+      it "applies default actions config from the app", :aggregate_failures do
+        prepare_app
+
+        expect(Admin::Action.config.default_request_format).to eq :html
+        expect(Admin::Action.config.default_response_format).to eq :html
+      end
+
+      it "applies actions config from the app" do
+        Hanami.app.config.actions.default_response_format = :json
+
+        prepare_app
+
+        expect(Admin::Action.config.default_response_format).to eq :json
+      end
+
+      it "applies config from the app base class" do
+        prepare_app
+
+        TestApp::Action.config.default_response_format = :json
+
+        expect(Admin::Action.config.default_response_format).to eq :json
+      end
+
+      context "slice actions config present" do
+        before do
+          with_directory(@dir) do
+            write "config/slices/admin.rb", <<~'RUBY'
+              module Admin
+                class Slice < Hanami::Slice
+                  config.actions.default_response_format = :csv
+                end
+              end
+            RUBY
+          end
+        end
+
+        it "applies actions config from the slice" do
+          prepare_app
+
+          expect(Admin::Action.config.default_response_format).to eq :csv
+        end
+
+        it "prefers actions config from the slice over config from the app-level base class" do
+          prepare_app
+
+          TestApp::Action.config.default_response_format = :json
+
+          expect(Admin::Action.config.default_response_format).to eq :csv
+        end
+
+        it "prefers config from the base class over actions config from the slice" do
+          prepare_app
+
+          TestApp::Action.config.default_response_format = :csv
+          Admin::Action.config.default_response_format = :json
+
+          expect(Admin::Action.config.default_response_format).to eq :json
+        end
+      end
+    end
+
+    describe "subclass in slice" do
+      before do
+        with_directory(@dir) do
+          write "slices/admin/actions/articles/index.rb", <<~'RUBY'
+            module Admin
+              module Actions
+                module Articles
+                  class Index < Admin::Action
+                  end
+                end
+              end
+            end
+          RUBY
+        end
+      end
+
+      it "applies default actions config from the app", :aggregate_failures do
+        prepare_app
+
+        expect(Admin::Actions::Articles::Index.config.default_request_format).to eq :html
+        expect(Admin::Actions::Articles::Index.config.default_response_format).to eq :html
+      end
+
+      it "applies actions config from the app" do
+        Hanami.app.config.actions.default_response_format = :json
+
+        prepare_app
+
+        expect(Admin::Actions::Articles::Index.config.default_response_format).to eq :json
+      end
+
+      it "applies actions config from the slice" do
+        with_directory(@dir) do
+          write "config/slices/admin.rb", <<~'RUBY'
+            module Admin
+              class Slice < Hanami::Slice
+                config.actions.default_response_format = :json
+              end
+            end
+          RUBY
+        end
+
+        prepare_app
+
+        expect(Admin::Actions::Articles::Index.config.default_response_format).to eq :json
+      end
+
+      it "applies config from the slice base class" do
+        prepare_app
+
+        Admin::Action.config.default_response_format = :json
+
+        expect(Admin::Actions::Articles::Index.config.default_response_format).to eq :json
+      end
+
+      it "prefers config from the slice base class over actions config from the slice" do
+        with_directory(@dir) do
+          write "config/slices/admin.rb", <<~'RUBY'
+            module Admin
+              class Slice < Hanami::Slice
+                config.actions.default_response_format = :csv
+              end
+            end
+          RUBY
+        end
+
+        prepare_app
+
+        Admin::Action.config.default_response_format = :json
+
+        expect(Admin::Actions::Articles::Index.config.default_response_format).to eq :json
+      end
+    end
+  end
+end

data/spec/integration/code_loading/loading_from_lib_spec.rb

@@ -0,0 +1,208 @@
+# frozen_string_literal: true
+
+RSpec.describe "Code loading / Loading from lib directory", :app_integration do
+  describe "default root" do
+    before :context do
+      with_directory(@dir = make_tmp_directory.realpath) do
+        write "config/app.rb", <<~'RUBY'
+          require "hanami"
+
+          module TestApp
+            class App < Hanami::App
+            end
+          end
+        RUBY
+
+        write "lib/external_class.rb", <<~'RUBY'
+          class ExternalClass
+          end
+        RUBY
+
+        write "lib/test_app/test_class.rb", <<~'RUBY'
+          module TestApp
+            class TestClass
+            end
+          end
+        RUBY
+      end
+    end
+
+    context "setup app" do
+      before do
+        with_directory(@dir) { require "hanami/setup" }
+      end
+
+      it "adds the lib directory to the load path" do
+        expect($LOAD_PATH).to include(@dir.join("lib").to_s)
+      end
+
+      specify "classes in lib/ can be required directly" do
+        expect(require("external_class")).to be true
+        expect(ExternalClass).to be
+      end
+
+      specify "classes in lib/[app_namespace]/ cannot yet be autoloaded" do
+        expect { TestApp::TestClass }.to raise_error(NameError)
+      end
+    end
+
+    context "prepared app" do
+      before do
+        with_directory(@dir) { require "hanami/prepare" }
+      end
+
+      it "leaves the lib directory already in the load path" do
+        expect($LOAD_PATH).to include(@dir.join("lib").to_s).exactly(1).times
+      end
+
+      specify "classes in lib/[app_namespace]/ can be autoloaded" do
+        expect(TestApp::TestClass).to be
+      end
+    end
+
+    context "lib dir missing" do
+      before do
+        with_directory(@dir = make_tmp_directory.realpath) do
+          write "config/app.rb", <<~'RUBY'
+            require "hanami"
+
+            module TestApp
+              class App < Hanami::App
+              end
+            end
+          RUBY
+
+          require "hanami/setup"
+        end
+      end
+
+      it "does not add the lib directory to the load path" do
+        expect($LOAD_PATH).not_to include(@dir.join("lib").to_s)
+      end
+    end
+  end
+
+  context "app root reconfigured" do
+    before :context do
+      with_directory(@dir = make_tmp_directory.realpath) do
+        write "config/app.rb", <<~'RUBY'
+          require "hanami"
+
+          module TestApp
+            class App < Hanami::App
+              config.root = Pathname(__dir__).join("..", "src").realpath
+            end
+          end
+        RUBY
+
+        write "src/lib/external_class.rb", <<~'RUBY'
+          class ExternalClass
+          end
+        RUBY
+
+        write "src/lib/test_app/test_class.rb", <<~'RUBY'
+          module TestApp
+            class TestClass
+            end
+          end
+        RUBY
+      end
+    end
+
+    context "setup app" do
+      before do
+        with_directory(@dir) { require "hanami/setup" }
+      end
+
+      it "does not add the lib directory to the load path (already done at time of subclassing)" do
+        expect($LOAD_PATH).not_to include(@dir.join("src", "lib").to_s)
+      end
+
+      it "adds the lib directory under the new root with `prepare_load_path`" do
+        expect { Hanami.app.prepare_load_path }
+          .to change { $LOAD_PATH }
+          .to include(@dir.join("src", "lib").to_s)
+      end
+    end
+
+    context "prepared app" do
+      before do
+        with_directory(@dir) { require "hanami/prepare" }
+      end
+
+      it "adds the lib directory to the load path" do
+        expect($LOAD_PATH).to include(@dir.join("src", "lib").to_s)
+      end
+
+      specify "classes in lib/ can be required directly" do
+        expect(require("external_class")).to be true
+        expect(ExternalClass).to be
+      end
+
+      specify "classes in lib/[app_namespace]/ can be autoloaded" do
+        expect(TestApp::TestClass).to be
+      end
+    end
+  end
+
+  context "app root reconfigured and load path immediately prepared" do
+    before :context do
+      with_directory(@dir = make_tmp_directory.realpath) do
+        write "config/app.rb", <<~'RUBY'
+          require "hanami"
+
+          module TestApp
+            class App < Hanami::App
+              config.root = Pathname(__dir__).join("..", "src").realpath and prepare_load_path
+            end
+          end
+        RUBY
+
+        write "src/lib/external_class.rb", <<~'RUBY'
+          class ExternalClass
+          end
+        RUBY
+
+        write "src/lib/test_app/test_class.rb", <<~'RUBY'
+          module TestApp
+            class TestClass
+            end
+          end
+        RUBY
+      end
+    end
+
+    context "setup app" do
+      before do
+        with_directory(@dir) { require "hanami/setup" }
+      end
+
+      it "adds the lib directory to the load path" do
+        expect($LOAD_PATH).to include(@dir.join("src", "lib").to_s)
+      end
+
+      specify "classes in lib/ can be required directly" do
+        expect(require("external_class")).to be true
+        expect(ExternalClass).to be
+      end
+
+      specify "classes in lib/[app_namespace]/ cannot yet be autoloaded" do
+        expect { TestApp::TestClass }.to raise_error(NameError)
+      end
+    end
+
+    context "prepared app" do
+      before do
+        with_directory(@dir) { require "hanami/prepare" }
+      end
+
+      it "leaves the lib directory to the load path" do
+        expect($LOAD_PATH).to include(@dir.join("src", "lib").to_s).exactly(1).times
+      end
+
+      specify "classes in lib/[app_namespace]/ can be autoloaded" do
+        expect(TestApp::TestClass).to be
+      end
+    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/integration/dotenv_loading_spec.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+# rubocop:disable Style/FetchEnvVar
+
+RSpec.describe "Dotenv loading", :app_integration do
+  before do
+    @orig_env = ENV.to_h
+  end
+
+  after do
+    ENV.replace(@orig_env)
+  end
+
+  context "dotenv gem is available" do
+    before do
+      require "dotenv"
+    end
+
+    context "hanami env is development" do
+      it "loads .env.development.local, .env.local, .env.development and .env (in this order) into ENV", :aggregate_failures do
+        with_tmp_directory(Dir.mktmpdir) do
+          write "config/app.rb", <<~'RUBY'
+            require "hanami"
+
+            module TestApp
+              class App < Hanami::App
+              end
+            end
+          RUBY
+
+          write ".env.development.local", <<~'TEXT'
+            FROM_SPECIFIC_ENV_LOCAL="from .env.development.local"
+          TEXT
+
+          write ".env.local", <<~'TEXT'
+            FROM_BASE_LOCAL="from .env.local"
+            FROM_SPECIFIC_ENV_LOCAL=nope
+          TEXT
+
+          write ".env.development", <<~'TEXT'
+            FROM_SPECIFIC_ENV="from .env.development"
+            FROM_SPECIFIC_ENV_LOCAL=nope
+            FROM_BASE_LOCAL=nope
+          TEXT
+
+          write ".env", <<~'TEXT'
+            FROM_BASE="from .env"
+            FROM_SPECIFIC_ENV_LOCAL=nope
+            FROM_BASE_LOCAL=nope
+            FROM_SPECIFIC_ENV=nope
+          TEXT
+
+          ENV["HANAMI_ENV"] = "development"
+
+          require "hanami/setup"
+
+          expect(ENV["FROM_SPECIFIC_ENV_LOCAL"]).to eq "from .env.development.local"
+          expect(ENV["FROM_BASE_LOCAL"]).to eq "from .env.local"
+          expect(ENV["FROM_SPECIFIC_ENV"]).to eq "from .env.development"
+          expect(ENV["FROM_BASE"]).to eq "from .env"
+        end
+      end
+    end
+
+    context "hanami env is test" do
+      it "loads .env.development.local, .env.development and .env (in this order) into ENV", :aggregate_failures do
+        with_tmp_directory(Dir.mktmpdir) do
+          write "config/app.rb", <<~'RUBY'
+            require "hanami"
+
+            module TestApp
+              class App < Hanami::App
+              end
+            end
+          RUBY
+
+          write ".env.test.local", <<~'TEXT'
+            FROM_SPECIFIC_ENV_LOCAL="from .env.test.local"
+          TEXT
+
+          write ".env.local", <<~'TEXT'
+            FROM_BASE_LOCAL="from .env.local"
+          TEXT
+
+          write ".env.test", <<~'TEXT'
+            FROM_SPECIFIC_ENV="from .env.test"
+            FROM_SPECIFIC_ENV_LOCAL=nope
+          TEXT
+
+          write ".env", <<~'TEXT'
+            FROM_BASE="from .env"
+            FROM_SPECIFIC_ENV_LOCAL=nope
+            FROM_SPECIFIC_ENV=nope
+          TEXT
+
+          ENV["HANAMI_ENV"] = "test"
+
+          require "hanami/prepare"
+
+          expect(ENV["FROM_SPECIFIC_ENV_LOCAL"]).to eq "from .env.test.local"
+          expect(ENV["FROM_BASE_LOCAL"]).to be nil
+          expect(ENV["FROM_SPECIFIC_ENV"]).to eq "from .env.test"
+          expect(ENV["FROM_BASE"]).to eq "from .env"
+        end
+      end
+    end
+  end
+
+  context "dotenv gem is unavailable" do
+    before do
+      allow_any_instance_of(Object).to receive(:gem).and_call_original
+      allow_any_instance_of(Object).to receive(:gem).with("dotenv").and_raise(Gem::LoadError)
+    end
+
+    it "does not load from .env files" do
+      with_tmp_directory(Dir.mktmpdir) do
+        write "config/app.rb", <<~'RUBY'
+          require "hanami"
+
+          module TestApp
+            class App < Hanami::App
+            end
+          end
+        RUBY
+
+        write ".env", <<~'TEXT'
+          FOO=bar
+        TEXT
+
+        expect { require "hanami/prepare" }.not_to(change { ENV.to_h })
+        expect(ENV.key?("FOO")).to be false
+      end
+    end
+  end
+end
+
+# rubocop:enable Style/FetchEnvVar