cucumber_factory 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 856fe1922e3b069b305e514911da87b4432acc34c89105b46cbf06d6cdd997be
-  data.tar.gz: a0f9631996850758343f66f79d96d88a1cf0216c4df464a8132677d462766525
+  metadata.gz: 95567d71e09afa59f6db5bb2722ce78eb234b473987025ca3f66b6e181cdac1e
+  data.tar.gz: 7b1e046852657282cb2d5b65b714d12bb65c848196c0d6c70c13f3ce231fc684
 SHA512:
-  metadata.gz: 31d7825ded3ed0ed9e9c29a490ecbff0028b710cb4f33bddbf1e3846a744444c9ae53a852b37db72284a57f4ef40515e166f8043dbf4d96db5412205a7f3b3c0
-  data.tar.gz: 71ede7f9b7ae86335fb3eb1cd27ff9c72bd9ec9fbd958585fe4293443c7b6608b3cd0c21ea994971946ac69091722eb2a27714492d34a5e792583068c412b666
+  metadata.gz: '083f2675e4b6592ab9ee117b5080fefdeaa06f27abba833f3145b176834f37baf3e40f4ef74e90b9d91558f1034b50c7c6250d2675caeda98d52b8a794d27142'
+  data.tar.gz: 392e4121dc98584c1928f2e028964780f079a4a0f74d437fb6595dc6d2b9ecbbb090e9eb97f0361f9fa1059c633fb8a9de8f357d986ad0a3bd5e193e79c20bae

data/.travis.yml

@@ -1,5 +1,4 @@
 rvm:
-  - 1.8.7
   - 2.1.10
   - 2.5.3
 
@@ -13,20 +12,10 @@ dist: trusty
 
 matrix:
   exclude:
-    - gemfile: Gemfile.cucumber-3.1
-      rvm: 1.8.7
     - gemfile: Gemfile.cucumber-3.1
       rvm: 2.1.10 # cucumber 3 wants ruby >= 2.2
-    - gemfile: Gemfile.cucumber-3.0
-      rvm: 1.8.7
     - gemfile: Gemfile.cucumber-3.0
       rvm: 2.1.10 # cucumber 3 wants ruby >= 2.2
-    - gemfile: Gemfile.cucumber-2.4
-      rvm: 1.8.7
-    - gemfile: Gemfile.cucumber-1.3
-      rvm: 2.5.3 # doesn't work with old RSpec
-    - gemfile: Gemfile.cucumber-1.3
-      rvm: 2.1.10 # doesn't work with old RSpec
 
 install:
   # Replace default Travis CI bundler script with a version that doesn't

data/CHANGELOG.md

@@ -15,6 +15,57 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 
 -
 
+## 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
+
+- Removed development and test support for Ruby 1.8. Closes #32.
+
+## 2.0.1 - 2020-02-27
+
+### Compatible changes
+
+- Fix a bug that prevented created records to be named when using multiline attribute assignments
+  ```
+  Given "Bob" is a user with these attributes:
+    | email | foo@bar.com     |
+  ```
+
 ## 2.0.0 - 2020-02-10
 
 ### Breaking changes

data/Gemfile.cucumber-1.3

@@ -2,16 +2,18 @@ source 'https://rubygems.org'
 
 # Runtime dependencies
 gem 'cucumber', '~> 1.3.20'
-gem 'activesupport', '~> 2.3.0'
-gem 'activerecord', '~> 2.3.0'
-gem 'mysql2', '= 0.2.20'
-gem 'i18n', '=0.6.11' # 0.7 no longer builds for Ruby 1.8.7
+gem 'activesupport', '~> 4.2.0'
+gem 'activerecord', '~> 4.2.0'
+gem 'mysql2'
 
 # Development dependencies
-gem 'rspec', '~> 1.0'
-gem 'rake', '=10.0.4'
+gem 'rspec', '> 3.0'
+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 (1.15.0)
+    cucumber_factory (2.2.0)
       activerecord
       activesupport
       cucumber
@@ -10,10 +10,21 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activerecord (2.3.18)
-      activesupport (= 2.3.18)
-    activesupport (2.3.18)
-    builder (3.2.2)
+    activemodel (4.2.11.1)
+      activesupport (= 4.2.11.1)
+      builder (~> 3.1)
+    activerecord (4.2.11.1)
+      activemodel (= 4.2.11.1)
+      activesupport (= 4.2.11.1)
+      arel (~> 6.0)
+    activesupport (4.2.11.1)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.4)
+    builder (3.2.4)
+    concurrent-ruby (1.1.6)
     cucumber (1.3.20)
       builder (>= 2.1.2)
       diff-lcs (>= 1.1.3)
@@ -23,31 +34,50 @@ GEM
     cucumber_priority (0.3.2)
       cucumber
     database_cleaner (1.0.1)
-    diff-lcs (1.2.5)
-    gemika (0.3.2)
+    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.6.11)
-    multi_json (1.11.2)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    minitest (5.12.0)
+    multi_json (1.14.1)
     multi_test (0.1.2)
-    mysql2 (0.2.20)
-    rake (10.0.4)
-    rspec (1.3.2)
+    mysql2 (0.5.3)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activerecord (~> 2.3.0)
-  activesupport (~> 2.3.0)
+  activerecord (~> 4.2.0)
+  activesupport (~> 4.2.0)
   cucumber (~> 1.3.20)
   cucumber_factory!
   database_cleaner (~> 1.0.0)
+  factory_bot (< 5)
   gemika
-  i18n (= 0.6.11)
-  mysql2 (= 0.2.20)
-  rake (= 10.0.4)
-  rspec (~> 1.0)
+  mysql2
+  rake (>= 10.0.4)
+  rspec (> 3.0)
 
 BUNDLED WITH
-   1.17.1
+   1.17.3

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.0)
+    cucumber_factory (2.2.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.0)
+    cucumber_factory (2.2.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.0)
+    cucumber_factory (2.2.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

@@ -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"

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