declare_schema 0.2.0.pre.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ce85b3e273a189a4ab8b48e333c2f12b2aea4962c0c277ae3c289f1904cddd8
-  data.tar.gz: d12345f0a483effa2724e0cd315efa759b2ace23e82ef9a1ae2cdaae28aa2571
+  metadata.gz: 8b82febb09d3ef72dd3e219c6900abd790e6401e9b15c9ca05c8cd9fc20c5bf4
+  data.tar.gz: 3f2520292af5845df795dba3f26ee62385d1166da51ce5c6a980d1fdc52460a3
 SHA512:
-  metadata.gz: 84cfbdd55c37a0404b672fbbca5c12dfeee765b0582cdf369b8b3f95159cfb8f82eb3fb1e6149e830ba4fe4481d6df6ef4df45398e30985380ae6681c731f8a9
-  data.tar.gz: adeda560e6bb859104b78e3710fb94d438606cf42c10b199527e5d14545505dda6dde3206500a5f7ea38b79530952182954f5e3892779f9d96db9270d59a28f1
+  metadata.gz: bb726c72430d5b44d94239c3d00abfa42a1c4e2a9c23ad316bd66ec6567857a81c6f7766136bf3d4d78d1df7a43edec2da7e0162cabd60080892b29a2f6b69ce
+  data.tar.gz: 4f39c4534895f33f5d30181ef18b09c2fd9eb535e9da14b0ce502c9117cf28e58404e4c6b2254ffb322a3faea99f0433de6450b9fca96a0585bc87d25047c7b8

data/CHANGELOG.md

@@ -4,14 +4,36 @@ 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.2.0] - Unreleased
+## [0.3.1] - 2020-11-13
+### Fixed
+- When passing `belongs_to` to Rails, suppress the `optional:` option in Rails 4, since that option was added in Rails 5.
+
+## [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.
 
-## [0.1.3] - Unreleased
+### 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.
@@ -25,6 +47,8 @@ using the appropriate Rails configuration attributes.
 ### Added
 - Initial version from https://github.com/Invoca/hobo_fields v4.1.0.
 
+[0.3.1]: https://github.com/Invoca/declare_schema/compare/v0.3.0...v0.3.1
+[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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    declare_schema (0.2.0.pre.1)
+    declare_schema (0.3.1)
       rails (>= 4.2)
 
 GEM
@@ -54,7 +54,7 @@ GEM
       thor (>= 0.14.0)
     arel (9.0.0)
     ast (2.4.1)
-    bootsnap (1.4.8)
+    bootsnap (1.5.0)
       msgpack (~> 1.0)
     builder (3.2.4)
     byebug (11.1.3)
@@ -134,19 +134,19 @@ GEM
       actionpack (>= 5.0)
       railties (>= 5.0)
     rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
     rubocop (0.91.0)
       parallel (~> 1.10)
       parser (>= 2.7.1.1)

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/lib/declare_schema/model.rb

@@ -106,17 +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)
         column_options = {}
-        column_options[:null] = options.delete(:null) || false
+
+        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)
 
@@ -129,20 +126,30 @@ 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)
+          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
+
+        if Rails::VERSION::MAJOR >= 5
+          super
+        else
+          super(name, scope, options.except(:optional))
+        end
+
+        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
+          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

data/lib/declare_schema/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeclareSchema
-  VERSION = "0.2.0.pre.1"
+  VERSION = "0.3.1"
 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 = {})
@@ -106,14 +127,12 @@ module Generators
 
         attr_accessor :renames
 
-        # TODO: Add an application callback (maybe an initializer in a special group?) that
-        # the application can use to load other models that live in the database, to support DeclareSchema migrations
-        # for them.
         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
@@ -129,22 +148,6 @@ module Generators
           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
@@ -410,9 +413,9 @@ module Generators
             col_name = old_names[c] || c
             col = db_columns[col_name]
             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
+            if spec.different_to?(col) # TODO: TECH-4814 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?
@@ -518,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}"
@@ -530,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
             {}

data/lib/generators/declare_schema/migration/templates/migration.rb.erb

@@ -1,4 +1,4 @@
-class <%= @migration_class_name %> < ActiveRecord::Migration<%= ('[4.2]' if Rails::VERSION::MAJOR >= 5) %>
+class <%= @migration_class_name %> < (Rails::VERSION::MAJOR >= 5 ? ActiveRecord::Migration[4.2] : ActiveRecord::Migration)
   def self.up
     <%= @up %>
   end

data/spec/lib/declare_schema/api_spec.rb

@@ -10,14 +10,14 @@ RSpec.describe 'DeclareSchema API' do
 
   describe 'example models' do
     it 'generates a model' do
