hanami 2.1.0.beta1 → 2.1.0.beta2

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

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+RSpec.describe Hanami::Helpers::AssetsHelper, "#javascript_tag", :app_integration do
+  subject(:obj) {
+    helpers = described_class
+    Class.new {
+      include helpers
+
+      attr_reader :_context
+
+      def initialize(context)
+        @_context = context
+      end
+    }.new(context)
+  }
+
+  def javascript_tag(...)
+    subject.javascript_tag(...)
+  end
+
+  let(:context) { TestApp::Views::Context.new }
+  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 "app/views/context.rb", <<~RUBY
+        # auto_register: false
+
+        require "hanami/view/context"
+
+        module TestApp
+          module Views
+            class Context < Hanami::View::Context
+            end
+          end
+        end
+      RUBY
+
+      write "app/assets/js/app.ts", <<~JS
+        import "../css/app.css";
+
+        console.log("Hello from index.ts");
+      JS
+
+      write "app/assets/css/app.css", <<~CSS
+        .btn {
+          background: #f00;
+        }
+      CSS
+
+      stub_assets("feature-a.js")
+
+      require "hanami/setup"
+      before_prepare if respond_to?(:before_prepare)
+      require "hanami/prepare"
+    end
+  end
+
+  it "returns an instance of SafeString" do
+    actual = javascript_tag("feature-a")
+    expect(actual).to be_instance_of(::Hanami::View::HTML::SafeString)
+  end
+
+  it "is aliased as `js`" do
+    expect(subject.js("feature-a")).to eq javascript_tag("feature-a")
+  end
+
+  it "renders <script> tag" do
+    actual = javascript_tag("feature-a")
+    expect(actual).to eq(%(<script src="/assets/feature-a.js" type="text/javascript"></script>))
+  end
+
+  xit "renders <script> tag without appending ext after query string" do
+    actual = javascript_tag("feature-x?callback=init")
+    expect(actual).to eq(%(<script src="/assets/feature-x?callback=init" type="text/javascript"></script>))
+  end
+
+  it "renders <script> tag with a defer attribute" do
+    actual = javascript_tag("feature-a", defer: true)
+    expect(actual).to eq(%(<script src="/assets/feature-a.js" type="text/javascript" defer="defer"></script>))
+  end
+
+  it "renders <script> tag with an integrity attribute" do
+    actual = javascript_tag("feature-a", integrity: "sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC")
+    expect(actual).to eq(%(<script src="/assets/feature-a.js" type="text/javascript" integrity="sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC" crossorigin="anonymous"></script>))
+  end
+
+  it "renders <script> tag with a crossorigin attribute" do
+    actual = javascript_tag("feature-a", integrity: "sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC", crossorigin: "use-credentials")
+    expect(actual).to eq(%(<script src="/assets/feature-a.js" type="text/javascript" integrity="sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC" crossorigin="use-credentials"></script>))
+  end
+
+  it "ignores src passed as an option" do
+    actual = javascript_tag("feature-a", src: "wrong")
+    expect(actual).to eq(%(<script src="/assets/feature-a.js" type="text/javascript"></script>))
+  end
+
+  describe "async option" do
+    it "renders <script> tag with an async=true if async option is true" do
+      actual = javascript_tag("feature-a", async: true)
+      expect(actual).to eq(%(<script src="/assets/feature-a.js" type="text/javascript" async="async"></script>))
+    end
+
+    it "renders <script> tag without an async=true if async option is false" do
+      actual = javascript_tag("feature-a", async: false)
+      expect(actual).to eq(%(<script src="/assets/feature-a.js" type="text/javascript"></script>))
+    end
+  end
+
+  describe "subresource_integrity mode" do
+    def before_prepare
+      Hanami.app.config.assets.subresource_integrity = [:sha384]
+    end
+
+    before { compile_assets! }
+
+    it "includes subresource_integrity and crossorigin attributes" do
+      actual = javascript_tag("app")
+      expect(actual).to match(%r{<script src="/assets/app-[A-Z0-9]{8}.js" type="text/javascript" integrity="sha384-[A-Za-z0-9+/]{64}" crossorigin="anonymous"></script>})
+    end
+  end
+
+  describe "cdn mode" do
+    let(:base_url) { "https://hanami.test" }
+
+    def before_prepare
+      Hanami.app.config.assets.base_url = "https://hanami.test"
+    end
+
+    it "returns absolute url for src attribute" do
+      actual = javascript_tag("feature-a")
+      expect(actual).to eq(%(<script src="#{base_url}/assets/feature-a.js" type="text/javascript"></script>))
+    end
+  end
+end

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

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+RSpec.describe Hanami::Helpers::AssetsHelper, "#stylesheet_link_tag", :app_integration do
+  subject(:obj) {
+    helpers = described_class
+    Class.new {
+      include helpers
+
+      attr_reader :_context
+
+      def initialize(context)
+        @_context = context
+      end
+    }.new(context)
+  }
+
+  def stylesheet_link_tag(...)
+    subject.stylesheet_link_tag(...)
+  end
+
+  let(:context) { TestApp::Views::Context.new }
+  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 "app/views/context.rb", <<~RUBY
+        # auto_register: false
+
+        require "hanami/view/context"
+
+        module TestApp
+          module Views
+            class Context < Hanami::View::Context
+            end
+          end
+        end
+      RUBY
+
+      write "app/assets/js/app.ts", <<~JS
+        import "../css/app.css";
+
+        console.log("Hello from index.ts");
+      JS
+
+      write "app/assets/css/app.css", <<~CSS
+        .btn {
+          background: #f00;
+        }
+      CSS
+
+      stub_assets("main.css")
+
+      require "hanami/setup"
+      before_prepare if respond_to?(:before_prepare)
+      require "hanami/prepare"
+    end
+  end
+
+  it "returns an instance of SafeString" do
+    actual = stylesheet_link_tag("main")
+    expect(actual).to be_instance_of(::Hanami::View::HTML::SafeString)
+  end
+
+  it "is aliased as `css`" do
+    expect(subject.css("main")).to eq stylesheet_link_tag("main")
+  end
+
+  it "renders <link> tag" do
+    actual = stylesheet_link_tag("main")
+    expect(actual).to eq(%(<link href="/assets/main.css" type="text/css" rel="stylesheet">))
+  end
+
+  xit "renders <link> tag without appending ext after query string" do
+    actual = stylesheet_link_tag("fonts?font=Helvetica")
+    expect(actual).to eq(%(<link href="/assets/fonts?font=Helvetica" type="text/css" rel="stylesheet">))
+  end
+
+  it "renders <link> tag with an integrity attribute" do
+    actual = stylesheet_link_tag("main", integrity: "sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC")
+    expect(actual).to eq(%(<link href="/assets/main.css" type="text/css" rel="stylesheet" integrity="sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC" crossorigin="anonymous">))
+  end
+
+  it "renders <link> tag with a crossorigin attribute" do
+    actual = stylesheet_link_tag("main", integrity: "sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC", crossorigin: "use-credentials")
+    expect(actual).to eq(%(<link href="/assets/main.css" type="text/css" rel="stylesheet" integrity="sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC" crossorigin="use-credentials">))
+  end
+
+  it "ignores href passed as an option" do
+    actual = stylesheet_link_tag("main", href: "wrong")
+    expect(actual).to eq(%(<link href="/assets/main.css" type="text/css" rel="stylesheet">))
+  end
+
+  describe "subresource_integrity mode" do
+    def before_prepare
+      Hanami.app.config.assets.subresource_integrity = [:sha384]
+    end
+
+    before { compile_assets! }
+
+    it "includes subresource_integrity and crossorigin attributes" do
+      actual = stylesheet_link_tag("app")
+      expect(actual).to match(%r{<link href="/assets/app-[A-Z0-9]{8}.css" type="text/css" rel="stylesheet" integrity="sha384-[A-Za-z0-9+/]{64}" crossorigin="anonymous">})
+    end
+  end
+
+  describe "cdn mode" do
+    let(:base_url) { "https://hanami.test" }
+
+    def before_prepare
+      Hanami.app.config.assets.base_url = base_url
+    end
+
+    it "returns absolute url for href attribute" do
+      actual = stylesheet_link_tag("main")
+      expect(actual).to eq(%(<link href="#{base_url}/assets/main.css" type="text/css" rel="stylesheet">))
+    end
+  end
+end

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

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+RSpec.describe Hanami::Helpers::AssetsHelper, "#video_tag", :app_integration do
+  subject(:obj) {
+    helpers = described_class
+    Class.new {
+      include helpers
+
+      attr_reader :_context
+
+      def initialize(context)
+        @_context = context
+      end
+    }.new(context)
+  }
+
+  def video_tag(...)
+    subject.video_tag(...)
+  end
+
+  let(:context) { TestApp::Views::Context.new }
+  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 "app/views/context.rb", <<~RUBY
+        # auto_register: false
+
+        require "hanami/view/context"
+
+        module TestApp
+          module Views
+            class Context < Hanami::View::Context
+            end
+          end
+        end
+      RUBY
+
+      stub_assets("movie.mp4", "movie.en.vtt")
+
+      require "hanami/setup"
+      before_prepare if respond_to?(:before_prepare)
+      require "hanami/prepare"
+    end
+  end
+
+  it "returns an instance of HtmlBuilder" do
+    actual = video_tag("movie.mp4")
+    expect(actual).to be_instance_of(::Hanami::View::HTML::SafeString)
+  end
+
+  it "renders <video> tag" do
+    actual = video_tag("movie.mp4").to_s
+    expect(actual).to eq(%(<video src="/assets/movie.mp4"></video>))
+  end
+
+  it "renders with html attributes" do
+    actual = video_tag("movie.mp4", autoplay: true, controls: true).to_s
+    expect(actual).to eq(%(<video autoplay="autoplay" controls="controls" src="/assets/movie.mp4"></video>))
+  end
+
+  it "renders with fallback content" do
+    actual = video_tag("movie.mp4") do
+      "Your browser does not support the video tag"
+    end.to_s
+
+    expect(actual).to eq(%(<video src="/assets/movie.mp4">Your browser does not support the video tag</video>))
+  end
+
+  it "renders with tracks" do
+    actual = video_tag("movie.mp4") do
+      tag.track kind: "captions", src: subject.asset_url("movie.en.vtt"), srclang: "en", label: "English"
+    end.to_s
+
+    expect(actual).to eq(%(<video src="/assets/movie.mp4"><track kind="captions" src="/assets/movie.en.vtt" srclang="en" label="English"></video>))
+  end
+
+  xit "renders with sources" do
+    actual = subject.video do
+      tag.text "Your browser does not support the video tag"
+      tag.source src: subject.asset_url("movie.mp4"), type: "video/mp4"
+      tag.source src: subject.asset_url("movie.ogg"), type: "video/ogg"
+    end.to_s
+
+    expect(actual).to eq(%(<video>Your browser does not support the video tag<source src="/assets/movie.mp4" type="video/mp4"><source src="/assets/movie.ogg" type="video/ogg"></video>))
+  end
+
+  it "raises an exception when no arguments" do
+    expect do
+      video_tag
+    end.to raise_error(
+      ArgumentError,
+      "You should provide a source via `src` option or with a `source` HTML tag"
+    )
+  end
+
+  it "raises an exception when no src and no block" do
+    expect do
+      video_tag(content: true)
+    end.to raise_error(
+      ArgumentError,
+      "You should provide a source via `src` option or with a `source` HTML tag"
+    )
+  end
+
+  describe "cdn mode" do
+    let(:base_url) { "https://hanami.test" }
+
+    def before_prepare
+      Hanami.app.config.assets.base_url = "https://hanami.test"
+    end
+
+    it "returns absolute url for src attribute" do
+      actual = video_tag("movie.mp4").to_s
+      expect(actual).to eq(%(<video src="#{base_url}/assets/movie.mp4"></video>))
+    end
+  end
+
+  private
+
+  def tag(...)
+    subject.__send__(:tag, ...)
+  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.beta1")
+    expect(Hanami::VERSION).to eq("2.1.0.beta2")
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami
 version: !ruby/object:Gem::Version
-  version: 2.1.0.beta1
+  version: 2.1.0.beta2
 platform: ruby
 authors:
 - Luca Guidi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-29 00:00:00.000000000 Z
+date: 2023-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -255,14 +255,13 @@ files:
 - hanami.gemspec
 - lib/hanami.rb
 - lib/hanami/app.rb
-- lib/hanami/assets/app_config.rb
-- lib/hanami/assets/config.rb
 - lib/hanami/boot.rb
 - lib/hanami/config.rb
 - lib/hanami/config/actions.rb
 - lib/hanami/config/actions/content_security_policy.rb
 - lib/hanami/config/actions/cookies.rb
 - lib/hanami/config/actions/sessions.rb
+- lib/hanami/config/assets.rb
 - lib/hanami/config/logger.rb
 - lib/hanami/config/null_config.rb
 - lib/hanami/config/router.rb
@@ -282,13 +281,16 @@ files:
 - lib/hanami/extensions/view/slice_configured_helpers.rb
 - lib/hanami/extensions/view/slice_configured_view.rb
 - lib/hanami/extensions/view/standard_helpers.rb
+- lib/hanami/helpers/assets_helper.rb
 - lib/hanami/helpers/form_helper.rb
 - lib/hanami/helpers/form_helper/form_builder.rb
 - lib/hanami/helpers/form_helper/values.rb
