to_factory 0.0.3 → 0.1.0

data/lib/to_factory/parsing/syntax.rb

@@ -0,0 +1,86 @@
+module ToFactory
+  module Parsing
+    class Syntax
+      attr_accessor :contents
+
+      def initialize(contents)
+        @contents = contents
+      end
+
+      def multiple_factories?
+        factories_sexp[0] == :block
+      end
+
+      def parse
+        result = {}
+        @klass_inference = KlassInference.new
+
+        parse_multiple do |factory_name, parent_name, ruby|
+          klass = @klass_inference.infer(factory_name, parent_name)
+          result[klass] ||= {}
+          result[klass][factory_name] = ruby
+        end
+
+        result
+      end
+
+      def factories
+        if multiple_factories?
+          factories_sexp[1..-1]
+        else
+          [factories_sexp]
+        end
+      end
+
+      def factories_sexp
+        header? ?  sexp[3] : sexp
+      end
+
+      def parse_multiple(&block)
+        factories.each do |x|
+          yield name_from(x), parent_from(x), to_ruby(x)
+        end
+      end
+
+      def parent_from(x)
+        x[1][-1][-1][-1] rescue name_from(x)
+      end
+
+      def name_from(sexp)
+        sexp[1][3][1]
+      end
+
+      private
+
+      def to_ruby(sexp)
+        ruby2ruby.process sexp.deep_clone
+      end
+
+      def sexp
+        @sexp ||= ruby_parser.process(@contents)
+      end
+
+      def ruby2ruby
+        @ruby2ruby ||= Ruby2Ruby.new
+      end
+
+      def ruby_parser
+        @ruby_parseer ||= RubyParser.new
+      end
+
+      class KlassInference
+        def initialize
+          @mapping = {}
+        end
+
+        def infer(klass, parent_klass=nil)
+          @mapping[klass] ||= klass.to_s.camelize.constantize
+        rescue
+          infer(parent_klass)
+        end
+      end
+
+
+    end
+  end
+end

data/lib/to_factory/version.rb

@@ -1,3 +1,3 @@
 module ToFactory
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/lib/to_factory.rb

@@ -1,2 +1,56 @@
+require "deep_merge"
+
 require "to_factory/version"
-require "to_factory/generator"
+require "to_factory/config"
+require "to_factory/generation/factory"
+require "to_factory/generation/attribute"
+require "to_factory/collation"
+require "to_factory/file_writer"
+require "to_factory/finders/model"
+require "to_factory/finders/factory"
+require "to_factory/definition_group"
+require "to_factory/file_sync"
+require "to_factory/parsing/file"
+
+module ToFactory
+  class MissingActiveRecordInstanceException < Exception;end
+
+  class << self
+    def new_syntax?
+      require "factory_girl"
+      if FactoryGirl::VERSION.to_s[0..0].to_i > 1
+        true
+      else
+        false
+      end
+    rescue NameError, ArgumentError
+      false
+    end
+  end
+end
+
+public
+
+def ToFactory(args=nil)
+  exclusions = if args.is_a?(Hash)
+                 exclusions = Array(args.delete(:exclude) || [])
+                 args = nil if args.keys.length == 0
+                 exclusions
+               else
+                 []
+               end
+
+  meth = ToFactory::FileSync.method(:new)
+  sync = args ? meth.call(args) : meth.call
+
+  sync.perform(exclusions)
+end
+
+if defined?(Rails)
+  unless Rails.respond_to?(:configuration)
+    #FactoryGirl 1.3.x expects this method, but it isn't defined in Rails 2.0.2
+    def Rails.configuration
+      OpenStruct.new
+    end
+  end
+end

data/spec/db/migrate/2_create_projects.rb

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

data/spec/db/migrate/3_create_not_namespaced.rb

@@ -0,0 +1,11 @@
+class CreateNotNamespaced < ActiveRecord::Migration
+  def self.up
+    create_table :not_namespaced_active_record_class_but_long_enough_it_shouldnt_cause_conflicts do |t|
+      t.column :name, :string, :null => false
+    end
+  end
+
+  def self.down
+    drop_table :not_namespaced_active_record_class_but_long_enough_it_shouldnt_cause_conflicts
+  end
+end

data/spec/db/migrate/4_add_birthday_to_users.rb

@@ -0,0 +1,9 @@
+class AddBirthdayToUsers < ActiveRecord::Migration
+  def self.up
+    add_column :users, :birthday, :datetime
+  end
+
+  def self.down
+    remove_column :users, :birthday
+  end
+end

data/spec/example_factories/new_syntax/admin.rb

@@ -0,0 +1,6 @@
+factory(:admin, :parent => :"to_factory/user") do
+  birthday "2014-07-08T15:30Z"
+  email "admin@example.com"
+  name "Admin"
+  some_id 9
+end

data/spec/example_factories/new_syntax/admin_with_header.rb

@@ -0,0 +1,8 @@
+FactoryGirl.define do
+  factory(:admin, :parent => :"to_factory/user") do
+    birthday "2014-07-08T15:30Z"
+    email "admin@example.com"
+    name "Admin"
+    some_id 9
+  end
+end

data/spec/example_factories/new_syntax/project_with_header.rb

@@ -0,0 +1,7 @@
+FactoryGirl.define do
+  factory(:"to_factory/project") do
+    name "My Project"
+    objective "easy testing"
+    some_id 9
+  end
+end

data/spec/example_factories/new_syntax/user.rb

@@ -0,0 +1,6 @@
+factory(:"to_factory/user") do
+  birthday "2014-07-08T15:30Z"
+  email "test@example.com"
+  name "Jeff"
+  some_id 8
+end

data/spec/example_factories/new_syntax/user_admin.rb

@@ -0,0 +1,13 @@
+factory(:"to_factory/user") do
+  birthday "2014-07-08T15:30Z"
+  email "test@example.com"
+  name "Jeff"
+  some_id 8
+end
+
+factory(:admin, :parent => :"to_factory/user") do
+  birthday "2014-07-08T15:30Z"
+  email "admin@example.com"
+  name "Admin"
+  some_id 9
+end

data/spec/example_factories/new_syntax/user_admin_with_header.rb

@@ -0,0 +1,15 @@
+FactoryGirl.define do
+  factory(:"to_factory/user") do
+    birthday "2014-07-08T15:30Z"
+    email "test@example.com"
+    name "Jeff"
+    some_id 8
+  end
+
+  factory(:admin, :parent => :"to_factory/user") do
+    birthday "2014-07-08T15:30Z"
+    email "admin@example.com"
+    name "Admin"
+    some_id 9
+  end
+end

data/spec/example_factories/new_syntax/user_with_header.rb

@@ -0,0 +1,8 @@
+FactoryGirl.define do
+  factory(:"to_factory/user") do
+    birthday "2014-07-08T15:30Z"
+    email "test@example.com"
+    name "Jeff"
+    some_id 8
+  end
+end

data/spec/example_factories/old_syntax/admin.rb

@@ -0,0 +1,6 @@
+Factory.define(:admin, :parent => :"to_factory/user") do |o|
+  o.birthday "2014-07-08T15:30Z"
+  o.email "admin@example.com"
+  o.name "Admin"
+  o.some_id 9
+end

data/spec/example_factories/old_syntax/project_with_header.rb

@@ -0,0 +1,5 @@
+Factory.define(:"to_factory/project") do |o|
+  o.name "My Project"
+  o.objective "easy testing"
+  o.some_id 9
+end

data/spec/example_factories/old_syntax/user.rb

@@ -0,0 +1,6 @@
+Factory.define(:"to_factory/user") do |o|
+  o.birthday "2014-07-08T15:30Z"
+  o.email "test@example.com"
+  o.name "Jeff"
+  o.some_id 8
+end

