schema_comments 0.1.0

data/lib/schema_comments/schema_dumper.rb

@@ -0,0 +1,160 @@
+# -*- coding: utf-8 -*-
+module SchemaComments
+  module SchemaDumper
+    def self.included(mod)
+#       mod.extend(ClassMethods)
+#       mod.instance_eval do 
+#         alias :ignore_tables_without_schema_comments :ignore_tables
+#         alias :ignore_tables :ignore_tables_with_schema_comments 
+#       end
+      mod.module_eval do 
+        alias_method_chain :tables, :schema_comments
+        alias_method_chain :table, :schema_comments
+      end
+    end
+    
+    IGNORED_TABLE = 'schema_comments'
+    
+#     module ClassMethods
+#       def ignore_tables_with_schema_comments
+#         result = ignore_tables_without_schema_comments
+#         result << IGNORED_TABLE unless result.include?(IGNORED_TABLE)
+#         result
+#       end
+#     end
+    
+    private
+    def tables_with_schema_comments(stream)
+      tables_without_schema_comments(stream)
+      if adapter_name == "mysql"
+        # ビューはtableの後に実行するようにしないと rake db:schema:load で失敗します。
+        mysql_views(stream)
+      end
+    end
+
+    def table_with_schema_comments(table, stream)
+      return if IGNORED_TABLE == table.downcase
+      # MySQLは、ビューもテーブルとして扱うので、一個一個チェックします。
+      if adapter_name == 'mysql'
+        config = ActiveRecord::Base.configurations[RAILS_ENV]
+        match_count = @connection.select_value(
+          "select count(*) from information_schema.TABLES where TABLE_TYPE = 'VIEW' AND TABLE_SCHEMA = '%s' AND TABLE_NAME = '%s'" % [
+            config["database"], table])
+        return if match_count.to_i > 0
+      end
+      columns = @connection.columns(table)
+      begin
+        tbl = StringIO.new
+
+        if @connection.respond_to?(:pk_and_sequence_for)
+          pk, pk_seq = @connection.pk_and_sequence_for(table)
+        end
+        pk ||= 'id'
+
+        tbl.print "  create_table #{table.inspect}"
+        if columns.detect { |c| c.name == pk }
+          if pk != 'id'
+            tbl.print %Q(, :primary_key => "#{pk}")
+          end
+        else
+          tbl.print ", :id => false"
+        end
+        tbl.print ", :force => true"
+        
+        table_comment = @connection.table_comment(table)
+        tbl.print ", :comment => '#{table_comment}'" unless table_comment.blank?
+        
+        tbl.puts " do |t|"
+
+        column_specs = columns.map do |column|
+          raise StandardError, "Unknown type '#{column.sql_type}' for column '#{column.name}'" if @types[column.type].nil?
+          next if column.name == pk
+          spec = {}
+          spec[:name]      = column.name.inspect
+          spec[:type]      = column.type.to_s
+          spec[:limit]     = column.limit.inspect if column.limit != @types[column.type][:limit] && column.type != :decimal
+          spec[:precision] = column.precision.inspect if !column.precision.nil?
+          spec[:scale]     = column.scale.inspect if !column.scale.nil?
+          spec[:null]      = 'false' if !column.null
+          spec[:default]   = default_string(column.default) if !column.default.nil?
+          spec[:comment]   = (column.comment || '').inspect
+          (spec.keys - [:name, :type]).each{ |k| spec[k].insert(0, "#{k.inspect} => ")}
+          spec
+        end.compact
+
+        # find all migration keys used in this table
+        keys = [:name, :limit, :precision, :scale, :default, :null, :comment] & column_specs.map(&:keys).flatten
+
+        # figure out the lengths for each column based on above keys
+        lengths = keys.map{ |key| column_specs.map{ |spec| spec[key] ? spec[key].length + 2 : 0 }.max }
+
+        # the string we're going to sprintf our values against, with standardized column widths
+        format_string = lengths.map{ |len| "%-#{len}s" }
+
+        # find the max length for the 'type' column, which is special
+        type_length = column_specs.map{ |column| column[:type].length }.max
+
+        # add column type definition to our format string
+        format_string.unshift "    t.%-#{type_length}s "
+
+        format_string *= ''
+
+        column_specs.each do |colspec|
+          values = keys.zip(lengths).map{ |key, len| colspec.key?(key) ? colspec[key] + ", " : " " * len }
+          values.unshift colspec[:type]
+          tbl.print((format_string % values).gsub(/,\s*$/, ''))
+          tbl.puts
+        end
+
+        tbl.puts "  end"
+        tbl.puts
+        
+        indexes(table, tbl)
+
+        tbl.rewind
+        stream.print tbl.read
+      rescue => e
+        stream.puts "# Could not dump table #{table.inspect} because of following #{e.class}"
+        stream.puts "#   #{e.message}"
+        stream.puts
+      end
+      
+      stream
+    end
+
+    def adapter_name
+      config = ActiveRecord::Base.configurations[RAILS_ENV]
+      config ? config['adapter'] : ActiveRecord::Base.connection.adapter_name
+    end
+
+    def mysql_views(stream)
+      config = ActiveRecord::Base.configurations[RAILS_ENV]
+      view_names = @connection.select_values(
+        "select TABLE_NAME from information_schema.TABLES where TABLE_TYPE = 'VIEW' AND TABLE_SCHEMA = '%s'" % config["database"])
+      view_names.each do |view_name|
+        mysql_view(view_name, stream)
+      end
+    end
+    
+    def mysql_view(view_name, stream)
+      ddl = @connection.select_value("show create view #{view_name}")
+      ddl.gsub!(/^CREATE .+? VIEW /i, "CREATE OR REPLACE VIEW ")
+      ddl.gsub!(/AS select/, "AS \n select\n")
+      ddl.gsub!(/( AS \`.+?\`\,)/){ "#{$1}\n" }
+      ddl.gsub!(/ from /i         , "\n from \n")
+      ddl.gsub!(/ where /i        , "\n where \n")
+      ddl.gsub!(/ order by /i     , "\n order by \n")
+      ddl.gsub!(/ having /i       , "\n having \n")
+      ddl.gsub!(/ union /i        , "\n union \n")
+      ddl.gsub!(/ and /i          , "\n and ")
+      ddl.gsub!(/ or /i           , "\n or ")
+      ddl.gsub!(/inner join/i     , "\n inner join")
+      ddl.gsub!(/left join/i      , "\n left join")
+      ddl.gsub!(/left outer join/i, "\n left outer join")
+      stream.print("  ActiveRecord::Base.connection.execute(<<-EOS)\n")
+      stream.print(ddl.split(/\n/).map{|line| '    ' << line.strip}.join("\n"))
+      stream.print("\n  EOS\n")
+    end
+    
+  end
+end

data/lib/schema_comments.rb

@@ -0,0 +1,53 @@
+module SchemaComments
+  VERSION = '0.1.0'
+  
+  autoload :Base, 'schema_comments/base'
+  autoload :ConnectionAdapters, 'schema_comments/connection_adapters'
+  autoload :Migration, 'schema_comments/migration'
+  autoload :Migrator, 'schema_comments/migrator'
+  autoload :Schema, 'schema_comments/schema'
+  autoload :SchemaComment, 'schema_comments/schema_comment'
+  autoload :SchemaDumper, 'schema_comments/schema_dumper'
+
+  DEFAULT_YAML_PATH = File.expand_path(File.join(RAILS_ROOT, 'db/schema_comments.yml'))
+
+  mattr_accessor :yaml_path
+  self.yaml_path = DEFAULT_YAML_PATH
+
+  mattr_accessor :quiet
+  
+  class << self
+    def setup
+      base_names = %w(Base Migration Migrator Schema SchemaDumper) +
+        %w(Column ColumnDefinition TableDefinition).map{|name| "ConnectionAdapters::#{name}"}
+      
+      base_names.each do |base_name|
+        ar_class = "ActiveRecord::#{base_name}".constantize
+        sc_class = "SchemaComments::#{base_name}".constantize
+        unless ar_class.ancestors.include?(sc_class)
+          ar_class.__send__(:include, sc_class)
+        end
+      end
+      
+      unless ActiveRecord::ConnectionAdapters::AbstractAdapter.ancestors.include?(SchemaComments::ConnectionAdapters::Adapter)
+        ActiveRecord::ConnectionAdapters::AbstractAdapter.module_eval do
+          include SchemaComments::ConnectionAdapters::Adapter
+        end
+      end
+      
+      # %w(Mysql PostgreSQL SQLite3 SQLite Firebird DB2 Oracle Sybase Openbase Frontbase)
+      %w(Mysql PostgreSQL SQLite3 SQLite).each do |adapter|
+        begin
+          require("active_record/connection_adapters/#{adapter.downcase}_adapter")
+          adapter_class = ('ActiveRecord::ConnectionAdapters::' << "#{adapter}Adapter").constantize
+          adapter_class.module_eval do
+            include SchemaComments::ConnectionAdapters::ConcreteAdapter
+          end
+        rescue Exception => e
+        end
+      end
+    end
+    
+  end
+
+end

data/spec/.gitignore

@@ -0,0 +1,3 @@
+/human_readable_schema_comments.yml
+/schema_comments.yml
+/schema_comments_test.sqlite3.db

data/spec/annotate_models_spec.rb

@@ -0,0 +1,56 @@
+# -*- coding: utf-8 -*-
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+require File.join(File.dirname(__FILE__), '../lib/annotate_models.rb')
+
+describe AnnotateModels 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
+  
+  it "get_schema_info" do
+    (ActiveRecord::Base.connection.tables - %w(schema_migrations)).should == []
+    
+    ActiveRecord::Schema.define(:version => "20090721185959") do
+      drop_table("books") rescue nil
+
+      create_table "books", :force => true, :comment => '書籍' do |t|
+        t.string   "title", :limit => 100, :null => false, :comment => 'タイトル'
+        t.integer  "size", :null => false, :default => 1, :comment => '判型'
+        t.decimal  "price", :precision => 17, :scale => 14, :default => 0.0, :null => false, :comment => '価格'
+        t.datetime "created_at", :comment => '登録日時'
+        t.datetime "updated_at", :comment => '更新日時'
+      end
+    end
+
+    class Book < ActiveRecord::Base
+    end
+
+
+    AnnotateModels.get_schema_info(Book).should == %{# == 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                               # 更新日時
+# 
+# =================
+# 
+}
+  end
+  
+end

data/spec/database.yml

@@ -0,0 +1,13 @@
+sqlite:
+  :adapter: sqlite
+  :dbfile: schema_comments_test.sqlite.db
+sqlite3:
+  :adapter: sqlite3
+  :database: schema_comments_test.sqlite3.db
+mysql:
+  adapter: mysql
+  encoding: utf8
+  username: root
+  password:
+  socket: /opt/local/var/run/mysql5/mysqld.sock
+  database: schema_comments_test

data/spec/i18n_export_spec.rb

@@ -0,0 +1,48 @@
+# -*- coding: utf-8 -*-
+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)
+
+    (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 "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
+
+    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
+  
+end

data/spec/migration_spec.rb

@@ -0,0 +1,96 @@
+# -*- coding: utf-8 -*-
+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)
+
+    (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 "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
+
+    ActiveRecord::Migrator.up(migration_path, 1)
+
+    ActiveRecord::Migrator.current_version.should == 1
+    Product.table_comment.should == '商品'
+    {
+      'product_type_cd' => '種別コード', 
+      "price" => "価格",
+      "name" => "商品名",
+      "created_at" => "登録日時",
+      "updated_at" => "更新日時"
+    }.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' => '種別コード', 
+      "price" => "価格",
+      "name" => "商品名",
+      "created_at" => "登録日時",
+      "updated_at" => "更新日時"
+    }.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' => '種別コード', 
+      "price" => "価格",
+      "name" => "商品名",
+      "created_at" => "登録日時",
+      "updated_at" => "更新日時"
+    }.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
+
+    ActiveRecord::Migrator.up(migration_path, 5)
+    ActiveRecord::Migrator.current_version.should == 5
+    Product.columns.detect{|c| c.name == 'name'}.comment.should == '商品名'
+
+    ActiveRecord::Migrator.up(migration_path, 6)
+    ActiveRecord::Migrator.current_version.should == 6
+    Product.reset_column_comments
+    Product.columns.detect{|c| c.name == 'name'}.comment.should == '名称'
+  end
+  
+end

data/spec/migrations/valid/001_create_products.rb

@@ -0,0 +1,17 @@
+# -*- coding: utf-8 -*-
+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