hanami 2.1.0.rc2 → 2.1.0

data/lib/hanami/web/welcome.html.erb

@@ -7,7 +7,7 @@
   <title>Hanami</title>
   <style>
     :root {
-      --max-width: 1024px;
+      --max-width: 768px;
       --foreground-rgb: 0, 0, 0;
       --background-rgb: 255, 255, 255;
       --card-border-rgb: 200, 200, 200;
@@ -84,7 +84,7 @@
 
     .grid {
       display: grid;
-      grid-template-columns: repeat(4, 1fr);
+      grid-template-columns: repeat(3, 1fr);
       column-gap: 20px;
       max-width: 100%;
       margin-bottom: 8vh;
@@ -182,10 +182,6 @@
         <h2>Guides</h2>
         <p>Get started with the Hanami guides</p>
       </a>
-      <a href="https://docs.hanamirb.org/" class="card">
-        <h2>API docs</h2>
-        <p>Learn more through the API docs</p>
-      </a>
       <a href="http://github.com/hanami" class="card">
         <h2>Code</h2>
         <p>Contribute to the source code</p>

data/spec/integration/assets/assets_spec.rb

@@ -18,39 +18,17 @@ RSpec.describe "Assets", :app_integration do
         end
       RUBY
 
-      write "config/assets.mjs", <<~JS
+      write "config/assets.js", <<~JS
         import * as assets from "hanami-assets";
         await assets.run();
       JS
 
       write "package.json", <<~JSON
         {
-          "scripts": {
-            "assets": "node config/assets.mjs"
-          }
+          "type": "module"
         }
       JSON
 
-      write "config/routes.rb", <<~RUBY
-        module TestApp
-          class Routes < Hanami::Routes
-            get "posts/:id/edit", to: "posts.edit"
-            put "posts/:id", to: "posts.update"
-          end
-        end
-      RUBY
-
-      write "app/action.rb", <<~RUBY
-        # auto_register: false
-
-        require "hanami/action"
-
-        module TestApp
-          class Action < Hanami::Action
-          end
-        end
-      RUBY
-
       write "app/view.rb", <<~RUBY
         # auto_register: false
 
@@ -109,4 +87,69 @@ RSpec.describe "Assets", :app_integration do
     expect(assets["app.css"].to_s).to match(%r{/assets/app-[A-Z0-9]{8}.css})
     expect(assets["app.js"].to_s).to match(%r{/assets/app-[A-Z0-9]{8}.js})
   end
+
+  describe "slice with assets" do
+    def before_prepare
+      write "slices/main/view.rb", <<~RUBY
+        # auto_register: false
+
+        module Main
+          class View < TestApp::View
+          end
+        end
+      RUBY
+
+      write "slices/main/views/posts/show.rb", <<~RUBY
+        module Main
+          module Views
+            module Posts
+              class Show < Main::View
+              end
+            end
+          end
+        end
+      RUBY
+
+      write "slices/main/templates/posts/show.html.erb", <<~ERB
+        <%= stylesheet_tag("app") %>
+        <%= javascript_tag("app") %>
+      ERB
+
+      write "slices/main/assets/js/app.ts", <<~TS
+        import "../css/app.css";
+
+        console.log("Hello from main slice index.ts");
+      TS
+
+      write "slices/main/assets/css/app.css", <<~CSS
+        .btn {
+          background: #f00;
+        }
+      CSS
+    end
+
+    specify "the slice's assets are available in its own and distinct `assets` component" do
+      compile_assets!
+
+      output = Main::Slice["views.posts.show"].call.to_s
+
+      expect(output).to match(%r{<link href="/assets/_main/app-[A-Z0-9]{8}.css" type="text/css" rel="stylesheet">})
+      expect(output).to match(%r{<script src="/assets/_main/app-[A-Z0-9]{8}.js" type="text/javascript"></script>})
+
+      assets = Main::Slice["assets"]
+
+      expect(assets["app.css"].to_s).to match(%r{/assets/_main/app-[A-Z0-9]{8}.css})
+      expect(assets["app.js"].to_s).to match(%r{/assets/_main/app-[A-Z0-9]{8}.js})
+    end
+  end
+
+  describe "slice without assets" do
+    def before_prepare
+      write "slices/main/.keep", ""
+    end
+
+    it "does not have an assets component" do
+      expect(Main::Slice.key?("assets")).to be false
+    end
+  end
 end

data/spec/integration/assets/cross_slice_assets_helpers_spec.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require "rack/test"
+require "stringio"
+
+RSpec.describe "Cross-slice assets via helpers", :app_integration do
+  include Rack::Test::Methods
+  let(:app) { Hanami.app }
+  let(:root) { make_tmp_directory }
+
+  before do
+    with_directory(root) do
+      write "config/app.rb", <<~RUBY
+        module TestApp
+          class App < Hanami::App
+            config.logger.stream = StringIO.new
+          end
+        end
+      RUBY
+
+      write "config/slices/admin.rb", <<~RUBY
+        module Admin
+          class Slice < Hanami::Slice
+            # TODO: we should update `import` to make importing from the app nicer
+            # TODO: this test failed when I tried doing `as: "app"` (string instead of symbol); fix this in dry-system
+            import keys: ["assets"], from: Hanami.app.container, as: :app
+          end
+        end
+      RUBY
+
+      write "config/assets.js", <<~JS
+        import * as assets from "hanami-assets";
+        await assets.run();
+      JS
+
+      write "package.json", <<~JSON
+        {
+          "type": "module"
+        }
+      JSON
+
+      write "app/view.rb", <<~RUBY
+        # auto_register: false
+
+        require "hanami/view"
+
+        module TestApp
+          class View < Hanami::View
+            config.layout = nil
+          end
+        end
+      RUBY
+
+      write "app/assets/js/app.ts", <<~TS
+        import "../css/app.css";
+
+        console.log("Hello from index.ts");
+      TS
+
+      write "app/assets/css/app.css", <<~CSS
+        .btn {
+          background: #f00;
+        }
+      CSS
+
+      write "slices/admin/assets/js/app.ts", <<~TS
+        import "../css/app.css";
+
+        console.log("Hello from admin's index.ts");
+      TS
+
+      write "slices/admin/assets/css/app.css", <<~CSS
+        .btn {
+          background: #f00;
+        }
+      CSS
+
+      write "slices/admin/view.rb", <<~RUBY
+        # auto_register: false
+
+        module Admin
+          class View < TestApp::View
+          end
+        end
+      RUBY
+
+      write "slices/admin/views/posts/show.rb", <<~RUBY
+        module Admin
+          module Views
+            module Posts
+              class Show < Admin::View
+              end
+            end
+          end
+        end
+      RUBY
+
+      write "slices/admin/views/context.rb", <<~RUBY
+        # auto_register: false
+
+        require "hanami/view"
+
+        module Admin
+          module Views
+            class Context < Hanami::View::Context
+              include Deps[app_assets: "app.assets"]
+            end
+          end
+        end
+      RUBY
+
+      write "slices/admin/templates/posts/show.html.erb", <<~ERB
+        <%= stylesheet_tag(app_assets["app.css"]) %>
+        <%= javascript_tag(app_assets["app.js"]) %>
+      ERB
+
+      before_prepare if respond_to?(:before_prepare)
+      require "hanami/prepare"
+    end
+  end
+
+  specify "assets are available in helpers and in `assets` component" do
+    compile_assets!
+
+    output = Admin::Slice["views.posts.show"].call.to_s
+
+    expect(output).to match(%r{<link href="/assets/app-[A-Z0-9]{8}.css" type="text/css" rel="stylesheet">})
+    expect(output).to match(%r{<script src="/assets/app-[A-Z0-9]{8}.js" type="text/javascript"></script>})
+  end
+end

data/spec/integration/rack_app/middleware_spec.rb

@@ -147,6 +147,72 @@ RSpec.describe "Hanami web app", :app_integration do
     expect(last_response.body).to eql("one.two")
   end
 
+  specify "Setting a middleware that requires keyword arguments" do
+    write "config/app.rb", <<~RUBY
+      require "hanami"
+
+      module TestApp
+        class TestMiddleware
+          def initialize(app, key:, value:)
+            @app = app
+            @key = key
+            @value = value
+          end
+
+          def call(env)
+            env[@key] = @value
+            @app.call(env)
+          end
+        end
+
+        class App < Hanami::App
+          config.logger.stream = StringIO.new
+
+          # Test middleware with keywords inside config
+          config.middleware.use(TestApp::TestMiddleware, key: "from_config", value: "config")
+        end
+      end
+    RUBY
+
+    write "config/routes.rb", <<~RUBY
+      require "hanami/router"
+
+      module TestApp
+        class Routes < Hanami::Routes
+          slice :main, at: "/" do
+            # Also test middleware with keywords inside routes
+            use TestApp::TestMiddleware, key: "from_routes", value: "routes"
+
+            root to: "home.index"
+          end
+        end
+      end
+    RUBY
+
+    write "slices/main/actions/home/index.rb", <<~RUBY
+      require "hanami/action"
+
+      module Main
+        module Actions
+          module Home
+            class Index < Hanami::Action
+              def handle(request, response)
+                response.body = [request.env["from_config"], request.env["from_routes"]].join(", ")
+              end
+            end
+          end
+        end
+      end
+    RUBY
+
+    require "hanami/boot"
+
+    get "/"
+
+    expect(last_response).to be_successful
+    expect(last_response.body).to eq "config, routes"
+  end
+
   specify "Setting a middleware that requires a block" do
     write "config/app.rb", <<~RUBY
       require "hanami"

data/spec/integration/view/context/assets_spec.rb

@@ -3,51 +3,77 @@
 require "hanami"
 
 RSpec.describe "App view / Context / Assets", :app_integration do
+  subject(:context) { context_class.new }
+  let(:context_class) { TestApp::Views::Context }
+
   before do
-    module TestApp
-      class App < Hanami::App
-      end
-    end
+    with_directory(make_tmp_directory) do
+      write "config/app.rb", <<~RUBY
+        module TestApp
+          class App < Hanami::App
+            config.logger.stream = File::NULL
+          end
+        end
+      RUBY
 
-    Hanami.prepare
+      write "app/views/context.rb", <<~RUBY
+        # auto_register: false
 
-    module TestApp
-      module Views
-        class Context < Hanami::View::Context
+        require "hanami/view/context"
+
+        module TestApp
+          module Views
+            class Context < Hanami::View::Context
+            end
+          end
         end
-      end
+      RUBY
+
+      before_prepare if respond_to?(:before_prepare)
+      require "hanami/prepare"
     end
   end
 
-  let(:context_class) { TestApp::Views::Context }
-  subject(:context) { context_class.new }
+  context "assets present and hanami-assets bundled" do
+    def before_prepare
+      write "app/assets/.keep", ""
+    end
 
-  describe "#assets" do
-    context "without assets provider" do
-      xit "raises error" do
-        allow(Hanami).to receive(:bundled?).with("hanami-assets").and_return(false)
+    it "is the app assets by default" do
+      expect(context.assets).to be TestApp::App[:assets]
+    end
+  end
 
-        expect { context.assets }
-          .to raise_error(Hanami::ComponentLoadError, /hanami-assets/)
-      end
+  context "assets not present" do
+    it "raises error" do
+      expect { context.assets }.to raise_error(Hanami::ComponentLoadError, /assets directory\?/)
     end
+  end
 
-    context "with assets provider" do
-      it "is the app assets by default" do
-        expect(context.assets).to be TestApp::App[:assets]
-      end
+  context "hanami-assets not bundled" do
+    def before_prepare
+      # These must be here instead of an ordinary before hook because the Hanami.bundled? check for
+      # assets is done as part of requiring "hanami/prepare" above.
+      allow(Hanami).to receive(:bundled?).and_call_original
+      allow(Hanami).to receive(:bundled?).with("hanami-assets").and_return(false)
 
-      context "injected assets" do
-        subject(:context) {
-          context_class.new(assets: assets)
-        }
+      write "app/assets/.keep", ""
+    end
 
-        let(:assets) { double(:assets) }
+    it "raises error" do
+      expect { context.assets }.to raise_error(Hanami::ComponentLoadError, /hanami-assets gem/)
+    end
+  end
 
-        it "is the injected assets" do
-          expect(context.assets).to be assets
-        end
-      end
+  context "injected assets" do
+    subject(:context) {
+      context_class.new(assets: assets)
+    }
+
+    let(:assets) { double(:assets) }
+
+    it "is the injected assets" do
+      expect(context.assets).to be assets
     end
   end
 end

data/spec/support/app_integration.rb

@@ -29,12 +29,16 @@ module RSpec
 
       private
 
+      # TODO: make slice-aware
       def stub_assets(*assets)
         manifest_hash = assets.each_with_object({}) { |source_path, hsh|
           hsh[source_path] = {url: File.join("/assets", source_path)}
         }
 
-        write "public/assets.json", JSON.generate(manifest_hash)
+        write "public/assets/assets.json", JSON.generate(manifest_hash)
+
+        # An assets dir is required to load the assets provider
+        write "app/assets/.keep", ""
       end
 
       def compile_assets!
@@ -44,7 +48,11 @@ module RSpec
         require "hanami/cli/command"
         require "hanami/cli/commands/app/command"
         require "hanami/cli/commands/app/assets/compile"
-        assets_compile = Hanami::CLI::Commands::App::Assets::Compile.new(config: Hanami.app.config.assets)
+        assets_compile = Hanami::CLI::Commands::App::Assets::Compile.new(
+          config: Hanami.app.config.assets,
+          out: File.new(File::NULL, "w"),
+          err: File.new(File::NULL, "w"),
+        )
 
         with_directory(Hanami.app.root) { assets_compile.call }
       end
@@ -62,16 +70,14 @@ module RSpec
         root = Hanami.app.root
 
         with_directory(root) do
-          write("config/assets.mjs", <<~JS) unless root.join("config", "assets.mjs").exist?
+          write("config/assets.js", <<~JS) unless root.join("config", "assets.js").exist?
             import * as assets from "hanami-assets";
             await assets.run();
           JS
 
           write("package.json", <<~JSON) unless root.join("package.json").exist?
             {
-              "scripts": {
-                "assets": "node config/assets.mjs"
-              }
+              "type": "module"
             }
           JSON
         end

data/spec/unit/hanami/helpers/assets_helper/asset_url_spec.rb

@@ -106,4 +106,15 @@ RSpec.describe Hanami::Helpers::AssetsHelper, "#asset_url", :app_integration do
       end
     end
   end
+
+  context "given an asset object" do
+    it "returns the URL for the asset" do
+      asset = Hanami::Assets::Asset.new(
+        path: "/foo/bar.js",
+        base_url: Hanami.app.config.assets.base_url
+      )
+
+      expect(asset_url(asset)).to eq "/foo/bar.js"
+    end
+  end
 end

data/spec/unit/hanami/version_spec.rb

@@ -2,6 +2,6 @@
 
 RSpec.describe "Hanami::VERSION" do
   it "returns current version" do
-    expect(Hanami::VERSION).to eq("2.1.0.rc2")
+    expect(Hanami::VERSION).to eq("2.1.0")
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami
 version: !ruby/object:Gem::Version
-  version: 2.1.0.rc2
+  version: 2.1.0
 platform: ruby
 authors:
 - Luca Guidi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-08 00:00:00.000000000 Z
+date: 2024-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -162,28 +162,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.rc
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.rc
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: hanami-utils
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.rc
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.rc
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -325,6 +325,7 @@ files:
 - spec/integration/action/view_rendering/view_context_spec.rb
 - spec/integration/action/view_rendering_spec.rb
 - spec/integration/assets/assets_spec.rb
+- spec/integration/assets/cross_slice_assets_helpers_spec.rb
 - spec/integration/assets/serve_static_assets_spec.rb
 - spec/integration/code_loading/loading_from_app_spec.rb
 - spec/integration/code_loading/loading_from_lib_spec.rb
@@ -446,11 +447,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.4.21
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: The web, with simplicity
@@ -466,6 +467,7 @@ test_files:
 - spec/integration/action/view_rendering/view_context_spec.rb
 - spec/integration/action/view_rendering_spec.rb
 - spec/integration/assets/assets_spec.rb
+- spec/integration/assets/cross_slice_assets_helpers_spec.rb
 - spec/integration/assets/serve_static_assets_spec.rb
 - spec/integration/code_loading/loading_from_app_spec.rb
 - spec/integration/code_loading/loading_from_lib_spec.rb