hanami 2.0.0.alpha8 → 2.0.0.beta1

data/spec/integration/cli/console_spec.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+RSpec.describe "hanami console", type: :integration do
+  context "irb" do
+    it "starts console" do
+      project_name = "bookshelf_console_irb"
+      with_project(project_name, console: :irb) do
+        setup_model
+
+        console do |input, _, _|
+          input.puts("Hanami::VERSION")
+          input.puts("Web::App")
+          input.puts("Web.routes")
+          input.puts("BookRepository.new.all.to_a")
+          input.puts("exit")
+        end
+
+        expect(out).to include(Hanami::VERSION)
+        expect(out).to include("Web::App")
+        expect(out).to include("#<Hanami::Routes")
+        expect(out).to include("[]")
+        expect(out).to include("[#{project_name}] [INFO]")
+        expect(out).to include("SELECT `id`, `title` FROM `books` ORDER BY `books`.`id`")
+      end
+    end
+
+    it "starts console with --engine option" do
+      with_project("bookshelf_console_irb", console: :irb) do
+        console(" --engine=irb") do |input, _, _|
+          input.puts("Hanami::VERSION")
+          input.puts("exit")
+        end
+
+        expect(out).to include(Hanami::VERSION)
+      end
+    end
+
+    it "starts console without hanami-model" do
+      project_without_hanami_model("bookshelf", gems: ["dry-struct"], console: :irb) do
+        write "lib/entities/access_token.rb", <<~EOF
+          require 'dry-struct'
+          require 'securerandom'
+
+          module Types
+            include Dry::Types.module
+          end
+
+          class AccessToken < Dry::Struct
+            attribute :id,     Types::String.default { SecureRandom.uuid }
+            attribute :secret, Types::String
+            attribute :digest, Types::String
+          end
+        EOF
+        console do |input, _, _|
+          input.puts("AccessToken.new(id: '1', secret: 'shh', digest: 'def')")
+          input.puts("exit")
+        end
+
+        expect(out).to include('#<AccessToken id="1" secret="shh" digest="def">')
+      end
+    end
+  end # irb
+
+  xit "returns error when known engine isn't bundled" do
+    with_project("bookshelf_console_irb", console: :irb) do
+      output = "Missing gem for `pry' console engine. Please make sure to add it to `Gemfile'."
+      run_cmd "hanami console --engine=pry", output, exit_status: 1
+    end
+  end
+
+  it "returns error when unknown engine is requested" do
+    with_project("bookshelf_console_irb", console: :irb) do
+      output = "Unknown console engine: `foo'."
+      run_cmd "hanami console --engine=foo", output, exit_status: 1
+    end
+  end
+
+  it "prints help message" do
+    with_project do
+      output = <<~OUT
+Command:
+  hanami console
+
+Usage:
+  hanami console
+
+Description:
+  Starts Hanami console
+
+Options:
+  --engine=VALUE                    # Force a specific console engine: (pry/ripl/irb)
+  --help, -h                        # Print this help
+
+Examples:
+  hanami console              # Uses the bundled engine
+  hanami console --engine=pry # Force to use Pry
+OUT
+
+      run_cmd "hanami console --help", output
+    end
+  end
+
+  # TODO: test with pry
+  # TODO: test with ripl
+end

