around_the_world 0.19.2 → 0.19.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c44e4600e2952abeee8b3742fda6da57a9d35386029cccdf4b74209785dffea
-  data.tar.gz: d9d00428029805db8a253c75c37265fa5342cbdd884a861f2c80baa56920ce61
+  metadata.gz: ad6bd225025bb0be327d8f7718ca5ae173fc2ad8364cac0859ff6f8c7edc0c67
+  data.tar.gz: 35c0eb58c034f9579a195a297652efd2eb1128d9f33470d082e9ac212062ccb1
 SHA512:
-  metadata.gz: c1f2264e9c186c8a7dce5a4c93a61d27efe8097fd319910ed61134aa4e21b5aa5c4520b3be976fc5d08d3b3b01160a48b47075068daf27f85ab24570e67dda5c
-  data.tar.gz: c3985023bd19fc5ed402f367acc15d23d619958454f27ac924bf8f138acbee56eb24c01e0536e4fbf409d22558ab963f230d71d2b0a6f2cc52765f676457a66c
+  metadata.gz: a0546264a8e3b6af2534532d1f1efe1d7100b8364c127e26805af78ab8261e9713ebac7f72f74ad29b7dabf21fcc98f2faab40f9440fcf7ba28e09a04c25b343
+  data.tar.gz: b1dcc397ed9da4a981c612c89e68477832ecee8fb065baaca2d2ad73c1596b02edac2e67a0d19741378563eea2002b710ae97bff405341ae495727286e681185

data/README.md

@@ -22,16 +22,95 @@ gem "around_the_world"
 ```
 
 And then execute:
-
-    $ bundle
+```bash
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install around_the_world
+```bash
+$ gem install around_the_world
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+Define a method that gets called _around_ the given instance method:
+
+```ruby
+class SomeClass
+  include AroundTheWorld
+
+  def did_something_happened?
+    true
+  end
+
+  around_method :did_something_happened? do |*args|
+    things_happened = super(*args)
+
+    if things_happened
+      "Something happened!"
+    else
+      "Nothing to see here..."
+    end
+  end
+end
+```
+
+```
+> SomeClass.new.did_something_happened?
+=> "Something happened!"
+```
+
+`around_method` accepts an option hash `prevent_double_wrapping_for: [Object]`. If defined, this prevents wrapping the method twice for a given purpose. It accepts any value:
+
+
+```ruby
+class SomeClass
+  include AroundTheWorld
+
+  def some_method
+    "method behavior"
+  end
+
+  around_method :some_method, prevent_double_wrapping_for: :memoization do |*args|
+    @memoized ||= super(*args)
+  end
+
+  around_method :some_method, prevent_double_wrapping_for: :memoization do |*args|
+    @memoized ||= super(*args)
+  end
+end
+```
+
+Results in:
+
+```
+# => AroundTheWorld::DoubleWrapError:
+     "Module AroundTheWorld:ProxyModule:memoization already defines the method :some_method"
+```
+
+It works for class methods too:
+
+```ruby
+class SomeClass
+  class << self
+    include AroundTheWorld
+
+    def a_singleton_method; end
+
+    around_method :a_singleton_method do |*args|
+      super(*args)
+
+      "It works for class methods too!"
+    end
+  end
+end
+```
+
+```
+> SomeClass.a_singleton_method
+=> "It works for class methods too!"
+```
 
 ## Development
 

data/lib/around_the_world/version.rb

@@ -2,5 +2,5 @@
 
 module AroundTheWorld
   # This constant is managed by spicerack
-  VERSION = "0.19.2"
+  VERSION = "0.19.3"
 end

data/lib/around_the_world.rb

@@ -5,6 +5,7 @@ require_relative "around_the_world/method_wrapper"
 require_relative "around_the_world/proxy_module"
 require_relative "around_the_world/version"
 require "active_support/concern"
+require "active_support/core_ext/object/blank"
 require "active_support/descendants_tracker"
 
 module AroundTheWorld
@@ -21,8 +22,8 @@ module AroundTheWorld
     #
     # @example
     #   class SomeClass
-    #     around_method :dont_look_in_here do
-    #       things_happened = super
+    #     around_method :dont_look_in_here do |*args|
+    #       things_happened = super(*args)
     #
     #       if things_happened
     #         "Something happened!"
@@ -40,19 +41,19 @@ module AroundTheWorld
     #   => "Something happened!"
     #
     # @example
-    #   around_method :dont_look_in_here, prevent_double_wrapping_for: :memoization do
-    #     @memoized ||= super
+    #   around_method :dont_look_in_here, prevent_double_wrapping_for: :memoization do |*args|
+    #     @memoized ||= super(*args)
     #   end
     #
-    #   around_method :dont_look_in_here, prevent_double_wrapping_for: :memoization do
-    #     @memoized ||= super
+    #   around_method :dont_look_in_here, prevent_double_wrapping_for: :memoization do |*args|
+    #     @memoized ||= super(*args)
     #   end
     #   # => AroundTheWorld::DoubleWrapError:
     #          "Module AroundTheWorld:ProxyModule:memoization already defines the method :dont_look_in_here"
     #
-    #   around_method :dont_look_in_here do
+    #   around_method :dont_look_in_here do |*args|
     #     do_something_else
-    #     super
+    #     super(*args)
     #   end
     #   # => no error raised
     #
@@ -63,8 +64,8 @@ module AroundTheWorld
     #     class << self
     #       def a_singleton_method; end
     #
-    #       around_method :a_singleton_method do
-    #         super
+    #       around_method :a_singleton_method do |*args|
+    #         super(*args)
     #         "It works for class methods too!"
     #       end
     #     end
@@ -73,6 +74,7 @@ module AroundTheWorld
     #   SomeClass.a_singleton_method
     #   => "It works for class methods too!"
     #
+    # @api public
     # @param method_name [Symbol]
     # @param :prevent_double_wrapping_for [Object]
     #   If defined, this prevents wrapping the method twice for a given purpose. Accepts any argument.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: around_the_world
 version: !ruby/object:Gem::Version
-  version: 0.19.2
+  version: 0.19.3
 platform: ruby
 authors:
 - Allen Rettberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-02 00:00:00.000000000 Z
+date: 2019-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -61,7 +61,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Allows you to easily wrap methods with custom logic on any class