declare_schema 0.3.0.pre.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3364c39b6579bb69804417a10b5b287208e6fdfe5a23bf57b6b3f928f69fe539
-  data.tar.gz: 2fbc6abab32d750ef1af34d6888b5954ee27da2563acd8595728d3d23d184244
+  metadata.gz: f3ae0814480b116b32a822887c83612b33458cc910384ae0c2122e547757f141
+  data.tar.gz: 133b7bd6d7d91dae9320a4e8002a8591e43ebb97f57013cbe266cef40a169088
 SHA512:
-  metadata.gz: 7e884c085c0d72f1146d7b7f52abbf1f44b19389e2f96e2858b855b11041c94406b0be159a300366d0abeec2f36cf9056d3eddd61352600c780a992ca3971817
-  data.tar.gz: 1d45f652bd8d0de74b71fec913c4005be8f3212de7fa7942ad587d67059f67115ce8d797be9d71121e792ab66aee84c2adaaa013766b6d96cb21eda1d35522b4
+  metadata.gz: 77b840eb5feb07d38c4fd96f4212d4c81f19c61a2aa2b4bbffb4f4f11594ba55c30e65ca4b77a68e7b29448f7762dba52782f1845307c5bbc02f7603f080c2e8
+  data.tar.gz: 2f85affbd44a6973595883afa01766ede6c950a70c4e783f3064e5c2a59ec5c71a3731d7d484bab133c18c698584077e2c14a8b98c81ce024e2e55bae59dabba

data/CHANGELOG.md

@@ -4,10 +4,19 @@ 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.3.0] - 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

data/Gemfile.lock

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

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, &block)
         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,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/version.rb

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

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/migration_generator_spec.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'rails'
+
 RSpec.describe 'DeclareSchema Migration Generator' do
   before do
     load File.expand_path('prepare_testapp.rb', __dir__)
@@ -53,7 +55,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
       add_index :adverts, [:id], unique: true, name: 'PRIMARY_KEY'
     EOS
-    # TODO: ^ add_index should not be there?
+    # TODO: ^ TECH-4975 add_index should not be there
 
     expect(down).to eq(<<~EOS.strip)
       remove_column :adverts, :body
@@ -129,7 +131,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       end
     end
 
-    up, down = Generators::DeclareSchema::Migration::Migrator.run
+    up = Generators::DeclareSchema::Migration::Migrator.run.first
     expect(up).to eq("add_column :adverts, :price, :integer, limit: 2")
 
     # Now run the migration, then change the limit:
@@ -154,7 +156,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       end
     end
 
-    up, down = Generators::DeclareSchema::Migration::Migrator.run
+    up = Generators::DeclareSchema::Migration::Migrator.run.first
     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 +172,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       end
     end
 
-    up, down = Generators::DeclareSchema::Migration::Migrator.run
+    up = Generators::DeclareSchema::Migration::Migrator.run.first
     expect(up).to eq(<<~EOS.strip)
       add_column :adverts, :price, :decimal
       add_column :adverts, :notes, :text, null: false
@@ -194,7 +196,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       end
     end
 
-    up, down = Generators::DeclareSchema::Migration::Migrator.run
+    up = Generators::DeclareSchema::Migration::Migrator.run.first
     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 +268,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       end
     end
 
-    up, down = Generators::DeclareSchema::Migration::Migrator.run
+    up = Generators::DeclareSchema::Migration::Migrator.run.first
     ActiveRecord::Migration.class_eval up
     Advert.connection.schema_cache.clear!
     Advert.reset_column_information
@@ -278,6 +280,9 @@ 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
 
@@ -298,9 +303,10 @@ 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, down = Generators::DeclareSchema::Migration::Migrator.run
+    up = Generators::DeclareSchema::Migration::Migrator.run.first
     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'
@@ -313,9 +319,10 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
     class Category < ActiveRecord::Base; end
     class Advert < ActiveRecord::Base
+      fields { }
       belongs_to :category, index: false
     end
-    up, down = Generators::DeclareSchema::Migration::Migrator.run
+    up = Generators::DeclareSchema::Migration::Migrator.run.first
     expect(up.gsub(/\n+/, "\n")).to eq("add_column :adverts, :category_id, :integer, limit: 8, null: false")
 
     Advert.field_specs.delete(:category_id)
@@ -325,9 +332,10 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
     class Category < ActiveRecord::Base; end
     class Advert < ActiveRecord::Base
+      fields { }
       belongs_to :category, index: 'my_index'
     end
-    up, down = Generators::DeclareSchema::Migration::Migrator.run
+    up = Generators::DeclareSchema::Migration::Migrator.run.first
     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'
@@ -372,7 +380,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
         title :string, index: true, limit: 255, null: true
       end
     end
-    up, down = Generators::DeclareSchema::Migration::Migrator.run
+    up = Generators::DeclareSchema::Migration::Migrator.run.first
     expect(up.gsub(/\n+/, "\n")).to eq(<<~EOS.strip)
       add_column :adverts, :title, :string, limit: 255
       add_index :adverts, [:title], name: 'on_title'
@@ -387,7 +395,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
         title :string, index: true, unique: true, null: true, limit: 255
       end
     end
-    up, down = Generators::DeclareSchema::Migration::Migrator.run
+    up = Generators::DeclareSchema::Migration::Migrator.run.first
     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'
@@ -402,20 +410,20 @@ RSpec.describe 'DeclareSchema Migration Generator' do
         title :string, index: 'my_index', limit: 255, null: true
       end
     end
-    up, down = Generators::DeclareSchema::Migration::Migrator.run
+    up = Generators::DeclareSchema::Migration::Migrator.run.first
     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, down = Generators::DeclareSchema::Migration::Migrator.run
+    up = Generators::DeclareSchema::Migration::Migrator.run.first
     expect(up.gsub(/\n+/, "\n")).to eq(<<~EOS.strip)
       add_column :adverts, :title, :string, limit: 255
       add_index :adverts, [:title], name: 'on_title'
@@ -428,7 +436,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
     class Advert < ActiveRecord::Base
       index :title, unique: true, name: 'my_index'
     end
-    up, down = Generators::DeclareSchema::Migration::Migrator.run
+    up = Generators::DeclareSchema::Migration::Migrator.run.first
     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'
@@ -441,7 +449,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
     class Advert < ActiveRecord::Base
       index [:title, :category_id]
     end
-    up, down = Generators::DeclareSchema::Migration::Migrator.run
+    up = Generators::DeclareSchema::Migration::Migrator.run.first
     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'
@@ -544,7 +552,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
         title :string, default: "Untitled", limit: 255, null: true
       end
     end
-    up, down = Generators::DeclareSchema::Migration::Migrator.run
+    up = Generators::DeclareSchema::Migration::Migrator.run.first
     ActiveRecord::Migration.class_eval(up)
 
     class FancyAdvert < Advert
@@ -613,7 +621,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
         created_at :datetime
       end
     end
-    up, down = Generators::DeclareSchema::Migration::Migrator.run(adverts: :ads)
+    up = Generators::DeclareSchema::Migration::Migrator.run(adverts: :ads).first
     expect(up.gsub(/\n+/, "\n")).to eq(<<~EOS.strip)
       rename_table :adverts, :ads
       add_column :ads, :created_at, :datetime, null: false
@@ -682,5 +690,106 @@ 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
-end
 
+  if Rails::VERSION::MAJOR >= 5
+    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: when 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
+
+      describe 'contradictory settings' do # contradictory settings are ok during migration
+        it 'passes through optional: true, null: false' do
+          class AdvertBelongsTo < ActiveRecord::Base
+            self.table_name = 'adverts'
+            fields { }
+            reset_column_information
+            belongs_to :ad_category, optional: true, null: false
+          end
+          expect(AdvertBelongsTo.reflections['ad_category'].options).to eq(optional: true)
+          expect(AdvertBelongsTo.field_specs['ad_category_id'].options&.[](:null)).to eq(false)
+        end
+
+        it 'passes through optional: false, null: true' do
+          class AdvertBelongsTo < ActiveRecord::Base
+            self.table_name = 'adverts'
+            fields { }
+            reset_column_information
+            belongs_to :ad_category, optional: false, null: true
+          end
+          expect(AdvertBelongsTo.reflections['ad_category'].options).to eq(optional: false)
+          expect(AdvertBelongsTo.field_specs['ad_category_id'].options&.[](:null)).to eq(true)
+        end
+      end
+
+      [false, true].each do |nullable|
+        context "nullable=#{nullable}" do
+          it 'infers optional: from null:' 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)
+            expect(AdvertBelongsTo.field_specs['ad_category_id'].options&.[](:null)).to eq(nullable)
+          end
+
+          it 'infers null: from optional:' do
+            eval <<~EOS
+              class AdvertBelongsTo < ActiveRecord::Base
+                fields { }
+                belongs_to :ad_category, optional: #{nullable}
+              end
+            EOS
+            expect(AdvertBelongsTo.reflections['ad_category'].options).to eq(optional: nullable)
+            expect(AdvertBelongsTo.field_specs['ad_category_id'].options&.[](:null)).to eq(nullable)
+          end
+        end
+      end
+    end
+  end
+
+  describe 'migration base class' do
+    it 'adapts to Rails 4' do
+      class Advert < active_record_base_class.constantize
+        fields do
+          title :string, limit: 100
+        end
+      end
+
+      Rails::Generators.invoke('declare_schema:migration', %w[-n -m])
+
+      migrations = Dir.glob('db/migrate/*declare_schema_migration*.rb')
+      expect(migrations.size).to eq(1), migrations.inspect
+
+      migration_content = File.read(migrations.first)
+      first_line = migration_content.split("\n").first
+      base_class = first_line.split(' < ').last
+      expect(base_class).to eq("(Rails::VERSION::MAJOR >= 5 ? ActiveRecord::Migration[4.2] : ActiveRecord::Migration)")
+    end
+  end
+end

data/spec/lib/declare_schema/prepare_testapp.rb

@@ -18,6 +18,8 @@ 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

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: declare_schema
 version: !ruby/object:Gem::Version
-  version: 0.3.0.pre.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Invoca Development adapted from hobo_fields by Tom Locke
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
 date: 2020-11-02 00:00:00.000000000 Z
@@ -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: []