testable 0.5.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c59c802e12f855543871b0917b7043a6dca602714c79cf5624d0033b86f8ce68
-  data.tar.gz: 3011ecba1297734eff0491ce54f4b8192bc5bdafe61b2736598af3649b790455
+  metadata.gz: 025f6e480d7fcc805e5f5315133169d8544210a60107b71436f5eb0564056175
+  data.tar.gz: 0111cd004bfcdcc8f64b889a5edd5728922d77a24349f9e05003422f3b491f55
 SHA512:
-  metadata.gz: c9b98f008221c0bd278f690f6aee6fe32c5ea84ffe3c55a977d015ef25100846291bf9a753080caffec7e13d8fcc81f9f3e757cdf7e9f980ab4ce0abf8289ae0
-  data.tar.gz: b977fd589e01f32b48af6ed449087c2a3db1d05ed0aa0f87ee2b74d876259695b61ec0d117f1691f426b77f285ed7809876324243fd0e1e2d42fdee5436df903
+  metadata.gz: 65992ba040e1175ceded847c9a7024c80e9b52bf0c5f08a51a7ff53964a4cff39a43c9de44d0c6e172b64ea3d31eda09c35066d809e10f7260743aee86b14440
+  data.tar.gz: a1f782e5b1f3a7d19247b2e02e7b415061de7e4be4a24a8593e7173ebf81a33e5499b86c3cc85826445eef58281904ffe7cea64a2e69c581e44e942e81b5a59f

data/.gitignore

@@ -1,3 +1,7 @@
+# Testable Generated
+
+testable.log
+
 # Ruby Generated
 
 /Gemfile.lock

data/README.md

@@ -8,6 +8,12 @@
 
 ----
 
+[![Gem Version](https://badge.fury.io/rb/testable.svg)](http://badge.fury.io/rb/testable)
+[![License](http://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/jeffnyman/testable/blob/master/LICENSE.md)
+
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://rubydoc.info/github/jeffnyman/testable/master/frames)
+[![Inline docs](http://inch-ci.org/github/jeffnyman/testable.png)](http://inch-ci.org/github/jeffnyman/github)
+
 Testable is an automated test micro-framework that provides a thin wrapper around [Watir](http://watir.com/) and [Capybara](http://teamcapybara.github.io/capybara/). Testable is based on many ideas from tools like [SitePrism](https://github.com/natritmeyer/site_prism) and [Watirsome](https://github.com/p0deje/watirsome), while also being a logical evolution of my own tool, [Tapestry](https://github.com/jeffnyman/tapestry).
 
 One of the core goals of Testable is to be a mediating influence between higher-level tests (acceptance criteria) and lower-level implementations of those tests. You can see some of the design principles for more details on what guided construction.
@@ -36,7 +42,17 @@ You can also install Testable just as you would any other gem:
 
 ## Usage
 
-Instructions will be coming soon. However, there are a series of scripts in the `examples` directory and a series of commands in the `Rakefile` that will let you execute those scripts.
+Probably the best way to get a feel for the current state of the code is to look at the examples:
+
+* [Testable Info](https://github.com/jeffnyman/testable/blob/master/examples/testable-info.rb)
+* [Testable Basics](https://github.com/jeffnyman/testable/blob/master/examples/testable-watir.rb)
+* [Testable Watir](https://github.com/jeffnyman/testable/blob/master/examples/testable-watir-test.rb)
+* [Testable Context](https://github.com/jeffnyman/testable/blob/master/examples/testable-watir-context.rb)
+* [Ready script](https://github.com/jeffnyman/testable/blob/master/examples/testable-watir-ready.rb)
+* [Events script](https://github.com/jeffnyman/testable/blob/master/examples/testable-watir-events.rb)
+* [Data setter script](https://github.com/jeffnyman/testable/blob/master/examples/testable-watir-datasetter.rb)
+
+You'll see references to "Veilus" and a "localhost" in the script. I'm using my own [Veilus application](https://veilus.herokuapp.com/). As far as the localhost, you can use the [Veilus repo](https://github.com/jeffnyman/veilus) to get a local copy to play around with.
 
 ## Design Principles
 

data/examples/testable-watir-test.rb

@@ -2,9 +2,7 @@
 $LOAD_PATH << "./lib"
 
 require "rspec"
-# rubocop:disable Style/MixinUsage
 include RSpec::Matchers
-# rubocop:enable Style/MixinUsage
 
 require "testable"
 
@@ -46,6 +44,21 @@ end
 
 Testable.start_browser :firefox
 
+# Will default to UNKNOWN.
+puts Testable.log_level
+
+# Will not actually log.
+Testable.logger.info("Testing an info log message.")
+
+# Change the log.
+Testable.log_level = :debug
+
+# Will actually log.
+Testable.logger.debug("Testing a debug log message.")
+
+# Sets the Watir wire protocol level logging.
+Testable.wire_level_logging = :info
+
 page = Home.new
 
 page.visit

data/lib/testable.rb

@@ -1,10 +1,12 @@
 require "testable/version"
 require "testable/page"
 require "testable/ready"
+require "testable/logger"
 require "testable/context"
 require "testable/element"
 require "testable/locator"
 require "testable/attribute"
+require "testable/deprecator"
 
 require "testable/capybara/page"
 
@@ -14,7 +16,6 @@ require "testable/extensions/dom_observer"
 
 require "watir"
 require "capybara"
-require "webdrivers"
 
 module Testable
   def self.included(caller)
@@ -41,6 +42,106 @@ module Testable
   attr_accessor :browser
 
   class << self
+    # Provides a means to allow a configure block on Testable. This allows you
+    # to setup Testable, as such:
+    #
+    #  Testable.configure do |config|
+    #    config.driver_timeout = 5
+    #    config.wire_level_logging = :info
+    #    config.log_level = :debug
+    #  end
+    def configure
+      yield self
+    end
+
+    # Watir provides a default timeout of 30 seconds. This allows you to change
+    # that in the Testable context. For example:
+    #
+    #   Testable.driver_timeout = 5
+    #
+    # This would equivalent to doing this:
+    #
+    #    Watir.default_timeout = 5
+    def driver_timeout=(value)
+      Watir.default_timeout = value
+    end
+
+    # The Testable logger object. To log messages:
+    #
+    #   Testable.logger.info('Some information.')
+    #   Testable.logger.debug('Some diagnostics')
+    #
+    # To alter or check the current logging level, you can call `.log_level=`
+    # or `.log_level`. By default the logger will output all messages to the
+    # standard output ($stdout) but it can be altered to log to a file or to
+    # another IO location by calling `.log_path=`.
+    def logger
+      @logger ||= Testable::Logger.new.create
+    end
+
+    # To enable logging, do this:
+    #
+    #   Testable.log_level = :DEBUG
+    #   Testable.log_level = 'DEBUG'
+    #   Testable.log_level = 0
+    #
+    # This can accept any of a Symbol / String / Integer as an input
+    # To disable all logging, which is the case by default, do this:
+    #
+    #   Testable.log_level = :UNKNOWN
+    def log_level=(value)
+      logger.level = value
+    end
+
+    # To query what level is being logged, do this:
+    #
+    #   Testable.log_level
+    #
+    # The logging level will be UNKNOWN by default.
+    def log_level
+      %i[DEBUG INFO WARN ERROR FATAL UNKNOWN][logger.level]
+    end
+
+    # The writer method allows you to configure where you want the output of
+    # the Testable logs to go, with the default being standard output. Here
+    # is how you could change this to a specific file:
+    #
+    #   Testable.log_path = 'testable.log'
+    def log_path=(logdev)
+      logger.reopen(logdev)
+    end
+
+    # The wire logger provides logging from Watir, which is very similar to the
+    # logging provided by Selenium::WebDriver::Logger. The default level is set
+    # to warn. This means you will see any deprecation notices as well as any
+    # warning messages. To see details on each element interaction the level
+    # can be set to info. To see details on what Watir is doing when it takes a
+    # selector hash and converts it into XPath, the level can be set to debug.
+    # If you want to ignore specific warnings that are appearing during test
+    # execution:
+    #
+    # Watir.logger.ignore :warning_name
+    #
+    # If you want to ignore all deprecation warnings in your tests:
+    #
+    # Watir.logger.ignore :deprecations
+    #
+    # To have the wire logger generate output to a file:
+    #
+    # Watir.logger.output = "wire.log"
+
+    def wire_path=(logdev)
+      Watir.logger.reopen(logdev)
+    end
+
+    def wire_level_logging=(value)
+      Watir.logger.level = value
+    end
+
+    def wire_level_logging
+      %i[DEBUG INFO WARN ERROR FATAL UNKNOWN][Watir.logger.level]
+    end
+
     def watir_api
       browser.methods - Object.public_methods -
         Watir::Container.instance_methods

data/lib/testable/deprecator.rb

@@ -0,0 +1,40 @@
+module Testable
+  class Deprecator
+    class << self
+      def deprecate(current, upcoming = nil, known_version = nil)
+        if upcoming
+          warn(
+            "#{current} is being deprecated and should no longer be used. \
+            Use #{upcoming} instead."
+          )
+        else
+          warn("#{current} is being deprecated and should no longer be used.")
+        end
+
+        warn(
+          "#{current} will be removed in Testable #{known_version}."
+        ) if known_version
+      end
+
+      def soft_deprecate(current, reason, known_version, upcoming = nil)
+        debug("The #{current} method is changing and is now configurable.")
+        debug("REASON: #{reason}.")
+        debug(
+          "Moving forwards into Testable #{known_version}, \
+          the default behavior will change."
+        )
+        debug("It is advised that you change to using #{upcoming}") if upcoming
+      end
+
+      private
+
+      def warn(message)
+        Testable.logger.warn(message)
+      end
+
+      def debug(message)
+        Testable.logger.debug(message)
+      end
+    end
+  end
+end

data/lib/testable/extensions/data_setter.rb

@@ -59,7 +59,7 @@ module Testable
     # Here "warp factor" would be converted to "warp_factor".
     def using(data)
       data.each do |key, value|
-        use_data_with(key, value) if object_enabled_for(key)
+        use_data_with(key, value.to_s) if object_enabled_for(key)
       end
     end
 
@@ -78,10 +78,41 @@ module Testable
     # with. These aspects are what tie this particular implementation to
     # Watir.
     def use_data_with(key, value)
+      value = preprocess_value(value, key)
+
       element = send(key.to_s.tr(' ', '_'))
       set_and_select(key, element, value)
       check_and_uncheck(key, element, value)
+      click(key, element)
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
+    def preprocess_value(value, key)
+      return value unless value =~ /\(\(.*\)\)/
+
+      starter = value.index("((")
+      ender = value.index("))")
+      qualifier = value[starter + 2, ender - starter - 2]
+
+      if qualifier == "random_large"
+        value[starter..ender + 1] = rand(1_000_000_000_000).to_s
+      elsif qualifier == "random_ssn"
+        value = rand(9**9).to_s.rjust(9, '0')
+        value.insert 5, "-"
+        value.insert 3, "-"
+      elsif qualifier == "random_selection"
+        list = chain("#{key}.options.to_a")
+
+        selected = list.sample.text
+        selected = list.sample.text if selected.nil?
+        value = selected
+      end
+
+      value
     end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
 
     def set_and_select(key, element, value)
       key = key.to_s.tr(' ', '_')
@@ -97,6 +128,10 @@ module Testable
       chain("#{key}.uncheck")      if element.class == Watir::CheckBox
     end
 
+    def click(key, element)
+      chain("#{key}.click")        if element.class == Watir::Label
+    end
+
     # This is a sanity check method to make sure that whatever element is
     # being used as part of the data setting, it exists in the DOM, is
     # visible (meaning, display is not 'none'), and is capable of accepting

data/lib/testable/logger.rb

@@ -0,0 +1,16 @@
+require "logger"
+
+module Testable
+  class Logger
+    def create(output = $stdout)
+      logger = ::Logger.new(output)
+      logger.progname = 'Testable'
+      logger.level = :UNKNOWN
+      logger.formatter = proc do |severity, time, progname, msg|
+        "#{time.strftime('%F %T')} - #{severity} - #{progname} - #{msg}\n"
+      end
+
+      logger
+    end
+  end
+end

data/lib/testable/page.rb

@@ -67,7 +67,7 @@ module Testable
     end
 
     alias displayed? has_correct_url?
-    alias loaded?    has_correct_url?
+    alias loaded? has_correct_url?
 
     # A call to `title_attribute` returns what the value of the `title_is`
     # attribute is for the given definition. It's important to note that

data/lib/testable/version.rb

@@ -1,7 +1,7 @@
 module Testable
   module_function
 
-  VERSION = "0.5.0".freeze
+  VERSION = "0.10.0".freeze
 
   def version
     """

data/testable.gemspec

@@ -26,16 +26,17 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = ">= 2.3"
+
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "rubocop"
   spec.add_development_dependency "pry"
 
-  spec.add_runtime_dependency "watir", ["~> 6.4"]
-  spec.add_runtime_dependency "capybara", ["~> 3.0"]
-  spec.add_runtime_dependency "webdrivers", ["~> 4.0"]
+  spec.add_runtime_dependency "watir", ["~> 6.16"]
+  spec.add_runtime_dependency "capybara", [">= 2", "< 4"]
 
   spec.post_install_message = %{
 (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: testable
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Jeff Nyman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-13 00:00:00.000000000 Z
+date: 2020-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,16 +28,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -100,42 +100,34 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.4'
+        version: '6.16'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.4'
+        version: '6.16'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: webdrivers
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+        version: '2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 description: Provides a semantic DSL to construct fluent interfaces for test execution
   logic.
 email:
@@ -172,6 +164,7 @@ files:
 - lib/testable/capybara/node.rb
 - lib/testable/capybara/page.rb
 - lib/testable/context.rb
+- lib/testable/deprecator.rb
 - lib/testable/element.rb
 - lib/testable/errors.rb
 - lib/testable/extensions/core_ruby.rb
@@ -179,6 +172,7 @@ files:
 - lib/testable/extensions/dom_observer.js
 - lib/testable/extensions/dom_observer.rb
 - lib/testable/locator.rb
+- lib/testable/logger.rb
 - lib/testable/page.rb
 - lib/testable/ready.rb
 - lib/testable/situation.rb
@@ -192,7 +186,7 @@ metadata:
   source_code_uri: https://github.com/jeffnyman/testable
   changelog_uri: https://github.com/jeffnyman/testable/blob/master/CHANGELOG.md
 post_install_message: "\n(::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)\n
-  \ Testable 0.5.0 has been installed.\n(::) (::) (::) (::) (::) (::) (::) (::) (::)
+  \ Testable 0.10.0 has been installed.\n(::) (::) (::) (::) (::) (::) (::) (::) (::)
   (::) (::) (::)\n  "
 rdoc_options: []
 require_paths:
@@ -201,14 +195,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Web and API Automation, using Capybara and Watir