declare_schema 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cf5ebc856041d2f6a90e4a6f30a56e5a538545f79b227cd2ca691eb99dcf9a8
-  data.tar.gz: 3d2b3efe4d0647f8c94052e2e8a22433a021503f458203e9f0f73d131d7c6225
+  metadata.gz: 3f3116a6fbb5a47de5809f3f813c88783284bad601452679fa59784f3598834b
+  data.tar.gz: 8f4b6fee7b4d17e5b644f32a4b624a3f77526f91826a8c0b82d61b6e25130332
 SHA512:
-  metadata.gz: 4771090d9ef1dbe0267eddfa4ac7d2fc25dd37a9c75a8e76bdb27ea9a072aac894671dc8115387eb9489855f6849ff7cf4c1f2f4e82eb36039824fd83328f2f3
-  data.tar.gz: 7fc9feb7d02f2b71f11ec4c21f3624c3dc503df64c443f304b1d19f75d6a81102a86d0b27be3c32749a191f966440a88c54c86db260123cd2e6457bdacd474cf
+  metadata.gz: b833000d28d64e7856de05c9ae822c88dcceeb7861f777f13177ea8017e56bf937aba42b9da14ae1ce4810fd275c5462cb08c18c32839255ab46f1de116eee1d
+  data.tar.gz: c41c8cbdafd96eeb92fcf5c646ff9d18f4ce2374f06ecc6977015fa8406bc4639ab3722354212d1a75274c5af982f10b6c2f4c838de94f4b9436da20f836d5d3

data/.travis.yml

@@ -0,0 +1,37 @@
+---
+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

data/CHANGELOG.md

@@ -1,11 +1,35 @@
-# CHANGELOG for `declarative_schema`
+# CHANGELOG for `declare_schema`
 
 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.0] - Unreleased
+## [0.2.0] - 2020-10-26
 ### Added
-- Initial version from https://github.com/Invoca/declare_schema v4.0.0.
+- Automatically eager_load! all Rails::Engines before generating migrations.
 
-[0.1.0]: https://github.com/Invoca/declarative_schema/tree/v0.1.0
+### 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.
+
+## [0.1.2] - 2020-09-29
+### Changed
+- Added travis support and created 2 specs as a starting point.
+
+
+## [0.1.1] - 2020-09-24
+### Added
+- Initial version from https://github.com/Invoca/hobo_fields v4.1.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

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 source 'https://rubygems.org'
-source 'https://gem.fury.io/invoca'
 
 gemspec
 
@@ -19,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,12 +1,11 @@
 PATH
   remote: .
   specs:
-    declare_schema (0.1.0)
+    declare_schema (0.2.0)
       rails (>= 4.2)
 
 GEM
   remote: https://rubygems.org/
-  remote: https://gem.fury.io/invoca/
   specs:
     actioncable (5.2.4.4)
       actionpack (= 5.2.4.4)
@@ -160,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)
@@ -195,7 +193,6 @@ DEPENDENCIES
   responders
   rspec
   rubocop
-  rubydoctest
   sqlite3
   yard
 

data/README.md

@@ -1,11 +1,68 @@
 # DeclareSchema
 
-Declare your active_record model schemas and have database migrations generated for you!
+Declare your Rails/active_record model schemas and have database migrations generated for you!
 
+## Example
+
+Make a model and declare your schema within a `fields do ... end` block:
+```ruby
+class Company < ActiveRecord::Base
+  fields do
+    company_name :string, limit: 100
+    ticker_symbol :string, limit: 4, null: true, index: true, unique: true
+    employee_count :integer
+    comments :text
+
+    timestamps
+  end
+
+  belongs_to :industry
+end
+```
+Then generate the migration:
+```sh
+$ rails generate declare_schema:migration
+
+---------- Up Migration ----------
+create_table :companies, id: :bigint do |t|
+  t.string   :company_name, null: false, limit: 100
+  t.string   :ticker_symbol, limit: 4
+  t.integer  :employee_count, null: false
+  t.text     :comments, null: false
+  t.datetime :created_at
+  t.datetime :updated_at
+  t.integer  :industry_id, null: false
+end
+add_index :companies, [:ticker_symbol], unique: true, name: 'on_ticker_symbol'
+add_index :companies, [:industry_id], name: 'on_industry_id'
+execute "ALTER TABLE companies ADD CONSTRAINT index_companies_on_industry_id FOREIGN KEY index_companies_on_industry_id(industry_id) REFERENCES industries(id) "
+----------------------------------
+
+---------- Down Migration --------
+drop_table :companies
+----------------------------------
+
+
+What now: [g]enerate migration, generate and [m]igrate now or [c]ancel?  g
+  => "g"
+
+Migration filename: [<enter>=declare_schema_migration_1|<custom_name>]: add_company_model
+```
+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.
+
+## Installing
+
+Install the `DeclareSchema` gem directly:
+```
+  $ gem install declare_schema
+```
+or add it to your `bundler` Gemfile:
+```
+  gem 'declare_schema'
+```
 ## Testing
 To run tests:
 ```
 rake test:prepare_testapp[force]
 rake test:all < test_responses.txt
 ```
-(Note: there currently are no unit tests. The above will run the `rdoctests`.)

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} #{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

@@ -1,25 +1,22 @@
-# frozen_string_literal: true
-
 # This file was generated by Appraisal
 
 source "https://rubygems.org"
-source "https://gem.fury.io/invoca"
 
 gem "appraisal"
+gem "bundler", "< 2"
+gem "climate_control", "~> 0.2"
 gem "pry"
 gem "pry-byebug"
 gem "rails", "~> 4.2"
 gem "responders"
-gem "rubydoctest"
+gem "rspec"
+gem "rubocop"
 gem "sqlite3", "~> 1.3.0"
-gem "test_overrides"
 gem "yard"
 
 group :testapp do
   gem "bootsnap", ">= 1.1.0", require: false
-  gem "kramdown"
   gem "listen"
-  gem "RedCloth"
 end
 
 gemspec path: "../"

data/gemfiles/rails_5.gemfile

@@ -1,25 +1,22 @@
-# frozen_string_literal: true
-
 # This file was generated by Appraisal
 
 source "https://rubygems.org"
-source "https://gem.fury.io/invoca"
 
 gem "appraisal"
+gem "bundler", "< 2"
+gem "climate_control", "~> 0.2"
 gem "pry"
 gem "pry-byebug"
 gem "rails", "~> 5.2"
 gem "responders"
-gem "rubydoctest"
+gem "rspec"
+gem "rubocop"
 gem "sqlite3"
-gem "test_overrides"
 gem "yard"
 
 group :testapp do
   gem "bootsnap", ">= 1.1.0", require: false
-  gem "kramdown"
   gem "listen"
-  gem "RedCloth"
 end
 
 gemspec path: "../"

data/gemfiles/rails_6.gemfile

@@ -1,25 +1,22 @@
-# frozen_string_literal: true
-
 # This file was generated by Appraisal
 
 source "https://rubygems.org"
-source "https://gem.fury.io/invoca"
 
 gem "appraisal"
+gem "bundler", "< 2"
+gem "climate_control", "~> 0.2"
 gem "pry"
 gem "pry-byebug"
 gem "rails", "~> 6.0"
 gem "responders"
-gem "rubydoctest"
+gem "rspec"
+gem "rubocop"
 gem "sqlite3"
-gem "test_overrides"
 gem "yard"
 
 group :testapp do
   gem "bootsnap", ">= 1.1.0", require: false
-  gem "kramdown"
   gem "listen"
-  gem "RedCloth"
 end
 
 gemspec path: "../"

data/lib/declare_schema/model.rb

@@ -117,7 +117,6 @@ module DeclareSchema
         end
         column_options = {}
         column_options[:null] = options.delete(:null) || false
-        column_options[:comment] = options.delete(:comment) if options.has_key?(:comment)
         column_options[:default] = options.delete(:default) if options.has_key?(:default)
         column_options[:limit] = options.delete(:limit) if options.has_key?(:limit)
 

data/lib/declare_schema/model/field_spec.rb

@@ -41,7 +41,8 @@ module DeclareSchema
 
         @model = model
         @name = name.to_sym
-        @type = type.is_a?(String) ? type.to_sym : type
+        type.is_a?(Symbol) or raise ArgumentError, "type must be a Symbol; got #{type.inspect}"
+        @type = type
         position_option = options.delete(:position)
         @options = options
 
@@ -52,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
@@ -72,7 +73,7 @@ module DeclareSchema
                                   type
                                 else
                                   field_class = DeclareSchema.to_class(type)
-                                  field_class && field_class::COLUMN_TYPE or raise UnknownSqlTypeError, "#{type.inspect} for #{model}.#{@name}"
+                                  field_class && field_class::COLUMN_TYPE or raise UnknownSqlTypeError, "#{type.inspect} for #{model}##{@name}"
                                 end
                               end
       end
@@ -101,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
@@ -114,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.0"
+  VERSION = "0.2.0"
 end

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

@@ -3,6 +3,7 @@
 require 'rails/generators/migration'
 require 'rails/generators/active_record'
 require 'generators/declare_schema/support/thor_shell'
+require 'declare_schema/model/field_spec'
 
 module DeclareSchema
   class MigrationGenerator < Rails::Generators::Base
@@ -85,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
@@ -117,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
 
@@ -138,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
@@ -150,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
@@ -182,3 +181,11 @@ module DeclareSchema
     end
   end
 end
+
+module Generators
+  module DeclareSchema
+    module Migration
+      MigrationGenerator = ::DeclareSchema::MigrationGenerator
+    end
+  end
+end