simple_aspect 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e991b108ddd328284fb3ce188939bf5a725482b1
-  data.tar.gz: 81e062bfdfc0e338fb13281be91eed674e42f4a0
+  metadata.gz: d4d10294dae057f9b624813a323f1195f33792c7
+  data.tar.gz: 47f0750698a998be89ff0fb06854440fad86ad04
 SHA512:
-  metadata.gz: 11f0ed8fb7a82d60d7c4768ab67bbf9e96f44573f144d9a80973aeeb8a7901f5b6dd5c19f4ed0d740f6de43e05f0e8a7c0755983c4196384c34938d6f73c5c44
-  data.tar.gz: ba9b6f33b50018731847f2100165e1d4678ea015552777aefdf8d6965935ab5fec73f25e503e35300ef90a7f73ab53eaa6910cd5706b71ce1e2a18974d3ab0ca
+  metadata.gz: ab95a34f6118aa21a8b8cbc260c250331708b47bc63f8d08e5a368515e6a5f55313e25cf688387396968104bfe6b1956ffa5efecd62f3ab15dabb18842a6ed74
+  data.tar.gz: 08daefe1dc62a9d1d0f9a84a79a8c08e994392c22e1a59395f21a559ba0cdc3e5a9bf68e6792829485e4ae56d85831907ca920fbe419f4ef56eaf1d210fed9e7

data/lib/simple_aspect.rb

@@ -3,6 +3,7 @@ require 'simple_aspect/version'
 module SimpleAspect
   require 'thread'
 
+  # @api private
   def self.extended(base)
     base.instance_eval do
       @sa_methods_to_aspect_methods_name = {}
@@ -11,6 +12,51 @@ module SimpleAspect
     end
   end
 
+  # Register an aspect method around the target method
+  #
+  # @param method [Symbol] name of the target method
+  # @param instance_around_method_name [Symbol] name of the aspect method. If
+  #   not provided, the definition of the aspect method should be provided with
+  #   a Proc/lambda
+  # @param block [Proc] the definition of the aspect method if its name was not
+  #   provided. This Proc needs to receive two arguments: *orig_args,
+  #   &orig_block
+  #
+  # @example without a defined method
+  #   class Worker
+  #     extend SimpleAspect
+  #
+  #     aspect_around :perform do |*args, &original|
+  #       result = original.call
+  #       log(result)
+  #     end
+  #
+  #     def perform(*args)
+  #       # do_work
+  #     end
+  #
+  #     def log(message)
+  #       # log
+  #     end
+  #   end
+  #
+  # @example with a defined method
+  #
+  #   class Worker
+  #     extend SimpleAspect
+  #
+  #     aspect_around :perform, :log
+  #
+  #     def perform(*args)
+  #       # do_work
+  #     end
+  #
+  #     def log(*args)
+  #       # log *args
+  #       result = yield
+  #       # log result
+  #     end
+  #   end
   def aspect_around(
     method,
     instance_around_method_name = sa_instance_around_method_name(method),
@@ -19,6 +65,7 @@ module SimpleAspect
     sa_register_aspect_on_method(method, instance_around_method_name, &block)
   end
 
+  # @api private
   def method_added(method)
     return if sa_should_not_redefine?(method)
 

data/lib/simple_aspect/version.rb

@@ -1,3 +1,3 @@
 module SimpleAspect
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_aspect
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Ricardo Tealdi