declare_schema 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59ff5d6d1a71b80a0541e2430f77665914d0c354ec92f31db8bbf22630fa5bef
-  data.tar.gz: dcaedebe325290c8c625c099b4d3cd6e2a87694f1d3cfec68811618f635715c1
+  metadata.gz: c0c13793a5b263a2f1134ee19168a42ceb57c472cf8fb656b8e86fcdd9500b79
+  data.tar.gz: ee92620b0a091538958957205ba940d97cd9f67bc606751cb52a8ae44370e541
 SHA512:
-  metadata.gz: 0a62a4236edd68e1429d4949b6745f34ed186acc24935bb027d1108b59372c0b681abc514963730c8e9e092769aa4a614a286c8815aa704a8dc24378e6cbe4ee
-  data.tar.gz: f8a9b7e40ffe14aa35e0a33d66c4e7dd820535ceacbc488bf159b386e28f5edf0d69896ff2e96a2c521e41e59c36fb9d7f47a6d1b6089a3625d8664a41be5b95
+  metadata.gz: 3bc0e18dd1b3a998640cc2e983c86182e19b855d8ce42b3f7233b3471a7849d0dc28fa2653d110b42d0544c513267f8066386496b1469085bb507541c068b87a
+  data.tar.gz: 34b9e31862291b85becf7eeb908c4ef1da5b29178b1ab387b35c6678680299cd921fa65b49e0ba89604518a66515092d3e7d6c38678267301c9399b4572d372e

data/.github/workflows/declare_schema_build.yml

@@ -0,0 +1,44 @@
+---
+on: [push]
+
+name: DeclareSchema Build
+
+jobs:
+  build:
+    name: DeclareSchema Build
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ 2.4.5, 2.5.8, 2.6.5, 2.7.1 ]
+        gemfile: [ gemfiles/rails_4.gemfile, gemfiles/rails_5.gemfile, gemfiles/rails_6.gemfile ]
+        exclude:
+          - { gemfile: gemfiles/rails_4.gemfile, ruby: 2.7.1 }
+          - { gemfile: gemfiles/rails_5.gemfile, ruby: 2.4.5 }
+          - { gemfile: gemfiles/rails_6.gemfile, ruby: 2.4.5 }
+    env:
+      BUNDLE_GEMFILE: "${{ matrix.gemfile }}"
+    steps:
+      - name: Checkout Branch
+        id: checkout_branch
+        uses: actions/checkout@v2
+      - name: Setup Ruby
+        id: setup_ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler: 1.17.3
+          ruby-version: ${{matrix.ruby}}
+      - name: Remove Bundler 2
+        id: remove_bundler_2
+        if: ${{ matrix.ruby >= '2.6.5' }}
+        run: |
+          rm -f /opt/hostedtoolcache/Ruby/2.*/x64/lib/ruby/gems/2.*/specifications/default/bundler-2.*.gemspec
+          gem install bundler:1.17.3 --force --default
+          gem install bundler -v 1.17.3
+      - name: Appraisals
+        id: appraisals
+        run: |
+          bundle install --jobs=3 --retry=3 --path=${BUNDLE_PATH:-vendor/bundle} --gemfile=${{ matrix.gemfile }}
+          git config --global user.email "dummy@example.com"
+          git config --global user.name "dummy"
+          bundle exec rake test:prepare_testapp[force]
+          bundle exec rake test:all < test_responses.txt

data/.gitignore

@@ -12,3 +12,4 @@
 
 # appraisal
 gemfiles/*.lock
+.idea

data/CHANGELOG.md

@@ -4,6 +4,17 @@ 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.6.0] - 2020-12-23
+### Added
+- Fields may now be declared with `:bigint` type which is identical to `:integer, limit 8`
+- FieldSpec#initialize interface now includes `position` keyword argument and `**options` hash.
+
+### Fixed
+- Fixed cycle in which FieldSpec#initialize was calling `model.field_specs` 
+
+### Changed
+- Changed ci support from Travis to Github Workflow
+
 ## [0.5.0] - 2020-12-21
 ### Added
 - Added support for configuring the character set and collation for MySQL databases
@@ -73,6 +84,7 @@ using the appropriate Rails configuration attributes.
 ### Added
 - Initial version from https://github.com/Invoca/hobo_fields v4.1.0.
 
+[0.6.0]: https://github.com/Invoca/declare_schema/compare/v0.5.0...v0.6.0
 [0.5.0]: https://github.com/Invoca/declare_schema/compare/v0.4.2...v0.5.0
 [0.4.2]: https://github.com/Invoca/declare_schema/compare/v0.4.1...v0.4.2
 [0.4.1]: https://github.com/Invoca/declare_schema/compare/v0.4.0...v0.4.1

data/Gemfile.lock

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

data/lib/declare_schema/model.rb

@@ -88,7 +88,7 @@ module DeclareSchema
         add_formatting_for_field(name, type)
         add_validations_for_field(name, type, args, options)
         add_index_for_field(name, args, options)
-        field_specs[name] = ::DeclareSchema::Model::FieldSpec.new(self, name, type, options)
+        field_specs[name] = ::DeclareSchema::Model::FieldSpec.new(self, name, type, position: field_specs.size, **options)
         attr_order << name unless attr_order.include?(name)
       end
 

data/lib/declare_schema/model/field_spec.rb

@@ -33,7 +33,8 @@ module DeclareSchema
 
       attr_reader :model, :name, :type, :position, :options
 
-      def initialize(model, name, type, options = {})
+      def initialize(model, name, type, position: 0, **options)
+        # TODO: TECH-5116
         # Invoca change - searching for the primary key was causing an additional database read on every model load.  Assume
         # "id" which works for invoca.
         # raise ArgumentError, "you cannot provide a field spec for the primary key" if name == model.primary_key
@@ -43,9 +44,8 @@ module DeclareSchema
         @name = name.to_sym
         type.is_a?(Symbol) or raise ArgumentError, "type must be a Symbol; got #{type.inspect}"
         @type = type
-        position_option = options.delete(:position)
+        @position = position
         @options = options
-
         case type
         when :text
           @options[:default] and raise "default may not be given for :text field #{model}##{@name}"
@@ -54,11 +54,15 @@ module DeclareSchema
           end
         when :string
           @options[:limit] or raise "limit must be given for :string field #{model}##{@name}: #{@options.inspect}; do you want `limit: 255`?"
-        else
+        when :bigint
+          @type = :integer
+          @options = options.merge(limit: 8)
+        end
+
+        unless type.in?([:text, :string])
           @options[:collation] and raise "collation may only given for :string and :text fields"
           @options[:charset]   and raise "charset may only given for :string and :text fields"
         end
-        @position = position_option || model.field_specs.length
       end
 
       TYPE_SYNONYMS = { timestamp: :datetime }.freeze

data/lib/declare_schema/version.rb

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

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

@@ -37,11 +37,9 @@ module Generators
 
         def field_specs
           i = 0
-          foreign_keys.reduce({}) do |h, v|
-            # some trickery to avoid an infinite loop when FieldSpec#initialize tries to call model.field_specs
-            h[v] = ::DeclareSchema::Model::FieldSpec.new(self, v, :integer, position: i, null: false)
+          foreign_keys.each_with_object({}) do |v, result|
+            result[v] = ::DeclareSchema::Model::FieldSpec.new(self, v, :integer, position: i, null: false)
             i += 1
-            h
           end
         end
 

data/spec/lib/declare_schema/field_spec_spec.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+RSpec.describe 'DeclareSchema Model FieldSpec' do
+  before do
+    load File.expand_path('prepare_testapp.rb', __dir__)
+  end
+
+  context 'There are no model columns to change' do
+    it '#different_to should return false for int8 == int8' do
+      subject = DeclareSchema::Model::FieldSpec.new(Object, :price, :integer, limit: 8, null: false, position: 0)
+
+      case Rails::VERSION::MAJOR
+      when 4
+        cast_type = ActiveRecord::Type::Integer.new(limit: 8)
+        col = ActiveRecord::ConnectionAdapters::Column.new("price", nil, cast_type, "integer(8)", false)
+      else
+        sql_type_metadata = ActiveRecord::ConnectionAdapters::SqlTypeMetadata.new(sql_type: "integer(8)", type: :integer, limit: 8)
+        col = ActiveRecord::ConnectionAdapters::Column.new("price", nil, sql_type_metadata, false, "adverts")
+      end
+
+      expect(subject.different_to?(subject.name, col)).to eq(false)
+    end
+
+    it '#different_to should return false for bigint == bigint' do
+      subject = DeclareSchema::Model::FieldSpec.new(Object, :price, :bigint, null: false, position: 0)
+
+      case Rails::VERSION::MAJOR
+      when 4
+        cast_type = ActiveRecord::Type::BigInteger.new(limit: 8)
+        col = ActiveRecord::ConnectionAdapters::Column.new("price", nil, cast_type, "bigint(20)", false)
+      else
+        sql_type_metadata = ActiveRecord::ConnectionAdapters::SqlTypeMetadata.new(sql_type: "bigint(20)", type: :integer, limit: 8)
+        col = ActiveRecord::ConnectionAdapters::Column.new("price", nil, sql_type_metadata, false, "adverts")
+      end
+
+      expect(subject.different_to?(subject.name, col)).to eq(false)
+    end
+
+    it '#different_to should return false for int8 == bigint' do
+      subject = DeclareSchema::Model::FieldSpec.new(Object, :price, :integer, limit: 8, null: false, position: 0)
+
+      case Rails::VERSION::MAJOR
+      when 4
+        cast_type = ActiveRecord::Type::BigInteger.new(limit: 8)
+        col = ActiveRecord::ConnectionAdapters::Column.new("price", nil, cast_type, "bigint(20)", false)
+      else
+        sql_type_metadata = ActiveRecord::ConnectionAdapters::SqlTypeMetadata.new(sql_type: "bigint(20)", type: :integer, limit: 8)
+        col = ActiveRecord::ConnectionAdapters::Column.new("price", nil, sql_type_metadata, false, "adverts")
+      end
+
+      expect(subject.different_to?(subject.name, col)).to eq(false)
+    end
+
+    it '#different_to should return false for bigint == int8' do
+      subject = DeclareSchema::Model::FieldSpec.new(Object, :price, :bigint, null: false, position: 0)
+
+      case Rails::VERSION::MAJOR
+      when 4
+        cast_type = ActiveRecord::Type::Integer.new(limit: 8)
+        col = ActiveRecord::ConnectionAdapters::Column.new("price", nil, cast_type, "integer(8)", false)
+      else
+        sql_type_metadata = ActiveRecord::ConnectionAdapters::SqlTypeMetadata.new(sql_type: "integer(8)", type: :integer, limit: 8)
+        col = ActiveRecord::ConnectionAdapters::Column.new("price", nil, sql_type_metadata, false, "adverts")
+      end
+
+      expect(subject.different_to?(subject.name, col)).to eq(false)
+    end
+  end
+end

data/spec/lib/declare_schema/migration_generator_spec.rb

@@ -1093,4 +1093,29 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       expect(base_class).to eq("(Rails::VERSION::MAJOR >= 5 ? ActiveRecord::Migration[4.2] : ActiveRecord::Migration)")
     end
   end
+
+  context 'Does not generate migrations' do
+    it 'for aliased fields bigint -> integer limit 8' do
+      if Rails::VERSION::MAJOR >= 5 || !ActiveRecord::Base.connection.class.name.match?(/SQLite3Adapter/)
+        class Advert < active_record_base_class.constantize
+          fields do
+            price :bigint
+          end
+        end
+
+        generate_migrations '-n', '-m'
+
+        migrations = Dir.glob('db/migrate/*declare_schema_migration*.rb')
+        expect(migrations.size).to eq(1), migrations.inspect
+
+        class Advert < active_record_base_class.constantize
+          fields do
+            price :integer, limit: 8
+          end
+        end
+
+        expect { generate_migrations '-n', '-g' }.to output("Database and models match -- nothing to change\n").to_stdout
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: declare_schema
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Invoca Development adapted from hobo_fields by Tom Locke
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-21 00:00:00.000000000 Z
+date: 2020-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -33,12 +33,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/dependabot.yml"
+- ".github/workflows/declare_schema_build.yml"
 - ".github/workflows/gem_release.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
-- ".travis.yml"
 - Appraisals
 - CHANGELOG.md
 - Gemfile
@@ -75,6 +75,7 @@ files:
 - lib/generators/declare_schema/support/thor_shell.rb
 - spec/lib/declare_schema/api_spec.rb
 - spec/lib/declare_schema/field_declaration_dsl_spec.rb
+- spec/lib/declare_schema/field_spec_spec.rb
 - spec/lib/declare_schema/generator_spec.rb
 - spec/lib/declare_schema/interactive_primary_key_spec.rb
 - spec/lib/declare_schema/migration_generator_spec.rb

data/.travis.yml

@@ -1,37 +0,0 @@
----
-dist: trusty
-os: linux
-language: ruby
-cache: bundler
-rvm:
-  - 2.4.5
-  - 2.5.8
-  - 2.6.5
-  - 2.7.1
-  - ruby-head
-gemfile:
-  - gemfiles/rails_4.gemfile
-  - gemfiles/rails_5.gemfile
-  - gemfiles/rails_6.gemfile
-jobs:
-  fast_finish: false
-  exclude:
-    - gemfile: gemfiles/rails_4.gemfile
-      rvm: 2.7.1
-    - gemfile: gemfiles/rails_5.gemfile
-      rvm: 2.4.5
-    - gemfile: gemfiles/rails_6.gemfile
-      rvm: 2.4.5
-  allow_failures:
-    - rvm: ruby-head
-before_install:
-  - rm -f /home/travis/.rvm/rubies/ruby-2.*/lib/ruby/gems/2.*/specifications/default/bundler-2.*.gemspec
-  - echo y | rvm @global do gem install bundler -v 1.17.3 --force --default
-  - gem install bundler -v 1.17.3 --force --default
-  - gem install bundler -v 1.17.3
-install:
-  - bundle --version
-  - bundle install --jobs=3 --retry=3 --path=${BUNDLE_PATH:-vendor/bundle}
-script:
-  - bundle exec rake test:prepare_testapp[force]
-  - bundle exec rake test:all < test_responses.txt