stepford 0.3.0 → 0.5.0

data/README.md

@@ -11,9 +11,13 @@ Stepford is a CLI to create starter [Factory Girl][factory_girl] factories for a
         author
         association :edited_by, factory: :user
         FactoryGirl.create_list :comments, 2
+        trait :with_notes do; FactoryGirl.create_list :note, 2; end
+        trait :complete do; complete true; end
+        trait :not_complete do; complete false; end
         created_at { 2.weeks.ago }
         name 'Test Name'
         price 1.23
+        trait :with_summary do; template 'Test Summary'; end
         updated_at { 2.weeks.ago }
       end
 
@@ -37,6 +41,16 @@ Then run:
 
 #### Factory Girl
 
+##### How NOT NULL, and Other Database Constraints and Active Record Validations Are Handled
+
+If the ActiveRecord column `null` property for the attribute is true for the attribute or foreign key for the association, or if there is a presence validator for an attribute or foreign key for the association, then that attribute or association will be defined by the default factory.
+
+Currently uniqueness constraints are ignored and must be handled by FactoryGirl sequence or similar if not automatically populated by your model or the database, e.g. in your factory, if username uniqueness is enforced by a unique constraint on the database-side, you'll need to do something like this manually in the factory:
+
+    sequence(:username) {|n| "user#{n}" }
+
+##### Creating Factories
+
 The default will assume a `test/factories` directory exists. In that directory, it will create a factory file for each model containing example values for all attributes except primary keys, foreign keys, created_at, and updated_at:
 
     bundle exec stepford factories
@@ -49,29 +63,47 @@ It will figure out that you want a single file, if the path ends in `.rb`:
 
     bundle exec stepford factories --path spec/support/factories.rb
 
-### Associations
+##### Traits
+
+To generate traits for each attribute that would be included with `--attributes`, but isn't because `--attributes` is not specified:
+
+    bundle exec stepford factories --attribute-traits
 
-To include associations:
+To generate traits for each association that would be included with `--associations`, but isn't because `--associations` is not specified:
+
+    bundle exec stepford factories --association-traits
+
+##### Associations
+
+To include all associations even if they aren't deemed to be required by not null ActiveRecord constraints defined in the model:
 
     bundle exec stepford factories --associations
 
-### Stepford Checks Model Associations
+##### Stepford Checks Model Associations
 
 If `--associations` or `--validate-associations` is specified, Stepford first loads Rails and attempts to check your models for broken associations.
 
 If associations are deemed broken, it will output proposed changes.
 
-### No IDs
+##### No IDs
 
 If working with a legacy schema, you may have models with foreign_key columns that you don't have associations defined for in the model. If that is the case, we don't want to assign arbitrary integers to them and try to create a record. If that is the case, try `--exclude-all-ids`, which will exclude those ids as attributes defined in the factories and you can add associations as needed to get things working.
 
-### Specifying Models
+##### Singleton Values
+
+Use `--cache-associations` to store and use factories to avoid 'stack level too deep' errors.
+
+##### Specifying Models
 
 Specify `--models` and a comma-delimited list of models to only output the models you specify. If you don't want to overwrite existing factory files, you should direct the output to another file and manually copy each in:
 
     bundle exec stepford factories --path spec/support/put_into_factories.rb --models foo,bar,foo_bar
 
-### Troubleshooting
+##### Testing Factories
+
+See [Testing all Factories (with RSpec)][test_factories] in the FG wiki.
+
+##### Troubleshooting
 
 If you have duplicate factory definitions during Rails load, it may complain. Just move, rename, or remove the offending files and factories and retry.
 
@@ -93,12 +125,12 @@ or maybe:
 
 you might either need to modify those factories to set associations that are required or specify `--associations` in Stepford to attempt generate them.
 
-If you specify `--associations`, you might get circular associations and could easily end up with:
+Without `--cache-associations`, you might get circular associations and could easily end up with:
 
     SystemStackError:
       stack level too deep
 
-ThoughtBot's Josh Clayton provided some suggestions for this, including using methods to generate more complex object structures:
+ThoughtBot's Josh Clayton also provided some suggestions for this, including using methods to generate more complex object structures:
 
     def post_containing_comment_by_author
       author = FactoryGirl.create(:user)
@@ -132,5 +164,7 @@ or referring to created objects through associations, though he said multiple ne
 
 Copyright (c) 2012 Gary S. Weaver, released under the [MIT license][lic].
 
+[singletons]: http://stackoverflow.com/questions/2015473/using-factory-girl-in-rails-with-associations-that-have-unique-constraints-gett/3569062#3569062
+[test_factories]: https://github.com/thoughtbot/factory_girl/wiki/Testing-all-Factories-%28with-RSpec%29
 [factory_girl]: https://github.com/thoughtbot/factory_girl/
 [lic]: http://github.com/garysweaver/stepford/blob/master/LICENSE

data/lib/stepford/cli.rb

@@ -5,10 +5,14 @@ module Stepford
     desc "factories", "create FactoryGirl factories"
     method_option :single, :desc => "Put all factories into a single file", :type => :boolean
     method_option :path, :desc => "Pathname of file to contain factories or path of directory to contain factory/factories"
-    method_option :associations, :desc => "Include associations in factories", :type => :boolean
+    method_option :associations, :desc => "Include all associations in factories, not just those that are required due to ActiveRecord presence validation or column not null restriction", :type => :boolean
     method_option :validate_associations, :desc => "Validate associations in factories even if not including associations", :type => :boolean
     method_option :exclude_all_ids, :desc => "Exclude attributes with names ending in _id even if they aren't foreign or primary keys", :type => :boolean
     method_option :models, :desc => "A comma delimited list of only the models you want to include"
+    method_option :attributes, :desc => "Include all attributes except foreign keys and primary keys, not just those that are required due to ActiveRecord presence validation or column not null restriction", :type => :boolean
+    method_option :attribute_traits, :desc => "Include traits for attributes that would be output with --attributes that wouldn't be otherwise when --attributes is not specified", :type => :boolean
+    method_option :association_traits, :desc => "Include traits for associations that would be output with --associations that wouldn't be otherwise when --associations is not specified", :type => :boolean
+    method_option :cache_associations, :desc => "Use singleton values to avoid 'stack level too deep' circular reference(s)", :type => :boolean    
     def factories()
       # load Rails environment
       require './config/environment'

data/lib/stepford/common.rb

@@ -20,7 +20,7 @@ module Stepford
       when :boolean
         column.default.nil? ? 'true' : column.default.to_s
       when :xml
-        column.default.nil? ? '<test>Test #{column_name.titleize}</test>' : column.default.to_s
+        column.default.nil? ? '<test>Test #{column.name.titleize}</test>' : column.default.to_s
       when :ts_vector
         column.default.nil? ? 'nil' : column.default.to_s
       else

data/lib/stepford/factory_girl.rb

@@ -2,8 +2,26 @@ require 'stepford/common'
 
 module Stepford
   class FactoryGirl
+    CACHE_VALUES_FILENAME = 'fg_cache.rb'
+
     def self.generate_factories(options={})
       # guard against circular references
+      if options[:cache_associations]
+        File.open(File.join(File.dirname(get_factories_rb_pathname(options)), CACHE_VALUES_FILENAME), "w") do |f|
+          #TODO: just copy this file from the gem to project vs. writing it like this
+          f.puts '# originally created by Stepford: https://github.com/garysweaver/stepford'
+          f.puts '# idea somewhat based on d2vid and snowangel\'s answer in http://stackoverflow.com/questions/2015473/using-factory-girl-in-rails-with-associations-that-have-unique-constraints-gett/3569062#3569062'
+          f.puts 'fg_cachehash = {}'
+          f.puts 'def fg_cache(class_sym, assc_sym = nil, number = nil)'
+          # if missing 3rd arg, assume 2nd arg is 3rd arg or use default
+          # if missing 2nd and 3rd arg, assume 2nd arg is 1st arg
+          f.puts '  number ||= assc_sym'
+          f.puts '  assc_sym ||= class_sym'
+          f.puts '  fg_cachehash[factory_sym, assc_sym, number] ||= (number ? FactoryGirl.create_list(class_sym, number) : FactoryGirl.create(class_sym))'
+          f.puts 'end'
+        end
+      end
+
       factories = {}
       expected = {}
       included_models = options[:models] ? options[:models].split(',').collect{|s|s.strip}.compact : nil
@@ -17,25 +35,45 @@ module Stepford
         excluded_attributes = Array.wrap(model_class.primary_key).collect{|pk|pk.to_sym} + [:updated_at, :created_at]
         association_lines = model_class.reflections.collect {|association_name, reflection|
           (expected[reflection.class_name.underscore.to_sym] ||= []) << model_name
-          excluded_attributes << reflection.foreign_key.to_sym
+          excluded_attributes << reflection.foreign_key.to_sym if reflection.foreign_key
           assc_sym = reflection.name.to_sym
           clas_sym = reflection.class_name.underscore.to_sym
-          # we have to do the part above to not set arbitrary values in foreign key attributes
-          if options[:associations]
-            if reflection.macro == :has_many
-              "FactoryGirl.create_list #{assc_sym.inspect}, 2"
-            elsif assc_sym != clas_sym
-              "association #{assc_sym.inspect}#{assc_sym != clas_sym ? ", factory: #{clas_sym.inspect}" : ''}"
+          # if has a foreign key, then if NOT NULL or is a presence validate, the association is required and should be output. unfortunately this could mean a circular reference that will have to be manually fixed
+          has_presence_validator = model_class.validators_on(assc_sym).collect{|v|v.class}.include?(ActiveModel::Validations::PresenceValidator)
+          required = reflection.foreign_key ? (has_presence_validator || model_class.columns.any?{|c| !c.null && c.name.to_sym == reflection.foreign_key.to_sym}) : false
+          should_be_trait = !(options[:associations] || required) && options[:association_traits]
+          if options[:associations] || required || should_be_trait
+            if options[:cache_associations]
+              if reflection.macro == :has_many              
+                "#{should_be_trait ? "trait #{"with_#{assc_sym}".to_sym.inspect} do; " : ''}after(:create) do |user, evaluator|; #{is_reserved?(assc_sym) ? 'self.' : ''}#{assc_sym} = fg_cache(#{clas_sym.inspect}#{clas_sym == assc_sym ? '' : ", #{assc_sym.inspect}"}, 2); end"
+              else
+                "#{should_be_trait ? "trait #{"with_#{assc_sym}".to_sym.inspect} do; " : ''}after(:create) do |user, evaluator|; #{is_reserved?(assc_sym) ? 'self.' : ''}#{assc_sym} = fg_cache(#{clas_sym.inspect}#{clas_sym == assc_sym ? '' : ", #{assc_sym.inspect}"}); end"
+              end
             else
-              "#{assc_sym}"
+              if reflection.macro == :has_many              
+                "#{should_be_trait ? "trait #{"with_#{assc_sym}".to_sym.inspect} do; " : ''}#{should_be_trait || has_presence_validator ? '' : '#'}after(:create) do |user, evaluator|; FactoryGirl.create_list #{clas_sym.inspect}, 2; end#{should_be_trait ? '; end' : ''}#{should_be_trait ? '' : ' # commented to avoid circular reference'}"
+              elsif assc_sym != clas_sym
+                "#{should_be_trait ? "trait #{"with_#{assc_sym}".to_sym.inspect} do; " : ''}#{should_be_trait || reflection.macro == :belongs_to || has_presence_validator ? '' : '#'}association #{assc_sym.inspect}#{assc_sym != clas_sym ? ", factory: #{clas_sym.inspect}" : ''}#{should_be_trait ? '; end' : ''}#{should_be_trait || reflection.macro == :belongs_to ? '' : ' # commented to avoid circular reference'}"
+              else
+                "#{should_be_trait ? "trait #{"with_#{assc_sym}".to_sym.inspect} do; " : ''}#{should_be_trait || reflection.macro == :belongs_to || has_presence_validator ? '' : '#'}#{is_reserved?(assc_sym) ? 'self.' : ''}#{assc_sym}#{should_be_trait ? '; end' : ''}#{should_be_trait || reflection.macro == :belongs_to ? '' : ' # commented to avoid circular reference'}"
+              end
             end
           else
             nil
           end
         }.compact.sort.each {|l|factory << l}