+- lib/hanami/middleware/assets.rb
 - lib/hanami/middleware/public_errors_app.rb
 - lib/hanami/middleware/render_errors.rb
 - lib/hanami/port.rb
 - lib/hanami/prepare.rb
+- lib/hanami/providers/assets.rb
 - lib/hanami/providers/inflector.rb
 - lib/hanami/providers/logger.rb
 - lib/hanami/providers/rack.rb
@@ -319,6 +321,8 @@ files:
 - spec/integration/action/view_rendering/paired_view_inference_spec.rb
 - 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/serve_static_assets_spec.rb
 - spec/integration/code_loading/loading_from_app_spec.rb
 - spec/integration/code_loading/loading_from_lib_spec.rb
 - spec/integration/code_loading/loading_from_slice_spec.rb
@@ -333,10 +337,14 @@ files:
 - spec/integration/container/standard_providers/rack_provider_spec.rb
 - spec/integration/container/standard_providers_spec.rb
 - spec/integration/dotenv_loading_spec.rb
+- spec/integration/logging/exception_logging_spec.rb
+- spec/integration/logging/notifications_spec.rb
+- spec/integration/logging/request_logging_spec.rb
 - spec/integration/rack_app/body_parser_spec.rb
 - spec/integration/rack_app/middleware_spec.rb
 - spec/integration/rack_app/non_booted_rack_app_spec.rb
 - spec/integration/rack_app/rack_app_spec.rb
+- spec/integration/rake_tasks_spec.rb
 - spec/integration/settings/access_in_slice_class_body_spec.rb
 - spec/integration/settings/access_to_constants_spec.rb
 - spec/integration/settings/loading_from_env_spec.rb
@@ -397,6 +405,13 @@ files:
 - spec/unit/hanami/config/views_spec.rb
 - spec/unit/hanami/env_spec.rb
 - spec/unit/hanami/extensions/view/context_spec.rb
+- spec/unit/hanami/helpers/assets_helper/asset_url_spec.rb
+- spec/unit/hanami/helpers/assets_helper/audio_tag_spec.rb
+- spec/unit/hanami/helpers/assets_helper/favicon_link_tag_spec.rb
+- spec/unit/hanami/helpers/assets_helper/image_tag_spec.rb
+- spec/unit/hanami/helpers/assets_helper/javascript_tag_spec.rb
+- spec/unit/hanami/helpers/assets_helper/stylesheet_link_tag_spec.rb
+- spec/unit/hanami/helpers/assets_helper/video_tag_spec.rb
 - spec/unit/hanami/helpers/form_helper_spec.rb
 - spec/unit/hanami/port_spec.rb
 - spec/unit/hanami/router/errors/not_allowed_error_spec.rb
@@ -444,6 +459,8 @@ test_files:
 - spec/integration/action/view_rendering/paired_view_inference_spec.rb
 - 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/serve_static_assets_spec.rb
 - spec/integration/code_loading/loading_from_app_spec.rb
 - spec/integration/code_loading/loading_from_lib_spec.rb
 - spec/integration/code_loading/loading_from_slice_spec.rb
@@ -458,10 +475,14 @@ test_files:
 - spec/integration/container/standard_providers/rack_provider_spec.rb
 - spec/integration/container/standard_providers_spec.rb
 - spec/integration/dotenv_loading_spec.rb
+- spec/integration/logging/exception_logging_spec.rb
+- spec/integration/logging/notifications_spec.rb
+- spec/integration/logging/request_logging_spec.rb
 - spec/integration/rack_app/body_parser_spec.rb
 - spec/integration/rack_app/middleware_spec.rb
 - spec/integration/rack_app/non_booted_rack_app_spec.rb
 - spec/integration/rack_app/rack_app_spec.rb
+- spec/integration/rake_tasks_spec.rb
 - spec/integration/settings/access_in_slice_class_body_spec.rb
 - spec/integration/settings/access_to_constants_spec.rb
 - spec/integration/settings/loading_from_env_spec.rb
@@ -522,6 +543,13 @@ test_files:
 - spec/unit/hanami/config/views_spec.rb
 - spec/unit/hanami/env_spec.rb
 - spec/unit/hanami/extensions/view/context_spec.rb
+- spec/unit/hanami/helpers/assets_helper/asset_url_spec.rb
+- spec/unit/hanami/helpers/assets_helper/audio_tag_spec.rb
+- spec/unit/hanami/helpers/assets_helper/favicon_link_tag_spec.rb
+- spec/unit/hanami/helpers/assets_helper/image_tag_spec.rb
+- spec/unit/hanami/helpers/assets_helper/javascript_tag_spec.rb
+- spec/unit/hanami/helpers/assets_helper/stylesheet_link_tag_spec.rb
+- spec/unit/hanami/helpers/assets_helper/video_tag_spec.rb
 - spec/unit/hanami/helpers/form_helper_spec.rb
 - spec/unit/hanami/port_spec.rb
 - spec/unit/hanami/router/errors/not_allowed_error_spec.rb

data/lib/hanami/assets/app_config.rb

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-require "dry/configurable"
-
-module Hanami
-  # @api private
-  module Assets
-    # App config for assets.
-    #
-    # This is NOT RELEASED as of 2.0.0.
-    #
-    # @api private
-    class AppConfig
-      include Dry::Configurable
-
-      attr_reader :base_config
-      protected :base_config
-
-      setting :server_url, default: "http://localhost:8080"
-
-      def initialize(*)
-        super
-
-        @base_config = Assets::Config.new
-      end
-
-      def initialize_copy(source)
-        super
-        @base_config = source.base_config.dup
-      end
-
-      def finalize!
-      end
-
-      # Returns the list of available settings
-      #
-      # @return [Set]
-      #
-      # @api private
-      def settings
-        base_config.settings + self.class.settings
-      end
-
-      private
-
-      def method_missing(name, *args, &block)
-        if config.respond_to?(name)
-          config.public_send(name, *args, &block)
-        elsif base_config.respond_to?(name)
-          base_config.public_send(name, *args, &block)
-        else
-          super
-        end
-      end
-
-      def respond_to_missing?(name, _incude_all = false)
-        config.respond_to?(name) || base_config.respond_to?(name) || super
-      end
-    end
-  end
-end

data/lib/hanami/assets/config.rb

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-require "dry/configurable"
-
-module Hanami
-  module Assets
-    # App config for assets.
-    #
-    # This is NOT RELEASED as of 2.0.0.
-    #
-    # @api private
-    class Config
-      include Dry::Configurable
-
-      # Initialize the Config
-      #
-      # @yield [config] the config object
-      #
-      # @return [Config]
-      #
-      # @since 2.0.0
-      # @api private
-      def initialize(*)
-        super
-        yield self if block_given?
-      end
-
-      # Returns the list of available settings
-      #
-      # @return [Set]
-      #
-      # @since 2.0.0
-      # @api private
-      def settings
-        self.class.settings
-      end
-
-      private
-
-      def method_missing(name, *args, &block)
-        if config.respond_to?(name)
-          config.public_send(name, *args, &block)
-        else
-          super
-        end
-      end
-
-      def respond_to_missing?(name, _incude_all = false)
-        config.respond_to?(name) || super
-      end
-    end
-  end
-end