migration_comments 0.3.2 → 0.4.0

data/test/annotate_models_test.rb

@@ -6,7 +6,7 @@ class Sample < ActiveRecord::Base
   self.table_name = 'sample'
 end
 
-class AnnotateModelsTest < Minitest::Unit::TestCase
+class AnnotateModelsTest < Minitest::Test
   include TestHelper
 
   TEST_PREFIX = "== Schema Information"
@@ -19,17 +19,19 @@ class AnnotateModelsTest < Minitest::Unit::TestCase
     end
 
     result = AnnotateModels.get_schema_info(Sample, TEST_PREFIX)
+
+    string_token = ENV['DB'] == 'mysql' ? ':string(255)' : ':string     '
+
     expected = <<EOS
 # #{TEST_PREFIX}
 #
 # Table name: sample # a table comment
 #
 #  id     :integer          not null, primary key
-#  field1 :string(255)                            # a "comment" \\ that ' needs; escaping''
+#  field1 #{string_token}                            # a "comment" \\ that ' needs; escaping''
 #  field2 :integer
-#  field3 :string(255)      default(""), not null # third column comment
+#  field3 #{string_token}      default(""), not null # third column comment
 #
-
 EOS
     assert_equal expected, result
   end

data/test/auto_increment_test.rb

@@ -4,14 +4,14 @@ class Sample < ActiveRecord::Base
   self.table_name = 'sample'
 end
 
-class AutoIncrementTest < Minitest::Unit::TestCase
+class AutoIncrementTest < Minitest::Test
   include TestHelper
 
   def test_basic_table_creation
     assert_auto_increments
   end
 
-  def test_modified_primary_key
+  def test_modified_primary_key_with_auto_increment
     comment_text = "a comment on the sample table in the primary_key field"
     result_comment = nil
     ActiveRecord::Schema.define do
@@ -22,16 +22,38 @@ class AutoIncrementTest < Minitest::Unit::TestCase
     assert_equal comment_text, result_comment
   end
 
+  def test_modified_primary_key_without_auto_increment
+    comment_text = "a comment on the sample table in the primary_key field"
+    result_comment = nil
+    ActiveRecord::Schema.define do
+      change_column :sample, :id, :integer, auto_increment: false
+      set_column_comment :sample, :id, comment_text
+      result_comment = retrieve_column_comment :sample, :id
+    end
+    assert_does_not_auto_increment
+    assert_equal comment_text, result_comment
+  end
+
   private
+
+  def assert_does_not_auto_increment
+    if ENV['DB'] == 'mysql'
+      extra = extract_extra_attributes('id')
+      refute_match(/auto_increment/i, extra)
+    end
+
+    id = nil
+    ActiveRecord::Base.connection.instance_eval do
+      execute "INSERT INTO #{quote_table_name :sample} (#{quote_column_name :id}, #{quote_column_name :field1}, #{quote_column_name :field2}) VALUES (15, 'text3', 11)"
+      id = select_value("SELECT #{quote_column_name :id} FROM #{quote_table_name :sample}").to_i
+    end
+    assert_equal 15, id
+  end
+
   def assert_auto_increments
     if ENV['DB'] == 'mysql'
-      extra = nil
-      ActiveRecord::Base.connection.instance_eval do
-        execute_and_free("SHOW FULL FIELDS FROM #{quote_table_name :sample}") do |result|
-          extra = each_hash(result).detect{|field| field[:Field] == 'id'}[:Extra]
-        end
-      end
-      assert_match /auto_increment/i, extra
+      extra = extract_extra_attributes('id')
+      assert_match(/auto_increment/i, extra)
     end
 
     ids = []
@@ -45,4 +67,12 @@ class AutoIncrementTest < Minitest::Unit::TestCase
 
     assert_equal Sample.count, 3
   end