data/spec/integration/cli/db/apply_spec.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+RSpec.describe "hanami db", type: :integration do
+  describe "apply" do
+    it "migrates, dumps structure, deletes migrations", if: RUBY_VERSION < '2.4' do
+      with_project do
+        versions = generate_migrations
+
+        hanami "db apply"
+
+        hanami "db version"
+        expect(out).to include(versions.last.to_s)
+
+        db         = Pathname.new("db")
+        schema     = db.join("schema.sql").to_s
+        migrations = db.join("migrations")
+
+        expect(schema).to have_file_content <<~SQL
+          CREATE TABLE `schema_migrations` (`filename` varchar(255) NOT NULL PRIMARY KEY);
+          CREATE TABLE `users` (`id` integer NOT NULL PRIMARY KEY AUTOINCREMENT, `name` varchar(255), `age` integer);
+          INSERT INTO "schema_migrations" VALUES('#{versions.first}_create_users.rb');
+          INSERT INTO "schema_migrations" VALUES('#{versions.last}_add_age_to_users.rb');
+        SQL
+
+        expect(migrations.children).to be_empty
+      end
+    end
+
+    it "migrates, dumps structure, deletes migrations", if: RUBY_VERSION >= '2.4' do
+      with_project do
+        versions = generate_migrations
+
+        hanami "db apply"
+
+        hanami "db version"
+        expect(out).to include(versions.last.to_s)
+
+        db         = Pathname.new('db')
+        schema     = db.join('schema.sql').to_s
+        migrations = db.join('migrations')
+
+        expect(schema).to have_file_content <<-SQL
+CREATE TABLE `schema_migrations` (`filename` varchar(255) NOT NULL PRIMARY KEY);
+CREATE TABLE `users` (`id` integer NOT NULL PRIMARY KEY AUTOINCREMENT, `name` varchar(255), `age` integer);
+CREATE TABLE sqlite_sequence(name,seq);
+INSERT INTO schema_migrations VALUES('#{versions.first}_create_users.rb');
+INSERT INTO schema_migrations VALUES('#{versions.last}_add_age_to_users.rb');
+SQL
+
+        expect(migrations.children).to be_empty
+      end
+    end
+
+    it "prints help message" do
+      with_project do
+        output = <<~OUT
+Command:
+  hanami db apply
+
+Usage:
+  hanami db apply
+
+Description:
+  Migrate, dump the SQL schema, and delete the migrations (experimental)
+
+Options:
+  --help, -h                        # Print this help
+OUT
+
+        run_cmd "hanami db apply --help", output
+      end
+    end
+  end
+end

data/spec/integration/cli/db/console_spec.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+RSpec.describe "hanami db", type: :integration do
+  describe "console" do
+    it "starts database console" do
+      with_project do
+        generate_migrations
+        hanami "db prepare"
+
+        db_console do |input, _, _|
+          input.puts('INSERT INTO users (id, name, age) VALUES(1, "Luca", 34);')
+          input.puts("SELECT * FROM users;")
+          input.puts(".quit")
+        end
+
+        expect(out).to include("1|Luca|34")
+      end
+    end
+
+    it "prints help message" do
+      with_project do
+        output = <<~OUT
+Command:
+  hanami db console
+
+Usage:
+  hanami db console
+
+Description:
+  Starts a database console
+
+Options:
+  --help, -h                        # Print this help
+OUT
+
+        run_cmd "hanami db console --help", output
+      end
+    end
+  end
+end

data/spec/integration/cli/db/create_spec.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+RSpec.describe "hanami db", type: :integration do
+  describe "create" do
+    it "creates database" do
+      project = "bookshelf_db_create"
+
+      with_project(project) do
+        hanami "db create"
+
+        db = Pathname.new("db").join("#{project}_development.sqlite").to_s
+        expect(db).to be_an_existing_file
+      end
+    end
+
+    it "doesn't create in production" do
+      project = "bookshelf_db_create_production"
+
+      with_project(project) do
+        RSpec::Support::Env["HANAMI_ENV"] = "production"
+        hanami "db create"
+
+        expect(exitstatus).to eq(1)
+
+        db = Pathname.new("db").join("#{project}.sqlite").to_s
+        expect(db).to_not be_an_existing_file
+      end
+    end
+
+    it "prints help message" do
+      with_project do
+        output = <<~OUT
+Command:
+  hanami db create
+
+Usage:
+  hanami db create
+
+Description:
+  Create the database (only for development/test)
+
+Options:
+  --help, -h                        # Print this help
+OUT
+
+        run_cmd 'hanami db create --help', output
+      end
+    end
+  end
+end

data/spec/integration/cli/db/drop_spec.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+RSpec.describe "hanami db", type: :integration do
+  describe "drop" do
+    it "drops database" do
+      project = "bookshelf_db_drop"
+
+      with_project(project) do
+        db = Pathname.new("db").join("#{project}_development.sqlite").to_s
+
+        hanami "db create"
+        expect(db).to be_an_existing_file
+
+        hanami "db drop"
+        expect(db).to_not be_an_existing_file
+      end
+    end
+
+    it "doesn't drop in production" do
+      project = "bookshelf_db_drop_production"
+
+      with_project(project) do
+        RSpec::Support::Env["HANAMI_ENV"] = "production"
+        db = Pathname.new("db").join("#{project}.sqlite").to_s
+        FileUtils.touch(db) # simulate existing database
+
+        hanami "db drop"
+
+        expect(exitstatus).to eq(1)
+        expect(db).to be_an_existing_file
+      end
+    end
+
+    it "prints help message" do
+      with_project do
+        output = <<~OUT
+Command:
+  hanami db drop
+
+Usage:
+  hanami db drop
+
+Description:
+  Drop the database (only for development/test)
+
+Options:
+  --help, -h                        # Print this help
+OUT
+
+        run_cmd 'hanami db drop --help', output
+      end
+    end
+  end
+end

