cucumber_factory 2.0.2 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eeed19e5c878629c3f87a038821a955401c40c19ca323577d7e84e3ae019f764
-  data.tar.gz: 2d3b57e9b739be6e69d28240c7553eec3882b2e200ca64c402a8cc646bcdc169
+  metadata.gz: 8f3cf136399f60bcca2308f17e39c1846de1e443157ac433bcdb94f6937a3333
+  data.tar.gz: 5983deb45accf5811e0af7f251a15f37062600c7decbf543a021b3338578a9bc
 SHA512:
-  metadata.gz: 752a2cbe68fa53254741a792770ab0252f320a218fb3c39fe85679bcf6d8e1289fdee354042bb342d96789266c6f8ac02819393ee375d628def84679de281cad
-  data.tar.gz: aa2eb84a898e7d52f10b7272ad8f7c04a9d1dea4096d0a7fab04d9158a887f46839e7d36b83f9aec945b13b18f0b4550de19fe9df0897ccc1235f22f990b2b59
+  metadata.gz: bb54944c1e92864af9cfcdaca67dfe3988577394907fce3c682b02ea900b50bc89d6d89eb6cdc3cdb90cfc89c199391e02dbfd50ef158ba46f0ccb2129ef8100
+  data.tar.gz: 9d90540b249f759377eb7cde97dc567fb61bada43f09c19ad6afaa73fff53e97acfd781ff8014515b9a0b04b8d8772663b8fc367cc9e743e9b61a26f1db839e9

data/.gitignore

