declare_schema 0.3.0.pre.1 → 0.3.0.pre.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a82a5e54f5dadf8a733520efe057d8b1a0319e1725ef82d41d97004ee68cf0c
-  data.tar.gz: 899e9f135706d4883b448bcffc09b5f962cb84892c1bf1be27e6f2e36209454f
+  metadata.gz: 3364c39b6579bb69804417a10b5b287208e6fdfe5a23bf57b6b3f928f69fe539
+  data.tar.gz: 2fbc6abab32d750ef1af34d6888b5954ee27da2563acd8595728d3d23d184244
 SHA512:
-  metadata.gz: 0465ffd5522605f9e0c61beffc2571ab76d077020596d82fe616c60cd631c6663b399c9c5d02c8983d9060223f3bb100932baf411efa69a3a7f236097784ae9e
-  data.tar.gz: 4c6b7b49067650cd0791257614dc84e1f6f6a9191346578249fa196dc0d9f621c491d597aaa32f82c64bde8f6e7fe8e18f1974f89c4677ade6c8203aede20ec4
+  metadata.gz: 7e884c085c0d72f1146d7b7f52abbf1f44b19389e2f96e2858b855b11041c94406b0be159a300366d0abeec2f36cf9056d3eddd61352600c780a992ca3971817
+  data.tar.gz: 1d45f652bd8d0de74b71fec913c4005be8f3212de7fa7942ad587d67059f67115ce8d797be9d71121e792ab66aee84c2adaaa013766b6d96cb21eda1d35522b4

data/CHANGELOG.md

@@ -6,10 +6,8 @@ Note: this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0
 
 ## [0.3.0] - Unreleased
 ### 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 is passed to `ActiveRecord`'s `belong_to`. 
+- 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!`
 
 ## [0.2.0] - 2020-10-26
 ### Added
@@ -20,7 +18,7 @@ is is passed to `ActiveRecord`'s `belong_to`.
 
 ### 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. 
+- Fixed a bug where `:bigint` foreign keys were omitted from the migration.
 
 ## [0.1.3] - 2020-10-08
 ### Changed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    declare_schema (0.3.0.pre.1)
+    declare_schema (0.3.0.pre.2)
       rails (>= 4.2)
 
 GEM

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,7 +106,15 @@ module DeclareSchema
       end
 
       # Extend belongs_to so that it creates a FieldSpec for the foreign key
-      def belongs_to(name, scope = nil, **options, &block)
+      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
         column_options = {}
         column_options[:null] = options.delete(:null) || false
         column_options[:default] = options.delete(:default) if options.has_key?(:default)
@@ -121,27 +129,20 @@ 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]
-        end
-
         fk_options[:dependent] = options.delete(:far_end_dependent) if options.has_key?(:far_end_dependent)
-
-        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
+        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
         end
       end
 

data/lib/declare_schema/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeclareSchema
-  VERSION = "0.3.0.pre.1"
+  VERSION = "0.3.0.pre.2"
 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
@@ -110,6 +112,11 @@ module Generators
           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 = {})
@@ -120,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

data/spec/lib/declare_schema/migration_generator_spec.rb

@@ -129,7 +129,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       end
     end
 
-    up = Generators::DeclareSchema::Migration::Migrator.run.first
+    up, down = Generators::DeclareSchema::Migration::Migrator.run
     expect(up).to eq("add_column :adverts, :price, :integer, limit: 2")
 
     # Now run the migration, then change the limit:
@@ -154,7 +154,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       end
     end
 
-    up = Generators::DeclareSchema::Migration::Migrator.run.first
+    up, down = Generators::DeclareSchema::Migration::Migrator.run
     expect(up).to eq("add_column :adverts, :price, :decimal")
 
     # Limits are generally not needed for `text` fields, because by default, `text` fields will use the maximum size
@@ -170,7 +170,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       end
     end
 
-    up = Generators::DeclareSchema::Migration::Migrator.run.first
+    up, down = Generators::DeclareSchema::Migration::Migrator.run
     expect(up).to eq(<<~EOS.strip)
       add_column :adverts, :price, :decimal
       add_column :adverts, :notes, :text, null: false
@@ -194,7 +194,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       end
     end
 
-    up = Generators::DeclareSchema::Migration::Migrator.run.first
+    up, down = Generators::DeclareSchema::Migration::Migrator.run
     expect(up).to eq(<<~EOS.strip)
       add_column :adverts, :notes, :text, null: false, limit: 4294967295
       add_column :adverts, :description, :text, null: false, limit: 255
@@ -266,7 +266,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       end
     end
 
-    up = Generators::DeclareSchema::Migration::Migrator.run.first
+    up, down = Generators::DeclareSchema::Migration::Migrator.run
     ActiveRecord::Migration.class_eval up
     Advert.connection.schema_cache.clear!
     Advert.reset_column_information
@@ -278,9 +278,6 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
     class Category < ActiveRecord::Base; end
     class Advert < ActiveRecord::Base
-      fields do
-        name :string, limit: 255, null: true
-      end
       belongs_to :category
     end
 
@@ -301,10 +298,9 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
     class Category < ActiveRecord::Base; end
     class Advert < ActiveRecord::Base
-      fields { }
       belongs_to :category, foreign_key: "c_id", class_name: 'Category'
     end
-    up = Generators::DeclareSchema::Migration::Migrator.run.first
+    up, down = Generators::DeclareSchema::Migration::Migrator.run
     expect(up.gsub(/\n+/, "\n")).to eq(<<~EOS.strip)
       add_column :adverts, :c_id, :integer, limit: 8, null: false
       add_index :adverts, [:c_id], name: 'on_c_id'
@@ -317,10 +313,9 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
     class Category < ActiveRecord::Base; end
     class Advert < ActiveRecord::Base
-      fields { }
       belongs_to :category, index: false
     end
-    up = Generators::DeclareSchema::Migration::Migrator.run.first
+    up, down = Generators::DeclareSchema::Migration::Migrator.run
     expect(up.gsub(/\n+/, "\n")).to eq("add_column :adverts, :category_id, :integer, limit: 8, null: false")
 
     Advert.field_specs.delete(:category_id)
@@ -330,10 +325,9 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
     class Category < ActiveRecord::Base; end
     class Advert < ActiveRecord::Base
-      fields { }
       belongs_to :category, index: 'my_index'
     end
-    up = Generators::DeclareSchema::Migration::Migrator.run.first
+    up, down = Generators::DeclareSchema::Migration::Migrator.run
     expect(up.gsub(/\n+/, "\n")).to eq(<<~EOS.strip)
       add_column :adverts, :category_id, :integer, limit: 8, null: false
       add_index :adverts, [:category_id], name: 'my_index'
@@ -378,7 +372,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
         title :string, index: true, limit: 255, null: true
       end
     end
-    up = Generators::DeclareSchema::Migration::Migrator.run.first
+    up, down = Generators::DeclareSchema::Migration::Migrator.run
     expect(up.gsub(/\n+/, "\n")).to eq(<<~EOS.strip)
       add_column :adverts, :title, :string, limit: 255
       add_index :adverts, [:title], name: 'on_title'
@@ -393,7 +387,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
         title :string, index: true, unique: true, null: true, limit: 255
       end
     end
-    up = Generators::DeclareSchema::Migration::Migrator.run.first
+    up, down = Generators::DeclareSchema::Migration::Migrator.run
     expect(up.gsub(/\n+/, "\n")).to eq(<<~EOS.strip)
       add_column :adverts, :title, :string, limit: 255
       add_index :adverts, [:title], unique: true, name: 'on_title'
@@ -408,20 +402,20 @@ RSpec.describe 'DeclareSchema Migration Generator' do
         title :string, index: 'my_index', limit: 255, null: true
       end
     end
-    up = Generators::DeclareSchema::Migration::Migrator.run.first
+    up, down = Generators::DeclareSchema::Migration::Migrator.run
     expect(up.gsub(/\n+/, "\n")).to eq(<<~EOS.strip)
       add_column :adverts, :title, :string, limit: 255
       add_index :adverts, [:title], name: 'my_index'
     EOS
 
-    Advert.index_specs.delete_if { |spec| spec.fields==["title"] }
+    Advert.index_specs.delete_if {|spec| spec.fields==["title"]}
 
     # You can ask for an index outside of the fields block
 
     class Advert < ActiveRecord::Base
       index :title
     end
-    up = Generators::DeclareSchema::Migration::Migrator.run.first
+    up, down = Generators::DeclareSchema::Migration::Migrator.run
     expect(up.gsub(/\n+/, "\n")).to eq(<<~EOS.strip)
       add_column :adverts, :title, :string, limit: 255
       add_index :adverts, [:title], name: 'on_title'
@@ -434,7 +428,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
     class Advert < ActiveRecord::Base
       index :title, unique: true, name: 'my_index'
     end
-    up = Generators::DeclareSchema::Migration::Migrator.run.first
+    up, down = Generators::DeclareSchema::Migration::Migrator.run
     expect(up.gsub(/\n+/, "\n")).to eq(<<~EOS.strip)
       add_column :adverts, :title, :string, limit: 255
       add_index :adverts, [:title], unique: true, name: 'my_index'
@@ -447,7 +441,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
     class Advert < ActiveRecord::Base
       index [:title, :category_id]
     end
-    up = Generators::DeclareSchema::Migration::Migrator.run.first
+    up, down = Generators::DeclareSchema::Migration::Migrator.run
     expect(up.gsub(/\n+/, "\n")).to eq(<<~EOS.strip)
       add_column :adverts, :title, :string, limit: 255
       add_index :adverts, [:title, :category_id], name: 'on_title_and_category_id'
@@ -550,7 +544,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
         title :string, default: "Untitled", limit: 255, null: true
       end
     end
-    up = Generators::DeclareSchema::Migration::Migrator.run.first
+    up, down = Generators::DeclareSchema::Migration::Migrator.run
     ActiveRecord::Migration.class_eval(up)
 
     class FancyAdvert < Advert
@@ -619,7 +613,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
         created_at :datetime
       end
     end
-    up = Generators::DeclareSchema::Migration::Migrator.run(adverts: :ads).first
+    up, down = Generators::DeclareSchema::Migration::Migrator.run(adverts: :ads)
     expect(up.gsub(/\n+/, "\n")).to eq(<<~EOS.strip)
       rename_table :adverts, :ads
       add_column :ads, :created_at, :datetime, null: false
@@ -688,48 +682,5 @@ RSpec.describe 'DeclareSchema Migration Generator' do
     ActiveRecord::Migration.class_eval(up)
     expect(Ad.field_specs['company'].options[:validates].inspect).to eq("{:presence=>true, :uniqueness=>{:case_sensitive=>false}}")
   end
-
-  describe 'belongs_to' do
-    before do
-      unless defined?(AdCategory)
-        class AdCategory < ActiveRecord::Base
-          fields { }
-        end
-      end
-
-      class Advert < ActiveRecord::Base
-        fields do
-          name :string, limit: 255, null: true
-          category_id :integer, limit: 8
-          nullable_category_id :integer, limit: 8, null: true
-        end
-      end
-      up = Generators::DeclareSchema::Migration::Migrator.run.first
-      ActiveRecord::Migration.class_eval(up)
-    end
-
-    it 'passes through optional:, if given' do
-      class AdvertBelongsTo < ActiveRecord::Base
-        self.table_name = 'adverts'
-        fields { }
-        reset_column_information
-        belongs_to :ad_category, optional: true
-      end
-      expect(AdvertBelongsTo.reflections['ad_category'].options).to eq(optional: true)
-    end
-
-    [false, true].each do |nullable|
-      context "nullable=#{nullable}" do
-        it 'infers the optional: argument from null: option' do
-          eval <<~EOS
-            class AdvertBelongsTo < ActiveRecord::Base
-              fields { }
-              belongs_to :ad_category, null: #{nullable}
-            end
-          EOS
-          expect(AdvertBelongsTo.reflections['ad_category'].options).to eq(optional: nullable)
-        end
-      end
-    end
-  end
 end
+

data/spec/lib/declare_schema/prepare_testapp.rb

@@ -18,8 +18,6 @@ require "#{TESTAPP_PATH}/config/environment"
 require 'rails/generators'
 Rails::Generators.configure!(Rails.application.config.generators)
 
-ActiveRecord::Base.connection.schema_cache.clear!
-
 (ActiveRecord::Base.connection.tables - Generators::DeclareSchema::Migration::Migrator.always_ignore_tables).each do |table|
   ActiveRecord::Base.connection.execute("DROP TABLE #{ActiveRecord::Base.connection.quote_table_name(table)}")
 end

data/spec/lib/generators/declare_schema/migration/migrator_spec.rb

@@ -36,6 +36,36 @@ module Generators
             end
           end
         end
+
+        describe '#before_generating_migration' do
+          it 'requires a block be passed' do
+            expect { described_class.before_generating_migration }.to raise_error(ArgumentError, 'A block is required when setting the before_generating_migration callback')
+          end
+        end
+
+        describe 'load_rails_models' do
+          before do
+            expect(Rails.application).to receive(:eager_load!)
+            expect(Rails::Engine).to receive(:subclasses).and_return([])
+          end
+
+          subject { described_class.new.load_rails_models }
+
+          context 'when a before_generating_migration callback is configured' do
+            let(:dummy_proc) { -> {} }
+
+            before do
+              described_class.before_generating_migration(&dummy_proc)
+              expect(dummy_proc).to receive(:call).and_return(true)
+            end
+
+            it { should be_truthy }
+          end
+
+          context 'when no before_generating_migration callback is configured' do
+            it { should be_nil }
+          end
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: declare_schema
 version: !ruby/object:Gem::Version
-  version: 0.3.0.pre.1
+  version: 0.3.0.pre.2
 platform: ruby
 authors:
 - Invoca Development adapted from hobo_fields by Tom Locke
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-30 00:00:00.000000000 Z
+date: 2020-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -84,7 +84,7 @@ homepage: https://github.com/Invoca/declare_schema
 licenses: []
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -100,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Database migration generator for Rails
 test_files: []