-        model_class.columns.collect {|c|
-          "#{c.name.to_sym} #{Stepford::Common.value_for(c)}" unless (excluded_attributes.include?(c.name.to_sym) || ((c.name.downcase.end_with?('_id') && options[:exclude_all_ids])))
-        }.compact.sort.each {|l|factory << l}
+        model_class.columns.sort_by {|c|[c.name]}.each {|c|
+          if !excluded_attributes.include?(c.name.to_sym) && !(c.name.downcase.end_with?('_id') && options[:exclude_all_ids]) && (options[:attributes] || !c.null)
+            factory << "#{c.name} #{Stepford::Common.value_for(c)}"
+          elsif options[:attribute_traits]
+            if c.type == :boolean
+              factory << "trait #{c.name.underscore.to_sym.inspect} do; #{c.name} true; end"
+              factory << "trait #{"not_#{c.name.underscore}".to_sym.inspect} do; #{c.name} false; end"
+            else
+              factory << "trait #{"with_#{c.name.underscore}".to_sym.inspect} do; #{c.name} #{Stepford::Common.value_for(c)}; end"
+            end
+          end
+        }
       end
 
       if options[:associations] || options[:validate_associations]
@@ -60,18 +98,7 @@ module Stepford
         return false if failed
       end
 
-      path = File.join('test','factories.rb')
-      if options[:path]
-        if options[:path].end_with?('.rb')
-          path = options[:path]
-        else
-          if options[:single]
-            path = File.join(options[:path],'factories.rb')
-          else
-            path = options[:path]
-          end
-        end
-      end
+      path = get_factories_rb_pathname(options)
       
       if path.end_with?('.rb')
         dirpath = File.dirname(path)
@@ -81,16 +108,12 @@ module Stepford
         end
 
         File.open(path, "w") do |f|
-          f.puts 'require \'factory_girl_rails\''
-          f.puts ''
-          f.puts 'FactoryGirl.define do'
-          f.puts '  '            
+          write_header(f, options)           
           factories.keys.sort.each do |factory_name|
             factory = factories[factory_name]
             write_factory(factory_name, factory, f)
-            f.puts '  '
           end
-          f.puts "end"
+          write_footer(f)
         end
       else
         unless File.directory?(path)
@@ -101,13 +124,9 @@ module Stepford
         factories.keys.sort.each do |factory_name|
           factory = factories[factory_name]
           File.open(File.join(path,"#{factory_name}.rb"), "w") do |f|
-            f.puts 'require \'factory_girl_rails\''
-            f.puts ''
-            f.puts 'FactoryGirl.define do'
-            f.puts '  '
+            write_header(f, options)
             write_factory(factory_name, factory, f)
-            f.puts '  '
-            f.puts "end"
+            write_footer(f)
           end
         end
       end
@@ -116,13 +135,49 @@ module Stepford
     end
 
     private
+
+    def self.is_reserved?(s)
+      # from http://stackoverflow.com/questions/6461303/built-in-way-to-determine-whether-a-string-is-a-ruby-reserved-word/6461673#6461673
+      %w{__FILE__ __LINE__ alias and begin BEGIN break case class def defined? do else elsif end END ensure false for if in module next nil not or redo rescue retry return self super then true undef unless until when while yield}.include? s.to_s
+    end
+
+    def self.get_factories_rb_pathname(options)
+      path = File.join('test','factories.rb')
+      if options[:path]
+        if options[:path].end_with?('.rb')
+          path = options[:path]
+        else
+          if options[:single]
+            path = File.join(options[:path],'factories.rb')
+          else
+            path = options[:path]
+          end
+        end
+      end
+      path
+    end
+
+    def self.write_header(f, options)
+      f.puts 'require \'factory_girl_rails\''
+      f.puts "require_relative \'#{CACHE_VALUES_FILENAME.chomp('.rb')}\'" if options[:cache_associations]
+      f.puts ''
+      f.puts '# originally created by Stepford: https://github.com/garysweaver/stepford'
+      f.puts ''
+      f.puts 'FactoryGirl.define do'
+      f.puts '  '
+    end
     
     def self.write_factory(factory_name, factory, f)
       f.puts "  factory #{factory_name.inspect} do"
       factory.each do |line|
         f.puts "    #{line}"
       end
-      f.puts "  end"
+      f.puts '  end'
+      f.puts '  '
+    end
+
+    def self.write_footer(f)
+      f.puts 'end'
     end
   end
 end

data/lib/stepford/version.rb

@@ -1,3 +1,3 @@
 module Stepford
-  VERSION = '0.3.0'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stepford
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-02 00:00:00.000000000 Z
+date: 2012-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor