the_help 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 11faa4a08713a7aaf31284ead2538784c24faa12
-  data.tar.gz: a0146884e4d5b11dda20c8d82d3d390aacb6dab0
+  metadata.gz: '00645306911789d8f4f190c30fcbe4ec2da126de'
+  data.tar.gz: 895cabf435968334c1091208a3baa4d46dcdffc9
 SHA512:
-  metadata.gz: 1b3b331eb3fda6b1c3500ff229fb2e809add4fa1c213a72705ae8e0dd4916806ea36dabba2ad86518a8e0d098b73bb4c78fee4dee9eb2ebd23706488b04cf42c
-  data.tar.gz: 92d7fd1cdd5827bcd8fb5bcf626bf3eeb9873968256dafad8c29421d090f0a0e26df1cb5e288ff85b16b982d481791b18e9278032532cd49001d1b173242fad9
+  metadata.gz: c3b92751038bec65110aeed4c22c7b18de4b019d88784d05cd5287c8114132d905d94803de75ec2cf4ac812232bfa4726fc12bf8c8b7f4d7520ca769097df57c
+  data.tar.gz: 8a4d1f2ff9f05f8cf80d35902f2087f843b415ee27a6998ce6f7018023f57493bb90f585751705c66faedc95d3d9b8e10c91e80d192de2f2f18cd713987393dc

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    the_help (1.0.2)
+    the_help (1.1.0)
 
 GEM
   remote: https://rubygems.org/

data/lib/the_help/provides_callbacks.rb

@@ -54,6 +54,7 @@ module TheHelp
       # @param name [Symbol] The name of the callback
       # @param block [Proc] The code that will be executed in the context of the
       #   object when the callback is invoked.
+      # @return [self]
       def callback(name, &block)
         define_method("#{name}_without_logging", &block)
         define_method(name) do |*args|
@@ -61,6 +62,7 @@ module TheHelp
             logger.debug("#{inspect} received callback :#{name}.")
           end
           send("#{name}_without_logging", *args)
+          self
         end
         private name
         self

data/lib/the_help/service.rb

@@ -62,6 +62,7 @@ module TheHelp
   # CreateNewUserAccount.(context: current_user, user: new_user_object)
   class Service
     include ProvidesCallbacks
+    include ServiceCaller
 
     # The default :not_authorized callback
     #
@@ -73,6 +74,16 @@ module TheHelp
     }
 
     class << self
+      # Defines attr_accessors with scoping options
+      def attr_accessor(*names, make_private: false, private_reader: false,
+                        private_writer: false)
+        super(*names)
+        names.each do |name|
+          private name if make_private || private_reader
+          private "#{name}=" if make_private || private_writer
+        end
+      end
+
       # Convenience method to instantiate the service and immediately call it
       #
       # Any arguments are passed to #initialize
@@ -124,7 +135,7 @@ module TheHelp
       end
 
       def input(name, **options)
-        attr_accessor name
+        attr_accessor name, make_private: true
         if options.key?(:default)
           required_inputs.delete(name)
           define_method(name) do
@@ -133,7 +144,6 @@ module TheHelp
         else
           required_inputs << name
         end
-        private name, "#{name}="
         self
       end
     end

data/lib/the_help/service_caller.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module TheHelp
+  # Provides convenience method for calling services
+  #
+  # The including module/class MUST provide the #service_context and
+  # #service_logger methods, which will be provided as the called-service's
+  # `context` and `logger` arguments, respectively.
+  #
+  # @example
+  #   class Foo
+  #     include TheHelp::ServiceCaller
+  #
+  #     def do_something
+  #       call_service(MyService, some: 'arguments')
+  #     end
+  #
+  #     private
+  #
+  #     def service_context
+  #       # something that provides the context
+  #     end
+  #
+  #     def service_logger
+  #       # an instance of a `Logger`
+  #     end
+  #   end
+  module ServiceCaller
+    # Calls the specified service
+    #
+    # @param service [Class<TheHelp::Service>]
+    # @param args [Hash<Symbol, Object>] Any additional keyword arguments are
+    #        passed directly to the service.
+    # @return [self]
+    def call_service(service, **args)
+      service_args = {
+        context: service_context,
+        logger: service_logger
+      }.merge(args)
+      service.call(**service_args)
+      self
+    end
+  end
+end

data/lib/the_help/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: the_help
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - John Wilger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-08 00:00:00.000000000 Z
+date: 2017-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -76,6 +76,7 @@ files:
 - lib/the_help/errors.rb
 - lib/the_help/provides_callbacks.rb
 - lib/the_help/service.rb
+- lib/the_help/service_caller.rb
 - lib/the_help/version.rb
 - the_help.gemspec
 homepage: https://github.com/jwilger/the_help