+
+  def extract_extra_attributes(field_name)
+    ActiveRecord::Base.connection.instance_eval do
+      execute_and_free("SHOW FULL FIELDS FROM #{quote_table_name :sample}") do |result|
+        each_hash(result).detect{|field| field[:Field] == field_name}[:Extra]
+      end
+    end
+  end
 end

data/test/config/database.yml

@@ -8,8 +8,8 @@ postgres:
 mysql:
   adapter: mysql2
   database: migration_comments_test
-  user: root
-  password: password
+  username: root
+  password:
 
 sqlite:
   adapter: sqlite3

data/test/primary_uuid_test.rb

@@ -0,0 +1,27 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class PrimaryUuidTest < Minitest::Test
+  include TestHelper
+
+  class Sample2 < ActiveRecord::Base
+    self.table_name = 'sample2'
+  end
+
+  def test_rails_4_uuid
+    return unless ENV['DB'] == 'postgres'
+    uuid = nil
+    ActiveRecord::Schema.define do
+      begin
+        enable_extension 'uuid-ossp'
+        create_table :sample2, id: :uuid do |t|
+          t.integer :field1
+          t.string :field2
+        end
+        uuid = Sample2.create(field1: 1, field2: 'foo').id
+      ensure
+        drop_table :sample2 rescue nil
+      end
+    end
+    assert_match /[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}/i, uuid
+  end
+end

data/test/schema_dumper_test.rb

@@ -1,6 +1,6 @@
 require File.join(File.dirname(__FILE__), 'test_helper')
 
-class SchemaDumperTest < Minitest::Unit::TestCase
+class SchemaDumperTest < Minitest::Test
   include TestHelper
   include MigrationComments::SchemaFormatter
 
@@ -14,14 +14,32 @@ class SchemaDumperTest < Minitest::Unit::TestCase
     ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, dest)
     dest.rewind
     result = dest.read
-    expected = <<EOS
-  create_table "sample", #{render_kv_pair(:force, true)}, #{render_kv_pair(:comment, "a table comment")} do |t|
-    t.string  "field1", __SPACES__#{render_kv_pair(:comment, %{a \"comment\" \\ that ' needs; escaping''})}
+    expected = if ENV['DB'] == 'mysql' && ::ActiveRecord::VERSION::MAJOR >= 5
+      <<-EOS
+  create_table "sample", force: :cascade, options: __OPTIONS__, comment: "a table comment" do |t|
+    t.string  "field1",                           #{render_kv_pair(:comment, %{a \"comment\" \\ that ' needs; escaping''})}
     t.integer "field2"
     t.string  "field3", #{render_kv_pair(:default, "")}, #{render_kv_pair(:null, false)}, #{render_kv_pair(:comment, "third column comment")}
   end
-EOS
-    assert_match /#{Regexp.escape(expected).gsub(/__SPACES__/, " +")}/, result
+      EOS
+    elsif ENV['DB'] == 'mysql'
+      <<-EOS
+  create_table "sample", force: :cascade, comment: "a table comment" do |t|
+    t.string  "field1", #{render_kv_pair(:limit, 255)},                           #{render_kv_pair(:comment, %{a \"comment\" \\ that ' needs; escaping''})}
+    t.integer "field2", #{render_kv_pair(:limit, 4)}
+    t.string  "field3", #{render_kv_pair(:limit, 255)}, #{render_kv_pair(:default, "")}, #{render_kv_pair(:null, false)}, #{render_kv_pair(:comment, "third column comment")}
+  end
+      EOS
+    else
+      <<-EOS
+  create_table "sample", force: :cascade, comment: "a table comment" do |t|
+    t.string  "field1",                           #{render_kv_pair(:comment, %{a \"comment\" \\ that ' needs; escaping''})}
+    t.integer "field2"
+    t.string  "field3", #{render_kv_pair(:default, "")}, #{render_kv_pair(:null, false)}, #{render_kv_pair(:comment, "third column comment")}
+  end
+      EOS
+    end
+    assert_match(/#{Regexp.escape(expected).gsub(/__OPTIONS__/, %Q("ENGINE=InnoDB[^"]*"))}/, result)
   end
 
   def test_dump_with_no_columns
@@ -34,12 +52,18 @@ EOS
     ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, dest)
     dest.rewind
     result = dest.read
-    expected = <<EOS
-  create_table "sample", #{render_kv_pair(:force, true)}, #{render_kv_pair(:comment, "a table comment")} do |t|
+    expected = if ENV['DB'] == 'mysql' && ::ActiveRecord::VERSION::MAJOR >= 5
+      <<-EOS
+  create_table "sample", force: :cascade, options: __OPTIONS__, comment: "a table comment" do |t|
+      EOS
+    else
+      <<-EOS
+  create_table "sample", force: :cascade, comment: "a table comment" do |t|
   end
-EOS
+      EOS
+    end
 
-    assert_match /#{Regexp.escape expected}/, result
+    assert_match(/#{Regexp.escape(expected).gsub(/__OPTIONS__/, %Q("ENGINE=InnoDB[^"]*"))}/, result)
   end
 
   def test_schema_dump_with_custom_type_error_for_pg
@@ -62,6 +86,6 @@ EOS
 #   Unknown type 'my_custom_type' for column 'field2'
 EOS
 
-    assert_match /#{Regexp.escape expected}/, result
+    assert_match(/#{Regexp.escape expected}/, result)
   end
 end

data/test/test_helper.rb

@@ -1,7 +1,7 @@
 require 'minitest/autorun'
 
 require 'rubygems'
-gem 'activerecord', '>= 2.3.2'
+gem 'activerecord', '>= 4.2.0'
 require 'active_record'
 require 'yaml'
 
@@ -9,6 +9,13 @@ CONFIGURATIONS = YAML::load(IO.read(File.join(File.dirname(__FILE__), 'config/da
 
 ENV['DB'] ||= 'postgres' # override as needed
 
+if ENV['DEBUG']
+  require 'minitest/byebug'
+else
+  ActiveRecord::Migration.verbose = false
+  $VERBOSE=false
+end
+
 ActiveRecord::Base.establish_connection(CONFIGURATIONS[ENV['DB']])
 
 $LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: migration_comments
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Pinny
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-08 00:00:00.000000000 Z
+date: 2016-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.2
+        version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.2
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: annotate
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: 2.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: 2.7.0
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Add schema comments in your migrations, see them in model annotations
   and db/schema.rb dump
 email:
@@ -89,23 +103,24 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - MIT-LICENSE
 - README.rdoc
 - Rakefile
+- docker-compose.yml
+- gemfiles/rails4.gemfile
+- gemfiles/rails5.gemfile
 - lib/migration_comments.rb
 - lib/migration_comments/active_record/connection_adapters/abstract_adapter.rb
 - lib/migration_comments/active_record/connection_adapters/abstract_adapter/schema_creation.rb
-- lib/migration_comments/active_record/connection_adapters/abstract_sqlite_adapter.rb
 - lib/migration_comments/active_record/connection_adapters/alter_table.rb
 - lib/migration_comments/active_record/connection_adapters/column.rb
 - lib/migration_comments/active_record/connection_adapters/column_definition.rb
 - lib/migration_comments/active_record/connection_adapters/comment_definition.rb
 - lib/migration_comments/active_record/connection_adapters/mysql2_adapter.rb
-- lib/migration_comments/active_record/connection_adapters/mysql_adapter.rb
 - lib/migration_comments/active_record/connection_adapters/postgresql_adapter.rb
 - lib/migration_comments/active_record/connection_adapters/sqlite3_adapter.rb
-- lib/migration_comments/active_record/connection_adapters/sqlite_adapter.rb
 - lib/migration_comments/active_record/connection_adapters/table.rb
 - lib/migration_comments/active_record/connection_adapters/table_definition.rb
 - lib/migration_comments/active_record/schema_dumper.rb
@@ -117,6 +132,7 @@ files:
 - test/annotate_models_test.rb
 - test/auto_increment_test.rb
 - test/config/database.yml
+- test/primary_uuid_test.rb
 - test/schema_dumper_test.rb
 - test/test_helper.rb
 homepage: https://github.com/pinnymz/migration_comments
@@ -138,8 +154,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: migration_comments
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Comments for your migrations
-test_files: []
+test_files:
+- test/add_comments_test.rb
+- test/annotate_models_test.rb
+- test/auto_increment_test.rb
+- test/config/database.yml
+- test/primary_uuid_test.rb
+- test/schema_dumper_test.rb
+- test/test_helper.rb

data/lib/migration_comments/active_record/connection_adapters/abstract_sqlite_adapter.rb

@@ -1,85 +0,0 @@
-module MigrationComments::ActiveRecord::ConnectionAdapters
-  module AbstractSQLiteAdapter
-    def comments_supported?
-      true
-    end
-
-    def inline_comments?
-      true
-    end
-
-    def set_table_comment(table_name, comment_text)
-      alter_table(table_name, :comment => comment_text)
-    end
-
-    def set_column_comment(table_name, column_name, comment_text)
-      sql_type = primary_key(table_name) == column_name.to_s ?
-          :primary_key :
-          column_for(table_name, column_name).sql_type
-      change_column table_name, column_name, sql_type, :comment => comment_text
-    end
-
-    def retrieve_table_comment(table_name)
-      result = select_rows(lookup_comment_sql(table_name))
-      if result[0][0] =~ /CREATE (?:TEMPORARY )?TABLE #{quote_table_name table_name} [^\(]*\/\*(.*)\*\/ \(/
-        $1
-      end
-    end
-
-    def retrieve_column_comments(table_name, *column_names)
-      if column_names.empty?
-        return columns(table_name).inject({}) { |m, v| m[v.name.to_sym] = v.comment if v.comment.present?; m }
-      end
-      result = select_rows(lookup_comment_sql(table_name))
-      result[0][0] =~ /^CREATE (?:TEMPORARY )?TABLE "\w*" [^\(]*(?:\/\*.*\*\/ )?\((.*)\)[^\)]*$/
-      col_defs = $1
-      comment_matches = col_defs.scan(/"([^",]+)"[^,]*\/\*(.+?)\*\//)
-      comment_matches.inject({}){|m, row| m[row.first.to_sym] = row.last; m}
-    end
-
-    def change_column_with_migration_comments(table_name, column_name, type, options = {}) #:nodoc:
-      adapter = self
-      alter_table(table_name) do |definition|
-        include_default = options_include_default?(options)
-        definition[column_name].instance_eval do
-          self.type    = type
-          self.limit   = options[:limit] if options.include?(:limit)
-          self.default = options[:default] if include_default
-          self.null    = options[:null] if options.include?(:null)
-          self.precision = options[:precision] if options.include?(:precision)
-          self.scale   = options[:scale] if options.include?(:scale)
-          self.comment = CommentDefinition.new(adapter, table_name, column_name, options[:comment]) if options.include?(:comment)
-        end
-      end
-    end
-
-    def column_for(table_name, column_name)
-      columns(table_name).detect{|col| col.name == column_name.to_s}
-    end
-
-    def comment_sql(comment_definition)
-      if comment_definition.nil? || comment_definition.comment_text.blank?
-        ""
-      else
-        " /*#{escaped_comment(comment_definition.comment_text)}*/"
-      end
-
-    end
-
-    def add_column_options!(sql, options)
-      super(sql, options)
-      if options.keys.include?(:comment)
-        sql << CommentDefinition.new(self, nil, nil, options[:comment]).to_sql
-      end
-    end
-
-    private
-    def escaped_comment(comment)
-      comment.gsub(/\*\//, "*-/")
-    end
-
-    def lookup_comment_sql(table_name)
-      "select sql from (select * from sqlite_master where type='table' union select * from sqlite_temp_master where type='table') where tbl_name = '#{table_name}'"
-    end
-  end
-end