screengem 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f613d52a7f2c21395da3ae69ec06038fd8b0c77b5534fdb6589bd17869787b6
-  data.tar.gz: 20789cb799e7b7480f22d45537448fe805a17f42c123887598f9d08efab6b55e
+  metadata.gz: accc4cf6330e69e04fb0c2ccf8aded873f0cdd6ca7f548f4d15a0acb3d4f1f7d
+  data.tar.gz: 68c1c36c5b7763557719751f4e58f5890054e79c09d8fc9fe9cc6dc01fd3a45e
 SHA512:
-  metadata.gz: 03ed64caa475c19be70ffb9b9fbf7e5fcef24b6ec9c8ce09b176d8d93ef96dd8d29b08353c3102b91707800dfd3e1c6275fdf3ed2a1debb865be3748cf685714
-  data.tar.gz: 03d28f961b96b2c87d60700ec2e857d8a55bc79fed093025b3b3bcf2f296f15ec3d91ae753daf9b87545aba180151eb16e156a0e3d9c42717945c1fffa9ba3ba
+  metadata.gz: ca06a1fb1c48d88a12b93f56da624dc082535af69608be82b2547fe9da6f4799724cc2294a7fde8db9ef242ccc7374698c05e5f1c97aeeaf921d89ad2a03e245
+  data.tar.gz: 6f9ac792ef8b6538a2e1d4829a6ff9d7ad43c33f8bfc45a70ec325f1a03cc1ec0a13ebbdca1820193e82f5512cb2d4fdaf41968756d5cfd926e4165828c28827

data/CHANGELOG.md

@@ -2,7 +2,11 @@
 
 ## master (unreleased)
 
-## 0.8.1 (2019-09-20)
+## 0.9.0 (2019-09-25)
+
+* Support for actor memory outside actor instances (support ParameterType actors)
+
+## 0.8.1 (2019-08-20)
 
 * Support for Rails 6 (only ActiveSupport)
 * Latest development dependencies

data/README.md

@@ -8,11 +8,11 @@ and the questions that the actor asks.
 ## Example Step Definitions
 
 ```ruby
-Given(/^that they are signed in and viewing the (.+?)$/) do |section_name|
+Given("that they are signed in and viewing the {section_name}") do |section_name|
   actor.performs(task.sign_in, task.remember_signature_counter(section_name))
 end
 
-Then(/^their signature is captured$/) do
+Then("their signature is captured") do
   actor.asks(question.signature_captured)
 end
 ```
@@ -28,12 +28,16 @@ A Task responds to perform and may execute one or more actions.
 
 ![Core Domain Model](/images/ScreengemCore.png)
 
-## Installation
+## Actor Memory
 
-Add this line to your application's Gemfile:
+Actors are able to remember and recall facts. This is the recommended way to
+pass state between steps. To clear all actor's memory before each scenario
+add a hook: 
 
-```ruby
-gem 'screengem'
+```
+Before do
+  Screengem::ActorMemory.instance.clear
+end
 ```
 
 ## Dampening
@@ -49,6 +53,14 @@ To enable and configure dampening perform the following steps:
 
 To stop dampening, run `unset APPLY_DAMPENING`
 
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'screengem'
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -1,6 +1,8 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "rubocop/rake_task"
 
+RuboCop::RakeTask.new
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+task default: [:rubocop, :spec]

data/lib/screengem.rb

@@ -30,6 +30,7 @@ require "screengem/browser_action"
 require "screengem/question"
 require "screengem/task"
 
+require "screengem/actor_memory"
 require "screengem/actor"
 
 require "screengem/factories/factory_creation_error"

data/lib/screengem/actor.rb

@@ -86,7 +86,7 @@ module Screengem
     end
 
     def recollections
-      @recollections ||= ActiveSupport::HashWithIndifferentAccess.new
+      ActorMemory.instance.recollections(self)
     end
 
     def screen

data/lib/screengem/actor_memory.rb

@@ -0,0 +1,27 @@
+module Screengem
+  #
+  # Ensures that the memory/recollections that an actor uses are effectively global (using the actor name).
+  #
+  # This is required to use Cucumber ParameterTypes because the block arguments are cloned before they are
+  # provided to the step definitions. This is intentional by the cucumber team to prevent leaking state
+  # between step definitions. See https://github.com/cucumber/cucumber-ruby/issues/1275.
+  #
+  # The cloning of the actor means that is is effectively treated like a value object, and there will be
+  # many instances of the same actor instantiated in the execution of a single test.
+  #
+  class ActorMemory
+    include ::Singleton
+
+    def recollections(actor)
+      @recollections ||= ActiveSupport::HashWithIndifferentAccess.new
+      @recollections[actor.name] ||= ActiveSupport::HashWithIndifferentAccess.new
+    end
+
+    #
+    # Use this method to clear actor memory to avoid actor memory persisting across scenarios.
+    #
+    def clear
+      @recollections = ActiveSupport::HashWithIndifferentAccess.new
+    end
+  end
+end

data/lib/screengem/screen_elements.rb

@@ -29,7 +29,7 @@ module Screengem
 
         method_name = class_name.demodulize.underscore
 
-        # Create some safety by detecting and failing fast for duplicate creation method names
+        # Create some safety by detecting and failing fast for duplicate creation method names.
         if generated_method_names.include?(method_name)
           raise "Name collision: two screen elements resolve to '#{method_name}'."
         end

data/lib/screengem/version.rb

@@ -1,3 +1,3 @@
 module Screengem
-  VERSION = "0.8.1"
+  VERSION = "0.9.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: screengem
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Alistair McKinnell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-20 00:00:00.000000000 Z
+date: 2019-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -189,6 +189,7 @@ files:
 - lib/screengem.rb
 - lib/screengem/action.rb
 - lib/screengem/actor.rb
+- lib/screengem/actor_memory.rb
 - lib/screengem/automatic_visit.rb
 - lib/screengem/browser_action.rb
 - lib/screengem/cli.rb
@@ -239,7 +240,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Ruby implementation of the Screengem Pattern.