service_actor-promptable 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8800d1583285536b5b23e60a3bbf1a54b19df3e388d763c55f93ad4536f1c12c
-  data.tar.gz: 62d24c3fcc870b8bc69e9a63d7af2eb7c5047cf4ce9414041edfab33b8be7762
+  metadata.gz: 86c769e2c2f536f08cf0ee375bdad88b01e06b130a657aaa2cd6c179939a5214
+  data.tar.gz: d406cd55a3c94872c88beb19ad894291ac45f89818afeafd8417c07721c6bbdb
 SHA512:
-  metadata.gz: cad2618d0d12523d4e4cfc6fe32887ed3f613397c0be38bc9ee83b4ef742faef97afa8698cf9b4932f3a68b8d96462b20b273abc766585b8925cdfd1c237d463
-  data.tar.gz: 1d0b7712bc6dd38c056bf07935c0440afdf6c5466513524a81b2e158c4ae1c5c48d2831b591403bfe91083e602e9ddb16827ac9575de3c41d7d26b437e6ce2ce
+  metadata.gz: c6bdca3a3d7ff922ab88f83eb89535e98deefb6cbf25e8a3df8a25af84367dd253e9b87e4a1ede9c29f513b9db6a65bcce37661d03b23f9341f7aa6dfc8fcb82
+  data.tar.gz: 035e23cc95bbb9385bcedf3def851c80e19c2cc469aaf8978257f527a2791602cb0f71a0ad4664101a53d6487771985b2b04de4ddb71eacd651ab578b5b0039b

data/CHANGELOG.md

@@ -13,6 +13,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
+## [1.0.2] - 2022-07-03
+### Added
+- Supports running unattended, with configurable toggle
+
 ## [1.0.1] - 2022-06-30
 ### Added
 - Introspectable Version module
@@ -26,6 +30,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - DSL => `prompt_with`
   - Class attribute => `prompt`
 
-[Unreleased]: https://github.com/pboling/service_actor-promptable/compare/v1.0.1...HEAD
+[Unreleased]: https://github.com/pboling/service_actor-promptable/compare/v1.0.2...HEAD
+[1.0.2]: https://github.com/pboling/service_actor-promptable/compare/1.0.1...v1.0.2
 [1.0.1]: https://github.com/pboling/service_actor-promptable/compare/1.0.0...v1.0.1
 [1.0.0]: https://github.com/pboling/service_actor-promptable/compare/3079772bb43c02ebfca364d27d062e573acdb091...v1.0.0

data/README.md

@@ -167,11 +167,38 @@ class ShouldContinue < Actor
   def call
     self.answer = prompt.ask("What is the capital of Assyria?", default: "Uh, I don't know that")
     # or for a Yes/No query:
