screengem 0.9.1 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6fdea9053a69b15255d54d9a1a3ae9cf34fe0973ef857dd17c12d023ba00eb4
-  data.tar.gz: bff48e6b9db7aa91e0beaf5400002f82f797fa6246d926c769ecdcc697ab06a5
+  metadata.gz: ac2f7d84aaffa8c289ae50df7e43bbb0c383fd484f0189b164506f0b1a179c15
+  data.tar.gz: 17052ca08f46778aa1b1af991f30fa6cf299a09a900432f9f9144a3feaba53aa
 SHA512:
-  metadata.gz: 1477cd2253855d1ddcf5d2e820c0419f5d2726b44c464507ea77557c4c73ecf5be8229921a79d44dece85883aea1a5c14a88f16ed647737516d7cfa35127af81
-  data.tar.gz: 7609872a5856218b3717f336d2bd9c3e92e9d087598d363eb8142def96067a4e42eb39f3aebfd30bb50e6b3fa3aff96c3d3ea143c359d64eabee1e42f4d9fbc3
+  metadata.gz: df490d4d6ebd176d35657c5b11d9e01aeb925adb86b4f0724c2d43615c3a72976512666e7bebedb1658de2428c6d2455f53bb9e5819d53f4d5be25e57b52b5d7
+  data.tar.gz: eb386240b263bdcf4366513165b3e123bc0f91604dd939d1f4b43cde2e961aca8f9f0abe76381e78db10dbc4245c71e9c0162c0e1e727eda89c5b1f93ce4d6c9

data/.rubocop.yml

@@ -1,5 +1,22 @@
 require: rubocop-rspec
 
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - spec/**/*_spec.rb
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: false
+
+Lint/RaiseException:
+  Enabled: false
+
+Lint/StructNewOverride:
+  Enabled: false
+
 Metrics/AbcSize:
   Enabled: false
 
@@ -15,6 +32,10 @@ Metrics/MethodLength:
 Metrics/ModuleLength:
   Enabled: false
 
+Naming/VariableNumber:
+  Enabled: true
+  EnforcedStyle: snake_case
+
 RSpec/AnyInstance:
   Enabled: false
 
@@ -24,6 +45,9 @@ RSpec/DescribedClass:
 RSpec/ExampleLength:
   Max: 20
 
+RSpec/MultipleMemoizedHelpers:
+  Max: 8
+
 RSpec/MultipleExpectations:
   Max: 5
 
@@ -36,9 +60,24 @@ RSpec/MessageSpies:
 RSpec/NotToNot:
   EnforcedStyle: to_not
 
+Style/ExponentialNotation:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: false
+
+Style/HashTransformKeys:
+  Enabled: false
+
+Style/HashTransformValues:
+  Enabled: false
+
 Style/Documentation:
   Enabled: false
 
+Style/DocumentDynamicEvalDefinition:
+  Enabled: false
+
 Style/EmptyMethod:
   Enabled: false
 

data/.ruby-version

@@ -1 +1 @@
-2.5.3
+2.7.3

data/CHANGELOG.md

@@ -2,6 +2,31 @@
 
 ## master (unreleased)
 
+## 0.13.0 (2021-06-13)
+
+* Relax the ActiveSupport dependency
+* Latest development dependencies
+
+## 0.12.0 (2021-01-27)
+
+* Relax the thor dependency
+* Latest development dependencies
+
+## 0.11.0 (2020-04-26)
+
+### Breaking Changes
+
+* Questions answer negatively by throwing an exception rather than returning false
+
+## 0.10.1 (2020-01-11)
+
+* Relax the thor dependency
+
+## 0.10.0 (2020-01-11)
+
+* Remove action abstraction
+* Latest development dependencies
+
 ## 0.9.1 (2019-10-22)
 
 * Relax the require_all dependency

data/README.md

@@ -24,15 +24,14 @@ An Actor is able to remember and recall key-value pairs.
 
 A Question responds to answer.
 
-A Task responds to perform and may execute one or more actions.
+A Task responds to perform.
 
 ![Core Domain Model](/images/ScreengemCore.png)
 
 ## Actor Memory
 
-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: 
+Actors are able to remember and recall facts. This is the recommended way to pass state
+between steps. To clear every actor's memory before each scenario add a hook:
 
 ```
 Before do
@@ -40,6 +39,20 @@ Before do
 end
 ```
 
+## Performing Tasks
+
+Actors are able to perform tasks. A task may be implemented by interacting with domain services,
+domain models, application databases, and the application via screen elements.
+
+Capybara is available to all screen elements and is the recommended way to interact with a browser.
+
+## Answering Questions
+
+Actors are able to answer questions. A question is considered to be answered affirmatively
+when no exception is thrown and negatively when an exception is thrown.
+
+[RSpec expectations](https://github.com/rspec/rspec-expectations) are available in all questions and are the recommended way to implement a question.
+
 ## Dampening
 
 It sometimes makes sense to slow down the automation. This is known as dampening.

data/lib/screengem.rb

@@ -8,7 +8,6 @@ require "capybara/dsl"
 require "rspec/expectations"
 
 require "screengem/automatic_visit"
-require "screengem/incorrect_answer"
 require "screengem/rails_routes"
 require "screengem/screen_element"
 require "screengem/screengem_error"
@@ -18,15 +17,12 @@ require "screengem/primitive_key"
 require "screengem/dampen_configuration"
 require "screengem/dampen_configuration_generator"
 
-require "screengem/concerns/actionable"
 require "screengem/concerns/configurable"
 require "screengem/concerns/dampenable"
 require "screengem/concerns/executable"
 
 require "screengem/dsl"
 
-require "screengem/action"
-require "screengem/browser_action"
 require "screengem/question"
 require "screengem/task"
 
@@ -35,9 +31,6 @@ require "screengem/actor"
 
 require "screengem/factories/factory_creation_error"
 
-require "screengem/factories/action_factory"
-require "screengem/factories/browser_action_factory"
-require "screengem/factories/standard_action_factory"
 require "screengem/factories/question_factory"
 require "screengem/factories/task_factory"
 

data/lib/screengem/actor.rb

@@ -1,14 +1,14 @@
 module Screengem
   #
-  # Mixin that allows an actor to perform tasks, ask questions, take actions, and
-  # to remember and recall tagged values.
+  # Mixin that allows an actor to perform tasks, ask questions, and to remember and
+  # recall tagged values.
   #
   # Return self for those methods that may be chained in the step definition DSL.
   #
   # 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 (aka primitives) are configured with:
+  # 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 screen elements.
   #
@@ -18,11 +18,7 @@ module Screengem
     #
     def asks(*questions)
       questions.each do |question|
-        question.configure(self, screen)
-
-        next if question.answer
-
-        raise incorrect_answer(question)
+        question.configure(self, screen).answer
       end
 
       self
@@ -33,9 +29,7 @@ module Screengem
     #
     def performs(*tasks)
       tasks.each do |task|
-        task.configure(self, screen)
-
-        task.perform
+        task.configure(self, screen).perform
       end
 
       self
@@ -66,25 +60,8 @@ module Screengem
       self
     end
 
-    #
-    # Used by an actor to take one or more actions.
-    #
-    # Used to implement tasks. Actions do not appear in step definitions.
-    #
-    def takes_action(*actions)
-      actions.each do |action|
-        action.configure(self, screen)
-
-        action.execute
-      end
-    end
-
     private
 
-    def incorrect_answer(question)
-      Screengem::IncorrectAnswer.new(question)
-    end
-
     def recollections
       ActorMemory.instance.recollections(self)
     end

data/lib/screengem/configuration.rb

@@ -25,12 +25,6 @@ module Screengem
     # A boolean that specifies that dampening is to be applied.
     attr_accessor :apply_dampening
 
-    # A boolean that specifies that browser actions are created (used by the ActionFactory).
-    attr_accessor :browser_actions
-
-    # A string that namespaces action classes (used by the ActionFactory).
-    attr_accessor :action_scope
-
     # A string that namespaces questions classes (used by the QuestionFactory).
     attr_accessor :question_scope
 
@@ -39,11 +33,9 @@ module Screengem
 
     def initialize
       self.apply_dampening = false
-      self.browser_actions = false
 
       self.dampen_configuration_root = "default"
 
-      self.action_scope = "Actions"
       self.question_scope = "Questions"
       self.task_scope = "Tasks"
     end
@@ -52,10 +44,6 @@ module Screengem
       apply_dampening
     end
 
-    def browser_actions?
-      browser_actions
-    end
-
     def dampen_configuration_sample_filename
       "#{dampen_configuration_filename}.sample"
     end

data/lib/screengem/factories/question_factory.rb

@@ -6,7 +6,7 @@ module Screengem
     class QuestionFactory < BasicObject
       include ::Singleton
 
-      def method_missing(question_name, *args) # rubocop:disable Style/MethodMissingSuper
+      def method_missing(question_name, *args)
         question_class_name = "#{question_name}_question".camelize
         question_class = "#{question_scope}::#{question_class_name}".constantize
 

data/lib/screengem/factories/task_factory.rb

@@ -6,7 +6,7 @@ module Screengem
     class TaskFactory < BasicObject
       include ::Singleton
 
-      def method_missing(task_name, *args) # rubocop:disable Style/MethodMissingSuper
+      def method_missing(task_name, *args)
         task_class_name = "#{task_name}_task".camelize
         task_class = "#{task_scope}::#{task_class_name}".constantize
 

data/lib/screengem/screen_elements.rb

@@ -22,11 +22,10 @@ module Screengem
       generated_method_names = []
 
       Screengem::ScreenElement.descendants.each do |screen_element_class|
-        class_name = screen_element_class.name
-
         # Skip any anonymous classes. We can't do anything with them. Probably they're from testing.
-        next if class_name.blank?
+        next if screen_element_class.anonymous?
 
+        class_name = screen_element_class.name
         method_name = class_name.demodulize.underscore
 
         # Create some safety by detecting and failing fast for duplicate creation method names.

data/lib/screengem/task.rb

@@ -5,7 +5,6 @@ module Screengem
   class Task
     include RSpec::Matchers
 
-    include Screengem::Actionable
     include Screengem::Configurable
     include Screengem::Dampenable
     include Screengem::Executable

data/lib/screengem/version.rb

@@ -1,3 +1,3 @@
 module Screengem
-  VERSION = "0.9.1"
+  VERSION = "0.13.0"
 end

data/screengem.gemspec

@@ -27,16 +27,18 @@ Gem::Specification.new do |spec|
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 2.7"
 
-  spec.add_runtime_dependency "activesupport", ">= 4.2", "< 6.1"
+  spec.add_runtime_dependency "activesupport", ">= 5.2", "< 6.2"
   spec.add_runtime_dependency "capybara", ">= 2.18", "< 4.0"
-  spec.add_runtime_dependency "require_all", ">= 2.0", "< 4.0"
-  spec.add_runtime_dependency "rspec-expectations", "~> 3.8"
-  spec.add_runtime_dependency "thor", "~> 0.20"
+  spec.add_runtime_dependency "require_all", ">= 3.0", "< 4.0"
+  spec.add_runtime_dependency "rspec-expectations", "~> 3.10"
+  spec.add_runtime_dependency "thor", ">= 0.20", "< 1.2"
 
   spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.8"
-  spec.add_development_dependency "rubocop", "~> 0.75"
-  spec.add_development_dependency "rubocop-rspec", "~> 1.36"
-  spec.add_development_dependency "simplecov", "~> 0.17"
+  spec.add_development_dependency "rspec", "~> 3.9"
+  spec.add_development_dependency "rubocop", "~> 1.8"
+  spec.add_development_dependency "rubocop-performance", "~> 1.9"
+  spec.add_development_dependency "rubocop-rspec", "~> 2.1"
+  spec.add_development_dependency "simplecov", "~> 0.21"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: screengem
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.13.0
 platform: ruby
 authors:
 - Alistair McKinnell
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-10-22 00:00:00.000000000 Z
+date: 2021-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
@@ -56,7 +56,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '4.0'
@@ -66,7 +66,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '4.0'
@@ -76,28 +76,34 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.20'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.20'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -118,57 +124,71 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.75'
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.75'
+        version: '1.9'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.36'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.36'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
-description: 
+        version: '0.21'
+description:
 email:
 - alistairm@nulogy.com
 executables:
@@ -193,13 +213,10 @@ files:
 - exe/screengem
 - images/ScreengemCore.png
 - 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
-- lib/screengem/concerns/actionable.rb
 - lib/screengem/concerns/configurable.rb
 - lib/screengem/concerns/dampenable.rb
 - lib/screengem/concerns/executable.rb
@@ -207,13 +224,9 @@ files:
 - lib/screengem/dampen_configuration.rb
 - lib/screengem/dampen_configuration_generator.rb
 - lib/screengem/dsl.rb
-- lib/screengem/factories/action_factory.rb
-- lib/screengem/factories/browser_action_factory.rb
 - lib/screengem/factories/factory_creation_error.rb
 - lib/screengem/factories/question_factory.rb
-- lib/screengem/factories/standard_action_factory.rb
 - lib/screengem/factories/task_factory.rb
-- lib/screengem/incorrect_answer.rb
 - lib/screengem/primitive_key.rb
 - lib/screengem/question.rb
 - lib/screengem/rails_routes.rb
@@ -231,7 +244,7 @@ metadata:
   changelog_uri: https://github.com/nulogy/screengem/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/nulogy/screengem
   bug_tracker_uri: https://github.com/nulogy/screengem/issues
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -239,15 +252,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Ruby implementation of the Screengem Pattern.
 test_files: []

data/lib/screengem/action.rb

@@ -1,11 +0,0 @@
-module Screengem
-  #
-  # Base class for all actions.
-  #
-  class Action
-    include RSpec::Matchers
-
-    include Screengem::Configurable
-    include Screengem::Executable
-  end
-end

data/lib/screengem/browser_action.rb

@@ -1,7 +0,0 @@
-module Screengem
-  #
-  # Base class for all browser actions.
-  #
-  class BrowserAction < Screengem::Action
-  end
-end

data/lib/screengem/concerns/actionable.rb

@@ -1,29 +0,0 @@
-module Screengem
-  #
-  # Concern that adds the ability to create actions.
-  #
-  module Actionable
-    extend ActiveSupport::Concern
-
-    def action
-      @action ||= action_factory
-    end
-
-    private
-
-    #
-    # Choose the specified action factory. Default to the standard action factory.
-    #
-    def action_factory
-      if browser_factory?
-        Screengem::Factories::BrowserActionFactory.instance
-      else
-        Screengem::Factories::StandardActionFactory.instance
-      end
-    end
-
-    def browser_factory?
-      Screengem.configuration.browser_actions?
-    end
-  end
-end

data/lib/screengem/factories/action_factory.rb

@@ -1,34 +0,0 @@
-module Screengem
-  module Factories
-    #
-    # Makes actions available to tasks.
-    #
-    class ActionFactory < BasicObject
-      def method_missing(action_name, *args) # rubocop:disable Style/MethodMissingSuper
-        action_class_name = raw_action_class_name(action_name).camelize
-        action_class = "#{action_scope}::#{action_class_name}".constantize
-
-        action_class.new(*args)
-      rescue => e
-        ActionError.new(<<~MSG)
-          Unable to create action: '#{action_class_name}'.
-            Details: #{e.message}
-        MSG
-      end
-
-      def respond_to_missing?(_action_name, *)
-        true
-      end
-
-      class ActionError < ::Screengem::Action
-        include FactoryCreationError
-      end
-
-      private
-
-      def action_scope
-        @action_scope ||= ::Screengem.configuration.action_scope
-      end
-    end
-  end
-end

data/lib/screengem/factories/browser_action_factory.rb

@@ -1,14 +0,0 @@
-module Screengem
-  module Factories
-    #
-    # Makes browser actions available.
-    #
-    class BrowserActionFactory < Screengem::Factories::ActionFactory
-      include ::Singleton
-
-      def raw_action_class_name(action_name)
-        "#{action_name}_action_browser"
-      end
-    end
-  end
-end

data/lib/screengem/factories/standard_action_factory.rb

@@ -1,14 +0,0 @@
-module Screengem
-  module Factories
-    #
-    # Makes standard actions available.
-    #
-    class StandardActionFactory < Screengem::Factories::ActionFactory
-      include ::Singleton
-
-      def raw_action_class_name(action_name)
-        "#{action_name}_action"
-      end
-    end
-  end
-end

data/lib/screengem/incorrect_answer.rb

@@ -1,23 +0,0 @@
-module Screengem
-  #
-  # Common error to signal a question that was answered incorrectly.
-  #
-  class IncorrectAnswer < RuntimeError
-    def initialize(question)
-      super(extract_question_text(question))
-    end
-
-    private
-
-    #
-    # Transforms question class name into a text message.
-    #
-    # Example:
-    #
-    #   Questions::SignatureCapturedQuestion is transformed to 'Signature captured?'.
-    #
-    def extract_question_text(question)
-      question.class.name.demodulize.underscore.humanize.gsub(" question", "?")
-    end
-  end
-end