declare_schema 0.1.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5a1596f905dad5d9dd2f08787607c7b9adc742bbb54702bf4cf4aca812e6912
-  data.tar.gz: 60ec900d6aeb5981d0dd2df7dc689ad01a243e3c1f5b575f33813f5196614c26
+  metadata.gz: f3ae0814480b116b32a822887c83612b33458cc910384ae0c2122e547757f141
+  data.tar.gz: 133b7bd6d7d91dae9320a4e8002a8591e43ebb97f57013cbe266cef40a169088
 SHA512:
-  metadata.gz: b5dc90e36aeb33f00426de19f9df2b85d2bd40754d3bbd6bb8ff8ba410dda808139434d656e305cb9c13320e3cc4130613f06c06ef5abef7e34be4f3ed55e498
-  data.tar.gz: 39e445fb41afbf2a91dcaa1271040ede91997abcd8e6237616f1e24983d5e88c5aa77c23bcd6c98c9b104f1c8ad68b9456c34a067a807044c2d72893f52e7b3b
+  metadata.gz: 77b840eb5feb07d38c4fd96f4212d4c81f19c61a2aa2b4bbffb4f4f11594ba55c30e65ca4b77a68e7b29448f7762dba52782f1845307c5bbc02f7603f080c2e8
+  data.tar.gz: 2f85affbd44a6973595883afa01766ede6c950a70c4e783f3064e5c2a59ec5c71a3731d7d484bab133c18c698584077e2c14a8b98c81ce024e2e55bae59dabba

data/CHANGELOG.md

