schema_comments 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1d1635ab2f5896095a1be697387e369586309f2
-  data.tar.gz: c8735f51f37748a54620b014c3b95e6dcf16ac5d
+  metadata.gz: 3e86f31a10d539ff6c38570c26e42ae901c381d0
+  data.tar.gz: 2cbd891ce4625a00b234429c4eb33f5a5841cdf4
 SHA512:
-  metadata.gz: bfb57df30717ea9c95a48614d0f82123dcd54f9b27f4203fd8431ea86b86570b4907b99a60deb629fb732340abb382ce5c5328929774e4ec66cdefdde20167dd
-  data.tar.gz: 5f41213ba5f2755be515609a4f6132f8a2fc4bbe9a60b14b192dd79efeaf761d1a50df57a60684f7f01081cb80e5f1c662b9efad6ce6b2cb2d032fc1851f4d3c
+  metadata.gz: bb6b51e194b02b595810294dfaf6390404118809082e68694644f5c97e10286dcf61ad47b873220df946b12f7504aeef321f0111d53cbdca223b1cd6b45bbab1
+  data.tar.gz: 4c6c5a2cc31b4b7e3541739623054d5df3a6f7badcb8359038b383d534a30876435821974f469778e7771430afccb584b71b0e1c61f82fa46999a4d79ba19965

data/.gitignore

@@ -1,11 +1,6 @@
 *.log
 *~
-/.rbenv-version
-/.rvmrc
-/.yardoc
 /coverage
-/doc
 /pkg
-/selectable_attr_test.sqlite3.db
 /Gemfile.lock
 /tmp

data/.rspec

@@ -1 +1,2 @@
+--format Fuubar
 --color

data/.travis.yml

@@ -3,7 +3,6 @@ rvm:
   - 2.2.4
   - 2.3.0
 gemfile:
-  - gemfiles/Gemfile.rails-4.0
   - gemfiles/Gemfile.rails-4.1
   - gemfiles/Gemfile.rails-4.2
 env:

data/Gemfile

@@ -1,7 +1,18 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
 
+# Declare your gem's dependencies in schema_comments.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
 gemspec
 
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]
+
 group :development, :test do
   gem "sqlite3"
   gem "mysql2"

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -43,10 +43,7 @@ class CreateProducts < ActiveRecord::Migration
 end
 ```
 
-こんな感じ。
-
-でこのようなマイグレーションを実行すると、db/schema.rb には、
-コメントが設定されているテーブル、カラムは以下のように出力されます。
+このようなマイグレーションを実行すると、db/schema.rb のコメントが設定されているテーブル、カラムには以下のように出力されます。
 
 ```
 ActiveRecord::Schema.define(:version => 0) do
@@ -60,15 +57,16 @@ ActiveRecord::Schema.define(:version => 0) do
 end
 ```
 
-コメントは、以下のメソッドで使用することが可能です。
+コメントは以下のメソッドで使用することが可能です。
 
 ```
 columns, create_table, drop_table, rename_table
-remove_column, add_column, change_column
+remove_column, add_column, change_column, rename_column
 ```
 
 
 ## コメントはどこに保存されるのか
+
 db/schema_comments.yml にYAML形式で保存されます。
 あまり推奨しませんが、もしマイグレーションにコメントを記述するのを忘れてしまった場合、db/schema_comments.yml
 を直接編集した後、rake db:schema:dumpやマイグレーションを実行すると、db/schema.rbのコメントに反映されます。
@@ -76,69 +74,28 @@ db/schema_comments.yml にYAML形式で保存されます。
 
 ## I18nへの対応
 
-```
-rake i18n:schema_comments:update_config_locale
-```
-
-このタスクを実行すると、i18n用のYAMLを更新できます。
+`schema_comments:i18n:update`タスクを実行すると、i18n用のYAMLを更新できます。
 
 ```
