schema_comments 0.1.3 → 0.1.4

data/README.rdoc

@@ -8,7 +8,7 @@ SchemaComments
 
 === as a gem
 insert following line to config/environment.rb
-  config.gem 'schema_comments', :version => '0.1.3'
+  config.gem 'schema_comments', :version => '0.1.4'
 and 
  $ sudo rake gems:install
 

data/Rakefile

@@ -12,6 +12,7 @@ begin
     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

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.1.4

data/lib/schema_comments.rb

@@ -15,7 +15,10 @@ module SchemaComments
   self.yaml_path = DEFAULT_YAML_PATH
 
   mattr_accessor :quiet
-  
+
+  class YamlError < StandardError
+  end
+
   class << self
     def setup
       base_names = %w(Base Migration Migrator Schema SchemaDumper) +

data/lib/schema_comments/schema_comment.rb

@@ -3,6 +3,7 @@ require 'yaml/store'
 require 'hash_key_orderable'
 
 module SchemaComments
+  
   # 現在はActiveRecord::Baseを継承していますが、将来移行が完全に終了した
   # 時点で、ActiveRecord::Baseの継承をやめます。
   #
@@ -128,8 +129,8 @@ module SchemaComments
           io.rewind
           root = YAML.load(io)
         end
-        table_comments = root['table_comments']
-        column_comments = root['column_comments']
+        table_comments = root['table_comments'] || {}
+        column_comments = root['column_comments'] || {}
         # 大元は
         # table_comments:
         #   ...
@@ -138,17 +139,21 @@ module SchemaComments
         # その他
         #   ...
         # の順番です。
+        raise YamlError, "Broken schame_comments.yml" unless root.is_a?(Hash)
         root.extend(HashKeyOrderable)
         root.key_order = %w(table_comments column_comments)
         # table_comments はテーブル名のアルファベット順
         table_names = ActiveRecord::Base.connection.tables.sort - ['schema_migrations']
+        raise YamlError, "Broken schame_comments.yml" unless table_comments.is_a?(Hash)
         table_comments.extend(HashKeyOrderable)
         table_comments.key_order = table_names
         # column_comments もテーブル名のアルファベット順
+        raise YamlError, "Broken schame_comments.yml" unless column_comments.is_a?(Hash)
         column_comments.extend(HashKeyOrderable)
         column_comments.key_order = table_names
         # column_comments の各値はテーブルのカラム順
         column_comments.each do |table_name, column_hash|
+          column_hash ||= {}
           column_names = nil
           begin
             columns = ActiveRecord::Base.connection.columns_without_schema_comments(table_name, "#{table_name.classify} Columns")
@@ -157,6 +162,7 @@ module SchemaComments
             column_names = column_hash.keys.sort
           end
           column_names.delete('id')
+          raise YamlError, "Broken schame_comments.yml" unless column_hash.is_a?(Hash)
           column_hash.extend(HashKeyOrderable)
           column_hash.key_order = column_names
         end

data/schema_comments.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{schema_comments}
-  s.version = "0.1.3"
+  s.version = "0.1.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["akimatter"]
-  s.date = %q{2010-04-13}
+  s.date = %q{2010-04-14}
   s.description = %q{schema_comments generates extra methods dynamically for attribute which has options}
   s.email = %q{akm2000@gmail.com}
   s.extra_rdoc_files = [
@@ -50,12 +50,18 @@ Gem::Specification.new do |s|
      "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/rcov.opts",
      "spec/resources/models/product.rb",
      "spec/resources/models/product_name.rb",
      "spec/schema.rb",
      "spec/schema_comments/.gitignore",
      "spec/schema_comments/connection_adapters_spec.rb",
+     "spec/schema_comments/schema_comment_spec.rb",
+     "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/schema_dumper_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb",
@@ -80,13 +86,23 @@ Gem::Specification.new do |s|
      "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/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"
   ]
 
   if s.respond_to? :specification_version then

data/spec/i18n_export_spec.rb