-    # self.answer = prompt.yes?("Do it?") # (Y/n)
+    # 
   end
 end
 ```
 
+If you have an actor that may be run unattended, and thus want to skip the prompts:
+```rb
+require "tty/prompt"
+
+class ShouldContinue < Actor
+  include ServiceActor::Promptable
+
+  prompt_with TTY::Prompt.new, unattended_options: { prompt_toggle: :unattended, answer_with: true}
+  output :answer, type: String
+
+  def call
+    # When not running unattended, this will prompt as normal.
+    # When running unattended it will use the `answer_with` value.
+    self.answer = prompt.yes?("Do it?")
+  end
+end
+
+# Run unattended:
+ShouldContinue.call(unattended: true) # will not prompt, and `answer` will be `true`!
+
+# Run the same class, no code changes, but attended:
+ShouldContinue.call(unattended: false) # will prompt!
+
+# Attended (unattended: false) is the default for classes that include ServiceActor::Promptable (obviously!)
+ShouldContinue.call # will prompt!
+```
+
 ### How to test
 
 Let's say you have the `ShouldContinue` class above, how do you provide user input to test the Actor?

data/lib/service_actor/promptable/unattended.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ServiceActor
+  module Promptable
+    # Sometimes a Service Actor should be able to run unattended or attended
+    class Unattended < BasicObject
+      def initialize(answer_with)
+        @answer_with = answer_with
+      end
+
+      def method_missing(_name, *_args)
+        ::Kernel.puts "Prompt is NoOp. Running unattended!"
+        @answer_with
+      end
+    end
+  end
+end

data/lib/service_actor/promptable/version.rb

@@ -3,7 +3,7 @@
 module ServiceActor
   module Promptable
     module Version
-      VERSION = "1.0.1"
+      VERSION = "1.0.2"
     end
   end
 end

data/lib/service_actor/promptable.rb

@@ -6,11 +6,26 @@ require "version_gem"
 # This library
 require "service_actor"
 require "service_actor/promptable/version"
+require "service_actor/promptable/unattended"
 
 module ServiceActor
-  # Add a prompt to an actor class
+  # Adds the `prompt_with` DSL to actors. This allows you to set a prompt interface.
+  # It is suggested to use the `tty-prompt` gem, but any prompt tool should work.
+  # Then you are able to call `.prompt` and manipulate the prompt during a play.
+  #
+  #   class PromptableActor < Actor
+  #     prompt_with TTY::Prompt.new
+  #     # or alternatively
+  #     def call
+  #       super
+  #       self.prompt = TTY::Prompt.new
+  #     end
+  #   end
   module Promptable
-    class Error < StandardError; end
+    UNATTENDED_DEFAULTS = {
+      prompt_toggle: :unattended,
+      answer_with: true
+    }.freeze
 
     def self.included(base)
       base.extend(ClassMethods)
@@ -21,11 +36,20 @@ module ServiceActor
       def inherited(child)
         super
 
-        child.prompt ||= @prompt
+        child.prompt_with(
+          prompt,
+          unattended_options: ServiceActor::Promptable::UNATTENDED_DEFAULTS.merge(unattended_options).dup
+        )
       end
 
-      def prompt_with(prompter)
-        @prompt = prompter
+      def prompt_with(prompter, unattended_options: {})
+        unattended_options = ServiceActor::Promptable::UNATTENDED_DEFAULTS.merge(unattended_options)
+        self.prompt = prompter
+        self.unattended_options = unattended_options
+        return unless unattended_options.key?(:prompt_toggle) && unattended_options[:prompt_toggle].is_a?(Symbol)
+
+        # Create an Actor input :unattended (default) which must be either true or false
+        input unattended_options[:prompt_toggle], in: [true, false], allow_nil: false, default: false
       end
 
       def prompt
@@ -35,15 +59,35 @@ module ServiceActor
       def prompt=(prompter)
         @prompt = prompter
       end
+
+      def unattended_options
+        @unattended_options
+      end
+
+      def unattended_options=(unattended_options)
+        @unattended_options = unattended_options
+      end
     end
 
     def prompt
-      self.class.prompt
+      if self.class.unattended_options[:prompt_toggle] && send(self.class.unattended_options[:prompt_toggle])
+        Unattended.new(self.class.unattended_options[:answer_with])
+      else
+        self.class.prompt
+      end
     end
 
     def prompt=(prompter)
       self.class.prompt = prompter
     end
+
+    def unattended_options
+      self.class.unattended_options
+    end
+
+    def unattended_options=(unattended_options)
+      self.class.unattended_options = unattended_options
+    end
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: service_actor-promptable
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Peter Boling
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-30 00:00:00.000000000 Z
+date: 2022-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: service_actor
@@ -198,6 +198,7 @@ files:
 - README.md
 - SECURITY.md
 - lib/service_actor/promptable.rb
+- lib/service_actor/promptable/unattended.rb
 - lib/service_actor/promptable/version.rb
 - sig/service_actor/promptable.rbs
 homepage: https://github.com/pboling/service_actor-promptable
@@ -205,10 +206,10 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/pboling/service_actor-promptable
-  source_code_uri: https://github.com/pboling/service_actor-promptable/tree/v1.0.1
-  changelog_uri: https://github.com/pboling/service_actor-promptable/blob/v1.0.1/CHANGELOG.md
+  source_code_uri: https://github.com/pboling/service_actor-promptable/tree/v1.0.2
+  changelog_uri: https://github.com/pboling/service_actor-promptable/blob/v1.0.2/CHANGELOG.md
   bug_tracker_uri: https://github.com/pboling/service_actor-promptable/issues
-  documentation_uri: https://www.rubydoc.info/gems/service_actor-promptable/1.0.1
+  documentation_uri: https://www.rubydoc.info/gems/service_actor-promptable/1.0.2
   wiki_uri: https://github.com/pboling/service_actor-promptable/wiki
   rubygems_mfa_required: 'true'
 post_install_message: