screengem 0.1.0

data/lib/screengem/dampen_configuration_generator.rb

@@ -0,0 +1,57 @@
+module Screengem
+  #
+  # Knows how to generate the sample dampen configuration.
+  #
+  class DampenConfigurationGenerator
+    include Screengem::PrimitiveKey
+
+    # Seconds to sleep after executing a question or task.
+    DEFAULT_SLEEP = 2
+
+    def generate
+      configuration = empty_configuration
+
+      default_configuration = configuration["default"]
+
+      default_configuration["questions"] = all_questions
+      default_configuration["tasks"] = all_tasks
+
+      configuration
+    end
+
+    private
+
+    def empty_configuration
+      {
+        "default" => {
+          "questions" => {},
+          "tasks" => {}
+        }
+      }
+    end
+
+    def all_questions
+      all_primitives(Screengem::Question)
+    end
+
+    def all_tasks
+      all_primitives(Screengem::Task)
+    end
+
+    def all_primitives(primitive_root)
+      sorted_descendents(primitive_root).each_with_object({}) do |primitive_class, memo|
+        next unless apply_dampening?(primitive_class)
+
+        memo[primitive_key(primitive_class.name)] = DEFAULT_SLEEP
+      end
+    end
+
+    def sorted_descendents(primitive_root)
+      primitive_root.descendants.sort_by { |primitive_class| primitive_key(primitive_class.name) }
+    end
+
+    def apply_dampening?(primitive_class)
+      primitive_class.supports_dampening? && primitive_class.descendants.empty?
+    end
+  end
+end

data/lib/screengem/dsl.rb

@@ -0,0 +1,14 @@
+module Screengem
+  #
+  # Mixin that makes tasks and questions available.
+  #
+  module DSL
+    def question
+      Screengem::Factories::QuestionFactory.instance
+    end
+
+    def task
+      Screengem::Factories::TaskFactory.instance
+    end
+  end
+end

data/lib/screengem/factories/action_factory.rb

@@ -0,0 +1,34 @@
+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

@@ -0,0 +1,14 @@
+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/factory_creation_error.rb

@@ -0,0 +1,18 @@
+module Screengem
+  module Factories
+    #
+    # Knows the behaviour for error creation primitives.
+    #
+    module FactoryCreationError
+      attr_reader :error_message
+
+      def initialize(error_message)
+        @error_message = error_message
+      end
+
+      def execute
+        raise Screengem::ScreengemError, error_message
+      end
+    end
+  end
+end

data/lib/screengem/factories/question_factory.rb

@@ -0,0 +1,38 @@
+module Screengem
+  module Factories
+    #
+    # Knows how to create a Question from a question name.
+    #
+    class QuestionFactory < BasicObject
+      include ::Singleton
+
+      def method_missing(question_name, *args) # rubocop:disable Style/MethodMissingSuper
+        question_class_name = "#{question_name}_question".camelize
+        question_class = "#{question_scope}::#{question_class_name}".constantize
+
+        question_class.new(*args)
+      rescue => e
+        QuestionError.new(<<~MSG)
+          Unable to create question: '#{question_class_name}'.
+            Details: #{e.message}
+        MSG
+      end
+
+      def respond_to_missing?(_question_name, *)
+        true
+      end
+
+      class QuestionError < ::Screengem::Question
+        include FactoryCreationError
+
+        skip_dampening
+      end
+
+      private
+
+      def question_scope
+        @question_scope ||= ::Screengem.configuration.question_scope
+      end
+    end
+  end
+end

data/lib/screengem/factories/standard_action_factory.rb

@@ -0,0 +1,14 @@
+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/factories/task_factory.rb

@@ -0,0 +1,38 @@
+module Screengem
+  module Factories
+    #
+    # Knows how to create a Task from a task name.
+    #
+    class TaskFactory < BasicObject
+      include ::Singleton
+
+      def method_missing(task_name, *args) # rubocop:disable Style/MethodMissingSuper
+        task_class_name = "#{task_name}_task".camelize
+        task_class = "#{task_scope}::#{task_class_name}".constantize
+
+        task_class.new(*args)
+      rescue => e
+        TaskError.new(<<~MSG)
+          Unable to create task: '#{task_class_name}'.
+            Details: #{e.message}
+        MSG
+      end
+
+      def respond_to_missing?(_task_name, *)
+        true
+      end
+
+      class TaskError < ::Screengem::Task
+        include FactoryCreationError
+
+        skip_dampening
+      end
+
+      private
+
+      def task_scope
+        @task_scope ||= ::Screengem.configuration.task_scope
+      end
+    end
+  end
+end

data/lib/screengem/feature_page.rb

@@ -0,0 +1,8 @@
+module Screengem
+  #
+  # Base class for all feature pages.
+  #
+  class FeaturePage
+    include Capybara::DSL
+  end
+end

data/lib/screengem/incorrect_answer.rb

@@ -0,0 +1,23 @@
+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

data/lib/screengem/page_references.rb

@@ -0,0 +1,42 @@
+module Screengem
+  #
+  # Mixin that gives the ability to get references to page objects.
+  #
+
+  # 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
+      #
+      generated_method_names = []
+
+      Screengem::FeaturePage.descendants.each do |page_object|
+        class_name = page_object.name
+        method_name = class_name.demodulize.underscore
+
+        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
+          end
+        RUBY
+      end
+    end
+  end
+  # rubocop:enable Style/GuardClause
+end

data/lib/screengem/primitive_key.rb

@@ -0,0 +1,10 @@
+module Screengem
+  #
+  # Mixin that knows how to generate the primitive key for a dampening configuration.
+  #
+  module PrimitiveKey
+    def primitive_key(primitive_class_name)
+      Screengem::DampenConfiguration.instance.dampen_configuration_key(primitive_class_name)
+    end
+  end
+end

data/lib/screengem/question.rb

@@ -0,0 +1,16 @@
+module Screengem
+  #
+  # Base class for all questions.
+  #
+  class Question
+    include Screengem::Configurable
+    include Screengem::Dampenable
+    include Screengem::Executable
+
+    dampen_scope :questions
+
+    def answer
+      execute.tap { sleep(seconds_to_dampen) }
+    end
+  end
+end

data/lib/screengem/screengem_error.rb

@@ -0,0 +1,3 @@
+module Screengem
+  ScreengemError = Class.new(RuntimeError)
+end

data/lib/screengem/task.rb

@@ -0,0 +1,19 @@
+module Screengem
+  #
+  # Base class for all tasks.
+  #
+  class Task
+    include Screengem::Actionable
+    include Screengem::Configurable
+    include Screengem::Dampenable
+    include Screengem::Executable
+
+    include Screengem::DSL
+
+    dampen_scope :tasks
+
+    def perform
+      execute.tap { sleep(seconds_to_dampen) }
+    end
+  end
+end

data/lib/screengem/version.rb

@@ -0,0 +1,3 @@
+module Screengem
+  VERSION = "0.1.0"
+end

data/lib/screengem.rb

@@ -0,0 +1,47 @@
+require "singleton"
+require "yaml"
+
+require "active_support"
+require "active_support/core_ext"
+
+require "capybara/dsl"
+
+require "screengem/feature_page"
+require "screengem/incorrect_answer"
+require "screengem/screengem_error"
+
+require "screengem/configuration"
+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"
+
+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"
+
+require "screengem/page_references"
+
+require "screengem/cli"
+
+require "screengem/version"
+
+module Screengem
+end

data/screengem.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "screengem/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "screengem"
+  spec.version       = Screengem::VERSION
+  spec.authors       = ["Alistair McKinnell"]
+  spec.email         = ["alistairm@nulogy.com"]
+
+  spec.summary       = "Ruby implementation of the Screengem Pattern."
+  spec.homepage      = "https://github.com/nulogy/screengem"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activesupport", ">= 4.2"
+  spec.add_runtime_dependency "capybara", "~> 2.18"
+  spec.add_runtime_dependency "require_all", "~> 2.0"
+  spec.add_runtime_dependency "thor", ">= 0.20"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.8"
+  spec.add_development_dependency "rubocop", "~> 0.61"
+  spec.add_development_dependency "rubocop-rspec", "~> 1.30"
+end

metadata

@@ -0,0 +1,212 @@
+--- !ruby/object:Gem::Specification
+name: screengem
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alistair McKinnell
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.18'
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.61'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.61'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.30'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.30'
+description: 
+email:
+- alistairm@nulogy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/screengem
+- bin/setup
+- lib/screengem.rb
+- lib/screengem/action.rb
+- lib/screengem/actor.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
+- lib/screengem/configuration.rb
+- 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/feature_page.rb
+- lib/screengem/incorrect_answer.rb
+- lib/screengem/page_references.rb
+- lib/screengem/primitive_key.rb
+- lib/screengem/question.rb
+- lib/screengem/screengem_error.rb
+- lib/screengem/task.rb
+- lib/screengem/version.rb
+- screengem.gemspec
+homepage: https://github.com/nulogy/screengem
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Ruby implementation of the Screengem Pattern.
+test_files: []