hanami 2.0.0.alpha7 → 2.0.0.beta1

data/spec/integration/sessions_spec.rb

@@ -0,0 +1,247 @@
+# frozen_string_literal: true
+
+RSpec.describe "Sessions", type: :integration do
+  it "shows welcome page" do
+    with_project do
+      server do
+        visit "/"
+
+        expect(page).to have_title("Hanami | The web, with simplicity")
+
+        expect(page).to have_content("The web, with simplicity.")
+        expect(page).to have_content("Hanami is Open Source Software for MVC web development with Ruby.")
+        expect(page).to have_content("bundle exec hanami generate action web 'home#index' --url=/")
+      end
+    end
+  end
+
+  it "is empty by default" do
+    with_project do
+      prepare
+
+      server do
+        visit "/"
+
+        expect(current_path).to eq("/")
+        expect(page).to         have_content("Sign in")
+      end
+    end
+  end
+
+  it "preserves data across requests" do
+    with_project do
+      prepare
+
+      server do
+        visit "/"
+        expect(current_path).to eq("/")
+
+        click_link("Sign in")
+        expect(current_path).to eq("/signin")
+
+        within "form#signin-form" do
+          click_button "Sign in"
+        end
+
+        visit "/" # Without this, Capybara losts the session.
+
+        expect(current_path).to eq("/")
+        expect(page).to have_content("Welcome, Luca")
+      end
+    end
+  end
+
+  it "clears the session" do
+    with_project do
+      prepare
+
+      server do
+        given_signedin_user
+
+        click_link "Sign out"
+
+        expect(current_path).to eq("/")
+        expect(page).to_not have_content("Welcome, Luca")
+      end
+    end
+  end
+
+  context "when sessions aren't enabled" do
+    it "raises error when trying to use `session'" 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 = session[:foo]
+              end
+            end
+          end
+        EOF
+        server do
+          visit "/"
+          expect(page).to have_content("To use `session', please enable sessions for the current app.")
+        end
+      end
+    end
+
+    it "raises error when trying to use `flash'" 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 = flash[:notice]
+              end
+            end
+          end
+        EOF
+        server do
+          visit "/"
+          expect(page).to have_content("To use `flash', please enable sessions for the current app.")
+        end
+      end
+    end
+  end
+
+  private
+
+  def prepare
+    # Enable sessions
+    replace "apps/web/app.rb", "# sessions :cookie, secret: ENV['WEB_SESSIONS_SECRET']", "sessions :cookie, secret: ENV['WEB_SESSIONS_SECRET']"
+
+    generate_user
+    generate_actions
+  end
+
+  def generate_user # rubocop:disable Metrics/MethodLength
+    generate_model     "user"
+    generate_migration "create_users", <<~EOF
+      Hanami::Model.migration do
+        change do
+          create_table :users do
+            primary_key :id
+            column :name, String
+          end
+
+          execute "INSERT INTO users (name) VALUES('Luca')"
+        end
+      end
+    EOF
+
+    hanami "db prepare"
+  end
+
+  def generate_actions
+    generate_home
+    generate_signin
+    generate_signout
+  end
+
+  def generate_home # rubocop:disable Metrics/MethodLength
+    generate "action web home#index --url=/"
+    replace "apps/web/config/routes.rb", "home#index", 'root to: "home#index"'
+
+    rewrite "apps/web/controllers/home/index.rb", <<~EOF
+      module Web::Controllers::Home
+        class Index
+          include Web::Action
+          expose :current_user
+
+          def call(params)
+            @current_user = UserRepository.new.find(session[:user_id])
+          end
+        end
+      end
+    EOF
+
+    rewrite "apps/web/templates/home/index.html.erb", <<~EOF
+      <h1>Bookshelf</h1>
+
+      <% if current_user.nil? %>
+        <%= link_to "Sign in", "/signin" %>
+      <% else %>
+        Welcome, <%= current_user.name %>
+        <%= link_to "Sign out", "/signout" %>
+      <% end %>
+    EOF
+  end
+
+  def generate_signin
+    generate_signin_new_action
+    generate_signin_create_action
+  end
+
+  def generate_signin_new_action
+    generate "action web sessions#new --url=/signin --method=GET"
+    rewrite "apps/web/templates/sessions/new.html.erb", <<~EOF
+      <h1>Sign in</h1>
+
+      <%=
+        form_for :signin, "/signin", id: "signin-form" do
+          div do
+            button "Sign in"
+          end
+        end
+      %>
+    EOF
+  end
+
+  def generate_signin_create_action
+    generate "action web sessions#create --url=/signin --method=POST"
+    rewrite "apps/web/controllers/sessions/create.rb", <<~EOF
+      module Web::Controllers::Sessions
+        class Create
+          include Web::Action
+
+          def call(params)
+            session[:user_id] = UserRepository.new.first.id
+            redirect_to routes.root_url
+          end
+        end
+      end
+    EOF
+  end
+
+  def generate_signout
+    generate "action web sessions#destroy --url=/signout --method=GET"
+
+    rewrite "apps/web/controllers/sessions/destroy.rb", <<~EOF
+      module Web::Controllers::Sessions
+        class Destroy
+          include Web::Action
+
+          def call(params)
+            session[:user_id] = nil
+            redirect_to routes.root_url
+          end
+        end
+      end
+    EOF
+  end
+
+  def given_signedin_user # rubocop:disable Metrics/AbcSize
+    visit "/"
+    expect(current_path).to eq("/")
+
+    click_link("Sign in")
+    expect(current_path).to eq("/signin")
+
+    within "form#signin-form" do
+      click_button "Sign in"
+    end
+
+    visit "/" # Without this, Capybara losts the session.
+
+    expect(current_path).to eq("/")
+    expect(page).to have_content("Welcome, Luca")
+  end
+end

