to_factory 0.2.0 → 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b7199b7f56596066bd61469c11ed611c8559011
+  data.tar.gz: 9799646595d3bb9835d61cceffde7514334bfc9a
+SHA512:
+  metadata.gz: eb276d7e60f92af6de9fb7a6c6fa0883cdffbd43d585141d359bb64b6e4539936d7fe40545453026419ccfa513a72db5804eecbe80ffd75f42d886d2f7c61e1c
+  data.tar.gz: 9345ae024ec70089a05d6430e1039691bbfad6eb43833525e8bb1ed4d7ba9054560a5d15b780617f4ede28efb51bc88c3e770250a24883ecc435563f05efc804

data/README.md

@@ -11,10 +11,13 @@ ToFactory :wrench:
 
 Easily add factories with valid data for an existing project.
 
+If you find yourself retro-fitting tests this gem will save you some of the legwork.
+
 * auto-generate all factories
 * adhoc generate from existing records
 * unintrusively update factory files in place
-* Parses and writes both new `FactoryGirl`, syntax or older `Factory.define` syntax
+* display factory definition for a record
+* parse and write `FactoryGirl` syntax or older `Factory.define` syntax
 
 Tested against Ruby 1.8.7, 1.9.2, 1.9.3, 2.0.0,  2.1.x, 2.2.0
 
@@ -63,11 +66,6 @@ ToFactory(exclude: [User, Project])
 #Use Adhoc instances from the console
 ToFactory User.last
 
-#List defined factory names
-ToFactory.definitions
-#=> [:user, :admin, :project]
-
-
 #writes to spec/factories/user.rb
 FactoryGirl.define
   factory(:user) do |u|
@@ -76,6 +74,16 @@ FactoryGirl.define
   end
 end
 
+#List defined factory names
+ToFactory.definitions
+#=> [:user, :admin, :project]
+
+#Display definition from record
+ToFactory.definition_for @user
+
+#Display existing definition from name
+ToFactory.definition_for :admin
+
 #doesn't overwrite existing factories
 ToFactory User.last
 #Exception =>

data/lib/to_factory/collation.rb

@@ -16,8 +16,8 @@ module ToFactory
     end
 
     def organize
-      representations.group_by(&:klass).inject({}) do |o, (klass,r)|
-        o[klass] = r.sort_by(&:hierarchy_order)
+      representations.group_by{|i| i.klass.name.underscore}.inject({}) do |o, (klass_name,r)|
+        o[klass_name] = r.sort_by(&:hierarchy_order)
         o
       end
     end
@@ -54,7 +54,7 @@ module ToFactory
     end
 
    def raise_already_exists!(keys)
-      raise ToFactory::AlreadyExists.new "an item for each of the following keys #{keys} already exists"
+     raise ToFactory::AlreadyExists.new "an item for each of the following keys #{keys.inspect} already exists"
     end
   end
 end

data/lib/to_factory/file_writer.rb

@@ -5,8 +5,8 @@ module ToFactory
     end
 
     def write(definitions)
-      definitions.each do |klass, representations|
-        write_to(name_from klass) do
+      definitions.each do |klass_name, representations|
+        write_to(klass_name) do
           wrap_factories(representations.map(&:definition))
         end
       end
@@ -14,10 +14,6 @@ module ToFactory
 
     private
 
-    def name_from(klass)
-      klass.name.underscore.gsub /^"|"$/, ""
-    end
-
     def write_to(name)
       mkdir(name)
 
@@ -35,9 +31,9 @@ module ToFactory
     end
 
     def modern_header(definitions)
-      out = "FactoryGirl.define do\n"
-      out << definitions.join("\n")
-      out << "\nend\n"
+      out =  "FactoryGirl.define do\n"
+      out << definitions.join("\n\n")
+      out << "end"
     end
 
     def mkdir(name)

data/lib/to_factory/generation/attribute.rb

@@ -26,8 +26,6 @@ module ToFactory
         formatted
       end
 
-      private
-
       def format(value, nested)
         case value
         when Time, DateTime
@@ -37,12 +35,30 @@ module ToFactory
         when Hash
           inspect_hash(value, nested)
         when Array
-          value.map{|v| inspect_value(v)}
+          inspect_array(value, nested)
+        when String
+          validate_parseable!(value).inspect
         else
           value.inspect
         end
       end
 
+      private
+
+      def validate_parseable!(value)
+        return value if parse(value)
+
+        "ToFactory: RubyParser exception parsing this attribute after factory generation"
+      end
+
+      def parse(value)
+        @parser ||= RubyParser.new
+        @parser.parse(value)
+        true
+      rescue
+        false
+      end
+
       def inspect_time(value)
         time = in_utc(value).strftime("%Y-%m-%dT%H:%M%Z").inspect
         time.gsub(/UTC"$/, "Z\"").gsub(/GMT"$/, "Z\"")
@@ -60,6 +76,11 @@ module ToFactory
         end
       end
 
+      def inspect_array(value, nested)
+        values = value.map{|v| format(v, nested)}.join(", ")
+        "[#{values}]"
+      end
+
       def key_value_pair(key, value)
         formatted_key = inspect_value(key, true)
         formatted_value = inspect_value(value.fetch(key), true)

data/lib/to_factory/generation/factory.rb

@@ -19,20 +19,12 @@ module ToFactory
 
       def header(&block)
         if ToFactory.new_syntax?
-          modern_header &block
+          generic_header("  factory", "", "  end", &block)
         else
-          header_factory_girl_1 &block
+          generic_header("Factory.define", " |o|", "end", &block)
         end
       end
 
-      def modern_header(&block)
-        generic_header("factory", "", &block)
-      end
-
-      def header_factory_girl_1(&block)
-        generic_header("Factory.define", " |o|", &block)
-      end
-
       def factory_attribute(attr, value)
         Attribute.new(attr, value).to_s
       end
@@ -49,10 +41,10 @@ module ToFactory
         @representation.parent_name
       end
 
-      def generic_header(factory_start, block_arg, &block)
-        out =  "  #{factory_start}(:#{name}#{parent_clause}) do#{block_arg}\n"
+      def generic_header(factory_start, block_arg, ending, &block)
+        out =  "#{factory_start}(:#{name}#{parent_clause}) do#{block_arg}\n"
         out << yield.to_s
-        out << "  end\n"
+        out << "#{ending}\n"
       end
 
       def parent_clause

data/lib/to_factory/version.rb

@@ -1,3 +1,3 @@
 module ToFactory
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/lib/to_factory.rb

@@ -1,3 +1,5 @@
+require 'fileutils'
+
 require "to_factory/version"
 require "to_factory/config"
 require "to_factory/generation/factory"
@@ -14,6 +16,7 @@ require "to_factory/options_parser"
 
 module ToFactory
   class MissingActiveRecordInstanceException < Exception;end
+  class NotFoundError < Exception;end
 
   class << self
     def new_syntax?
@@ -27,9 +30,24 @@ module ToFactory
       false
     end
 
+    def definition_for(item)
+      if item.is_a? ActiveRecord::Base
+        Representation.from(item).definition
+      else
+        if found = representations.find{|r| r.name.to_s == item.to_s }
+          found.definition
+        else
+          raise NotFoundError.new "No definition found for #{item}"
+        end
+      end
+    end
+
     def definitions
-      results = Finders::Factory.new.call
-      results.map(&:name)
+      representations.map(&:name)
+    end
+
+    def representations
+      Finders::Factory.new.call
     end
   end
 end

data/spec/integration/file_writer_spec.rb

@@ -9,7 +9,7 @@ describe ToFactory::FileWriter do
     fs = ToFactory::FileSync.new
     representations = fs.all_representations
     #sanity check generation isn't broken
-    expect(representations.keys).to eq [ToFactory::User]
+    expect(representations.keys).to eq ["to_factory/user"]
     expect(representations.values[0][0]).to be_a ToFactory::Representation
 
     fw.write representations

data/spec/integration/to_factory_method_spec.rb

@@ -23,6 +23,22 @@ describe ToFactory do
 
   end
 
+  describe "ToFactory.definition_for" do
+  let(:expected_user_file) { File.read "./spec/example_factories/#{version}_syntax/user.rb"}
+    it do
+      expect(ToFactory.definition_for user).to match_sexp expected_user_file
+    end
+
+    it do
+      ToFactory(user)
+      expect(ToFactory.definition_for :"to_factory/user").to match_sexp expected_user_file
+    end
+
+    it "raises a not found error" do
+      expect(lambda{ToFactory.definition_for :"to_factory/user"}).to raise_error ToFactory::NotFoundError
+    end
+  end
+
   describe "Object#ToFactory" do
     context "with multiple levels of parent classes" do
       let(:filename) { "spec/example_factories/#{version}_syntax/#{'user_admin_super_admin'}.rb"}
@@ -43,8 +59,13 @@ describe ToFactory do
 
     it "generates all factories" do
       ToFactory()
+      #simple check for equivalent ruby
       expect(user_file)   .to match_sexp expected_user_file
       expect(project_file).to match_sexp expected_project_file
+
+      #once we are sure output is equivalent ruby, check output is identical
+      expect(user_file.chomp)   .to eq expected_user_file.chomp
+      expect(project_file.chomp).to eq expected_project_file.chomp
     end
 
     def user_file_includes(content)

data/spec/spec_helper.rb

@@ -6,7 +6,6 @@ rescue LoadError
 end
 
 require 'active_record'
-require 'fileutils'
 require 'active_support/core_ext/string'
 require 'active_support/core_ext/hash'
 require "sqlite3"

data/spec/support/ruby_parser_exception_causing_string.rb

@@ -0,0 +1,31 @@
+"               
+                                      \ \ \                 -           \ \   
+                                                                             
+                                                                               
+                                                                    ,      
+                                                                           
+                                                                   
+                                                                             
+                                                                   
+                                                                         \    
+                                                                       
+                                                                      
+                                              \                              
+                                                                              
+                                                                               
+                                                                             
+                                                                             
+                                                                       
+                                                                        
+                                                                             
+                                                                          
+                                                                         
+                                                    ,                  
+                                                                        
+                                                               \ \    
+                                                                               
+                                                                          
+                                                                           
+                                                                         
+
+                                                                 \ "

data/spec/unit/collation_spec.rb

@@ -33,7 +33,7 @@ describe ToFactory::Collation do
       pre_existing    = [ admin, user, super_admin ]
 
       result = ToFactory::Collation.organize(new_definitions, pre_existing)
-      result = result[ToFactory::User]
+      result = result["to_factory/user"]
       expect(result.map &:hierarchy_order).to eq [1,2,3,4]
       expect(result).to eq [user, admin, super_admin, root]
     end

data/spec/unit/file_writer_spec.rb

@@ -13,8 +13,8 @@ describe ToFactory::FileWriter do
     it "adds factories for all models" do
       user_representation = double :name => :user, "definition" => "factory a"
       project_representation = double :name => "project", :definition =>"factory b"
-      fw.write({ToFactory::User =>[user_representation],
-                ToFactory::Project => [project_representation]
+      fw.write({"to_factory/user" =>[user_representation],
+                "to_factory/project" => [project_representation]
       })
 
       if ToFactory.new_syntax?

data/spec/unit/generation/attribute_spec.rb

@@ -22,6 +22,25 @@ describe ToFactory::Generation::Attribute do
 
       expect(attribute.inspect_value(hash)).to eq expected
     end
+
+    it "handles arrays correctly" do
+      expected = "[1, 2, :a, \"4\"]"
+
+      input = [1, 2, :a, "4"]
+      expect(attribute.format(input, false)).to eq expected
+    end
   end
 
+  if RUBY_VERSION =~ /\A1\.8/
+    it "alters attributes that are unparseable by RubyParser" do
+      #when reparsing the generated files, we don't want the parser itself
+      #to raise an exception, rather than fix RubyParser now, a hotfix is to
+      #warn about these attributes and replace them with something parseable
+      value = File.read("./spec/support/ruby_parser_exception_causing_string.rb")
+      expect(lambda{RubyParser.new.parse(value)}).to raise_error StringScanner::Error
+      result = attribute.inspect_value(value)
+      expect(lambda{RubyParser.new.parse(result)}).not_to raise_error
+      expect(result).to match /ToFactory: RubyParser exception/
+    end
+  end
 end

metadata

@@ -1,177 +1,137 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: to_factory
-version: !ruby/object:Gem::Version 
-  hash: 23
-  prerelease: 
-  segments: 
-  - 0
-  - 2
-  - 0
-  version: 0.2.0
+version: !ruby/object:Gem::Version
+  version: 0.2.1
 platform: ruby
-authors: 
+authors:
 - Mark Burns
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2015-01-08 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2015-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :development
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 3
-        - 6
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
         version: 1.3.6
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: ruby-debug
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: database_cleaner
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 13
-        segments: 
-        - 0
-        - 3
-        version: "0.3"
-  type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: ruby2ruby
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: activerecord
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">"
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 2
-        - 0
-        version: "2.0"
-    - - <
-      - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 4
-        - 0
-        version: "4.0"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: i18n
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - <
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 0
-        - 7
-        version: "0.7"
-  type: :runtime
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
   name: factory_girl
-  prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - <
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 2
-        - 0
-        version: "2.0"
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
   type: :development
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        version: "3.0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :development
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 35
-        segments: 
-        - 10
-        - 0
-        version: "10.0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
   type: :development
-  version_requirements: *id009
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
 description: Autogenerate and append/create factory_girl definitions from the console
-email: 
+email:
 - markthedeveloper@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
-- .rspec
-- .travis.yml
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - README.md
 - Rakefile
@@ -227,6 +187,7 @@ files:
 - spec/support/models/not_active_record.rb
 - spec/support/models/project.rb
 - spec/support/models/user.rb
+- spec/support/ruby_parser_exception_causing_string.rb
 - spec/unit/collation_spec.rb
 - spec/unit/file_writer_spec.rb
 - spec/unit/finders/factory_spec.rb
@@ -237,41 +198,31 @@ files:
 - spec/unit/parsing/klass_inference_spec.rb
 - tmp/.keep
 - to_factory.gemspec
-has_rdoc: true
-homepage: ""
-licenses: 
+homepage: ''
+licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  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
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 2.4.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Turn ActiveRecord instances into factories
-test_files: 
+test_files:
 - spec/db/migrate/1_create_users.rb
 - spec/db/migrate/2_create_projects.rb
 - spec/db/migrate/3_create_not_namespaced.rb
@@ -305,6 +256,7 @@ test_files:
 - spec/support/models/not_active_record.rb
 - spec/support/models/project.rb
 - spec/support/models/user.rb
+- spec/support/ruby_parser_exception_causing_string.rb
 - spec/unit/collation_spec.rb
 - spec/unit/file_writer_spec.rb
 - spec/unit/finders/factory_spec.rb