proxy_method 1.2.3 → 1.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c539293262786eeb2b5ac828d72dfd137256f0ba373a208915f45de4c52d0be4
-  data.tar.gz: 0c7e1d18915405dc5a61184b43e1b2144f442ffbcbeebe0ec5259979a4493423
+  metadata.gz: 30dca7d6e6868dad470c1c00056727bfc78c0c1ec457d95876c0fd42cd2b8bb5
+  data.tar.gz: d805267647962b76433660771e691090fd94b0c23643ae704916b11aaaa5fa65
 SHA512:
-  metadata.gz: 66e0d8f292257e6393e792c2c0a194616d7883648386ce37062e821b103e4f4312afc1bc44645f34f306eb388d5f117671a21bb679f785d4d8f1c37383e9e3e4
-  data.tar.gz: 1492b6a7e32c92debd06c026d382827514b8ec66e08bc6cbfa0207b009093a1c85bcbbea82af6facd04795aec8de8c53e894a45b23d930fbafda79816736dd0e
+  metadata.gz: 3a5f7ab8a5f2d0e03064d80635e2857588ba3f983a2de14f9acbf62d37736ec9dd835217304aa7c5414ab4be44a2408cc83771ccfd94a82dcdb2e697ed5a0e80
+  data.tar.gz: 547f5b2e3886c9b9841339aec6751393807375c772e7d2175c9617422c65eb2811fe2c7f88768fa19339e586bad1ba578ff67646131d0880b3afc1779a8f9201

data/lib/proxy_method/version.rb

@@ -1,3 +1,3 @@
 module ProxyMethod
-  VERSION='1.2.3'
+  VERSION='1.2.5'
 end

data/lib/proxy_method.rb

@@ -3,6 +3,81 @@ module ProxyMethod
     DEFAULT_PROXY_MESSAGE = 'Disabled by proxy_method'
     DEFAULT_PREFIX = 'unproxied_'
 
+    ##
+    # Proxy one or more inherited class methods, so that they are not used
+    # directly. Given this base class:
+    #
+    #     class Animal
+    #       def self.create
+    #         'created'
+    #       end
+    #
+    #       def destroy
+    #         'destroyed'
+    #       end
+    #     end
+    #
+    # The simplest implementation is to pass just a single method name:
+    #
+    #     class Dog < Animal
+    #       proxy_class_method :create
+    #     end
+    #
+    #     Dog.create
+    #     # => RuntimeError: Disabled by proxy_method
+    #
+    #     Dog.destroy
+    #     # 'destroyed'
+    #
+    # Or multiple method names:
+    #
+    #     class Dog < Animal
+    #       proxy_class_method :create, :destroy
+    #     end
+    #
+    #     Dog.create
+    #     # => RuntimeError: Disabled by proxy_method
+    #
+    #     Dog.destroy
+    #     # => RuntimeError: Disabled by proxy_method
+    #
+    # With a custom error message:
+    #
+    #     class Dog < Animal
+    #       proxy_class_method :create, raise: 'Disabled!'
+    #     end
+    #
+    #     Dog.create
+    #     # => RuntimeError: Disabled!
+    #
+    # You can still access the unproxied version by prefixing 'unproxied'
+    # to the method name:
+    #
+    #     Dog.unproxied_create
+    #     # => 'created'
+    #
+    # And you can change the prefix for unproxied versions:
+    #
+    #     class Dog < Animal
+    #       proxy_class_method :create, prefix: 'original_'
+    #     end
+    #
+    #     Dog.original_create
+    #     # => 'created'
+    #
+    # Finally, you can actually *proxy* the method, by providing an
+    # alternative block of code to run:
+    #
+    #     class Dog < Animal
+    #       proxy_class_method(:create) do |object, method_name, *args, &block|
+    #         "indirectly #{object.send(method_name)}"
+    #       end
+    #     end
+    #
+    #     Dog.original_create
+    #     # => 'indirectly created'
+
+
     def proxy_class_method(*original_method_names, &proxy_block)
       options = if original_method_names.last.is_a?(Hash)
         original_method_names.pop
@@ -104,12 +179,12 @@ module ProxyMethod
       @_proxied_class_methods ||= {}
     end
 
-    def unproxy! # :nodoc:
+    def unproxy!
       @_proxy_class_methods_enabled = false
       self
     end
 
-    def reproxy! # :nodoc:
+    def reproxy!
       @_proxy_class_methods_enabled = true
       self
     end
@@ -119,10 +194,23 @@ module ProxyMethod
     base.extend ClassMethods
   end
 
+  ##
+  # Return an unproxied version of this instance.
+  #
+  # This returns a copy of the instance where all proxies are disabled. This is
+  # sometimes necessary when a proxied method is being called by a different
+  # method outside your control.
+
   def unproxied
     self.dup.send(:unproxy!)
   end
 
+  ##
+  # Return a proxied version of this instance.
+  #
+  # If the instance has previously been "unproxied", this returns a
+  # copy where all proxies are re-enabled.
+
   def proxied
     self.dup.send(:reproxy!)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: proxy_method
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.5
 platform: ruby
 authors:
 - Jaime Bellmyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-04 00:00:00.000000000 Z
+date: 2020-01-06 00:00:00.000000000 Z
 dependencies: []
 description: |2
       The purpose of this gem is to prevent directly running the inherited