proxy_method 1.2.5 → 1.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30dca7d6e6868dad470c1c00056727bfc78c0c1ec457d95876c0fd42cd2b8bb5
-  data.tar.gz: d805267647962b76433660771e691090fd94b0c23643ae704916b11aaaa5fa65
+  metadata.gz: 6f4af87ac13ed1ecd407497936bce7b5e57f16be2348460de75c65c490a756ec
+  data.tar.gz: 344cc71d86ce1c8af010fe28ef7e8c6040de4237e2673806fbd822595927f684
 SHA512:
-  metadata.gz: 3a5f7ab8a5f2d0e03064d80635e2857588ba3f983a2de14f9acbf62d37736ec9dd835217304aa7c5414ab4be44a2408cc83771ccfd94a82dcdb2e697ed5a0e80
-  data.tar.gz: 547f5b2e3886c9b9841339aec6751393807375c772e7d2175c9617422c65eb2811fe2c7f88768fa19339e586bad1ba578ff67646131d0880b3afc1779a8f9201
+  metadata.gz: 379a2267013b8b47ee6c901a87acac2794103f049651b0eb50743d2deb5477afc14acb0ce94d38b4940ca19dcbf15138745484138e903e1a3ace957beecf1409
+  data.tar.gz: d54ad49a095ec66ade4d46dfd299f835b651fa09554b79e3c59d98512643c8f1ac4827f9720b7e623e6bd09cb35603a2c6f3fd834a4cd9f63fa8fce6e86b0688

data/lib/proxy_method.rb

@@ -50,7 +50,7 @@ module ProxyMethod
     #     Dog.create
     #     # => RuntimeError: Disabled!
     #
-    # You can still access the unproxied version by prefixing 'unproxied'
+    # You can still access the unproxied version by prefixing 'unproxied_'
     # to the method name:
     #
     #     Dog.unproxied_create
@@ -74,10 +74,9 @@ module ProxyMethod
     #       end
     #     end
     #
-    #     Dog.original_create
+    #     Dog.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
@@ -109,6 +108,87 @@ module ProxyMethod
       end
     end
 
+    ##
+    # Proxy one or more inherited instance methods, so that they are not used
+    # directly. Given this base class:
+    #
+    #     class Animal
+    #       def save
+    #         'saved'
+    #       end
+    #
+    #       def update
+    #         'updated'
+    #       end
+    #     end
+    #
+    # The simplest implementation is to pass just a single method name:
+    #
+    #     class Dog < Animal
+    #       proxy_instance_method :save
+    #     end
+    #
+    #     Dog.new.save
+    #     # => RuntimeError: Disabled by proxy_method
+    #
+    #     Dog.new.upate
+    #     # 'updated'
+    #
+    #
+    # Or use the shorthand form:
+    #
+    #     class Dog < Animal
+    #       proxy_method :save
+    #     end
+    #
+    # Or multiple method names:
+    #
+    #     class Dog < Animal
+    #       proxy_method :save, :update
+    #     end
+    #
+    #     Dog.new.save
+    #     # => RuntimeError: Disabled by proxy_method
+    #
+    #     Dog.new.update
+    #     # => RuntimeError: Disabled by proxy_method
+    #
+    # With a custom error message:
+    #
+    #     class Dog < Animal
+    #       proxy_method :save, raise: 'Disabled!'
+    #     end
+    #
+    #     Dog.new.save
+    #     # => RuntimeError: Disabled!
+    #
+    # You can still access the unproxied version by prefixing 'unproxied_'
+    # to the method name:
+    #
+    #     Dog.new.unproxied_save
+    #     # => 'saved'
+    #
+    # And you can change the prefix for unproxied versions:
+    #
+    #     class Dog < Animal
+    #       proxy_method :save, prefix: 'original_'
+    #     end
+    #
+    #     Dog.new.original_save
+    #     # => 'saved'
+    #
+    # Finally, you can actually *proxy* the method, by providing an
+    # alternative block of code to run:
+    #
+    #     class Dog < Animal
+    #       proxy_method(:save) do |object, method_name, *args, &block|
+    #         "indirectly #{object.send(method_name)}"
+    #       end
+    #     end
+    #
+    #     Dog.new.save
+    #     # => 'indirectly saved'
+
     def proxy_instance_method(*original_method_names, &proxy_block)
       options = if original_method_names.last.is_a?(Hash)
         original_method_names.pop

data/lib/proxy_method/version.rb

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

metadata

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