@@ -3,10 +3,6 @@ require File.join(File.dirname(__FILE__), 'spec_helper')
 
 describe SchemaComments::Base do
 
-  MIGRATIONS_ROOT = File.join(File.dirname(__FILE__), 'migrations')
-
-  IGNORED_TABLES = %w(schema_migrations)
-  
   before(:each) do
     SchemaComments.yaml_path = File.expand_path(File.join(File.dirname(__FILE__), 'schema_comments.yml'))
     FileUtils.rm(SchemaComments.yaml_path, :verbose => true) if File.exist?(SchemaComments.yaml_path)

data/spec/migration_spec.rb

@@ -3,10 +3,6 @@ require File.join(File.dirname(__FILE__), 'spec_helper')
 
 describe ActiveRecord::Migrator do
 
-  MIGRATIONS_ROOT = File.join(File.dirname(__FILE__), 'migrations')
-
-  IGNORED_TABLES = %w(schema_migrations)
-  
   before(:each) do
     SchemaComments.yaml_path = File.expand_path(File.join(File.dirname(__FILE__), 'schema_comments.yml'))
     FileUtils.rm(SchemaComments.yaml_path, :verbose => true) if File.exist?(SchemaComments.yaml_path)
@@ -17,15 +13,15 @@ describe ActiveRecord::Migrator do
     ActiveRecord::Base.connection.initialize_schema_migrations_table
     ActiveRecord::Base.connection.execute "DELETE FROM #{ActiveRecord::Migrator.schema_migrations_table_name}"
   end
-  
+
   it "test_valid_migration" do
     (ActiveRecord::Base.connection.tables - %w(schema_migrations)).should == []
-    
+
     migration_path = File.join(MIGRATIONS_ROOT, 'valid')
     Dir.glob('*.rb').each do |file|
       require(file) if /^\d+?_.*/ =~ file
     end
-    
+
     Product.reset_table_comments
     Product.reset_column_comments
 
@@ -34,7 +30,7 @@ describe ActiveRecord::Migrator do
     ActiveRecord::Migrator.current_version.should == 1
     Product.table_comment.should == '商品'
     {
-      'product_type_cd' => '種別コード', 
+      'product_type_cd' => '種別コード',
       "price" => "価格",
       "name" => "商品名",
       "created_at" => "登録日時",
@@ -42,17 +38,17 @@ describe ActiveRecord::Migrator do
     }.each do |col_name, comment|
       Product.columns.detect{|c| c.name.to_s == col_name}.comment.should == comment
     end
-    
+
     ActiveRecord::Migrator.down(migration_path, 0)
     # SchemaComments::SchemaComment.count.should == 0
-    
+
     ActiveRecord::Migrator.up(migration_path, 1)
     ActiveRecord::Migrator.up(migration_path, 2)
     ActiveRecord::Migrator.current_version.should == 2
-    
+
     ProductName.table_comment.should == '商品'
     {
-      'product_type_cd' => '種別コード', 
+      'product_type_cd' => '種別コード',
       "price" => "価格",
       "name" => "商品名",
       "created_at" => "登録日時",
@@ -60,13 +56,13 @@ describe ActiveRecord::Migrator do
     }.each do |col_name, comment|
       ProductName.columns.detect{|c| c.name == col_name}.comment.should == comment
     end
-    
+
     ActiveRecord::Migrator.down(migration_path, 1)
     ActiveRecord::Migrator.current_version.should == 1
-    
+
     Product.table_comment.should == '商品'
     {
-      'product_type_cd' => '種別コード', 
+      'product_type_cd' => '種別コード',
       "price" => "価格",
       "name" => "商品名",
       "created_at" => "登録日時",
@@ -74,11 +70,11 @@ describe ActiveRecord::Migrator do
     }.each do |col_name, comment|
       Product.columns.detect{|c| c.name == col_name}.comment.should == comment
     end
-    
+
     ActiveRecord::Migrator.up(migration_path, 4)
     ActiveRecord::Migrator.current_version.should == 4
     # SchemaComments::SchemaComment.count.should == 5
-    
+
     ActiveRecord::Migrator.down(migration_path, 3)
     ActiveRecord::Migrator.current_version.should == 3
     # SchemaComments::SchemaComment.count.should == 6
@@ -104,6 +100,9 @@ describe ActiveRecord::Migrator do
     Product.reset_column_comments
     Product.columns.detect{|c| c.name == 'name'}.comment.should == '商品名称'
     Product.columns.detect{|c| c.name == 'product_type_cd'}.comment.should == 'カテゴリコード'
+
+    ActiveRecord::Migrator.up(migration_path, 8)
+    ActiveRecord::Migrator.current_version.should == 8
   end
-  
+
 end

data/spec/migrations/valid/008_create_users_without_comment.rb

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+class CreateUsersWithoutComment < ActiveRecord::Migration
+  def self.up
+    create_table :users do |t|
+      t.string :login
+      t.string :email
+      t.string :crypted_password
+      t.string :password_salt
+      t.string :persistence_token
+      t.string :single_access_token
+      t.string :perishable_token
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :users
+  end
+end

data/spec/schema_comments/schema_comment_spec.rb

@@ -0,0 +1,78 @@
+# -*- coding: utf-8 -*-
+require File.join(File.dirname(__FILE__), '../spec_helper')
+
+describe SchemaComments::SchemaComment do
+
+  IGNORED_TABLES = %w(schema_migrations)
+
+  before(:each) do
+    SchemaComments.yaml_path = File.expand_path(File.join(File.dirname(__FILE__), 'schema_comments.yml'))
+    FileUtils.rm(SchemaComments.yaml_path, :verbose => true) if File.exist?(SchemaComments.yaml_path)
+    
+    (ActiveRecord::Base.connection.tables - IGNORED_TABLES).each do |t|
+      ActiveRecord::Base.connection.drop_table(t) rescue nil
+    end
+    ActiveRecord::Base.connection.initialize_schema_migrations_table
+    ActiveRecord::Base.connection.execute "DELETE FROM #{ActiveRecord::Migrator.schema_migrations_table_name}"
+  end
+
+  describe :yaml_access do
+    before{@original_yaml_path = SchemaComments.yaml_path}
+    after {SchemaComments.yaml_path = @original_yaml_path}
+
+    # http://d.hatena.ne.jp/akm/20091213#c1271134505
+    # プラグインの更新ご苦労さまです。
+    # とても便利に使わせていただいてます。
+    #
+    # ところが本日更新してみたら0.1.3になっていて、
+    # コメントの生成に失敗するようになってしまいました。
+    #
+    # 原因を探ってみましたところ、
+    # コメントを一個も書いていないマイグレーションでは、
+    # nilにHashKeyOrderableをextendしようとして落ちていました。
+    #
+    # プラグインによって自動で作られるマイグレーションがあるのですが、
+    # 必ずしもコメントを書くとは限らないので、
+    # コメントがないときは無視？もしくはそのままカラム名をいれるのがいいのかなと思いました。
+    #
+    # # schema_comment.rb:154-164　あたり
+    #
+    # よろしければ対応していただけたらと思います。
+    it "dump without column comment" do
+      migration_path = File.join(MIGRATIONS_ROOT, 'valid')
+      Dir.glob('*.rb').each{|file| require(file) if /^\d+?_.*/ =~ file}
+
+      ActiveRecord::Migrator.up(migration_path, 8)
+      ActiveRecord::Migrator.current_version.should == 8
+
+      SchemaComments.yaml_path = 
+        File.expand_path(File.join(
+          File.dirname(__FILE__), "schema_comments_users_without_column_hash.yml"))
+      SchemaComments::SchemaComment.yaml_access do |db|
+        db['column_comments']['products']['name'] = "商品名"
+      end
+    end
+    {
+      "table_comments" => lambda{|db| db['column_comments']['users']['login'] = "ログイン"},
+      "column_comments" => lambda{|db| db['table_comments']['users'] = "物品"},
+      "column_hash" => lambda{|db| db['column_comments']['users']['login'] = "ログイン"}
+    }.each  do |broken_type, proc|
+      it "raise SchemaComments::YamlError with broken #{broken_type}" do
+        migration_path = File.join(MIGRATIONS_ROOT, 'valid')
+        Dir.glob('*.rb').each{|file| require(file) if /^\d+?_.*/ =~ file}
+
+        ActiveRecord::Migrator.up(migration_path, 8)
+        ActiveRecord::Migrator.current_version.should == 8
+
+        SchemaComments.yaml_path = 
+          File.expand_path(File.join(
+            File.dirname(__FILE__), "schema_comments_broken_#{broken_type}.yml"))
+        lambda{
+          SchemaComments::SchemaComment.yaml_access(&proc)
+        }.should raise_error(SchemaComments::YamlError)
+      end
+    end
+    
+  end
+
+end

data/spec/schema_comments/schema_comments_broken_column_comments.yml

@@ -0,0 +1,7 @@
+--- 
+table_comments: 
+  products: "商品"
+column_comments: 
+- "ここには"
+- "配列ではなく"
+- "Hashを期待しています"

data/spec/schema_comments/schema_comments_broken_column_hash.yml

@@ -0,0 +1,10 @@
+--- 
+table_comments: 
+  products: "商品"
+column_comments: 
+  products: 
+  - "ここには"
+  - "配列ではなく"
+  - "Hashを期待しています"
+  users:
+    login: "ログインID"

data/spec/schema_comments/schema_comments_broken_table_comments.yml

@@ -0,0 +1,13 @@
+--- 
+table_comments: 
+- "ここには"
+- "配列ではなく"
+- "Hashを期待しています"
+column_comments: 
+  products: 
+    product_type_cd: "カテゴリコード"
+    name: "商品名称"
+    created_at: "登録日時"
+    updated_at: "更新日時"
+  users:
+    login: "ログインID"

data/spec/schema_comments/schema_comments_users_without_column_hash.yml

@@ -0,0 +1,10 @@
+--- 
+table_comments: 
+  products: "商品"
+column_comments: 
+  products: 
+    product_type_cd: "カテゴリコード"
+    name: "商品名"
+    created_at: "登録日時"
+    updated_at: "更新日時"
+  users: 

data/spec/schema_comments/schema_dumper_spec.rb

@@ -21,9 +21,7 @@ describe ActiveRecord::SchemaDumper do
       (ActiveRecord::Base.connection.tables - %w(schema_migrations)).should == []
 
       migration_path = File.join(MIGRATIONS_ROOT, 'valid')
-      Dir.glob('*.rb').each do |file|
-        require(file) if /^\d+?_.*/ =~ file
-      end
+      Dir.glob('*.rb').each{|file| require(file) if /^\d+?_.*/ =~ file}
 
       Product.reset_table_comments
       Product.reset_column_comments

data/spec/spec_helper.rb

@@ -42,5 +42,10 @@ unless defined?(RAILS_ENV)
 
   $LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
   require File.join(File.dirname(__FILE__), '..', 'init')
+
+
+  MIGRATIONS_ROOT = File.join(File.dirname(__FILE__), 'migrations')
+
+  IGNORED_TABLES = %w(schema_migrations)
 end
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 3
-  version: 0.1.3
+  - 4
+  version: 0.1.4
 platform: ruby
 authors: 
 - akimatter
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-13 00:00:00 +09:00
+date: 2010-04-14 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -74,12 +74,18 @@ files:
 - 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/rcov.opts
 - spec/resources/models/product.rb
 - spec/resources/models/product_name.rb
 - spec/schema.rb
 - spec/schema_comments/.gitignore
 - spec/schema_comments/connection_adapters_spec.rb
+- spec/schema_comments/schema_comment_spec.rb
+- 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/schema_dumper_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -128,10 +134,20 @@ test_files:
 - 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