data/spec/integration/cli/db/migrate_spec.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+RSpec.describe "hanami db", type: :integration do
+  describe "migrate" do
+    it "migrates database" do
+      project = "bookshelf_db_migrate"
+
+      with_project(project) do
+        generate_migrations
+
+        hanami "db create"
+        hanami "db migrate"
+
+        db = Pathname.new("db").join("#{project}_development.sqlite")
+
+        users = `sqlite3 #{db} ".schema users"`
+        expect(users).to include("CREATE TABLE `users` (`id` integer NOT NULL PRIMARY KEY AUTOINCREMENT, `name` varchar(255), `age` integer);")
+
+        version = `sqlite3 #{db} "SELECT filename FROM schema_migrations ORDER BY filename DESC LIMIT 1"`
+        expect(version).to include("add_age_to_users")
+      end
+    end
+
+    it "migrates database up to a version" do
+      project = "bookshelf_db_migrate_up_to_version"
+
+      with_project(project) do
+        versions = generate_migrations
+
+        hanami "db create"
+        hanami "db migrate #{versions.first}"
+
+        db = Pathname.new("db").join("#{project}_development.sqlite")
+
+        users = `sqlite3 #{db} ".schema users"`
+        expect(users).to include("CREATE TABLE `users` (`id` integer NOT NULL PRIMARY KEY AUTOINCREMENT, `name` varchar(255));")
+
+        version = `sqlite3 #{db} "SELECT filename FROM schema_migrations ORDER BY filename DESC LIMIT 1"`
+        expect(version).to include("create_users")
+      end
+    end
+
+    it "migrates database down to a version" do
+      project = "bookshelf_db_migrate_down_to_version"
+
+      with_project(project) do
+        versions = generate_migrations
+
+        hanami "db create"
+        hanami "db migrate" # up to latest version
+        hanami "db migrate #{versions.first}"
+
+        db = Pathname.new("db").join("#{project}_development.sqlite")
+
+        users = `sqlite3 #{db} ".schema users"`
+        expect(users).to include("CREATE TABLE `users`(`id` integer DEFAULT (NULL) NOT NULL PRIMARY KEY AUTOINCREMENT, `name` varchar(255) DEFAULT (NULL) NULL);")
+
+        version = `sqlite3 #{db} "SELECT filename FROM schema_migrations ORDER BY filename DESC LIMIT 1"`
+        expect(version).to include("create_users")
+      end
+    end
+
+    it "migrates database down to 0" do
+      project = "bookshelf_db_migrate_down_to_zero"
+
+      with_project(project) do
+        generate_migrations
+
+        hanami "db create"
+        hanami "db migrate" # up to latest version
+        hanami "db migrate 0"
+
+        db = Pathname.new("db").join("#{project}_development.sqlite")
+
+        users = `sqlite3 #{db} ".schema users"`
+        expect(users).to eq("")
+
+        version = `sqlite3 #{db} "SELECT filename FROM schema_migrations ORDER BY filename DESC LIMIT 1"`
+        expect(version).to eq("")
+      end
+    end
+
+    it "prints help message" do
+      with_project do
+        banner = <<~OUT
+Command:
+  hanami db drop
+
+Usage:
+  hanami db drop
+
+Description:
+  Drop the database (only for development/test)
+
+Options:
+  --help, -h                        # Print this help
+OUT
+
+        output = [
+          banner,
+          # %r{  hanami db migrate [\d]{14} # Migrate to a specific version}
+        ]
+
+        run_cmd 'hanami db drop --help', output
+      end
+    end
+  end
+end

data/spec/integration/cli/db/prepare_spec.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+RSpec.describe "hanami db", type: :integration do
+  describe "prepare" do
+    it "prepares database" do
+      with_project do
+        versions = generate_migrations
+
+        hanami "db prepare"
+        hanami "db version"
+
+        expect(out).to include(versions.last.to_s)
+      end
+    end
+
+    it "prints help message" do
+      with_project do
+        output = <<~OUT
+Command:
+  hanami db prepare
+
+Usage:
+  hanami db prepare
+
+Description:
+  Drop, create, and migrate the database (only for development/test)
+
+Options:
+  --help, -h                        # Print this help
+OUT
+
+        run_cmd 'hanami db prepare --help', output
+      end
+    end
+  end
+end

data/spec/integration/cli/db/rollback_spec.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+RSpec.describe "hanami db", type: :integration do
+  describe "rollback" do
+    it "rollbacks database" do
+      project = "bookshelf_db_rollback"
+
+      with_project(project) do
+        generate_migrations
+
+        hanami "db create"
+        hanami "db migrate"
+        hanami "db rollback"
+
+        db = Pathname.new("db").join("#{project}_development.sqlite")
+
+        users = `sqlite3 #{db} ".schema users"`
+        expect(users).to include("CREATE TABLE `users`(`id` integer DEFAULT (NULL) NOT NULL PRIMARY KEY AUTOINCREMENT, `name` varchar(255) DEFAULT (NULL) NULL);")
+
+        version = `sqlite3 #{db} "SELECT filename FROM schema_migrations ORDER BY filename DESC LIMIT 1"`
+        expect(version).to_not include("add_age_to_users")
+      end
+    end
+
+    it "rollbacks database using custom steps" do
+      project = "bookshelf_db_migrate_custom_steps"
+
+      with_project(project) do
+        generate_migrations
+
+        hanami "db create"
+        hanami "db migrate"
+        hanami "db rollback 2"
+
+        db = Pathname.new("db").join("#{project}_development.sqlite")
+
+        users = `sqlite3 #{db} ".schema users"`
+        expect(users).to_not include("CREATE TABLE `users`(`id` integer DEFAULT (NULL) NOT NULL PRIMARY KEY AUTOINCREMENT, `name` varchar(255) DEFAULT (NULL) NULL);")
+
+        version = `sqlite3 #{db} "SELECT filename FROM schema_migrations ORDER BY filename DESC LIMIT 1"`
+        expect(version).to_not include("create_users")
+      end
+    end
+
+    it "returns an error when steps isn't an integer" do
+      with_project do
+        generate_migrations
+
+        hanami "db create"
+        hanami "db migrate"
+
+        output = "the number of steps must be a positive integer (you entered `quindici')."
+        run_cmd "hanami db rollback quindici", output, exit_status: 1
+      end
+    end
+
+    it "returns an error when steps is 0" do
+      with_project do
+        generate_migrations
+
+        hanami "db create"
+        hanami "db migrate"
+
+        output = "the number of steps must be a positive integer (you entered `0')."
+        run_cmd "hanami db rollback 0", output, exit_status: 1
+      end
+    end
+
+    it "prints help message" do
+      with_project do
+        output = <<~OUT
+Command:
+  hanami db rollback
+
+Usage:
+  hanami db rollback [STEPS]
+
+Description:
+  Rollback migrations
+
+Arguments:
+  STEPS                             # Number of steps to rollback the database
+
+Options:
+  --help, -h                        # Print this help
+
+Examples:
+  hanami db rollback   # Rollbacks latest migration
+  hanami db rollback 2 # Rollbacks last two migration
+OUT
+
+        run_cmd 'hanami db rollback --help', output
+      end
+    end
+  end
+end

data/spec/integration/cli/db/version_spec.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+RSpec.describe "hanami db", type: :integration do
+  describe "version" do
+    it "prints database version" do
+      with_project do
+        versions = generate_migrations
+
+        hanami "db create"
+        hanami "db migrate"
+        hanami "db version"
+
+        expect(out).to     include(versions.last.to_s)
+        expect(out).to_not include("SELECT * FROM")
+      end
+    end
+
+    it "prints help message" do
+      with_project do
+        output = <<~OUT
+Command:
+  hanami db version
+
+Usage:
+  hanami db version
+
+Description:
+  Print the current migrated version
+
+Options:
+  --help, -h                        # Print this help
+OUT
+
+        run_cmd 'hanami db version --help', output
+      end
+    end
+  end
+end

data/spec/integration/cli/db_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+RSpec.describe "hanami db", type: :integration do
+  it "prints subcommands" do
+    with_project do
+      output = <<~OUT
+        Commands:
+          hanami db apply                           # Migrate, dump the SQL schema, and delete the migrations (experimental)
+          hanami db console                         # Starts a database console
+          hanami db create                          # Create the database (only for development/test)
+          hanami db drop                            # Drop the database (only for development/test)
+          hanami db migrate [VERSION]               # Migrate the database
+          hanami db prepare                         # Drop, create, and migrate the database (only for development/test)
+          hanami db rollback [STEPS]                # Rollback migrations
+          hanami db version                         # Print the current migrated version
+      OUT
+
+      run_cmd "hanami db", output, exit_status: 1
+    end
+  end
+end