data/spec/integration/static_middleware_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+RSpec.describe "Static middleware", type: :integration do
+  it "serves a public file" do
+    with_project do
+      write "public/static.txt", "Static file"
+
+      RSpec::Support::Env["HANAMI_ENV"]          = "production"
+      RSpec::Support::Env["DATABASE_URL"]        = "sqlite://#{Pathname.new('db').join('bookshelf.sqlite')}"
+      RSpec::Support::Env["SERVE_STATIC_ASSETS"] = "true"
+      RSpec::Support::Env["SMTP_HOST"]           = "localhost"
+      RSpec::Support::Env["SMTP_PORT"]           = "25"
+
+      server do
+        visit "/static.txt"
+
+        expect(page.body).to include("Static file")
+      end
+    end
+  end
+end

data/spec/integration/streaming_spec.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+RSpec.describe "Streaming", type: :integration do
+  xit "streams the body" do
+    with_project do
+      generate "action web home#index --url=/"
+
+      # Require Rack::Chunked
+      unshift "apps/web/app.rb", "require 'rack/chunked'"
+
+      # Mount middleware
+      replace "apps/web/app.rb", "# middleware.use", "middleware.use ::Rack::Chunked"
+      replace "apps/web/app.rb", "controller.prepare do", "controller.format text: 'text/plain'\ncontroller.prepare do"
+
+      rewrite "apps/web/controllers/home/index.rb", <<~EOF
+        module Web::Controllers::Home
+          class Index
+            include Web::Action
+
+            def call(params)
+              self.format = :text
+              self.body = Enumerator.new do |y|
+                %w(one two three).each { |s| y << s }
+              end
+            end
+          end
+        end
+      EOF
+
+      server do
+        get "/", {}, "HTTP_VERSION" => "HTTP/1.1"
+
+        expect(last_response.headers).to_not have_key("Content-Length")
+        expect(last_response.headers["Transfer-Encoding"]).to eq("chunked")
+
+        expect(last_response.status).to eq(200)
+        expect(last_response.body).to   eq("3\r\none\r\n3\r\ntwo\r\n5\r\nthree\r\n0\r\n\r\n")
+      end
+    end
+  end
+end

