hanami 2.0.0.alpha8 → 2.0.0.beta1

data/spec/integration/cli/version_spec.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+RSpec.describe "hanami version", type: :integration do
+  context "within a project" do
+    it "prints current version" do
+      with_project do
+        run_cmd 'hanami version', "v#{Hanami::VERSION}"
+      end
+    end
+
+    it "prints current version with v alias" do
+      with_project do
+        run_cmd 'hanami v', "v#{Hanami::VERSION}"
+      end
+    end
+
+    it "prints current version with -v alias" do
+      with_project do
+        run_cmd 'hanami -v', "v#{Hanami::VERSION}"
+      end
+    end
+
+    it "prints current version with --version alias" do
+      with_project do
+        run_cmd 'hanami --version', "v#{Hanami::VERSION}"
+      end
+    end
+
+    it "prints help message" do
+      with_project do
+        output = <<~OUT
+Command:
+  hanami version
+
+Usage:
+  hanami version
+
+Description:
+  Print Hanami version
+
+Options:
+  --help, -h                        # Print this help
+OUT
+
+        run_cmd 'hanami version --help', output
+      end
+    end
+  end
+
+  context "outside of a project" do
+    it 'prints current version' do
+      run_cmd 'hanami version', "v#{Hanami::VERSION}"
+    end
+
+    it 'prints current version with v alias' do
+      run_cmd 'hanami v', "v#{Hanami::VERSION}"
+    end
+
+    it 'prints current version with -v alias' do
+      run_cmd 'hanami -v', "v#{Hanami::VERSION}"
+    end
+
+    it 'prints current version with --version alias' do
+      run_cmd 'hanami --version', "v#{Hanami::VERSION}"
+    end
+
+    it "prints help message" do
+      output = <<~OUT
+Command:
+  hanami version
+
+Usage:
+  hanami version
+
+Description:
+  Print Hanami version
+
+Options:
+  --help, -h                        # Print this help
+OUT
+
+      run_cmd 'hanami version --help', output
+    end
+  end
+end

data/spec/integration/early_hints_spec.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+RSpec.describe "Early Hints", type: :integration do
+  it "pushes assets" do
+    skip "curl not installed" if which("curl").nil?
+
+    with_project("bookshelf", server: :puma) do
+      generate "action web home#index --url=/"
+
+      write "apps/web/assets/javascripts/app.css", <<~EOF
+        body { margin: 0; }
+      EOF
+
+      inject_line_after "apps/web/templates/app.html.erb", /favicon/, %(<%= stylesheet "app" %>)
+      inject_line_after "config/environment.rb", /mount/, "early_hints true"
+
+      write "config/puma.rb", <<~EOF
+        early_hints true
+      EOF
+
+      port = RSpec::Support::RandomPort.call
+      server(port: port) do
+        sleep 2
+
+        # The Ruby HTTP client that we use for testing (excon), fails to connect to the server.
+        # It's very likely that it assumes that for each request, the server will return only one response.
+        # But in case of Early Hints (103) the returned response are multiple: `n` Early Hints (103) + OK (200).
+        #
+        # For this reason we fall back to cURL for this test.
+        system_exec("curl -i -v http://localhost:#{port}/")
+        expect(out).to include("Link: </assets/app.css>; rel=preload; as=style")
+      end
+    end
+  end
+end

data/spec/integration/handle_exceptions_spec.rb