@@ -6,3 +6,4 @@ pkg
 .rvmrc
 log/*.log
 spec/support/database.yml
+uploads/

data/CHANGELOG.md

@@ -13,6 +13,59 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 
 ### Compatible changes
 
+-
+
+## 2.3.1 - 2020-10-01
+
+### Compatible changes
+
+- Lowered the priority of all steps in this gem to avoid issues with overlapping steps.
+
+## 2.3.0 - 2020-09-24
+
+### Compatible changes
+
+- Added a step to add file objects to a model:
+  ```cucumber
+  Given there is a user with the avatar file:"path/to/avatar.jpg"
+  ```
+  Both single and double quotes are supported.
+
+## 2.2.0 - 2020-09-23
+
+### Compatible changes
+
+- A step was added that allows modifying existing records with a similar syntax to creating new records:
+  ```cucumber
+  (Given "Bob" is a user)
+    And "Bob" has the email "foo@bar.com" and is subscribed
+  ```
+  - This step will also work with doc strings or tables:
+  ```cucumber
+  (Given "Bob" is a user)
+    And the user above has these attributes:
+    | name  | Bob         |
+    | email | foo@bar.com | 
+  ```
+
+## 2.1.1 - 2020-05-20
+
+### Compatible changes
+
+- Cucumber 2.1.0 introduced some regressions which are being addressed with this patch:
+    - Fix the assignment of polymorphic associations.
+    - Restore the support for inherited traits within nested factories.
+
+## 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,9 @@ gem 'rake', '>=10.0.4'
 gem 'database_cleaner', '~>1.0.0'
 gem 'gemika'
 
+# Test dependencies
+gem 'factory_bot', '< 5'
+gem 'carrierwave', '~> 1.0'
+
 # 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.3.1)
       activerecord
       activesupport
       cucumber
@@ -24,6 +24,10 @@ GEM
       tzinfo (~> 1.1)
     arel (6.0.4)
     builder (3.2.4)
+    carrierwave (1.2.3)
+      activemodel (>= 4.0.0)
+      activesupport (>= 4.0.0)
+      mime-types (>= 1.16)
     concurrent-ruby (1.1.6)
     cucumber (1.3.20)
       builder (>= 2.1.2)
@@ -35,11 +39,16 @@ 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)
     i18n (0.9.5)
       concurrent-ruby (~> 1.0)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2018.0812)
     minitest (5.12.0)
     multi_json (1.14.1)
     multi_test (0.1.2)
@@ -68,9 +77,11 @@ PLATFORMS
 DEPENDENCIES
   activerecord (~> 4.2.0)
   activesupport (~> 4.2.0)
+  carrierwave (~> 1.0)
   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,9 @@ gem 'rake'
 gem 'database_cleaner'
 gem 'gemika'
 
+# Test dependencies
+gem 'factory_bot', '< 5' # 5.0 requires Ruby >= 2.3
+gem 'carrierwave', '~> 1.0' # 2.0 requires Rails >= 5 and Ruby >= 2.2
+
 # 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.3.1)
       activerecord
       activesupport
       cucumber
@@ -24,6 +24,10 @@ GEM
       tzinfo (~> 1.1)
     arel (6.0.4)
     builder (3.2.3)
+    carrierwave (1.2.3)
+      activemodel (>= 4.0.0)
+      activesupport (>= 4.0.0)
+      mime-types (>= 1.16)
     concurrent-ruby (1.0.5)
     cucumber (2.4.0)
       builder (>= 2.1.2)
@@ -40,10 +44,15 @@ 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)
       concurrent-ruby (~> 1.0)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2018.0812)
     minitest (5.11.3)
     multi_json (1.13.1)
     multi_test (0.1.2)
@@ -72,9 +81,11 @@ PLATFORMS
 DEPENDENCIES
   activerecord (~> 4.2.0)
   activesupport (~> 4.2.0)
+  carrierwave (~> 1.0)
   cucumber (~> 2.4.0)
   cucumber_factory!
   database_cleaner
+  factory_bot (< 5)
   gemika
   mysql2
   rake

data/Gemfile.cucumber-3.0

@@ -12,5 +12,9 @@ gem 'rake'
 gem 'database_cleaner'
 gem 'gemika'
 
+# Test dependencies
+gem 'factory_bot'
+gem 'carrierwave'
+
 # 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.3.1)
       activerecord
       activesupport
       cucumber
@@ -24,6 +24,10 @@ GEM
     arel (7.1.4)
     backports (3.11.1)
     builder (3.2.3)
+    carrierwave (1.2.3)
+      activemodel (>= 4.0.0)
+      activesupport (>= 4.0.0)
+      mime-types (>= 1.16)
     concurrent-ruby (1.0.5)
     cucumber (3.0.2)
       builder (>= 2.1.2)
@@ -45,10 +49,15 @@ 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)
       concurrent-ruby (~> 1.0)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2018.0812)
     minitest (5.11.3)
     multi_json (1.13.1)
     multi_test (0.1.2)
@@ -77,9 +86,11 @@ PLATFORMS
 DEPENDENCIES
   activerecord (~> 5.0.0)
   activesupport (~> 5.0.0)
+  carrierwave
   cucumber (~> 3.0.0)
   cucumber_factory!
   database_cleaner
+  factory_bot
   gemika
   mysql2
   rake

data/Gemfile.cucumber-3.1

@@ -12,5 +12,9 @@ gem 'rake'
 gem 'database_cleaner'
 gem 'gemika'
 
+# Test dependencies
+gem 'factory_bot'
+gem 'carrierwave'
+
 # 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.3.1)
       activerecord
       activesupport
       cucumber
@@ -24,6 +24,10 @@ GEM
     arel (8.0.0)
     backports (3.11.1)
     builder (3.2.3)
+    carrierwave (1.2.3)
+      activemodel (>= 4.0.0)
+      activesupport (>= 4.0.0)
+      mime-types (>= 1.16)
     concurrent-ruby (1.0.5)
     cucumber (3.1.0)
       builder (>= 2.1.2)
@@ -45,10 +49,15 @@ 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)
       concurrent-ruby (~> 1.0)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2018.0812)
     minitest (5.11.3)
     multi_json (1.13.1)
     multi_test (0.1.2)
@@ -77,9 +86,11 @@ PLATFORMS
 DEPENDENCIES
   activerecord (~> 5.1.0)
   activesupport (~> 5.1.0)
+  carrierwave
   cucumber (~> 3.1.0)
   cucumber_factory!
   database_cleaner
+  factory_bot
   gemika
   mysql2
   rake

data/README.md

@@ -24,6 +24,13 @@ Quoted strings and numbers denote attribute values:
 Given there is a movie with the title "Sunshine" and the year 2007
 ```
 
+To update an existing record, specify the record and the changes:
+```
+Given the movie above has the title "Sunset" and the year 2008
+Given the movie "Sunrise" has the year 2009
+```
+A record can be specified by the `above` keyword, which uses the last created record of this class, or by any string that was used during its creation.
+
 Setting boolean attributes
 --------------------------
 
@@ -42,6 +49,13 @@ Given there is a movie which is awesome, popular and successful but not science
 And there is a director with the income "500000" but with the account balance "-30000"
 ```
 
+To update boolean attributes use the keyword `is`:
+
+```cucumber
+Given the movie above is awesome but not popular
+Given the movie above has the year 1979 but is not science fiction
+```
+
 
 Setting many attributes with a table
 ------------------------------------
@@ -62,10 +76,18 @@ Given there is a movie with these attributes:
   | comedy | false    |
 ```
 
+```cucumber
+Given the movie above has these attributes:
+  """
+  name: Sunshine
+  comedy: false
+  """
+```
+
 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"
@@ -129,7 +151,16 @@ Given there is a movie with the tags ["comedy", "drama" and "action"]
 ```
 
 
+Setting file attributes
+-----------------------
+
+You can set an attribute to a file object with the following syntax:
+
+```cucumber
+Given there is a movie with the image file:'path/to/image.jpg'
+```
 
+All paths are relative to the project root, absolute paths are not supported. Please note that file attributes must follow the syntax `file:"PATH"`, both single and double quotes are allowed.
 
 Using named factories and traits
 --------------------------------

data/lib/cucumber_factory.rb

@@ -13,6 +13,7 @@ require 'cucumber_priority'
 
 # Gem
 require 'cucumber_factory/build_strategy'
+require 'cucumber_factory/update_strategy'
 require 'cucumber_factory/factory'
 require 'cucumber_factory/switcher'
 

data/lib/cucumber_factory/build_strategy.rb

@@ -7,79 +7,115 @@ 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
+          factory.compile # Required to load inherited traits!
+          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
+
+      def parse_model_class(model_prose)
+        underscored_model_name(model_prose).camelize.constantize
+      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 = factory_class.factories[factory_name]
+        factory
+      end
 
-        if factory.nil? && variants.present? && factory = factory_class.factories[variants[0]]
+      def factory_bot_strategy(factory, model_prose, variants)
+        return unless factory
+
+        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 = parse_model_class(model_prose)
+        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 +125,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