aam 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 699245579213a9098682764ceed7c99eb8c421ffa666ab2b1f9e6cd6ebe56c4e
+  data.tar.gz: 9c9332ffe62d2bc489a0c599ca13f48b8a8cee10955d1465b4de59859d7b31f4
+SHA512:
+  metadata.gz: 4947e3233adac7958abd5a096b997dcaf3fa345ce567406e2ed3fe23f1e494b3c7ca07314fc1302fd68431fb61044b69f6f4b467c3d7032b68c738436b5e0ef4
+  data.tar.gz: f28178f423a1cf5731e6891e0b638238c11a84a577d0cd3725a8aecf3b582b3c5eaacc4e57110ddf5cba76718b80560b941b6ab2643045a250a411bdebf329eb

data/.gitignore

@@ -0,0 +1,13 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+_yardoc
+coverage
+doc/
+pkg
+rdoc
+test/tmp
+tmp

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in aam.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 akicho8
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.org

@@ -0,0 +1,119 @@
+* DBのテーブルと対応するファイルにカラム情報を埋め込みまくる自分用ツール
+
+** 使い方
+
+#+BEGIN_SRC shell
+$ rake aam  
+#+END_SRC
+
+これで関連するファイルにカラム情報を埋め込みまくります。
+必要そうなところにインデックスが張ってないと警告まで埋め込みます。
+
+** 単体で使う例
+
+#+BEGIN_SRC ruby
+ActiveRecord::Schema.define do
+  suppress_messages do
+    create_table :users do |t|
+      t.string :name
+      t.boolean :flag, :default => false
+    end
+    add_index :users, :name, :unique => true
+
+    create_table :articles do |t|
+      t.belongs_to :user, index: true
+      t.belongs_to :foo, :polymorphic => true, :index => false
+    end
+
+    create_table :blogs do |t|
+      t.string :name
+    end
+  end
+end
+
+class User < ActiveRecord::Base
+  has_many :articles
+  has_one :article, :as => :foo
+end
+
+class Article < ActiveRecord::Base
+  belongs_to :user
+  belongs_to :foo, :polymorphic => true
+end
+
+class Blog < ActiveRecord::Base
+  has_many :sub_articles, :foreign_key => :foo_id
+end
+
+class SubArticle < Article
+  belongs_to :blog, :class_name => "Blog", :foreign_key => :foo_id
+end
+
+puts Aam::SchemaInfoGenerator.new(User).generate
+# >> # == Schema Information ==
+# >> #
+# >> # Userテーブル (users as User)
+# >> #
+# >> # +----------+------+---------+-------------+------+-------+
+# >> # | カラム名 | 意味 | タイプ  | 属性        | 参照 | INDEX |
+# >> # +----------+------+---------+-------------+------+-------+
+# >> # | id       | Id   | integer | NOT NULL PK |      |       |
+# >> # | name     | Name | string  |             |      | A!    |
+# >> # | flag     | Flag | boolean | DEFAULT(f)  |      |       |
+# >> # +----------+------+---------+-------------+------+-------+
+
+puts Aam::SchemaInfoGenerator.new(Article).generate
+# >> # == Schema Information ==
+# >> #
+# >> # Articleテーブル (articles as Article)
+# >> #
+# >> # +----------+----------+---------+-------------+-----------------------+-------+
+# >> # | カラム名 | 意味     | タイプ  | 属性        | 参照                  | INDEX |
+# >> # +----------+----------+---------+-------------+-----------------------+-------+
+# >> # | id       | Id       | integer | NOT NULL PK |                       |       |
+# >> # | user_id  | ユーザー | integer |             | => User#id            | A     |
+# >> # | foo_type | Foo type | string  |             | モデル名(polymorphic) |       |
+# >> # | foo_id   | Foo      | integer |             | => (foo_type)#id      |       |
+# >> # +----------+----------+---------+-------------+-----------------------+-------+
+# >> #
+# >> #- 備考 -------------------------------------------------------------------------
+# >> # ・Article モデルは User モデルから has_many :articles されています。
+# >> # ・【警告:インデックス欠如】create_articles マイグレーションに add_index :articles, [:foo_id, :foo_type] を追加してください
+# >> #--------------------------------------------------------------------------------
+
+puts Aam::SchemaInfoGenerator.new(Blog).generate
+# >> # == Schema Information ==
+# >> #
+# >> # Blogテーブル (blogs as Blog)
+# >> #
+# >> # +----------+------+---------+-------------+------+-------+
+# >> # | カラム名 | 意味 | タイプ  | 属性        | 参照 | INDEX |
+# >> # +----------+------+---------+-------------+------+-------+
+# >> # | id       | Id   | integer | NOT NULL PK |      |       |
+# >> # | name     | Name | string  |             |      |       |
+# >> # +----------+------+---------+-------------+------+-------+
+
+puts Aam::SchemaInfoGenerator.new(SubArticle).generate
+# >> # == Schema Information ==
+# >> #
+# >> # なんとかテーブル (articles as SubArticle)
+# >> #
+# >> # +----------+----------+---------+-------------+--------------------------------------+-------+
+# >> # | カラム名 | 意味     | タイプ  | 属性        | 参照                                 | INDEX |
+# >> # +----------+----------+---------+-------------+--------------------------------------+-------+
+# >> # | id       | Id       | integer | NOT NULL PK |                                      |       |
+# >> # | user_id  | ユーザー | integer |             | => User#id                           | A     |
+# >> # | foo_type | Foo type | string  |             | モデル名(polymorphic)                |       |
+# >> # | foo_id   | Foo      | integer |             | :blog => Blog#id と => (foo_type)#id |       |
+# >> # +----------+----------+---------+-------------+--------------------------------------+-------+
+# >> #
+# >> #- 備考 -------------------------------------------------------------------------
+# >> # ・SubArticle モデルは User モデルから has_many :articles されています。
+# >> # ・【警告:インデックス欠如】create_articles マイグレーションに add_index :articles, [:foo_id, :foo_type] を追加してください
+# >> # ・SubArticle モデルは Blog モデルから has_many :sub_articles, :foreign_key => :foo_id されています。
+# >> #--------------------------------------------------------------------------------
+#+END_SRC
+
+** 参考
+
+- https://github.com/ctran/annotate_models

