hanami 2.0.0.alpha8 → 2.0.0.beta1

data/spec/integration/cli/generate/mailer_spec.rb

@@ -0,0 +1,189 @@
+# frozen_string_literal: true
+
+RSpec.describe "hanami generate", type: :integration do
+  describe "mailer" do
+    context "generates a new mailer" do
+      let(:output) do
+        ["create  lib/bookshelf_generate_mailer/mailers/welcome.rb",
+         "create  spec/bookshelf_generate_mailer/mailers/welcome_spec.rb",
+         "create  lib/bookshelf_generate_mailer/mailers/templates/welcome.txt.erb",
+         "create  lib/bookshelf_generate_mailer/mailers/templates/welcome.html.erb"]
+      end
+
+      it 'generate the mailer files' do
+        with_project('bookshelf_generate_mailer', test: 'rspec') do
+          run_cmd "hanami generate mailer welcome", output
+          #
+          # lib/bookshelf_generate_mailer/mailers/welcome.rb
+          #
+          expect("lib/bookshelf_generate_mailer/mailers/welcome.rb").to have_file_content <<~END
+            module Mailers
+              class Welcome
+                include Hanami::Mailer
+
+                from    '<from>'
+                to      '<to>'
+                subject 'Hello'
+              end
+            end
+          END
+
+          expect("lib/bookshelf_generate_mailer/mailers/templates/welcome.txt.erb").to have_file_content ""
+          expect("lib/bookshelf_generate_mailer/mailers/templates/welcome.html.erb").to have_file_content ""
+        end
+      end
+
+      it 'generates a proper minitest file' do
+        with_project('bookshelf_generate_mailer', test: 'minitest') do
+          run_cmd "hanami generate mailer welcome", output
+          #
+          # spec/bookshelf_generate_mailer/mailers/welcome_spec.rb
+          #
+          expect("spec/bookshelf_generate_mailer/mailers/welcome_spec.rb").to have_file_content <<~END
+            require_relative '../../spec_helper'
+
+            describe Mailers::Welcome do
+              it 'delivers email' do
+                mail = Mailers::Welcome.deliver
+              end
+            end
+          END
+        end
+      end
+
+      it 'generates a proper RSpec file' do
+        with_project('bookshelf_generate_mailer', test: 'rspec') do
+          run_cmd "hanami generate mailer welcome", output
+          #
+          # spec/bookshelf_generate_mailer/mailers/welcome_spec.rb
+          #
+          expect("spec/bookshelf_generate_mailer/mailers/welcome_spec.rb").to have_file_content <<~END
+            RSpec.describe Mailers::Welcome, type: :mailer do
+              it 'delivers email' do
+                mail = Mailers::Welcome.deliver
+              end
+            end
+          END
+        end
+      end
+    end
+
+    it "generates mailer with options from, to and subject with single quotes" do
+      with_project("bookshelf_generate_mailer_with_options") do
+        output = [
+          "create  spec/bookshelf_generate_mailer_with_options/mailers/welcome_spec.rb",
+          "create  lib/bookshelf_generate_mailer_with_options/mailers/welcome.rb",
+          "create  lib/bookshelf_generate_mailer_with_options/mailers/templates/welcome.txt.erb",
+          "create  lib/bookshelf_generate_mailer_with_options/mailers/templates/welcome.html.erb"
+        ]
+
+        run_cmd "hanami generate mailer welcome --from=\"'mail@example.com'\" --to=\"'user@example.com'\" --subject=\"'Let\'s start'\"", output
+
+        expect("lib/bookshelf_generate_mailer_with_options/mailers/welcome.rb").to have_file_content <<~END
+          module Mailers
+            class Welcome
+              include Hanami::Mailer
+
+              from    'mail@example.com'
+              to      'user@example.com'
+              subject 'Let\'s start'
+            end
+          end
+        END
+      end
+    end
+
+    it "generates mailer with options from, to and subject with double quotes" do
+      with_project("bookshelf_generate_mailer_with_options") do
+        output = [
+          "create  spec/bookshelf_generate_mailer_with_options/mailers/welcome_spec.rb",
+          "create  lib/bookshelf_generate_mailer_with_options/mailers/welcome.rb",
+          "create  lib/bookshelf_generate_mailer_with_options/mailers/templates/welcome.txt.erb",
+          "create  lib/bookshelf_generate_mailer_with_options/mailers/templates/welcome.html.erb"
+        ]
+
+        run_cmd "hanami generate mailer welcome --from='\"mail@example.com\"' --to='\"user@example.com\"' --subject='\"Come on \"Folks\"\"'", output
+
+        expect("lib/bookshelf_generate_mailer_with_options/mailers/welcome.rb").to have_file_content <<~END
+          module Mailers
+            class Welcome
+              include Hanami::Mailer
+
+              from    'mail@example.com'
+              to      'user@example.com'
+              subject 'Come on "Folks"'
+            end
+          end
+        END
+      end
+    end
+
+    it "generates mailer with options from, to and subject without quotes" do
+      with_project("bookshelf_generate_mailer_with_options") do
+        output = [
+          "create  spec/bookshelf_generate_mailer_with_options/mailers/welcome_spec.rb",
+          "create  lib/bookshelf_generate_mailer_with_options/mailers/welcome.rb",
+          "create  lib/bookshelf_generate_mailer_with_options/mailers/templates/welcome.txt.erb",
+          "create  lib/bookshelf_generate_mailer_with_options/mailers/templates/welcome.html.erb"
+        ]
+
+        run_cmd "hanami generate mailer welcome --from=mail@example.com --to=user@example.com --subject=Welcome", output
+
+        expect("lib/bookshelf_generate_mailer_with_options/mailers/welcome.rb").to have_file_content <<~END
+          module Mailers
+            class Welcome
+              include Hanami::Mailer
+
+              from    'mail@example.com'
+              to      'user@example.com'
+              subject 'Welcome'
+            end
+          end
+        END
+      end
+    end
+
+    it "fails with missing arguments" do
+      with_project("bookshelf_generate_mailer_without_args") do
+        output = <<~OUT
+          ERROR: "hanami generate mailer" was called with no arguments
+          Usage: "hanami generate mailer MAILER"
+        OUT
+
+        run_cmd "hanami generate mailer", output, exit_status: 1
+      end
+    end
+
+    it "prints help message" do
+      with_project do
+        output = <<~OUT
+Command:
+  hanami generate mailer
+
+Usage:
+  hanami generate mailer MAILER
+
+Description:
+  Generate a mailer
+
+Arguments:
+  MAILER                            # REQUIRED The mailer name (eg. `welcome`)
+
+Options:
+  --from=VALUE                      # The default `from` field of the mail
+  --to=VALUE                        # The default `to` field of the mail
+  --subject=VALUE                   # The mail subject
+  --help, -h                        # Print this help
+
+Examples:
+  hanami generate mailer welcome                                         # Basic usage
+  hanami generate mailer welcome --from="noreply@example.com"            # Generate with default `from` value
+  hanami generate mailer announcement --to="users@example.com"           # Generate with default `to` value
+  hanami generate mailer forgot_password --subject="Your password reset" # Generate with default `subject`
+        OUT
+
+        run_cmd 'hanami generate mailer --help', output
+      end
+    end
+  end
+end

data/spec/integration/cli/generate/migration_spec.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+RSpec.describe "hanami generate", type: :integration do
+  describe "migration" do
+    context "with migration name" do
+      it_behaves_like "a new migration" do
+        let(:input) { "users" }
+      end
+    end
+
+    context "with underscored name" do
+      it_behaves_like "a new migration" do
+        let(:input) { "create_users" }
+      end
+    end
+
+    context "with dashed name" do
+      it_behaves_like "a new migration" do
+        let(:input) { "add-verified-at-to-users" }
+      end
+    end
+
+    context "with camel case app name" do
+      it_behaves_like "a new migration" do
+        let(:input) { "AddUniqueIndexUsersEmail" }
+      end
+    end
+
+    context "with missing argument" do
+      it "fails" do
+        with_project('bookshelf_generate_migration_missing_arguments') do
+          output = <<-END
+ERROR: "hanami generate migration" was called with no arguments
+Usage: "hanami generate migration MIGRATION"
+END
+
+          run_cmd "hanami generate migration", output, exit_status: 1
+        end
+      end
+    end
+
+    it "prints help message" do
+      with_project do
+        banner = <<~OUT
+Command:
+  hanami generate migration
+
+Usage:
+  hanami generate migration MIGRATION
+
+Description:
+  Generate a migration
+
+Arguments:
+  MIGRATION                         # REQUIRED The migration name (eg. `create_users`)
+
+Options:
+  --help, -h                        # Print this help
+
+Examples:
+OUT
+
+        output = [
+          banner,
+          %r{  hanami generate migration create_users # Generate `db/migrations/[\d]{14}_create_users.rb`},
+        ]
+
+        run_cmd 'hanami generate migration --help', output
+      end
+    end
+  end # migration
+end

data/spec/integration/cli/generate/model_spec.rb

@@ -0,0 +1,290 @@
+# frozen_string_literal: true
+
+require "hanami/utils/string"
+
+RSpec.describe "hanami generate", type: :integration do
+  describe "model" do
+    context "with model name" do
+      it_behaves_like "a new model" do
+        let(:input) { "user" }
+      end
+    end
+
+    context "with underscored name" do
+      it_behaves_like "a new model" do
+        let(:input) { "discounted_book" }
+      end
+    end
+
+    context "with dashed name" do
+      it_behaves_like "a new model" do
+        let(:input) { "user-event" }
+      end
+    end
+
+    context "with camel case name" do
+      it_behaves_like "a new model" do
+        let(:input) { "VerifiedUser" }
+      end
+    end
+
+    context "with missing argument" do
+      it "fails" do
+        with_project('bookshelf_generate_model_missing_arguments') do
+          output = <<-END
+ERROR: "hanami generate model" was called with no arguments
+Usage: "hanami generate model MODEL"
+END
+
+          run_cmd "hanami generate model", output, exit_status: 1
+        end
+      end
+    end
+
+    context "with missing migrations directory" do
+      it "will create directory and migration" do
+        with_project do
+          model_name = "book"
+          directory  = Pathname.new("db").join("migrations")
+          FileUtils.rm_rf(directory)
+
+          run_cmd "hanami generate model #{model_name}"
+          expect(directory).to be_directory
+
+          migration = directory.children.find do |m|
+            m.to_s.include?(model_name)
+          end
+
+          expect(migration).to_not be(nil)
+        end
+      end
+    end
+
+    context "with skip-migration" do
+      it "doesn't create a migration file" do
+        model_name = "user"
+        table_name = "users"
+        project = "bookshelf_generate_model_skip_migration"
+        with_project(project) do
+          run_cmd "hanami generate model #{model_name} --skip-migration"
+          #
+          # db/migrations/<timestamp>_create_<models>.rb
+          #
+          migrations = Pathname.new("db").join("migrations").children
+          file       = migrations.find do |child|
+            child.to_s.include?("create_#{table_name}")
+          end
+
+          expect(file).to be_nil, "Expected to not find a migration matching: create_#{table_name}. Found #{file&.to_s}"
+        end
+      end
+
+      it "doesn't create a migration file when --relation is used" do
+        model_name = "user"
+        table_name = "accounts"
+        project = "bookshelf_generate_model_skip_migration"
+        with_project(project) do
+          run_cmd "hanami generate model #{model_name} --skip-migration --relation=#{table_name}"
+          #
+          # db/migrations/<timestamp>_create_<models>.rb
+          #
+          migrations = Pathname.new("db").join("migrations").children
+          file       = migrations.find do |child|
+            child.to_s.include?("create_#{table_name}")
+          end
+
+          expect(file).to be_nil, "Expected to not find a migration matching: create_#{table_name}. Found #{file&.to_s}"
+        end
+      end
+    end
+
+    context "with relation option" do
+      let(:project)    { "generate_model_with_relation_name" }
+      let(:model_name) { "stimulus" }
+      let(:class_name) { "Stimulus" }
+      let(:relation_name) { "stimuli" }
+
+      it "creates correct entity, repository, and migration" do
+        with_project(project) do
+          output = [
+            "create  lib/#{project}/entities/#{model_name}.rb",
+            "create  lib/#{project}/repositories/#{model_name}_repository.rb",
+            /create  db\/migrations\/(\d+)_create_#{relation_name}.rb/
+          ]
+
+          run_cmd "hanami generate model #{model_name} --relation=#{relation_name}", output
+
+          expect("lib/#{project}/repositories/#{model_name}_repository.rb").to have_file_content <<~END
+            class #{class_name}Repository < Hanami::Repository
+              self.relation = :#{relation_name}
+            end
+          END
+
+          migration = Pathname.new("db").join("migrations").children.find do |child|
+            child.to_s.include?("create_#{relation_name}")
+          end
+
+          expect(migration.to_s).to have_file_content <<~END
+            Hanami::Model.migration do
+              change do
+                create_table :#{relation_name} do
+                  primary_key :id
+
+                  column :created_at, DateTime, null: false
+                  column :updated_at, DateTime, null: false
+                end
+              end
+            end
+          END
+        end
+      end
+
+      it "handles CamelCase arguments" do
+        with_project(project) do
+          model         = "sheep"
+          relation_name = "black_sheeps"
+          output = [
+            "create  lib/#{project}/entities/#{model}.rb",
+            "create  lib/#{project}/repositories/#{model}_repository.rb",
+            /create  db\/migrations\/(\d+)_create_#{relation_name}.rb/
+          ]
+
+          run_cmd "hanami generate model #{model} --relation=BlackSheeps", output
+
+          expect("lib/#{project}/repositories/sheep_repository.rb").to have_file_content <<~END
+            class SheepRepository < Hanami::Repository
+              self.relation = :#{relation_name}
+            end
+          END
+
+          migration = Pathname.new("db").join("migrations").children.find do |child|
+            child.to_s.include?("create_#{relation_name}")
+          end
+
+          expect(migration.to_s).to have_file_content <<~END
+            Hanami::Model.migration do
+              change do
+                create_table :#{relation_name} do
+                  primary_key :id
+
+                  column :created_at, DateTime, null: false
+                  column :updated_at, DateTime, null: false
+                end
+              end
+            end
+          END
+        end
+      end
+
+      it "returns error for blank option" do
+        with_project(project) do
+          run_cmd "hanami generate model #{model_name} --relation=", "`' is not a valid relation name", exit_status: 1
+        end
+      end
+    end
+
+    context "minitest" do
+      it "generates model" do
+        project = "bookshelf_generate_model_minitest"
+
+        with_project(project, test: :minitest) do
+          model      = "book"
+          class_name = Hanami::Utils::String.new(model).classify
+          output     = [
+            "create  spec/#{project}/entities/#{model}_spec.rb",
+            "create  spec/#{project}/repositories/#{model}_repository_spec.rb"
+          ]
+
+          run_cmd "hanami generate model #{model}", output
+
+          #
+          # spec/<project>/entities/<model>_spec.rb
+          #
+          expect("spec/#{project}/entities/#{model}_spec.rb").to have_file_content <<~END
+            require_relative '../../spec_helper'
+
+            describe #{class_name} do
+              # place your tests here
+            end
+          END
+
+          #
+          # spec/<project>/repositories/<model>_repository_spec.rb
+          #
+          expect("spec/#{project}/repositories/#{model}_repository_spec.rb").to have_file_content <<~END
+            require_relative '../../spec_helper'
+
+            describe #{class_name}Repository do
+              # place your tests here
+            end
+          END
+        end
+      end
+    end # minitest
+
+    context "rspec" do
+      it "generates model" do
+        project = "bookshelf_generate_model_rspec"
+
+        with_project(project, test: :rspec) do
+          model      = "book"
+          class_name = Hanami::Utils::String.new(model).classify
+          output     = [
+            "create  spec/#{project}/entities/#{model}_spec.rb",
+            "create  spec/#{project}/repositories/#{model}_repository_spec.rb"
+          ]
+
+          run_cmd "hanami generate model #{model}", output
+
+          #
+          # spec/<project>/entities/<model>_spec.rb
+          #
+          expect("spec/#{project}/entities/#{model}_spec.rb").to have_file_content <<~END
+            RSpec.describe #{class_name}, type: :entity do
+              # place your tests here
+            end
+          END
+
+          #
+          # spec/<project>/repositories/<model>_repository_spec.rb
+          #
+          expect("spec/#{project}/repositories/#{model}_repository_spec.rb").to have_file_content <<~END
+            RSpec.describe BookRepository, type: :repository do
+              # place your tests here
+            end
+          END
+        end
+      end
+    end # rspec
+
+    it "prints help message" do
+      with_project do
+        output = <<~OUT
+Command:
+  hanami generate model
+
+Usage:
+  hanami generate model MODEL
+
+Description:
+  Generate a model
+
+Arguments:
+  MODEL                             # REQUIRED Model name (eg. `user`)
+
+Options:
+  --[no-]skip-migration             # Skip migration, default: false
+  --relation=VALUE                  # Name of the database relation, default: pluralized model name
+  --help, -h                        # Print this help
+
+Examples:
+  hanami generate model user                     # Generate `User` entity, `UserRepository` repository, and the migration
+  hanami generate model user --skip-migration    # Generate `User` entity and `UserRepository` repository
+  hanami generate model user --relation=accounts # Generate `User` entity, `UserRepository` and migration to create `accounts` table
+OUT
+
+        run_cmd 'hanami generate model --help', output
+      end
+    end
+  end # model
+end

data/spec/integration/cli/generate/secret_spec.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+RSpec.describe "hanami generate", type: :integration do
+  describe "secret" do
+    context "without app name" do
+      it "prints secret" do
+        with_project do
+          generate "secret"
+
+          expect(out).to match(/[\w]{64}/)
+        end
+      end
+    end
+
+    context "with app name" do
+      it "prints secret" do
+        with_project do
+          generate "secret web"
+
+          expect(out).to match(%r{WEB_SESSIONS_SECRET="[\w]{64}"})
+        end
+      end
+    end
+
+    it 'prints help message' do
+      with_project do
+        banner = <<~OUT
+Command:
+  hanami generate secret
+
+Usage:
+  hanami generate secret [APP]
+
+Description:
+  Generate session secret
+
+Arguments:
+  APP                               # The app name (eg. `web`)
+
+Options:
+  --help, -h                        # Print this help
+
+Examples:
+OUT
+
+        output = [
+          banner,
+          # %r{  hanami generate secret     # Prints secret (eg. `[\w]{64}`)},
+          # %r{  hanami generate secret web # Prints session secret (eg. `WEB_SESSIONS_SECRET=[\w]{64}`)}
+        ]
+
+        run_cmd 'hanami generate secret --help', output
+      end
+    end
+  end # secret
+end

data/spec/integration/cli/generate_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+RSpec.describe "hanami generate", type: :integration do
+  it "prints subcommands" do
+    with_project do
+      output = <<~OUT
+        Commands:
+          hanami generate action APP ACTION                     # Generate an action for app
+          hanami generate app APP                               # Generate an app
+          hanami generate mailer MAILER                         # Generate a mailer
+          hanami generate migration MIGRATION                   # Generate a migration
+          hanami generate model MODEL                           # Generate a model
+          hanami generate secret [APP]                          # Generate session secret
+      OUT
+
+      run_cmd "hanami generate", output, exit_status: 1
+    end
+  end
+end