schema_comments 0.1.0

data/spec/migrations/valid/002_rename_products.rb

@@ -0,0 +1,10 @@
+# -*- coding: utf-8 -*-
+class RenameProducts < ActiveRecord::Migration
+  def self.up
+    rename_table "products", "product_names"
+  end
+
+  def self.down
+    rename_table "product_names", "products"
+  end
+end

data/spec/migrations/valid/003_rename_products_again.rb

@@ -0,0 +1,10 @@
+# -*- coding: utf-8 -*-
+class RenameProductsAgain < ActiveRecord::Migration
+  def self.up
+    rename_table "product_names", "products"
+  end
+
+  def self.down
+    rename_table "products", "product_names"
+  end
+end

data/spec/migrations/valid/004_remove_price.rb

@@ -0,0 +1,10 @@
+# -*- coding: utf-8 -*-
+class RemovePrice < ActiveRecord::Migration
+  def self.up
+    remove_column "products", "price"
+  end
+
+  def self.down
+    add_column "products", "price", :integer, :comment => "価格"
+  end
+end

data/spec/migrations/valid/005_change_products_name.rb

@@ -0,0 +1,10 @@
+# -*- coding: utf-8 -*-
+class ChangeProductsName < ActiveRecord::Migration
+  def self.up
+    change_column "products", 'name', :string, :limit => 50
+  end
+
+  def self.down
+    change_column "products", 'name', :string
+  end
+end

data/spec/migrations/valid/006_change_products_name_with_comment.rb

@@ -0,0 +1,10 @@
+# -*- coding: utf-8 -*-
+class ChangeProductsNameWithComment < ActiveRecord::Migration
+  def self.up
+    change_column "products", 'name', :string, :limit => 100, :comment => "名称"
+  end
+
+  def self.down
+    change_column "products", 'name', :string, :limit => 50, :comment => "商品名"
+  end
+end

data/spec/resources/models/product.rb

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

data/spec/resources/models/product_name.rb

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

data/spec/schema.rb

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

data/spec/schema_dumper_spec.rb

@@ -0,0 +1,74 @@
+# -*- coding: utf-8 -*-
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe ActiveRecord::SchemaDumper 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
+  
+  it "dump" 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
+
+    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)
+    dest.rewind
+    dest.read.should == <<EOS
+# 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|
+    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
+EOS
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1,6 @@
+--colour
+--format
+progress
+--loadby
+mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,46 @@
+$KCODE='u'
+
+ENV['RAILS_ENV'] ||= 'test'
+unless defined?(RAILS_ENV)
+  FIXTURES_ROOT = File.join(File.dirname(__FILE__), 'fixtures') unless defined?(FIXTURES_ROOT)
+
+  RAILS_ENV = 'test' 
+  RAILS_ROOT = File.dirname(__FILE__) unless defined?(RAILS_ROOT)
+
+  require 'rubygems'
+  require 'spec'
+
+  require 'active_support'
+  require 'active_record'
+  # require 'action_mailer'
+  require 'action_controller'
+  require 'action_view'
+  require 'initializer'
+
+  require 'yaml'
+  begin
+    require 'yaml_waml'
+  rescue
+    $stderr.puts "yaml_waml not found. You should [sudo] gem install kakutani-yaml_waml"
+  end
+
+  config = YAML.load(IO.read(File.join(File.dirname(__FILE__), 'database.yml')))
+  ActiveRecord::Base.logger = Logger.new(File.join(File.dirname(__FILE__), 'debug.log'))
+  ActionController::Base.logger = ActiveRecord::Base.logger
+  ActiveRecord::Base.establish_connection(config[ENV['DB'] || 'sqlite3'])
+
+
+  load(File.join(File.dirname(__FILE__), 'schema.rb'))
+
+  %w(resources/models).each do |path|
+    $LOAD_PATH.unshift File.join(File.dirname(__FILE__), path)
+    ActiveSupport::Dependencies.load_paths << File.join(File.dirname(__FILE__), path)
+  end
+  Dir.glob("resources/**/*.rb") do |filename|
+    require filename
+  end
+
+  $LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+  require File.join(File.dirname(__FILE__), '..', 'init')
+end
+

data/spec/yaml_export_spec.rb

@@ -0,0 +1,52 @@
+# -*- 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

data/tasks/annotate_models_tasks.rake

@@ -0,0 +1,12 @@
+# Original file
+# http://github.com/rotuka/annotate_models/blob/d2afee82020dbc592b147d92f9beeadbf665a9e0/tasks/annotate_models_tasks.rake
+namespace :db do
+  desc "Add schema information (as comments) to model files"
+  task :annotate => :environment do
+    require File.join(File.dirname(__FILE__), "../lib/annotate_models.rb")
+    AnnotateModels.do_annotations
+  end
+ 
+  desc "Updates database (migrate and annotate models)"
+  task :update => %w(migrate annotate)
+end

data/tasks/schema_comments.rake

@@ -0,0 +1,204 @@
+# -*- coding: utf-8 -*-
+require 'yaml'
+require 'yaml_waml'
+require 'activerecord'
+
+# テストを実行する際はschema_commentsのschema_comments.ymlへの出力を抑制します。
+namespace :db do
+  Rake.application.send(:eval, "@tasks.delete('db:migrate')")
+  desc "Migrate the database through scripts in db/migrate and update db/schema.rb by invoking db:schema:dump. Target specific version with VERSION=x. Turn off output with VERBOSE=false."
+  task :migrate => :environment do
+    SchemaComments::SchemaComment.yaml_access do
+      ActiveRecord::Migration.verbose = ENV["VERBOSE"] ? ENV["VERBOSE"] == "true" : true
+      ActiveRecord::Migrator.migrate("db/migrate/", ENV["VERSION"] ? ENV["VERSION"].to_i : nil)
+      SchemaComments.quiet = true
+      Rake::Task["db:schema:dump"].invoke if ActiveRecord::Base.schema_format == :ruby
+    end
+  end
+  
+  Rake.application.send(:eval, "@tasks.delete('db:rollback')")
+  desc 'Rolls the schema back to the previous version. Specify the number of steps with STEP=n'
+  task :rollback => :environment do
+    SchemaComments::SchemaComment.yaml_access do
+      step = ENV['STEP'] ? ENV['STEP'].to_i : 1
+      ActiveRecord::Migrator.rollback('db/migrate/', step)
+      SchemaComments.quiet = true
+      Rake::Task["db:schema:dump"].invoke if ActiveRecord::Base.schema_format == :ruby
+    end
+  end
+
+  namespace :migrate do
+    desc 'Runs the "up" for a given migration VERSION.'
+    task :up => :environment do
+      SchemaComments::SchemaComment.yaml_access do
+        version = ENV["VERSION"] ? ENV["VERSION"].to_i : nil
+        raise "VERSION is required" unless version
+        ActiveRecord::Migrator.run(:up, "db/migrate/", version)
+        SchemaComments.quiet = true
+        Rake::Task["db:schema:dump"].invoke if ActiveRecord::Base.schema_format == :ruby
+      end
+    end
+
+    desc 'Runs the "down" for a given migration VERSION.'
+    task :down => :environment do
+      SchemaComments::SchemaComment.yaml_access do
+        version = ENV["VERSION"] ? ENV["VERSION"].to_i : nil
+        raise "VERSION is required" unless version
+        ActiveRecord::Migrator.run(:down, "db/migrate/", version)
+        SchemaComments.quiet = true
+        Rake::Task["db:schema:dump"].invoke if ActiveRecord::Base.schema_format == :ruby
+      end
+    end
+  end
+
+  namespace :test do
+    Rake.application.send(:eval, "@tasks.delete('db:test:prepare')")
+    desc 'Check for pending migrations and load the test schema'
+    task :prepare => 'db:abort_if_pending_migrations' do
+      SchemaComments::SchemaComment.yaml_access do
+        SchemaComments.quiet = true
+        if defined?(ActiveRecord) && !ActiveRecord::Base.configurations.blank?
+          Rake::Task[{ :sql  => "db:test:clone_structure", :ruby => "db:test:load" 
+          }[ActiveRecord::Base.schema_format]].invoke
+        end
+      end
+    end
+  end
+
+end
+
+
+
+class ActiveRecord::Base
+  class << self
+    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
+          klass.respond_to?(:table_exists?) and klass.table_exists?
+      end
+      result = subclasses.inject({}) do |d, m|
+        comment = (m.table_comment || '').dup
+        comment.gsub!(ignore_pattern_to_export_i18n, '') if ignore_pattern_to_export_i18n
+        # テーブル名(複数形)をモデル名(単数形)に
+        model_name = (comment.scan(/\[\[\[(?:model|class)(?:_name)?:\s*?([^\s]+?)\s*?\]\]\]/).flatten.first || m.name).underscore
+        comment.gsub!(/\[\[\[.*?\]\]\]/)
+        d[model_name] = comment
+        d
+      end
+			result.instance_eval do
+				def each_with_order(*args, &block)
+					self.keys.sort.each do |key|
+						yield(key, self[key])
+					end
+				end
+				alias :each_without_order :each
+				alias :each :each_with_order
+			end
+			result			
+    end
+    
+    def export_i18n_attributes
+      subclasses = ActiveRecord::Base.send(:subclasses).select do |klass|
+        (klass != SchemaComments::SchemaComment) and
+          klass.respond_to?(:table_exists?) and klass.table_exists?
+      end
+      result = subclasses.inject({}) do |d, m|
+        attrs = {}
+        m.columns.each do |col|
+          next if col.name == 'id'
+          comment = (col.comment || '').dup
+          comment.gsub!(ignore_pattern_to_export_i18n, '') if ignore_pattern_to_export_i18n
+
+          # カラム名を属性名に
+          attr_name = (comment.scan(/\[\[\[(?:attr|attribute)(?:_name)?:\s*?([^\s]+?)\s*?\]\]\]/).flatten.first || col.name)
+          comment.gsub!(/\[\[\[.*?\]\]\]/)
+          attrs[attr_name] = comment
+        end
+        
+        column_names = m.columns.map(&:name) - ['id']
+        column_order_modeule = Module.new do
+          def each_with_column_order(*args, &block)
+            @column_names.each do |column_name|
+              yield(column_name, self[column_name])
+            end
+          end
+          
+          def self.extended(obj)
+            obj.instance_eval do
+              alias :each_without_column_order :each
+              alias :each :each_with_column_order
+            end
+          end
+        end
+        attrs.instance_variable_set(:@column_names, column_names)
+        attrs.extend(column_order_modeule)
+        
+        # テーブル名(複数形)をモデル名(単数形)に
+        model_name = ((m.table_comment || '').scan(/\[\[\[(?:model|class)(?:_name)?:\s*?([^\s]+?)\s*?\]\]\]/).flatten.first || m.name).underscore
+        d[model_name] = attrs
+        d
+      end
+      
+      result.instance_eval do
+        def each_with_order(*args, &block)
+          self.keys.sort.each do |key|
+            yield(key, self[key])
+          end
+        end
+        alias :each_without_order :each
+        alias :each :each_with_order
+      end
+      result
+    end
+  end
+end
+
+namespace :i18n do
+  namespace :schema_comments do
+    task :load_all_models => :environment do
+      Dir.glob(File.join(RAILS_ROOT, 'app', 'models', '**', '*.rb')) do |file_name|
+        require file_name
+      end
+    end
+    
+    desc "Export i18n model resources from schema_comments. you can set locale with environment variable LOCALE"
+    task :export_models => :"i18n:schema_comments:load_all_models" do
+      locale = (ENV['LOCALE'] || I18n.locale).to_s
+      obj = {locale => {'activerecord' => {'models' => ActiveRecord::Base.export_i18n_models}}}
+      puts YAML.dump(obj)
+    end
+    
+    desc "Export i18n attributes resources from schema_comments. you can set locale with environment variable LOCALE"
+    task :export_attributes => :"i18n:schema_comments:load_all_models" do
+      locale = (ENV['LOCALE'] || I18n.locale).to_s
+      obj = {locale => {'activerecord' => {'attributes' => ActiveRecord::Base.export_i18n_attributes}}}
+      puts YAML.dump(obj)
+    end
+    
+    desc "update i18n YAML. you can set locale with environment variable LOCALE"
+    task :update_config_locale => :"i18n:schema_comments:load_all_models" do
+      require 'yaml/store'
+      locale = (ENV['LOCALE'] || I18n.locale).to_s
+      path = (ENV['YAML_PATH'] || File.join(RAILS_ROOT, "config/locales/#{locale}.yml"))
+      print "updating #{path}..."
+      
+      begin
+        db = YAML::Store.new(path)
+        db.transaction do
+          locale = db[locale] ||= {}
+          activerecord = locale['activerecord'] ||= {}
+          activerecord['models'] = ActiveRecord::Base.export_i18n_models
+          activerecord['attributes'] = ActiveRecord::Base.export_i18n_attributes
+        end
+        puts "Complete!"
+      rescue Exception
+        puts "Failure!!!"
+        puts $!.to_s
+        puts "  " << $!.backtrace.join("\n  ")
+        raise
+      end
+    end
+  end
+end