@@ -4,7 +4,32 @@ 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.1.3] - Unreleased
+## [0.3.0] - 2020-11-02
+### Added
+- Added support for `belongs_to optional:`.
+If given, it is passed through to `ActiveRecord`'s `belong_to`.
+If not given in Rails 5+, the `optional:` value is set equal to the `null:` value (default: `false`) and that
+is passed to `ActiveRecord`'s `belong_to`.
+Similarly, if `null:` is not given, it is inferred from `optional:`.
+If both are given, their values are respected, even if contradictory;
+this is a legitimate case when migrating to/from an optional association.
+- Added a new callback `before_generating_migration` to the `Migrator` that can be
+defined in order to custom load more models that might be missed by `eager_load!`
+### Fixed
+- Migrations are now generated where the `[4.2]` is only applied after `ActiveRecord::Migration` in Rails 5+ (since Rails 4 didn't know about that notation).
+
+## [0.2.0] - 2020-10-26
+### Added
+- Automatically eager_load! all Rails::Engines before generating migrations.
+
+### Changed
+- Changed tests from rdoctest to rspec.
+
+### Fixed
+- Fixed a bug where `:text limit: 0xffff_ffff` (max size) was omitted from migrations.
+- Fixed a bug where `:bigint` foreign keys were omitted from the migration.
+
+## [0.1.3] - 2020-10-08
 ### Changed
 - Updated the `always_ignore_tables` list in `Migrator` to access Rails metadata table names
 using the appropriate Rails configuration attributes.
@@ -18,6 +43,8 @@ using the appropriate Rails configuration attributes.
 ### Added
 - Initial version from https://github.com/Invoca/hobo_fields v4.1.0.
 
+[0.3.0]: https://github.com/Invoca/declare_schema/compare/v0.2.0...v0.3.0
+[0.2.0]: https://github.com/Invoca/declare_schema/compare/v0.1.3...v0.2.0
 [0.1.3]: https://github.com/Invoca/declare_schema/compare/v0.1.2...v0.1.3
 [0.1.2]: https://github.com/Invoca/declare_schema/compare/v0.1.1...v0.1.2
 [0.1.1]: https://github.com/Invoca/declare_schema/tree/v0.1.1

data/Gemfile

@@ -18,6 +18,5 @@ gem 'rails',            '~> 5.2', '>= 5.2.4.3'
 gem 'responders'
 gem 'rspec'
 gem 'rubocop'
-gem 'rubydoctest'
 gem 'sqlite3'
 gem 'yard'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    declare_schema (0.1.3)
+    declare_schema (0.3.0)
       rails (>= 4.2)
 
 GEM
@@ -159,7 +159,6 @@ GEM
     rubocop-ast (0.4.2)
       parser (>= 2.7.1.4)
     ruby-progressbar (1.10.1)
-    rubydoctest (1.1.5)
     sprockets (4.0.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -194,7 +193,6 @@ DEPENDENCIES
   responders
   rspec
   rubocop
-  rubydoctest
   sqlite3
   yard
 

data/README.md

@@ -50,6 +50,26 @@ Migration filename: [<enter>=declare_schema_migration_1|<custom_name>]: add_comp
 ```
 Note that the migration generator is interactive -- it can't tell the difference between renaming something vs. adding one thing and removing another, so sometimes it will ask you to clarify.
 
+## Migrator Configuration
+
+The following configuration options are available for the gem and can be used
+during the initialization of your Rails application.
+
+### before_generating_migration callback
+
+During the initializtion 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.
+
+**Example Configuration**
+
+```ruby
+DeclareSchema::Migration::Migrator.before_generating_migration do
+  require 'lib/some/hidden/models.rb'
+end
+```
+
 ## Installing
 
 Install the `DeclareSchema` gem directly:

data/Rakefile

@@ -14,7 +14,6 @@ $LOAD_PATH.unshift File.expand_path('lib', __dir__)
 require 'declare_schema'
 
 RUBY = 'ruby'
-RUBYDOCTEST = ENV['RUBYDOCTEST'] || "#{RUBY} -S rubydoctest"
 GEM_ROOT = __dir__
 TESTAPP_PATH = ENV['TESTAPP_PATH'] || File.join(Dir.tmpdir, 'declare_schema_testapp')
 BIN = File.expand_path('bin/declare_schema', __dir__)
@@ -24,13 +23,7 @@ task default: 'test:all'
 include Rake::DSL
 
 namespace "test" do
-  task all: [:doctest, :spec]
-
-  desc "Run the doctests"
-  task :doctest do |_t|
-    files = Dir['test/*.rdoctest'].sort.map { |f| File.expand_path(f) }.join(' ')
-    system("#{RUBYDOCTEST} --trace --verbose #{files}") or exit(1)
-  end
+  task all: :spec
 
   desc "Prepare a rails application for testing"
   task :prepare_testapp, :force do |_t, args|
@@ -38,19 +31,19 @@ namespace "test" do
       FileUtils.remove_entry_secure(TESTAPP_PATH, true)
       sh %(#{BIN} new #{TESTAPP_PATH} --skip-wizard --skip-bundle)
       FileUtils.chdir TESTAPP_PATH
-      sh %(bundle install)
-      sh %(echo "" >> Gemfile)
-      sh %(echo "gem 'irt', :group => :development" >> Gemfile) # to make the bundler happy
-      sh %(echo "gem 'therubyracer'" >> Gemfile)
-      sh %(echo "gem 'kramdown'" >> Gemfile)
-      sh %(echo "" > app/models/.gitignore) # because git reset --hard would rm the dir
-      rm %(.gitignore) # we need to reset everything in a testapp
-      sh %(git init && git add . && git commit -m "initial commit")
-      puts %(The testapp has been created in '#{TESTAPP_PATH}')
+      sh "bundle install"
+      sh "(echo '';
+           echo \"gem 'irt', :group => :development\";
+           echo \"gem 'therubyracer'\";
+           echo \"gem 'kramdown'\") > Gemfile"
+      sh "echo '' > app/models/.gitignore" # because git reset --hard would rm the dir
+      rm ".gitignore" # we need to reset everything in a testapp
+      sh "git init && git add . && git commit -m \"initial commit\""
+      puts "The testapp has been created in '#{TESTAPP_PATH}'"
     else
-      FileUtils.chdir TESTAPP_PATH
-      sh %(git add .)
-      sh %(git reset --hard -q HEAD)
+      FileUtils.chdir(TESTAPP_PATH)
+      sh "git add ."
+      sh "git reset --hard -q HEAD"
     end
   end
 end

data/gemfiles/rails_4.gemfile

@@ -11,7 +11,6 @@ gem "rails", "~> 4.2"
 gem "responders"
 gem "rspec"
 gem "rubocop"
-gem "rubydoctest"
 gem "sqlite3", "~> 1.3.0"
 gem "yard"
 

data/gemfiles/rails_5.gemfile

@@ -11,7 +11,6 @@ gem "rails", "~> 5.2"
 gem "responders"
 gem "rspec"
 gem "rubocop"
-gem "rubydoctest"
 gem "sqlite3"
 gem "yard"
 

data/gemfiles/rails_6.gemfile

@@ -11,7 +11,6 @@ gem "rails", "~> 6.0"
 gem "responders"
 gem "rspec"
 gem "rubocop"
-gem "rubydoctest"
 gem "sqlite3"
 gem "yard"
 

data/lib/declare_schema/model.rb

@@ -106,18 +106,14 @@ module DeclareSchema
       end
 
       # Extend belongs_to so that it creates a FieldSpec for the foreign key
-      def belongs_to(name, *args, &block)
-        if args.size == 0 || (args.size == 1 && args[0].is_a?(Proc))
-          options = {}
-          args.push(options)
-        elsif args.size == 1
-          options = args[0]
-        else
-          options = args[1]
-        end
+      def belongs_to(name, scope = nil, **options, &block)
         column_options = {}
-        column_options[:null] = options.delete(:null) || false
-        column_options[:comment] = options.delete(:comment) if options.has_key?(:comment)
+
+        column_options[:null] = if options.has_key?(:null)
+                                  options.delete(:null)
+                                elsif options.has_key?(:optional)
+                                  options[:optional] # infer :null from :optional
+                                end || false
         column_options[:default] = options.delete(:default) if options.has_key?(:default)
         column_options[:limit] = options.delete(:limit) if options.has_key?(:limit)
 
@@ -130,20 +126,27 @@ module DeclareSchema
         fk_options[:constraint_name] = options.delete(:constraint) if options.has_key?(:constraint)
         fk_options[:index_name] = index_options[:name]
 
+        fk = options[:foreign_key]&.to_s || "#{name}_id"
+
+        if !options.has_key?(:optional) && Rails::VERSION::MAJOR >= 5
+          options[:optional] = column_options[:null] # infer :optional from :null
+        end
+
         fk_options[:dependent] = options.delete(:far_end_dependent) if options.has_key?(:far_end_dependent)
-        super(name, *args, &block).tap do |_bt|
-          refl = reflections[name.to_s] or raise "Couldn't find reflection #{name} in #{reflections.keys}"
-          fkey = refl.foreign_key
-          declare_field(fkey.to_sym, :integer, column_options)
-          if refl.options[:polymorphic]
-            foreign_type = options[:foreign_type] || "#{name}_type"
-            declare_polymorphic_type_field(foreign_type, column_options)
-            index([foreign_type, fkey], index_options) if index_options[:name] != false
-          else
-            index(fkey, index_options) if index_options[:name] != false
-            options[:constraint_name] = options
-            constraint(fkey, fk_options) if fk_options[:constraint_name] != false
-          end
+
+        super(name, scope, options)
+
+        refl = reflections[name.to_s] or raise "Couldn't find reflection #{name} in #{reflections.keys}"
+        fkey = refl.foreign_key or raise "Couldn't find foreign_key for #{name} in #{refl.inspect}"
+        declare_field(fkey.to_sym, :integer, column_options)
+        if refl.options[:polymorphic]
+          foreign_type = options[:foreign_type] || "#{name}_type"
+          declare_polymorphic_type_field(foreign_type, column_options)
+          index([foreign_type, fkey], index_options) if index_options[:name] != false
+        else
+          index(fkey, index_options) if index_options[:name] != false
+          options[:constraint_name] = options
+          constraint(fkey, fk_options) if fk_options[:constraint_name] != false
         end
       end
 

data/lib/declare_schema/model/field_spec.rb

@@ -53,7 +53,7 @@ module DeclareSchema
             @options[:limit] = self.class.round_up_mysql_text_limit(@options[:limit] || MYSQL_LONGTEXT_LIMIT)
           end
         when :string
-          @options[:limit] or raise "limit must be given for :string field #{model}##{@name}: #{@options.inspect}; do you want 255?"
+          @options[:limit] or raise "limit must be given for :string field #{model}##{@name}: #{@options.inspect}; do you want `limit: 255`?"
         end
         @position = position_option || model.field_specs.length
       end
@@ -102,10 +102,6 @@ module DeclareSchema
         @options[:default]
       end
 
-      def comment
-        @options[:comment]
-      end
-
       def same_type?(col_spec)
         type = sql_type
         normalized_type           = TYPE_SYNONYMS[type] || type
@@ -115,13 +111,6 @@ module DeclareSchema
 
       def different_to?(col_spec)
         !same_type?(col_spec) ||
-          # we should be able to use col_spec.comment, but col_spec has
-          # a nil table_name for some strange reason.
-          (model.table_exists? &&
-            ActiveRecord::Base.respond_to?(:column_comment) &&
-            !(col_comment = ActiveRecord::Base.column_comment(col_spec.name, model.table_name)).nil? &&
-            col_comment != comment
-          ) ||
           begin
             native_type = native_types[type]
             check_attributes = [:null, :default]

data/lib/declare_schema/version.rb

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

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

@@ -3,7 +3,7 @@
 require 'rails/generators/migration'
 require 'rails/generators/active_record'
 require 'generators/declare_schema/support/thor_shell'
-require_relative '../../../declare_schema/model/field_spec'
+require 'declare_schema/model/field_spec'
 
 module DeclareSchema
   class MigrationGenerator < Rails::Generators::Base
@@ -86,7 +86,7 @@ module DeclareSchema
         @down = down
         @migration_class_name = final_migration_name.camelize
 
-        migration_template 'migration.rb.erb', "db/migrate/#{final_migration_name.underscore}.rb"
+        migration_template('migration.rb.erb', "db/migrate/#{final_migration_name.underscore}.rb")
         if action == 'm'
           case Rails::VERSION::MAJOR
           when 4
@@ -118,14 +118,13 @@ module DeclareSchema
                              ActiveRecord::Migrator.new(:up, migrations, ActiveRecord::SchemaMigration).pending_migrations
                            end
 
-      if pending_migrations.any?
-        say "You have #{pending_migrations.size} pending migration#{'s' if pending_migrations.size > 1}:"
-        pending_migrations.each do |pending_migration|
-          say format('  %4d %s', pending_migration.version, pending_migration.name)
+      pending_migrations.any?.tap do |any|
+        if any
+          say "You have #{pending_migrations.size} pending migration#{'s' if pending_migrations.size > 1}:"
+          pending_migrations.each do |pending_migration|
+            say format('  %4d %s', pending_migration.version, pending_migration.name)
+          end
         end
-        true
-      else
-        false
       end
     end
 
@@ -139,10 +138,10 @@ module DeclareSchema
           loop do
             if rename_to_choices.empty?
               say "\nCONFIRM DROP! #{kind_str} #{name_prefix}#{t}"
-              resp = ask("Enter 'drop #{t}' to confirm or press enter to keep:")
-              if resp.strip == "drop #{t}"
+              resp = ask("Enter 'drop #{t}' to confirm or press enter to keep:").strip
+              if resp == "drop #{t}"
                 break
-              elsif resp.strip.empty?
+              elsif resp.empty?
                 to_drop.delete(t)
                 break
               else
@@ -151,8 +150,7 @@ module DeclareSchema
             else
               say "\nDROP, RENAME or KEEP?: #{kind_str} #{name_prefix}#{t}"
               say "Rename choices: #{to_create * ', '}"
-              resp = ask "Enter either 'drop #{t}' or one of the rename choices or press enter to keep:"
-              resp = resp.strip
+              resp = ask("Enter either 'drop #{t}' or one of the rename choices or press enter to keep:").strip
 
               if resp == "drop #{t}"
                 # Leave things as they are
@@ -183,3 +181,11 @@ module DeclareSchema
     end
   end
 end
+
+module Generators
+  module DeclareSchema
+    module Migration
+      MigrationGenerator = ::DeclareSchema::MigrationGenerator
+    end
+  end
+end

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

@@ -69,12 +69,14 @@ module Generators
       class Migrator
         class Error < RuntimeError; end
 
-        @ignore_models = []
-        @ignore_tables = []
-        @active_record_class = ActiveRecord::Base
+        @ignore_models                    = []
+        @ignore_tables                    = []
+        @before_generating_migration_callback = nil
+        @active_record_class              = ActiveRecord::Base
 
         class << self
           attr_accessor :ignore_models, :ignore_tables, :disable_indexing, :disable_constraints, :active_record_class
+          attr_reader :before_generating_migration_callback
 
           def active_record_class
             @active_record_class.is_a?(Class) or @active_record_class = @active_record_class.to_s.constantize
@@ -96,6 +98,25 @@ module Generators
           def connection
             ActiveRecord::Base.connection
           end
+
+          def fix_native_types(types)
+            case connection.class.name
+            when /mysql/i
+              types[:integer][:limit] ||= 11
+              types[:text][:limit]    ||= 0xffff
+              types[:binary][:limit]  ||= 0xffff
+            end
+            types
+          end
+
+          def native_types
+            @native_types ||= fix_native_types(connection.native_database_types)
+          end
+
+          def before_generating_migration(&block)
+            block or raise ArgumentError, 'A block is required when setting the before_generating_migration callback'
+            @before_generating_migration_callback = block
+          end
         end
 
         def initialize(ambiguity_resolver = {})
@@ -107,36 +128,26 @@ module Generators
         attr_accessor :renames
 
         def load_rails_models
+          ActiveRecord::Migration.verbose = false
+
           Rails.application.eager_load!
+          Rails::Engine.subclasses.each(&:eager_load!)
+          self.class.before_generating_migration_callback&.call
         end
 
         # Returns an array of model classes that *directly* extend
         # ActiveRecord::Base, excluding anything in the CGI module
         def table_model_classes
           load_rails_models
-          ActiveRecord::Base.send(:descendants).reject { |c| (c.base_class != c) || c.name.starts_with?("CGI::") }
+          ActiveRecord::Base.send(:descendants).select do |klass|
+            klass.base_class == klass && !klass.name.starts_with?("CGI::")
+          end
         end
 
         def connection
           self.class.connection
         end
 
-        class << self
-          def fix_native_types(types)
-            case connection.class.name
-            when /mysql/i
-              types[:integer][:limit] ||= 11
-              types[:text][:limit]    ||= 0xffff
-              types[:binary][:limit]  ||= 0xffff
-            end
-            types
-          end
-
-          def native_types
-            @native_types ||= fix_native_types(connection.native_database_types)
-          end
-        end
-
         def native_types
           self.class.native_types
         end
@@ -217,7 +228,7 @@ module Generators
           end
         end
 
-        def always_ignore_tables
+        def self.always_ignore_tables
           sessions_table =
             begin
               if defined?(CGI::Session::ActiveRecordStore::Session) &&
@@ -231,8 +242,8 @@ module Generators
 
           [
             'schema_info',
-            ActiveRecord::Base.schema_migrations_table_name,
-            ActiveRecord::Base.internal_metadata_table_name,
+            ActiveRecord::Base.try(:schema_migrations_table_name) || 'schema_migrations',
+            ActiveRecord::Base.try(:internal_metadata_table_name) || 'ar_internal_metadata',
             sessions_table
           ].compact
         end
@@ -256,7 +267,7 @@ module Generators
           model_table_names = models_by_table_name.keys
 
           to_create = model_table_names - db_tables
-          to_drop = db_tables - model_table_names - always_ignore_tables
+          to_drop = db_tables - model_table_names - self.class.always_ignore_tables
           to_change = model_table_names
           to_rename = extract_table_renames!(to_create, to_drop)
 
@@ -404,14 +415,13 @@ module Generators
             spec = model.field_specs[c]
             if spec.different_to?(col) # TODO: DRY this up to a diff function that returns the differences. It's different if it has differences. -Colin
               change_spec = fk_field_options(model, c)
-              change_spec[:limit]     = spec.limit     if (spec.sql_type != :text ||
+              change_spec[:limit]     ||= spec.limit   if (spec.sql_type != :text ||
                                                          ::DeclareSchema::Model::FieldSpec.mysql_text_limits?) &&
                                                           (spec.limit || col.limit)
               change_spec[:precision] = spec.precision unless spec.precision.nil?
               change_spec[:scale]     = spec.scale     unless spec.scale.nil?
               change_spec[:null]      = spec.null      unless spec.null && col.null
               change_spec[:default]   = spec.default   unless spec.default.nil? && col.default.nil?
-              change_spec[:comment]   = spec.comment   unless spec.comment.nil? && (col.comment if col.respond_to?(:comment)).nil?
 
               changes << "change_column :#{new_table_name}, :#{c}, " +
                          ([":#{spec.sql_type}"] + format_options(change_spec, spec.sql_type, changing: true)).join(", ")
@@ -511,8 +521,7 @@ module Generators
               next if k == :null && v == true
             end
 
-            next if k == :limit && type == :text &&
-                    (!::DeclareSchema::Model::FieldSpec.mysql_text_limits? || v == ::DeclareSchema::Model::FieldSpec::MYSQL_LONGTEXT_LIMIT)
+            next if k == :limit && type == :text && !::DeclareSchema::Model::FieldSpec.mysql_text_limits?
 
             if k.is_a?(Symbol)
               "#{k}: #{v.inspect}"
@@ -523,10 +532,20 @@ module Generators
         end
 
         def fk_field_options(model, field_name)
-          if (foreign_key = model.constraint_specs.find { |fk| field_name == fk.foreign_key.to_s }) && (parent_table = foreign_key.parent_table_name)
+          foreign_key = model.constraint_specs.find { |fk| field_name == fk.foreign_key.to_s }
+          if foreign_key && (parent_table = foreign_key.parent_table_name)
             parent_columns = connection.columns(parent_table) rescue []
-            pk_column = parent_columns.find { |column| column.name == "id" } # right now foreign keys assume id is the target
-            pk_limit  = pk_column ? pk_column.cast_type.limit : 8
+            pk_limit  =
+              if (pk_column = parent_columns.find { |column| column.name.to_s == "id" }) # right now foreign keys assume id is the target
+                if Rails::VERSION::MAJOR <= 4
+                  pk_column.cast_type.limit
+                else
+                  pk_column.limit
+                end
+              else
+                8
+              end
+
             { limit: pk_limit }
           else
             {}