flextures 3.0.1 → 3.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 99504d8a772565a2297207af2206bfc18cb82c73
+  data.tar.gz: 707211a620654b6711d760e9ef6ca89f58ae17e7
+SHA512:
+  metadata.gz: be828a61867a9f864890d8372d171d79affe797f41a851607015dd54ee2516c094197ebac46452ce22e21c201a2cf25f34a2e19415dd414aaec276953299483d
+  data.tar.gz: 028002915fb72150b3a618ca6efd128d502c942463f8dd0e3b40cdc66bf6f3db3e0dd36be97f54b76f5b016a5355a17b22fd83c58fa7c2ca882256ed2dd8ed2c

data/.gitignore

@@ -0,0 +1,48 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+*~
+\#*
+.\#*
+
+# For vim:
+*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc

data/Gemfile

@@ -1,13 +1,8 @@
-source "http://rubygems.org"
-
-#gem "activerecord"
-
-group :development, :test do
-  gem "bundler", "1.3.5"
-  gem "jeweler", "1.8.3"
-end
-
-group :text do
-  gem "shoulda", ">= 0"
-end
-
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in flextures.gemspec
+gemspec
+
+group :test do
+  gem "shoulda", ">= 0"
+end

data/Gemfile.lock

@@ -1,21 +1,17 @@
+PATH
+  remote: .
+  specs:
+    flextures (3.1.0)
+
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
     activesupport (3.2.8)
       i18n (~> 0.6)
       multi_json (~> 1.0)
-    git (1.2.5)
     i18n (0.6.0)
-    jeweler (1.8.3)
-      bundler (~> 1.0)
-      git (>= 1.2.5)
-      rake
-      rdoc
-    json (1.6.6)
     multi_json (1.3.6)
     rake (0.9.2.2)
-    rdoc (3.12)
-      json (~> 1.4)
     shoulda (3.1.1)
       shoulda-context (~> 1.0)
       shoulda-matchers (~> 1.2)
@@ -27,6 +23,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (= 1.3.5)
-  jeweler (= 1.8.3)
+  bundler (~> 1.6)
+  flextures!
+  rake
   shoulda

data/{README.ja.rdoc → README.ja.md}

@@ -1,16 +1,18 @@
-= flextures
+# flextures
 