data/spec/integration/unsafe_send_file_spec.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+RSpec.describe "Unsafe send file", type: :integration do
+  it "sends file from the public directory" do
+    with_project do
+      write "public/static.txt", "Static 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)
+              unsafe_send_file "public/static.txt"
+            end
+          end
+        end
+      EOF
+
+      server do
+        get "/"
+
+        expect(last_response.status).to eq(200)
+        expect(last_response.body).to   include("Static file")
+      end
+    end
+  end
+
+  it "sends file outside of the public directory" 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)
+              unsafe_send_file __FILE__
+            end
+          end
+        end
+      EOF
+
+      server do
+        get "/"
+
+        expect(last_response.status).to eq(200)
+        expect(last_response.body).to   include("Web::Controllers::Home")
+      end
+    end
+  end
+end

data/spec/isolation/hanami/application/already_configured_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Bookshelf
+  class App < Hanami::App
+  end
+end
+
+RSpec.describe Hanami do
+  describe ".application" do
+    it "it raises error when already assigned" do
+      expect do
+        module Soundcard
+          class App < Hanami::App
+          end
+        end
+      end.to raise_error("Hanami.app already configured")
+    end
+  end
+end

data/spec/isolation/hanami/application/inherit_anonymous_class_spec.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+RSpec.describe Hanami do
+  describe ".application" do
+    it "it doesn't assign when anonymous class inherits Hanami::Application" do
+      Class.new(Hanami::Application)
+      expect { Hanami.app }.to raise_error("Hanami.app not configured")
+    end
+  end
+end

data/spec/isolation/hanami/application/inherit_concrete_class_spec.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Bookshelf
+  class App < Hanami::App
+  end
+end
+
+RSpec.describe Hanami do
+  describe ".application" do
+    it "it assign when concrete class inherits Hanami::Application" do
+      expect(Hanami.app).to eq(Bookshelf::Application)
+    end
+  end
+end

data/spec/isolation/hanami/application/not_configured_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+RSpec.describe Hanami do
+  describe ".application" do
+    it "it raises error when not configured" do
+      expect { Hanami.app }.to raise_error("Hanami.app not configured")
+    end
+  end
+end

data/spec/isolation/hanami/application/routes/configured_spec.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "hanami/action"
+
+module Bookshelf
+  class App < Hanami::App
+  end
+end
+
+module Web
+end
+Hanami.app.register_slice :web, namespace: Web
+
+Hanami.prepare
+
+module Web
+  class Action < Hanami::Action
+  end
+
+  module Actions
+    module Home
+      class Index < Web::Action
+      end
+    end
+  end
+end
+
+Hanami.app.routes do
+  mount :web, at: "/" do
+    root to: "home#index"
+  end
+end
+
+RSpec.describe Hanami::Application do
+  describe ".routes" do
+    subject { Hanami.app.routes }
+
+    it "returns configured routes" do
+      expect(subject).to be_kind_of(Proc)
+      # FIXME: make this expectation to pass
+      # expect(subject.for(:web).url(:root)).to eq("/")
+    end
+  end
+end

data/spec/isolation/hanami/application/routes/not_configured_spec.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Bookshelf
+  class App < Hanami::App
+  end
+end
+
+RSpec.describe Hanami::Application do
+  describe ".routes" do
+    subject { Hanami.app.routes }
+
+    it "raises error when not configured" do
+      expect { subject }.to raise_error("Hanami.app.routes not configured")
+    end
+  end
+end

data/spec/isolation/hanami/boot/success_spec.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "hanami/action"
+require "hanami/logger"
+
+module Bookshelf
+  class App < Hanami::App
+  end
+end
+
+module Web
+end
+slice = Hanami.app.register_slice :web, namespace: Web
+
+Hanami.prepare
+
+Hanami.app.routes do
+  mount :web, at: "/" do
+    root to: "home#index"
+  end
+end
+
+module Web
+  class Action < Hanami::Action
+  end
+
+  module Actions
+    module Home
+      class Index < Web::Action
+      end
+    end
+  end
+end
+
+slice.register "actions.home.index" do
+  Web::Actions::Home::Index.new
+end
+
+RSpec.describe Hanami do
+  describe ".boot" do
+    it "assigns Hanami.app, .root, and .logger" do
+      pending "Failing due to dry-system changes"
+
+      Hanami.boot
+      expect(Hanami.app.ancestors).to include(Hanami::Application)
+      expect(Hanami.app.root).to eq(Dir.pwd)
+      expect(Hanami.logger).to be_kind_of(Hanami::Logger)
+    end
+  end
+end

