schema_comments 0.1.4 → 0.2.0.alpha1

data/Gemfile

@@ -0,0 +1,23 @@
+source "http://rubygems.org"
+
+gem "activesupport", "~> 3.1.0"
+gem "activerecord", "~> 3.1.0"
+
+
+group :test do
+  gem "rails", "~> 3.1.0"
+  gem "sqlite3"
+  gem "yaml_waml"
+end
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "rspec-rails", "~> 2.8.1"
+  gem "yard", "~> 0.7"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.8.3"
+  gem "simplecov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,125 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.1.4)
+      actionpack (= 3.1.4)
+      mail (~> 2.3.0)
+    actionpack (3.1.4)
+      activemodel (= 3.1.4)
+      activesupport (= 3.1.4)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.6)
+      rack-cache (~> 1.1)
+      rack-mount (~> 0.8.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.0.3)
+    activemodel (3.1.4)
+      activesupport (= 3.1.4)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.4)
+      activemodel (= 3.1.4)
+      activesupport (= 3.1.4)
+      arel (~> 2.2.3)
+      tzinfo (~> 0.3.29)
+    activeresource (3.1.4)
+      activemodel (= 3.1.4)
+      activesupport (= 3.1.4)
+    activesupport (3.1.4)
+      multi_json (~> 1.0)
+    arel (2.2.3)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    git (1.2.5)
+    hike (1.2.1)
+    i18n (0.6.0)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.6.6)
+    mail (2.3.3)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.18)
+    multi_json (1.2.0)
+    polyglot (0.3.3)
+    rack (1.3.6)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.1.4)
+      actionmailer (= 3.1.4)
+      actionpack (= 3.1.4)
+      activerecord (= 3.1.4)
+      activeresource (= 3.1.4)
+      activesupport (= 3.1.4)
+      bundler (~> 1.0)
+      railties (= 3.1.4)
+    railties (3.1.4)
+      actionpack (= 3.1.4)
+      activesupport (= 3.1.4)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    rspec-rails (2.8.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec (~> 2.8.0)
+    simplecov (0.6.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    sprockets (2.0.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.5)
+    thor (0.14.6)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.33)
+    yaml_waml (0.3.0)
+    yard (0.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.1.0)
+  activesupport (~> 3.1.0)
+  bundler (~> 1.0.0)
+  jeweler (~> 1.8.3)
+  rails (~> 3.1.0)
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)
+  rspec-rails (~> 2.8.1)
+  simplecov
+  sqlite3
+  yaml_waml
+  yard (~> 0.7)

data/README.rdoc

@@ -1,7 +1,6 @@
-SchemaComments 
-==========
+= SchemaComments 
 
-== Install ==
+== Install
 
 === as a plugin
  ruby script/plugin install git://github.com/akm/schema_comments.git
@@ -26,7 +25,7 @@ If you install schema_comments as a gem, must create config/initializers/schema_
  SchemaComments.setup
 
 
-== overview ==
+== overview
 schema_commentsプラグインを使うと、テーブルとカラムにコメントを記述することができます。
 
  class CreateProducts < ActiveRecord::Migration
@@ -67,13 +66,13 @@ 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への対応 ==
+== I18nへの対応
 rake i18n:schema_comments:update_config_localeタスクを実行すると、i18n用のYAMLを更新できます。
 
 rake i18n:schema_comments:update_config_locale LOCALE=ja でデフォルトではconfig/locales/ja.ymlを更新します。
@@ -85,7 +84,7 @@ 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に出力されている場合、
@@ -113,17 +112,17 @@ ja:
 
 
 
-== MySQLのビュー ==
+== MySQLのビュー
 MySQLのビューを使用した場合、元々MySQLではSHOW TABLES でビューも表示してしまうため、
 ビューはテーブルとしてSchemaDumperに認識され、development環境ではMySQLのビューとして作成されているのに、
 test環境ではテーブルとして作成されてしまい、テストが正しく動かないことがあります。
 これを避けるため、schema_commentsでは、db/schema.rbを出力する際、テーブルに関する記述の後に、CREATE VIEWを行う記述を追加します。
 
 
-== annotate_models ==
+== annotate_models
 rake db:annotate で以下のようなコメントを、モデル、テスト、フィクスチャといったモデルに関係の強いファイルの
 先頭に追加します。
-  # == Schema Info ==
+  # == Schema Info
   # 
   # Schema version: 20090721185959
   #

data/Rakefile

@@ -1,50 +1,44 @@
+# encoding: utf-8
+
 require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
 require 'rake'
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "schema_comments"
-    gem.summary  = "schema_comments generates extra methods dynamically"
-    gem.description  = "schema_comments generates extra methods dynamically for attribute which has options"
-    gem.email = "akm2000@gmail.com"
-    gem.homepage = "http://github.com/akm/schema_comments"
-    gem.authors = ["akimatter"]
-    gem.add_development_dependency "rspec", ">= 1.2.9"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-    gem.test_files = Dir.glob('spec/**/*.rb') + Dir.glob('spec/**/*.yml')
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "schema_comments"
+  gem.homepage = "http://github.com/akm/schema_comments"
+  gem.license = "Ruby License"
+  gem.summary  = "schema_comments generates extra methods dynamically"
+  gem.description  = "schema_comments generates extra methods dynamically for attribute which has options"
+  gem.email = "akm2000@gmail.com"
+  gem.authors = ["akimatter"]
+  # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  gem.test_files = Dir.glob('spec/**/*.rb') + Dir.glob('spec/**/*.yml')
+  # dependencies defined in Gemfile
 end
+Jeweler::RubygemsDotOrgTasks.new
 
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
+RSpec::Core::RakeTask.new(:rcov) do |spec|
   spec.pattern = 'spec/**/*_spec.rb'
   spec.rcov = true
-  spec.rcov_opts = lambda do
-    IO.readlines("spec/rcov.opts").map {|l| l.chomp.split " "}.flatten
-  end
 end
 
-task :spec => :check_dependencies
-
 task :default => :spec
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "schema_comments #{version}"
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-  rdoc.options = ["--charset", "utf-8", "--line-numbers"]
-end
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -1 +1 @@
-0.1.4
+0.2.0.alpha1

data/lib/annotate_models.rb

@@ -2,16 +2,18 @@
 # fork from
 # http://github.com/rotuka/annotate_models/blob/d2afee82020dbc592b147d92f9beeadbf665a9e0/lib/annotate_models.rb
 
+require 'rails'
+
 require "config/environment" if File.exist?("config/environment")
 
-MODEL_DIR         = File.join(RAILS_ROOT, "app/models" )
-UNIT_TEST_DIR     = File.join(RAILS_ROOT, "test/unit"  )
-SPEC_MODEL_DIR    = File.join(RAILS_ROOT, "spec/models")
-FIXTURES_DIR      = File.join(RAILS_ROOT, "test/fixtures")
-SPEC_FIXTURES_DIR = File.join(RAILS_ROOT, "spec/fixtures")
+MODEL_DIR         = Rails.root.join("app/models" )
+UNIT_TEST_DIR     = Rails.root.join("test/unit"  )
+SPEC_MODEL_DIR    = Rails.root.join("spec/models")
+FIXTURES_DIR      = Rails.root.join("test/fixtures")
+SPEC_FIXTURES_DIR = Rails.root.join("spec/fixtures")
 
 module AnnotateModels
-  
+
   PREFIX_AT_BOTTOM = "== Schema Info"
   SUFFIX_AT_BOTTOM = ""
   PREFIX_ON_TOP = "== Schema Info =="
@@ -61,7 +63,7 @@ module AnnotateModels
       value.inspect
     end
   end
-  
+
   # Use the column information in an ActiveRecord class
   # to create a comment block containing a line for
   # each column. The line contains the column name,
@@ -71,7 +73,7 @@ module AnnotateModels
     table_info << " # #{klass.table_comment}" unless klass.table_comment.blank?
     table_info << "\n#\n"
     max_size = klass.column_names.collect{|name| name.size}.max + 1
-    
+
     columns = klass.columns
 
     cols = if self.sort_columns
@@ -83,10 +85,10 @@ module AnnotateModels
            else
              columns
            end
-    
+
     col_lines = append_comments(cols.map{|col| [col, annotate_column(col, klass, max_size)]})
     cols_text = col_lines.join("\n")
-    
+
     result = "# #{self.output_prefix}\n# \n# Schema version: #{get_schema_version}\n#\n"
     result << table_info
     result << cols_text
@@ -94,13 +96,13 @@ module AnnotateModels
     result << "\n"
     result
   end
-  
+
   def self.annotate_column(col, klass, max_size)
     attrs = []
     attrs << "not null" unless col.null
     attrs << "default(#{quote(col.default)})" if col.default
     attrs << "primary key" if col.name == klass.primary_key
-    
+
     col_type = col.type.to_s
     if col_type == "decimal"
       col_type << "(#{col.precision}, #{col.scale})"
@@ -120,7 +122,7 @@ module AnnotateModels
       end
     end
   end
-  
+
   # Add a schema block to a file. If the file already contains
   # a schema info block (a comment starting
   # with "Schema as of ..."), remove it first.
@@ -128,7 +130,7 @@ module AnnotateModels
   def self.annotate_one_file(file_name, info_block)
     if File.exist?(file_name)
       content = File.read(file_name)
