schema_comments 0.2.0 → 0.3.0

metadata

@@ -1,290 +1,148 @@
 --- !ruby/object:Gem::Specification
 name: schema_comments
 version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
-- akimatter
+- akm
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2013-01-28 00:00:00.000000000 Z
+date: 2015-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.10.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.10.0
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.10.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.10.1
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: autotest
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: ZenTest
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 4.8.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 4.8.3
 description: schema_comments generates extra methods dynamically for attribute which
-  has options
-email: akm2000@gmail.com
+  has options.
+email:
+- akm2000@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE.txt
-- README.rdoc
+extra_rdoc_files: []
 files:
-- .rspec
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
+- Rakefile
 - VERSION
+- bin/console
+- bin/setup
+- gemfiles/.gitignore
+- gemfiles/Gemfile.rails-4.0
+- gemfiles/Gemfile.rails-4.1
+- gemfiles/Gemfile.rails-4.2
 - init.rb
 - lib/annotate_models.rb
 - lib/hash_key_orderable.rb
+- lib/schema_comments.rb
 - lib/schema_comments/base.rb
 - lib/schema_comments/connection_adapters.rb
 - lib/schema_comments/migration.rb
 - lib/schema_comments/migrator.rb
+- lib/schema_comments/railtie.rb
 - lib/schema_comments/schema.rb
 - lib/schema_comments/schema_comment.rb
-- lib/schema_comments/schema_dumper/mysql.rb
 - lib/schema_comments/schema_dumper.rb
+- lib/schema_comments/schema_dumper/mysql.rb
 - lib/schema_comments/task.rb
-- lib/schema_comments.rb
+- lib/schema_comments/version.rb
+- schema_comments.gemspec
 - tasks/annotate_models_tasks.rake
 - tasks/schema_comments.rake
-- spec/annotate_models_spec.rb
-- spec/fake_app.rb
-- spec/hash_key_orderable_spec.rb
-- spec/i18n_export_spec.rb
-- spec/migration_spec.rb
-- spec/migrations/valid/001_create_products.rb
-- spec/migrations/valid/002_rename_products.rb
-- spec/migrations/valid/003_rename_products_again.rb
-- spec/migrations/valid/004_remove_price.rb
-- spec/migrations/valid/005_change_products_name.rb
-- spec/migrations/valid/006_change_products_name_with_comment.rb
-- spec/migrations/valid/007_change_comments.rb
-- spec/migrations/valid/008_create_users_without_comment.rb
-- spec/resources/models/product.rb
-- spec/resources/models/product_name.rb
-- spec/schema.rb
-- spec/schema_comments/connection_adapters_spec.rb
-- spec/schema_comments/schema_comment_spec.rb
-- spec/schema_comments/schema_dumper_spec.rb
-- spec/spec_helper.rb
-- spec/yaml_export_spec.rb
-- spec/database.yml
-- spec/human_readable_schema_comments.yml
-- spec/schema_comments/schema_comments.yml
-- spec/schema_comments/schema_comments_broken_column_comments.yml
-- spec/schema_comments/schema_comments_broken_column_hash.yml
-- spec/schema_comments/schema_comments_broken_table_comments.yml
-- spec/schema_comments/schema_comments_users_without_column_hash.yml
-- spec/schema_comments.yml
 homepage: http://github.com/akm/schema_comments
 licenses:
-- Ruby License
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2176134516294785649
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>'
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.4.5
 signing_key: 
-specification_version: 3
-summary: schema_comments generates extra methods dynamically
-test_files:
-- spec/annotate_models_spec.rb
-- spec/fake_app.rb
-- spec/hash_key_orderable_spec.rb
-- spec/i18n_export_spec.rb
-- spec/migration_spec.rb
-- spec/migrations/valid/001_create_products.rb
-- spec/migrations/valid/002_rename_products.rb
-- spec/migrations/valid/003_rename_products_again.rb
-- spec/migrations/valid/004_remove_price.rb
-- spec/migrations/valid/005_change_products_name.rb
-- spec/migrations/valid/006_change_products_name_with_comment.rb
-- spec/migrations/valid/007_change_comments.rb
-- spec/migrations/valid/008_create_users_without_comment.rb
-- spec/resources/models/product.rb
-- spec/resources/models/product_name.rb
-- spec/schema.rb
-- spec/schema_comments/connection_adapters_spec.rb
-- spec/schema_comments/schema_comment_spec.rb
-- spec/schema_comments/schema_dumper_spec.rb
-- spec/spec_helper.rb
-- spec/yaml_export_spec.rb
-- spec/database.yml
-- spec/human_readable_schema_comments.yml
-- spec/schema_comments/schema_comments.yml
-- spec/schema_comments/schema_comments_broken_column_comments.yml
-- spec/schema_comments/schema_comments_broken_column_hash.yml
-- spec/schema_comments/schema_comments_broken_table_comments.yml
-- spec/schema_comments/schema_comments_users_without_column_hash.yml
-- spec/schema_comments.yml
+specification_version: 4
+summary: schema_comments generates extra methods dynamically for attribute which has
+  options.
+test_files: []

data/Gemfile.lock

@@ -1,106 +0,0 @@
-PATH
-  remote: .
-  specs:
-    schema_comments (0.2.0)
-      activerecord (>= 3.0.0)
-      activesupport (>= 3.0.0)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    ZenTest (4.8.3)
-    actionpack (3.2.11)
-      activemodel (= 3.2.11)
-      activesupport (= 3.2.11)
-      builder (~> 3.0.0)
-      erubis (~> 2.7.0)
-      journey (~> 1.0.4)
-      rack (~> 1.4.0)
-      rack-cache (~> 1.2)
-      rack-test (~> 0.6.1)
-      sprockets (~> 2.2.1)
-    activemodel (3.2.11)
-      activesupport (= 3.2.11)
-      builder (~> 3.0.0)
-    activerecord (3.2.11)
-      activemodel (= 3.2.11)
-      activesupport (= 3.2.11)
-      arel (~> 3.0.2)
-      tzinfo (~> 0.3.29)
-    activesupport (3.2.11)
-      i18n (~> 0.6)
-      multi_json (~> 1.0)
-    arel (3.0.2)
-    autotest (4.4.6)
-      ZenTest (>= 4.4.1)
-    builder (3.0.4)
-    diff-lcs (1.1.3)
-    erubis (2.7.0)
-    hike (1.2.1)
-    i18n (0.6.1)
-    journey (1.0.4)
-    json (1.7.6)
-    multi_json (1.5.0)
-    mysql (2.9.0)
-    mysql2 (0.3.11)
-    rack (1.4.4)
-    rack-cache (1.2)
-      rack (>= 0.4)
-    rack-ssl (1.3.2)
-      rack
-    rack-test (0.6.2)
-      rack (>= 1.0)
-    railties (3.2.11)
-      actionpack (= 3.2.11)
-      activesupport (= 3.2.11)
-      rack-ssl (~> 1.3.2)
-      rake (>= 0.8.7)
-      rdoc (~> 3.4)
-      thor (>= 0.14.6, < 2.0)
-    rake (10.0.3)
-    rdoc (3.12)
-      json (~> 1.4)
-    rspec (2.10.0)
-      rspec-core (~> 2.10.0)
-      rspec-expectations (~> 2.10.0)
-      rspec-mocks (~> 2.10.0)
-    rspec-core (2.10.1)
-    rspec-expectations (2.10.0)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.10.1)
-    rspec-rails (2.10.1)
-      actionpack (>= 3.0)
-      activesupport (>= 3.0)
-      railties (>= 3.0)
-      rspec (~> 2.10.0)
-    simplecov (0.7.1)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.7.1)
-    simplecov-html (0.7.1)
-    sprockets (2.2.2)
-      hike (~> 1.2)
-      multi_json (~> 1.0)
-      rack (~> 1.0)
-      tilt (~> 1.1, != 1.3.0)
-    sqlite3 (1.3.7)
-    thor (0.17.0)
-    tilt (1.3.3)
-    tzinfo (0.3.35)
-    yard (0.8.3)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  ZenTest (= 4.8.3)
-  autotest
-  bundler
-  mysql
-  mysql2
-  rake
-  rspec (~> 2.10.0)
-  rspec-rails (~> 2.10.1)
-  schema_comments!
-  simplecov
-  sqlite3
-  yard

data/README.rdoc

@@ -1,150 +0,0 @@
-= SchemaComments {<img src="https://secure.travis-ci.org/akm/schema_comments.png" />}[http://travis-ci.org/akm/schema_comments]
-
-== Install
-
-=== 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.1.4'
-and 
- $ sudo rake gems:install
-
-Or install gem manually
-
- $ sudo gem install schema_comments
-
-And make lib/tasks/schema_comments.rake
- require 'schema_comments/task'
-
-
-== Configuration
-If you install schema_comments as a gem, must create config/initializers/schema_comments.rb like this:
- require 'schema_comments'
- SchemaComments.setup
-
-
-== 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
- 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
-
-
-コメントは、以下のメソッドで使用することが可能です。
-
-columns, create_table, drop_table, rename_table
-remove_column, add_column, change_column
-
-
-== コメントはどこに保存されるのか
-db/schema_comments.yml にYAML形式で保存されます。
-あまり推奨しませんが、もしマイグレーションにコメントを記述するのを忘れてしまった場合、db/schema_comments.yml
-を直接編集した後、rake db:schema:dumpやマイグレーションを実行すると、db/schema.rbのコメントに反映されます。
-
-
-== I18nへの対応
-rake i18n:schema_comments:update_config_localeタスクを実行すると、i18n用のYAMLを更新できます。
-
-rake i18n:schema_comments:update_config_locale LOCALE=ja でデフォルトではconfig/locales/ja.ymlを更新します。
-
-毎回LOCALEを指定するのが面倒な場合は、config/initializers/locale.rb に
-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: "更新日時"
-
-
-
-== MySQLのビュー
-MySQLのビューを使用した場合、元々MySQLではSHOW TABLES でビューも表示してしまうため、
-ビューはテーブルとしてSchemaDumperに認識され、development環境ではMySQLのビューとして作成されているのに、
-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さんのプラグイン(
-http://github.com/rotuka/annotate_models )をベースに拡張を加えています。
-
-
-Copyright (c) 2008 Takeshi AKIMA, released under the Ruby License