data/Rakefile

@@ -0,0 +1,10 @@
+# -*- coding: utf-8 -*-
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+task :default => :test
+
+require "rake/testtask"
+Rake::TestTask.new do |t|
+  t.libs << "test"
+end

data/aam.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aam/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "aam"
+  spec.version       = Aam::VERSION
+  spec.authors       = ["akicho8"]
+  spec.email         = ["akicho8@gmail.com"]
+  spec.description   = %q{Index reference to Japanese correspondence relation annotate_models}
+  spec.summary       = %q{Advanced Annotate Models}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "test-unit"
+  spec.add_development_dependency "sqlite3"
+
+  spec.add_dependency "rails"
+  spec.add_dependency "activerecord"
+  spec.add_dependency "activesupport"
+  spec.add_dependency "org_tp"
+end

data/examples/0100_example.rb

@@ -0,0 +1,112 @@
+# -*- coding: utf-8 -*-
+require "bundler/setup"
+Bundler.require
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+ActiveRecord::Schema.define do
+  suppress_messages do
+    create_table :users do |t|
+      t.string :name
+      t.boolean :flag, :default => false
+    end
+    add_index :users, :name, :unique => true
+
+    create_table :articles do |t|
+      t.belongs_to :user, index: true
+      t.belongs_to :foo, :polymorphic => true, :index => false # Rails5からindex:trueがデフォルトになっているため
+    end
+
+    create_table :blogs do |t|
+      t.string :name
+    end
+  end
+end
+
+class User < ActiveRecord::Base
+  has_many :articles
+  has_one :article, :as => :foo
+end
+
+class Article < ActiveRecord::Base
+  belongs_to :user
+  belongs_to :foo, :polymorphic => true
+end
+
+class Blog < ActiveRecord::Base
+  has_many :sub_articles, :foreign_key => :foo_id
+end
+
+class SubArticle < Article
+  belongs_to :blog, :class_name => "Blog", :foreign_key => :foo_id
+end
+
+Aam.logger = nil
+
+if true
+  require "i18n"
+  I18n.enforce_available_locales = false
+  I18n.default_locale = :ja
+  I18n.backend.store_translations :ja, {:activerecord => {:models => {"sub_article" => "なんとか"} }, :attributes => {"user_id" => "ユーザー"}}
+end
+
+puts Aam::SchemaInfoGenerator.new(User).generate
+puts Aam::SchemaInfoGenerator.new(Article).generate
+puts Aam::SchemaInfoGenerator.new(Blog).generate
+puts Aam::SchemaInfoGenerator.new(SubArticle).generate
+
+# >> # == Schema Information ==
+# >> #
+# >> # Userテーブル (users as User)
+# >> #
+# >> # +----------+------+---------+-------------+------+-------+
+# >> # | カラム名 | 意味 | タイプ  | 属性        | 参照 | INDEX |
+# >> # +----------+------+---------+-------------+------+-------+
+# >> # | id       | Id   | integer | NOT NULL PK |      |       |
+# >> # | name     | Name | string  |             |      | A!    |
+# >> # | flag     | Flag | boolean | DEFAULT(f)  |      |       |
+# >> # +----------+------+---------+-------------+------+-------+
+# >> # == Schema Information ==
+# >> #
+# >> # Articleテーブル (articles as Article)
+# >> #
+# >> # +----------+----------+---------+-------------+-----------------------+-------+
+# >> # | カラム名 | 意味     | タイプ  | 属性        | 参照                  | INDEX |
+# >> # +----------+----------+---------+-------------+-----------------------+-------+
+# >> # | id       | Id       | integer | NOT NULL PK |                       |       |
+# >> # | user_id  | ユーザー | integer |             | => User#id            | A     |
+# >> # | foo_type | Foo type | string  |             | モデル名(polymorphic) |       |
+# >> # | foo_id   | Foo      | integer |             | => (foo_type)#id      |       |
+# >> # +----------+----------+---------+-------------+-----------------------+-------+
+# >> #
+# >> #- 備考 -------------------------------------------------------------------------
+# >> # ・Article モデルは User モデルから has_many :articles されています。
+# >> # ・【警告:インデックス欠如】create_articles マイグレーションに add_index :articles, [:foo_id, :foo_type] を追加してください
+# >> #--------------------------------------------------------------------------------
+# >> # == Schema Information ==
+# >> #
+# >> # Blogテーブル (blogs as Blog)
+# >> #
+# >> # +----------+------+---------+-------------+------+-------+
+# >> # | カラム名 | 意味 | タイプ  | 属性        | 参照 | INDEX |
+# >> # +----------+------+---------+-------------+------+-------+
+# >> # | id       | Id   | integer | NOT NULL PK |      |       |
+# >> # | name     | Name | string  |             |      |       |
+# >> # +----------+------+---------+-------------+------+-------+
+# >> # == Schema Information ==
+# >> #
+# >> # なんとかテーブル (articles as SubArticle)
+# >> #
+# >> # +----------+----------+---------+-------------+--------------------------------------+-------+
+# >> # | カラム名 | 意味     | タイプ  | 属性        | 参照                                 | INDEX |
+# >> # +----------+----------+---------+-------------+--------------------------------------+-------+
+# >> # | id       | Id       | integer | NOT NULL PK |                                      |       |
+# >> # | user_id  | ユーザー | integer |             | => User#id                           | A     |
+# >> # | foo_type | Foo type | string  |             | モデル名(polymorphic)                |       |
+# >> # | foo_id   | Foo      | integer |             | :blog => Blog#id と => (foo_type)#id |       |
+# >> # +----------+----------+---------+-------------+--------------------------------------+-------+
+# >> #
+# >> #- 備考 -------------------------------------------------------------------------
+# >> # ・SubArticle モデルは User モデルから has_many :articles されています。
+# >> # ・【警告:インデックス欠如】create_articles マイグレーションに add_index :articles, [:foo_id, :foo_type] を追加してください
+# >> # ・SubArticle モデルは Blog モデルから has_many :sub_articles, :foreign_key => :foo_id されています。
+# >> #--------------------------------------------------------------------------------

data/experiment/000_example.rb

@@ -0,0 +1,121 @@
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "aam"
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+ActiveRecord::Schema.define do
+  suppress_messages do
+    create_table(:users) do |t|
+      t.string :name, :limit => 32
+      t.boolean :flag, :default => false
+    end
+    add_index :users, :name, :unique => true
+
+    create_table(:articles) do |t|
+      t.belongs_to :user, :index => false
+      t.belongs_to :xxx, :polymorphic => true, :index => false
+    end
+
+    create_table(:blogs) do |t|
+      t.string :name
+    end
+
+    create_table(:foos) do |t|
+      t.belongs_to :user, :index => false
+      t.belongs_to :xxx, :polymorphic => true, :index => false
+    end
+  end
+end
+
+class User < ActiveRecord::Base
+  has_many :articles
+  has_one :article, :as => :xxx
+end
+
+class Article < ActiveRecord::Base
+  belongs_to :user
+  belongs_to :xxx, :polymorphic => true
+end
+
+class Blog < ActiveRecord::Base
+  has_many :sub_articles, :foreign_key => :xxx_id
+end
+
+class SubArticle < Article
+  belongs_to :blog, :class_name => "Blog", :foreign_key => :xxx_id
+end
+
+class Foo < ActiveRecord::Base
+end
+
+Aam.logger = nil
+puts Aam::SchemaInfoGenerator.new(User).generate
+puts Aam::SchemaInfoGenerator.new(Article).generate
+puts Aam::SchemaInfoGenerator.new(SubArticle).generate
+puts Aam::SchemaInfoGenerator.new(Foo).generate
+# >> # == Schema Information ==
+# >> #
+# >> # Userテーブル (users as User)
+# >> #
+# >> # |----------+------+------------+-------------+------+-------|
+# >> # | カラム名 | 意味 | タイプ     | 属性        | 参照 | INDEX |
+# >> # |----------+------+------------+-------------+------+-------|
+# >> # | id       | Id   | integer    | NOT NULL PK |      |       |
+# >> # | name     | Name | string(32) |             |      | A!    |
+# >> # | flag     | Flag | boolean    | DEFAULT(f)  |      |       |
+# >> # |----------+------+------------+-------------+------+-------|
+# >> # == Schema Information ==
+# >> #
+# >> # Articleテーブル (articles as Article)
+# >> #
+# >> # |----------+----------+---------+-------------+-----------------------+-------|
+# >> # | カラム名 | 意味     | タイプ  | 属性        | 参照                  | INDEX |
+# >> # |----------+----------+---------+-------------+-----------------------+-------|
+# >> # | id       | Id       | integer | NOT NULL PK |                       |       |
+# >> # | user_id  | User     | integer |             | => User#id            |       |
+# >> # | xxx_type | Xxx type | string  |             | モデル名(polymorphic) |       |
+# >> # | xxx_id   | Xxx      | integer |             | => (xxx_type)#id      |       |
+# >> # |----------+----------+---------+-------------+-----------------------+-------|
+# >> #
+# >> #- 備考 -------------------------------------------------------------------------
+# >> # ・【警告:インデックス欠如】create_articles マイグレーションに add_index :articles, :user_id を追加してください
+# >> # ・Article モデルは User モデルから has_many :articles されています。
+# >> # ・【警告:インデックス欠如】create_articles マイグレーションに add_index :articles, [:xxx_id, :xxx_type] を追加してください
+# >> #--------------------------------------------------------------------------------
+# >> # == Schema Information ==
+# >> #
+# >> # Sub articleテーブル (articles as SubArticle)
+# >> #
+# >> # |----------+----------+---------+-------------+--------------------------------------+-------|
+# >> # | カラム名 | 意味     | タイプ  | 属性        | 参照                                 | INDEX |
+# >> # |----------+----------+---------+-------------+--------------------------------------+-------|
+# >> # | id       | Id       | integer | NOT NULL PK |                                      |       |
+# >> # | user_id  | User     | integer |             | => User#id                           |       |
+# >> # | xxx_type | Xxx type | string  |             | モデル名(polymorphic)                |       |
+# >> # | xxx_id   | Xxx      | integer |             | :blog => Blog#id と => (xxx_type)#id |       |
+# >> # |----------+----------+---------+-------------+--------------------------------------+-------|
+# >> #
+# >> #- 備考 -------------------------------------------------------------------------
+# >> # ・【警告:インデックス欠如】create_articles マイグレーションに add_index :articles, :user_id を追加してください
+# >> # ・SubArticle モデルは User モデルから has_many :articles されています。
+# >> # ・【警告:インデックス欠如】create_articles マイグレーションに add_index :articles, [:xxx_id, :xxx_type] を追加してください
+# >> # ・SubArticle モデルは Blog モデルから has_many :sub_articles, :foreign_key => :xxx_id されています。
+# >> #--------------------------------------------------------------------------------
+# >> # == Schema Information ==
+# >> #
+# >> # Fooテーブル (foos as Foo)
+# >> #
+# >> # |----------+----------+---------+-------------+------+-------|
+# >> # | カラム名 | 意味     | タイプ  | 属性        | 参照 | INDEX |
+# >> # |----------+----------+---------+-------------+------+-------|
+# >> # | id       | Id       | integer | NOT NULL PK |      |       |
+# >> # | user_id  | User     | integer |             |      |       |
+# >> # | xxx_type | Xxx type | string  |             |      |       |
+# >> # | xxx_id   | Xxx      | integer |             |      |       |
+# >> # |----------+----------+---------+-------------+------+-------|
+# >> #
+# >> #- 備考 -------------------------------------------------------------------------
+# >> # ・【警告:インデックス欠如】create_foos マイグレーションに add_index :foos, :user_id を追加してください
+# >> # ・【警告】Foo モデルに belongs_to :user を追加してください
+# >> # ・【警告:インデックス欠如】create_foos マイグレーションに add_index :foos, [:xxx_id, :xxx_type] を追加してください
+# >> # ・【警告】Foo モデルに belongs_to :xxx, :polymorphic => true を追加してください
+# >> #--------------------------------------------------------------------------------