-      
+
       encoding_comment = content.scan(/^\#\s*-\*-(.+?)-\*-/).flatten.first
       content.sub!(/^\#\s*-\*-(.+?)-\*-/, '')
 
@@ -136,7 +138,7 @@ module AnnotateModels
       content.sub!(/(\n)*^# #{PREFIX_ON_TOP}.*?\n(#.*\n)*# #{SUFFIX_ON_TOP}/, '')
       content.sub!(/(\n)*^# #{PREFIX_AT_BOTTOM}.*?\n(#.*\n)*#.*(\n)*/, '')
       content.sub!(/^[\n\s]*/, '')
-      
+
       # Write it back
       File.open(file_name, "w") do |f|
         f.print "# -*- #{encoding_comment.strip} -*-\n\n" unless encoding_comment.blank?
@@ -153,27 +155,27 @@ module AnnotateModels
     end
   end
 
-  
+
   # Given the name of an ActiveRecord class, create a schema
   # info block (basically a comment containing information
   # on the columns and their types) and put it at the front
-  # of the model and fixture source files.  
+  # of the model and fixture source files.
   def self.annotate(klass)
     info = get_schema_info(klass)
     model_name = klass.name.underscore
     fixtures_name = "#{klass.table_name}.yml"
-    
+
     [
       File.join(self.model_dir,     "#{model_name}.rb"),      # model
       File.join(UNIT_TEST_DIR,      "#{model_name}_test.rb"), # test
       File.join(FIXTURES_DIR,       fixtures_name),           # fixture
       File.join(SPEC_MODEL_DIR,     "#{model_name}_spec.rb"), # spec
       File.join(SPEC_FIXTURES_DIR,  fixtures_name),           # spec fixture
-      File.join(RAILS_ROOT,         'test', 'factories.rb'),  # factories file
-      File.join(RAILS_ROOT,         'spec', 'factories.rb'),  # factories file
+      Rails.root.join(        'test', 'factories.rb'),  # factories file
+      Rails.root.join(        'spec', 'factories.rb'),  # factories file
     ].each { |file| annotate_one_file(file, info) }
   end
-  
+
   # Return a list of the model files to annotate. If we have
   # command line arguments, they're assumed to be either
   # the underscore or CamelCase versions of model names.
@@ -183,16 +185,16 @@ module AnnotateModels
     result = nil
     if self.models.empty?
       Dir.chdir(self.model_dir) do
-        result = Dir["**/*.rb"].map do |filename| 
+        result = Dir["**/*.rb"].map do |filename|
           filename.sub(/\.rb$/, '').camelize
         end
       end
     else
       result = self.models.dup
     end
-    result 
+    result
   end
-  
+
   # We're passed a name of things that might be
   # ActiveRecord models. If we can find the class, and
   # if its a subclass of ActiveRecord::Base,
@@ -213,7 +215,7 @@ module AnnotateModels
     end
     puts "Annotated #{annotated.join(', ')}"
   end
-  
+
   def self.get_schema_version
     unless @schema_version
       version = ActiveRecord::Migrator.current_version rescue 0

data/lib/hash_key_orderable.rb

@@ -1,6 +1,6 @@
 module HashKeyOrderable
   attr_accessor :key_order
-  
+
   def each_with_key_order(&block)
     if @key_order.nil? || @key_order.empty?
       each_without_key_order(&block)

data/lib/schema_comments/base.rb

@@ -7,12 +7,12 @@ module SchemaComments
         alias :columns :columns_with_schema_comments
       end
     end
-    
+
     module ClassMethods
       def table_comment
         @table_comment ||= connection.table_comment(table_name)
       end
-      
+
       def columns_with_schema_comments
         result = columns_without_schema_comments
         unless @column_comments_loaded
@@ -24,17 +24,17 @@ module SchemaComments
         end
         result
       end
-      
+
       def reset_column_comments
         @column_comments_loaded = false
       end
-      
+
       def reset_table_comments
         @table_comment = nil
       end
-      
+
       attr_accessor_with_default :ignore_pattern_to_export_i18n, /\[.*\]/
-      
+
       def export_i18n_models
         subclasses = ActiveRecord::Base.send(:subclasses).select do |klass|
           (klass != SchemaComments::SchemaComment) and
@@ -47,7 +47,7 @@ module SchemaComments
           d
         end
       end
-      
+
       def export_i18n_attributes(connection = ActiveRecord::Base.connection)
         subclasses = ActiveRecord::Base.send(:subclasses).select do |klass|
           (klass != SchemaComments::SchemaComment) and
@@ -65,8 +65,8 @@ module SchemaComments
           d
         end
       end
-      
+
     end
-    
+
   end
 end

data/lib/schema_comments/connection_adapters.rb

@@ -40,16 +40,21 @@ module SchemaComments
       #   column_comments(:users, {:first_name => "User's given name", :last_name => "Family name"})
       #   column_comments(:tags , {:id => "Tag IDentifier"})
       def column_comments(*args)
-        if (args.length == 2) && args.last.is_a?(Hash)
-          # マイグレーションからActiveRecord関係を経由して呼び出されます。
-          table_name = args.first.to_s
-          args.last.each do |col, comment|
-            column_comment(table_name, col, comment) unless SchemaComments.quiet
+        case args.length
+        when 1 then
+           # こっちはSchemaComments::Base::ClassMethods#columns_with_schema_commentsから呼び出されます。
+          return SchemaComment.column_comments(args.first)
+        when 2 then
+          if args.last.is_a?(Hash)
+            # マイグレーションからActiveRecord関係を経由して呼び出されます。
+            table_name = args.first.to_s
+            args.last.each do |col, comment|
+              column_comment(table_name, col, comment) unless SchemaComments.quiet
+            end
+            return
           end
-        else
-          # こっちはSchemaComments::Base::ClassMethods#columns_with_schema_commentsから呼び出されます。
-          SchemaComment.column_comments(args)
         end
+        raise ArgumentError, "#{self.class}#column_comments accepts (tabel_name) or (tabel_name, hash_col_comment)"
       end
 
       def table_comment(table_name, comment = nil) #:nodoc:

data/lib/schema_comments/migration.rb

@@ -7,7 +7,7 @@ module SchemaComments
         alias :migrate :migrate_with_schema_comments
       end
     end
-    
+
     module ClassMethods
       def migrate_with_schema_comments(*args, &block)
         SchemaComments::SchemaComment.yaml_access do
@@ -15,6 +15,6 @@ module SchemaComments
         end
       end
     end
-    
+
   end
 end

data/lib/schema_comments/migrator.rb

@@ -7,7 +7,7 @@ module SchemaComments
         alias :migrate :migrate_with_schema_comments
       end
     end
-    
+
     module ClassMethods
       def migrate_with_schema_comments(*args, &block)
         SchemaComments::SchemaComment.yaml_access do
@@ -15,6 +15,6 @@ module SchemaComments
         end
       end
     end
-    
+
   end
 end

data/lib/schema_comments/schema.rb

@@ -7,7 +7,7 @@ module SchemaComments
         alias :define :define_with_schema_comments
       end
     end
-    
+
     module ClassMethods
       def define_with_schema_comments(*args, &block)
         SchemaComments::SchemaComment.yaml_access do

data/lib/schema_comments/schema_comment.rb

@@ -3,7 +3,7 @@ require 'yaml/store'
 require 'hash_key_orderable'
 
 module SchemaComments
-  
+
   # 現在はActiveRecord::Baseを継承していますが、将来移行が完全に終了した
   # 時点で、ActiveRecord::Baseの継承をやめます。
   #
@@ -23,7 +23,7 @@ module SchemaComments
         return nil unless table_exists?
         connection.select_value(sanitize_conditions("select descriptions from schema_comments where table_name = '%s' and column_name is null" % table_name))
       end
-      
+
       def column_comment(table_name, column_name)
         if yaml_exist?
           @column_names ||= yaml_access{|db| db[COLUMN_KEY] }.dup
@@ -33,7 +33,7 @@ module SchemaComments
         return nil unless table_exists?
         connection.select_value(sanitize_conditions("select descriptions from schema_comments where table_name = '%s' and column_name = '%s'" % [table_name, column_name]))
       end
-      
+
       def column_comments(table_name)
         if yaml_exist?
           result = nil
@@ -45,14 +45,14 @@ module SchemaComments
         hash_array = connection.select_all(sanitize_conditions("select column_name, descriptions from schema_comments where table_name = '%s' and column_name is not null" % table_name))
         hash_array.inject({}){|dest, r| dest[r['column_name']] = r['descriptions']; dest}
       end
-      
+
       def save_table_comment(table_name, comment)
         yaml_access do |db|
           db[TABLE_KEY][table_name.to_s] = comment
         end
         @table_names = nil
       end
-      
+
       def save_column_comment(table_name, column_name, comment)
         yaml_access do |db|
           db[COLUMN_KEY][table_name.to_s] ||= {}
@@ -60,7 +60,7 @@ module SchemaComments
         end
         @column_names = nil
       end
-      
+
       def destroy_of(table_name, column_name)
         yaml_access do |db|
           column_hash = db[COLUMN_KEY][table_name.to_s]
@@ -68,7 +68,7 @@ module SchemaComments
         end
         @column_names = nil
       end
-      
+
       def update_table_name(table_name, new_name)
         if yaml_exist?
           yaml_access do |db|
@@ -79,7 +79,7 @@ module SchemaComments
         @table_names = nil
         @column_names = nil
       end
-      
+
       def update_column_name(table_name, column_name, new_name)
         if yaml_exist?
           yaml_access do |db|
@@ -92,11 +92,11 @@ module SchemaComments
         @table_names = nil
         @column_names = nil
       end
-      
+
       def yaml_exist?
         File.exist?(SchemaComments.yaml_path)
       end
-      
+
       def yaml_access(&block)
         if @yaml_transaction
           yield(@yaml_transaction) if block_given?