@@ -0,0 +1,244 @@
+# frozen_string_literal: true
+
+RSpec.describe "handle exceptions", type: :integration do
+  it "doesn't handle exceptions in development mode" do
+    with_project do
+      generate_action
+
+      server do
+        get "/books/1"
+
+        expect(last_response.status).to eq(500)
+      end
+    end
+  end
+
+  it "doesn't handle exceptions in test mode" do
+    with_project do
+      generate_action
+
+      RSpec::Support::Env["HANAMI_ENV"] = "test"
+
+      server do
+        get "/books/1"
+
+        expect(last_response.status).to eq(500)
+      end
+    end
+  end
+
+  context "when handles exceptions in production mode" do
+    it "it returns the expected status" do
+      with_project do
+        generate_action
+        setup_production_env
+
+        server do
+          get "/books/1"
+
+          expect(last_response.status).to eq(400)
+        end
+      end
+    end
+
+    context "and an exception is raised from a template" do
+      it "it returns a 500 and it renders a custom template if it exists" do
+        with_project do
+          generate "action web books#show --url=/books/:id"
+
+          rewrite "apps/web/templates/books/show.html.erb", <<~EOF
+            <%= raise ArgumentError.new("oh nooooo") %>
+          EOF
+
+          write "apps/web/templates/500.html.erb", <<~EOF
+            This is a custom template for 500 error
+          EOF
+
+          setup_production_env
+
+          server do
+            get "/books/1"
+
+            expect(last_response.status).to eq(500)
+            expect(last_response.body).to eq("This is a custom template for 500 error\n")
+          end
+        end
+      end
+
+      it "it returns a 500 and it renders the default template if custom template doesn't exist" do
+        with_project do
+          generate "action web books#show --url=/books/:id"
+
+          rewrite "apps/web/templates/books/show.html.erb", <<~EOF
+            <%= raise ArgumentError.new("oh nooooo") %>
+          EOF
+
+          setup_production_env
+
+          server do
+            get "/books/1"
+
+            expect(last_response.status).to eq(500)
+            expect(last_response.body).to include("<h2>500 - Internal Server Error</h2>")
+          end
+        end
+      end
+
+      it "it returns a 500 and renders backtrace error if an exception is raised from 500 custom template" do
+        with_project do
+          generate "action web books#show --url=/books/:id"
+
+          rewrite "apps/web/templates/books/show.html.erb", <<~EOF
+            <%= raise ArgumentError.new("oh nooooo") %>
+          EOF
+
+          write "apps/web/templates/500.html.erb", <<~EOF
+            <%= raise ArgumentError.new("Error from custom template") %>
+            This is a custom template for 500 error
+          EOF
+
+          setup_production_env
+
+          server do
+            get "/books/1"
+
+            expect(last_response.status).to eq(500)
+            expect(last_response.body).to_not include("This is a custom template for 500 error")
+            expect(last_response.body).to include("Error from custom template")
+          end
+        end
+      end
+    end
+
+    context "and an exception is raised from a view" do
+      it "it returns a 500 and it renders a custom template if it exists" do
+        with_project do
+          generate "action web books#show --url=/books/:id"
+
+          rewrite "apps/web/views/books/show.rb", <<~EOF
+            module Web::Views::Books
+              class Show
+                include Web::View
+
+                def header
+                  raise ArgumentError.new("oh nooooo")
+                end
+              end
+            end
+          EOF
+
+          rewrite "apps/web/templates/books/show.html.erb", <<~EOF
+            <%= header %>
+          EOF
+
+          write "apps/web/templates/500.html.erb", <<~EOF
+            This is a custom template for 500 error
+          EOF
+
+          setup_production_env
+
+          server do
+            get "/books/1"
+
+            expect(last_response.status).to eq(500)
+            expect(last_response.body).to eq("This is a custom template for 500 error\n")
+          end
+        end
+      end
+
+      it "it returns a 500 and it renders the default template if custom template doesn't exist" do
+        with_project do
+          generate "action web books#show --url=/books/:id"
+
+          rewrite "apps/web/views/books/show.rb", <<~EOF
+            module Web::Views::Books
+              class Show
+                include Web::View
+
+                def header
+                  raise ArgumentError.new("oh nooooo")
+                end
+              end
+            end
+          EOF
+
+          rewrite "apps/web/templates/books/show.html.erb", <<~EOF
+            <%= header %>
+          EOF
+
+          setup_production_env
+
+          server do
+            get "/books/1"
+
+            expect(last_response.status).to eq(500)
+            expect(last_response.body).to include("<h2>500 - Internal Server Error</h2>")
+          end
+        end
+      end
+
+      it "it returns a 500 and renders backtrace error if an exception is raised from 500 custom template" do
+        with_project do
+          generate "action web books#show --url=/books/:id"
+
+          rewrite "apps/web/views/books/show.rb", <<~EOF
+            module Web::Views::Books
+              class Show
+                include Web::View
+
+                def header
+                  raise ArgumentError.new("oh nooooo")
+                end
+              end
+            end
+          EOF
+
+          rewrite "apps/web/templates/books/show.html.erb", <<~EOF
+            <%= header %>
+          EOF
+
+          write "apps/web/templates/500.html.erb", <<~EOF
+            <%= raise ArgumentError.new("Error from custom template") %>
+            This is a custom template for 500 error
+          EOF
+
+          setup_production_env
+
+          server do
+            get "/books/1"
+
+            expect(last_response.status).to eq(500)
+            expect(last_response.body).to_not include("This is a custom template for 500 error")
+            expect(last_response.body).to include("Error from custom template")
+          end
+        end
+      end
+    end
+  end
+
+  private
+
+  def generate_action
+    generate "action web books#show --url=/books/:id"
+
+    rewrite "apps/web/controllers/books/show.rb", <<~EOF
+      module Web::Controllers::Books
+        class Show
+          include Web::Action
+          handle_exception ArgumentError => 400
+
+          def call(params)
+            raise ArgumentError.new("oh nooooo")
+          end
+        end
+      end
+    EOF
+  end
+
+  def setup_production_env
+    RSpec::Support::Env["HANAMI_ENV"]   = "production"
+    RSpec::Support::Env["DATABASE_URL"] = "sqlite://#{Pathname.new('db').join('bookshelf.sqlite')}"
+    RSpec::Support::Env["SMTP_HOST"]    = "localhost"
+    RSpec::Support::Env["SMTP_PORT"]    = "25"
+  end
+end

