factory_girl_upgrader 0.1.0

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    factory_girl_upgrader (0.1.0)
+      activesupport (~> 3.0.10)
+      factory_girl (~> 2.0)
+      i18n (~> 0.6.0)
+      ruby_parser (~> 2.3.1)
+      ruby_scribe (~> 0.1.0)
+      ruby_transform (~> 0.1.0)
+      thor (~> 0.13)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.10)
+    diff-lcs (1.1.3)
+    factory_girl (2.1.0)
+    i18n (0.6.0)
+    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_parser (2.3.1)
+      sexp_processor (~> 3.0)
+    ruby_scribe (0.1.2)
+      activesupport (~> 3.0.10)
+      i18n (~> 0.6.0)
+      ruby_parser (~> 2.3.1)
+      thor (~> 0.13)
+    ruby_transform (0.1.1)
+      activesupport (~> 3.0.10)
+      i18n (~> 0.6.0)
+      ruby_parser (~> 2.3.1)
+      ruby_scribe (~> 0.1.0)
+      thor (~> 0.13)
+    sexp_processor (3.0.7)
+    thor (0.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  factory_girl_upgrader!
+  rspec (~> 2.0)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Ben Hughes
+
+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,62 @@
+= Factory Girl Upgrader
+
+Uses ruby_parser and ruby_scribe to dynamically convert factory_girl factories in the V1 DSL into the V2 DSL.
+
+== In-Progress
+
+NOTE: This gem is not essentially unusable and is being continually worked on - more of a proof of concept for now.
+
+== Command-Line Usage
+
+The gem comes with a thor task that you can use to print out a converted version of any Ruby file containing factory_girl V1 code:
+
+  $ factory_girl_upgrader cat test_project.rb
+
+== API Usage
+
+This is built on the tree-walking base class RubyTransform::Transformer from the +ruby_transform+ project. 
+The principal transform, which is a composite of other more granular transforms, is +RSpecify::Transformer+. 
+Here's how it can be used in conjunction with +ruby_parser+:
+
+  sexp = RubyParser.new.parse(File.read(path))
+  sexp = FactoryGirl::Upgrader::Transformer.new.transform(sexp)
+
+  emitter = RubyScribe::Emitter.new
+  emitter.methods_without_parenthesis += ["factory"]
+  emitter.emit(sexp)
+
+== Supported factory_girl V1 features:
+
+* Simple attribute setting
+* Sequences with a block
+* Associations (without options)
+
+NOTE: Indeed, this is only the basics. This will be expanded in the future to be a more comprehensive set of transformations.
+
+== Limitations
+
+To make this more DSL-friendly without parentheses requires expansion of the emitter configuration on ruby_scribe 
+(we need to be able to give ruby_scribe AST node hints on parentheses and block style).
+
+== Example:
+
+=== Original (factory_girl V1):
+
+  Factory.define(:product) do |f|
+    f.association :category
+    f.sequence(:name) {|n| "Product #{n}" }
+    f.price 19.95
+  end
+
+
+=== Transformed (factory_girl V2):
+
+  FactoryGirl.define do 
+    factory :product do
+      category
+      price(19.95)
+      sequence(:name) do |n| 
+        "Product #{n}"
+      end
+    end
+  end

data/lib/factory_girl/upgrader/runner.rb

@@ -0,0 +1,26 @@
+require "thor"
+require "factory_girl/upgrader"
+
+module FactoryGirl
+  module Upgrader
+    class Runner < Thor
+      desc :cat, "Takes a single ruby file, parses it, and outputs the scribed version."
+      def cat(path)
+        sexp = RubyParser.new.parse(File.read(path))
+        sexp = FactoryGirl::Upgrader::Transformer.new.transform(sexp)
+        RubyScribe::Emitter.new.tap do |emitter|
+          emitter.methods_without_parenthesis += ["factory"]
+          puts emitter.emit(sexp)
+        end
+      end
+      
+      protected
+    
+      def expand_paths(paths = [])
+        paths.map do |path|
+          [path] + Dir[path + "**/*.rb"]
+        end.flatten.uniq.reject {|f| File.directory?(f) }
+      end
+    end
+  end
+end

data/lib/factory_girl/upgrader/transformer.rb

@@ -0,0 +1,88 @@
+module FactoryGirl
+  module Upgrader
+    class Transformer < RubyTransform::Transformer
+      def transform(e)
+        super(transform_factories(e))
+      end
+      
+      def transform_factories(e)
+        if matches_define_factory?(e)
+          transform_factory_definition(e)
+        else
+          e
+        end
+      end
+      
+      def matches_define_factory?(e)
+        e.is_a?(Sexp) && e.kind == :iter &&  # We're in a block
+          e.body.first.is_a?(Sexp) && e.body.first.kind == :call && # What's calling
+            e.body.first.body.first == s(:const, :Factory) && e.body.first.body.second == :define &&  # Factory.define
+            e.body.second.try(:kind) == :lasgn && # and we're passing a block variable for the factory
+            e.body.third.try(:kind) == :block # and we have a block
+      end
+      
+      def transform_factory_definition(e)
+        factory_name = e.body.first.body.third.body.first.body.first  # Yeah... we really need an OO AST model.
+        local_variable = e.body.second.body.first
+        block = e.body.third
+        
+        s(:iter,
+          s(:call, s(:const, :FactoryGirl), :define, s(:arglist)), nil,
+          s(:iter,
+            s(:call, nil, :factory, s(:arglist, s(:lit, factory_name.to_sym))), nil,
+            transform_factory_definition_block(block, local_variable)
+          )
+        )
+      end
+      
+      def transform_factory_definition_block(block, local_variable)
+        Sexp.new(*([:block] + block.body.map {|e|
+          case
+          when matches_factory_association?(e, local_variable)
+            transform_factory_association(e)
+          when matches_factory_sequence?(e, local_variable)
+            transform_factory_sequence(e)
+          when matches_factory_attribute?(e, local_variable)
+            transform_factory_attribute(e)
+          else
+            e
+          end
+        }))
+      end
+      
+      # Factory Attributes:
+      def matches_factory_attribute?(e, local_variable)
+        e.is_a?(Sexp) && e.kind == :call && e.body.first.kind == :lvar && e.body.first.body.first == local_variable.to_sym
+      end
+      
+      def transform_factory_attribute(e)
+        e.dup.tap do |sexp|
+          sexp[1] = nil
+        end
+      end
+      
+      # Factory Sequences:
+      def matches_factory_sequence?(e, local_variable)
+        e.is_a?(Sexp) && e.kind == :iter && matches_factory_attribute?(e.body.first, local_variable)
+      end
+      
+      def transform_factory_sequence(e)
+        e.dup.tap do |sexp|
+          sexp[1] = transform_factory_attribute(sexp[1])
+        end
+      end
+      
+      # Factory Associations:
+      def matches_factory_association?(e, local_variable)
+        e.is_a?(Sexp) && e.kind == :call && e.body.first.kind == :lvar && e.body.first.body.first == local_variable.to_sym &&
+          e.body.second == :association
+      end
+      
+      def transform_factory_association(e)
+        association_name = e.body.third.body.first.body.first
+        
+        s(:call, nil, association_name, s(:arglist))
+      end
+    end
+  end
+end

data/lib/factory_girl/upgrader/version.rb

@@ -0,0 +1,5 @@
+module FactoryGirl
+  module Upgrader
+    VERSION = "0.1.0"
+  end
+end

data/lib/factory_girl/upgrader.rb

@@ -0,0 +1,11 @@
+require "rubygems"
+require "factory_girl"
+require "ruby_parser"
+require "ruby_scribe"
+require "ruby_transform"
+
+require "factory_girl/upgrader/transformer"
+
+Dir[File.join(File.dirname(__FILE__), "upgrader/transformers/**/*.rb")].each do |file|
+  require file
+end

data/spec/factory_girl/upgrader/transformer_spec.rb

@@ -0,0 +1,28 @@
+require "spec_helper"
+
+describe FactoryGirl::Upgrader::Transformer do
+  
+  describe "old factory_girl V1 factory" do
+    subject { '
+      Factory.define(:product) do |f|
+        f.association :category
+        f.price 19.95
+        f.sequence(:name) {|n| "Product #{n}" }
+      end
+    ' }
+    
+    it { should transform_to("new factory_girl V2 factory", '
+      FactoryGirl.define do
+        factory(:product) do
+          category
+          price(19.95)
+
+          sequence(:name) do |n|
+            "Product #{n}"
+          end
+        end
+      end
+    ') }
+  end
+  
+end

data/spec/matchers/should_transform_to.rb

@@ -0,0 +1,26 @@
+RSpec::Matchers.define :transform_to do |desc, expected|
+  match do |actual|
+    actual_as_sexp = actual.is_a?(String) ? RubyParser.new.parse(actual) : actual
+    expected_as_sexp = expected.is_a?(String) ? RubyParser.new.parse(expected) : expected
+    
+    transformer = described_class.is_a?(Class) ? described_class.new : described_class
+    @transformed = transformer.transform(actual_as_sexp)
+    @transformed == expected_as_sexp
+  end
+  
+  failure_message_for_should do |actual|
+    "expected that:\n\n#{RubyParser.new.parse(actual)}\n\nwould transform to:\n\n#{RubyParser.new.parse(expected)}\n\nbut instead was:\n\n#{@transformed}\n\n#{transformed_as_ruby}"
+  end
+
+  failure_message_for_should_not do |actual|
+    "expected that:\n\n#{RubyParser.new.parse(actual)}\n\nwould not transform to:\n\n#{RubyParser.new.parse(expected)}\n\nbut instead was:\n\n#{@transformed}\n\n#{transformed_as_ruby}"
+  end
+  
+  description do
+    "transform with to #{desc}"
+  end
+  
+  def transformed_as_ruby
+    RubyScribe::Emitter.new.emit(@transformed) rescue nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$:.unshift(File.join(File.dirname(__FILE__), "../lib"))
+
+require "rubygems"
+require "rspec"
+require "factory_girl/upgrader"
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/matchers/**/*.rb"].each {|f| require f}
+

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: factory_girl_upgrader
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Ben Hughes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-11 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &70286276079920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70286276079920
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70286276078840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.10
+  type: :runtime
+  prerelease: false
+  version_requirements: *70286276078840
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &70286276078100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70286276078100
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: &70286276077420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70286276077420
+- !ruby/object:Gem::Dependency
+  name: ruby_parser
+  requirement: &70286276076940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70286276076940
+- !ruby/object:Gem::Dependency
+  name: ruby_scribe
+  requirement: &70286276076340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70286276076340
+- !ruby/object:Gem::Dependency
+  name: ruby_transform
+  requirement: &70286276075560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70286276075560
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70286276074860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: *70286276074860
+description: Uses ruby_parser and ruby_scribe to dynamically convert factory_girl
+  factories in the V1 DSL into the V2 DSL.
+email: ben@railsgarden.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/factory_girl/upgrader/runner.rb
+- lib/factory_girl/upgrader/transformer.rb
+- lib/factory_girl/upgrader/version.rb
+- lib/factory_girl/upgrader.rb
+- spec/factory_girl/upgrader/transformer_spec.rb
+- spec/matchers/should_transform_to.rb
+- spec/spec_helper.rb
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+homepage: http://github.com/rubiety/factory_girl_upgrader
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.4
+requirements: []
+rubyforge_project: factory_girl_upgrader
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Converts factory_girl V1 DSL factories to factory_girl V2 DSL.
+test_files: []