data/spec/example_factories/old_syntax/user_admin.rb

@@ -0,0 +1,13 @@
+Factory.define(:"to_factory/user") do |o|
+  o.birthday "2014-07-08T15:30Z"
+  o.email "test@example.com"
+  o.name "Jeff"
+  o.some_id 8
+end
+
+Factory.define(:admin, :parent => :"to_factory/user") do |o|
+  o.birthday "2014-07-08T15:30Z"
+  o.email "admin@example.com"
+  o.name "Admin"
+  o.some_id 9
+end

data/spec/example_factories/old_syntax/user_admin_with_header.rb

@@ -0,0 +1,13 @@
+Factory.define(:"to_factory/user") do |o|
+  o.birthday "2014-07-08T15:30Z"
+  o.email "test@example.com"
+  o.name "Jeff"
+  o.some_id 8
+end
+
+Factory.define(:admin, :parent => :"to_factory/user") do |o|
+  o.birthday "2014-07-08T15:30Z"
+  o.email "admin@example.com"
+  o.name "Admin"
+  o.some_id 9
+end

data/spec/example_factories/old_syntax/user_with_header.rb

@@ -0,0 +1,6 @@
+Factory.define(:"to_factory/user") do |o|
+  o.birthday "2014-07-08T15:30Z"
+  o.email "test@example.com"
+  o.name "Jeff"
+  o.some_id 8
+end

data/spec/integration/config_spec.rb

@@ -0,0 +1,19 @@
+describe "ToFactory  Configuration" do
+  before do
+    ToFactory.reset_config!
+  end
+
+  it do
+    expect(ToFactory.factories).to eq "./spec/factories"
+    ToFactory.factories = "factories dir"
+
+    expect(ToFactory.factories).to eq "factories dir"
+  end
+
+  it do
+    expect(ToFactory.models).to eq "./app/models"
+    ToFactory.models = "models dir"
+
+    expect(ToFactory.models).to eq "models dir"
+  end
+end

data/spec/integration/file_sync_spec.rb

@@ -0,0 +1,77 @@
+describe "FileSync" do
+  let(:user) { create_user!  }
+  let(:admin) { create_admin!  }
+  let(:project) { create_project!  }
+  let(:version) { ToFactory.new_syntax? ? "new" : "old"}
+  let(:expected_user_file)             { File.read("./spec/example_factories/#{version}_syntax/user.rb") }
+  let(:expected_user_with_header_file) { File.read("./spec/example_factories/#{version}_syntax/user_with_header.rb") }
+  let(:expected_admin_file)            { File.read("./spec/example_factories/#{version}_syntax/admin.rb") }
+  let(:user_with_header)               { File.read("./spec/example_factories/#{version}_syntax/user_with_header.rb") }
+  let(:user_admin_with_header)         { File.read("./spec/example_factories/#{version}_syntax/user_admin_with_header.rb") }
+
+
+  before do
+    FileUtils.rm_rf "./tmp/factories"
+  end
+
+  def user_file
+    File.read("./tmp/factories/to_factory/user.rb") rescue nil
+  end
+
+  def project_file
+    File.read("./tmp/factories/to_factory/project.rb") rescue nil
+  end
+
+
+  context "with no arguments" do
+    before do
+      user
+      admin
+    end
+
+    it "finds the first existing instance" do
+      sync = ToFactory::FileSync.new
+      sync.perform
+
+      expect(user_file ).to match_sexp expected_user_with_header_file
+    end
+  end
+
+  context "with an instance" do
+    it "writes that instance" do
+      sync = ToFactory::FileSync.new(user)
+      sync.perform
+
+      expect(user_file   ).to match_sexp user_with_header
+      expect(project_file).to eq nil
+    end
+  end
+
+  context "with a pre-existing file" do
+    let(:sync) { ToFactory::FileSync.new(user) }
+    before do
+      sync.perform
+      expect(user_file).to match_sexp user_with_header
+    end
+
+    it "raises an error" do
+      expect(lambda{ sync.perform }).to raise_error ToFactory::AlreadyExists
+    end
+
+    context "with a named factory" do
+      it do
+        sync = ToFactory::FileSync.new({:admin => admin})
+        sync.perform
+
+        parser = ToFactory::Parsing::File.new(user_file)
+        result = parser.parse[ToFactory::User]
+        expect(result[:admin]).to match_sexp expected_admin_file
+        expect(result[:"to_factory/user"]).to match_sexp expected_user_file
+
+        expect(lambda{
+          sync.perform
+        }).to raise_error ToFactory::AlreadyExists
+      end
+    end
+  end
+end

data/spec/integration/file_writer_spec.rb

@@ -0,0 +1,16 @@
+describe ToFactory::FileWriter do
+  let(:fw) { ToFactory::FileWriter.new }
+  let(:expected)    { File.read "./spec/example_factories/#{version}_syntax/user_with_header.rb"}
+  let(:user_file_contents)    { File.read "./tmp/factories/to_factory/user.rb"}
+  let!(:user) { create_user!  }
+  let!(:admin) { create_admin!  }
+  it do
+    fs = ToFactory::FileSync.new
+    definitions = fs.new_definitions
+    #sanity check generation isn't broken
+    expect(definitions.keys).to eq [ToFactory::User]
+
+    fw.write definitions
+    expect(user_file_contents).to match_sexp expected
+  end
+end

data/spec/integration/generate_class_method_spec.rb

@@ -0,0 +1,107 @@
+describe ToFactory do
+  let!(:user)    { create_user! }
+  let!(:project) { create_project!}
+
+  before { FileUtils.rm_rf "./tmp/factories" }
+
+  def user_file
+    File.read("./tmp/factories/to_factory/user.rb") rescue nil
+  end
+
+  def project_file
+    File.read("./tmp/factories/to_factory/project.rb") rescue nil
+  end
+
+  let(:expected_user_file) { File.read "./spec/example_factories/#{version}_syntax/user_with_header.rb"}
+  let(:expected_project_file) { File.read "./spec/example_factories/#{version}_syntax/project_with_header.rb"}
+
+  describe "Object#ToFactory" do
+    it "generates all factories" do
+      ToFactory()
+      expect(user_file)   .to match_sexp expected_user_file
+      expect(project_file).to match_sexp expected_project_file
+    end
+
+    def user_file_includes(content)
+      expect(user_file).to include content
+    end
+
+    context "excluding classes" do
+      before do
+        user
+        project
+      end
+
+      it "ignores specified classes" do
+        ToFactory(:exclude => ToFactory::User)
+        expect(user_file).to be_nil
+        expect(project_file).to be_present
+      end
+
+      it "ignores specified classes - sanity check" do
+        ToFactory(:exclude => ToFactory::Project)
+        expect(user_file).to be_present
+        expect(project_file).to be_nil
+      end
+
+      it "doesn't auto generate any if :all is specified" do
+        ToFactory(:exclude => :all)
+        expect(user_file).to be_nil
+        expect(project_file).to be_nil
+
+        #sanity check
+        ToFactory()
+        expect(user_file).to be_present
+        expect(project_file).to be_present
+      end
+    end
+
+    context "with no existing file" do
+      it "creates the file" do
+        expect(user_file).to be_nil
+        ToFactory(user)
+        expect(user_file).to be_present
+      end
+
+      context "with single ActiveRecord::Base instance argument" do
+        it "creates the file" do
+          expect(user_file).to be_nil
+          ToFactory(user)
+          expect(user_file).to be_present
+        end
+      end
+    end
+
+    context "with an existing file" do
+      before do
+        expect(user_file).to be_nil
+        ToFactory(user)
+        expect(user_file).to be_present
+      end
+
+      context "with a name for the factory" do
+        it "appends to the file" do
+          if ToFactory.new_syntax?
+            user_file_includes('factory(:"to_factory/user"')
+          else
+            user_file_includes('Factory.define(:"to_factory/user"')
+          end
+
+          ToFactory(:specific_user => user)
+          if ToFactory.new_syntax?
+            user_file_includes('factory(:specific_user, :parent => :"to_factory/user"')
+          else
+            user_file_includes('Factory.define(:specific_user, :parent => :"to_factory/user"')
+          end
+
+
+        end
+      end
+
+      it "without a name" do
+        expect(lambda{ToFactory(user)}).
+               to raise_error ToFactory::AlreadyExists
+      end
+    end
+  end
+end

data/spec/integration/lint_spec.rb

@@ -0,0 +1,16 @@
+context "full integration" do
+  let(:user) do
+    ToFactory::User.create :name => "Jeff", :email => "test@example.com", :some_id => 8, :birthday => Time.now
+  end
+
+  it "#to_factory linting the output" do
+    if ToFactory.new_syntax?
+      ToFactory(user)
+
+      load "./tmp/factories/to_factory/user.rb"
+
+      FactoryGirl.lint
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -1,17 +1,93 @@
-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'
+begin
+  require "codeclimate-test-reporter"
+  CodeClimate::TestReporter.start
+rescue LoadError
+  #ignore on ruby 1.8.x
 end
 
-Spork.each_run do
-  Dir['lib/**/*.rb'].each{|f| require f unless f=="lib/to_factory/version.rb"}
+require 'active_record'
+require 'fileutils'
+require 'active_support/core_ext/string'
+require 'active_support/core_ext/hash'
+require "sqlite3"
+require "database_cleaner"
+
+begin
+  require "pry-byebug"
+rescue LoadError
+  begin
+    require "ruby-debug"
+  rescue LoadError
+    $stderr.puts "No debugger available for #{RUBY_VERSION}"
+  end
+end
+
+require "to_factory"
+
+require "./spec/support/models/user"
+require "./spec/support/models/project"
+require "./spec/support/terse_expect_syntax"
+require "./spec/support/match_sexp"
+
+module ToFactory::DataCreation
+  def create_all!
+    create_user!
+    create_admin!
+  end
+
+  def create_project!
+    ToFactory::Project.create({:name => "My Project", :objective => "easy testing", :some_id => 9 })
+  end
+
+  def birthday
+    Time.find_zone("UTC").parse("2014-07-08T15:30Z")
+  end
+
+  def create_user!
+    ToFactory::User.create :name => "Jeff", :email => "test@example.com", :some_id => 8, :birthday => birthday
+  end
+
+  def create_admin!
+    ToFactory::User.create :name => "Admin", :email => "admin@example.com", :some_id => 9, :birthday => birthday
+  end
+end
+
+module ToFactory::SpecSyntaxHelpers
+  def version
+    ToFactory.new_syntax? ? "new" : "old"
+  end
+end
+
+RSpec.configure do |config|
+  config.include TerseExpectSyntax
+  config.include ToFactory::DataCreation
+  config.include ToFactory::SpecSyntaxHelpers
+
+  config.before :suite do
+    ActiveRecord::Base.tap do |base|
+      config = {:adapter => "sqlite3", :database => "spec/db/test.sqlite3"}
+      base.configurations = {:test => config}.with_indifferent_access
+      base.establish_connection :test
+    end
+
+    DatabaseCleaner.strategy = :truncation
+    DatabaseCleaner.clean_with(:truncation)
+    DatabaseCleaner.start
+  end
+
+  config.before(:each) do
+    FileUtils.rm_rf "tmp/factories"
+    DatabaseCleaner.clean
+    ToFactory.reset_config!
+    ToFactory.models = "./spec/support/models"
+    ToFactory.factories = "./tmp/factories"
+  end
+
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
 end