flextures 2.1.0 → 3.0.0

data/Gemfile

@@ -3,7 +3,7 @@ source "http://rubygems.org"
 #gem "activerecord"
 
 group :development, :test do
-  gem "bundler", "1.2.0"
+  gem "bundler", "1.3.5"
   gem "jeweler", "1.8.3"
 end
 

data/Gemfile.lock

@@ -27,6 +27,6 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (= 1.2.0)
+  bundler (= 1.3.5)
   jeweler (= 1.8.3)
   shoulda

data/README.ja.rdoc

@@ -15,8 +15,8 @@ Rails標準のfixtureの不満点を解消するために作成しました
 通常のfixtureとの主な違いは次の４点です
 
 1. yamlよりもcsvを優先する
-2. migrationでテーブル構成が変わっても、ロードを停止しないで、カラムの変更点を検知して値を補完する
-3. テーブル名と、fixtureのファイル名を一致させないでも自由なロード＆ダンプが出来る機能
+2. migrationでテーブル構成が変わっても、カラムの変更点を無視、補完してロードを行う
+3. テーブル名とfixtureのファイル名を一致させないでも、自由なロード＆ダンプが出来るオプション
 4. FactoyGirl風の読み込みフィルタで、Fixtureのデータを加工しながら読み込む事が出来る
 
 == インストール方法
@@ -26,14 +26,18 @@ gem化されているので、bundlerで次のように記述して、普通にb
 
  gem "flextures"
 
-ちなみに開発環境はruby1.9系、rails3環境を想定しています
+現在flexturesは機能を追加したバージョンアップをした３系への移行作業途中で
+ソースコード、マニュアルは３系のものになっています
+最新版のソースコードはgithub上に挙げられているのでbundlerにguthubのリポジトリのURLを追加して下さい
+
+ちなみに開発環境はruby1.9以上のバージョン、rails3以上、もしくはPadrinoを想定しています
 
 == 使い方
 
 === rakeコマンド
 
 次のコマンドで spec/fixtures/ 以下にあるfixtureのロード＆ダンプを行います
-(ディレクトリは設定ファイルで変更可能)
+(読み込む基本のディレクトリは設定ファイルで変更可能)
 
  rake db:flextures:load
  rake db:flextures:dump
@@ -49,31 +53,31 @@ Usersモデルのfixture(users.csvか　users.yml)をロードする
 
  rake db:flextures:load MODEL=User
 
-その他オプションは以下のとおりな感じです:
+その他オプションは以下の通りです:
 
  TABLE : テーブル名を指定してロード。テーブル名はカンマ切りで複数指定が可能
  MODEL : モデル名を指定してロード。モデル名はカンマ区切りで複数指定が可能
  DIR : フィクスチャをロード＆ダンプするディレクトリを指定する
- FIXTURES : ロード、ダンプをするファイル名をRails標準以外のもので直接指定(Userモデルのusers.csv以外を指定)
- FILE : ロード、ダンプをするファイル名をRails標準以外のもので直接指定(Userモデルのusers.csv以外を指定)
+ FILE : loadまたはdumpするファイル名を直接指定(Userモデルのusers.csv以外を指定)
+ FORMAT：ダンプ、またはロードするデータの種類を指定できる(csvかyml)
+ OPTION：その他の細かい読み込みオプションはここで指定出来ます
  T : TABLEのエイリアス
- M : モデル名指定のエイリアス
  D : ディレクトリ指定のエイリアス
  F : ファイル名指定のエイリアス
 
-yamlのファイルはロードしたいけどcsvはロードをしたくない
-またはその逆の場合は、以下のコマンドでそれが可能です
- 
- rake db:flextures:csvload
- rake db:flextures:ymlload
- rake db:flextures:csvdump
- rake db:flextures:ymldump
+migration等でテーブルの構成が変わった時には
+generateコマンドを実行すると、テーブル情報のloadとdumpをセットで行なってくれるので便利です
+
+ rake db:flextures:generate T=users
 
-通常の load や dump で使えるオプションはこちらでも使用可能です
+さらに詳しい説明に関しては {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]を参照して下さい
 
-=== RSpec flexture support
+=== Unit test flexture support
 
-RSpec中でfixtures関数の代わりにfixtureのロード機能を使えます
+ユニットテスト中でデータの読み込みが行いたくなったときのために
+fixtureのロード機能を使えます
+
+次の例はRSpecからの読み込みですが
 基本的な機能は、通常のfixturesと同じですので、fixtures と同じ感覚で使用して下さい
 
  describe ItemShopController do
@@ -86,11 +90,15 @@ RSpec中でfixtures関数の代わりにfixtureのロード機能を使えます
  describe ItemShopController do
    flextures :items, :users => :users_for_itmshop # users_for_itemshop.csv をロードする
 
-=== Flextures load and dump filter
+その他現在はShouldからの呼び出しや様々なオプションを載せていますが
+さらに詳しい使い方に関しては {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)
 
 ==== load filer
 
 Railsのプロジェクトに config/flextures.factory.rb というファイルを作成して、そこにフィルタを記述することによって
+(Padrinoでも設置場所は同じです)
 フィクスチャの読み込み時に、値を加工して読み込む事が可能になっています
 例えば、次の様に記述するとusersテーブルのlast_login_dateの値を、常に現在の時間として設定できます
 
@@ -98,8 +106,8 @@ Railsのプロジェクトに config/flextures.factory.rb というファイル
    f.last_login_date = DateTime.now
  end
 
-テーブルにdefaultとか設定していなくても
-カラムのデータとかを、適当に補完する機能があるので
+テーブルにdefaultの値を設定していなくても
+カラムのデータを適当に補完する機能があるので
 大量のデータを生成したい時は次のように{faker}[https://github.com/stympy/faker]等と組み合わせて
 必要な分だけ生成をさせると、今までより若干捗るかもしれません
 
@@ -121,6 +129,9 @@ Railsのプロジェクトに config/flextures.factory.rb というファイル
    :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] を参照して下さい
+
 === 設定ファイル
 
 config/flextures.config.rb　で設定ファイルを作成すると、データをロード＆ダンプするディレクトリなどの設定を変更できます
@@ -132,5 +143,5 @@ config/flextures.config.rb　で設定ファイルを作成すると、データ
    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.rdoc

@@ -13,10 +13,10 @@ Each commands load or dump fixtures.
 
 Major different point is four.
 
-1. Fixture file is prefered CSV to YAML.
-2. Don't stop load if table colums are'nt match fixture file's column.
-3. Fixture file name can change if file name is not equal table name. 
-4. Fixture data translate to use filter like factory girl.
+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
 
@@ -26,7 +26,15 @@ Please use bundler.
 
  gem "flextures"
 
-(Development emnvoriment must be ruby1.9 and rails3)
+ curent flextures is developping version3.0
+ 
+This document and sourcecode and documents(readme.rdoc,wiki) write about version flextures 3.0 (current released version is 2.1.0)
+if you want to use flextures3.0
+your Gemfile should set option github url
+
+  gem "flextures", git:"https://github.com/baban/flextures"
+
+(Development emnvoriment must be ruby1.9 higer and rails3 higher)
 
 == How to use
 
@@ -44,34 +52,28 @@ For example, this option set dump file name.
 
  rake db:flextures:dump TABLE=users
 
-If you use this option load command.
-Option set load file name.
-(loading "users.csv" or "users.yml")
-
- rake db:flextures:load MODEL=User
-
 Other options...
 
  TABLE : set table name
  MODEL : set model name
  DIR : set directory name
- FIXTURES : set fixture file name
  FILE : set fixture file name
+ FORMAT：change dump file format(csv or yml)
+ OPTION：other options
  T : alias TABLE option
- M : alias MODEL option
  D : alias DIR option
  F : alias FIXTURES option
 
-if you only load CSV file or YAML file, next command can load.
- 
- rake db:flextures:csvload
- rake db:flextures:ymlload
- rake db:flextures:csvdump
- rake db:flextures:ymldump
+if you change table colum information
+next comannd regenerate (load fixture and dump) fixtures
 
-=== RSpec flexture support
+ rake db:flextures:generate T=users
 
-Fixture load function implemented for RSpec.
+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).
 
  describe ItemShopController do
    flextures :users, :items
@@ -84,6 +86,9 @@ Flextures function can change load file name.
  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
@@ -118,6 +123,8 @@ dump filter has hash argumtne, it is formatted colum name key and convert method
    :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
@@ -130,5 +137,5 @@ Configuration file can change load and dump directory
    Config.fixture_dump_directory = "test/fixtures/"
  end
 
-
+Other options please see {wiki}[https://github.com/baban/flextures/wiki/Configuration-file] ...
 

data/VERSION

@@ -1 +1 @@
-2.1.0
+3.0.0

data/flextures.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "flextures"
-  s.version = "2.1.0"
+  s.version = "3.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["baban"]
-  s.date = "2013-02-03"
+  s.date = "2013-06-24"
   s.description = "load and dump fixtures"
   s.email = "babanba.n@gmail.com"
   s.extra_rdoc_files = [
@@ -46,6 +46,7 @@ Gem::Specification.new do |s|
     "test/unit/test_flextures.rb",
     "test/unit/test_flextures_args.rb",
     "test/unit/test_flextures_dumper.rb",
+    "test/unit/test_flextures_extention_modules.rb",
     "test/unit/test_flextures_hooks.rb",
     "test/unit/test_flextures_loader.rb",
     "test/unit/test_simple.rb"
@@ -53,21 +54,21 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/baban/flextures"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.25"
+  s.rubygems_version = "1.8.10"
   s.summary = "load and dump fixtures"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<bundler>, ["= 1.2.0"])
+      s.add_development_dependency(%q<bundler>, ["= 1.3.5"])
       s.add_development_dependency(%q<jeweler>, ["= 1.8.3"])
     else
-      s.add_dependency(%q<bundler>, ["= 1.2.0"])
+      s.add_dependency(%q<bundler>, ["= 1.3.5"])
       s.add_dependency(%q<jeweler>, ["= 1.8.3"])
     end
   else
-    s.add_dependency(%q<bundler>, ["= 1.2.0"])
+    s.add_dependency(%q<bundler>, ["= 1.3.5"])
     s.add_dependency(%q<jeweler>, ["= 1.8.3"])
   end
 end

data/lib/flextures/flextures.rake

@@ -11,12 +11,21 @@ namespace :db do
 
     desc "Dump data to prefer csv format"
     task :csvdump => :environment do
-      Flextures::Rake::Command::csvdump
+      puts "This command is deprecated"
+      # TODO: deprecated message
+      # please use 'FOAMRT=csv' option
+      ENV["FORMAT"]="csv"
+      Flextures::Rake::Command::dump
     end
 
     desc "Dump data to yaml format"
     task :ymldump => :environment do
-      Flextures::Rake::Command::ymldump
+      puts "This command is deprecated"
+      puts "please use 'rake db:flextures:dump FORMAT='yml''"
+      # TODO: deprecated message
+      # please use 'FOAMRT=yml' option
+      ENV["FORMAT"]="yml"
+      Flextures::Rake::Command::dump
     end
 
     desc "load fixture data csv format"
@@ -26,12 +35,27 @@ namespace :db do
 
     desc "load fixture data only csv format files"
     task :csvload => :environment do
-      Flextures::Rake::Command::csvload
+      puts "This command is deprecated"
+      puts "please use 'rake db:flextures:load FORMAT='csv''"
+      # TODO: deprecated message
+      # please use 'FOAMRT=csv' option
+      ENV["FORMAT"]="csv"
+      Flextures::Rake::Command::load
     end
 
     desc "load fixture files only yaml format"
     task :ymlload => :environment do
-      Flextures::Rake::Command::ymlload
+      # TODO: deprecated message
+      # please use 'FOAMRT=yml' option
+      ENV["FORMAT"]="yml"
+      puts "This command is deprecated"
+      puts "please use 'rake db:flextures:load FORMAT='yml''"
+      Flextures::Rake::Command::load
     end
+
+    desc "load and dump file (replace) new data file"
+    task :generate => :environment do
+      Flextures::Rake::Command::generate
+    end 
   end
 end

data/lib/flextures/flextures.rb

@@ -8,17 +8,16 @@ require "flextures/flextures_extension_modules"
 require "flextures/flextures_factory"
 
 module Flextures
-  LOAD_DIR = Config.fixture_load_directory
-  DUMP_DIR = Config.fixture_dump_directory
-
-  # テーブルモデルの作成
+  # ActiveRecord Model is created that guess by table_name
+  # @params [String|Symbol] table_name
+  # @params [ActiveRecord::Base] model class
   def self.create_model table_name
-    # Factoryにオプションで指定があった時
+    # when Model is defined in FactoryFilter
     a = ->{
       f = Factory::FACTORIES[table_name.to_sym]
       f && f[:model]
     }
-    # テーブル名からモデル名が推測できるとき
+    # when program can guess Model name by table_name
     b = ->{
       begin
         table_name.singularize.camelize.constantize
@@ -26,14 +25,14 @@ module Flextures
         nil
       end
     }
-    # モデル名推測不可能なとき
+    # when cannot guess Model name
     c = ->{ 
       Class.new(ActiveRecord::Base){ |o| o.table_name=table_name }
     }
     a.call || b.call || c.call
   end
 
-  # 設定ファイルが存在すればロード
+  # load configuration file, if file is exist
   def self.init_load
     if defined?(Rails) and Rails.root
       [
@@ -43,20 +42,18 @@ module Flextures
     end
   end
 
-  # 全テーブル削除のときにほんとうに消去して良いテーブル一覧を返す
+  # @return [Array] flextures useable table names
   def self.deletable_tables
     tables = ActiveRecord::Base.connection.tables
-    Flextures::Config.ignore_tables.each do |name|
-      tables.delete name
-    end
+    Flextures::Config.ignore_tables.each { |name| tables.delete name }
     tables
   end
 
-  # テーブル情報の初期化
+  # initialize table data
   def self.init_tables
     tables = Flextures::deletable_tables
     tables.each do |name|
-      # テーブルではなくviewを拾って止まる場合があるのでrescueしてしまう
+      # if 'name' variable is 'database view', raise error
       begin
         Class.new(ActiveRecord::Base){ |o| o.table_name= name }.delete_all
       rescue => e
@@ -64,41 +61,40 @@ module Flextures
     end
   end
 
-  # テーブル情報の初期化
   def self.delete_tables *tables
     tables.each do |name|
-      # テーブルではなくviewを拾って止まる場合があるのでrescueしてしまう
+      # if 'name' variable is 'database view', raise error
       begin
         Class.new(ActiveRecord::Base){ |o| o.table_name= name }.delete_all
-      rescue => e
+      rescue StandaraError => e
       end
     end
   end
 
-  # デバッグ用のメソッド、渡されたブロックを実行する
-  # 主にテーブルの今の中身を覗きたい時に使う
+  # It is debug method to use like 'tab' method
+  # @params [Proc] dumper write dump information
   def self.table_tap &dumper
     tables = Flextures::deletable_tables
     tables.each do |name|
-      # テーブルではなくviewを拾って止まる場合があるのでrescueしてしまう
+      # if 'name' variable is 'database view', raise error
       begin
         klass = Class.new(ActiveRecord::Base){ |o| o.table_name= name; }
         dumper.call klass
-      rescue => e
+      rescue StandaraError => e
       end
     end
   end
 
   # parse arguments functions
   module ARGS
-    # 書き出し 、読み込み すべきファイルとオプションを書きだす
+    # parse rake ENV parameters
     def self.parse option={}
       table_names = []
-      if ENV["T"] or ENV["TABLE"]
-        table_names = (ENV["T"] or ENV["TABLE"]).split(',').map{ |name| { table: name, file: name } }
+      if v = (ENV["T"] or ENV["TABLE"])
+        table_names = v.split(',').map{ |name| { table: name, file: name } }
       end
-      if ENV["M"] or ENV["MODEL"]
-        table_names = (ENV["M"] or ENV["MODEL"]).split(',').map do |name|
+      if v = (ENV["M"] or ENV["MODEL"])
+        table_names = v.split(',').map do |name|
           name = name.constantize.table_name
           { table: name, file: name }
         end
@@ -122,14 +118,23 @@ module Flextures
 
       table_names = table_names.map{ |option| option.merge dir: ENV["DIR"] } if ENV["DIR"]
       table_names = table_names.map{ |option| option.merge dir: ENV["D"]   } if ENV["D"]
-      # read mode だとcsvもyaml存在しないファイルは返さない
+
+      table_names = table_names.map{ |option| option.merge minus: ENV["MINUS"].to_s.split(",") } if ENV["MINUS"]
+      table_names = table_names.map{ |option| option.merge plus:  ENV["PLUS"].to_s.split(",")  } if ENV["PLUS"]
+
+      table_names = table_names.map{ |option| option.merge silent: true }   if ENV["OPTION"].to_s.split(",").include?("silent")
+      table_names = table_names.map{ |option| option.merge unfilter: true } if ENV["OPTION"].to_s.split(",").include?("unfilter")
+      table_names = table_names.map{ |option| option.merge strict: true }   if ENV["OPTION"].to_s.split(",").include?("strict")
+
+      # if mode is 'read mode' and file is not exist value is not return
       table_names.select! &exist if option[:mode] && option[:mode] == 'read'
       table_names
     end
 
     # check exist filename block
     def self.exist
-      return->(name){ File.exists?("#{LOAD_DIR}#{name}.csv") or File.exists?("#{LOAD_DIR}#{name}.yml") }
+      return->(name){ File.exists?( File.join( Config.fixture_load_directory, "#{name}.csv") ) or
+                      File.exists?( File.join( Config.fixture_load_directory, "#{name}.yml") ) }
     end
   end
 end