declare_schema 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0c13793a5b263a2f1134ee19168a42ceb57c472cf8fb656b8e86fcdd9500b79
-  data.tar.gz: ee92620b0a091538958957205ba940d97cd9f67bc606751cb52a8ae44370e541
+  metadata.gz: c0108465514c80103fc934c550e911b563d4f3ebe8a1ebfb3a95c7fa10ed3ee8
+  data.tar.gz: 60b586c698f62017311bef429896f79312314a61e918a1d6fb60dca60e4f6d15
 SHA512:
-  metadata.gz: 3bc0e18dd1b3a998640cc2e983c86182e19b855d8ce42b3f7233b3471a7849d0dc28fa2653d110b42d0544c513267f8066386496b1469085bb507541c068b87a
-  data.tar.gz: 34b9e31862291b85becf7eeb908c4ef1da5b29178b1ab387b35c6678680299cd921fa65b49e0ba89604518a66515092d3e7d6c38678267301c9399b4572d372e
+  metadata.gz: 2167096015bc12def6ed7f5ab3c45b1de223e79c9b3828d6a322c9a849d08534ac0551033058de9c6059733e344e7f9ab97ff152a11a67227e2490bc1726f022
+  data.tar.gz: 173f38d4d7f7aa50904422624ddcec7a65f6f2b5e534b3eab5dd6894056d6166859a332d8ad9f021d5cc14306a6c0503c6a0308491bd5cede23c01934bd7c488

data/.github/workflows/declare_schema_build.yml

@@ -10,13 +10,29 @@ jobs:
     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 ]
+        gemfile:
+        - gemfiles/rails_4_mysql.gemfile
+        - gemfiles/rails_4_sqlite.gemfile
+        - gemfiles/rails_5_mysql.gemfile
+        - gemfiles/rails_5_sqlite.gemfile
+        - gemfiles/rails_6_mysql.gemfile
+        - gemfiles/rails_6_sqlite.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 }
+        - { gemfile: gemfiles/rails_4_mysql.gemfile, ruby: 2.7.1 }
+        - { gemfile: gemfiles/rails_4_sqlite.gemfile, ruby: 2.7.1 }
+        - { gemfile: gemfiles/rails_5_mysql.gemfile, ruby: 2.4.5 }
+        - { gemfile: gemfiles/rails_5_sqlite.gemfile, ruby: 2.4.5 }
+        - { gemfile: gemfiles/rails_6_mysql.gemfile, ruby: 2.4.5 }
+        - { gemfile: gemfiles/rails_6_sqlite.gemfile, ruby: 2.4.5 }
     env:
       BUNDLE_GEMFILE: "${{ matrix.gemfile }}"
+    services:
+      mysql:
+        image: mysql:5.7
+        env:
+          MYSQL_ALLOW_EMPTY_PASSWORD: yes
+        ports:
+          - 3306:3306
     steps:
       - name: Checkout Branch
         id: checkout_branch
@@ -40,5 +56,5 @@ jobs:
           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]
+          MYSQL_PORT=3306 bundle exec rake test:prepare_testapp[force]
           bundle exec rake test:all < test_responses.txt

data/Appraisals

@@ -1,14 +1,31 @@
 # frozen_string_literal: true
 
-appraise 'rails-4' do
+appraise 'rails-4-sqlite' do
   gem 'rails', '~> 4.2'
   gem 'sqlite3', '~> 1.3.0'
 end
 
-appraise 'rails-5' do
+appraise 'rails-4-mysql' do
+  gem 'rails', '~> 4.2'
+  gem 'mysql2'
+end
+
+appraise 'rails-5-sqlite' do
+  gem 'rails', '~> 5.2'
+  gem 'sqlite3'
+end
+
+appraise 'rails-5-mysql' do
   gem 'rails', '~> 5.2'
+  gem 'mysql2'
+end
+
+appraise 'rails-6-sqlite' do
+  gem 'rails', '~> 6.1'
+  gem 'sqlite3'
 end
 
-appraise 'rails-6' do
-  gem 'rails', '~> 6.0'
+appraise 'rails-6-mysql' do
+  gem 'rails', '~> 6.1'
+  gem 'mysql2'
 end

data/CHANGELOG.md

@@ -4,6 +4,14 @@ 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.1] - 2021-01-06
+### Added
+- Added Appraisals for MySQL as well as SQLite.
+
+### Fixed
+- Fixed case where primary key index will be gone by the time we get to dropping that primary key
+because all of the existing primary key columns are being removed.
+
 ## [0.6.0] - 2020-12-23
 ### Added
 - Fields may now be declared with `:bigint` type which is identical to `:integer, limit 8`
@@ -84,6 +92,7 @@ using the appropriate Rails configuration attributes.
 ### Added
 - Initial version from https://github.com/Invoca/hobo_fields v4.1.0.
 
+[0.6.1]: https://github.com/Invoca/declare_schema/compare/v0.6.0...v0.6.1
 [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

data/Gemfile

@@ -14,10 +14,8 @@ gem 'bundler',          '< 2'
 gem "climate_control",  '~> 0.2'
 gem 'pry'
 gem 'pry-byebug'
-gem 'mysql2'
 gem 'rails',            '~> 5.2', '>= 5.2.4.3'
 gem 'responders'
 gem 'rspec'
 gem 'rubocop'
-gem 'sqlite3'
 gem 'yard'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    declare_schema (0.6.0)
+    declare_schema (0.6.1)
       rails (>= 4.2)
 
 GEM
@@ -85,7 +85,6 @@ GEM
     mini_portile2 (2.4.0)
     minitest (5.14.2)
     msgpack (1.3.3)
-    mysql2 (0.5.3)
     nio4r (2.5.4)
     nokogiri (1.10.10)
       mini_portile2 (~> 2.4.0)
@@ -167,7 +166,6 @@ GEM
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
-    sqlite3 (1.4.2)
     thor (1.0.1)
     thread_safe (0.3.6)
     tzinfo (1.2.7)
@@ -188,14 +186,12 @@ DEPENDENCIES
   climate_control (~> 0.2)
   declare_schema!
   listen
-  mysql2
   pry
   pry-byebug
   rails (~> 5.2, >= 5.2.4.3)
   responders
   rspec
   rubocop
-  sqlite3
   yard
 
 BUNDLED WITH

data/README.md

@@ -94,7 +94,7 @@ turn all tables into `utf8mb4` supporting tables:
 # frozen_string_literal: true
 
 Generators::DeclareSchema::Migration::Migrator.default_charset   = "utf8mb4"
-Generators::DeclareSchema::Migration::Migrator.default_collation = "utf8mb4_general"
+Generators::DeclareSchema::Migration::Migrator.default_collation = "utf8mb4_bin"
 ```
 
 ### Table Configuration
@@ -109,7 +109,7 @@ like the following:
 # frozen_string_literal: true
 
 class Comment < ActiveRecord::Base
-  fields charset: "utf8mb4", collation: "utf8mb4_general" do
+  fields charset: "utf8mb4", collation: "utf8mb4_bin" do
     subject :string, limit: 255
     content :text,   limit: 0xffff_ffff
   end
@@ -131,7 +131,7 @@ look like the following:
 class Comment < ActiveRecord::Base
   fields do
     subject :string, limit: 255
-    context :text,   limit: 0xffff_ffff, charset: "utf8mb4", collation: "utf8mb4_general"
+    context :text,   limit: 0xffff_ffff, charset: "utf8mb4", collation: "utf8mb4_bin"
   end
 end
 ```

data/Rakefile

@@ -30,15 +30,28 @@ namespace "test" do
     if args.force || !File.directory?(TESTAPP_PATH)
       FileUtils.remove_entry_secure(TESTAPP_PATH, true)
       sh %(#{BIN} new #{TESTAPP_PATH} --skip-wizard --skip-bundle)
-      FileUtils.chdir TESTAPP_PATH
+      FileUtils.chdir(TESTAPP_PATH)
+      begin
+        require 'mysql2'
+        if ENV['MYSQL_PORT']
+          sh "(echo 'H';
+               echo '1,$s/localhost/127.0.0.1/';
+               echo '/host:/';
+               echo 'a';
+               echo '  port: #{ENV['MYSQL_PORT']}';
+               echo '.';
+               echo w;
+               echo q) | ed #{TESTAPP_PATH}/config/database.yml || echo ed failed!"
+        end
+      rescue LoadError
+      end
       sh "bundle install"
       sh "(echo '';
-           echo \"gem 'irt', :group => :development\";
-           echo \"gem 'therubyracer'\";
-           echo \"gem 'kramdown'\") > Gemfile"
+           echo \"gem 'irb', :group => :development\") >> 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\""
+      sh "rake db:create"
       puts "The testapp has been created in '#{TESTAPP_PATH}'"
     else
       FileUtils.chdir(TESTAPP_PATH)

data/bin/declare_schema

@@ -8,4 +8,4 @@ require_relative '../lib/declare_schema/version'
 
 ARGV.freeze
 
-DeclareSchema::Command.run(:DeclareSchema, ARGV.dup, DeclareSchema::VERSION)
+DeclareSchema::Command.run('declare_schema', ARGV.dup, DeclareSchema::VERSION, path: File.expand_path('..', __dir__))

data/declare_schema.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
   s.authors = ['Invoca Development adapted from hobo_fields by Tom Locke']
   s.email = 'development@invoca.com'
   s.homepage = 'https://github.com/Invoca/declare_schema'
-  s.summary = 'Database migration generator for Rails'
+  s.summary = 'Database schema declaration and migration generator for Rails'
   s.description = 'Declare your Rails/active_record model schemas and have database migrations generated for you!'
   s.name = "declare_schema"
   s.version = DeclareSchema::VERSION

data/gemfiles/rails_4_mysql.gemfile

@@ -0,0 +1,22 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "bundler", "< 2"
+gem "climate_control", "~> 0.2"
+gem "pry"
+gem "pry-byebug"
+gem "rails", "~> 4.2"
+gem "responders"
+gem "rspec"
+gem "rubocop"
+gem "yard"
+gem "mysql2"
+
+group :testapp do
+  gem "bootsnap", ">= 1.1.0", require: false
+  gem "listen"
+end
+
+gemspec path: "../"

data/gemfiles/{rails_4.gemfile → rails_4_sqlite.gemfile}

@@ -7,13 +7,12 @@ gem "bundler", "< 2"
 gem "climate_control", "~> 0.2"
 gem "pry"
 gem "pry-byebug"
-gem "mysql2"
 gem "rails", "~> 4.2"
 gem "responders"
 gem "rspec"
 gem "rubocop"
-gem "sqlite3", "~> 1.3.0"
 gem "yard"
+gem "sqlite3", "~> 1.3.0"
 
 group :testapp do
   gem "bootsnap", ">= 1.1.0", require: false

data/gemfiles/rails_5_mysql.gemfile

@@ -0,0 +1,22 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "bundler", "< 2"
+gem "climate_control", "~> 0.2"
+gem "pry"
+gem "pry-byebug"
+gem "rails", "~> 5.2"
+gem "responders"
+gem "rspec"
+gem "rubocop"
+gem "yard"
+gem "mysql2"
+
+group :testapp do
+  gem "bootsnap", ">= 1.1.0", require: false
+  gem "listen"
+end
+
+gemspec path: "../"

data/gemfiles/{rails_5.gemfile → rails_5_sqlite.gemfile}

@@ -7,13 +7,12 @@ gem "bundler", "< 2"
 gem "climate_control", "~> 0.2"
 gem "pry"
 gem "pry-byebug"
-gem "mysql2"
 gem "rails", "~> 5.2"
 gem "responders"
 gem "rspec"
 gem "rubocop"
-gem "sqlite3"
 gem "yard"
+gem "sqlite3"
 
 group :testapp do
   gem "bootsnap", ">= 1.1.0", require: false

data/gemfiles/rails_6_mysql.gemfile

@@ -0,0 +1,22 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "bundler", "< 2"
+gem "climate_control", "~> 0.2"
+gem "pry"
+gem "pry-byebug"
+gem "rails", "~> 6.1"
+gem "responders"
+gem "rspec"
+gem "rubocop"
+gem "yard"
+gem "mysql2"
+
+group :testapp do
+  gem "bootsnap", ">= 1.1.0", require: false
+  gem "listen"
+end
+
+gemspec path: "../"

data/gemfiles/{rails_6.gemfile → rails_6_sqlite.gemfile}

@@ -7,13 +7,12 @@ gem "bundler", "< 2"
 gem "climate_control", "~> 0.2"
 gem "pry"
 gem "pry-byebug"
-gem "mysql2"
-gem "rails", "~> 6.0"
+gem "rails", "~> 6.1"
 gem "responders"
 gem "rspec"
 gem "rubocop"
-gem "sqlite3"
 gem "yard"
+gem "sqlite3"
 
 group :testapp do
   gem "bootsnap", ">= 1.1.0", require: false

data/lib/declare_schema/command.rb

@@ -16,7 +16,7 @@ module DeclareSchema
     EOS
 
     class << self
-      def run(gem, args, version)
+      def run(gem, args, version, gemfile_options = {})
         command = args.shift
 
         case command
@@ -38,10 +38,17 @@ module DeclareSchema
           end
           template_path = File.join(Dir.tmpdir, "declare_schema_app_template")
           File.open(template_path, 'w') do |file|
-            file.puts "gem '#{gem}', '>= #{version}'"
+            file.puts ["gem '#{gem}', '>= #{version}'", (gemfile_options.inspect unless gemfile_options.empty?)].compact.join(', ')
           end
           puts "Generating Rails infrastructure..."
-          system("rails new #{app_name} #{args * ' '} -m #{template_path}")
+          database_option =
+            begin
+              require 'mysql2'
+              ' -d mysql'
+            rescue LoadError
+            end
+          puts("rails new #{app_name} #{args * ' '} -m #{template_path}#{database_option}")
+          system("rails new #{app_name} #{args * ' '} -m #{template_path}#{database_option}")
           File.delete(template_path)
 
         when /^(g|generate|destroy)$/

data/lib/declare_schema/model/field_spec.rb

@@ -13,7 +13,6 @@ module DeclareSchema
       MYSQL_TEXT_LIMITS_ASCENDING = [MYSQL_TINYTEXT_LIMIT, MYSQL_TEXT_LIMIT, MYSQL_MEDIUMTEXT_LIMIT, MYSQL_LONGTEXT_LIMIT].freeze
 
       class << self
-        # method for easy stubbing in tests
         def mysql_text_limits?
           if defined?(@mysql_text_limits)
             @mysql_text_limits
@@ -59,9 +58,14 @@ module DeclareSchema
           @options = options.merge(limit: 8)
         end
 
-        unless type.in?([:text, :string])
-          @options[:collation] and raise "collation may only given for :string and :text fields"
+        if type.in?([:text, :string])
+          if ActiveRecord::Base.connection.class.name.match?(/mysql/i)
+            @options[:charset]   ||= model.table_options[:charset]   || Generators::DeclareSchema::Migration::Migrator.default_charset
+            @options[:collation] ||= model.table_options[:collation] || Generators::DeclareSchema::Migration::Migrator.default_collation
+          end
+        else
           @options[:charset]   and raise "charset may only given for :string and :text fields"
+          @options[:collation] and raise "collation may only given for :string and :text fields"
         end
       end
 
@@ -109,16 +113,12 @@ module DeclareSchema
         @options[:default]
       end
 
-      def collation
-        if ActiveRecord::Base.connection.class.name.match?(/mysql/i)
-          (@options[:collation] || model.table_options[:collation] || Generators::DeclareSchema::Migration::Migrator.default_collation).to_s
-        end
+      def charset
+        @options[:charset]
       end
 
-      def charset
-        if ActiveRecord::Base.connection.class.name.match?(/mysql/i)
-          (@options[:charset] || model.table_options[:charset] || Generators::DeclareSchema::Migration::Migrator.default_charset).to_s
-        end
+      def collation
+        @options[:collation]
       end
 
       def same_type?(col_spec)

data/lib/declare_schema/model/table_options_definition.rb

@@ -26,12 +26,14 @@ module DeclareSchema
 
         def mysql_table_options(connection, table_name)
           database = connection.current_database
-          defaults = connection.select_one(<<~EOS)
+          defaults = connection.select_one(<<~EOS) or raise "no defaults found for table #{table_name}"
             SELECT CCSA.character_set_name, CCSA.collation_name
-            FROM information_schema.`TABLES` T, information_schema.`COLLATION_CHARACTER_SET_APPLICABILITY` CCSA
-            WHERE CCSA.collation_name = T.table_collation AND
-                  T.table_schema = '#{connection.quote_string(database)}' AND
-                  T.table_name = '#{connection.quote_string(table_name)}';
+            FROM information_schema.TABLES as T
+              JOIN information_schema.COLLATION_CHARACTER_SET_APPLICABILITY as CCSA
+                ON CCSA.collation_name = T.table_collation
+            WHERE
+              T.table_schema = '#{connection.quote_string(database)}' AND
+              T.table_name = '#{connection.quote_string(table_name)}'
           EOS
 
           defaults["character_set_name"] or raise "character_set_name missing from #{defaults.inspect}"
@@ -75,7 +77,7 @@ module DeclareSchema
       alias to_s settings
 
       def alter_table_statement
-        statement = "ALTER TABLE #{ActiveRecord::Base.connection.quote_table_name(table_name)} #{to_s};"
+        statement = "ALTER TABLE #{ActiveRecord::Base.connection.quote_table_name(table_name)} #{to_s}"
         "execute #{statement.inspect}"
       end
     end