data/spec/integration/head_spec.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+RSpec.describe "HTTP HEAD", type: :integration do
+  it "returns empty body for HEAD requests" do
+    with_project do
+      generate "action web home#index --url=/"
+
+      server do
+        head "/"
+
+        expect(last_response.status).to eq(200)
+        expect(last_response.body).to   eq("")
+      end
+    end
+  end
+
+  it "returns empty body for HEAD requests when body is set by the action" do
+    with_project do
+      generate "action web home#index --url=/"
+      rewrite "apps/web/controllers/home/index.rb", <<~EOF
+        module Web::Controllers::Home
+          class Index
+            include Web::Action
+
+            def call(params)
+              self.body = "Hello"
+            end
+          end
+        end
+      EOF
+
+      server do
+        head "/"
+
+        expect(last_response.status).to eq(200)
+        expect(last_response.body).to   eq("")
+      end
+    end
+  end
+
+  it "returns empty body for HEAD requests when body is set by the view" do
+    with_project do
+      generate "action web home#index --url=/"
+      rewrite "apps/web/views/home/index.rb", <<~EOF
+        module Web::Views::Home
+          class Index
+            include Web::View
+
+            def render
+              "World"
+            end
+          end
+        end
+      EOF
+
+      server do
+        head "/"
+
+        expect(last_response.status).to eq(200)
+        expect(last_response.body).to   eq("")
+      end
+    end
+  end
+
+  it "returns empty body for HEAD requests with send file" do
+    with_project do
+      write "public/static.txt", "Plain text file"
+      generate "action web home#index --url=/"
+      rewrite "apps/web/controllers/home/index.rb", <<~EOF
+        module Web::Controllers::Home
+          class Index
+            include Web::Action
+
+            def call(params)
+              send_file "static.txt"
+            end
+          end
+        end
+      EOF
+
+      server do
+        head "/"
+
+        expect(last_response.status).to eq(200)
+        expect(last_response.body).to   eq("")
+      end
+    end
+  end
+end

data/spec/integration/http_headers_spec.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+RSpec.describe "HTTP headers", type: :integration do
+  it "returns HTTP headers" do
+    with_project do
+      generate "action web home#index --url=/"
+
+      server do
+        get "/"
+
+        expect(last_response.status).to       eq(200)
+        expect(last_response.headers.keys).to eq(
+          %w[
+            X-Frame-Options X-Content-Type-Options X-Xss-Protection
+            Content-Security-Policy Content-Type Content-Length
+            Server Date Connection
+          ]
+        )
+
+        expect(last_response.headers["X-Frame-Options"]).to         eq("DENY")
+        expect(last_response.headers["X-Content-Type-Options"]).to  eq("nosniff")
+        expect(last_response.headers["X-Xss-Protection"]).to        eq("1; mode=block")
+        expect(last_response.headers["Content-Security-Policy"]).to eq("form-action 'self'; frame-ancestors 'self'; base-uri 'self'; default-src 'none'; script-src 'self'; connect-src 'self'; img-src 'self' https: data:; style-src 'self' 'unsafe-inline' https:; font-src 'self'; object-src 'none'; plugin-types app/pdf; child-src 'self'; frame-src 'self'; media-src 'self'")
+        expect(last_response.headers["Content-Type"]).to            eq("text/html; charset=utf-8")
+        expect(Integer(last_response.headers["Content-Length"])).to be > 0
+      end
+    end
+  end
+end

data/spec/integration/mailer_spec.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+RSpec.describe "Mailer", type: :integration do
+  it "use a mailer" do
+    with_project do
+      generate "mailer welcome"
+      write "lib/bookshelf/mailers/default_user.rb", <<~EOF
+        module Mailers
+          module DefaultUser
+            def user_name
+              "Alfonso"
+            end
+          end
+        end
+      EOF
+
+      replace "config/environment.rb", "delivery :test", <<-EOF
+    delivery :test
+
+    prepare do
+      include Mailers::DefaultUser
+    end
+      EOF
+
+      console do |input, _, _|
+        input.puts("Mailers::Welcome.new.user_name")
+      end
+
+      expect(out).to include("Alfonso")
+    end
+  end
+end

data/spec/integration/middleware_spec.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+RSpec.describe "Project middleware", type: :integration do
+  it "mounts Rack middleware" do
+    with_project do
+      generate_middleware
+
+      unshift "config/environment.rb", 'require "rack/etag"'
+      unshift "config/environment.rb", 'require_relative "./middleware/runtime"'
+      unshift "config/environment.rb", 'require_relative "./middleware/custom"'
+
+      inject_line_after "config/environment.rb", "Hanami.configure", <<~EOL
+        middleware.use Middleware::Runtime
+        middleware.use Middleware::Custom, "OK"
+        middleware.use Rack::ETag
+      EOL
+
+      generate "action web home#index --url=/"
+      rewrite "apps/web/controllers/home/index.rb", <<~EOF
+        module Web::Controllers::Home
+          class Index
+            include Web::Action
+
+            def call(params)
+              self.body = "OK"
+            end
+          end
+        end
+      EOF
+
+      server do
+        get "/"
+
+        expect(last_response.status).to               eq(200)
+
+        expect(last_response.headers["X-Runtime"]).to eq("1ms")
+        expect(last_response.headers["X-Custom"]).to  eq("OK")
+        expect(last_response.headers["ETag"]).to_not  be_nil
+      end
+    end
+  end
+
+  private
+
+  def generate_middleware # rubocop:disable Metrics/MethodLength
+    write "config/middleware/runtime.rb", <<~EOF
+      module Middleware
+        class Runtime
+          def initialize(app)
+            @app = app
+          end
+
+          def call(env)
+            status, headers, body = @app.call(env)
+            headers["X-Runtime"]  = "1ms"
+
+            [status, headers, body]
+          end
+        end
+      end
+    EOF
+
+    write "config/middleware/custom.rb", <<~EOF
+      module Middleware
+        class Custom
+          def initialize(app, value)
+            @app   = app
+            @value = value
+          end
+
+          def call(env)
+            status, headers, body = @app.call(env)
+            headers["X-Custom"]   = @value
+
+            [status, headers, body]
+          end
+        end
+      end
+    EOF
+  end
+end

data/spec/integration/mount_applications_spec.rb

@@ -0,0 +1,88 @@
+require "resolv-replace"
+require "net/http"
+require "uri"
+
+RSpec.describe "mount apps", type: :integration do
+  before do
+    stub_dns_hosts("127.0.0.1 #{host} www.#{host} #{subdomain} localhost")
+  end
+
+  let(:host) { "bookshelf.test" }
+  let(:subdomain) { "beta.#{host}" }
+
+  context "with apps mounted with path" do
+    it "shows welcome page" do
+      with_project do
+        generate_host_middleware
+        generate "app admin"
+        generate "app beta"
+
+        replace "config/environment.rb", "Beta::App", %(  mount Beta::App, at: "/", host: "#{subdomain}")
+
+        server do
+          # Web
+          visit "/"
+          expect(page).to have_content("bundle exec hanami generate action web 'home#index' --url=/")
+
+          # Admin
+          visit "/admin"
+          expect(page).to have_content("bundle exec hanami generate action admin 'home#index' --url=/")
+        end
+      end
+    end
+  end
+
+  context "when apps mounted with host: option" do
+    it "shows welcome page" do
+      with_project do
+        generate_host_middleware
+        generate "app admin"
+        generate "app beta"
+
+        replace "config/environment.rb", "Beta::App", %(  mount Beta::App, at: "/", host: "#{subdomain}")
+
+        port = RSpec::Support::RandomPort.call
+        server(port: port) do
+          # Beta
+          response = raw_http_request("http://#{subdomain}:#{port}")
+          expect(response.body).to include("bundle exec hanami generate action beta 'home#index' --url=/")
+        end
+      end
+    end
+  end
+
+  private
+
+  def generate_host_middleware
+    unshift "config/environment.rb", 'require_relative "./middleware/host"'
+
+    inject_line_after "config/environment.rb", "Hanami.configure", <<-EOL
+middleware.use Middleware::Host
+EOL
+
+    write "config/middleware/host.rb", <<-EOF
+require "uri"
+
+module Middleware
+  class Host
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      host = URI.parse(env["REQUEST_URI"]).host
+      env["SERVER_NAME"] = host
+      env["HTTP_HOST"] = host
+      env["HTTP_X_FORWARDED_HOST"] = host
+
+      @app.call(env)
+    end
+  end
+end
+EOF
+  end
+
+  def raw_http_request(uri)
+    Net::HTTP.get_response(URI.parse(uri))
+  end
+end