to_factory 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+pkg/*
+*.swp
+tmp/database.log

data/.rspec

@@ -0,0 +1 @@
+--drb

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ree

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+source "http://gems.github.com"
+
+group :development, :test do
+  gem 'factory_girl_rails'
+  gem 'rspec'
+  gem 'wirble'
+  gem 'spork'
+  gem 'activesupport', "~>3.0"
+  gem 'sqlite3'
+  gem 'ruby-debug'
+  gem 'activerecord'
+end
+
+# Specify your gem's dependencies in to_factory.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,88 @@
+PATH
+  remote: .
+  specs:
+    to_factory (0.0.1)
+      factory_girl_rails
+
+GEM
+  remote: http://rubygems.org/
+  remote: http://gems.github.com/
+  specs:
+    abstract (1.0.0)
+    actionpack (3.0.10)
+      activemodel (= 3.0.10)
+      activesupport (= 3.0.10)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.5.0)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.14)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.10)
+      activesupport (= 3.0.10)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.10)
+      activemodel (= 3.0.10)
+      activesupport (= 3.0.10)
+      arel (~> 2.0.10)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.10)
+    arel (2.0.10)
+    builder (2.1.2)
+    columnize (0.3.4)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    factory_girl (2.0.2)
+    factory_girl_rails (1.1.0)
+      factory_girl (~> 2.0.0)
+      railties (>= 3.0.0)
+    i18n (0.5.0)
+    linecache (0.43)
+    rack (1.2.3)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    railties (3.0.10)
+      actionpack (= 3.0.10)
+      activesupport (= 3.0.10)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.4)
+    rake (0.9.2)
+    rdoc (3.9.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+    spork (0.8.5)
+    sqlite3 (1.3.4)
+    thor (0.14.6)
+    tzinfo (0.3.29)
+    wirble (0.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  activesupport (~> 3.0)
+  factory_girl_rails
+  rspec
+  ruby-debug
+  spork
+  sqlite3
+  to_factory!
+  wirble

data/README.md

@@ -0,0 +1,41 @@
+ToFactory
+=========
+This is a little convenience gem for the scenario where
+you find yourself writing factories for a pre-existing project.
+
+E.g. they didn't have tests or they were using Test:Unit with fixtures but you prefer
+RSpec and FactoryGirl.
+
+Installation
+___________
+
+I've only tried this out with a Rails 3, Ruby 1.8.7 project.
+
+```ruby
+
+#Gemfile
+group =>[:test, :development] do
+  gem 'to_factory'
+end
+```
+
+
+```bash
+bundle install
+```
+
+Usage
+_____
+
+```ruby
+#rails console
+
+> puts User.first.to_factory
+
+#=>
+Factory.define :user do |u|
+  u.email "test@example.com"
+  u.name "Mike"
+end
+
+```

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler/gem_tasks'
+require 'logger'
+require 'active_record'
+require 'yaml'
+
+namespace :test do
+  namespace :db do
+    desc "Migrate the database through scripts in db/migrate. Target specific version with VERSION=x"
+    task :migrate => :environment do
+      ActiveRecord::Migrator.migrate('spec/db/migrate', ENV["VERSION"] ? ENV["VERSION"].to_i : nil )
+    end
+
+    task :environment do
+      ActiveRecord::Base.establish_connection(YAML::load(File.read('spec/config/database.yml')))
+      ActiveRecord::Base.logger = Logger.new(File.open('tmp/database.log', 'a'))
+    end
+  end
+end

data/lib/to_factory/generator.rb

@@ -0,0 +1,115 @@
+module ToFactory
+  class MissingActiveRecordInstanceException < Exception;end
+  class MustBeActiveRecordSubClassException < Exception;end
+
+  def self.included base
+    base.class_eval do
+      unless self.ancestors.include? ActiveRecord::Base
+        raise MustBeActiveRecordSubClassException
+      end
+
+    end
+
+    base.instance_eval do
+      define_method :to_factory do
+        Generator.new(self).factory_with_attributes
+      end
+    end
+  end
+
+  class Generator
+    attr_accessor :model_class, :object_instance
+
+    def initialize object=nil
+      return unless object
+
+      if object.is_a? ActiveRecord::Base
+        @model_class = object.class.to_s
+        @object_instance = object
+      else
+        @model_class = object
+      end
+    end
+
+    def factory
+      out = "Factory :#{name} do |#{abbreviation}|\n"
+      out << yield if block_given?
+      out << "end"
+    end
+
+    def factory_with_attributes
+      factory do
+        to_skip = [:id, :created_at, :updated_at]
+        attributes = object_instance.attributes.delete_if{|key, value| to_skip.include? key.to_sym}
+
+        attributes.map do |attr, value|
+          factory_attribute(attr, value)
+        end.sort.join("\n") << "\n"
+      end
+    end
+
+    def factory_for options
+      @object_instance = find_from options
+      return nil unless @object_instance
+      factory_with_attributes
+    end
+
+    private
+    def find_from options
+      return model_class.find options if options.is_a? Integer
+      unless options.is_a? Hash
+        raise ArgumentError.new("Expected hash of attributes or integer to look up record")
+      end
+
+      options = options.with_indifferent_access
+
+      if id=options['id'].to_i
+        return model_class.find(id) if id > 0
+      end
+
+      finder, params = finder_and_params_from_options options
+
+      model_class.send finder, *params
+    end
+
+    public
+
+    def factory_attribute attr, value=nil
+      raise MissingActiveRecordInstanceException unless object_instance
+
+      value = object_instance.send attr unless value
+
+      value = "nil" if value.nil?
+      value = "\"#{value}\"" if value.is_a? String
+      "  #{abbreviation}.#{attr} #{value}"
+    end
+
+    def name
+      model_class.to_s.underscore
+    end
+
+    private
+
+    def finder_and_params_from_options options
+      params =[]
+      finder = "find_by_"
+
+      options.keys.each do |k|
+        if finder == "find_by_"
+          finder << k
+        else
+          finder << "_and_#{k}"
+        end
+
+        value = options[k]
+        params << value
+      end
+
+      [finder, params]
+    end
+
+    def abbreviation
+      name[0..0]
+    end
+  end
+end

data/lib/to_factory/version.rb

@@ -0,0 +1,3 @@
+module ToFactory
+  VERSION = "0.0.1"
+end

data/lib/to_factory.rb

@@ -0,0 +1,2 @@
+require "to_factory/version"
+require "to_factory/generator"

data/spec/config/database.yml

@@ -0,0 +1,2 @@
+adapter: sqlite3
+database: spec/db/test.sqlite

data/spec/db/migrate/201108201012010100_create_users.rb

@@ -0,0 +1,13 @@
+class CreateUsers < ActiveRecord::Migration
+  def self.up
+    create_table :users do |t|
+      t.column :name, :string, :null => false
+      t.column :email, :string
+      t.integer :some_id
+    end
+  end
+
+  def self.down
+    drop_table :users
+  end
+end

data/spec/generator_spec.rb

@@ -0,0 +1,166 @@
+require File.expand_path('spec/spec_helper')
+
+describe ToFactory::Generator do
+  def options
+    YAML::load File.read('spec/config/database.yml')
+  end
+
+  def connect
+    AR::Base.establish_connection options rescue nil
+    AR::Base.connection
+  end
+
+  before(:all) do
+    ActiveRecord.tap do |AR|
+      connect
+      AR::Base.connection.drop_database options[:database] rescue nil
+
+      begin
+        # Create the SQLite database
+        connect
+        ActiveRecord::Base.connection
+      rescue Exception => e
+        $stderr.puts e, *(e.backtrace)
+        $stderr.puts "Couldn't create database for #{config.inspect}"
+      end
+
+      AR::Migrator.migrate('db/migrate')
+      class User < AR::Base; end
+   end
+  end
+
+  before(:each) do
+    User.destroy_all
+    ActiveRecord::Base.connection.execute "delete from sqlite_sequence where name = 'users'"
+  end
+
+  context "with an active record class but no instance" do
+    before do
+      @generator = ToFactory::Generator.new User
+      User.create :id => 1, :name => 'Tom',   :email => 'blah@example.com',  :some_id => 7
+      User.create :id => 2, :name => 'James', :email => 'james@example.com', :some_id => 8
+    end
+
+    it "initializes" do
+      @generator.model_class.should == User
+    end
+
+    let(:user_factory_1) do
+      user_factory_1 = <<-eof
+Factory :user do |u|
+  u.email "blah@example.com"
+  u.name "Tom"
+  u.some_id 7
+end
+      eof
+      user_factory_1.chop
+    end
+    let(:user_factory_2) do
+      user_factory_2 = <<-eof
+Factory :user do |u|
+  u.email "james@example.com"
+  u.name "James"
+  u.some_id 8
+end
+      eof
+      user_factory_2.chop
+    end
+    context "looking up attributes" do
+      it "takes a key value for id" do
+        out = @generator.factory_for :id => 1
+        out.should == user_factory_1
+      end
+
+      it "takes an integer for id" do
+        out = @generator.factory_for 1
+        out.should == user_factory_1
+      end
+
+      it "takes a key value and does a lookup" do
+        out = @generator.factory_for :name => 'Tom'
+        out.should == user_factory_1
+
+        out = @generator.factory_for :name => 'James'
+        out.should == user_factory_2
+      end
+
+      it "takes multiple keys and does a lookup" do
+        out = @generator.factory_for :id => 1, :name => 'Tom'
+      end
+
+      context "with invalid attributes" do
+        it "raises an exception" do
+          lambda{@generator.factory_for :id => 1000}.should raise_error ActiveRecord::RecordNotFound
+        end
+      end
+    end
+  end
+
+  it "initializes with an activerecord instance" do
+    user = User.create :name => "Jeff"
+    @generator = ToFactory::Generator.new user
+    @generator.model_class.should == "User"
+  end
+
+  it "initializes without an object" do
+    @generator = ToFactory::Generator.new
+    @generator.model_class.should be_nil
+  end
+
+  it "generates the first line of the factory" do
+    @generator = ToFactory::Generator.new User
+    f = @generator.factory
+    output = <<-eof
+Factory :user do |u|
+end
+    eof
+    f.should ==  output.chop
+  end
+
+
+  it "raises an exception without an AR object, when requesting attributes" do
+    @generator = ToFactory::Generator.new User
+    lambda{@generator.factory_attribute :foo}.should raise_error ToFactory::MissingActiveRecordInstanceException
+  end
+
+  context "with a user in the database" do
+    before do
+      User.create :name => "Jeff", :email => "test@example.com", :some_id => 8
+      @generator = ToFactory::Generator.new user
+    end
+
+    let(:user){ User.first}
+
+    it "generates lines for multiple the attributes" do
+      @generator.factory_attribute(:name). should == '  u.name "Jeff"'
+      @generator.factory_attribute(:email).should == '  u.email "test@example.com"'
+    end
+
+    let(:expected) do
+      expected = <<-eof
+Factory :user do |u|
+  u.email "test@example.com"
+  u.name "Jeff"
+  u.some_id 8
+end
+      eof
+      expected.chop
+    end
+
+    it "generates the full factory" do
+      @generator.factory_with_attributes.should == expected
+    end
+
+    it "adds the to_factory method to an active record object" do
+      ActiveRecord::Base.send :include, ToFactory
+      user.to_factory.should == expected
+    end
+
+    it "raises an error if you try to inlude in a non ActiveRecord object" do
+      class Egg;end
+
+      lambda{Egg.send :include, ToFactory}.should raise_error ToFactory::MustBeActiveRecordSubClassException
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'spork'
+require 'spork/ext/ruby-debug'
+
+Spork.prefork do
+  require 'active_record'
+  require 'rspec'
+  require 'yaml'
+  require 'fileutils'
+  require 'ruby-debug'
+  require 'active_support/core_ext/string'
+  require 'active_support/core_ext/hash'
+end
+
+Spork.each_run do
+  Dir['lib/**/*.rb'].each{|f| require f unless f=="lib/to_factory/version.rb"}
+end

data/to_factory.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "to_factory/version"
+
+Gem::Specification.new do |s|
+  s.name        = "to_factory"
+  s.version     = ToFactory::VERSION
+  s.authors     = ["Mark Burns"]
+  s.email       = ["markthedeveloper@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Turn ActiveRecord instances into factories}
+  s.add_dependency('factory_girl_rails')
+
+  s.description = %q{This gem gives the object.to_factory method to give a formatted string version of an ActiveRecord object that can be used by factory_girl}
+
+  s.rubyforge_project = "to_factory"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: to_factory
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Mark Burns
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-21 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: factory_girl_rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: This gem gives the object.to_factory method to give a formatted string version of an ActiveRecord object that can be used by factory_girl
+email: 
+- markthedeveloper@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/to_factory.rb
+- lib/to_factory/generator.rb
+- lib/to_factory/version.rb
+- spec/config/database.yml
+- spec/db/migrate/201108201012010100_create_users.rb
+- spec/db/test.sqlite
+- spec/generator_spec.rb
+- spec/spec_helper.rb
+- to_factory.gemspec
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: to_factory
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Turn ActiveRecord instances into factories
+test_files: 
+- spec/config/database.yml
+- spec/db/migrate/201108201012010100_create_users.rb
+- spec/db/test.sqlite
+- spec/generator_spec.rb
+- spec/spec_helper.rb