declare_schema 0.9.0 → 0.11.1

data/lib/declare_schema/schema_change/column_change.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module DeclareSchema
+  module SchemaChange
+    class ColumnChange < Base
+      def initialize(table_name, column_name, old_type:, old_options:, new_type:, new_options:)
+        @table_name = table_name
+        @column_name = column_name
+        @old_type = old_type
+        @old_options = old_options
+        @new_type = new_type
+        @new_options = new_options
+      end
+
+      def up_command
+        "change_column #{[@table_name.to_sym.inspect,
+                          @column_name.to_sym.inspect,
+                          @new_type.to_sym.inspect,
+                          *self.class.format_options(@new_options)].join(", ")}"
+      end
+
+      def down_command
+        "change_column #{[@table_name.to_sym.inspect,
+                          @column_name.to_sym.inspect,
+                          @old_type.to_sym.inspect,
+                          *self.class.format_options(@old_options)].join(", ")}"
+      end
+    end
+  end
+end

data/lib/declare_schema/schema_change/column_remove.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative 'column_add'
+
+module DeclareSchema
+  module SchemaChange
+    class ColumnRemove < ColumnAdd
+      alias column_add_up_command up_command
+      alias column_add_down_command down_command
+
+      def up_command
+        column_add_down_command
+      end
+
+      def down_command
+        column_add_up_command
+      end
+    end
+  end
+end

data/lib/declare_schema/schema_change/column_rename.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module DeclareSchema
+  module SchemaChange
+    class ColumnRename < Base
+      def initialize(table_name, old_name, new_name)
+        @table_name = table_name
+        @old_name = old_name
+        @new_name = new_name
+      end
+
+      def up_command
+        "rename_column #{@table_name.to_sym.inspect}, #{@old_name.to_sym.inspect}, #{@new_name.to_sym.inspect}"
+      end
+
+      def down_command
+        "rename_column #{@table_name.to_sym.inspect}, #{@new_name.to_sym.inspect}, #{@old_name.to_sym.inspect}"
+      end
+    end
+  end
+end

data/lib/declare_schema/schema_change/foreign_key_add.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module DeclareSchema
+  module SchemaChange
+    class ForeignKeyAdd < Base
+      def initialize(table_name, parent_table_name, column_name:, name:)
+        @table_name = table_name
+        @parent_table_name = parent_table_name
+        @column_name = column_name
+        @name = name
+      end
+
+      def up_command
+        "add_foreign_key #{@table_name.to_sym.inspect}, #{@parent_table_name.to_sym.inspect}, " +
+          "column: #{@column_name.to_sym.inspect}, name: #{@name.to_sym.inspect}"
+      end
+
+      def down_command
+        "remove_foreign_key #{@table_name.to_sym.inspect}, name: #{@name.to_sym.inspect}"
+      end
+    end
+  end
+end

data/lib/declare_schema/schema_change/foreign_key_remove.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative 'foreign_key_add'
+
+module DeclareSchema
+  module SchemaChange
+    class ForeignKeyRemove < ForeignKeyAdd
+      alias index_add_up_command up_command
+      alias index_add_down_command down_command
+
+      def up_command
+        index_add_down_command
+      end
+
+      def down_command
+        index_add_up_command
+      end
+    end
+  end
+end

data/lib/declare_schema/schema_change/index_add.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module DeclareSchema
+  module SchemaChange
+    class IndexAdd < Base
+      def initialize(table_name, column_names, name:, unique:, where: nil)
+        @table_name = table_name
+        @column_names = column_names
+        @name = name
+        @unique = unique
+        @where = where.presence
+      end
+
+      def up_command
+        options = {
+          name: @name.to_sym,
+        }
+        options[:unique] = true if @unique
+        options[:where] = @where if @where
+
+        "add_index #{[@table_name.to_sym.inspect,
+                      @column_names.map(&:to_sym).inspect,
+                      *self.class.format_options(options)].join(', ')}"
+      end
+
+      def down_command
+        "remove_index #{@table_name.to_sym.inspect}, name: #{@name.to_sym.inspect}"
+      end
+    end
+  end
+end

data/lib/declare_schema/schema_change/index_remove.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative 'index_add'
+
+module DeclareSchema
+  module SchemaChange
+    class IndexRemove < IndexAdd
+      alias index_add_up_command up_command
+      alias index_add_down_command down_command
+
+      def up_command
+        index_add_down_command
+      end
+
+      def down_command
+        index_add_up_command
+      end
+    end
+  end
+end

data/lib/declare_schema/schema_change/primary_key_change.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module DeclareSchema
+  module SchemaChange
+    class PrimaryKeyChange < Base
+      def initialize(table_name, old_column_names, new_column_names)
+        @table_name = table_name
+        @old_column_names = old_column_names.presence
+        @new_column_names = new_column_names.presence
+      end
+
+      def up_command
+        alter_primary_key(@old_column_names, @new_column_names)
+      end
+
+      def down_command
+        alter_primary_key(@new_column_names, @old_column_names)
+      end
+
+      private
+
+      def alter_primary_key(old_col_names, new_col_names)
+        drop_command = "DROP PRIMARY KEY" if old_col_names
+        add_command = "ADD PRIMARY KEY (#{new_col_names.join(', ')})" if new_col_names
+        commands = [drop_command, add_command].compact.join(', ')
+        statement = "ALTER TABLE #{ActiveRecord::Base.connection.quote_table_name(@table_name)} #{commands}"
+        "execute #{statement.inspect}"
+      end
+    end
+  end
+end

data/lib/declare_schema/schema_change/table_add.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module DeclareSchema
+  module SchemaChange
+    class TableAdd < Base
+      def initialize(table_name, fields, create_table_options, sql_options: nil)
+        @table_name = table_name
+        fields.all? do |type, name, options|
+          type.is_a?(Symbol) && name.is_a?(Symbol) && options.is_a?(Hash)
+        end or raise ArgumentError, "fields must be Array(Array(Symbol, Symbol, Hash)); got #{fields.inspect}"
+        @fields = fields
+        @create_table_options = create_table_options
+        @create_table_options = @create_table_options.merge(options: sql_options) if sql_options.present?
+      end
+
+      def up_command
+        longest_field_type_length = @fields.map { |type, _name, _option| type.to_s.length }.max
+
+        <<~EOS.strip
+          create_table #{[@table_name.to_sym.inspect, *self.class.format_options(@create_table_options)].join(', ')} do |t|
+          #{@fields.map do |type, name, options|
+              padded_type = format("%-*s", longest_field_type_length, type)
+              args = [name.inspect, *self.class.format_options(options)].join(', ')
+              "  t.#{padded_type} #{args}"
+            end.join("\n")}
+          end
+        EOS
+      end
+
+      def down_command
+        "drop_table #{@table_name.to_sym.inspect}"
+      end
+    end
+  end
+end

data/lib/declare_schema/schema_change/table_change.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module DeclareSchema
+  module SchemaChange
+    class TableChange < Base
+      def initialize(table_name, old_options, new_options)
+        @table_name = table_name
+        @old_options = old_options
+        @new_options = new_options
+      end
+
+      def up_command
+        alter_table(@table_name, @new_options)
+      end
+
+      def down_command
+        alter_table(@table_name, @old_options)
+      end
+
+      private
+
+      TABLE_OPTIONS_TO_SQL_MAPPINGS = {
+        charset:   'CHARACTER SET',
+        collation: 'COLLATE'
+      }.freeze
+
+      def alter_table(table_name, options)
+        sql_options = options.map { |key, value| [TABLE_OPTIONS_TO_SQL_MAPPINGS[key], value] }
+        statement = "ALTER TABLE #{ActiveRecord::Base.connection.quote_table_name(table_name)} #{sql_options.join(' ')}"
+        "execute #{statement.inspect}"
+      end
+    end
+  end
+end

