factory_faster 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0ee96ae3acadba8720236440c575e36320ee3a99
+  data.tar.gz: cbb6cd8ed4193db979c0c1e21087e9ebe960595e
+SHA512:
+  metadata.gz: 7ae8faff33abad9f4c0c64a7dfb9ff40fa8aeec4c8a4bb3e92e84967ea6c9171dacc6cd0106761f148a97b452a92ad902b2674a41ed6756605fd422ab2f26584
+  data.tar.gz: 6814adf53b72789ff20af010d3a2e5a9afeab88cc789bfb5313ec99b6363e9d4b0272aa54560e194de9c41f6480a0d2b0dd59f8b5e5f0fda6c27707dd0947be3

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p353

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+0.0.2 - Apr 8 2014
+* Fixed batch processor
+* External release
+
+0.0.1 - Apr 7 2014
+* Initial internal release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in factory_faster.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Tom Copeland
+
+MIT License
+
+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.md

@@ -0,0 +1,62 @@
+# FactoryFaster
+
+FactoryFaster optimizes your Rails app's FactoryGirl usage by replacing `create` with `build` where it's safe to do so.
+
+## Installation
+
+Add this line to your application's `Gemfile` in the 'development' group:
+
+    gem 'factory_faster'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install factory_faster
+
+## Usage
+
+Process just one file with:
+
+    bundle exec script/rails runner "FactoryFaster::Batch.new('test/unit/foo_test.rb').process"
+
+Or if you want to include the gem but not `require` it in your `Gemfile`:
+
+    bundle exec script/rails runner "require 'factory_faster' ; FactoryFaster::Batch.new('test/unit/foo_test.rb').process"
+
+Or use a glob to process lots of files:
+
+    bundle exec script/rails runner "FactoryFaster::Batch.new('test/unit/*.rb').process"
+
+The output will be something like this:
+
+    foo> $ bundle exec script/rails runner "FactoryFaster::Batch.new('test/unit/foo_test.rb').process"
+    Processing test/unit/foo_test.rb
+    Checking target 1 of 2 on line 42
+    Replacing create with build
+    Running test
+    Passed!
+    Checking target 2 of 2 on line 207
+    Replacing create with build
+    Running test
+    Passed!
+    2 of 2 could be replaced, so replacing those
+
+## BUGS / TODO
+
+Adding a new test to a file invalidates all the skip line numbers after the addition.  Subsequent runs then get both the old and the new line numbers, so gradually more and more lines get skipped.
+
+FactoryFaster will miss the case there a test case has multiple calls to `Factory.create` and if more than one of then has to be switched to `Factory.build` in order to trigger an error.
+
+FactoryFaster depends on `sed` to replace the code.  It could use plain old Ruby instead.
+
+FactoryFaster doesn't skip commented out lines.
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/factory_faster/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+task :default => :test
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end

data/factory_faster.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'factory_faster/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "factory_faster"
+  spec.version       = FactoryFaster::VERSION
+  spec.authors       = ["Tom Copeland"]
+  spec.email         = ["tom.copeland@livingsocial.com"]
+  spec.summary       = %q{FactoryFaster makes your FactoryGirl tests faster.}
+  spec.description   = %q{FactoryFaster makes your FactoryGirl tests faster.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "mocha", "~> 0.14.0"
+  spec.add_development_dependency "shoulda"
+end

data/lib/factory_faster.rb

@@ -0,0 +1,5 @@
+require 'factory_faster/version'
+require 'factory_faster/data_store'
+require 'factory_faster/target'
+require 'factory_faster/batch'
+require 'factory_faster/faster'

data/lib/factory_faster/batch.rb

@@ -0,0 +1,19 @@
+module FactoryFaster
+  
+  class Batch
+
+    attr_reader :glob
+
+    def initialize(glob)
+      @glob = glob
+    end
+
+    def run
+      Dir.glob(glob).each do |filename|
+        Faster.new(filename).process
+      end
+    end
+    
+  end
+
+end

data/lib/factory_faster/data_store.rb

@@ -0,0 +1,58 @@
+module FactoryFaster
+
+  #
+  # Each row looks like this:
+  # filename|md5 hash|lines to skip
+  # test/unit/foo_test.rb|abcdefabcde|5,12,19,20
+  #
+  class DataStore
+
+    attr_reader :store_file, :records
+
+    def initialize(filename)
+      @store_file = filename
+      load
+    end
+
+    def set(filename, skips)
+      @records[filename] = [signature_for(filename),skips]
+      store
+    end
+
+    def skips_for(filename)
+      (!@records[filename].nil? && !@records[filename][1].nil?) ? @records[filename][1] : []
+    end
+
+    def unchanged?(filename)
+      !@records[filename].nil? && @records[filename][0] == signature_for(filename)
+    end
+
+    private
+
+    def signature_for(filename)
+      Digest::MD5.hexdigest(File.read(filename))
+    end
+
+    def store
+      File.open(store_file, "w") do |f|
+        @records.each do |filename, data|
+          f.syswrite("#{filename}|#{data[0]}|#{data[1].join(',')}\n")
+        end
+      end
+    end
+
+    # in memory data structure is
+    # test/unit/foo_test.rb => [abcdefabcde, [5,12,19.20]]
+    def load
+      @records = {}
+      File.readlines(store_file).each do |line|
+        fields = line.split("|")
+        filename = fields[0]
+        signature = fields[1]
+        skips = !fields[2].nil? ? fields[2].split(',').map(&:to_i) : []
+        @records[filename] = [signature, skips]
+      end unless !File.exists?(store_file)
+    end
+  end
+
+end

data/lib/factory_faster/faster.rb

@@ -0,0 +1,91 @@
+module FactoryFaster
+
+  class Faster
+
+    attr_reader :filename, :replacement_targets, :data_store
+
+    def initialize(filename)
+      @filename = filename
+      data_store_file = if defined?(Rails)
+        "#{Rails.root}/tmp/factory_faster.txt"
+      else
+        "tmp/factory_faster.txt"
+      end
+      @data_store = DataStore.new(data_store_file)
+      @replacement_targets = load_replacement_targets
+    end
+
+    def process
+      puts "Processing #{filename}"
+      if data_store.unchanged?(filename)
+        puts "Skipping since it hasn't changed since it was last checked"
+        return
+      end
+      if fixable_replacement_targets.empty?
+        puts "Skipping since there are no targets to fix"
+        return
+      end
+      initial_fixable_targets_count = fixable_replacement_targets.size
+      fixable_replacement_targets.select {|t| !t.skip? }.each_with_index do |target, idx|
+        puts "Checking target #{idx+1} of #{initial_fixable_targets_count} on line #{target.line_number}"
+        try_to_fix(target)
+      end
+      passed = fixable_replacement_targets.select {|t| t.passed? }
+      if passed.any?
+        puts "#{passed.size} of #{initial_fixable_targets_count} could be replaced, so replacing those"
+        passed.each do |target|
+          replace_create_with_build(target.line_number)
+        end
+      end
+      data_store.set(filename, replacement_targets.select {|t| t.skip? }.map(&:line_number))
+    end
+
+    def try_to_fix(target)
+      puts "Replacing create with build"
+      replace_create_with_build(target.line_number)
+      puts "Running test"
+      if test_passes?
+        puts "Passed!"
+        target.passed = true
+      else
+        puts "Error, so marking as a skip"
+        target.skip = true
+      end
+      revert_file
+    end
+
+    def revert_file
+      `git checkout -- #{filename}`
+    end
+
+    def fixable_replacement_targets
+      replacement_targets.select {|t| !t.skip? }
+    end
+
+    def test_passes?
+      run_test
+      $?.exitstatus == 0
+    end
+
+    def run_test
+      cmd = "bundle exec ruby #{filename} 2>&1"
+      `#{cmd}`
+    end
+
+    def replace_create_with_build(line_number)
+      sed_line_number = line_number + 1
+      cmd = "sed -i '' '#{sed_line_number}s/FactoryGirl.create/FactoryGirl.build/' #{filename}"
+      `#{cmd}`
+    end
+
+    def load_replacement_targets
+      res = []
+      File.readlines(filename).each_with_index do |line, idx|
+        next unless line.match /FactoryGirl.create/
+        res << Target.new(idx, data_store.skips_for(filename).include?(idx))
+      end
+      res
+    end
+  end
+  
+end

data/lib/factory_faster/target.rb

@@ -0,0 +1,22 @@
+module FactoryFaster
+  class Target
+
+    attr_accessor :line_number, :passed, :skip
+
+    def initialize(line_number, skip=false)
+      @line_number = line_number
+      @passed = false
+      @skip = skip
+    end
+
+    def skip?
+      skip
+    end
+
+    def passed?
+      passed
+    end
+
+  end
+
+end

data/lib/factory_faster/version.rb

@@ -0,0 +1,3 @@
+module FactoryFaster
+  VERSION = "0.0.2"
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha/setup'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+Mocha::Configuration.prevent(:stubbing_non_existent_method)
+
+require 'factory_faster'

data/test/unit/data_store_test.rb

@@ -0,0 +1,38 @@
+require File.expand_path("../test_helper", File.dirname(__FILE__))
+
+class DataStoreTest < Test::Unit::TestCase
+
+  should "load existing data on initialization" do
+    setup_sample_file
+    store = FactoryFaster::DataStore.new(sample_filename)
+    assert_equal 2, store.records.size
+  end
+  
+  should "deserialize skips" do
+    setup_sample_file
+    store = FactoryFaster::DataStore.new(sample_filename)
+    assert_equal [5,12,19,20], store.skips_for("test/unit/foo_test.rb")
+  end
+  
+  should "be able to set skips" do
+    setup_sample_file
+    File.expects(:read).returns("foo") # MD5 is acbd18db4cc2f85cedef654fccc4a4d8
+    store = FactoryFaster::DataStore.new(sample_filename)
+    store.set("test/unit/bar_test.rb", [1,2])
+    assert_equal [1,2], store.skips_for("test/unit/bar_test.rb")
+  end
+
+  private
+
+  def setup_sample_file
+    File.open(sample_filename, "w") do |f|
+      f.syswrite("test/unit/foo_test.rb|abcdefabcde|5,12,19,20\n")
+      f.syswrite("test/unit/bar_test.rb|abcde|\n")
+    end
+  end
+
+  def sample_filename
+    "tmp/factory_faster.txt"
+  end
+
+end

data/test/unit/target_test.rb

@@ -0,0 +1,13 @@
+require File.expand_path("../test_helper", File.dirname(__FILE__))
+
+class TargetTest < Test::Unit::TestCase
+
+  should "default passed? to false" do
+    assert !FactoryFaster::Target.new("foo_test.rb").passed?
+  end
+
+  should "allow skip? to be set on initialization" do
+    assert FactoryFaster::Target.new("foo_test.rb", true).skip?
+  end
+
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: factory_faster
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Tom Copeland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: FactoryFaster makes your FactoryGirl tests faster.
+email:
+- tom.copeland@livingsocial.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- factory_faster.gemspec
+- lib/factory_faster.rb
+- lib/factory_faster/batch.rb
+- lib/factory_faster/data_store.rb
+- lib/factory_faster/faster.rb
+- lib/factory_faster/target.rb
+- lib/factory_faster/version.rb
+- test/test_helper.rb
+- test/unit/data_store_test.rb
+- test/unit/target_test.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: FactoryFaster makes your FactoryGirl tests faster.
+test_files:
+- test/test_helper.rb
+- test/unit/data_store_test.rb
+- test/unit/target_test.rb