screengem 0.6.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21b69c903afb974665c2aa6e4a7bec85d358f77e6098073bc7aa13d1894f9f89
-  data.tar.gz: 0a7dfb096d615137892bbcc736157fdd05f804868450bda7768ecb523ed34f4a
+  metadata.gz: f0f99a511e85ed2b6f1232ca2ffa53e296ab97be13bdaecadce83657b33e6915
+  data.tar.gz: 16e8d91f9c89f33a82a1d2e1b6c8917e016c132df1f101c6953d50c4ab1f7f89
 SHA512:
-  metadata.gz: 371bac28fea725a28e8010a772836491991ab49aefe1f542d41b9e8eb5cac5f2cd758044174fe44af906f10eb95e8490974e5f2b9a11637f478f6c8846bed9a5
-  data.tar.gz: 60777c62b2ac2e2801a8b9738c01e0418b21b3fbfb07a9e3f5de203887a0025b63f373ca7d1b5bc83b7812cbe81ca0d4d23e49cc3ed9ad460586e94341e45237
+  metadata.gz: 072bf89ce61351a3fcab0bc150cfe7319e10d60c67bffd8a056637f0a62c884cb5eae84a324dcfbabdc65755bc881c20fc192f2567364fab858cde0ae33d5c88
+  data.tar.gz: a34105be1cb51ef91a904f650befc987d49cdf3150e170264811b0106f3355f2f79749ba461d5d7a6c76d2d7cf88c1c17505e447ab2f25b5e1b7b9ec1300a1a5

data/.rubocop.yml

@@ -39,18 +39,21 @@ Style/Documentation:
 Style/EmptyMethod:
   Enabled: false
 
-Style/FrozenStringLiteralComment:
+Style/ExpandPathArguments:
   Enabled: false
 
-Style/MutableConstant:
+Style/FrozenStringLiteralComment:
   Enabled: false
 
-Style/ExpandPathArguments:
+Style/MutableConstant:
   Enabled: false
 
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 
+Style/SymbolArray:
+  Enabled: false
+
 Style/RescueModifier:
   Enabled: false
 

data/CHANGELOG.md

@@ -2,12 +2,30 @@
 
 ## master (unreleased)
 
+## 0.7.1 (2019-04-20)
+
+### Bug fixes
+
+* Fixed failure to generate screen element methods unless no arg constructor.
+
+## 0.7.0 (2019-04-18)
+
+### New Features
+
+* Introduce the `visit_path` method for subclasses of ScreenElement (no need to call `visit`).
+
+### Bug fixes
+
+* Load the Rails environment to run the `screengem` command that creates dampening configurations
+
 ## 0.6.0 (2019-04-11)
 
 ### New Features
 
 * Whenever an actor recalls a value perform a `reload` on the value. Avoid the `reload` by passing `false` to the `reload:` argument.
 
+## 0.5.0 (2019-03-28)
+
 ### New Features
 
 * [RSpec Expectations](https://github.com/rspec/rspec-expectations) are available in all primitives: actions, questions, and tasks.

data/lib/screengem/automatic_visit.rb

@@ -0,0 +1,42 @@
+module Screengem
+  #
+  # Knows how to decorate public screen element methods with a visit invocation around any public method.
+  #
+  # This behaviour is turned on for any screen element instance that overrides the visit_path method.
+  #
+  class AutomaticVisit
+    attr_reader :screen_element
+
+    def initialize(screen_element)
+      @screen_element = screen_element
+    end
+
+    def method_missing(method, *args)
+      if screen_element.respond_to?(method)
+        forward_with_auto_visit(method, args)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method, *)
+      screen_element.respond_to?(method)
+    end
+
+    private
+
+    def forward_with_auto_visit(method, args)
+      screen_element.visit if auto_visit?(method)
+
+      screen_element.send(method, *args)
+    end
+
+    def auto_visit?(method)
+      methods_to_decorate.include?(method)
+    end
+
+    def methods_to_decorate
+      @methods_to_decorate ||= screen_element.public_methods(false) - [:visit, :visit_path]
+    end
+  end
+end

