factory_seed 0.1.0

data/README.rdoc

@@ -0,0 +1,90 @@
+= Introduction
+
+Seed introduces an easy way to instantiate factories created with Factory Girl.
+
+= Install
+
+  sudo gem install factory_seed
+
+If you want the source go to http://github.com/fnando/factory_seed
+
+= Usage
+
+Take the following factories:
+
+  Factory.define(:user) do |f|
+    f.username { Factory.next(:username) }
+    f.password "test"
+    f.password_confirmation "test"
+  end
+
+  Factory.define(:messages) do |f|
+    f.association :user
+    f.subject "Some subject"
+  end
+
+  Factory.define(:comments) do |f|
+    f.association :user
+    f.comment "Some comment"
+  end
+
+You need to include the +Seed+ module where you want to use it.
+
+  require "seed"
+  include Seed
+
+  _10_users
+  _1_user_with_10_comments
+  _1_user_with_10_comments_and_3_messages
+
+If you think that underscores are ugly, you can simply use the +seed+ method.
+
+  seed "10 users"
+  seed "1 user with 10 comments"
+
+You can set variables by using the records you just created.
+
+  @user = _1_user
+  @user, @comments = _1_user_with_10_comments
+  @user, @comments, @messages = _1_user_with_10_comments_and_10_messages
+
+You can define the associations by providing a hash.
+
+  @user = _1_user
+  _10_comments(:user => @user)
+
+= Using with Test::Unit
+
+Just include the +Seed+ module.
+
+  class SomeTest < Test::Unit::TestCase
+    include Seed
+  end
+
+Or if you want to make Seed available to all test cases
+
+  class Test::Unit::TestCase
+    include Seed
+  end
+
+= Using with RSpec
+
+Include the +Seed+ module by using the +configure+ method.
+
+  Spec::Runner.configure do |config|
+    config.include(Seed)
+  end
+
+= License
+
+(The MIT License)
+
+Copyright © 2010:
+
+* Nando Vieira (http://simplesideias.com.br)
+
+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/lib/seed.rb

@@ -0,0 +1,107 @@
+module Seed
+  #++
+  # TODO:
+  # * Support the construction 10_users_and_10_posts
+  #--
+
+  # The +seed+ method allows you to instantiate factories by parsing a simple text.
+  #
+  #   seed "1 user"
+  #   seed "2 users"
+  #   seed "1 admin user"
+  #   seed "1 user with 10 posts"
+  #   seed "1 user with 10 posts and 10 comments"
+  #   seed "10 comments", :user => @user
+  #
+  # You can set variables by using the returned result.
+  #
+  #   @user = seed("1 user")
+  #   @users = seed("10 users")
+  #   @user, @comments = seed("1 user with 10 comments")
+  #   @user, @comments, @posts = seed("1 user with 10 comments and 10 posts")
+  #
+  # There's a shortcut for the +seed+ method. All you have to do is replace the spaces by underscores
+  # and call it as a method by prefixing it with an underscore. Confuse? Not at all!
+  # This
+  #
+  #   seed("1 user")
+  #
+  # becomes
+  #
+  #   _1_user
+  #
+  # More samples:
+  #
+  #   @user = _1_user
+  #   @users = _10_users
+  #   @comment = _1_comment(:user => @user)
+  #   @comments = _10_comments
+  #   @user, @comments, @posts = _1_user_with_10_comments_and_3_posts
+  #
+  def seed(text, options = {})
+    _instantiate_factories(text, options)
+  end
+
+  def _instantiate_factories(method, options = nil, results = [], iteration = 0) # :nodoc:
+    iteration += 1
+
+    # Set default options
+    options ||= {}
+
+    # Retrieve count and main factory name
+    _, size, what = *method.match(/^ ?(\d+) (.*?)$/)
+
+    size = size.to_i
+
+    associations = nil
+    matches = what.match(/^(.*?) with (.*?)$/)
+
+    if matches
+      what = $1
+      associations = $2.split(" and ")
+    end
+
+    what.gsub!(/ /, "_")
+    what = what.singularize if size > 1
+
+    records = Array.new(size) { Factory.create(what, options) }
+
+    if size > 1 && iteration == 1
+      results = records
+    elsif size > 1
+      results << records
+    elsif size == 1 && iteration == 1 && !associations
+      results = records.first
+    else
+      results << records.first
+    end
+
+    if associations
+      records.each do |record|
+        associations.each do |assoc|
+          _instantiate_factories(assoc, options.merge(what => record), results, iteration)
+        end
+      end
+    end
+
+    results
+  end
+
+  def respond_to?(method, include_private = false) # :nodoc:
+    if method.to_s =~ /^_\d+_[a-z_]+/
+      true
+    else
+      super
+    end
+  end
+
+  def method_missing(method, *args) # :nodoc:
+    method_name = method.to_s
+
+    if method_name =~ /^_(\d+)/
+      _instantiate_factories(method_name.gsub(/_/, " "), args.first)
+    else
+      super
+    end
+  end
+end

data/lib/seed/version.rb

@@ -0,0 +1,8 @@
+module Seed
+  module Version # :nodoc: all
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+  end
+end

data/test/resources/factories.rb

@@ -0,0 +1,25 @@
+Factory.sequence(:username) do |i|
+  "johndoe#{i}"
+end
+
+Factory.sequence(:title) do |i|
+  "Post ##{i}"
+end
+
+Factory.define(:user) do |f|
+  f.username { Factory.next(:username) }
+end
+
+Factory.define(:admin_user, :parent => :user) do |f|
+  f.admin true
+end
+
+Factory.define(:post) do |f|
+  f.title { Factory.next(:title) }
+  f.association :user
+end
+
+Factory.define(:comment) do |f|
+  f.association :user
+  f.association :post
+end

data/test/resources/models.rb

@@ -0,0 +1,13 @@
+class User < ActiveRecord::Base
+  has_many :posts
+  has_many :comments
+end
+
+class Post < ActiveRecord::Base
+  belongs_to :user
+end
+
+class Comment < ActiveRecord::Base
+  belongs_to :user
+  belongs_to :post
+end

data/test/schema.rb

@@ -0,0 +1,15 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :users do |t|
+    t.string :username
+    t.boolean :admin, :default => false, :null => false
+  end
+
+  create_table :posts do |t|
+    t.references :user
+    t.string :title
+  end
+
+  create_table :comments do |t|
+    t.references :post, :user
+  end
+end

data/test/seed_test.rb

@@ -0,0 +1,110 @@
+require "test_helper"
+
+class SeedTest < Test::Unit::TestCase
+  include Seed
+
+  def setup
+    User.delete_all
+    Post.delete_all
+  end
+
+  def test_1_user
+    _1_user
+
+    assert_equal 1, User.count
+  end
+
+  def test_2_users
+    _2_users
+
+    assert_equal 2, User.count
+  end
+
+  def test_1_user_with_1_post
+    _1_user_with_1_post
+
+    assert_equal 1, User.count
+    assert_equal 1, Post.count
+    assert_equal 1, User.first.posts.count
+  end
+
+  def test_1_user_with_10_posts
+    _1_user_with_10_posts
+
+    assert_equal 1, User.count
+    assert_equal 10, Post.count
+    assert_equal 10, User.first.posts.count
+  end
+
+  def test_1_user_with_10_posts_and_10_comments
+    _1_user_with_10_posts_and_10_comments
+
+    assert_equal 10, User.first.posts.count
+    assert_equal 10, User.first.comments.count
+  end
+
+  def test_1_post_with_options
+    @user = Factory(:user)
+    _1_post(:user => @user)
+
+    assert_equal 1, @user.posts.count
+  end
+
+  def test_10_posts_with_options
+    @user = Factory(:user)
+    _10_posts(:user => @user)
+
+    assert_equal 10, @user.posts.count
+  end
+
+  def test_10_posts_using_seed_method
+    seed "10 users"
+    assert_equal 10, User.count
+  end
+
+  def test_return_1_user
+    @user = _1_user
+    assert_kind_of User, @user
+  end
+
+  def test_return_10_users
+    @users = _10_users
+    assert_equal 10, @users.count
+  end
+
+  def test_return_1_user_with_10_comments
+    @user, @comments = _1_user_with_10_comments
+
+    assert_kind_of User, @user
+    assert_equal 10, @user.comments.count
+  end
+
+  def test_return_1_user_with_10_comments_and_3_posts
+    @user, @comments, @posts = _1_user_with_10_comments_and_3_posts
+
+    assert_kind_of User, @user
+    assert_equal 10, @comments.count
+    assert_equal 3, @posts.count
+  end
+
+  def test_return_1_user_with_1_comment_and_1_post
+    @user, @comment, @post = _1_user_with_1_comment_and_1_post
+
+    assert_kind_of User, @user
+    assert_kind_of Comment, @comment
+    assert_kind_of Post, @post
+  end
+
+  def test_respond_to_methods
+    assert respond_to?("_10_users")
+    assert respond_to?("_1_user_with_10_comments")
+    assert respond_to?("_1_user_with_10_comments_and_1_post")
+  end
+
+  def test_1_user_as_admin
+    @user = _1_admin_user
+
+    assert_kind_of User, @user
+    assert @user.admin?
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+require "rubygems"
+require "test/unit"
+require "active_record"
+require "active_support"
+require "factory_girl"
+
+require "seed"
+require "resources/factories"
+require "resources/models"
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+load "schema.rb"

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: factory_seed
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Nando Vieira
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-22 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: factory_girl
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Seed introduces an easy way to instantiate factories created with Factory Girl.
+email: fnando.vieira@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- lib/seed.rb
+- lib/seed/version.rb
+- test/resources/factories.rb
+- test/resources/models.rb
+- test/schema.rb
+- test/seed_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/fnando/factory_seed
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Seed introduces an easy way to instantiate factories created with Factory Girl.
+test_files: 
+- test/resources/factories.rb
+- test/resources/models.rb
+- test/schema.rb
+- test/seed_test.rb
+- test/test_helper.rb