fastory 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ryan Angilly
+
+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.rdoc

@@ -0,0 +1,18 @@
+= fastory
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Punchbowl Software. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,61 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "fastory"
+    gem.summary = %Q{Make FactoryGirl faster by caching SQL on frequently used factories}
+    gem.description = %Q{Sits on top of FactoryGirl and, when appropriate, caches SQL for later playback}
+    gem.email = "ryan@angilly.com"
+    gem.homepage = "http://github.com/mypunchbowl/fastory"
+    gem.authors = ["Ryan Angilly"]
+    gem.add_development_dependency "thoughtbot-shoulda"
+    gem.add_dependency "activesupport", '>=2.3.5'
+    gem.add_dependency "activerecord", '>=2.3.5'
+    gem.add_dependency "factory_girl", '>=1.2.3'
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "fastory #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/fastory.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{fastory}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ryan Angilly"]
+  s.date = %q{2010-01-27}
+  s.description = %q{Sits on top of FactoryGirl and, when appropriate, caches SQL for later playback}
+  s.email = %q{ryan@angilly.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "fastory.gemspec",
+     "lib/fastory.rb",
+     "test/fastory_test.rb",
+     "test/test.db",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/mypunchbowl/fastory}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Make FactoryGirl faster by caching SQL on frequently used factories}
+  s.test_files = [
+    "test/fastory_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.3.5"])
+      s.add_runtime_dependency(%q<activerecord>, [">= 2.3.5"])
+      s.add_runtime_dependency(%q<factory_girl>, [">= 1.2.3"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 2.3.5"])
+      s.add_dependency(%q<activerecord>, [">= 2.3.5"])
+      s.add_dependency(%q<factory_girl>, [">= 1.2.3"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 2.3.5"])
+    s.add_dependency(%q<activerecord>, [">= 2.3.5"])
+    s.add_dependency(%q<factory_girl>, [">= 1.2.3"])
+  end
+end
+

data/lib/fastory.rb

@@ -0,0 +1,139 @@
+require 'active_support'
+require 'active_record'
+
+module Punchbowl
+  module InstanceMethods
+    def self.included(receiver)
+      Fastory.sql_inserts = []
+      Fastory.fastories = {}
+
+      receiver.instance_eval do
+        alias_method_chain :teardown, :fastory_refresh
+      end
+    end
+
+    def teardown_with_fastory_refresh
+      Fastory.fastories.each do |k,v|
+        Fastory.fastories[k][:templates_used] = 0
+      end
+
+      teardown_without_fastory_refresh
+    end
+  end
+
+  class Fastory
+    attr_accessor :name, :options    
+    cattr_accessor :fastories, :sql_inserts, :record_sql
+    
+    @@fastories = {}
+    @@sql_inserts = []
+    @@record_sql = false
+
+    def initialize(name, options = {})
+      self.name = name
+      self.options = options
+    end
+
+    def process! 
+      options = transform_associations
+
+      if template_available?
+        cache = @@fastories[cache_key]
+        cnt = cache[:templates_used] ||= 0
+        cache[:templates_used] += 1
+
+        fast_gen(cache[:templates][cnt][:sql])
+
+        obj = build_class.find cache[:templates][cnt][:id]
+      else
+        @@sql_inserts = []
+        @@record_sql = true
+        obj = fg.build name, options
+        obj.id = fg.next(:fastory_id_generator) if obj.id.blank? 
+        obj.save!
+        @@record_sql = false
+
+        @@fastories[cache_key] ||= {}
+        @@fastories[cache_key][:templates_available] ||= 0
+        @@fastories[cache_key][:templates_available] += 1
+        @@fastories[cache_key][:templates_used] = @@fastories[cache_key][:templates_available]
+
+        res = @@fastories[cache_key][:templates] ||= []
+        obj_meta = {:sql => @@sql_inserts.dup, :id => obj.id }
+        res = @@fastories[cache_key][:templates] << obj_meta 
+      end
+
+      obj
+    end
+
+    private
+
+    def transform_associations
+      output_options = {}
+      options.each do |k,v|
+        unless v.is_a?(ActiveRecord::Base)
+          output_options[k] = v
+          next
+        end
+
+        raise 'Cannot deal with new records either... sorry' if v.new_record?
+        assoc = build_class.reflect_on_all_associations.find {|a| a.name.to_s == k.to_s }
+        raise "No association #{name} on #{k}" if assoc.blank?
+        raise 'Can only deal with belongs_to right now' unless assoc.belongs_to?
+
+        output_options[assoc.primary_key_name] = v.id
+      end
+
+      output_options
+    end
+
+    def build_class
+      fg.factories[name].build_class
+    end
+
+    def template_available?
+      @@fastories[cache_key].present? && (@@fastories[cache_key][:templates_available].to_i > @@fastories[cache_key][:templates_used].to_i)
+    end
+
+    def fg
+      ::Factory
+    end
+
+    def fast_gen(sql)
+      sql.each {|s| ActiveRecord::Base.connection.execute_without_query_capture(s) }
+    end
+
+    def cache_key
+      options.to_a.map {|a,b| [a.to_s, b.to_s]}.sort {|a,b| a[0] <=> b[0]}.unshift([:name, name])
+    end
+  end
+end
+
+ActiveRecord::Base.connection.class_eval do
+  define_method :execute_with_query_capture do |*args|
+    sql = args[0]
+    name = args[1]
+
+    if Punchbowl::Fastory.record_sql
+      case sql
+      when /\A(DELETE|UPDATE|INSERT)/
+        Punchbowl::Fastory.sql_inserts << sql
+      end
+    end
+
+    execute_without_query_capture(sql, name)
+  end
+
+  alias_method_chain :execute, :query_capture
+end
+
+if defined?(ActiveSupport) && defined?(ActiveSupport::TestCase)
+  ActiveSupport::TestCase.send :include, Punchbowl::InstanceMethods
+end
+
+Factory.sequence(:fastory_id_generator) {|n| n.to_i}
+
+def Fastory(name, options = {})
+  Punchbowl::Fastory.new(name, options).process!
+end
+

data/test/fastory_test.rb

@@ -0,0 +1,24 @@
+require 'test_helper'
+
+class FastoryTest < Test::Unit::TestCase
+  include Punchbowl::InstanceMethods
+ 
+  should "define Fastory" do
+    assert Fastory(:user).is_a?(User)
+  end
+
+  should "handle associations" do
+    @user = Fastory :user
+    @event = Fastory :event, :user => @user
+  
+    @user.reload
+    @event.reload
+
+    assert_equal @user, @event.user
+  end
+
+  def teardown
+    ActiveRecord::Base.connection.execute 'delete from users'
+    ActiveRecord::Base.connection.execute 'delete from events'
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_record'
+require 'shoulda'
+require 'factory_girl'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3",
+                                        :database  => File.join(File.dirname(__FILE__), 'test.db')) 
+
+ActiveRecord::Schema.define do
+  execute 'DROP TABLE IF EXISTS users'
+  execute 'DROP TABLE IF EXISTS events'
+  
+  create_table :users, :force => true do |t|
+    t.string :name
+    t.string :email
+  end
+
+  create_table :events, :force => true do |t|
+    t.string :title
+    t.integer :user_id
+  end
+end
+
+require 'fastory'
+
+class User < ActiveRecord::Base
+  has_many :events
+end
+
+class Event < ActiveRecord::Base
+  belongs_to :user
+end
+
+Factory.define(:user) do |u|
+  u.name 'Ryan'
+  u.email 'ryan@angilly.com'
+end
+
+Factory.define(:event) do |e|
+  e.user { Factory :user }
+  e.title 'My sweet party'
+end
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: fastory
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ryan Angilly
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-27 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.5
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.5
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: factory_girl
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3
+    version: 
+description: Sits on top of FactoryGirl and, when appropriate, caches SQL for later playback
+email: ryan@angilly.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- fastory.gemspec
+- lib/fastory.rb
+- test/fastory_test.rb
+- test/test.db
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/mypunchbowl/fastory
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Make FactoryGirl faster by caching SQL on frequently used factories
+test_files: 
+- test/fastory_test.rb
+- test/test_helper.rb