-      expect(system("bundle exec rails generate declare_schema:model advert title:string body:text")).to be_truthy
+      generate_model 'advert', 'title:string', 'body:text'
 
       # The above will generate the test, fixture and a model file like this:
       # model_declaration = Rails::Generators.invoke('declare_schema:model', ['advert2', 'title:string', 'body:text'])
       # expect(model_declaration.first).to eq([["Advert"], nil, "app/models/advert.rb", nil,
       #                                       [["AdvertTest"], "test/models/advert_test.rb", nil, "test/fixtures/adverts.yml"]])
 
-      expect(File.read("#{TESTAPP_PATH}/app/models/advert.rb")).to eq(<<~EOS)
+      expect_model_definition_to_eq('advert', <<~EOS)
         class Advert < #{active_record_base_class}
 
           fields do
@@ -27,7 +27,8 @@ RSpec.describe 'DeclareSchema API' do
 
         end
       EOS
-      system("rm -rf #{TESTAPP_PATH}/app/models/advert2.rb #{TESTAPP_PATH}/test/models/advert2.rb #{TESTAPP_PATH}/test/fixtures/advert2.rb")
+
+      clean_up_model('advert2')
 
       # The migration generator uses this information to create a migration.
       # The following creates and runs the migration:
@@ -36,13 +37,11 @@ RSpec.describe 'DeclareSchema API' do
 
       # We're now ready to start demonstrating the API
 
-      Rails.application.config.autoload_paths += ["#{TESTAPP_PATH}/app/models"]
-
-      $LOAD_PATH << "#{TESTAPP_PATH}/app/models"
+      load_models
 
       unless Rails::VERSION::MAJOR >= 6
         # TODO: get this to work on Travis for Rails 6
-        Rails::Generators.invoke('declare_schema:migration', %w[-n -m])
+        generate_migrations '-n', '-m'
       end
 
       require 'advert'

data/spec/lib/declare_schema/generator_spec.rb

@@ -6,22 +6,20 @@ RSpec.describe 'DeclareSchema Migration Generator' do
   end
 
   it "generates nested models" do
-    Rails::Generators.invoke('declare_schema:model', %w[alpha/beta one:string two:integer])
+    generate_model 'alpha/beta', 'one:string', 'two:integer'
 
-    expect(File.exist?('app/models/alpha/beta.rb')).to be_truthy
-
-    expect(File.read('app/models/alpha/beta.rb')).to eq(<<~EOS)
+    expect_model_definition_to_eq('alpha/beta', <<~EOS)
       class Alpha::Beta < #{active_record_base_class}
-  
+
         fields do
           one :string, limit: 255
           two :integer
         end
-  
+
       end
     EOS
 
-    expect(File.read('app/models/alpha.rb')).to eq(<<~EOS)
+    expect_model_definition_to_eq('alpha', <<~EOS)
       module Alpha
         def self.table_name_prefix
           'alpha_'
@@ -29,9 +27,9 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       end
     EOS
 
-    expect(File.read('test/models/alpha/beta_test.rb')).to eq(<<~EOS)
+    expect_test_definition_to_eq('alpha/beta', <<~EOS)
       require 'test_helper'
-      
+
       class Alpha::BetaTest < ActiveSupport::TestCase
         # test "the truth" do
         #   assert true
@@ -39,7 +37,50 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       end
     EOS
 
-    expect(File.exist?('test/fixtures/alpha/beta.yml')).to be_truthy
+    case Rails::VERSION::MAJOR
+    when 4
+      expect_test_fixture_to_eq('alpha/beta', <<~EOS)
+        # Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+
+        # This model initially had no columns defined.  If you add columns to the
+        # model remove the '{}' from the fixture names and add the columns immediately
+        # below each fixture, per the syntax in the comments below
+        #
+        one: {}
+        # column: value
+        #
+        two: {}
+        #  column: value
+      EOS
+    when 5
+      expect_test_fixture_to_eq('alpha/beta', <<~EOS)
+        # Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+
+        # This model initially had no columns defined. If you add columns to the
+        # model remove the '{}' from the fixture names and add the columns immediately
+        # below each fixture, per the syntax in the comments below
+        #
+        one: {}
+        # column: value
+        #
+        two: {}
+        # column: value
+      EOS
+    when 6
+      expect_test_fixture_to_eq('alpha/beta', <<~EOS)
+        # Read about fixtures at https://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+
+        # This model initially had no columns defined. If you add columns to the
+        # model remove the '{}' from the fixture names and add the columns immediately
+        # below each fixture, per the syntax in the comments below
+        #
+        one: {}
+        # column: value
+        #
+        two: {}
+        # column: value
+      EOS
+    end
 
     $LOAD_PATH << "#{TESTAPP_PATH}/app/models"