schema_comments 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21a9d779680d54f251b51ab643ec747878b68924
-  data.tar.gz: 3ffa036c8dab55d4386d442e60bdf66aa6ff770e
+  metadata.gz: dfd122cb2fedd33909167773b879f943f97c74fb
+  data.tar.gz: 880e604fc10669a33c3408c936a052c1d54d86fa
 SHA512:
-  metadata.gz: 6027c604d17578b22dfb68aa5e0b6a42c184629ae539c2cb79b9c1634ab76dbf4d55a82136d075d1a7be53756d68ee7e7ff2b2fbadc2e935d6108956806cb524
-  data.tar.gz: e576b7f6de6a7cf31ea2a73413bce1b3929347ac110a2f81c3a84bceab744854d50cf16f73bab85139a8b9f130a74463c17150aced1f21641be640473fa5346c
+  metadata.gz: e03c5f4bd9b55bc4aa9e4395eb809da23999739ce10676ad67d0c9ad3d03c6c2dacf0244b6722572cd2128d1d6f572da85f7d47d21995651bed87530f4b1110b
+  data.tar.gz: 1210f6fa4a9eccfb61ebfcc7065d9e0265d0d6d67e4b4f7214d9030fe2102562e727d63360c2e4310a245fe53a3fe804b8ba20d2f249330526002cd175f3fb12

data/.gitignore

@@ -8,3 +8,4 @@
 /pkg
 /selectable_attr_test.sqlite3.db
 /Gemfile.lock
+/tmp

data/.travis.yml

@@ -1,8 +1,7 @@
 script: "bundle exec rake spec"
 rvm:
-#  - 2.0.0 # it can work but spec fails
-  - 2.1.6
-  - 2.2.2
+  - 2.2.4
+  - 2.3.0
 gemfile:
   - gemfiles/Gemfile.rails-4.0
   - gemfiles/Gemfile.rails-4.1

data/Gemfile

@@ -2,7 +2,7 @@ source "http://rubygems.org"
 
 gemspec
 
-group :development do
+group :development, :test do
   gem "sqlite3"
   gem "mysql2"
   gem "rails"

data/README.md

@@ -173,8 +173,8 @@ rake db:annotate で以下のようなコメントを、モデル、テスト、
 annotate_modelsは、達人プログラマーのDave Thomasさんが公開しているプラグインです。
 http://repo.pragprog.com/svn/Public/plugins/annotate_models/
 
-本プラグインでは、それを更に拡張したDave Boltonさんのプラグイン(
-http://github.com/rotuka/annotate_models )をベースに拡張を加えています。
+本プラグインでは、それを更に拡張したDave Boltonさんのプラグインannotate_models
+( リポジトリは削除された様子・・・ )をベースに拡張を加えています。
 
 ## License
 Copyright (c) 2008 Takeshi AKIMA, released under the Ruby License

data/gemfiles/Gemfile.rails-4.0

@@ -5,7 +5,7 @@ gem "activerecord" , "~> 4.0.0"
 
 group :test do
   gem "sqlite3", :platform => :ruby
-  gem "mysql2" , :platform => :ruby
+  gem "mysql2" , "~> 0.3.13", :platform => :ruby
   gem "rails"
 
   # gem "activerecord-jdbcsqlite3-adapter", :platform => :jruby

data/gemfiles/Gemfile.rails-4.1

@@ -3,9 +3,9 @@ source "http://rubygems.org"
 gem "activesupport", "~> 4.1.0"
 gem "activerecord" , "~> 4.1.0"
 
-group :test do
+group :development, :test do
   gem "sqlite3", :platform => :ruby
-  gem "mysql2" , :platform => :ruby
+  gem "mysql2" , "~> 0.3.13", :platform => :ruby
   gem "rails"
 end
 

data/lib/schema_comments/base.rb

@@ -1,11 +1,7 @@
 module SchemaComments
   module Base
-    def self.included(mod)
-      mod.extend ClassMethods
-      mod.instance_eval do
-        alias :columns_without_schema_comments :columns
-        alias :columns :columns_with_schema_comments
-      end
+    def self.prepended(mod)
+      mod.singleton_class.prepend ClassMethods
       mod.ignore_pattern_to_export_i18n = /\[.*\]/
     end
 
@@ -14,8 +10,8 @@ module SchemaComments
         @table_comment ||= connection.table_comment(table_name)
       end
 
-      def columns_with_schema_comments
-        result = columns_without_schema_comments
+      def columns
+        result = super
         unless @column_comments_loaded
           column_comment_hash = connection.column_comments(table_name)
           result.each do |column|

data/lib/schema_comments/connection_adapters.rb

@@ -11,18 +11,13 @@ module SchemaComments
     end
 
     module TableDefinition
-      def self.included(mod)
-        mod.module_eval do
-          alias_method_chain(:column, :schema_comments)
-        end
-      end
       attr_accessor :comment
 
-      def column_with_schema_comments(name, type, options = {})
-        column_without_schema_comments(name, type, options)
+      def column(name, type, options = {})
+        result = super(name, type, options)
         column = self[name]
         column.comment = options[:comment]
-        self
+        result
       end
     end
 
@@ -81,22 +76,9 @@ module SchemaComments
     end
 
     module ConcreteAdapter
-      def self.included(mod)
-        mod.module_eval do
-          alias_method_chain :columns      , :schema_comments
-          alias_method_chain :create_table , :schema_comments
-          alias_method_chain :drop_table   , :schema_comments
-          alias_method_chain :rename_table , :schema_comments
-          alias_method_chain :remove_column, :schema_comments
-          alias_method_chain :add_column   , :schema_comments
-          alias_method_chain :change_column, :schema_comments
-          alias_method_chain :rename_column, :schema_comments
-        end
-      end
-
       #TODO: columnsメソッドに第二引数移行がないので本来は消すべき？
-      def columns_with_schema_comments(table_name, name = nil, &block)
-        result = columns_without_schema_comments(table_name)
+      def columns(table_name, name = nil, &block)
+        result = super(table_name)
         column_comment_hash = column_comments(table_name)
         result.each do |column|
           column.comment = column_comment_hash[column.name]
@@ -104,9 +86,9 @@ module SchemaComments
         result
       end
 
-      def create_table_with_schema_comments(table_name, options = {}, &block)
+      def create_table(table_name, options = {}, &block)
         table_def = nil
-        result = create_table_without_schema_comments(table_name, options) do |t|
+        result = super(table_name, options) do |t|
           table_def = t
           yield(t)
         end
@@ -117,19 +99,19 @@ module SchemaComments
         result
       end
 
-      def drop_table_with_schema_comments(table_name, *args, &block)
-        result = drop_table_without_schema_comments(table_name, *args)
+      def drop_table(table_name, *args, &block)
+        result = super(table_name, *args)
         delete_schema_comments(table_name) unless @ignore_drop_table
         result
       end
 
-      def rename_table_with_schema_comments(table_name, new_name)
-        result = rename_table_without_schema_comments(table_name, new_name)
+      def rename_table(table_name, new_name)
+        result = super(table_name, new_name)
         update_schema_comments_table_name(table_name, new_name)
         result
       end
 
-      def remove_column_with_schema_comments(table_name, *column_names)
+      def remove_column(table_name, *column_names)
         # sqlite3ではremove_columnがないので、以下のフローでスキーマ更新します。
         # 1. CREATE TEMPORARY TABLE "altered_xxxxxx" (・・・)
         # 2. PRAGMA index_list("xxxxxx")
@@ -140,7 +122,7 @@ module SchemaComments
         #
         # このdrop tableの際に、schema_commentsを変更しないようにフラグを立てています。
         @ignore_drop_table = true
-        remove_column_without_schema_comments(table_name, *column_names)
+        super(table_name, *column_names)
         column_names.each do |column_name|
           delete_schema_comments(table_name, column_name)
         end
@@ -148,25 +130,25 @@ module SchemaComments
         @ignore_drop_table = false
       end
 
-      def add_column_with_schema_comments(table_name, column_name, type, options = {})
+      def add_column(table_name, column_name, type, options = {})
         comment = options.delete(:comment)
-        result = add_column_without_schema_comments(table_name, column_name, type, options)
+        result = super(table_name, column_name, type, options)
         column_comment(table_name, column_name, comment) if comment
         result
       end
 
-      def change_column_with_schema_comments(table_name, column_name, type, options = {})
+      def change_column(table_name, column_name, type, options = {})
         comment = options.delete(:comment)
         @ignore_drop_table = true
-        result = change_column_without_schema_comments(table_name, column_name, type, options)
+        result = super(table_name, column_name, type, options)
         column_comment(table_name, column_name, comment) if comment
         result
       ensure
         @ignore_drop_table = false
       end
 
-      def rename_column_with_schema_comments(table_name, column_name, new_column_name)
-        result = rename_column_without_schema_comments(table_name, column_name, new_column_name)
+      def rename_column(table_name, column_name, new_column_name)
+        result = super(table_name, column_name, new_column_name)
         comment = update_schema_comments_column_name(table_name, column_name, new_column_name)
         result
       end

data/lib/schema_comments/migration.rb

@@ -1,17 +1,13 @@
 module SchemaComments
   module Migration
-    def self.included(mod)
-      mod.extend(ClassMethods)
-      mod.instance_eval do
-        alias :migrate_without_schema_comments :migrate
-        alias :migrate :migrate_with_schema_comments
-      end
+    def self.prepended(mod)
+      mod.singleton_class.prepend(ClassMethods)
     end
 
     module ClassMethods
-      def migrate_with_schema_comments(*args, &block)
+      def migrate(*args, &block)
         SchemaComments::SchemaComment.yaml_access do
-          migrate_without_schema_comments(*args, &block)
+          super(*args, &block)
         end
       end
     end

data/lib/schema_comments/migrator.rb

@@ -1,17 +1,13 @@
 module SchemaComments
   module Migrator
-    def self.included(mod)
-      mod.extend(ClassMethods)
-      mod.instance_eval do
-        alias :migrate_without_schema_comments :migrate
-        alias :migrate :migrate_with_schema_comments
-      end
+    def self.prepend(mod)
+      mod.singleton_class.prepend(ClassMethods)
     end
 
     module ClassMethods
-      def migrate_with_schema_comments(*args, &block)
+      def migrate(*args, &block)
         SchemaComments::SchemaComment.yaml_access do
-          migrate_without_schema_comments(*args, &block)
+          super(*args, &block)
         end
       end
     end

data/lib/schema_comments/schema.rb

@@ -1,17 +1,13 @@
 module SchemaComments
   module Schema
-    def self.included(mod)
-      mod.extend(ClassMethods)
-      mod.instance_eval do
-        alias :define_without_schema_comments :define
-        alias :define :define_with_schema_comments
-      end
+    def self.prepended(mod)
+      mod.singleton_class.prepend(ClassMethods)
     end
 
     module ClassMethods
-      def define_with_schema_comments(*args, &block)
+      def define(*args, &block)
         SchemaComments::SchemaComment.yaml_access do
-          define_without_schema_comments(*args, &block)
+          super(*args, &block)
         end
       end
     end

data/lib/schema_comments/schema_comment.rb

@@ -82,15 +82,16 @@ module SchemaComments
           db = SortedStore.new(SchemaComments.yaml_path)
           result = nil
           # t = Time.now.to_f
-          db.transaction do
-            @yaml_transaction = db
-            begin
+          @yaml_transaction = db
+          begin
+            db.transaction do
               db[TABLE_KEY] ||= {}
               db[COLUMN_KEY] ||= {}
+              SortedStore.validate_yaml!(db)
               result = yield(db) if block_given?
-            ensure
-              @yaml_transaction = nil
             end
+          ensure
+            @yaml_transaction = nil
           end
           # puts("SchemaComment#yaml_access %fms from %s" % [Time.now.to_f - t, caller[0].gsub(/^.+:in /, '')])
           result
@@ -110,7 +111,20 @@ module SchemaComments
         root.to_yaml(@opt)
       end
 
+      def self.validate_yaml!(root)
+        table_comments = (root['table_comments'] ||= {})
+        column_comments = (root['column_comments'] ||= {})
+        # raise YamlError, "Broken schame_comments.yml by invalid root: #{root.inspect}" unless root.is_a?(Hash)
+        raise YamlError, "Broken schame_comments.yml by invalid table_comments" unless table_comments.is_a?(Hash)
+        raise YamlError, "Broken schame_comments.yml by invalid_column_comments" unless column_comments.is_a?(Hash)
+        column_comments.each do |table_name, value|
+          next if value.nil?
+          raise YamlError, "Broken schame_comments.yml by invalid column_comments for #{table_name}" unless value.is_a?(Hash)
+        end
+      end
+
       def self.sort_yaml_content!(root)
+        self.validate_yaml!(root)
         table_comments = (root['table_comments'] ||= {})
         column_comments = (root['column_comments'] ||= {})
         # 大元は
@@ -121,16 +135,13 @@ module SchemaComments
         # その他
         #   ...
         # の順番です。
-        raise YamlError, "Broken schame_comments.yml" unless root.is_a?(Hash)
         root.extend(HashKeyOrderable)
         root.key_order = %w(table_comments column_comments)
         # table_comments はテーブル名のアルファベット順
         table_names = ActiveRecord::Base.connection.tables.sort - ['schema_migrations']
-        raise YamlError, "Broken schame_comments.yml" unless table_comments.is_a?(Hash)
         table_comments.extend(HashKeyOrderable)
         table_comments.key_order = table_names
         # column_comments もテーブル名のアルファベット順
-        raise YamlError, "Broken schame_comments.yml" unless column_comments.is_a?(Hash)
         column_comments.extend(HashKeyOrderable)
         column_comments.key_order = table_names
         # column_comments の各値はテーブルのカラム順

data/lib/schema_comments/version.rb

@@ -1,3 +1,3 @@
 module SchemaComments
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

data/lib/schema_comments.rb

@@ -28,13 +28,13 @@ module SchemaComments
         ar_class = "ActiveRecord::#{base_name}".constantize
         sc_class = "SchemaComments::#{base_name}".constantize
         unless ar_class.ancestors.include?(sc_class)
-          ar_class.__send__(:include, sc_class)
+          ar_class.__send__(:prepend, sc_class)
         end
       end
 
       unless ActiveRecord::ConnectionAdapters::AbstractAdapter.ancestors.include?(SchemaComments::ConnectionAdapters::Adapter)
         ActiveRecord::ConnectionAdapters::AbstractAdapter.module_eval do
-          include SchemaComments::ConnectionAdapters::Adapter
+          prepend SchemaComments::ConnectionAdapters::Adapter
         end
       end
 
@@ -44,7 +44,7 @@ module SchemaComments
           require("active_record/connection_adapters/#{adapter.downcase}_adapter")
           adapter_class = ('ActiveRecord::ConnectionAdapters::' << "#{adapter}Adapter").constantize
           adapter_class.module_eval do
-            include SchemaComments::ConnectionAdapters::ConcreteAdapter
+            prepend SchemaComments::ConnectionAdapters::ConcreteAdapter
           end
         rescue Exception => e
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schema_comments
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - akm
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-04-28 00:00:00.000000000 Z
+date: 2016-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -141,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: schema_comments generates extra methods dynamically for attribute which has