screengem 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c867245700998e61a1a4267fa2310d0969c7a18090fd833005976dfe358094aa
+  data.tar.gz: bb153e7f607790113e9623fc923e6a105db61fd46e433a85c830585db571fe3e
+SHA512:
+  metadata.gz: 556786b3992d74be2e1c28ea53b53fa7e8f50012828bc46bc523502dd8711cfadf2142cdc06d20b444e5a4fe91fcb9ad3eeb3ebe45a996775b4aeb3f1c7c6088
+  data.tar.gz: e08be7f02fff0f28daa21ec772beb2face609a17c777aabc773e88c39bc7d55942d65756c87eb75fbc297532fa2531ca2fd4de08976e51708d703cb354a8552e

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop

@@ -0,0 +1 @@
+--display-cop-names

data/.rubocop.yml

@@ -0,0 +1,58 @@
+require: rubocop-rspec
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Enabled: false
+
+RSpec/AnyInstance:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Max: 20
+
+RSpec/MultipleExpectations:
+  Max: 5
+
+RSpec/LeadingSubject:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/NotToNot:
+  EnforcedStyle: to_not
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyMethod:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/MutableConstant:
+  Enabled: false
+
+Style/ExpandPathArguments:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/RescueModifier:
+  Enabled: false
+
+Style/RescueStandardError:
+  EnforcedStyle: implicit
+
+Style/WordArray:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.3.3

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.16.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at alistairm@nulogy.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in screengem.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Alistair McKinnell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,33 @@
+# Screengem
+
+A simple Ruby implementation of the [Screenplay Pattern](https://ideas.riverglide.com/page-objects-refactored-12ec3541990). 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'screengem'
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nulogy/screengem. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Screengem project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/nulogy/screengem/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "screengem"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/screengem

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+# Add the screengem/lib directory to the load path
+$LOAD_PATH.unshift(File.expand_path("../../lib", __FILE__))
+
+require "screengem"
+
+Screengem::CLI.start(ARGV)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/screengem/action.rb

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

data/lib/screengem/actor.rb

@@ -0,0 +1,86 @@
+module Screengem
+  #
+  # Mixin that allows an actor to perform tasks, ask questions, take actions, 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 are extended with PageReferences so that
+  # they can interact with the application via page objects.
+  #
+  module Actor
+    #
+    # Used by an actor to ask one or more questions in a step definition.
+    #
+    def asks(*questions)
+      questions.each do |question|
+        question.configure(self).extend(page_references)
+
+        next if question.answer
+
+        raise incorrect_answer(question)
+      end
+
+      self
+    end
+
+    #
+    # Used by an actor to perform one or more tasks in a step definition.
+    #
+    def performs(*tasks)
+      tasks.each do |task|
+        task.configure(self).extend(page_references)
+
+        task.perform
+      end
+
+      self
+    end
+
+    #
+    # Used by an actor to recall a value for the specified tag.
+    #
+    def recall(tag)
+      recollections.fetch(tag)
+    end
+
+    #
+    # Used by an actor to remember one or more tagged values.
+    #
+    def remember(facts)
+      recollections.merge!(facts)
+
+      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).extend(page_references)
+
+        action.execute
+      end
+    end
+
+    private
+
+    def incorrect_answer(question)
+      Screengem::IncorrectAnswer.new(question)
+    end
+
+    def page_references
+      @page_references ||= Screengem::PageReferences
+    end
+
+    def recollections
+      @recollections ||= ActiveSupport::HashWithIndifferentAccess.new
+    end
+  end
+end

data/lib/screengem/browser_action.rb

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

data/lib/screengem/cli.rb

@@ -0,0 +1,32 @@
+require "require_all"
+require "thor"
+
+module Screengem
+  class CLI < Thor
+    option :root
+    option :config, default: "dampen_configuration.yml"
+    option :questions, default: "questions"
+    option :tasks, default: "tasks"
+    option :quiet, default: false
+    desc "generate", "Create the sample dampening configuration"
+    def generate
+      root = options[:root]
+
+      # Require all questions and tasks for inclusion in the sample configuration.
+      require_all File.join(root, options[:questions])
+      require_all File.join(root, options[:tasks])
+
+      Screengem.configure do |config|
+        config.dampen_configuration_filename = File.join(root, options[:config])
+      end
+
+      sample_filename = Screengem.configuration.dampen_configuration_sample_filename
+
+      puts "Regenerating #{sample_filename} ..." unless options[:quiet]
+
+      sample_configuration = Screengem::DampenConfigurationGenerator.new.generate
+
+      File.write(sample_filename, sample_configuration.to_yaml)
+    end
+  end
+end

data/lib/screengem/concerns/actionable.rb

@@ -0,0 +1,29 @@
+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/concerns/configurable.rb

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

data/lib/screengem/concerns/dampenable.rb

@@ -0,0 +1,45 @@
+module Screengem
+  #
+  # Concern for adding dampening to primitives.
+  #
+  module Dampenable
+    extend ActiveSupport::Concern
+
+    class_methods do
+      #
+      # Since most primitives may be dampened.
+      #
+      def supports_dampening?
+        true
+      end
+
+      #
+      # Specify a primitive subclass with no dampening.
+      #
+      def skip_dampening
+        define_singleton_method(:supports_dampening?) do
+          false
+        end
+      end
+
+      #
+      # Specify the dampening configuration scope.
+      #
+      def dampen_scope(scope)
+        define_method(:dampening_scope) do
+          scope
+        end
+      end
+    end
+
+    def seconds_to_dampen
+      dampen_configuration.seconds_to_dampen(dampening_scope, self.class.name)
+    end
+
+    private
+
+    def dampen_configuration
+      Screengem::DampenConfiguration.instance.configuration
+    end
+  end
+end

data/lib/screengem/concerns/executable.rb

@@ -0,0 +1,15 @@
+module Screengem
+  #
+  # Concern for adding the command pattern.
+  #
+  module Executable
+    extend ActiveSupport::Concern
+
+    #
+    # Subclasses must implement an execute method.
+    #
+    def execute
+      raise "You must define an execute method"
+    end
+  end
+end

data/lib/screengem/configuration.rb

@@ -0,0 +1,63 @@
+module Screengem
+  class << self
+    attr_accessor :configuration
+  end
+
+  #
+  # Expose the configuration to users of the Screengem gem.
+  #
+  def self.configure
+    self.configuration ||= Screengem::Configuration.new
+
+    yield(configuration)
+  end
+
+  #
+  # Configuration for the Screengem gem.
+  #
+  class Configuration
+    # The name of the YAML file that is used to configure dampening.
+    attr_accessor :dampen_configuration_filename
+
+    # The top level key in the YAML file that is used to configure dampening.
+    attr_accessor :dampen_configuration_root
+
+    # 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
+
+    # A string that namespaces task classes (used by the TaskFactory).
+    attr_accessor :task_scope
+
+    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
+
+    def apply_dampening?
+      apply_dampening
+    end
+
+    def browser_actions?
+      browser_actions
+    end
+
+    def dampen_configuration_sample_filename
+      "#{dampen_configuration_filename}.sample"
+    end
+  end
+end

data/lib/screengem/dampen_configuration.rb

@@ -0,0 +1,85 @@
+module Screengem
+  #
+  # Exposes the question and task sleep intervals as defined in the dampening configuration.
+  #
+  class DampenConfiguration
+    include ::Singleton
+
+    attr_reader :configuration
+
+    def initialize
+      @configuration = DampenConfigurationFactory.new.build_configuration
+    end
+
+    def dampen_configuration_key(primitive_class_name)
+      primitive_class_name.demodulize.underscore.gsub(/_(question|task)$/, "")
+    end
+
+    #
+    # Knows how to build a dampen configuration.
+    #
+    class DampenConfigurationFactory
+      def build_configuration
+        if dampening_configured?
+          DampenConfiguration::Standard.new(load_configuration)
+        else
+          DampenConfiguration::None.new
+        end
+      end
+
+      private
+
+      def dampening_configured?
+        apply_dampening? && configuration_file_exists?
+      end
+
+      def apply_dampening?
+        Screengem.configuration.apply_dampening?
+      end
+
+      def configuration_file_exists?
+        File.exist?(configuration_yaml)
+      end
+
+      def load_configuration
+        YAML.load_file(configuration_yaml)
+      end
+
+      def configuration_yaml
+        Screengem.configuration.dampen_configuration_filename
+      end
+    end
+
+    #
+    # Respond by looking up seconds to dampen in the specified settings.
+    #
+    class Standard
+      include Screengem::PrimitiveKey
+
+      attr_reader :settings
+
+      def initialize(settings)
+        @settings = ActiveSupport::HashWithIndifferentAccess.new(settings).fetch(dampen_configuration_root, {})
+      end
+
+      def seconds_to_dampen(primitive_scope, primitive_class_name)
+        settings.dig(primitive_scope, primitive_key(primitive_class_name)).to_i
+      end
+
+      private
+
+      def dampen_configuration_root
+        Screengem.configuration.dampen_configuration_root
+      end
+    end
+
+    #
+    # Always respond with no dampening.
+    #
+    class None
+      def seconds_to_dampen(_primitive_scope, _class_name)
+        0
+      end
+    end
+  end
+end