schema_comments 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24b3283a263104ee9046e1997be8c81c8147833a
-  data.tar.gz: cb88b5c63f9beee0dda6e4a5fa914a46a338ea8c
+  metadata.gz: cb906aa319149d9162686075b61ccaa340f1fd38
+  data.tar.gz: 91ba3034e9efc564abfe4e7b556639fc606a5c6a
 SHA512:
-  metadata.gz: 02a04a92bf9a60b4830636e8788eb561bafb454a80ebdeec79d2960e473e96c4d302b50d80fbd739f8c3832e2d2b4ff4eed4873c95b5812f039887108749b124
-  data.tar.gz: d344cb682fcd641ca133968b395cb9ef4bfa533af50cd9e7a70773efb66688b19b703a61d36dd86b4c15d6c55e17615a3b1eb2adeda562d00e0bb036e7983567
+  metadata.gz: 8b83e84536e4770de6e2231c9c6b712ce299ed3bb7610e847d0ba004050455d5d3a9e35d6d88ad809e67e8c8075757a5ad276370ab37363869c2f572a6a8b8ca
+  data.tar.gz: 5ac5502337703798c29e059d1bfaa7efbffdde85a2148cd88143e9ea40f579849638910107190be71f2e975952e0243f8b800c3dab2edf33f4e6e6296a8e0d01

data/README.md

@@ -5,89 +5,67 @@
 ### With Bundler
 add this line into Gemfile
 
-    gem "schema_comments"
+```
+gem "schema_comments"
+```
 
 And do bundle install
 
-    bundle install
-
-## Install(old)
-
-### as a plugin
-
-    ruby script/plugin install git://github.com/akm/schema_comments.git
-
-### as a gem
-insert following line to config/environment.rb
-
-     config.gem 'schema_comments', :version => '0.2.0'
-
-and 
-
-    $ sudo rake gems:install
+```
+bundle install
+```
 
 Or install gem manually
 
-    $ sudo gem install schema_comments
-
-And make lib/tasks/schema_comments.rake
-
-    require 'schema_comments/task'
-
-## Configuration for Rails App
-1. make lib/tasks/schema_comments.rake
-2. edit the file like following
-
-    require 'schema_comments/task'
-    SchemaComments.yaml_path = File.expand_path("../../../db/schema_comments.yml", __FILE__)
-
-
-## Configuration (old)
-If you install schema_comments as a gem, must create config/initializers/schema_comments.rb like this:
-
-    require 'schema_comments'
-    SchemaComments.setup
+```
+$ gem install schema_comments
+```
 
 
 ## Overview
 schema_commentsプラグインを使うと、テーブルとカラムにコメントを記述することができます。
 
-    class CreateProducts < ActiveRecord::Migration
-      def self.up
-        create_table "products", :comment => '商品' do |t|
-          t.string   "product_type_cd", :comment => '種別コード'
-          t.integer  "price", :comment => "価格"
-          t.string   "name", :comment => "商品名"
-          t.datetime "created_at", :comment => "登録日時"
-          t.datetime "updated_at", :comment => "更新日時"
-        end
-      end
-   
-      def self.down
-        drop_table "products"
-      end
+```
+class CreateProducts < ActiveRecord::Migration
+  def self.up
+    create_table "products", :comment => '商品' do |t|
+      t.string   "product_type_cd", :comment => '種別コード'
+      t.integer  "price", :comment => "価格"
+      t.string   "name", :comment => "商品名"
+      t.datetime "created_at", :comment => "登録日時"
+      t.datetime "updated_at", :comment => "更新日時"
     end
+  end
+
+  def self.down
+    drop_table "products"
+  end
+end
+```
 
 こんな感じ。
 
 でこのようなマイグレーションを実行すると、db/schema.rb には、
 コメントが設定されているテーブル、カラムは以下のように出力されます。
 
-    ActiveRecord::Schema.define(:version => 0) do
-      create_table "products", :force => true, :comment => '商品' do |t|
-        t.string   "product_type_cd", :comment => '種別コード'
-        t.integer  "price", :comment => "価格"
-        t.string   "name", :comment => "商品名"
-        t.datetime "created_at", :comment => "登録日時"
-        t.datetime "updated_at", :comment => "更新日時"
-      end
-    end
-
+```
+ActiveRecord::Schema.define(:version => 0) do
+  create_table "products", :force => true, :comment => '商品' do |t|
+    t.string   "product_type_cd", :comment => '種別コード'
+    t.integer  "price", :comment => "価格"
+    t.string   "name", :comment => "商品名"
+    t.datetime "created_at", :comment => "登録日時"
+    t.datetime "updated_at", :comment => "更新日時"
+  end
+end
+```
 
 コメントは、以下のメソッドで使用することが可能です。
 
+```
 columns, create_table, drop_table, rename_table
 remove_column, add_column, change_column
+```
 
 
 ## コメントはどこに保存されるのか
@@ -98,53 +76,66 @@ db/schema_comments.yml にYAML形式で保存されます。
 
 ## I18nへの対応
 
-    rake i18n:schema_comments:update_config_locale
+```
+rake i18n:schema_comments:update_config_locale
+```
 
 このタスクを実行すると、i18n用のYAMLを更新できます。
 
-    rake i18n:schema_comments:update_config_locale LOCALE=ja
+```
+rake i18n:schema_comments:update_config_locale LOCALE=ja
+```
 
 でデフォルトではconfig/locales/ja.ymlを更新します。
 
 毎回LOCALEを指定するのが面倒な場合は、config/initializers/locale.rb に
 
-    I18n.default_locale = 'ja'
+```
+I18n.default_locale = 'ja'
+```
 
 という記述を追加しておくと良いでしょう。
 
 また出力先のYAMLのPATHを指定したい場合、YAML_PATHで指定が可能です。
 
-    rake i18n:schema_comments:update_config_locale LOCALE=ja YAML_PATH=/path/to/yaml
+```
+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
+```
+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: "更新日時"
+```
+ja:
+  activerecord:
+    attributes:
+      product: 
+        product_type_cd: "種別コード"
+        price: "価格"
+        name: "商品名"
+        created_at: "登録日時"
+        updated_at: "更新日時"
+```
 
 
 
@@ -159,22 +150,24 @@ test環境ではテーブルとして作成されてしまい、テストが正
 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                               # 更新日時
-      # 
-      # =================
-      # 
-    
+```
+# == 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さんが公開しているプラグインです。

data/lib/schema_comments/railtie.rb

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

data/lib/schema_comments/version.rb

@@ -1,3 +1,3 @@
 module SchemaComments
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/lib/schema_comments.rb

@@ -1,9 +1,9 @@
 require 'active_support/core_ext/module'
 
+require 'schema_comments/version'
 require 'schema_comments/railtie'
 
 module SchemaComments
-  VERSION = File.read(File.expand_path("../../VERSION", __FILE__))
 
   autoload :Base              , 'schema_comments/base'
   autoload :ConnectionAdapters, 'schema_comments/connection_adapters'
@@ -14,8 +14,6 @@ module SchemaComments
   autoload :SchemaDumper      , 'schema_comments/schema_dumper'
 
   mattr_accessor :yaml_path
-  self.yaml_path = Rails.root.join("db/schema_comments.yml").to_s if defined?(Rails) && Rails.root
-
   mattr_accessor :quiet
 
   class YamlError < StandardError

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schema_comments
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - akm
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-04-15 00:00:00.000000000 Z
+date: 2015-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport