declare_schema 0.9.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 531940d48f1fe38830944576136ff76e2b29dc69a323a2a8e3f60f431731f104
-  data.tar.gz: 3afe0ce91fa631f4fa07d10ef1039f788589d440e87245c859db9bbe0179972d
+  metadata.gz: 389da0d9f9e0753e62297aeca33c3c73305d95082a3f50baf6288362011e6f52
+  data.tar.gz: 7d20d8ef4a085e37ec13273c020b8c3883e96359e9e4c7d173c3beccf5c73dab
 SHA512:
-  metadata.gz: 67270e128e00f45b8ed8393b85ffe65ab4bc7ae197296adacf22c37629bdf5e768d6e204987b67e2d63b3ac0cc79aadb0b02c2c4f60e7e4b85e01f4d24ef55e2
-  data.tar.gz: c9763a6eacd9d1d1deef9e829072e974ea53a5575f0938a8b4202e4210aa704186022a12e8704c08edde24bc73c2da7f95b467b77f3c81e422df54eddaf2352a
+  metadata.gz: 0e4eb02bc1d989d648095b952e1feff00af9cbbc4ea3dbb7962f15fdbcafce2fac4bc93c467417d29396e6753993874c3c2faf882a620db0d54f3ea905195cf9
+  data.tar.gz: d504a96bb5f60d7c64b03fd975c9e7c78fe9614f06a0aa73fffe0c0987786a554e3f603a79198f962b13b0b869690b839fb1cd0215196353064360ef81e46e51

data/.github/workflows/declare_schema_build.yml

@@ -57,4 +57,4 @@ jobs:
           git config --global user.email "dummy@example.com"
           git config --global user.name "dummy"
           MYSQL_PORT=3306 bundle exec rake test:prepare_testapp[force]
-          bundle exec rake test:all < test_responses.txt
+          bundle exec rake test:all

data/CHANGELOG.md

@@ -4,6 +4,34 @@ Inspired by [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 Note: this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.11.1] - 2021-03-26
+### Fixed
+- Fixed a bug where up and down in generated migration would be empty in Rails 4.
+
+## [0.11.0] - 2021-03-22
+### Removed
+- Removed `g|m|c` prompt entirely, since it was confusing. Instead, the migration is
+ always generated; the user may press ^C at the filename prompt to cancel.
+ The migration will be run if `--migrate` is passed; otherwise, the migrate command will be displayed to be run later.
+### Added
+- Added the new configuration option `DeclareSchema.@db_migrate_command =`.
+### Fixed 
+- Fixed bug where foreign key constraint names are not globally unique
+
+## [0.10.1] - 2021-03-18
+### Fixed
+- Migration steps are now generated in a defined dependency order, so that--for example--indexes that depend
+ on columns are deleted first, before the columns themselves are deleted (since the latter implicitly does the former, which would break the migration when run).
+- Related to the above, down migration steps are now always generated in exactly the reverse order of the up migration steps.
+
+## [0.10.0] - 2021-03-17
+### Deprecated
+- Deprecated the `fields` DSL method in favor of `declare_schema`.
+
+### Added
+- Added the `declare_schema` method to replace `fields`. We now expect a column's type to come before the name
+i.e. `declare schema { string :title }`. Otherwise, there is no difference between `fields` and `declare_schema`.
+
 ## [0.9.0] - 2021-03-01
 ### Added
 - Added configurable default settings for `default_text_limit`, `default_string_limit`, `default_null`,
@@ -140,6 +168,10 @@ using the appropriate Rails configuration attributes.
 ### Added
 - Initial version from https://github.com/Invoca/hobo_fields v4.1.0.
 
+[0.11.1]: https://github.com/Invoca/declare_schema/compare/v0.11.0...v0.11.1
+[0.11.0]: https://github.com/Invoca/declare_schema/compare/v0.10.1...v0.11.0
+[0.10.1]: https://github.com/Invoca/declare_schema/compare/v0.10.0...v0.10.1
+[0.10.0]: https://github.com/Invoca/declare_schema/compare/v0.9.0...v0.10.0
 [0.9.0]: https://github.com/Invoca/declare_schema/compare/v0.8.0...v0.9.0
 [0.8.0]: https://github.com/Invoca/declare_schema/compare/v0.7.1...v0.8.0
 [0.7.1]: https://github.com/Invoca/declare_schema/compare/v0.7.0...v0.7.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    declare_schema (0.9.0)
+    declare_schema (0.11.1)
       rails (>= 4.2)
 
 GEM

data/README.md

@@ -57,7 +57,7 @@ during the initialization of your Rails application.
 
 ### before_generating_migration callback
 
-During the initializtion process for generating migrations, `DeclareSchema` will
+During the initialization process for generating migrations, `DeclareSchema` will
 trigger the `eager_load!` on the `Rails` application and all `Rails::Engine`s loaded
 into scope.  If you need to generate migrations for models that aren't automatically loaded by `eager_load!`,
 load them in the `before_generating_migration` block.
@@ -163,6 +163,16 @@ turn all tables into `utf8mb4` supporting tables:
 DeclareSchema.default_charset   = "utf8mb4"
 DeclareSchema.default_collation = "utf8mb4_bin"
 ```
+#### db:migrate Command
+`declare_schema` can run the migration once it is generated, if the `--migrate` option is passed.
+If not, it will display the command to run later. By default this command is
+```
+bundle exec rails db:migrate
+```
+If your repo has a different command to run for migrations, you can configure it like this:
+```ruby
+`DeclareSchema.db_migrate_command = "bundle exec rails db:migrate_immediate"`
+```
 
 ## Declaring Character Set and Collation
 _Note: This feature currently only works for MySQL database configurations._
@@ -228,5 +238,5 @@ or add it to your `bundler` Gemfile:
 To run tests:
 ```
 rake test:prepare_testapp[force]
-rake test:all < test_responses.txt
+rake test:all
 ```

data/lib/declare_schema.rb

@@ -28,10 +28,16 @@ module DeclareSchema
   @default_null                  = false
   @default_generate_foreign_keys = true
   @default_generate_indexing     = true
+  @db_migrate_command            =
+    if ActiveSupport::VERSION::MAJOR < 5
+      "bundle exec rake db:migrate"
+    else
+      "bundle exec rails db:migrate"
+    end
 
   class << self
     attr_reader :default_charset, :default_collation, :default_text_limit, :default_string_limit, :default_null,
-                :default_generate_foreign_keys, :default_generate_indexing
+                :default_generate_foreign_keys, :default_generate_indexing, :db_migrate_command
 
     def to_class(type)
       case type
@@ -78,6 +84,11 @@ module DeclareSchema
       generate_indexing.in?([true, false]) or raise ArgumentError, "generate_indexing must be either true or false (got #{generate_indexing.inspect})"
       @default_generate_indexing = generate_indexing
     end
+
+    def db_migrate_command=(db_migrate_command)
+      db_migrate_command.is_a?(String) or raise ArgumentError, "db_migrate_command must be a string (got #{db_migrate_command.inspect})"
+      @db_migrate_command = db_migrate_command
+    end
   end
 end
 

data/lib/declare_schema/dsl.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'active_support/proxy_object'
+
+module DeclareSchema
+  class Dsl < BasicObject # avoid Object because that gets extended by lots of gems
+    include ::Kernel      # but we need the basic class methods
+
+    instance_methods.each do |m|
+      unless m.to_s.starts_with?('__') || m.in?([:object_id, :instance_eval])
+        undef_method(m)
+      end
+    end
+
+    def initialize(model, options = {})
+      @model = model
+      @options = options
+    end
+
+    attr_reader :model
+
+    def timestamps
+      field(:created_at, :datetime, null: true)
+      field(:updated_at, :datetime, null: true)
+    end
+
+    def optimistic_lock
+      field(:lock_version, :integer, default: 1, null: false)
+    end
+
+    def field(name, type, *args, **options)
+      @model.declare_field(name, type, *(args + [@options.merge(options)]))
+    end
+
+    def method_missing(type, name, *args)
+      field(name, type, *args)
+    end
+  end
+end

data/lib/declare_schema/extensions/active_record/fields_declaration.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
 require 'active_record'
+require 'declare_schema/dsl'
 require 'declare_schema/model'
 require 'declare_schema/field_declaration_dsl'
 
 module DeclareSchema
-  module FieldsDsl
+  module Macros
     def fields(table_options = {}, &block)
       # Any model that calls 'fields' gets DeclareSchema::Model behavior
       DeclareSchema::Model.mix_in(self)
 
-      # @include_in_migration = false #||= options.fetch(:include_in_migration, true); options.delete(:include_in_migration)
       @include_in_migration = true
       @table_options        = table_options
 
@@ -23,7 +23,26 @@ module DeclareSchema
         end
       end
     end
+    deprecate :fields, deprecator: ActiveSupport::Deprecation.new('1.0', 'DeclareSchema')
+
+    def declare_schema(table_options = {}, &block)
+      # Any model that calls 'fields' gets DeclareSchema::Model behavior
+      DeclareSchema::Model.mix_in(self)
+
+      # @include_in_migration = false #||= options.fetch(:include_in_migration, true); options.delete(:include_in_migration)
+      @include_in_migration = true # TODO: Add back or delete the include_in_migration feature
+      @table_options        = table_options
+
+      if block
+        dsl = DeclareSchema::Dsl.new(self, null: false)
+        if block.arity == 1
+          yield dsl
+        else
+          dsl.instance_eval(&block)
+        end
+      end
+    end
   end
 end
 
-ActiveRecord::Base.singleton_class.prepend DeclareSchema::FieldsDsl
+ActiveRecord::Base.singleton_class.prepend DeclareSchema::Macros

data/lib/declare_schema/model.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'rails'
-
 require 'declare_schema/extensions/module'
 
 module DeclareSchema
@@ -41,7 +39,7 @@ module DeclareSchema
           eval <<~EOS
             def self.inherited(klass)
               unless klass.field_specs.has_key?(inheritance_column)
-                fields do |f|
+                declare_schema do |f|
                   f.field(inheritance_column, :string, limit: 255, null: true)
                 end
                 index(inheritance_column)
@@ -130,7 +128,7 @@ module DeclareSchema
 
         fk_options[:dependent] = options.delete(:far_end_dependent) if options.has_key?(:far_end_dependent)
 
-        if Rails::VERSION::MAJOR >= 5
+        if ActiveSupport::VERSION::MAJOR >= 5
           super
         else
           super(name, scope, options.except(:optional))
@@ -149,7 +147,7 @@ module DeclareSchema
         end
       end
 
-      if ::Rails::VERSION::MAJOR < 5
+      if ::ActiveSupport::VERSION::MAJOR < 5
         def primary_key
           super || 'id'
         end
@@ -227,7 +225,7 @@ module DeclareSchema
                   ActiveRecord::Coders::JSON
                 elsif [:load, :dump].all? { |x| class_name_or_coder.respond_to?(x) }
                   class_name_or_coder
-                elsif Rails::VERSION::MAJOR >= 5
+                elsif ActiveSupport::VERSION::MAJOR >= 5
                   ActiveRecord::Coders::YAMLColumn.new(attr_name, class_name_or_coder)
                 else
                   ActiveRecord::Coders::YAMLColumn.new(class_name_or_coder)

data/lib/declare_schema/model/column.rb

@@ -53,7 +53,7 @@ module DeclareSchema
         def deserialize_default_value(column, type, default_value)
           type or raise ArgumentError, "must pass type; got #{type.inspect}"
 
-          case Rails::VERSION::MAJOR
+          case ActiveSupport::VERSION::MAJOR
           when 4
             # TODO: Delete this Rails 4 support ASAP! This could be wrong, since it's using the type of the old column...which
             # might be getting migrated to a new type. We should be using just type as below. -Colin

data/lib/declare_schema/model/foreign_key_definition.rb

@@ -7,20 +7,20 @@ module DeclareSchema
     class ForeignKeyDefinition
       include Comparable
 
-      attr_reader :constraint_name, :model, :foreign_key, :foreign_key_name, :options, :on_delete_cascade
+      attr_reader :constraint_name, :model, :foreign_key, :foreign_key_name, :parent_table_name, :child_table_name, :options, :on_delete_cascade
+
 
       def initialize(model, foreign_key, options = {})
         @model = model
         @foreign_key = foreign_key.to_s.presence
         @options = options
 
-        @child_table = model.table_name # unless a table rename, which would happen when a class is renamed??
+        @child_table_name = model.table_name # unless a table rename, which would happen when a class is renamed??
         @parent_table_name = options[:parent_table]&.to_s
         @foreign_key_name = options[:foreign_key]&.to_s || @foreign_key
 
-        @constraint_name = options[:constraint_name]&.to_s ||
-                             options[:index_name]&.to_s ||
-                             IndexDefinition.index_name(@foreign_key_name)
+        @constraint_name = options[:constraint_name]&.to_s.presence ||
+                             model.connection.index_name(model.table_name, column: @foreign_key_name)
         @on_delete_cascade = options[:dependent] == :delete
       end
 
@@ -61,11 +61,6 @@ module DeclareSchema
             foreign_key.sub(/_id\z/, '').camelize.constantize.table_name
       end
 
-      def to_add_statement
-        "add_foreign_key(#{@child_table.inspect}, #{parent_table_name.inspect}, " +
-          "column: #{@foreign_key_name.inspect}, name: #{@constraint_name.inspect})"
-      end
-
       def <=>(rhs)
         key <=> rhs.send(:key)
       end
@@ -75,7 +70,7 @@ module DeclareSchema
       private
 
       def key
-        @key ||= [@child_table, parent_table_name, @foreign_key_name, @on_delete_cascade].map(&:to_s)
+        @key ||= [@child_table_name, parent_table_name, @foreign_key_name, @on_delete_cascade].map(&:to_s)
       end
 
       def hash

data/lib/declare_schema/model/index_definition.rb

@@ -68,7 +68,7 @@ module DeclareSchema
 
         # This is the old approach which is still needed for MySQL in Rails 4 and SQLite
         def sqlite_compound_primary_key(model, table)
-          ActiveRecord::Base.connection.class.name.match?(/SQLite3Adapter/) || Rails::VERSION::MAJOR < 5 or return nil
+          ActiveRecord::Base.connection.class.name.match?(/SQLite3Adapter/) || ActiveSupport::VERSION::MAJOR < 5 or return nil
 
           connection = model.connection.dup
 
@@ -93,25 +93,6 @@ module DeclareSchema
         name == PRIMARY_KEY_NAME
       end
 
-      def to_add_statement(new_table_name, existing_primary_key = nil)
-        if primary_key? && !ActiveRecord::Base.connection.class.name.match?(/SQLite3Adapter/)
-          to_add_primary_key_statement(new_table_name, existing_primary_key)
-        else
-          # Note: + below keeps that interpolated string from being frozen, so we can << into it.
-          r = +"add_index #{new_table_name.to_sym.inspect}, #{fields.map(&:to_sym).inspect}"
-          r << ", unique: true"      if unique
-          r << ", where: '#{where}'" if where.present?
-          r << ", name: '#{name}'"
-          r
-        end
-      end
-
-      def to_add_primary_key_statement(new_table_name, existing_primary_key)
-        drop = "DROP PRIMARY KEY, " if existing_primary_key
-        statement = "ALTER TABLE #{new_table_name} #{drop}ADD PRIMARY KEY (#{fields.join(', ')})"
-        "execute #{statement.inspect}"
-      end
-
       def to_key
         @key ||= [table, fields, name, unique, where].map(&:to_s)
       end

data/lib/declare_schema/schema_change/all.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DeclareSchema
+  module SchemaChange
+    module All
+    end
+    autoload :Base, 'declare_schema/schema_change/base'
+    autoload :ColumnAdd, 'declare_schema/schema_change/column_add'
+    autoload :ColumnChange, 'declare_schema/schema_change/column_change'
+    autoload :ColumnRename, 'declare_schema/schema_change/column_rename'
+    autoload :ForeignKeyAdd, 'declare_schema/schema_change/foreign_key_add'
+    autoload :ForeignKeyRemove, 'declare_schema/schema_change/foreign_key_remove'
+    autoload :IndexAdd, 'declare_schema/schema_change/index_add'
+    autoload :IndexRemove, 'declare_schema/schema_change/index_remove'
+    autoload :PrimaryKeyChange, 'declare_schema/schema_change/primary_key_change'
+    autoload :TableAdd, 'declare_schema/schema_change/table_add'
+    autoload :TableChange, 'declare_schema/schema_change/table_change'
+    autoload :TableRemove, 'declare_schema/schema_change/table_remove'
+    autoload :TableRename, 'declare_schema/schema_change/table_rename'
+  end
+end
+

data/lib/declare_schema/schema_change/base.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module DeclareSchema
+  module SchemaChange
+    class Base
+      class << self
+        def format_options(options)
+          options.map do |k, v|
+            value =
+              if v.is_a?(Hash)
+                "{ #{format_options(v).join(', ')} }"
+              else
+                v.inspect
+              end
+            if k.is_a?(Symbol)
+              "#{k}: #{value}"
+            else
+              "#{k.inspect} => #{value}"
+            end
+          end
+        end
+      end
+
+      def up
+        up_command + spacing(up_command)
+      end
+
+      def down
+        down_command + spacing(down_command)
+      end
+
+      private
+
+      def spacing(command)
+        if command["\n"]
+          "\n\n"
+        else
+          "\n"
+        end
+      end
+    end
+  end
+end

data/lib/declare_schema/schema_change/column_add.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module DeclareSchema
+  module SchemaChange
+    class ColumnAdd < Base
+      def initialize(table_name, column_name, column_type, **column_options)
+        @table_name = table_name
+        @column_name = column_name
+        @column_type = column_type
+        @column_options = column_options
+      end
+
+      def up_command
+        "add_column #{[@table_name.to_sym.inspect,
+                       @column_name.to_sym.inspect,
+                       @column_type.to_sym.inspect,
+                       *self.class.format_options(@column_options)].join(", ")}"
+      end
+
+      def down_command
+        "remove_column #{@table_name.to_sym.inspect}, #{@column_name.to_sym.inspect}"
+      end
+    end
+  end
+end