schema_comments 0.2.0 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 24b3283a263104ee9046e1997be8c81c8147833a
+  data.tar.gz: cb88b5c63f9beee0dda6e4a5fa914a46a338ea8c
+SHA512:
+  metadata.gz: 02a04a92bf9a60b4830636e8788eb561bafb454a80ebdeec79d2960e473e96c4d302b50d80fbd739f8c3832e2d2b4ff4eed4873c95b5812f039887108749b124
+  data.tar.gz: d344cb682fcd641ca133968b395cb9ef4bfa533af50cd9e7a70773efb66688b19b703a61d36dd86b4c15d6c55e17615a3b1eb2adeda562d00e0bb036e7983567

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,13 @@
+script: "bundle exec rake spec"
+rvm:
+#  - 2.0.0 # it can work but spec fails
+  - 2.1.6
+  - 2.2.2
+gemfile:
+  - gemfiles/Gemfile.rails-4.0
+  - gemfiles/Gemfile.rails-4.1
+  - gemfiles/Gemfile.rails-4.2
+env:
+  - DB=sqlite3
+  - DB=mysql2
+before_install: gem install bundler --version '>= 1.9.0'

data/Gemfile

@@ -1,12 +1,15 @@
 source "http://rubygems.org"
 
-group :test do
-  gem "sqlite3", :platform => :ruby
-  gem "mysql"  , (RUBY_VERSION == '1.9.2' ? "~> 2.8.1" : ">= 0"), :platform => :ruby
-  gem "mysql2" , :platform => :ruby
+gemspec
 
-  # gem "activerecord-jdbcsqlite3-adapter", :platform => :jruby
-  # gem "activerecord-jdbcmysql-adapter"  , :platform => :jruby
-end
+group :development do
+  gem "sqlite3"
+  gem "mysql2"
+  gem "rails"
 
-gemspec
+  gem "pry"
+  gem "pry-byebug"
+  gem "pry-stack_explorer"
+  gem "simplecov"
+  gem "fuubar"
+end

data/README.md

@@ -0,0 +1,187 @@
+# SchemaComments  [![Build Status](https://secure.travis-ci.org/akm/schema_comments.png)](http://travis-ci.org/akm/schema_comments)
+
+## Install
+
+### With Bundler
+add this line into Gemfile
+
+    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
+
+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
+
+
+## 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 )をベースに拡張を加えています。
+
+## License
+Copyright (c) 2008 Takeshi AKIMA, released under the Ruby License

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "schema_comments"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gemfiles/.gitignore

@@ -0,0 +1 @@
+/Gemfile.*.lock

data/gemfiles/Gemfile.rails-4.0

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+
+gem "activesupport", "~> 4.0.0"
+gem "activerecord" , "~> 4.0.0"
+
+group :test do
+  gem "sqlite3", :platform => :ruby
+  gem "mysql2" , :platform => :ruby
+  gem "rails"
+
+  # gem "activerecord-jdbcsqlite3-adapter", :platform => :jruby
+  # gem "activerecord-jdbcmysql-adapter"  , :platform => :jruby
+end
+
+gemspec :path => '..'

data/gemfiles/Gemfile.rails-4.1

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+gem "activesupport", "~> 4.1.0"
+gem "activerecord" , "~> 4.1.0"
+
+group :test do
+  gem "sqlite3", :platform => :ruby
+  gem "mysql2" , :platform => :ruby
+  gem "rails"
+end
+
+gemspec :path => '..'

data/gemfiles/Gemfile.rails-4.2

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+gem "activesupport", "~> 4.2.0"
+gem "activerecord" , "~> 4.2.0"
+
+group :test do
+  gem "sqlite3", :platform => :ruby
+  gem "mysql2" , :platform => :ruby
+  gem "rails"
+end
+
+gemspec :path => '..'

data/lib/annotate_models.rb

@@ -56,7 +56,7 @@ module AnnotateModels
     when NilClass                 then "NULL"
     when TrueClass                then "TRUE"
     when FalseClass               then "FALSE"
-    when Float, Fixnum, Bignum    then value.to_s
+    when Float, Fixnum, Bignum    then value.to_s.inspect
       # BigDecimals need to be output in a non-normalized form and quoted.
     when BigDecimal               then value.to_s('F')
     else
@@ -98,13 +98,21 @@ module AnnotateModels
   end
 
   def self.annotate_column(col, klass, max_size)
+    col_type = col.type.to_s
     attrs = []
     attrs << "not null" unless col.null
-    attrs << "default(#{quote(col.default)})" if col.default
+    if col.default
+      default_value =
+        case col_type
+        when "decimal" then col.default.to_s.sub(/\.0+\z/, '.0')
+        else col.default
+        end
+      attrs << "default(#{quote(default_value)})"
+    end
     attrs << "primary key" if col.name == klass.primary_key
 
-    col_type = col.type.to_s
-    if col_type == "decimal"
+    case col_type
+    when "decimal" then
       col_type << "(#{col.precision}, #{col.scale})"
     else
       col_type << "(#{col.limit})" if col.limit

data/lib/schema_comments/connection_adapters.rb

@@ -94,8 +94,9 @@ module SchemaComments
         end
       end
 
+      #TODO: columnsメソッドに第二引数移行がないので本来は消すべき？
       def columns_with_schema_comments(table_name, name = nil, &block)
-        result = columns_without_schema_comments(table_name, name, &block)
+        result = columns_without_schema_comments(table_name)
         column_comment_hash = column_comments(table_name)
         result.each do |column|
           column.comment = column_comment_hash[column.name]

data/lib/schema_comments/railtie.rb

@@ -0,0 +1,11 @@
+require 'schema_comments'
+
+require 'rails'
+
+module SchemaScomments
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      require 'schema_comments/task'
+    end
+  end
+end

data/lib/schema_comments/schema_comment.rb

@@ -133,7 +133,7 @@ module SchemaComments
           column_hash ||= {}
           column_names = nil
           begin
-            columns = ActiveRecord::Base.connection.columns_without_schema_comments(table_name, "#{table_name.classify} Columns")
+            columns = ActiveRecord::Base.connection.columns_without_schema_comments(table_name)
             column_names = columns.map(&:name)
           rescue ActiveRecord::ActiveRecordError
             column_names = column_hash.keys.sort

data/lib/schema_comments/schema_dumper/mysql.rb

@@ -35,7 +35,7 @@ module SchemaComments
     end
 
       def header(stream)
-        define_params = @version ? ":version => #{@version}" : ""
+        define_params = @version ? "version: #{@version}" : ""
 
         if stream.respond_to?(:external_encoding)
           stream.puts "# encoding: #{stream.external_encoding.name}"
@@ -52,7 +52,7 @@ module SchemaComments
 # from scratch. The latter is a flawed and unsustainable approach (the more migrations
 # you'll amass, the slower it'll run and the greater likelihood for issues).
 #
-# It's strongly recommended to check this file into your version control system.
+# It's strongly recommended that you check this file into your version control system.
 
 ActiveRecord::Schema.define(#{define_params}) do
 

data/lib/schema_comments/version.rb

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

data/lib/schema_comments.rb

@@ -1,5 +1,7 @@
 require 'active_support/core_ext/module'
 
+require 'schema_comments/railtie'
+
 module SchemaComments
   VERSION = File.read(File.expand_path("../../VERSION", __FILE__))
 

data/schema_comments.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'schema_comments/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "schema_comments"
+  spec.version       = SchemaComments::VERSION
+  spec.authors       = ["akm"]
+  spec.email         = ["akm2000@gmail.com"]
+
+  spec.summary       = %q{schema_comments generates extra methods dynamically for attribute which has options.}
+  spec.description   = %q{schema_comments generates extra methods dynamically for attribute which has options.}
+  spec.homepage      = "http://github.com/akm/schema_comments"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency('activesupport', ">= 4.0.0")
+  spec.add_runtime_dependency('activerecord', ">= 4.0.0")
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end