screengem 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '05882b1d14fcb9e81a7b940a395de8e34167d0652ee564800be2cb5b784633d6'
-  data.tar.gz: 91ba212fd5c24bb7b1ddae9b79a4504aca3f1d8cba2949a16aaf5691091b9420
+  metadata.gz: a9311c4efbaf425f5cb08c89cb7ec0df2408ce296e8df1725fc63ce073c27878
+  data.tar.gz: 8ef3d9d8f9b4e7b3fb28ef55b1f5a084e96d0e32b84178cee531d27143926e54
 SHA512:
-  metadata.gz: 4203bdfd6d5d28f387bcbb5df19a02f318e73465f5b845103d8e3c365dfbb3a91999b8897b3f93aa48956c2a3b36b54e57dd6e95a4bdd930cf2bca56707680a0
-  data.tar.gz: 6a16b7076d33d3eeeb80c30c7b1fc5a107524a5ca0d93fd308eebb10092ee43ce206e63a7466154f4ec7fb9a7151c36b884f4e121fdc203caf2cd6dd43b1b80d
+  metadata.gz: 9e391d87bc90efc2153fb3cbfcd094d51c9676f94a7371111494a8d174b83f9a12d703a562470ae18be9533156f20b954286a003c1a8832947841599c57d62a1
+  data.tar.gz: 548acebf1c946d4235a908a6c6f5d50a1f520bbf20373a8625254613f3fc58ad1f60300a82a6038d180d9f0a11deb3808925531381165b88dba3b8bb3d46a33c

data/.rubocop.yml

@@ -1,4 +1,7 @@
-require: rubocop-rspec
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
 
 AllCops:
   NewCops: enable
@@ -48,6 +51,10 @@ RSpec/DescribedClass:
 RSpec/ExampleLength:
   Max: 20
 
+RSpec/FilePath:
+  Exclude:
+    - spec/screengem/concerns/*_spec.rb
+
 RSpec/MultipleMemoizedHelpers:
   Max: 8
 

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## main (unreleased)
 
+## 0.17.0 (2022-10-11)
+
+### Breaking Changes
+
+* Drop support for dampening
+
 ## 0.16.0 (2022-08-03)
 
 * Allow actor to recall with a default

data/README.md

@@ -53,19 +53,6 @@ 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.
-
-To enable and configure dampening perform the following steps:
-
-1. Create a sample dampening configuration `screengem generate --root features_screenplay`
-1. Tweak the sample dampening configuration
-1. Promote the sample dampening configuration `cp ./features_screenplay/dampen_configuration.yml.sample ./features_screenplay/dampen_configuration.yml`
-1. Enable dampening `export APPLY_DAMPENING=1`
-
-To stop dampening, run `unset APPLY_DAMPENING`
-
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/screengem/configuration.rb

@@ -9,22 +9,13 @@ module Screengem
   def self.configure
     self.configuration ||= Screengem::Configuration.new
 
-    yield(configuration)
+    yield(configuration) if block_given?
   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 string that namespaces questions classes (used by the QuestionFactory).
     attr_accessor :question_scope
 
@@ -32,20 +23,8 @@ module Screengem
     attr_accessor :task_scope
 
     def initialize
-      self.apply_dampening = false
-
-      self.dampen_configuration_root = "default"
-
       self.question_scope = "Questions"
       self.task_scope = "Tasks"
     end
-
-    def apply_dampening?
-      apply_dampening
-    end
-
-    def dampen_configuration_sample_filename
-      "#{dampen_configuration_filename}.sample"
-    end
   end
 end

data/lib/screengem/factories/question_factory.rb

@@ -24,8 +24,6 @@ module Screengem
 
       class QuestionError < ::Screengem::Question
         include FactoryCreationError
-
-        skip_dampening
       end
 
       private

data/lib/screengem/factories/task_factory.rb

@@ -24,8 +24,6 @@ module Screengem
 
       class TaskError < ::Screengem::Task
         include FactoryCreationError
-
-        skip_dampening
       end
 
       private

data/lib/screengem/question.rb

@@ -6,13 +6,10 @@ module Screengem
     include RSpec::Matchers
 
     include Screengem::Configurable
-    include Screengem::Dampenable
     include Screengem::Executable
 
-    dampen_scope :questions
-
     def answer
-      execute.tap { sleep(seconds_to_dampen) }
+      execute
     end
   end
 end

data/lib/screengem/task.rb

@@ -6,15 +6,12 @@ module Screengem
     include RSpec::Matchers
 
     include Screengem::Configurable
-    include Screengem::Dampenable
     include Screengem::Executable
 
     include Screengem::DSL
 
-    dampen_scope :tasks
-
     def perform
-      execute.tap { sleep(seconds_to_dampen) }
+      execute
     end
   end
 end

data/lib/screengem/version.rb

@@ -1,3 +1,3 @@
 module Screengem
-  VERSION = "0.16.0"
+  VERSION = "0.17.0"
 end

data/lib/screengem.rb

@@ -13,12 +13,8 @@ require "screengem/screen_element"
 require "screengem/screengem_error"
 
 require "screengem/configuration"
-require "screengem/primitive_key"
-require "screengem/dampen_configuration"
-require "screengem/dampen_configuration_generator"
 
 require "screengem/concerns/configurable"
-require "screengem/concerns/dampenable"
 require "screengem/concerns/executable"
 
 require "screengem/dsl"
@@ -36,8 +32,6 @@ require "screengem/factories/task_factory"
 
 require "screengem/screen_elements"
 
-require "screengem/cli"
-
 require "screengem/version"
 
 module Screengem

data/screengem.gemspec

@@ -33,7 +33,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "capybara", ">= 3.0", "< 4.0"
   spec.add_runtime_dependency "require_all", ">= 3.0", "< 4.0"
   spec.add_runtime_dependency "rspec-expectations", "~> 3.11"
-  spec.add_runtime_dependency "thor", "~> 1.2"
 
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.11"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: screengem
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Alistair McKinnell
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-03 00:00:00.000000000 Z
+date: 2022-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -84,20 +84,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.11'
-- !ruby/object:Gem::Dependency
-  name: thor
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -199,8 +185,7 @@ dependencies:
 description:
 email:
 - alistairm@nulogy.com
-executables:
-- screengem
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
@@ -217,24 +202,18 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- exe/screengem
 - images/ScreengemCore.png
 - lib/screengem.rb
 - lib/screengem/actor.rb
 - lib/screengem/actor_memory.rb
 - lib/screengem/automatic_visit.rb
-- lib/screengem/cli.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/factory_creation_error.rb
 - lib/screengem/factories/question_factory.rb
 - lib/screengem/factories/task_factory.rb
-- lib/screengem/primitive_key.rb
 - lib/screengem/question.rb
 - lib/screengem/rails_routes.rb
 - lib/screengem/screen_element.rb
@@ -266,7 +245,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.18
+rubygems_version: 3.3.22
 signing_key:
 specification_version: 4
 summary: Ruby implementation of the Screengem Pattern.

data/exe/screengem

@@ -1,8 +0,0 @@
-#!/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/lib/screengem/cli.rb

@@ -1,32 +0,0 @@
-require "require_all"
-require "thor"
-
-module Screengem
-  class CLI < Thor
-    option :root, desc: "The directory to start scanning for Tasks and Questions"
-    option :config, default: "dampen_configuration.yml", desc: "The name of the dampen configuration file"
-    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.
-      require_all root
-
-      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/dampenable.rb

@@ -1,54 +0,0 @@
-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
-
-      #
-      # Specify dampening to apply to a primitive.
-      #
-      def dampen_for(seconds)
-        define_singleton_method(:seconds_to_dampen) do
-          seconds
-        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/dampen_configuration.rb

@@ -1,85 +0,0 @@
-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, _primitive_class_name)
-        0
-      end
-    end
-  end
-end

data/lib/screengem/dampen_configuration_generator.rb

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

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