the_help 1.5.2 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d34be83924ed7c3d112f20bc436d6554cd60796992556e5564ea5f11bd47ee8f
-  data.tar.gz: dff8be814a80546a339d287dbf40177c812bb1e335576106bf7357e0ef335125
+  metadata.gz: 3edb077ec558a78e242e845f6c6f5e31466899e9261d3b25aa358ecd1ebb050f
+  data.tar.gz: 409913bdf7ca41cf2c0089ea95e4118a32b37b8f7c6c94d77ae6799857b6631d
 SHA512:
-  metadata.gz: e054ed53f313c46308d07df088e16a344a8cabd68e01d9a1fccdb960e11bd8a4352081f1eb5e9309d67975d60a9cc311eb91dc310a27d6c269113490527fb270
-  data.tar.gz: edaf7872ad85bc47a14137fc21c9724328d49158fdf41529d324f80ba122f056505ef5290b9dfde4ebbc0b1033494b4df436cf7cf6b1034c306e2087170e132c
+  metadata.gz: 04a66ae08e0cbcae7cf4eede6e4b482c187140669ccf7c9aff59cb65cd9dbb9602c890d14df65f6ccd5e9292d329498af9676c11bfeb9aa90569e3d3163c4942
+  data.tar.gz: a5846b8b1054896839eae9280a4ae9674349fe404795bc9d93f04f6d998d5e3ac9974daecdb8420615e97c5e7e05c161dc1fd164e27b67fb49697a0901e1ee1e

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+bin/*

data/.rspec

@@ -1,3 +1,2 @@
---format documentation
 --color
 --require spec_helper

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.5.3

data/Gemfile.lock

@@ -1,47 +1,51 @@
 PATH
   remote: .
   specs:
-    the_help (1.5.2)
+    the_help (1.6.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.0)
+    byebug (10.0.2)
     diff-lcs (1.3)
-    parallel (1.12.1)
-    parser (2.5.0.2)
+    jaro_winkler (1.5.2)
+    parallel (1.13.0)
+    parser (2.6.0.0)
       ast (~> 2.4.0)
-    powerpack (0.1.1)
+    powerpack (0.1.2)
     rainbow (3.0.0)
     rake (10.5.0)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.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)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
-    rubocop (0.52.1)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.63.1)
+      jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.4.0.2, < 3.0)
+      parser (>= 2.5, != 2.5.1.1)
       powerpack (~> 0.1)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.9.0)
-    unicode-display_width (1.3.0)
-    yard (0.9.12)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
+    unicode-display_width (1.4.1)
+    yard (0.9.18)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  byebug
   rake (~> 10.0)
   rspec (~> 3.0)
   rubocop (~> 0.50)
@@ -49,4 +53,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   1.16.4
+   1.17.1

data/README.md

@@ -40,28 +40,26 @@ class Foo < TheHelp::Service
   main do
     call_service(GetSomeWidgets,
                  customer_id: 12345,
-                 each_widget: method(:process_widget),
-                 invalid_customer: method(:no_customer),
-                 no_widgets_found: method(:no_widgets))
+                 each_widget: callback(:process_widget),
+                 invalid_customer: callback(:no_customer),
+                 no_widgets_found: callback(:no_widgets))
     do_something_else
   end
 
-  private
-
-  def process_widget(widget)
+  callback(:process_widget) do |widget|
     # do something with it
   end
 
-  def invalid_customer
+  callback(:invalid_customer) do
     # handle this case
     stop!
   end
 
-  def no_widgets
+  callback(:no_widgets) do
     # handle this case
   end
 
-  def do_something_else
+  callback(:do_something_else) do
     # ...
   end
 end
@@ -141,21 +139,33 @@ unintended consequences further down the stack.)
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/jwilger/the_help. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/jwilger/the_help. This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere to
+the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
 
-Everyone interacting in the TheHelp project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jwilger/the_help/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the TheHelp project’s codebases, issue trackers, chat
+rooms and mailing lists is expected to follow the [code of
+conduct](https://github.com/jwilger/the_help/blob/master/CODE_OF_CONDUCT.md).
 
 [SRP]: https://en.wikipedia.org/wiki/Single_responsibility_principle
 [TDA]: https://martinfowler.com/bliki/TellDontAsk.html

data/lib/the_help/provides_callbacks.rb

@@ -9,11 +9,18 @@ module TheHelp
   #
   #     def do_something
   #       collaborator.do_some_other_thing(when_done: callback(:it_was_done))
+  #       collaborator
+  #         .do_some_other_thing(when_done: callback(:it_was_done_method))
   #     end
   #
   #     callback(:it_was_done) do |some_arg:|
   #       puts "Yay! #{some_arg}"
   #     end
+  #
+  #     def it_was_done_method(some_arg:)
+  #       puts "In a method: #{some_arg}"
+  #     end
+  #     callback :it_was_done_method
   #   end
   #
   #   class Bar
@@ -26,47 +33,98 @@ module TheHelp
   #   f.collaborator = Bar.new
   #   f.do_something
   #   # STDOUT: "Yay! done by Bar"
-  #
-  # Callbacks can be given to collaborating objects, but the actual methods are
-  # defined as private methods. This allows the object to control which other
-  # objects are able to invoke the callbacks (at least to the extent that Ruby
-  # lets you do so.)
+  #   # STDOUT: "In a method: done by Bar"
   #
   # If the including class defines a #logger instance method, a debug-level
   # message will be logged indicating that the callback was invoked.
   module ProvidesCallbacks
+    class CallbackNotDefinedError < StandardError; end
+
     def self.included(other)
       other.class_eval do
         extend TheHelp::ProvidesCallbacks::ClassMethods
-        alias_method :callback, :method
       end
     end
 
+    def callback(callback_name)
+      return method(callback_name) if _provides_callbacks_callback_defined?(
+        callback_name
+      )
+
+      raise CallbackNotDefinedError,
+            "The callback :#{callback_name} has not been defined."
+    end
+
+    private
+
+    def _provides_callbacks_callback_defined?(callback_name)
+      self.class.send(:_provides_callbacks_callback_defined?, callback_name)
+    end
+
     # Classes that include ProvidesCallbacks are extended with these
     # ClassMethods
     module ClassMethods
+      private
+
       # Defines a callback method on the class
       #
-      # The provided block will be used to define an instance method. This
-      # behaves similarly to #define_method, however it will ensure that
-      # callbacks are logged if the object has a #logger method defined.
+      # Regardless of whether the callback is pointing to an existing instance
+      # method or if it is defined via the block argument, the callback will
+      # also be wrapped in logging statements that can help you trace the
+      # execution path through your code in the event of any anomolies.
       #
-      # @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.
+      # @param name [Symbol] The name of the callback. If no block is provided,
+      #        then name must be the name of an existing instance method.
+      # @param block [Proc] If a block is provided, the block will act as the
+      #        though it is the body of an instance method when the callback is
+      #        invoked.
       # @return [self]
       def callback(name, &block)
-        define_method("#{name}_without_logging", &block)
+        _provides_callbacks_defined_callbacks << name.to_sym
+        without_logging = "#{name}_without_logging".to_sym
+        _provides_callbacks_define_method_with_block(without_logging, &block)
+        _provides_callbacks_alias_method(without_logging, name)
+        _provides_callbacks_define_wrapper(name, without_logging)
+        self
+      end
+
+      def _provides_callbacks_callback_defined?(name)
+        _provides_callbacks_defined_callbacks.include?(name.to_sym)
+      end
+
+      def _provides_callbacks_defined_callbacks
+        @_provides_callbacks_defined_callbacks ||= Set.new
+      end
+
+      def _provides_callbacks_method_defined?(name)
+        method_defined?(name) || private_method_defined?(name)
+      end
+
+      def _provides_callbacks_define_method_with_block(without_logging, &block)
+        return unless block_given?
+
+        define_method(without_logging, &block)
+        private without_logging
+      end
+
+      def _provides_callbacks_alias_method(without_logging, name)
+        return unless _provides_callbacks_method_defined?(name)
+
+        alias_method without_logging, name
+        private without_logging
+      end
+
+      def _provides_callbacks_define_wrapper(name, without_logging)
+        make_public = public_method_defined?(name)
         define_method(name) do |*args|
           if defined?(logger)
             logger.debug("#{self.class.name}/#{__id__} received callback " \
                          ":#{name}.")
           end
-          send("#{name}_without_logging", *args)
+          send(without_logging, *args)
           self
         end
-        private name
-        self
+        private name unless make_public
       end
     end
   end

data/lib/the_help/service.rb

@@ -237,8 +237,8 @@ module TheHelp
     end
 
     def log_service_call
-      logger.info("Service call to #{self.class.name}/#{__id__} " \
-                  "for #{context.inspect}")
+      logger.debug("Service call to #{self.class.name}/#{__id__} " \
+                   "for #{context.inspect}")
     end
 
     def authorized?

data/lib/the_help/version.rb

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

data/the_help.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_development_dependency 'byebug'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '~> 0.50'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: the_help
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.6.1
 platform: ruby
 authors:
 - John Wilger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-30 00:00:00.000000000 Z
+date: 2019-01-25 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -77,7 +91,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".ruby-version"
+- ".tool-versions"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -114,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A service layer framework

data/.ruby-version

@@ -1 +0,0 @@
-2.5.0