-* {ENGLISH DOCUMENT}[https://github.com/baban/flextures/blob/master/README.rdoc]
+* [ENGLISH DOCUMENT](https://github.com/baban/flextures/blob/master/README.rdoc)
 
-== Abstruct
+## Abstruct
 
 このplug-inは、これまで開発中で溜まっていた
 Rails標準のfixtureの不満点を解消するために作成しました
 基本的な操作は単純で次のコマンドで
 それぞれfixtureのロードとダンプを行います
 
+```
  rake db:flextures:load
  rake db:flextures:dump
+```
 
 通常のfixtureとの主な違いは次の４点です
 
@@ -19,56 +21,69 @@ Rails標準のfixtureの不満点を解消するために作成しました
 3. テーブル名とfixtureのファイル名を一致させないでも、自由なロード＆ダンプが出来るオプション
 4. FactoyGirl風の読み込みフィルタで、Fixtureのデータを加工しながら読み込む事が出来る
 
-== インストール方法
+## インストール方法
 
 RailsのPlug-inとして使われることを想定しています
 gem化されているので、bundlerで次のように記述して、普通にbundle install してください
 
+```
  gem "flextures"
 
+```
+
 ちなみに開発環境はruby1.9以上のバージョン、rails3以上、もしくはPadrinoを想定しています
 
-== 使い方
+## 使い方
 
-=== rakeコマンド
+### rakeコマンド
 
 次のコマンドで spec/fixtures/ 以下にあるfixtureのロード＆ダンプを行います
 (読み込む基本のディレクトリは設定ファイルで変更可能)
 
- rake db:flextures:load
- rake db:flextures:dump
+```
+rake db:flextures:load
+rake db:flextures:dump
+```
 
 rake コマンドには以下の様な書式でオプションを指定することができます
 指摘出来るオプションは、ロードとダンプで共通です
 
 テーブル名で吐き出し(Userモデルusers)
 
- rake db:flextures:dump TABLE=users
+```
+rake db:flextures:dump TABLE=users
+```
 
 Usersモデルのfixture(users.csvか　users.yml)をロードする
 
- rake db:flextures:load MODEL=User
+```
+rake db:flextures:load MODEL=User
+```
 
 その他オプションは以下の通りです:
 
- TABLE : テーブル名を指定してロード。テーブル名はカンマ切りで複数指定が可能
- MODEL : モデル名を指定してロード。モデル名はカンマ区切りで複数指定が可能
- DIR : フィクスチャをロード＆ダンプするディレクトリを指定する
- FILE : loadまたはdumpするファイル名を直接指定(Userモデルのusers.csv以外を指定)
- FORMAT：ダンプ、またはロードするデータの種類を指定できる(csvかyml)
- OPTION：その他の細かい読み込みオプションはここで指定出来ます
- T : TABLEのエイリアス
- D : ディレクトリ指定のエイリアス
- F : ファイル名指定のエイリアス
+| オプション | 役割                                                              |
+------------|--------------------------------------------------------------------
+| TABLE     | テーブル名を指定してロード。テーブル名はカンマ切りで複数指定が可能        |
+| MODEL     | モデル名を指定してロード。モデル名はカンマ区切りで複数指定が可能          |
+| DIR       | フィクスチャをロード＆ダンプするディレクトリを指定する                   |
+| FILE      | loadまたはdumpするファイル名を直接指定(Userモデルのusers.csv以外を指定) |
+| FORMAT    | ダンプ、またはロードするデータの種類を指定できる(csvかyml)              |
+| OPTION    | その他の細かい読み込みオプションはここで指定出来ます                     |
+| T         | TABLEのエイリアス                                                   |
+| D         | ディレクトリ指定のエイリアス                                          |
+| F         | ファイル名指定のエイリアス                                            |
 
 migration等でテーブルの構成が変わった時には
 generateコマンドを実行すると、テーブル情報のloadとdumpをセットで行なってくれるので便利です
 
- rake db:flextures:generate T=users
+```
+rake db:flextures:generate T=users
+```
 
-さらに詳しい説明に関しては {Wiki:Rakeコマンドラインオプション}[https://github.com/baban/flextures/wiki/Rake%E3%82%B3%E3%83%9E%E3%83%B3%E3%83%89%E3%82%AA%E3%83%97%E3%82%B7%E3%83%A7%E3%83%B3]を参照して下さい
+さらに詳しい説明に関しては [Wiki:Rakeコマンドラインオプション](https://github.com/baban/flextures/wiki/Rake%E3%82%B3%E3%83%9E%E3%83%B3%E3%83%89%E3%82%AA%E3%83%97%E3%82%B7%E3%83%A7%E3%83%B3)を参照して下さい
 
-=== Unit test flexture support
+### Unit test flexture support
 
 ユニットテスト中でデータの読み込みが行いたくなったときのために
 fixtureのロード機能を使えます
@@ -76,68 +91,78 @@ fixtureのロード機能を使えます
 次の例はRSpecからの読み込みですが
 基本的な機能は、通常のfixturesと同じですので、fixtures と同じ感覚で使用して下さい
 
- describe ItemShopController do
-   flextures :users, :items
+```ruby
+describe ItemShopController do
+  flextures :users, :items
+```
 
 基本的な違いは、yamlよりcsvを優先する、カラムの変更点を検知して警告を出しながらもロードを行う等ですが
 もう一つ、ハッシュ引数で指定する事で、テーブル名、ファイル名を一致させなくても フィクスチャ を読み込ませることができます
 そのため、すべてのテストケースで依存関係を気にしながら共通のfixtureを使わなくても良い様に出来ます
 
- describe ItemShopController do
-   flextures :items, :users => :users_for_itmshop # users_for_itemshop.csv をロードする
+```ruby
+describe ItemShopController do
+  flextures :items, :users => :users_for_itmshop # users_for_itemshop.csv をロードする
+```
 
 その他現在はShouldからの呼び出しや様々なオプションを載せていますが
-さらに詳しい使い方に関しては {Wiki:Unit Test Supportの説明}[https://github.com/baban/flextures/wiki/Unit-test-support%E3%81%AE%E8%AA%AC%E6%98%8E] を参照して下さい
+さらに詳しい使い方に関しては [Wiki:Unit Test Supportの説明](https://github.com/baban/flextures/wiki/Unit-test-support%E3%81%AE%E8%AA%AC%E6%98%8E) を参照して下さい
 
-=== Flextures load filter (and dump filter)
+### Flextures load filter (and dump filter)
 
-==== load filer
+#### load filer
 
 Railsのプロジェクトに config/flextures.factory.rb というファイルを作成して、そこにフィルタを記述することによって
 (Padrinoでも設置場所は同じです)
 フィクスチャの読み込み時に、値を加工して読み込む事が可能になっています
 例えば、次の様に記述するとusersテーブルのlast_login_dateの値を、常に現在の時間として設定できます
 
- Flextures::Factory.define :users do |f| 
-   f.last_login_date = DateTime.now
- end
+```ruby
+Flextures::Factory.define :users do |f|
+  f.last_login_date = DateTime.now
+end
+```
 
 テーブルにdefaultの値を設定していなくても
 カラムのデータを適当に補完する機能があるので
-大量のデータを生成したい時は次のように{faker}[https://github.com/stympy/faker]等と組み合わせて
+大量のデータを生成したい時は次のように[faker](https://github.com/stympy/faker)等と組み合わせて
 必要な分だけ生成をさせると、今までより若干捗るかもしれません
 
- require 'faker'
- Flextures::Factory.define :users do |f|
-   f.name= Faker::Name.name if !f.name  # ランダムで名前を生成(ただしUS仕様
-   f.sex= [0,1].shuffle.first if !f.sex # 性別を設定
-   # Factory Girlの様にhas_manyな感じのデータも生成できます。（初期設定でアイテムを２個持たせる）
-   f.items<< [ Item.new( master_item_id: 1, count: 5 ), Item.new( master_item_id: 2, count: 3 ) ]
- end
+```ruby
+require 'faker'
+Flextures::Factory.define :users do |f|
+  f.name= Faker::Name.name if !f.name  # ランダムで名前を生成(ただしUS仕様
+  f.sex= [0,1].shuffle.first if !f.sex # 性別を設定
+  # Factory Girlの様にhas_manyな感じのデータも生成できます。（初期設定でアイテムを２個持たせる）
+  f.items<< [ Item.new( master_item_id: 1, count: 5 ), Item.new( master_item_id: 2, count: 3 ) ]
+end
+```
 
-* {wiki:has_manyな感じのデータの精製法}[https://github.com/baban/flextures/wiki/Has-many%E3%81%AA%E6%84%9F%E3%81%98%E3%81%AE%E3%83%87%E3%83%BC%E3%82%BF%E3%81%AE%E7%B2%BE%E8%A3%BD%E6%96%B9%E6%B3%95]
+* [wiki:has_manyな感じのデータの精製法](https://github.com/baban/flextures/wiki/Has-many%E3%81%AA%E6%84%9F%E3%81%98%E3%81%AE%E3%83%87%E3%83%BC%E3%82%BF%E3%81%AE%E7%B2%BE%E8%A3%BD%E6%96%B9%E6%B3%95)
 
-==== dump filer
+#### dump filer
 
 データのdump時に加工が必要になった時には、ダンプフィルターにテーブル名と、加工したい値をキーに、処理をラムダで渡してやることで可能です
 
- Flextures::DumpFilter.define :users, {
-   :encrypted_password => lambda { |v| Base64.encode64(v) }
- }
+```ruby
+Flextures::DumpFilter.define :users, {
+  :encrypted_password => lambda { |v| Base64.encode64(v) }
+}
+```
 
+さらに細かい使い方に関しては [Wiki:FactoryFilterについて](https://github.com/baban/flextures/wiki/Factoryfilter%E3%81%AB%E3%81%A4%E3%81%84%E3%81%A6) を参照して下さい
 
-さらに細かい使い方に関しては {Wiki:FactoryFilterについて}[https://github.com/baban/flextures/wiki/Factoryfilter%E3%81%AB%E3%81%A4%E3%81%84%E3%81%A6] を参照して下さい
-
-=== 設定ファイル
+### 設定ファイル
 
 config/flextures.config.rb　で設定ファイルを作成すると、データをロード＆ダンプするディレクトリなどの設定を変更できます
 
- # config/flextures.config.rb
- module Flextures
-   # test/fixtures/ のフィクスチャを読み出したい場合は吐き出しディレクトリの値を上書きする
-   Config.fixture_load_directory = "test/fixtures/"
-   Config.fixture_dump_directory = "test/fixtures/"
- end
-
-その他の情報は {Wiki:設定ファイルの書式について}[https://github.com/baban/flextures/wiki/%E8%A8%AD%E5%AE%9A%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E3%81%AE%E6%9B%B8%E5%BC%8F%E3%81%AB%E3%81%A4%E3%81%84%E3%81%A6] を参照して下さい
+```ruby
+# config/flextures.config.rb
+module Flextures
+  # test/fixtures/ のフィクスチャを読み出したい場合は吐き出しディレクトリの値を上書きする
+  Config.fixture_load_directory = "test/fixtures/"
+  Config.fixture_dump_directory = "test/fixtures/"
+end
+```
 
+その他の情報は [Wiki:設定ファイルの書式について](https://github.com/baban/flextures/wiki/%E8%A8%AD%E5%AE%9A%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E3%81%AE%E6%9B%B8%E5%BC%8F%E3%81%AB%E3%81%A4%E3%81%84%E3%81%A6)を参照して下さい

data/README.md

@@ -0,0 +1,156 @@
+# flextures
+
+* [日本語版ドキュメント(Japanese Document)](https://github.com/baban/flextures/blob/master/README.ja.md)
+
+## Abstruct
+
+This plug-in aim to resolve many problems, durling rails developping about fixtures.
+Basic commands is simple.
+Each commands load or dump fixtures.
+
+```
+rake db:flextures:load
+rake db:flextures:dump
+```
+
+Major different point is four.
+
+1. Fixture file prefered CSV to YAML.
+2. loading don't stop, if table columns are not match fixture file's column
+3. Fixture file name can change, if file name is not equal table name.
+4. Fixture data can translate to use filter, like factory girl.
+
+## How to install
+
+This program is implemented Rails Plug-in.
+You want to install this plug-in.
+Please use bundler.
+
+```
+gem "flextures"
+```
+
+(Development emnvoriment must be ruby1.9 higer and rails3 higher)
+
+## How to use
+
+### rake command
+
+load command input fixtures file under "spec/fixtures/".
+(Loading directory can change configuration file)
+
+```
+rake db:flextures:load
+rake db:flextures:dump
+```
+
+rake command can set options.
+For example, this option set dump file name.
+(Option dump only "users.csv")
+
+```
+rake db:flextures:dump TABLE=users
+```
+
+Other options...
+
+| option | description                         |
+---------|--------------------------------------
+| TABLE  | set table name                      |
+| MODEL  | set model name                      |
+| DIR    | set directory name                  |
+| FILE   | set fixture file name               |
+| FORMAT | change dump file format(csv or yml) |
+| OPTION | other options                       |
+| T      | alias TABLE option                  |
+| D      | alias DIR option                    |
+| F      | alias FIXTURES option               |
+
+if you change table colum information
+next comannd regenerate (load fixture and dump) fixtures
+
+```
+rake db:flextures:generate T=users
+```
+
+Other information please see [wiki](https://github.com/baban/flextures/wiki/Rake-command-option) ...
+
+### Unit test flexture support
+
+Fixture load function implemented for Unittes Tools (for example, RSpec, Shoulda).
+
+```ruby
+describe ItemShopController do
+  flextures :users, :items
+```
+
+flexture function can write like a "fixture" function, implemented in RSpec.
+But, "flexture" function ignore columns change.
+
+Flextures function can change load file name.
+
+```ruby
+describe ItemShopController do
+  flextures :items, :users => :users_for_itmshop # load "users_for_itemshop.csv"
+```
+
+Other option information
+Please see [wiki](https://github.com/baban/flextures/wiki/Unittestsupport) ...
+
+### Flextures load & dump filter
+
+#### load filter
+
+If you create filter file.(File name is "config/flextures.factory.rb")
+Factory filter translate fixture data and set database.
+
+For example, this code set current time to last_login_date column.
+
+```ruby
+Flextures::Factory.define :users do |f|
+  f.last_login_date = DateTime.now
+end
+ ```
+
+This sample, generate name and sex automatically, and other tables data generate
+
+```ruby
+require 'faker'
+Flextures::Factory.define :users do |f|
+  f.name= Faker::Name.name if !f.name  # gemerate name
+  f.sex= [0,1].shuffle.first if !f.sex # generate sex
+  # factory filter can generate data, use has_many association
+  f.items<< [ Item.new( master_item_id: 1, count: 5 ), Item.new( master_item_id: 2, count: 3 ) ]
+end
+```
+
+### dump filter
+
+if you need to convert table data into other data format, you use dump filter.
+(dump filter is same file as load filter)
+
+dump filter has hash argumtne, it is formatted colum name key and convert method, proc, lambda value
+
+```ruby
+Flextures::DumpFilter.define :users, {
+  :encrypted_password => lambda { |v| Base64.encode64(v) }
+}
+ ```
+
+Other options please see [wiki](https://github.com/baban/flextures/wiki/Factoryfilter) ...
+
+### Configuration file
+
+Configuration file can change load and dump directory
+(file is config/flextures.config.rb)
+
+```ruby
+# config/flextures.config.rb
+module Flextures
+  # Load and dump directory change "spec/fixtures/" to "test/fixtures/"
+  Config.fixture_load_directory = "test/fixtures/"
+  Config.fixture_dump_directory = "test/fixtures/"
+end
+```
+
+Other options please see [wiki](https://github.com/baban/flextures/wiki/Configuration-file) ...