-rake i18n:schema_comments:update_config_locale LOCALE=ja
+rake schema_comments:i18n:update
 ```
 
-でデフォルトではconfig/locales/ja.ymlを更新します。
+環境変数`LOCALE`で対象のロケールを指定可能ですが、指定されていなければ`I18n.locale`から取得します。
 
-毎回LOCALEを指定するのが面倒な場合は、config/initializers/locale.rb に
+これは `config/application.rb` で以下のように指定可能です。
 
 ```
-I18n.default_locale = 'ja'
+   config.i18n.default_locale = :ja
 ```
 
-という記述を追加しておくと良いでしょう。
 
 また出力先のYAMLのPATHを指定したい場合、YAML_PATHで指定が可能です。
 
 ```
-rake i18n:schema_comments:update_config_locale LOCALE=ja YAML_PATH=/path/to/yaml
-```
-
-### コメント内コメント
-コメント中の ((( から ))) は反映されませんので、モデル名／属性名に含めたくない箇所は ((( と ))) で括ってください。
-((( ))) と同様に[[[ ]]]も使用できます。
-例えば以下のようにdb/schema.rbに出力されている場合、
-
-```
-ActiveRecord::Schema.define(:version => 0) do
-  create_table "products", :force => true, :comment => '商品' do |t|
-    t.string   "product_type_cd", :comment => '種別コード(((01:書籍, 02:靴, 03:パソコン)))'
-    t.integer  "price", :comment => "価格"
-    t.string   "name", :comment => "商品名"
-    t.datetime "created_at", :comment => "登録日時"
-    t.datetime "updated_at", :comment => "更新日時"
-  end
-end
-```
-
-```
-$ rake i18n:schema_comments:update_config_locale LOCALE=ja
-```
-
-とすると、以下のように出力されます。
-
-```
-ja:
-  activerecord:
-    attributes:
-      product: 
-        product_type_cd: "種別コード"
-        price: "価格"
-        name: "商品名"
-        created_at: "登録日時"
-        updated_at: "更新日時"
+rake schema_comments:i18n:update LOCALE=ja YAML_PATH=/path/to/yaml
 ```
 
 
-
 ## MySQLのビュー
 MySQLのビューを使用した場合、元々MySQLではSHOW TABLES でビューも表示してしまうため、
 ビューはテーブルとしてSchemaDumperに認識され、development環境ではMySQLのビューとして作成されているのに、
@@ -146,35 +103,5 @@ test環境ではテーブルとして作成されてしまい、テストが正
 これを避けるため、schema_commentsでは、db/schema.rbを出力する際、テーブルに関する記述の後に、CREATE VIEWを行う記述を追加します。
 
 
-## annotate_models
-rake db:annotate で以下のようなコメントを、モデル、テスト、フィクスチャといったモデルに関係の強いファイルの
-先頭に追加します。
-
-```
-# == Schema Info
-# 
-# Schema version: 20090721185959
-#
-# Table name: books # 書籍
-#
-#  id         :integer         not null, primary key
-#  title      :string(100)     not null               # タイトル
-#  size       :integer         not null, default(1)   # 判型
-#  price      :decimal(17, 14) not null, default(0.0) # 価格
-#  created_at :datetime                               # 登録日時
-#  updated_at :datetime                               # 更新日時
-# 
-# =================
-# 
-```
-
-また、rake db:updateで、rake db:migrateとrake db:annotateを実行します。
-
-annotate_modelsは、達人プログラマーのDave Thomasさんが公開しているプラグインです。
-http://repo.pragprog.com/svn/Public/plugins/annotate_models/
-
-本プラグインでは、それを更に拡張したDave Boltonさんのプラグインannotate_models
-( リポジトリは削除された様子・・・ )をベースに拡張を加えています。
-
 ## License
-Copyright (c) 2008 Takeshi AKIMA, released under the Ruby License
+Copyright (c) 2008 - 2016 Takeshi AKIMA, released under the Ruby License

data/Rakefile

@@ -1,3 +1,9 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 

data/gemfiles/Gemfile.rails-4.0

@@ -7,6 +7,8 @@ group :test do
   gem "sqlite3", :platform => :ruby
   gem "mysql2" , "~> 0.3.13", :platform => :ruby
   gem "rails"
+  gem "fuubar"
+  gem "simplecov"
 
   # gem "activerecord-jdbcsqlite3-adapter", :platform => :jruby
   # gem "activerecord-jdbcmysql-adapter"  , :platform => :jruby

data/gemfiles/Gemfile.rails-4.1

@@ -7,6 +7,8 @@ group :development, :test do
   gem "sqlite3", :platform => :ruby
   gem "mysql2" , "~> 0.3.13", :platform => :ruby
   gem "rails"
+  gem "fuubar"
+  gem "simplecov"
 end
 
 gemspec :path => '..'

data/gemfiles/Gemfile.rails-4.2

@@ -7,6 +7,8 @@ group :test do
   gem "sqlite3", :platform => :ruby
   gem "mysql2" , :platform => :ruby
   gem "rails"
+  gem "fuubar"
+  gem "simplecov"
 end
 
 gemspec :path => '..'

data/lib/schema_comments.rb

@@ -7,8 +7,7 @@ module SchemaComments
 
   autoload :Base              , 'schema_comments/base'
   autoload :ConnectionAdapters, 'schema_comments/connection_adapters'
-  autoload :Migration         , 'schema_comments/migration'
-  autoload :Migrator          , 'schema_comments/migrator'
+  autoload :DummyMigration    , 'schema_comments/dummy_migration'
   autoload :Schema            , 'schema_comments/schema'
   autoload :SchemaComment     , 'schema_comments/schema_comment'
   autoload :SchemaDumper      , 'schema_comments/schema_dumper'
@@ -21,8 +20,12 @@ module SchemaComments
 
   class << self
     def setup
-      base_names = %w(Base Migration Migrator Schema) +
-        %w(Column ColumnDefinition TableDefinition).map{|name| "ConnectionAdapters::#{name}"}
+      defined?(Rails) && Rails.env.production? ? setup_on_production : setup_on_development
+    end
+
+    def setup_on_development
+      base_names = %w(Schema) +
+        %w(ColumnDefinition TableDefinition).map{|name| "ConnectionAdapters::#{name}"}
 
       base_names.each do |base_name|
         ar_class = "ActiveRecord::#{base_name}".constantize
@@ -51,6 +54,24 @@ module SchemaComments
       end
     end
 
+    def setup_on_production
+      ActiveRecord::Migration.__send__(:prepend, DummyMigration)
+    end
+
+    [
+      :table_comment,
+      :column_comment,
+      :column_comments,
+      :save_table_comment,
+      :save_column_comment,
+      :destroy_of,
+      :update_table_name,
+      :update_column_name,
+      :clear_cache,
+    ].each do |m|
+      module_eval("def #{m}(*args); SchemaComment.#{m}(*args) end", __FILE__, __LINE__)
+    end
+
   end
 
 end

data/lib/schema_comments/connection_adapters.rb

@@ -2,10 +2,6 @@
 module SchemaComments
   module ConnectionAdapters
 
-    module Column
-      attr_accessor :comment
-    end
-
     module ColumnDefinition
       attr_accessor :comment
     end
@@ -76,16 +72,6 @@ module SchemaComments
     end
 
     module ConcreteAdapter
-      #TODO: columnsメソッドに第二引数移行がないので本来は消すべき？
-      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]
-        end
-        result
-      end
-
       def create_table(table_name, options = {}, &block)
         table_def = nil
         result = super(table_name, options) do |t|

data/lib/schema_comments/dummy_migration.rb

@@ -0,0 +1,7 @@
+module SchemaComments
+  module DummyMigration
+    def rename_column(table, old_col, new_col, options = {})
+      super(table, old_col, new_col)
+    end
+  end
+end

data/lib/schema_comments/railtie.rb

@@ -6,6 +6,7 @@ module SchemaScomments
   class Railtie < ::Rails::Railtie
     rake_tasks do
       SchemaComments.yaml_path = Rails.root.join("db/schema_comments.yml").to_s
+      SchemaComments.setup
       require 'schema_comments/task'
     end
   end

data/lib/schema_comments/schema_comment.rb

@@ -11,19 +11,19 @@ module SchemaComments
 
     class << self
       def table_comment(table_name)
-        @table_names ||= yaml_access{|db| db[TABLE_KEY]}.dup
+        @table_names ||= yaml_read{|db| db[TABLE_KEY]}.dup
         @table_names[table_name.to_s]
       end
 
       def column_comment(table_name, column_name)
-        @column_names ||= yaml_access{|db| db[COLUMN_KEY] }.dup
+        @column_names ||= yaml_read{|db| db[COLUMN_KEY] }.dup
         column_hash = @column_names[table_name.to_s] || {}
         column_hash[column_name.to_s]
       end
 
       def column_comments(table_name)
         result = nil
-        @column_names ||= yaml_access{|db| db[COLUMN_KEY] }.dup
+        @column_names ||= yaml_read{|db| db[COLUMN_KEY] }.dup
         result = @column_names[table_name.to_s]
         result || {}
       end
@@ -32,7 +32,7 @@ module SchemaComments
         yaml_access do |db|
           db[TABLE_KEY][table_name.to_s] = comment
         end
-        @table_names = nil
+        clear_cache
       end
 
       def save_column_comment(table_name, column_name, comment)
@@ -40,7 +40,7 @@ module SchemaComments
           db[COLUMN_KEY][table_name.to_s] ||= {}
           db[COLUMN_KEY][table_name.to_s][column_name.to_s] = comment
         end
-        @column_names = nil
+        clear_cache
       end
 
       def destroy_of(table_name, column_name)
@@ -48,7 +48,7 @@ module SchemaComments
           column_hash = db[COLUMN_KEY][table_name.to_s]
           column_hash.delete(column_name.to_s) if column_hash
         end
-        @column_names = nil
+        clear_cache
       end
 
       def update_table_name(table_name, new_name)
@@ -56,8 +56,7 @@ module SchemaComments
           db[TABLE_KEY][new_name.to_s] = db[TABLE_KEY].delete(table_name.to_s)
           db[COLUMN_KEY][new_name.to_s] = db[COLUMN_KEY].delete(table_name.to_s)
         end
-        @table_names = nil
-        @column_names = nil
+        clear_cache
       end
 
       def update_column_name(table_name, column_name, new_name)
@@ -67,12 +66,45 @@ module SchemaComments
             table_cols[new_name.to_s] = table_cols.delete(column_name.to_s)
           end
         end
+        clear_cache
+      end
+
+      def model_comments
+        yaml_read{|db| db[TABLE_KEY] }.
+          each_with_object({}){|(k,v),d| d[k.singularize] = v }
+      end
+
+      def attribute_comments
+        yaml_read{|db| db[COLUMN_KEY] }.each_with_object({}) do |(k,v),d|
+          d[k.singularize] = v.each_with_object({}) do |(name, comment), dd|
+            dd[name.sub(/_id\z/, '')] = comment.sub(/id\z/i, '') if name =~ /_id\z/
+            dd[name] = comment
+          end
+        end
+      end
+
+      def activerecord_comments
+        {
+          'activerecord' => {
+            'models' => model_comments,
+            'attributes' => attribute_comments,
+          }
+        }
+      end
+
+      def locale_yaml(locale)
+        YAML.dump({locale.to_s => activerecord_comments})
+      end
+
+      def clear_cache
         @table_names = nil
         @column_names = nil
+        self
       end
 
-      def yaml_exist?
-        File.exist?(SchemaComments.yaml_path)
+      def yaml_read(&block)
+        db = YAML.load_file(SchemaComments.yaml_path)
+        block_given? ? yield(db) : db
       end
 
       def yaml_access(&block)