data/lib/declare_schema/schema_change/table_remove.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module DeclareSchema
+  module SchemaChange
+    class TableRemove < Base
+      def initialize(table_name, add_table_back)
+        @table_name = table_name
+        @add_table_back = add_table_back
+      end
+
+      def up_command
+        "drop_table #{@table_name.to_sym.inspect}"
+      end
+
+      def down_command
+        @add_table_back
+      end
+    end
+  end
+end

data/lib/declare_schema/schema_change/table_rename.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module DeclareSchema
+  module SchemaChange
+    class TableRename < Base
+      def initialize(old_name, new_name)
+        @old_name = old_name
+        @new_name = new_name
+      end
+
+      def up_command
+        "rename_table #{@old_name.to_sym.inspect}, #{@new_name.to_sym.inspect}"
+      end
+
+      def down_command
+        "rename_table #{@new_name.to_sym.inspect}, #{@old_name.to_sym.inspect}"
+      end
+    end
+  end
+end

data/lib/declare_schema/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeclareSchema
-  VERSION = "0.9.0"
+  VERSION = "0.11.1"
 end

data/lib/generators/declare_schema/migration/USAGE

@@ -1,47 +1,37 @@
 Description:
 
         This generator compares your existing schema against the
-        schema declared inside your fields declarations in your
-        models.
+        schema declared inside your declare_schema do ... end
+        declarations in your models.
 
         If the generator finds differences, it will display the
-        migration it has created, and ask you if you wish to
-        [g]enerate migration, generate and [m]igrate now or [c]ancel?
-        Enter "g" to just generate the migration but do not run it.
-        Enter "m" to generate the migration and run it, or press "c"
-        to do nothing.
-
-        The generator will then prompt you for the migration name,
+        migration it has created, and prompt you for the migration name,
         supplying a numbered default name.
 
         The generator is conservative and will prompt you to resolve
         any ambiguities.
 
-Examples:
+Example:
 
-        $ rails generate declare_schema:migration
+        $ bundle exec rails generate declare_schema:migration
 
         ---------- Up Migration ----------
-        create_table :foos do |t|
+        create_table :users do |t|
+          t.string :first_name, limit: 50
+          t.string :last_name, limit: 50
           t.datetime :created_at
           t.datetime :updated_at
         end
         ----------------------------------
 
         ---------- Down Migration --------
-        drop_table :foos
+        drop_table :users
         ----------------------------------
-        What now: [g]enerate migration, generate and [m]igrate now or [c]ancel? m
-
-        Migration filename:
-        (you can type spaces instead of '_' -- every little helps)
-        Filename [declare_schema_migration_2]: create_foo
+        Migration filename: (spaces will be converted to _) [declare_schema_migration_2]: create users
               exists  db/migrate
-              create  db/migrate/20091023183838_create_foo.rb
-        (in /work/foo)
-        ==  CreateFoo: migrating ======================================================
-        -- create_table(:yos)
-           -> 0.0856s
-        ==  CreateFoo: migrated (0.0858s) =============================================
+              create  db/migrate/20091023183838_create_users.rb
+
+Not running migration since --migrate not given. When you are ready, run:
 
+   bundle exec rails db:migrate
 

data/lib/generators/declare_schema/migration/migration_generator.rb

@@ -38,20 +38,18 @@ module DeclareSchema
                  type: :boolean,
                  desc: "Don't prompt for a migration name - just pick one"
 
-    class_option :generate,
-                 aliases: '-g',
-                 type: :boolean,
-                 desc: "Don't prompt for action - generate the migration"
-
     class_option :migrate,
                  aliases: '-m',
                  type: :boolean,
-                 desc: "Don't prompt for action - generate and migrate"
+                 desc: "After generating migration, run it"
 
     def migrate
       return if migrations_pending?
 
-      generator = Generators::DeclareSchema::Migration::Migrator.new(->(c, d, k, p) { extract_renames!(c, d, k, p) })
+      generator = Generators::DeclareSchema::Migration::Migrator.new do |to_create, to_drop, kind_str, name_prefix|
+        extract_renames!(to_create, to_drop, kind_str, name_prefix)
+      end
+
       up, down = generator.generate
 
       if up.blank?
@@ -67,34 +65,31 @@ module DeclareSchema
       say down
       say "----------------------------------"
 
-      action = options[:generate] && 'g' ||
-               options[:migrate] && 'm' ||
-               choose("\nWhat now: [g]enerate migration, generate and [m]igrate now or [c]ancel?", /^(g|m|c)$/)
-
-      if action != 'c'
-        if name.blank? && !options[:default_name]
-          final_migration_name = choose("\nMigration filename: [<enter>=#{migration_name}|<custom_name>]:", /^[a-z0-9_ ]*$/, migration_name).strip.gsub(' ', '_')
-        end
-        final_migration_name = migration_name if final_migration_name.blank?
-
-        up.gsub!("\n", "\n    ")
-        up.gsub!(/ +\n/, "\n")
-        down.gsub!("\n", "\n    ")
-        down.gsub!(/ +\n/, "\n")
-
-        @up = up
-        @down = down
-        @migration_class_name = final_migration_name.camelize
-
-        migration_template('migration.rb.erb', "db/migrate/#{final_migration_name.underscore}.rb")
-        if action == 'm'
-          case Rails::VERSION::MAJOR
-          when 4
-            rake('db:migrate')
-          else
-            rails_command('db:migrate')
-          end
+      final_migration_name =
+        name.presence ||
+        if !options[:default_name]
+          choose("\nMigration filename (spaces will be converted to _) [#{default_migration_name}]:", /^[a-z0-9_ ]*$/,
+                 default_migration_name).strip.gsub(' ', '_').presence
+        end ||
+        default_migration_name
+
+      @up = indent(up.strip, 4)
+      @down = indent(down.strip, 4)
+      @migration_class_name = final_migration_name.camelize
+
+      migration_template('migration.rb.erb', "db/migrate/#{final_migration_name.underscore}.rb")
+
+      db_migrate_command = ::DeclareSchema.db_migrate_command
+      if options[:migrate]
+        say db_migrate_command
+        bare_rails_command = db_migrate_command.sub(/\Abundle exec +/, '').sub(/\Arake +|rails +/, '')
+        if ActiveSupport::VERSION::MAJOR < 5
+          rake(bare_rails_command)
+        else
+          rails_command(bare_rails_command)
         end
+      else
+        say "\nNot running migration since --migrate not given. When you are ready, run:\n\n   #{db_migrate_command}\n\n"
       end
     rescue ::DeclareSchema::UnknownTypeError => ex
       say "Invalid field type: #{ex}"
@@ -102,8 +97,15 @@ module DeclareSchema
 
     private
 
+    if ActiveSupport::VERSION::MAJOR < 5
+      def indent(string, columns)
+        whitespace = ' ' * columns
+        string.gsub("\n", "\n#{whitespace}").gsub(/ +\n/, "\n")
+      end
+    end
+
     def migrations_pending?
-      migrations = case Rails::VERSION::MAJOR
+      migrations = case ActiveSupport::VERSION::MAJOR
                    when 4
                      ActiveRecord::Migrator.migrations('db/migrate')
                    when 5
@@ -111,7 +113,7 @@ module DeclareSchema
                    else
                      ActiveRecord::MigrationContext.new(ActiveRecord::Migrator.migrations_paths, ActiveRecord::SchemaMigration).migrations
                    end
-      pending_migrations = case Rails::VERSION::MAJOR
+      pending_migrations = case ActiveSupport::VERSION::MAJOR
                            when 4, 5
                              ActiveRecord::Migrator.new(:up, migrations).pending_migrations
                            else
@@ -176,8 +178,8 @@ module DeclareSchema
       to_rename
     end
 
-    def migration_name
-      name || Generators::DeclareSchema::Migration::Migrator.default_migration_name
+    def default_migration_name
+      Generators::DeclareSchema::Migration::Migrator.default_migration_name
     end
   end
 end