data/lib/screengem/cli.rb

@@ -8,6 +8,9 @@ module Screengem
     option :quiet, default: false, desc: "Suppress command output"
     desc "generate", "Create the sample dampening configuration"
     def generate
+      # Require Rails to be loaded so that we can successfully require questions and tasks.
+      require "./config/environment"
+
       root = options[:root]
 
       # Require all questions and tasks for inclusion in the sample configuration.

data/lib/screengem/screen_element.rb

@@ -2,7 +2,22 @@ module Screengem
   #
   # Base class for all screen elements.
   #
+  # Calling visit does nothing when currently navigated to the target.
+  #
   class ScreenElement
     include Capybara::DSL
+
+    def visit(visit_uri = visit_path)
+      return if visit_uri == page.current_path
+
+      page.visit(visit_uri)
+    end
+
+    #
+    # Subclasses override the visit_path method to participate in auto visit.
+    # See Screengem::AutomaticVisit.
+    #
+    def visit_path
+    end
   end
 end

data/lib/screengem/screen_elements.rb

@@ -2,10 +2,17 @@ module Screengem
   #
   # Singleton that gives the ability to get references to screen elements.
   #
-  # On initialization generate a factory method for each screen element we can find. Example:
+  # On initialization generate a factory method for each screen element. If the screen element
+  # defines a visit_path method then we wrap the screen element to support auto visit.
+  #
+  # Examples:
   #
   #   def login_page
-  #     Pages::LoginPage.new
+  #     ScreenElements::LoginPage.new
+  #   end
+  #
+  #   def login_page
+  #     Screengem::AutomaticVisit.new(ScreenElements::LoginPage.new)
   #   end
   #
   class ScreenElements
@@ -14,22 +21,41 @@ module Screengem
     def initialize
       generated_method_names = []
 
-      Screengem::ScreenElement.descendants.each do |screen_element|
-        class_name = screen_element.name
+      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?
+
         method_name = class_name.demodulize.underscore
 
+        # 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
 
         generated_method_names << method_name
 
-        class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
-          def #{method_name}(*args)
-            #{class_name}.new(*args)
-          end
-        RUBY
+        if auto_visit?(screen_element_class)
+          class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
+            def #{method_name}(*args)
+              Screengem::AutomaticVisit.new(#{class_name}.new(*args))
+            end
+          RUBY
+        else
+          class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
+            def #{method_name}(*args)
+              #{class_name}.new(*args)
+            end
+          RUBY
+        end
       end
     end
+
+    private
+
+    def auto_visit?(screen_element)
+      screen_element.instance_methods(false).include?(:visit_path)
+    end
   end
 end

data/lib/screengem/version.rb

@@ -1,3 +1,3 @@
 module Screengem
-  VERSION = "0.6.0"
+  VERSION = "0.7.1"
 end

data/lib/screengem.rb

@@ -7,6 +7,7 @@ require "active_support/core_ext"
 require "capybara/dsl"
 require "rspec/expectations"
 
+require "screengem/automatic_visit"
 require "screengem/incorrect_answer"
 require "screengem/screen_element"
 require "screengem/screengem_error"

data/screengem.gemspec

@@ -38,4 +38,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.8"
   spec.add_development_dependency "rubocop", "~> 0.65"
   spec.add_development_dependency "rubocop-rspec", "~> 1.32"
+  spec.add_development_dependency "simplecov", "~> 0.16"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: screengem
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Alistair McKinnell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-12 00:00:00.000000000 Z
+date: 2019-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -148,6 +148,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.32'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
 description: 
 email:
 - alistairm@nulogy.com
@@ -175,6 +189,7 @@ files:
 - lib/screengem.rb
 - lib/screengem/action.rb
 - lib/screengem/actor.rb
+- lib/screengem/automatic_visit.rb
 - lib/screengem/browser_action.rb
 - lib/screengem/cli.rb
 - lib/screengem/concerns/actionable.rb