cucumber_factory 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eeed19e5c878629c3f87a038821a955401c40c19ca323577d7e84e3ae019f764
-  data.tar.gz: 2d3b57e9b739be6e69d28240c7553eec3882b2e200ca64c402a8cc646bcdc169
+  metadata.gz: 3153238ae9f4c30fd21e6dd493621e361d4bc6b508521effc93fbb4cb4be8af2
+  data.tar.gz: c152087fd0231027a94abf15f2abff5c3b3857c714212f3c1eefa67902b32b3e
 SHA512:
-  metadata.gz: 752a2cbe68fa53254741a792770ab0252f320a218fb3c39fe85679bcf6d8e1289fdee354042bb342d96789266c6f8ac02819393ee375d628def84679de281cad
-  data.tar.gz: aa2eb84a898e7d52f10b7272ad8f7c04a9d1dea4096d0a7fab04d9158a887f46839e7d36b83f9aec945b13b18f0b4550de19fe9df0897ccc1235f22f990b2b59
+  metadata.gz: 48b39f6ebaedb5bca521d07579384cbcffea01eb4638787de026ce683b1db2abc70fd91227f272cd88a75cb3a15cd8e780989b99a3429313aa6f9e0f6a8575c9
+  data.tar.gz: 5b16cb2d4e73c1fde061b12e31a23944a3d6889316002805cd0f0bb7d0355cf520d01cb587c5a0ab58648633f83189ee2bba9597b2bda7217315db5fc48ca218

data/CHANGELOG.md

@@ -13,6 +13,19 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 
 ### Compatible changes
 
+-
+
+
+## 2.1.0 - 2020-03-09
+
+### Compatible changes
+
+- Allow associations to be set for [transient attributes](https://github.com/thoughtbot/factory_bot/blob/master/GETTING_STARTED.md#transient-attributes) if they are named after the model. For example, when there is a `Role` model and the`user` factory has a transient attribute `role`, the following steps are now valid:
+  ```
+  Given there is a role
+    And there is a user with the role above
+  ```
+
 ## 2.0.2 - 2020-03-26
 
 ### Compatible changes

data/Gemfile.cucumber-1.3

@@ -12,5 +12,8 @@ gem 'rake', '>=10.0.4'
 gem 'database_cleaner', '~>1.0.0'
 gem 'gemika'
 
+# Test dependencies
+gem 'factory_bot', '< 5'
+
 # Gem under test
 gem 'cucumber_factory', :path => '.'

data/Gemfile.cucumber-1.3.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cucumber_factory (2.0.2)
+    cucumber_factory (2.1.0)
       activerecord
       activesupport
       cucumber
@@ -35,6 +35,8 @@ GEM
       cucumber
     database_cleaner (1.0.1)
     diff-lcs (1.3)
+    factory_bot (4.11.1)
+      activesupport (>= 3.0.0)
     gemika (0.4.0)
     gherkin (2.12.2)
       multi_json (~> 1.3)
@@ -71,6 +73,7 @@ DEPENDENCIES
   cucumber (~> 1.3.20)
   cucumber_factory!
   database_cleaner (~> 1.0.0)
+  factory_bot (< 5)
   gemika
   mysql2
   rake (>= 10.0.4)

data/Gemfile.cucumber-2.4

@@ -12,5 +12,8 @@ gem 'rake'
 gem 'database_cleaner'
 gem 'gemika'
 
+# Test dependencies
+gem 'factory_bot', '< 5' # 5.0 requires Ruby >= 2.3
+
 # Gem under test
 gem 'cucumber_factory', :path => '.'

data/Gemfile.cucumber-2.4.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cucumber_factory (2.0.2)
+    cucumber_factory (2.1.0)
       activerecord
       activesupport
       cucumber
@@ -40,6 +40,8 @@ GEM
       cucumber
     database_cleaner (1.6.2)
     diff-lcs (1.3)
+    factory_bot (4.11.1)
+      activesupport (>= 3.0.0)
     gemika (0.3.2)
     gherkin (4.1.3)
     i18n (0.9.5)
@@ -75,6 +77,7 @@ DEPENDENCIES
   cucumber (~> 2.4.0)
   cucumber_factory!
   database_cleaner
+  factory_bot (< 5)
   gemika
   mysql2
   rake

data/Gemfile.cucumber-3.0

@@ -12,5 +12,8 @@ gem 'rake'
 gem 'database_cleaner'
 gem 'gemika'
 
+# Test dependencies
+gem 'factory_bot'
+
 # Gem under test
 gem 'cucumber_factory', :path => '.'

data/Gemfile.cucumber-3.0.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cucumber_factory (2.0.2)
+    cucumber_factory (2.1.0)
       activerecord
       activesupport
       cucumber
@@ -45,6 +45,8 @@ GEM
       cucumber
     database_cleaner (1.6.2)
     diff-lcs (1.3)
+    factory_bot (5.1.1)
+      activesupport (>= 4.2.0)
     gemika (0.3.2)
     gherkin (4.1.3)
     i18n (0.9.5)
@@ -80,6 +82,7 @@ DEPENDENCIES
   cucumber (~> 3.0.0)
   cucumber_factory!
   database_cleaner
+  factory_bot
   gemika
   mysql2
   rake

data/Gemfile.cucumber-3.1

@@ -12,5 +12,8 @@ gem 'rake'
 gem 'database_cleaner'
 gem 'gemika'
 
+# Test dependencies
+gem 'factory_bot'
+
 # Gem under test
 gem 'cucumber_factory', :path => '.'

data/Gemfile.cucumber-3.1.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cucumber_factory (2.0.2)
+    cucumber_factory (2.1.0)
       activerecord
       activesupport
       cucumber
@@ -45,6 +45,8 @@ GEM
       cucumber
     database_cleaner (1.6.2)
     diff-lcs (1.3)
+    factory_bot (5.1.1)
+      activesupport (>= 4.2.0)
     gemika (0.3.2)
     gherkin (5.0.0)
     i18n (0.9.5)
@@ -80,6 +82,7 @@ DEPENDENCIES
   cucumber (~> 3.1.0)
   cucumber_factory!
   database_cleaner
+  factory_bot
   gemika
   mysql2
   rake

data/README.md

@@ -65,7 +65,7 @@ Given there is a movie with these attributes:
 Setting associations
 --------------------
 
-You can set `belongs_to` associations by referring to the last created record of as `above`:
+You can set `belongs_to` and `transient` associations by referring to the last created record of as `above`:
 
 ```cucumber
 Given there is a movie with the title "Before Sunrise"

data/lib/cucumber_factory/build_strategy.rb

@@ -7,79 +7,110 @@ module CucumberFactory
     class << self
 
       def from_prose(model_prose, variant_prose)
-        # don't use \w which depends on the system locale
-        underscored_model_name = model_prose.gsub(/[^A-Za-z0-9_\/]+/, "_")
-        if variant_prose.present?
-          variants = /\((.*?)\)/.match(variant_prose)[1].split(/\s*,\s*/)
-          variants = variants.collect { |variant| variant.downcase.gsub(" ", "_") }
+        variants = variants_from_prose(variant_prose)
+        factory = factory_bot_factory(model_prose, variants)
+
+        if factory
+          strategy = factory_bot_strategy(factory, model_prose, variants)
+          transient_attributes = factory_bot_transient_attributes(factory, variants)
         else
-          variants = []
+          strategy = alternative_strategy(model_prose, variants)
+          transient_attributes = []
         end
 
-        if factory_bot_strategy = factory_bot_strategy(underscored_model_name, variants)
-          factory_bot_strategy
+        [strategy, transient_attributes]
+      end
+
+      private
+
+      def variants_from_prose(variant_prose)
+        if variant_prose.present?
+          variants = /\((.*?)\)/.match(variant_prose)[1].split(/\s*,\s*/)
+          variants.collect { |variant| variant.downcase.gsub(" ", "_").to_sym }
         else
-          model_class = underscored_model_name.camelize.constantize
-          machinist_strategy(model_class, variants) ||
-            active_record_strategy(model_class) ||
-            ruby_object_strategy(model_class)
+          []
         end
       end
 
-      private
+      def factory_bot_factory(model_prose, variants)
+        return unless factory_bot_class
 
-      def factory_bot_strategy(factory_name, variants)
-        factory_class   = ::FactoryBot  if defined?(FactoryBot)
-        factory_class ||= ::FactoryGirl if defined?(FactoryGirl)
-        return unless factory_class
+        factory_name = factory_name_from_prose(model_prose)
+        factory = factory_bot_class.factories[factory_name]
 
-        variants = variants.map(&:to_sym)
-        factory_name = factory_name.to_s.underscore.gsub('/', '_').to_sym
+        if factory.nil? && variants.present?
+          factory = factory_bot_class.factories[variants[0]]
+        end
+
+        factory
+      end
 
-        factory = factory_class.factories[factory_name]
+      def factory_bot_strategy(factory, model_prose, variants)
+        return unless factory
 
-        if factory.nil? && variants.present? && factory = factory_class.factories[variants[0]]
+        factory_name = factory_name_from_prose(model_prose)
+        if factory_bot_class.factories[factory_name].nil? && variants.present?
           factory_name, *variants = variants
         end
 
-        if factory
-          new(factory.build_class) do |attributes|
-            # Cannot have additional scalar args after a varargs
-            # argument in Ruby 1.8 and 1.9
-            args = []
-            args += variants
-            args << attributes
-            factory_class.create(factory_name, *args)
-          end
+        new(factory.build_class) do |attributes|
+          # Cannot have additional scalar args after a varargs
+          # argument in Ruby 1.8 and 1.9
+          args = []
+          args += variants
+          args << attributes
+          factory_bot_class.create(factory_name, *args)
+        end
+      end
+
+      def factory_bot_transient_attributes(factory, variants)
+        return [] unless factory
+
+        factory_attributes = factory_bot_attributes(factory, variants)
+        class_attributes = factory.build_class.attribute_names.map(&:to_sym)
+
+        factory_attributes - class_attributes
+      end
+
+      def factory_bot_attributes(factory, variants)
+        traits = factory_bot_traits(factory, variants)
+        factory.with_traits(traits.map(&:name)).definition.attributes.names
+      end
+
+      def factory_bot_traits(factory, variants)
+        factory.definition.defined_traits.select do |trait|
+          variants.include?(trait.name.to_sym)
         end
+      end
 
+      def alternative_strategy(model_prose, variants)
+        model_class = underscored_model_name(model_prose).camelize.constantize
+        machinist_strategy(model_class, variants) ||
+          active_record_strategy(model_class) ||
+          ruby_object_strategy(model_class)
       end
 
       def machinist_strategy(model_class, variants)
-        if model_class.respond_to?(:make)
-
-          new(model_class) do |attributes|
-            if variants.present?
-              variants.size == 1 or raise 'Machinist only supports a single variant per blueprint'
-              model_class.make(variants.first.to_sym, attributes)
-            else
-              model_class.make(attributes)
-            end
-          end
+        return unless model_class.respond_to?(:make)
 
+        new(model_class) do |attributes|
+          if variants.present?
+            variants.size == 1 or raise 'Machinist only supports a single variant per blueprint'
+            model_class.make(variants.first, attributes)
+          else
+            model_class.make(attributes)
+          end
         end
       end
 
       def active_record_strategy(model_class)
-        if model_class.respond_to?(:create!)
-
-          new(model_class) do |attributes|
-            model = model_class.new
-            CucumberFactory::Switcher.assign_attributes(model, attributes)
-            model.save!
-            model
-          end
+        return unless model_class.respond_to?(:create!)
 
+        new(model_class) do |attributes|
+          model = model_class.new
+          CucumberFactory::Switcher.assign_attributes(model, attributes)
+          model.save!
+          model
         end
       end
 
@@ -89,6 +120,21 @@ module CucumberFactory
         end
       end
 
+      def factory_bot_class
+        factory_class = ::FactoryBot if defined?(FactoryBot)
+        factory_class ||= ::FactoryGirl if defined?(FactoryGirl)
+        factory_class
+      end
+
+      def factory_name_from_prose(model_prose)
+        underscored_model_name(model_prose).to_s.underscore.gsub('/', '_').to_sym
+      end
+
+      def underscored_model_name(model_prose)
+        # don't use \w which depends on the system locale
+        model_prose.gsub(/[^A-Za-z0-9_\/]+/, "_")
+      end
+
     end
 
 

data/lib/cucumber_factory/factory.rb

@@ -100,7 +100,7 @@ module CucumberFactory
       end
 
       def parse_creation(world, raw_model, raw_variant, raw_attributes, raw_boolean_attributes, raw_multiline_attributes = nil)
-        build_strategy = BuildStrategy.from_prose(raw_model, raw_variant)
+        build_strategy, transient_attributes = BuildStrategy.from_prose(raw_model, raw_variant)
         model_class = build_strategy.model_class
         attributes = {}
         if raw_attributes.try(:strip).present?
@@ -108,7 +108,7 @@ module CucumberFactory
           raw_attributes.scan(raw_attribute_fragment_regex).each do |fragment|
             attribute = attribute_name_from_prose(fragment[0])
             value = fragment[1]
-            attributes[attribute] = attribute_value(world, model_class, attribute, value)
+            attributes[attribute] = attribute_value(world, model_class, transient_attributes, attribute, value)
           end
           unused_raw_attributes = raw_attributes.gsub(raw_attribute_fragment_regex, '')
           if unused_raw_attributes.present?
@@ -129,14 +129,14 @@ module CucumberFactory
               raw_attribute, value = fragment.split(': ')
               attribute = attribute_name_from_prose(raw_attribute)
               value = "\"#{value}\"" unless matches_fully?(value, VALUE_ARRAY)
-              attributes[attribute] = attribute_value(world, model_class, attribute, value)
+              attributes[attribute] = attribute_value(world, model_class, transient_attributes, attribute, value)
             end
           # DataTable e.g. in raw [["first name", "Jane"], ["last name", "Jenny"]]
           else
             raw_multiline_attributes.raw.each do |raw_attribute, value|
               attribute = attribute_name_from_prose(raw_attribute)
               value = "\"#{value}\"" unless matches_fully?(value, VALUE_ARRAY)
-              attributes[attribute] = attribute_value(world, model_class, attribute, value)
+              attributes[attribute] = attribute_value(world, model_class, transient_attributes, attribute, value)
             end
           end
         end
@@ -145,15 +145,15 @@ module CucumberFactory
         record
       end
 
-      def attribute_value(world, model_class, attribute, value)
-        association = model_class.respond_to?(:reflect_on_association) ? model_class.reflect_on_association(attribute) : nil
+      def attribute_value(world, model_class, transient_attributes, attribute, value)
+        association_class = resolve_association_class(attribute, model_class, transient_attributes)
 
         if matches_fully?(value, VALUE_ARRAY)
           elements_str = unquote(value)
-          value = elements_str.scan(VALUE_SCALAR).map { |v| attribute_value(world, model_class, attribute, v) }
-        elsif association.present?
+          value = elements_str.scan(VALUE_SCALAR).map { |v| attribute_value(world, model_class, transient_attributes, attribute, v) }
+        elsif association_class.present?
           if matches_fully?(value, VALUE_LAST_RECORD)
-            value = CucumberFactory::Switcher.find_last(association.klass) or raise Error, "There is no last #{attribute}"
+            value = CucumberFactory::Switcher.find_last(association_class) or raise Error, "There is no last #{attribute}"
           elsif matches_fully?(value, VALUE_STRING)
             value = unquote(value)
             value = get_named_record(world, value) || transform_value(world, value)
@@ -169,6 +169,19 @@ module CucumberFactory
         value
       end
 
+      def resolve_association_class(attribute, model_class, transient_attributes)
+        return unless model_class.respond_to?(:reflect_on_association)
+
+        klass = if model_class.reflect_on_association(attribute)
+          model_class.reflect_on_association(attribute).klass
+        elsif transient_attributes.include?(attribute.to_sym)
+          klass_name = attribute.to_s.camelize
+          klass_name.constantize if Object.const_defined?(klass_name)
+        else
+          nil
+        end
+      end
+
       def resolve_scalar_value(world, model_class, attribute, value)
         if matches_fully?(value, VALUE_STRING)
           value = unquote(value)

data/lib/cucumber_factory/version.rb

@@ -1,3 +1,3 @@
 module CucumberFactory
-  VERSION = '2.0.2'
+  VERSION = '2.1.0'
 end

data/spec/cucumber_factory/factory/build_strategy_spec.rb

@@ -2,47 +2,45 @@ require 'spec_helper'
 
 describe CucumberFactory::BuildStrategy do
 
-  subject { CucumberFactory::BuildStrategy }
-
   # most of the behaviour is integration tested in steps_spec.rb
 
   describe '.from_prose' do
 
     context 'when describing a factory_bot factory' do
-
-      it 'returns a strategy corresponding to the factories model' do
-        FactoryBot.stub_factories :job_offer => JobOffer
-        strategy = subject.from_prose('job offer', nil)
+      it 'returns a strategy and transient attributes corresponding to the factories model' do
+        strategy, transient_attributes = described_class.from_prose('job offer', nil)
 
         strategy.should be_a(described_class)
         strategy.model_class.should == JobOffer
+        transient_attributes.should == [:my_transient_attribute]
       end
 
       it 'uses the variant for the factory name if present' do
-        FactoryBot.stub_factories :job_offer => JobOffer
-        strategy = subject.from_prose('foo', '(job offer)')
+        strategy, transient_attributes = described_class.from_prose('job offer', '(tempting_job_offer)')
 
         strategy.should be_a(described_class)
         strategy.model_class.should == JobOffer
+        transient_attributes.should == [:my_transient_attribute, :other_transient_attribute]
       end
-
     end
 
     context 'when describing a non factory_bot model' do
+      before do
+        hide_const("FactoryBot")
+      end
 
       it "should return a strategy for the class matching a natural language expression" do
-        subject.from_prose("movie", nil).model_class.should == Movie
-        subject.from_prose("job offer", nil).model_class.should == JobOffer
+        described_class.from_prose("movie", nil).first.model_class.should == Movie
+        described_class.from_prose("job offer", nil).first.model_class.should == JobOffer
       end
 
       it "should ignore variants for the class name" do
-        subject.from_prose("movie", "(job offer)").model_class.should == Movie
+        described_class.from_prose("movie", "(job offer)").first.model_class.should == Movie
       end
 
       it "should allow namespaced models" do
-        subject.from_prose("people/actor", nil).model_class.should == People::Actor
+        described_class.from_prose("people/actor", nil).first.model_class.should == People::Actor
       end
-
     end
 
   end