schema_comments 0.4.3 → 0.5.0

data/lib/schema_comments/schema_dumper.rb

@@ -80,7 +80,8 @@ module SchemaComments
           spec[:null]      = 'false' unless column.null
           default = schema_default(column) if column.has_default?
           spec[:default]   = default unless default.nil?
-          spec[:comment]   = '"' << (column.comment || '').gsub(/\"/, '\"') << '"' # ここでinspectを使うと最後の文字だけ文字化け(UTF-8のコード)になっちゃう
+          column_comment = SchemaComment.column_comment(table, column.name)
+          spec[:comment]   = '"' << (column_comment || '').gsub(/\"/, '\"') << '"' # ここでinspectを使うと最後の文字だけ文字化け(UTF-8のコード)になっちゃう
           (spec.keys - [:name, :type]).each{ |k| spec[k].insert(0, "#{k.inspect} => ")}
           spec
         end.compact
@@ -120,6 +121,10 @@ module SchemaComments
         stream.puts "# Could not dump table #{table.inspect} because of following #{e.class}"
         stream.puts "#   #{e.message}"
         stream.puts
+        if ENV['RAILS_ENV'] == 'test'
+          $stderr.puts "[#{e.class.name}] #{e.message}"
+          $stderr.puts e.backtrace.join("\n  ")
+        end
       end
 
       stream
@@ -161,13 +166,13 @@ module SchemaComments
         klass = usage[:class]
         method_caption = nil
         if col = usage[:class].columns.detect{|c| c.name == usage[:enum_name]}
-          method_caption = col.comment
+          method_caption = SchemaComment.column_comment(klass.table_name, col.name)
         end
         method_caption ||= usage[:enum_name]
         spec = {
           :class_name => klass.name,
           :methos_name => usage[:enum_name],
-          :class_caption => klass.table_comment,
+          :class_caption => SchemaComment.table_comment(klass.table_name),
           :method_caption => method_caption
         }
         specs << spec

data/lib/schema_comments/schema_dumper/mysql.rb

@@ -92,7 +92,7 @@ HEADER
         end
         tbl.print ", :force => true"
 
-        table_comment = @connection.table_comment(table)
+        table_comment = SchemaComment.table_comment(table)
         tbl.print ", :comment => '#{table_comment}'" unless table_comment.blank?
 
         tbl.puts " do |t|"
@@ -121,7 +121,8 @@ HEADER
           if column.name == pk
             spec[:comment]   = '"AUTO_INCREMENT PRIMARY KEY by rails"'
           else
-            spec[:comment]   = '"' << (column.comment || '').gsub(/\"/, '\"') << '"' # ここでinspectを使うと最後の文字だけ文字化け(UTF-8のコード)になっちゃう
+            column_comment = SchemaComment.column_comment(table, column.name)
+            spec[:comment]   = '"' << (column_comment || '').gsub(/\"/, '\"') << '"' # ここでinspectを使うと最後の文字だけ文字化け(UTF-8のコード)になっちゃう
           end
           (spec.keys - [:name, :type]).each{ |k| spec[k].insert(0, "#{k.inspect} => ")}
           spec
@@ -172,6 +173,10 @@ HEADER
         stream.puts "# Could not dump table #{table.inspect} because of following #{e.class}"
         stream.puts "#   #{e.message}"
         stream.puts
+        if ENV['RAILS_ENV'] == 'test'
+          $stderr.puts "[#{e.class.name}] #{e.message}"
+          $stderr.puts e.backtrace.join("\n  ")
+        end
       end
 
       stream

data/lib/schema_comments/tasks/schema_comments.rake

@@ -1,168 +1,36 @@
-# -*- coding: utf-8 -*-
-require 'yaml'
-# require 'yaml_waml'
-require 'active_record'
-require 'schema_comments'
-SchemaComments.setup
-
-db_namespace = namespace :db do
-  namespace :schema do
-
-    Rake.application.send(:eval, "@tasks.delete('db:schema:dump')")
-    desc 'Create a db/schema.rb file that can be portably used against any DB supported by AR'
-    task :dump => [:environment, :load_config] do
-      begin
-        require 'active_record/schema_dumper'
-        filename = ENV['SCHEMA'] || "#{Rails.root}/db/schema.rb"
-        File.open(filename, "w:utf-8") do |file|
-          ActiveRecord::Base.establish_connection(Rails.env)
-          # ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, file)
-          SchemaComments::SchemaDumper.dump(ActiveRecord::Base.connection, file)
-        end
-        db_namespace['schema:dump'].reenable
-      rescue Exception => e
-        puts "[#{e.class}] #{e.message}:\n  " << e.backtrace.join("\n  ")
-        raise e
-      end
-    end
-
-  end
-end
-
-class ActiveRecord::Base
-  class << self
-    attr_accessor :ignore_pattern_to_export_i18n
-  end
-
-  self.ignore_pattern_to_export_i18n = /\(\(\(.*\)\)\)/
-
-  class << self
-    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
+namespace :schema_comments do
+  desc 'Dump schema to db/schema.rb'
+  task :dump => :environment do
+    require 'active_record/schema_dumper'
+    filename = ENV['SCHEMA'] || Rails.root.join('db/schema.rb').to_s
+    File.open(filename, "w:utf-8") do |file|
+      ActiveRecord::Base.establish_connection(Rails.env)
+      # ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, file)
+      SchemaComments::SchemaDumper.dump(ActiveRecord::Base.connection, file)
     end
   end
-end
-
-namespace :i18n do
-  namespace :schema_comments do
-    task :load_all_models => :environment do
-      Dir.glob(Rails.root.join('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
+  namespace :i18n do
+    desc "Show locale YAML"
+    task :show => :environment 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)
+      puts SchemaComments::SchemaComment.locale_yaml(locale)
     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'
+    task :update => :environment do
       locale = (ENV['LOCALE'] || I18n.locale).to_s
       path = (ENV['YAML_PATH'] || Rails.root.join("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
+      open(path, 'w') do |f|
+        f.puts SchemaComments::SchemaComment.locale_yaml(locale)
       end
     end
+
+  end
+end
+
+if Rails.env.development?
+  Rake::Task['db:schema:dump'].enhance do
+    Rake::Task['schema_comments:dump'].invoke
   end
 end

data/lib/schema_comments/version.rb

@@ -1,3 +1,3 @@
 module SchemaComments
-  VERSION = "0.4.3"
+  VERSION = "0.5.0"
 end

data/lib/tasks/schema_comments_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :schema_comments do
+#   # Task goes here
+# end

data/schema_comments.gemspec

@@ -1,28 +1,27 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'schema_comments/version'
+$:.push File.expand_path("../lib", __FILE__)
+require "schema_comments/version"
 
-Gem::Specification.new do |spec|
-  spec.name          = "schema_comments"
-  spec.version       = SchemaComments::VERSION
-  spec.authors       = ["akm"]
-  spec.email         = ["akm2000@gmail.com"]
+Gem::Specification.new do |s|
+  s.name        = "schema_comments"
+  s.version     = SchemaComments::VERSION
+  s.authors     = ["akm"]
+  s.email       = ["akm2000@gmail.com"]
+  s.homepage    = "http://github.com/akm/schema_comments"
+  s.summary     = "schema_comments generates extra methods dynamically for attribute which has options."
+  s.description = "schema_comments generates extra methods dynamically for attribute which has options."
+  s.license     = "MIT"
 
-  spec.summary       = %q{schema_comments generates extra methods dynamically for attribute which has options.}
-  spec.description   = %q{schema_comments generates extra methods dynamically for attribute which has options.}
-  spec.homepage      = "http://github.com/akm/schema_comments"
-  spec.license       = "MIT"
+  s.files       = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  # s.bindir      = "exe"
+  # s.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ["lib"]
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  s.test_files = Dir["test/**/*"]
 
-  spec.add_runtime_dependency('activesupport', ">= 4.0.0")
-  spec.add_runtime_dependency('activerecord', ">= 4.0.0")
+  s.add_runtime_dependency('activesupport', ">= 4.0.0")
+  s.add_runtime_dependency('activerecord', ">= 4.0.0")
 
-  spec.add_development_dependency "bundler", "~> 1.9"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schema_comments
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - akm
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2016-05-15 00:00:00.000000000 Z
+date: 2016-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -42,30 +42,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -92,34 +92,27 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
-- LICENSE.txt
+- MIT-LICENSE
 - README.md
 - Rakefile
-- VERSION
-- bin/console
-- bin/setup
 - gemfiles/.gitignore
 - gemfiles/Gemfile.rails-4.0
 - gemfiles/Gemfile.rails-4.1
 - gemfiles/Gemfile.rails-4.2
-- init.rb
-- lib/annotate_models.rb
 - lib/hash_key_orderable.rb
 - lib/schema_comments.rb
-- lib/schema_comments/base.rb
 - lib/schema_comments/connection_adapters.rb
-- lib/schema_comments/migration.rb
-- lib/schema_comments/migrator.rb
+- lib/schema_comments/dummy_migration.rb
 - lib/schema_comments/railtie.rb
 - lib/schema_comments/schema.rb
 - lib/schema_comments/schema_comment.rb
 - lib/schema_comments/schema_dumper.rb
 - lib/schema_comments/schema_dumper/mysql.rb
 - lib/schema_comments/task.rb
-- lib/schema_comments/tasks/alter_comments.rake
-- lib/schema_comments/tasks/annotate_models_tasks.rake
 - lib/schema_comments/tasks/schema_comments.rake
 - lib/schema_comments/version.rb
+- lib/tasks/schema_comments_tasks.rake
+- log/.keep
 - schema_comments.gemspec
 homepage: http://github.com/akm/schema_comments
 licenses:

data/LICENSE.txt

@@ -1,60 +0,0 @@
-Ruby License
-http://www.ruby-lang.org/en/LICENSE.txt
- 
-Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.co.jp>.
-You can redistribute it and/or modify it under either the terms of the GPL
-(see COPYING.txt file), or the conditions below:
- 
-  1. You may make and give away verbatim copies of the source form of the
-     software without restriction, provided that you duplicate all of the
-     original copyright notices and associated disclaimers.
- 
-  2. You may modify your copy of the software in any way, provided that
-     you do at least ONE of the following:
- 
-       a) place your modifications in the Public Domain or otherwise
-          make them Freely Available, such as by posting said
-	  modifications to Usenet or an equivalent medium, or by allowing
-	  the author to include your modifications in the software.
- 
-       b) use the modified software only within your corporation or
-          organization.
- 
-       c) rename any non-standard executables so the names do not conflict
-	  with standard executables, which must also be provided.
- 
-       d) make other distribution arrangements with the author.
- 
-  3. You may distribute the software in object code or executable
-     form, provided that you do at least ONE of the following:
- 
-       a) distribute the executables and library files of the software,
-	  together with instructions (in the manual page or equivalent)
-	  on where to get the original distribution.
- 
-       b) accompany the distribution with the machine-readable source of
-	  the software.
- 
-       c) give non-standard executables non-standard names, with
-          instructions on where to get the original software distribution.
- 
-       d) make other distribution arrangements with the author.
- 
-  4. You may modify and include the part of the software into any other
-     software (possibly commercial).  But some files in the distribution
-     are not written by the author, so that they are not under this terms.
- 
-     They are gc.c(partly), utils.c(partly), regex.[ch], st.[ch] and some
-     files under the ./missing directory.  See each file for the copying
-     condition.
- 
-  5. The scripts and library files supplied as input to or produced as 
-     output from the software do not automatically fall under the
-     copyright of the software, but belong to whomever generated them, 
-     and may be sold commercially, and may be aggregated with this
-     software.
- 
-  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
-     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
-     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-     PURPOSE.