cucumber_factory 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: baa05dc176d4705c737b2ad4f7257f01f0da4d0e07aae0513acc8248c7577550
-  data.tar.gz: 68ff25b1099b7eabb458e60e9cb95e8edb8ec7051befdd2c493353b7c23ef0f1
+  metadata.gz: 95567d71e09afa59f6db5bb2722ce78eb234b473987025ca3f66b6e181cdac1e
+  data.tar.gz: 7b1e046852657282cb2d5b65b714d12bb65c848196c0d6c70c13f3ce231fc684
 SHA512:
-  metadata.gz: 4ca06816ddcc668384556e40eef5466bb231dc9c4c458bb277f7296fd715d32e73d70af414d2e8c2cc8a9e5bd6157d59ec99c9e93ca737c5a2b015bfb1c82970
-  data.tar.gz: 293eabcf22252aca840ca43800d24f9e75a5a4cbf20aa6efbcfa52051782e2f3c5c6286166fc44c56decaad247972d7d487cc0fe08f7661527512ce2c80da7d9
+  metadata.gz: '083f2675e4b6592ab9ee117b5080fefdeaa06f27abba833f3145b176834f37baf3e40f4ef74e90b9d91558f1034b50c7c6250d2675caeda98d52b8a794d27142'
+  data.tar.gz: 392e4121dc98584c1928f2e028964780f079a4a0f74d437fb6595dc6d2b9ecbbb090e9eb97f0361f9fa1059c633fb8a9de8f357d986ad0a3bd5e193e79c20bae

data/CHANGELOG.md

@@ -15,6 +15,23 @@ 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

data/Gemfile.cucumber-1.3.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cucumber_factory (2.1.1)
+    cucumber_factory (2.2.0)
       activerecord
       activesupport
       cucumber

data/Gemfile.cucumber-2.4.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cucumber_factory (2.1.1)
+    cucumber_factory (2.2.0)
       activerecord
       activesupport
       cucumber

data/Gemfile.cucumber-3.0.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cucumber_factory (2.1.1)
+    cucumber_factory (2.2.0)
       activerecord
       activesupport
       cucumber

data/Gemfile.cucumber-3.1.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cucumber_factory (2.1.1)
+    cucumber_factory (2.2.0)
       activerecord
       activesupport
       cucumber

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,6 +76,14 @@ Given there is a movie with these attributes:
   | comedy | false    |
 ```
 
+```cucumber
+Given the movie above has these attributes:
+  """
+  name: Sunshine
+  comedy: false
+  """
+```
+
 Setting associations
 --------------------
 

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

@@ -22,6 +22,10 @@ module CucumberFactory
         [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)
@@ -85,7 +89,7 @@ module CucumberFactory
       end
 
       def alternative_strategy(model_prose, variants)
-        model_class = underscored_model_name(model_prose).camelize.constantize
+        model_class = parse_model_class(model_prose)
         machinist_strategy(model_class, variants) ||
           active_record_strategy(model_class) ||
           ruby_object_strategy(model_class)

data/lib/cucumber_factory/factory.rb

@@ -2,11 +2,14 @@ module CucumberFactory
   module Factory
     class Error < StandardError; end
 
-    ATTRIBUTES_PATTERN = '( with the .+?)?( (?:which|who|that) is .+?)?'
+    ATTRIBUTES_PATTERN = '( with the .+?)?( (?:which|who|that) is .+?)?' # ... with the year 1979 which is science fiction
     TEXT_ATTRIBUTES_PATTERN = ' (?:with|and) these attributes:'
+    UPDATE_ATTR_PATTERN = '(?: (?:has|belongs to)( the .+?))?(?:(?: and| but|,)*( is .+?))?' # ... belongs to the collection "Fantasy" and is trending
+    TEXT_UPDATE_ATTR_PATTERN = '(?: and|,)* has these attributes:'
 
-    RECORD_PATTERN = 'there is an? (.+?)( \(.+?\))?'
-    NAMED_RECORD_PATTERN = '(?:"([^\"]*)"|\'([^\']*)\') is an? (.+?)( \(.+?\))?'
+    RECORD_PATTERN = 'there is an? (.+?)( \(.+?\))?' # Given there is a movie (comedy)
+    NAMED_RECORD_PATTERN = '(?:"([^\"]*)"|\'([^\']*)\') is an? (.+?)( \(.+?\))?' # Given "LotR" is a movie
+    RECORD_UPDATE_PATTERN = 'the (.+?) (above|".+?"|\'.+?\')' # Given the movie "LotR" ...
 
     NAMED_RECORDS_VARIABLE = :'@named_cucumber_factory_records'
 
@@ -39,6 +42,12 @@ module CucumberFactory
       :block => lambda { |a1, a2, a3, a4| CucumberFactory::Factory.send(:parse_creation, self, a1, a2, a3, a4) }
     }
 
+    UPDATE_STEP_DESCRIPTOR = {
+      :kind => :And,
+      :pattern => /^#{RECORD_UPDATE_PATTERN}#{UPDATE_ATTR_PATTERN}$/,
+      :block => lambda { |a1, a2, a3, a4| CucumberFactory::Factory.send(:parse_update, self, a1, a2, a3, a4) }
+    }
+
     NAMED_CREATION_STEP_DESCRIPTOR_WITH_TEXT_ATTRIBUTES = {
       :kind => :Given,
       :pattern => /^#{NAMED_RECORD_PATTERN}#{ATTRIBUTES_PATTERN}#{TEXT_ATTRIBUTES_PATTERN}?$/,
@@ -53,6 +62,13 @@ module CucumberFactory
       :priority => true
     }
 
+    UPDATE_STEP_DESCRIPTOR_WITH_TEXT_ATTRIBUTES = {
+      :kind => :And,
+      :pattern => /^#{RECORD_UPDATE_PATTERN}#{UPDATE_ATTR_PATTERN}#{TEXT_UPDATE_ATTR_PATTERN}$/,
+      :block => lambda { |a1, a2, a3, a4, a5| CucumberFactory::Factory.send(:parse_update, self, a1, a2, a3, a4, a5) },
+      :priority => true
+    }
+
     class << self
 
       def add_steps(main)
@@ -61,6 +77,8 @@ module CucumberFactory
         add_step(main, CREATION_STEP_DESCRIPTOR_WITH_TEXT_ATTRIBUTES)
         add_step(main, NAMED_CREATION_STEP_DESCRIPTOR_WITH_TEXT_ATTRIBUTES)
         add_step(main, CLEAR_NAMED_RECORDS_STEP_DESCRIPTOR)
+        add_step(main, UPDATE_STEP_DESCRIPTOR)
+        add_step(main, UPDATE_STEP_DESCRIPTOR_WITH_TEXT_ATTRIBUTES)
       end
 
       private
@@ -100,8 +118,24 @@ module CucumberFactory
       end
 
       def parse_creation(world, raw_model, raw_variant, raw_attributes, raw_boolean_attributes, raw_multiline_attributes = nil)
-        build_strategy, transient_attributes = BuildStrategy.from_prose(raw_model, raw_variant)
+        build_strategy, transient_attributes = CucumberFactory::BuildStrategy.from_prose(raw_model, raw_variant)
         model_class = build_strategy.model_class
+        attributes = parse_attributes(world, model_class, raw_attributes, raw_boolean_attributes, raw_multiline_attributes, transient_attributes)
+        record = build_strategy.create_record(attributes)
+        remember_record_names(world, record, attributes)
+        record
+      end
+
+      def parse_update(world, raw_model, raw_name, raw_attributes, raw_boolean_attributes, raw_multiline_attributes = nil)
+        model_class = CucumberFactory::BuildStrategy.parse_model_class(raw_model)
+        attributes = parse_attributes(world, model_class, raw_attributes, raw_boolean_attributes, raw_multiline_attributes)
+        record = resolve_associated_value(world, model_class, model_class, model_class, raw_name)
+        CucumberFactory::UpdateStrategy.new(record).assign_attributes(attributes)
+        remember_record_names(world, record, attributes)
+        record
+      end
+
+      def parse_attributes(world, model_class, raw_attributes, raw_boolean_attributes, raw_multiline_attributes = nil, transient_attributes = [])
         attributes = {}
         if raw_attributes.try(:strip).present?
           raw_attribute_fragment_regex = /(?:the |and |with |but |,| )+(.*?) (#{VALUE_SCALAR}|#{VALUE_ARRAY}|#{VALUE_LAST_RECORD})/
@@ -140,33 +174,19 @@ module CucumberFactory
             end
           end
         end
-        record = build_strategy.create_record(attributes)
-        remember_record_names(world, record, attributes)
-        record
+        attributes
       end
 
       def attribute_value(world, model_class, transient_attributes, attribute, value)
         associated, association_class = resolve_association(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, transient_attributes, attribute, v) }
+        value = if matches_fully?(value, VALUE_ARRAY)
+          array_values = unquote(value).scan(VALUE_SCALAR)
+          array_values.map { |v| attribute_value(world, model_class, transient_attributes, attribute, v) }
         elsif associated
-          if matches_fully?(value, VALUE_LAST_RECORD)
-            raise(Error, "Cannot set last #{model_class}##{attribute} for polymorphic associations") unless association_class.present?
-
-            value = CucumberFactory::Switcher.find_last(association_class) || 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)
-          elsif matches_fully?(value, VALUE_INTEGER)
-            value = value.to_s
-            value = get_named_record(world, value) || transform_value(world, value)
-          else
-            raise Error, "Cannot set association #{model_class}##{attribute} to #{value}."
-          end
+          resolve_associated_value(world, model_class, association_class, attribute, value)
         else
-          value = resolve_scalar_value(world, model_class, attribute, value)
+          resolve_scalar_value(world, model_class, attribute, value)
         end
         value
       end
@@ -192,6 +212,22 @@ module CucumberFactory
         [associated, association_class]
       end
 
+      def resolve_associated_value(world, model_class, association_class, attribute, value)
+        if matches_fully?(value, VALUE_LAST_RECORD)
+          raise(Error, "Cannot set last #{model_class}##{attribute} for polymorphic associations") unless association_class.present?
+
+          CucumberFactory::Switcher.find_last(association_class) || raise(Error, "There is no last #{attribute}")
+        elsif matches_fully?(value, VALUE_STRING)
+          value = unquote(value)
+          get_named_record(world, value) || transform_value(world, value)
+        elsif matches_fully?(value, VALUE_INTEGER)
+          value = value.to_s
+          get_named_record(world, value) || transform_value(world, value)
+        else
+          raise Error, "Cannot set association #{model_class}##{attribute} to #{value}."
+        end
+      end
+
       def resolve_scalar_value(world, model_class, attribute, value)
         if matches_fully?(value, VALUE_STRING)
           value = unquote(value)

data/lib/cucumber_factory/update_strategy.rb

@@ -0,0 +1,30 @@
+module CucumberFactory
+
+  class UpdateStrategy
+
+    def initialize(record)
+      @record = record
+    end
+
+    def assign_attributes(attributes)
+      active_record_strategy(attributes) ||
+        ruby_object_strategy(attributes)
+    end
+
+    private
+
+    def active_record_strategy(attributes)
+      return unless @record.respond_to?(:save!)
+
+      CucumberFactory::Switcher.assign_attributes(@record, attributes)
+      @record.save!
+    end
+
+    def ruby_object_strategy(attributes)
+      attributes.each do |name, value|
+        @record.send("#{name}=".to_sym, value)
+      end
+    end
+
+  end
+end

data/lib/cucumber_factory/version.rb

@@ -1,3 +1,3 @@
 module CucumberFactory
-  VERSION = '2.1.1'
+  VERSION = '2.2.0'
 end

data/spec/cucumber_factory/steps_spec.rb

@@ -111,7 +111,7 @@ describe 'steps provided by cucumber_factory' do
       payment.id.should == 2
     end
 
-    it "should allow to name records and set a belongs_to association to that record by refering to that name" do
+    it "should allow to name records and set a belongs_to association to that record by referring to that name" do
       invoke_cucumber_step('"Some Prequel" is a movie with the title "Before Sunrise"')
       invoke_cucumber_step('there is a movie with the title "Limitless"')
       invoke_cucumber_step('there is a movie with the title "Before Sunset" and the prequel "Some Prequel"')
@@ -120,7 +120,7 @@ describe 'steps provided by cucumber_factory' do
       movie.prequel.should == prequel
     end
 
-    it "should allow to set a belongs_to association to a previously created record by refering to any string attribute of that record" do
+    it "should allow to set a belongs_to association to a previously created record by referring to any string attribute of that record" do
       invoke_cucumber_step('there is a movie with the title "Before Sunrise"')
       invoke_cucumber_step('there is a movie with the title "Limitless"')
       invoke_cucumber_step('there is a movie with the title "Before Sunset" and the prequel "Before Sunrise"')
@@ -129,7 +129,17 @@ describe 'steps provided by cucumber_factory' do
       movie.prequel.should == prequel
     end
 
-    it "should allow to set a belongs_to association to a previously created record by refering to their explicitely set primary keys" do
+    it "should allow to set a belongs_to association to a previously updated record by referring to any string attribute used when updating" do
+      invoke_cucumber_step('there is a movie')
+      invoke_cucumber_step('the movie above has the title "Before Sunrise"')
+      invoke_cucumber_step('there is a movie with the title "Limitless"')
+      invoke_cucumber_step('there is a movie with the title "Before Sunset" and the prequel "Before Sunrise"')
+      movie = Movie.find_by_title!('Before Sunset')
+      prequel = Movie.find_by_title!('Before Sunrise')
+      movie.prequel.should == prequel
+    end
+
+    it "should allow to set a belongs_to association to a previously created record by referring to their explicitely set primary keys" do
       invoke_cucumber_step('there is a movie with the ID 123')
       invoke_cucumber_step('there is a movie with the title "Before Sunset" and the prequel 123')
       movie = Movie.find_by_title!('Before Sunset')
@@ -200,6 +210,15 @@ describe 'steps provided by cucumber_factory' do
       user.deleted.should == true
     end
 
+    it "should allow to name records and set a belongs_to association to that record by referring to that name" do
+      invoke_cucumber_step('"Some Prequel" is a movie with the title "Before Sunrise"')
+      invoke_cucumber_step('there is a movie with the title "Limitless"')
+      invoke_cucumber_step('there is a movie with the title "Before Sunset" and the prequel "Some Prequel"')
+      movie = Movie.find_by_title!('Before Sunset')
+      prequel = Movie.find_by_title!('Before Sunrise')
+      movie.prequel.should == prequel
+    end
+
     it "should allow to set positive boolean attributes with 'which' after the attribute list" do
       user = User.new
       User.stub(:new => user)
@@ -259,7 +278,7 @@ describe 'steps provided by cucumber_factory' do
       user.deleted.should == true
     end
 
-    it "should allow to set a has_many association by refering to multiple named records in square brackets" do
+    it "should allow to set a has_many association by referring to multiple named records in square brackets" do
       invoke_cucumber_step('there is a movie with the title "Sunshine"')
       invoke_cucumber_step('there is a movie with the title "Limitless"')
       invoke_cucumber_step('there is a user with the reviewed movies ["Sunshine" and "Limitless"]')
@@ -536,5 +555,54 @@ tags: ["foo", "bar"]
       lambda { invoke_cucumber_step("there is a machinist model with the attribute 'foo' and the ") }.should raise_error(ArgumentError, 'Unable to parse attributes " and the ".')
       lambda { invoke_cucumber_step("there is a machinist model with the attribute 'foo'. the other_attribute 'bar' and the third attribute 'baz'") }.should raise_error(ArgumentError, 'Unable to parse attributes ".".')
     end
+
+    it "should allow to update the last record of a type" do
+      invoke_cucumber_step('there is a user with the name "Bar" and the email "foo@example.com" who is not subscribed')
+      invoke_cucumber_step('the user above has the name "Baz", the email "foobar@example.com", and is subscribed')
+      user = User.last
+      user.name.should == 'Baz'
+      user.email.should == 'foobar@example.com'
+      user.subscribed.should == true
+    end
+
+    it "should be able to update a record with a given name" do
+      invoke_cucumber_step('"Foo" is a user with the name "Bar"')
+      invoke_cucumber_step('the user "Foo" has the email "foo@example.com"')
+      invoke_cucumber_step("the user 'Foo' is subscribed")
+      user = User.last
+      user.name.should == 'Bar'
+      user.email.should == 'foo@example.com'
+      user.subscribed.should == true
+    end
+
+    it "should be able to update a record with a Cucumber table expression" do
+      invoke_cucumber_step('"Foo" is a user with the name "Bar"')
+      invoke_cucumber_step('the user above has these attributes:', nil, <<-DATA_TABLE)
+| name   | Jane |
+| locked | true |
+      DATA_TABLE
+      user = User.last
+      user.name.should == "Jane"
+      user.locked.should == true
+    end
+
+    it "should allow to update a record via additional data table" do
+      invoke_cucumber_step('"Foo" is a user with the name "Bar"')
+      invoke_cucumber_step('the user above has the email "test@invalid.com", is subscribed, and has these attributes:', nil, <<-DATA_TABLE)
+| name | Jane |
+      DATA_TABLE
+      user = User.last
+      user.name.should == "Jane"
+      user.email.should == "test@invalid.com"
+      user.subscribed.should == true
+    end
+
+    it "should allow to update an association" do
+      invoke_cucumber_step('there is a movie with the title "Before Sunrise"')
+      invoke_cucumber_step('there is a user with the name "John"')
+      invoke_cucumber_step('the movie above has the reviewer above')
+      movie = Movie.last
+      movie.reviewer.name.should == "John"
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cucumber_factory
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Henning Koch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-20 00:00:00.000000000 Z
+date: 2020-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -97,6 +97,7 @@ files:
 - lib/cucumber_factory/build_strategy.rb
 - lib/cucumber_factory/factory.rb
 - lib/cucumber_factory/switcher.rb
+- lib/cucumber_factory/update_strategy.rb
 - lib/cucumber_factory/version.rb
 - spec/cucumber_factory/factory/build_strategy_spec.rb
 - spec/cucumber_factory/steps_spec.rb