data/spec/new_integration/action/configuration_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+RSpec.describe "App action / Configuration", :app_integration do
+  before do
+    module TestApp
+      class App < Hanami::App
+        config.actions.default_response_format = :json
+        register_slice :main
+      end
+    end
+
+    Hanami.app.prepare
+
+    module TestApp
+      class Action < Hanami::Action
+      end
+    end
+  end
+
+  let(:action_class) { TestApp::Action }
+  subject(:configuration) { action_class.config }
+
+  it "applies 'config.actions' configuration from the app" do
+    expect(configuration.default_response_format).to eq :json
+  end
+end

data/spec/new_integration/action/cookies_spec.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+RSpec.describe "App action / Cookies", :app_integration do
+  before do
+    module TestApp
+      class App < Hanami::App
+      end
+    end
+
+    Hanami.app.instance_eval(&app_hook) if respond_to?(:app_hook)
+    Hanami.app.prepare
+
+    module TestApp
+      class Action < Hanami::Action
+      end
+    end
+  end
+
+  subject(:action_class) { TestApp::Action }
+
+  context "default configuration" do
+    it "has cookie support enabled" do
+      expect(action_class.ancestors).to include Hanami::Action::Cookies
+    end
+  end
+
+  context "custom cookie options given in app-level config" do
+    subject(:app_hook) {
+      proc do
+        config.actions.cookies = {max_age: 300}
+      end
+    }
+
+    it "has cookie support enabled" do
+      expect(action_class.ancestors).to include Hanami::Action::Cookies
+    end
+
+    it "has the cookie options configured" do
+      expect(action_class.config.cookies).to eq(max_age: 300)
+    end
+  end
+
+  context "cookies disabled in app-level config" do
+    subject(:app_hook) {
+      proc do
+        config.actions.cookies = nil
+      end
+    }
+
+    it "does not have cookie support enabled" do
+      expect(action_class.ancestors.map(&:to_s)).not_to include "Hanami::Action::Cookies"
+    end
+
+    it "has no cookie options configured" do
+      expect(action_class.config.cookies).to eq({})
+    end
+  end
+end

data/spec/new_integration/action/csrf_protection_spec.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+RSpec.describe "App action / CSRF protection", :app_integration do
+  before do
+    module TestApp
+      class App < Hanami::App
+      end
+    end
+
+    Hanami.app.instance_eval(&app_hook) if respond_to?(:app_hook)
+    Hanami.app.register_slice :main
+    Hanami.app.prepare
+
+    module TestApp
+      class Action < Hanami::Action
+      end
+    end
+  end
+
+  subject(:action_class) { TestApp::Action }
+
+  context "app sessions enabled" do
+    context "CSRF protection not explicitly configured" do
+      let(:app_hook) {
+        proc do
+          config.actions.sessions = :cookie, {secret: "abc123"}
+        end
+      }
+
+      it "has CSRF protection enabled" do
+        expect(action_class.ancestors).to include Hanami::Action::CSRFProtection
+      end
+    end
+
+    context "CSRF protection explicitly disabled" do
+      let(:app_hook) {
+        proc do
+          config.sessions = :cookie, {secret: "abc123"}
+          config.actions.csrf_protection = false
+        end
+      }
+
+      it "does not have CSRF protection enabled" do
+        expect(action_class.ancestors.map(&:to_s)).not_to include "Hanami::Action::CSRFProtection"
+      end
+    end
+  end
+
+  context "app sessions not enabled" do
+    it "does not have CSRF protection enabled" do
+      expect(action_class.ancestors.map(&:to_s)).not_to include "Hanami::Action::CSRFProtection"
+    end
+  end
+end