the_help 3.1.0 → 3.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c3bac0cd5079035a765ff1018c38020e8f7805b00fd0e7123da0a9fe2547e15
-  data.tar.gz: 7708a7c8c5523525b6ee909bd1395b03b898f69bb4fdab7e91b14fe6817e332c
+  metadata.gz: dc4395e67a6bb231d32bce3a2663791e8e5626b186df2cf8801bfbef60f4808d
+  data.tar.gz: 3ff62f7e6df84f25611e7a742bcb1122468af481153c13affb1c8feafd405758
 SHA512:
-  metadata.gz: a2a35d48df57043c329f3425539ca6e8aa181bd2f9b420977c5d871caab068d1a100ad8ae2d9b924dd56022340e0c0f4c5cb4587e510955627b9db428a4c2a9b
-  data.tar.gz: b91c4d0a6601a062987b77fbdb53760959b20332d8a071b216087568b1934ef99d5cd7e72dc19ecda5074c468e6d601154386a85f8c1e711aa69772b75e4433c
+  metadata.gz: 184272bb541578a4da8b7c97b52febe1b45ce1f87596c7f609f5fedb2d74aaff3240c04a1560adab0f9858a776c0953b531a255e83bf0071b90f87d509003f40
+  data.tar.gz: 7528614f77a172d920e9cf943fc4fa54f7630d341d2fb39b97b57780b5476a56399091780c421d1484048a08c472154b619136fb5f8368ac96a7451e7c41c813

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# TheHelp Changelog #
+
+## 3.3.0 ##
+
+* Calling `#stop!` with no arguments in a service definition will now check that a result was set
+  with either `#result.success` or `#result.error` and raise `TheHelp::NoResultError` if no result
+  was set.
+
+* You can now call `#stop!` with both a `type:` and `value:` argument. `type:` can be either
+  `:error` (the default) or `:success`, and `value:` can be any object. Calling in this manner
+  will set the service result to the specified type and value.

data/Gemfile.lock

@@ -1,50 +1,55 @@
 PATH
   remote: .
   specs:
-    the_help (3.1.0)
+    the_help (3.3.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
-    byebug (11.0.1)
-    diff-lcs (1.3)
-    jaro_winkler (1.5.3)
-    parallel (1.18.0)
-    parser (2.6.5.0)
-      ast (~> 2.4.0)
+    ast (2.4.1)
+    byebug (11.1.3)
+    diff-lcs (1.4.4)
+    parallel (1.19.2)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
     rainbow (3.0.0)
-    rake (10.5.0)
+    rake (13.0.1)
+    regexp_parser (1.8.2)
+    rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.0)
-      rspec-support (~> 3.9.0)
-    rspec-expectations (3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.0)
-    rubocop (0.75.1)
-      jaro_winkler (~> 1.5.1)
+    rspec-support (3.9.4)
+    rubocop (0.93.1)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.1.0)
+      parser (>= 2.7.1.5)
     ruby-progressbar (1.10.1)
-    unicode-display_width (1.6.0)
-    yard (0.9.20)
+    unicode-display_width (1.7.0)
+    yard (0.9.25)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   byebug
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 0.50)
   the_help!

data/lib/the_help/service.rb

@@ -150,18 +150,42 @@ module TheHelp
         self
       end
 
-      def input(name, **options)
-        attr_accessor name, make_private: true
-        if options.key?(:default)
-          required_inputs.delete(name)
-          define_method(name) do
-            instance_variable_get("@#{name}") || options[:default]
-          end
+      # Defines a service input
+      #
+      # The specified input becomes a named parameter for the service's `#call` method.
+      #
+      # @param name [Symbol] This becomes the name of the input parameter
+      #
+      # @param block [Proc] If a block is provided, the contents of the block will be executed in
+      #                     the scope of the service instance in order to provide the default
+      #                     value of the input. This is different than providing a Proc to the
+      #                     `:default` option, which would simply return the Proc itself as the
+      #                     default value rather than calling it.
+      #
+      # @option options [Object] :default If specified (and no block is given), this becomes the
+      #                                   literal default value for the input.
+      def input(name, **options, &block)
+        if options.key?(:default) || block
+          make_optional_input(name, options[:default], &block)
         else
+          attr_accessor name, make_private: true
           required_inputs << name
         end
         self
       end
+
+      private
+
+      def make_optional_input(name, default, &block)
+        attr_writer name
+        private "#{name}="
+        default_routine = block || -> { default }
+        define_method("_#{name}", &default_routine)
+        define_method(name) do
+          instance_variable_get("@#{name}") || send("_#{name}")
+        end
+        required_inputs.delete(name)
+      end
     end
 
     # Holds the result of running a service as well as the execution status
@@ -239,16 +263,21 @@ module TheHelp
     # @return [TheHelp::Service::Result]
     def call
       validate_service_definition
+
       catch(:stop) do
         authorize
         log_service_call
         main
         check_result!
-        self.block_result = yield result if block_given?
       end
+
+      self.block_result = yield result if block_given?
+
       throw :stop if stop_caller
+
       return block_result if block_given?
-      return result
+
+      result
     end
 
     private
@@ -291,11 +320,20 @@ module TheHelp
       return if authorized?
       logger.warn("Unauthorized attempt to access #{self.class.name}/#{__id__} " \
                   "as #{context.inspect}")
-      run_callback(not_authorized, service: self.class, context: context)
+      result.error run_callback(not_authorized, service: self.class, context: context)
       stop!
     end
 
-    def stop!
+    def stop!(type: :error, **opts)
+      value = opts.fetch(:value) { |key|
+        check_result!
+        throw :stop
+      }
+      if type == :success
+        result.success value
+      else
+        result.error value
+      end
       throw :stop
     end
 

data/lib/the_help/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TheHelp
-  VERSION = '3.1.0'
+  VERSION = '3.3.2'
 end

data/the_help.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'byebug'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '~> 0.50'
   spec.add_development_dependency 'yard'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: the_help
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.3.2
 platform: ruby
 authors:
 - John Wilger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-01 00:00:00.000000000 Z
+date: 2020-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -93,6 +93,7 @@ files:
 - ".rubocop.yml"
 - ".tool-versions"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock