schema_comments 0.2.0 → 0.3.0

data/spec/resources/models/product.rb

@@ -1,2 +0,0 @@
-class Product < ActiveRecord::Base
-end

data/spec/resources/models/product_name.rb

@@ -1,2 +0,0 @@
-class ProductName < ActiveRecord::Base
-end

data/spec/schema.rb

@@ -1,2 +0,0 @@
-ActiveRecord::Schema.define(:version => 0) do
-end

data/spec/schema_comments/connection_adapters_spec.rb

@@ -1,54 +0,0 @@
-# -*- coding: utf-8 -*-
-require File.join(File.dirname(__FILE__), '../spec_helper')
-
-describe SchemaComments::ConnectionAdapters do
-
-  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}"
-
-    (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
-
-    ActiveRecord::Migrator.up(migration_path, 1)
-    ActiveRecord::Migrator.current_version.should == 1
-
-    ActiveRecord::Base.export_i18n_models.keys.include?('product').should == true
-    ActiveRecord::Base.export_i18n_models['product'].should == '商品'
-
-    ActiveRecord::Base.export_i18n_attributes.keys.include?('product').should == true
-    ActiveRecord::Base.export_i18n_attributes['product'].should == {
-      'product_type_cd' => '種別コード',
-      "price" => "価格",
-      "name" => "商品名",
-      "created_at" => "登録日時",
-      "updated_at" => "更新日時"
-    }
-  end
-
-  describe SchemaComments::ConnectionAdapters::Column do
-    describe :comment do
-      it "should return comment" do
-        Product.columns.detect{|c| c.name == "product_type_cd"}.comment.should == '種別コード'
-        Product.columns.detect{|c| c.name == "price"}.comment.should == '価格'
-        Product.columns.detect{|c| c.name == "name"}.comment.should == '商品名'
-        Product.columns.detect{|c| c.name == "created_at"}.comment.should == '登録日時'
-        Product.columns.detect{|c| c.name == "updated_at"}.comment.should == '更新日時'
-      end
-    end
-
-  end
-end

data/spec/schema_comments/schema_comment_spec.rb

@@ -1,76 +0,0 @@
-# -*- coding: utf-8 -*-
-require File.join(File.dirname(__FILE__), '../spec_helper')
-
-describe SchemaComments::SchemaComment do
-
-  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.yml

@@ -1,10 +0,0 @@
----
-table_comments:
-  products: 商品
-column_comments:
-  products:
-    product_type_cd: 種別コード
-    price: 価格
-    name: 商品名
-    created_at: 登録日時
-    updated_at: 更新日時

data/spec/schema_comments/schema_comments_broken_column_comments.yml

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

data/spec/schema_comments/schema_comments_broken_column_hash.yml

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

data/spec/schema_comments/schema_comments_broken_table_comments.yml

@@ -1,13 +0,0 @@
---- 
-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

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

data/spec/schema_comments/schema_dumper_spec.rb

@@ -1,92 +0,0 @@
-# -*- coding: utf-8 -*-
-require File.join(File.dirname(__FILE__), '../spec_helper')
-
-describe ActiveRecord::SchemaDumper do
-
-  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 :dump do
-    it "products" do
-      (ActiveRecord::Base.connection.tables - %w(schema_migrations)).should == []
-
-      migration_path = File.join(MIGRATIONS_ROOT, 'valid')
-      Dir.glob('*.rb').each{|file| require(file) if /^\d+?_.*/ =~ file}
-
-      Product.reset_table_comments
-      Product.reset_column_comments
-
-      ActiveRecord::Migrator.up(migration_path, 1)
-      ActiveRecord::Migrator.current_version.should == 1
-
-      ActiveRecord::Base.export_i18n_models.keys.include?('product').should == true
-      ActiveRecord::Base.export_i18n_models['product'].should == '商品'
-
-      ActiveRecord::Base.export_i18n_attributes.keys.include?('product').should == true
-      ActiveRecord::Base.export_i18n_attributes['product'].should == {
-        'product_type_cd' => '種別コード',
-        "price" => "価格",
-        "name" => "商品名",
-        "created_at" => "登録日時",
-        "updated_at" => "更新日時"
-      }
-
-      dest = StringIO.new
-      # ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, dest)
-      SchemaComments::SchemaDumper.dump(ActiveRecord::Base.connection, dest)
-      dest.rewind
-      s = <<EOS
-# encoding: UTF-8
-# This file is auto-generated from the current state of the database. Instead
-# of editing this file, please use the migrations feature of Active Record to
-# incrementally modify your database, and then regenerate this schema definition.
-#
-# Note that this schema.rb definition is the authoritative source for your
-# database schema. If you need to create the application database on another
-# system, you should be using db:schema:load, not running all the migrations
-# 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.
-
-ActiveRecord::Schema.define(:version => 1) do
-
-  create_table "products", :force => true, :comment => '商品' do |t|
-EOS
-
-      if ENV['DB'] =~ /mysql/i
-        s << <<EOS
-    #t.column "id",              "int(11)",      :null => false, :comment => "AUTO_INCREMENT PRIMARY KEY by rails"
-    t.column "product_type_cd", "varchar(255)",                 :comment => "種別コード"
-    t.column "price",           "int(11)",                      :comment => "価格"
-    t.column "name",            "varchar(255)",                 :comment => "商品名"
-    t.column "created_at",      "datetime",                     :comment => "登録日時"
-    t.column "updated_at",      "datetime",                     :comment => "更新日時"
-EOS
-      else
-        s << <<EOS
-    t.string   "product_type_cd", :comment => "種別コード"
-    t.integer  "price",           :comment => "価格"
-    t.string   "name",            :comment => "商品名"
-    t.datetime "created_at",      :comment => "登録日時"
-    t.datetime "updated_at",      :comment => "更新日時"
-EOS
-      end
-      s << <<EOS
-  end
-
-end
-EOS
-      dest.read.should == s
-    end
-
-  end
-end

data/spec/schema_comments.yml

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

data/spec/spec_helper.rb

@@ -1,53 +0,0 @@
-if ENV["COVERAGE"] and not(ENV["COVERAGE"].empty?)
-  require "simplecov"
-  SimpleCov.start
-end
-
-ENV['DB'] ||= 'sqlite3'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-
-require 'rails'
-require 'schema_comments'
-# require 'database_cleaner'
-SchemaComments.yaml_path = File.expand_path("schema_comments.yml", File.dirname(__FILE__))
-
-# Ensure we use 'syck' instead of 'psych' in 1.9.2
-# RubyGems >= 1.5.0 uses 'psych' on 1.9.2, but
-# Psych does not yet support YAML 1.1 merge keys.
-# Merge keys is often used in mongoid.yml
-# See: http://redmine.ruby-lang.org/issues/show/4300
-# if RUBY_VERSION >= '1.9.2'
-
-# if defined?(YAML::ENGINE) && YAML::ENGINE.respond_to?(:yamler=)
-#   YAML::ENGINE.yamler = 'syck'
-# end
-
-# require 'yaml_waml'
-
-require 'fake_app'
-
-require 'rspec/rails'
-
-# Requires supporting files with custom matchers and macros, etc,
-# in ./support/ and its subdirectories.
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
-
-
-RSpec.configure do |config|
-
-  %w(resources/models).each do |path|
-    $LOAD_PATH.unshift File.join(File.dirname(__FILE__), path)
-    ActiveSupport::Dependencies.autoload_paths << File.join(File.dirname(__FILE__), path)
-  end
-  Dir.glob("resources/**/*.rb") do |filename|
-    require filename
-  end
-
-  SchemaComments.setup
-end
-
-MIGRATIONS_ROOT = File.join(File.dirname(__FILE__), 'migrations')
-
-IGNORED_TABLES = %w(schema_migrations)

data/spec/yaml_export_spec.rb

@@ -1,52 +0,0 @@
-# -*- coding: utf-8 -*-
-require File.join(File.dirname(__FILE__), 'spec_helper')
-
-describe SchemaComments::SchemaComment do
-
-  before(:each) do
-    SchemaComments.yaml_path = File.join(File.dirname(__FILE__), 'human_readable_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
-
-  it "should export human readable yaml" do
-    ActiveRecord::Schema.define(:version => 0) do
-      create_table(:person, :comment => '人') do |t|
-        t.string :name, :comment => '名前'
-      end
-
-      create_table(:addresses, :comment => '住所') do |t|
-        t.integer :person_id, :comment => '人'
-        t.text :descriptions, :comment => '記述'
-      end
-
-      create_table(:emails, :comment => 'メール') do |t|
-        t.integer :person_id, :comment => '人'
-        t.string :address, :comment => 'アドレス'
-      end
-    end
-
-    File.read(SchemaComments.yaml_path).split(/$/).map(&:strip).should == %{
----
-table_comments:
-  addresses: 住所
-  emails: メール
-  person: 人
-column_comments:
-  addresses:
-    person_id: 人
-    descriptions: 記述
-  emails:
-    person_id: 人
-    address: アドレス
-  person:
-    name: 名前
-}.split(/$/).map(&:strip)
-  end
-
-end