the_help 1.6.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2028b3233247d37829ca68a1c6dfd5453f67c9cf4ef4635b46326f87deac4fe
-  data.tar.gz: 9f0f912ef276566c2eaaf3797646c0b495554643d3d4a0963d50e9da29c50257
+  metadata.gz: f11ddd3d1fc5d239938188bda0cba4c3e57d86433fc39f5214dc9ae6aee875af
+  data.tar.gz: e1a80305b54998dfb4c84e6ec8c1b0c49ccaedc0b21c969becfaca90a671ac60
 SHA512:
-  metadata.gz: e4ef0ec2e74937c413b32f4610a12c03697b29108c34bc0dbc3799c3646cda95356beb5dc038f249010c74757efa28e3e2b6353552f84f8480564b7a77feed42
-  data.tar.gz: cf939fdae7f09497b44dd0fe5ec93002b0e68426c8cbd736eb9a04bf3f7a80d919e83bf0d83a2d3c798c251f2d5750ac99b75b1fb5ad291e7924c2e73403768e
+  metadata.gz: 0af2dbe4d5979ed8d525794f9797c0011a4535ebe7127afd3bddd2a5c11911c0b919c86b8527916a49ee0e29decf662a28c9317cdea935cd8366e1bf56d781e7
+  data.tar.gz: '019aaca0b3c14e5d96ac5e0f661f5fb9cb8c04ddcbff254ae27f9c380c19a44019037ae80026dbb24604c0a2d09e8b50331f9e94b325515083ab1c67cb083594'

data/.tool-versions

@@ -1 +1 @@
-ruby 2.5.3
+ruby 2.6.3

data/Gemfile.lock

@@ -1,45 +1,43 @@
 PATH
   remote: .
   specs:
-    the_help (1.6.2)
+    the_help (2.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.0)
-    byebug (10.0.2)
+    byebug (11.0.1)
     diff-lcs (1.3)
-    jaro_winkler (1.5.2)
-    parallel (1.13.0)
-    parser (2.6.0.0)
+    jaro_winkler (1.5.3)
+    parallel (1.18.0)
+    parser (2.6.5.0)
       ast (~> 2.4.0)
-    powerpack (0.1.2)
     rainbow (3.0.0)
     rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    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)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    rubocop (0.63.1)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.75.1)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      powerpack (~> 0.1)
+      parser (>= 2.6)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.4.0)
-    ruby-progressbar (1.10.0)
-    unicode-display_width (1.4.1)
-    yard (0.9.18)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.0)
+    yard (0.9.20)
 
 PLATFORMS
   ruby

data/lib/the_help/service.rb

@@ -15,18 +15,17 @@ module TheHelp
   #     input :send_welcome_message, default: true
   #
   #     authorization_policy do
-  #       authorized = false
-  #       call_service(Authorize, permission: :admin_users,
-  #                    allowed: ->() { authorized = true })
-  #       authorized
+  #       call_service(Authorize, permission: :admin_users).success?
   #     end
   #
   #     main do
   #       # do something to create the user account
   #       if send_welcome_message
-  #         call_service(SendWelcomeMessage, user: user,
-  #                      success: callback(:message_sent))
+  #         call_service(SendWelcomeMessage, user: user) do |result|
+  #           callback(:message_sent) if result.success?
+  #         end
   #       end
+  #       result.success
   #     end
   #
   #     callback(:message_sent) do |message|
@@ -36,25 +35,25 @@ module TheHelp
   #
   #   class Authorize < TheHelp::Service
   #     input :permission
-  #     input :allowed
   #
   #     authorization_policy allow_all: true
   #
   #     main do
   #       if user_has_permission?
-  #         allowed.call
+  #         result.success
+  #       else
+  #         result.error 'Permission Denied'
   #       end
   #     end
   #   end
   #
   #   class SendWelcomeMessage < TheHelp::Service
   #     input :user
-  #     input :success, default: ->(message) { }
   #
   #     main do
   #       message = 'Hello, world!'
   #       # do something with message...
-  #       run_callback(success, message)
+  #       result.success message
   #     end
   #   end
   #
@@ -62,38 +61,20 @@ module TheHelp
   #
   # @example Calling services with a block
   #
-  #   # Calling a service with a block when the service is not designed to
-  #   # receive one will result in an exception being raised
-  #
-  #   class DoesNotTakeBlock < TheHelp::Service
-  #     authorization_policy allow_all: true
-  #
-  #     main do
-  #       # whatever
-  #     end
-  #   end
-  #
-  #   DoesNotTakeBlock.call { |result| true } # raises TheHelp::NoResultError
-  #
-  #   # However, if the service *is* designed to receive a block (by explicitly
-  #   # assigning to the internal `#result` attribute in the main routine), the
-  #   # result will be yielded to the block if a block is present.
+  #   # The service result will be yielded to the block if a block is present.
   #
   #   class CanTakeABlock < TheHelp::Service
   #     authorization_policy allow_all: true
   #
   #     main do
-  #       self.result = :the_service_result
+  #       result.success :the_service_result
   #     end
   #   end
   #
   #   service_result = nil
   #
-  #   CanTakeABlock.call() # works just fine
-  #   service_result
-  #   #=> nil              # but obviously the result is just discarded
+  #   CanTakeABlock.call { |result| service_result = result.value }
   #
-  #   CanTakeABlock.call { |result| service_result = result }
   #   service_result
   #   #=> :the_service_result
   #
@@ -126,9 +107,7 @@ module TheHelp
       #
       # Any arguments are passed to #initialize
       def call(*args, &block)
-        result = new(*args).call(&block)
-        return result unless result.is_a?(self)
-        self
+        new(*args).call(&block)
       end
 
       # :nodoc:
@@ -185,8 +164,51 @@ module TheHelp
       end
     end
 
+    # Holds the result of running a service as well as the execution status
+    #
+    # An instance of this class will be returned from any service call and will have a status of
+    # either :success or :error along with a value that is set by the service.
+    class Result
+      attr_reader :status, :value
+
+      def initialize
+        self.status = :pending
+        self.value = nil
+      end
+
+      def pending?
+        status == :pending
+      end
+
+      def success?
+        status == :success
+      end
+
+      def error?
+        status == :error
+      end
+
+      def success(value = nil)
+        self.value = value
+        self.status = :success
+        freeze
+      end
+
+      def error(value)
+        self.value = value
+        self.status = :error
+        freeze
+      end
+
+      private
+
+      attr_writer :status, :value
+    end
+
     def initialize(context:, logger: Logger.new($stdout),
                    not_authorized: CB_NOT_AUTHORIZED, **inputs)
+      @result = Result.new
+
       self.context = context
       self.logger = logger
       self.not_authorized = not_authorized
@@ -194,26 +216,28 @@ module TheHelp
       self.stop_caller = false
     end
 
+    # Executes the service and returns the result
+    #
+    # @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
       throw :stop if stop_caller
       return block_result if block_given?
-      return result if result_set?
-      self
+      return result
     end
 
     private
 
     attr_accessor :context, :logger, :not_authorized, :block_result,
                   :stop_caller
-    attr_writer :result
-    attr_reader :inputs
+    attr_reader :inputs, :result
 
     alias service_context context
     alias service_logger logger
@@ -257,13 +281,8 @@ module TheHelp
       throw :stop
     end
 
-    def result
-      raise TheHelp::NoResultError unless result_set?
-      @result
-    end
-
-    def result_set?
-      defined?(@result)
+    def check_result!
+      raise TheHelp::NoResultError if result.pending?
     end
 
     def run_callback(callback, *args)

data/lib/the_help/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: the_help
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 2.0.0
 platform: ruby
 authors:
 - John Wilger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-23 00:00:00.000000000 Z
+date: 2019-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -127,8 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A service layer framework