brut 0.17.0 → 0.18.1

data/lib/brut/cli/apps/db.rb

@@ -3,181 +3,137 @@ require "uri"
 require "date"
 require "brut/cli"
 
-class Brut::CLI::Apps::DB < Brut::CLI::App
-  description "Manage your database in development, test, and production"
+class Brut::CLI::Apps::DB < Brut::CLI::Commands::BaseCommand
+  def description = "Manage your database in development, test, and production"
+  def name = "db"
 
-  class Seed < Brut::CLI::Command
-    description "Load seed data into the database"
-    requires_project_env default: "development"
+  def default_command_class = Status
 
-    def handle_bootstrap_exception(ex)
-      case ex
-      when Sequel::DatabaseConnectionError
-        abort_execution("Database needs to be created")
-      when Sequel::DatabaseError
-        if ex.cause.kind_of?(PG::UndefinedTable)
-          abort_execution("Migrations need to be run")
-        else
-          super
-        end
-      else
-        super
-      end
-    end
+  class Status < Brut::CLI::Commands::BaseCommand
+    def description = "Check the status of the database and migrations"
+    def default_rack_env = "development"
+    def bootstrap? = false
 
-    def execute
-      seeds_dir = Brut.container.db_seeds_dir
-      Dir["#{seeds_dir}/*.rb"].each do |file|
-        require file
+    def run
+      database_name = URI(Brut.container.database_url).path.gsub(/^\//,"")
+      connection = Brut.container.sequel_db_handle
+      stdout.puts "Database server is up"
+      stdout.puts "Database #{database_name} exists"
+      migrations_run = if connection.table_exists?("schema_migrations")
+                         connection["select filename from schema_migrations order by filename"].all.map { |_| _[:filename] }
+                       else
+                         []
+                       end
+      migration_files = Dir[Brut.container.migrations_dir / "*.rb"].map { |file|
+        filename = Pathname(file).basename.to_s
+      }
+      if migration_files.empty? && migrations_run.empty?
+        stdout.puts("✅ NO MIGRATION FILES TO RUN")
+      else
+        max_length = migration_files.map(&:length).max
+        printf_string = "%-#{max_length}s - %s\n"
+        migration_files.each do |filename|
+          applied = migrations_run.include?(filename)
+          stdout.printf(printf_string,filename,applied ? "✅ APPLIED" : "❌ NOT APPLIED")
+        end
       end
-      seed_data = Brut::BackEnd::SeedData.new
-      seed_data.setup!
-      seed_data.load_seeds!
       0
-    rescue Sequel::UniqueConstraintViolation => ex
-      raise "Seed data may have already been loaded: #{ex}"
-    end
-  end
-
-  class Rebuild < Brut::CLI::Command
-    description "Drop, re-create, and run migrations, effecitvely rebuilding the entire database"
-
-    requires_project_env default: "development"
-
-    def handle_bootstrap_exception(ex)
-      case ex
-      when Sequel::DatabaseConnectionError
-        continue_execution
-      when Sequel::DatabaseError
-        if ex.cause.kind_of?(PG::UndefinedTable)
-          continue_execution
-        else
-          super
-        end
-      else
-        super
+    rescue Sequel::DatabaseConnectionError => ex
+      uri_no_database = URI(Brut.container.database_url.to_s)
+      database_name = uri_no_database.path.gsub(/^\//,"")
+      uri_no_database.path = ""
+      begin
+        connection = Sequel.connect(uri_no_database.to_s)
+        stdout.puts "Database server is up"
+        stdout.puts "Database #{database_name} does not exist - run `brut db create` to create it"
+        0
+      rescue => ex2
+        stderr.puts "Database server is not running at #{uri_no_database}: #{ex2.message}"
+        stderr.puts "This could be a problem with your dev environment generally, or your .env.test or .env.test.local files"
+        1
       end
     end
-
-    def execute
-      delegate_to_commands(Drop, Create, Migrate)
-    end
   end
 
-  class Create < Brut::CLI::Command
-    description "Create the database if it does not exist"
-    requires_project_env default: "development"
+  class Create < Brut::CLI::Commands::BaseCommand
+    def description = "Create the database if it does not exist"
+    def default_rack_env = "development"
+    def bootstrap? = false
 
-    def handle_bootstrap_exception(ex)
-      case ex
-      when Sequel::DatabaseConnectionError
-        uri_no_database = URI(Brut.container.database_url.to_s)
-        database_name = uri_no_database.path.gsub(/^\//,"")
-        uri_no_database.path = ""
-        begin
-          connection = Sequel.connect(uri_no_database.to_s)
-          out.puts "#{database_name} does not exit. Creating..."
-          connection.run("CREATE DATABASE \"#{database_name}\"")
-          connection.disconnect
-        rescue => ex
-          err.puts ex.message
-        end
-        stop_execution
-      when Sequel::DatabaseError
-        if ex.cause.kind_of?(PG::UndefinedTable)
-          out.puts ex.message
-          out.puts "Migrations need to be run"
-          continue_execution
-        else
-          super
-        end
-      else
-        super
-      end
-    end
-    def execute
+    def run
       connection = Sequel.connect(Brut.container.database_url)
-      out.puts "Database already exists"
+      stdout.puts "Database already exists"
       connection.disconnect
       0
-    rescue => ex
-      handle_bootstrap_exception(ex)
+    rescue Sequel::DatabaseConnectionError => ex
+      uri_no_database = URI(Brut.container.database_url.to_s)
+      database_name = uri_no_database.path.gsub(/^\//,"")
+      uri_no_database.path = ""
+      begin
+        connection = Sequel.connect(uri_no_database.to_s)
+        stdout.puts "Database #{database_name} does not exist. Creating..."
+        connection.run("CREATE DATABASE \"#{database_name}\"")
+        connection.disconnect
+        0
+      rescue Sequel::DatabaseConnectionError => ex2
+        stderr.puts "Database server is not running at #{uri_no_database}: #{ex2.message}"
+        stderr.puts "This could be a problem with your dev environment generally, or your .env.test or .env.test.local files"
+        1
+      end
     end
   end
 
-  class Drop < Brut::CLI::Command
-    description "Drop the database if it exists"
-    requires_project_env default: "development"
-
-    def handle_bootstrap_exception(ex)
-      case ex
-      when Sequel::DatabaseConnectionError
-        out.puts "Database does not exist"
-        stop_execution
-      when Sequel::DatabaseError
-        if ex.cause.kind_of?(PG::UndefinedTable)
-          continue_execution
-        else
-          super
-        end
-      else
-        super
-      end
-    end
+  class Drop < Brut::CLI::Commands::BaseCommand
+    def description = "Drop the database if it exists"
+    def default_rack_env = "development"
+    def bootstrap? = false
 
-    def execute
+    def run
       uri_no_database = URI(Brut.container.database_url.to_s)
       database_name = uri_no_database.path.gsub(/^\//,"")
       uri_no_database.path = ""
-      out.puts "Database exists. Dropping..."
       begin
         Brut.container.sequel_db_handle.disconnect
-      rescue Sequel::DatabaseConnectionError
+        stdout.puts "Database #{database_name} exists. Dropping..."
+        connection = Sequel.connect(uri_no_database.to_s)
+        connection.run("DROP DATABASE IF EXISTS \"#{database_name}\"")
+        connection.disconnect
+        0
+      rescue Sequel::DatabaseConnectionError => ex
+        begin
+          connection = Sequel.connect(uri_no_database.to_s)
+          stdout.puts "Database #{database_name} does not exist"
+          connection.disconnect
+          0
+        rescue Sequel::DatabaseConnectionError => ex2
+          stderr.puts "Database server is not running at #{uri_no_database}: #{ex2.message}"
+          stderr.puts "This could be a problem with your dev environment generally, or your .env.test or .env.test.local files"
+          1
+        end
       end
-      connection = Sequel.connect(uri_no_database.to_s)
-      connection.run("DROP DATABASE IF EXISTS \"#{database_name}\"")
-      connection.disconnect
-      0
-    rescue => ex
-      handle_bootstrap_exception(ex)
     end
   end
 
-  class Migrate < Brut::CLI::Command
-    description "Apply any outstanding migrations to the database"
-    requires_project_env default: "development"
-
-    def handle_bootstrap_exception(ex)
-      case ex
-      when Sequel::DatabaseConnectionError
-        abort_execution("Database does not exist. Create it first")
-      when Sequel::DatabaseError
-        if ex.cause.kind_of?(PG::UndefinedTable)
-          # ignoring - we are running migrations which will address this
-          continue_execution
-        else
-          super
-        end
-      else
-        super
-      end
-    end
+  class Migrate < Brut::CLI::Commands::BaseCommand
+    def description = "Apply any outstanding migrations to the database"
+    def default_rack_env = "development"
 
-    def execute
-      Sequel.extension :migration
-      Brut.container.sequel_db_handle.extension :brut_migrations
+    def run
       migrations_dir = Brut.container.migrations_dir
       if !migrations_dir.exist?
-        err.puts "#{migrations_dir} doesn't exist"
-        return
+        stdout.puts "No migrations to run from #{migrations_dir}"
+        return 0
       elsif Dir[migrations_dir / "*.rb"].empty?
-        out.puts "No migrations yet"
-        return
+        stdout.puts "No migrations to run from #{migrations_dir}"
+        return 0
       end
+
+      Sequel.extension :migration
+      Brut.container.sequel_db_handle.extension :brut_migrations
       Brut.container.sequel_db_handle.extension :pg_array
 
       logger = Logger.new(STDOUT)
-      logger.level = ENV["LOG_LEVEL"]
+      logger.level = self.options.log_level
       indent = ""
       logger.formatter = proc { |severity,time,progname,message|
         formatted = "#{indent} - #{message}\n"
@@ -190,27 +146,86 @@ class Brut::CLI::Apps::DB < Brut::CLI::App
         formatted
       }
       Brut.container.sequel_db_handle.logger = logger
-      Brut.container.instrumentation.span("migrations.run") do
-        Sequel::Migrator.run(Brut.container.sequel_db_handle,migrations_dir)
+      Sequel::Migrator.run(Brut.container.sequel_db_handle,migrations_dir)
+      stdout.puts "All migrations have been applied"
+      0
+    rescue Sequel::DatabaseConnectionError => ex
+      stderr.puts "Database #{Brut.container.database_url} does not exist. Create it first with `brut db create`"
+      1
+    rescue Sequel::DatabaseError => ex
+      #if ex.cause.kind_of?(PG::UndefinedTable)
+      #  # ignoring - we are running migrations which will address this
+      #  0
+      #else
+        raise ex
+      #end
+    end
+  end
+
+  class Rebuild < Brut::CLI::Commands::CompoundCommand
+    def description = "Drop, re-create, and run migrations, effecitvely rebuilding the entire database"
+    def default_rack_env = "development"
+    def bootstrap? = false
+    def initialize
+      super([
+        Drop.new,
+        Create.new,
+        Migrate.new,
+      ])
+    end
+  end
+
+
+  class Seed < Brut::CLI::Commands::BaseCommand
+    def description = "Load seed data into the database"
+    def default_rack_env = "development"
+    def bootstrap? = true
+
+    def run
+      seeds_dir = Brut.container.db_seeds_dir
+      Dir["#{seeds_dir}/*.rb"].each do |file|
+        require file
+      end
+      seed_data = Brut::BackEnd::SeedData.new
+      seed_data.setup!
+      seed_data.load_seeds!
+      0
+    rescue Sequel::DatabaseConnectionError => ex
+      stderr.puts "Database doesn't exist. Create it with `brut db create`"
+      1
+    rescue Sequel::UniqueConstraintViolation => ex
+      stderr.puts "Seed data may have already been loaded: #{ex}. You can re-load it using `brut db rebuild`, then `brut db seed`"
+      1
+    rescue Sequel::DatabaseError => ex
+      if ex.cause.kind_of?(PG::UndefinedTable)
+        stderr.puts "Migrations need to be run. Use `brut db migrate` to run them"
+        1
+      else
+        raise ex
       end
-      out.puts "Migrations applied"
     end
   end
 
-  class NewMigration < Brut::CLI::Command
-    description "Create a new migration file"
-    args "migration_name"
+  class NewMigration < Brut::CLI::Commands::BaseCommand
+    def description = "Create a new migration file"
+    def args_description = "migration_name"
+    def bootstrap? = false
 
     def before_execute
       ENV["RACK_ENV"] = "development"
     end
 
-    def execute
-      if @args.length == 0
-        return abort_execution("You must provide a name for the migration")
+    def run
+      if argv.length == 0
+        stderr.puts "You must provide a name for the migration"
+        return 1
+      end
+      if env["RACK_ENV"] != "development"
+        stderr.puts "This only works in the development environment, not #{env["RACK_ENV"]}"
+        return 1
       end
       migrations_dir = Brut.container.migrations_dir
-      name = @args.join(" ").gsub(/[^\w\d\-]/,"-")
+      name = argv.join(" ").gsub(/[^\w\d\-]/,"-")
       date = DateTime.now.strftime("%Y%m%d%H%M%S")
       file_name = migrations_dir / "#{date}_#{name}.rb"
       File.open(file_name,"w") do |file|
@@ -222,58 +237,9 @@ class Brut::CLI::Apps::DB < Brut::CLI::App
         file.puts "end"
       end
       relative_path = file_name.relative_path_from(Brut.container.project_root)
-      out.puts "Migration created:\n    #{relative_path}"
-    end
-  end
-
-  class Status < Brut::CLI::Command
-    description "Check the status of the database and migrations"
-    requires_project_env default: "development"
-
-    def handle_bootstrap_exception(ex)
-      case ex
-      when Sequel::DatabaseConnectionError
-        uri_no_database = URI(Brut.container.database_url.to_s)
-        database_name = uri_no_database.path.gsub(/^\//,"")
-        uri_no_database.path = ""
-        begin
-          connection = Sequel.connect(uri_no_database.to_s)
-          out.puts "Database Server is Up"
-          out.puts "Database #{database_name} does not exist"
-        rescue => ex
-          err.puts ex.message
-        end
-        stop_execution
-      when Sequel::DatabaseError
-        if ex.cause.kind_of?(PG::UndefinedTable)
-          err.puts "Migrations need to be run"
-          continue_execution
-        else
-          super
-        end
-      end
-    end
-
-    def execute
-      database_name = URI(Brut.container.database_url).path
-      connection = Brut.container.sequel_db_handle
-      out.puts "Database Server is Up"
-      out.puts "Database #{database_name} exists"
-      migrations_run = if connection.table_exists?("schema_migrations")
-                         connection["select filename from schema_migrations order by filename"].all.map { |_| _[:filename] }
-                       else
-                         []
-                       end
-      migration_files = Dir[Brut.container.migrations_dir / "*.rb"].map { |file|
-        filename = Pathname(file).basename.to_s
-      }
-      max_length = migration_files.map(&:length).max
-      printf_string = "%-#{max_length}s - %s\n"
-      migration_files.each do |filename|
-        applied = migrations_run.include?(filename)
-        printf(printf_string,filename,applied ? "✅ APPLIED" : "❌ NOT APPLIED")
-      end
+      stdout.puts "Migration created:\n    #{relative_path}"
       0
     end
   end
+
 end