screengem 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4cd749e9d769dc9f60bd7f25b4e5a5d1ef571f7e677b8899e60186b5fec6c351
-  data.tar.gz: 229544036b8cb8fca593981f91f82915a22488ec16fcdf0d2d81604e3330fda2
+  metadata.gz: 59794b81ef61dfaac8b24ada31840f7b06bf10256b49a26d938409902a0733e2
+  data.tar.gz: 574b6278358edde4ffcfeda8426b0873949deee001162694045919a5ce2eb706
 SHA512:
-  metadata.gz: 4ede6cabff701aa9e0834bd0a430efa9d16b9b9b82fdfb427314e9e00fd5266e4f6955ad99632d336bdbf718f3739dd2ebdbdeb707119a3a0dda6b4fdd7df0bf
-  data.tar.gz: 3514009fa5061cc2f231c0a2cfff897277d3844d67bc1f051de85d6bce1d01426eac30793c739cf36be5fd9aec32c1da8e79bbeb6177a1930dc57fb88a4611dc
+  metadata.gz: a2a37e7c2235866deae4b2462a073735fadb47d48ed187080541169a10b05cfb3445db06bc7740b247e0a27a738216342d33e507ec281eb0b15b01c59264b2a7
+  data.tar.gz: 7f361d7e3a584863de72b8fb52964a1194981826a1a6249b6fe5270cddaa65a4ab28c67523682cdd5785eab19d483484969c4f8f68b5e25f609c585e78fa4033

data/.rspec

@@ -1,3 +1,4 @@
 --format documentation
 --color
---require spec_helper
+--require screengem_spec_helper
+

data/.rubocop.yml

@@ -15,6 +15,9 @@ Metrics/MethodLength:
 RSpec/AnyInstance:
   Enabled: false
 
+RSpec/DescribedClass:
+  Enabled: false
+
 RSpec/ExampleLength:
   Max: 20
 

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## master (unreleased)
 
+## 0.3.0 (2019-03-16)
+
+### New Features
+
+* Scope screen elements to the `screen` instance variable
+* Screen elements are no longer memoized
+* Add example step definitions to the README
+
 ## 0.2.0 (2019-03-12)
 
 ### New features

data/README.md

@@ -2,12 +2,19 @@
 
 A simple Ruby implementation of the [Screenplay Pattern](https://ideas.riverglide.com/page-objects-refactored-12ec3541990). 
 
-## Installation
+Screengem promotes writing step definitions in terms of actors, the tasks that the actor performs, 
+and the questions that the actor asks. 
 
-Add this line to your application's Gemfile:
+## Example Step Definitions
 
 ```ruby
-gem 'screengem'
+Given(/^that they are signed in and viewing the (.+?)$/) do |section_name|
+  actor.performs(task.sign_in, task.remember_signature_counter(section_name))
+end
+
+Then(/^their signature is captured$/) do
+  actor.asks(question.signature_captured)
+end
 ```
 
 ## Core Domain Model
@@ -21,6 +28,14 @@ A Task responds to perform and may execute one or more actions.
 
 ![Core Domain Model](/images/ScreengemCore.png)
 
+## 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/lib/screengem/actor.rb

@@ -8,8 +8,9 @@ module Screengem
   # The ability to remember and recall values is used to carry state forward from one
   # step definition to another (as the preferred alternative to instance variables).
   #
-  # Action, question, and task instances are extended with PageReferences so that
-  # they can interact with the application via page objects.
+  # Action, question, and task instances (aka primitives) are configured with:
+  #   (1) a reference to the actor that is interacting with the primitive
+  #   (2) a reference to the screen instance that hosts accessors to the page objects.
   #
   module Actor
     #
@@ -17,7 +18,7 @@ module Screengem
     #
     def asks(*questions)
       questions.each do |question|
-        question.configure(self).extend(page_references)
+        question.configure(self, screen)
 
         next if question.answer
 
@@ -32,7 +33,7 @@ module Screengem
     #
     def performs(*tasks)
       tasks.each do |task|
-        task.configure(self).extend(page_references)
+        task.configure(self, screen)
 
         task.perform
       end
@@ -63,7 +64,7 @@ module Screengem
     #
     def takes_action(*actions)
       actions.each do |action|
-        action.configure(self).extend(page_references)
+        action.configure(self, screen)
 
         action.execute
       end
@@ -75,12 +76,12 @@ module Screengem
       Screengem::IncorrectAnswer.new(question)
     end
 
-    def page_references
-      @page_references ||= Screengem::PageReferences
-    end
-
     def recollections
       @recollections ||= ActiveSupport::HashWithIndifferentAccess.new
     end
+
+    def screen
+      Screengem::PageReferences.instance
+    end
   end
 end

data/lib/screengem/concerns/configurable.rb

@@ -1,16 +1,17 @@
 module Screengem
   #
-  # Concern that adds ability to configure with an actor instance.
+  # Concern that adds ability to configure a primitive with an actor and screen instance.
   #
   module Configurable
     extend ActiveSupport::Concern
 
     included do
-      attr_reader :actor
+      attr_reader :actor, :screen
     end
 
-    def configure(actor)
+    def configure(actor, screen)
       @actor = actor
+      @screen = screen
 
       self
     end

data/lib/screengem/page_references.rb

@@ -1,23 +1,17 @@
 module Screengem
   #
-  # Mixin that gives the ability to get references to page objects.
+  # Singleton that gives the ability to get references to page objects.
   #
+  # On initialization generate a factory method for each page object we can find. Example:
+  #
+  #   def login_page
+  #     Pages::LoginPage.new
+  #   end
+  #
+  class PageReferences
+    include Singleton
 
-  # rubocop:disable Style/GuardClause
-  module PageReferences
-    def self.extended(_mod)
-      # One time definition of the page object references.
-      return unless PageReferences.instance_methods.empty?
-
-      #
-      # Generate a factory method for each page object we can find.
-      #
-      # Example:
-      #
-      #   def login_page
-      #     @login_page ||= Pages::LoginPage.new
-      #   end
-      #
+    def initialize
       generated_method_names = []
 
       Screengem::FeaturePage.descendants.each do |page_object|
@@ -26,17 +20,16 @@ module Screengem
 
         if generated_method_names.include?(method_name)
           raise "Name collision: two page objects resolve to '#{method_name}'."
-        else
-          generated_method_names << method_name
         end
 
-        module_eval(<<~RUBY, __FILE__, __LINE__ + 1)
-          def #{method_name}
-            @#{method_name} ||= #{class_name}.new
+        generated_method_names << method_name
+
+        class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
+          def #{method_name}(*args)
+            #{class_name}.new(*args)
           end
         RUBY
       end
     end
   end
-  # rubocop:enable Style/GuardClause
 end

data/lib/screengem/version.rb

@@ -1,3 +1,3 @@
 module Screengem
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/screengem.gemspec

@@ -35,6 +35,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "rspec", "~> 3.8"
-  spec.add_development_dependency "rubocop", "~> 0.64"
+  spec.add_development_dependency "rubocop", "~> 0.65"
   spec.add_development_dependency "rubocop-rspec", "~> 1.32"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: screengem
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Alistair McKinnell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-12 00:00:00.000000000 Z
+date: 2019-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -112,14 +112,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.64'
+        version: '0.65'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.64'
+        version: '0.65'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement