hanami 2.0.3 → 2.1.0.beta2

data/spec/unit/hanami/extensions/view/context_spec.rb

@@ -0,0 +1,59 @@
+require "hanami/view"
+require "hanami/view/context"
+require "hanami/extensions/view/context"
+
+RSpec.describe(Hanami::View::Context) do
+  subject(:context) { described_class.new(**args) }
+  let(:args) { {} }
+
+  describe "#assets" do
+    context "assets given" do
+      let(:args) { {assets: assets} }
+      let(:assets) { double(:assets) }
+
+      it "returns the assets" do
+        expect(context.assets).to be assets
+      end
+    end
+
+    context "no assets given" do
+      it "raises a Hanami::ComponentLoadError" do
+        expect { context.assets }.to raise_error Hanami::ComponentLoadError
+      end
+    end
+  end
+
+  describe "#request" do
+    context "request given" do
+      let(:args) { {request: request} }
+      let(:request) { double(:request) }
+
+      it "returns the request" do
+        expect(context.request).to be request
+      end
+    end
+
+    context "no request given" do
+      it "raises a Hanami::ComponentLoadError" do
+        expect { context.request }.to raise_error Hanami::ComponentLoadError
+      end
+    end
+  end
+
+  describe "#routes" do
+    context "routes given" do
+      let(:args) { {routes: routes} }
+      let(:routes) { double(:routes) }
+
+      it "returns the routes" do
+        expect(context.routes).to be routes
+      end
+    end
+
+    context "no routes given" do
+      it "raises a Hanami::ComponentLoadError" do
+        expect { context.routes }.to raise_error Hanami::ComponentLoadError
+      end
+    end
+  end
+end

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

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+RSpec.describe Hanami::Helpers::AssetsHelper, "#asset_url", :app_integration do
+  subject(:obj) {
+    helpers = described_class
+    Class.new {
+      include helpers
+
+      attr_reader :_context
+
+      def initialize(context)
+        @_context = context
+      end
+    }.new(context)
+  }
+
+  def asset_url(...)
+    subject.asset_url(...)
+  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("app.js")
+
+      require "hanami/setup"
+      before_prepare if respond_to?(:before_prepare)
+      require "hanami/prepare"
+    end
+  end
+
+  context "when configurated relative path only" do
+    context "without manifest" do
+      it "returns the relative URL to the asset" do
+        expect(asset_url("app.js")).to eq("/assets/app.js")
+      end
+
+      it "returns absolute URL if the argument is an absolute URL" do
+        result = asset_url("http://assets.hanamirb.org/assets/application.css")
+        expect(result).to eq("http://assets.hanamirb.org/assets/application.css")
+      end
+    end
+
+    context "with manifest" do
+      before { compile_assets! }
+
+      it "returns the relative URL to the asset" do
+        expect(asset_url("app.js")).to match(%r{/assets/app-[A-Z0-9]{8}\.js})
+      end
+    end
+  end
+
+  context "when configured with base url" do
+    let(:base_url) { "https://hanami.test" }
+
+    def before_prepare
+      Hanami.app.config.assets.base_url = base_url
+    end
+
+    context "without manifest" do
+      it "returns the absolute URL to the asset" do
+        expect(asset_url("app.js")).to eq("#{base_url}/assets/app.js")
+      end
+    end
+
+    context "with manifest" do
+      before { compile_assets! }
+
+      it "returns the relative path to the asset" do
+        expect(asset_url("app.js")).to match(%r{#{base_url}/assets/app-[A-Z0-9]{8}.js})
+      end
+    end
+  end
+end

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

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+RSpec.describe Hanami::Helpers::AssetsHelper, "#audio_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 audio_tag(...)
+    subject.audio_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("song.ogg", "song.pt-BR.vtt")
+
+      require "hanami/setup"
+      before_prepare if respond_to?(:before_prepare)
+      require "hanami/prepare"
+    end
+  end
+
+  it "returns an instance of HtmlBuilder" do
+    actual = audio_tag("song.ogg")
+    expect(actual).to be_instance_of(::Hanami::View::HTML::SafeString)
+  end
+
+  it "renders <audio> tag" do
+    actual = audio_tag("song.ogg").to_s
+    expect(actual).to eq(%(<audio src="/assets/song.ogg"></audio>))
+  end
+
+  it "renders with html attributes" do
+    actual = audio_tag("song.ogg", autoplay: true, controls: true).to_s
+    expect(actual).to eq(%(<audio autoplay="autoplay" controls="controls" src="/assets/song.ogg"></audio>))
+  end
+
+  it "renders with fallback content" do
+    actual = audio_tag("song.ogg") do
+      "Your browser does not support the audio tag"
+    end.to_s
+
+    expect(actual).to eq(%(<audio src="/assets/song.ogg">Your browser does not support the audio tag</audio>))
+  end
+
+  it "renders with tracks" do
+    actual = audio_tag("song.ogg") do
+      tag.track kind: "captions", src: subject.asset_url("song.pt-BR.vtt"), srclang: "pt-BR", label: "Portuguese"
+    end.to_s
+
+    expect(actual).to eq(%(<audio src="/assets/song.ogg"><track kind="captions" src="/assets/song.pt-BR.vtt" srclang="pt-BR" label="Portuguese"></audio>))
+  end
+
+  xit "renders with sources" do
+    actual = audio_tag do
+      tag.text "Your browser does not support the audio tag"
+      tag.source src: subject.asset_url("song.ogg"), type: "audio/ogg"
+      tag.source src: subject.asset_url("song.wav"), type: "audio/wav"
+    end.to_s
+
+    expect(actual).to eq(%(<audio>Your browser does not support the audio tag<source src="/assets/song.ogg" type="audio/ogg"><source src="/assets/song.wav" type="audio/wav"></audio>))
+  end
+
+  it "raises an exception when no arguments" do
+    expect do
+      audio_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
+      audio_tag(controls: 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 = base_url
+    end
+
+    it "returns absolute url for src attribute" do
+      actual = audio_tag("song.ogg").to_s
+      expect(actual).to eq(%(<audio src="#{base_url}/assets/song.ogg"></audio>))
+    end
+  end
+
+  private
+
+  def tag(...)
+    subject.__send__(:tag, ...)
+  end
+end

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

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+RSpec.describe Hanami::Helpers::AssetsHelper, "#favicon_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 favicon_link_tag(...)
+    obj.instance_eval { favicon_link_tag(...) }
+  end
+
+  let(:root) { make_tmp_directory }
+  let(:context) { TestApp::Views::Context.new }
+
+  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("favicon.ico", "favicon.png")
+
+      require "hanami/setup"
+      before_prepare if respond_to?(:before_prepare)
+      require "hanami/prepare"
+    end
+  end
+
+  it "returns an instance of SafeString" do
+    actual = favicon_link_tag
+    expect(actual).to be_instance_of(::Hanami::View::HTML::SafeString)
+  end
+
+  it "is aliased as `favicon`" do
+    expect(subject.favicon).to eq favicon_link_tag
+  end
+
+  it "renders <link> tag" do
+    actual = favicon_link_tag.to_s
+    expect(actual).to eq(%(<link href="/assets/favicon.ico" rel="shortcut icon" type="image/x-icon">))
+  end
+
+  it "renders with HTML attributes" do
+    actual = favicon_link_tag("favicon.png", rel: "icon", type: "image/png").to_s
+    expect(actual).to eq(%(<link href="/assets/favicon.png" rel="icon" type="image/png">))
+  end
+
+  it "ignores href passed as an option" do
+    actual = favicon_link_tag("favicon.png", href: "wrong").to_s
+    expect(actual).to eq(%(<link href="/assets/favicon.png" rel="shortcut icon" type="image/x-icon">))
+  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 href attribute" do
+      actual = favicon_link_tag.to_s
+      expect(actual).to eq(%(<link href="#{base_url}/assets/favicon.ico" rel="shortcut icon" type="image/x-icon">))
+    end
+  end
+end

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

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+RSpec.describe Hanami::Helpers::AssetsHelper, "#image_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 image_tag(...)
+    subject.image_tag(...)
+  end
+
+  let(:root) { make_tmp_directory }
+  let(:context) { TestApp::Views::Context.new }
+
+  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("application.jpg")
+
+      require "hanami/setup"
+      before_prepare if respond_to?(:before_prepare)
+      require "hanami/prepare"
+    end
+  end
+
+  it "returns an instance of HtmlBuilder" do
+    actual = image_tag("application.jpg")
+    expect(actual).to be_instance_of(::Hanami::View::HTML::SafeString)
+  end
+
+  it "renders an <img> tag" do
+    actual = image_tag("application.jpg").to_s
+    expect(actual).to eq(%(<img src="/assets/application.jpg" alt="Application">))
+  end
+
+  it "custom alt" do
+    actual = image_tag("application.jpg", alt: "My Alt").to_s
+    expect(actual).to eq(%(<img src="/assets/application.jpg" alt="My Alt">))
+  end
+
+  it "custom data attribute" do
+    actual = image_tag("application.jpg", "data-user-id" => 5).to_s
+    expect(actual).to eq(%(<img src="/assets/application.jpg" alt="Application" data-user-id="5">))
+  end
+
+  it "ignores src passed as an option" do
+    actual = image_tag("application.jpg", src: "wrong").to_s
+    expect(actual).to eq(%(<img src="/assets/application.jpg" alt="Application">))
+  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 = image_tag("application.jpg").to_s
+      expect(actual).to eq(%(<img src="#{base_url}/assets/application.jpg" alt="Application">))
+    end
+  end
+end

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