proxy_method 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d326c1e11ed5cd4cc667d4687a7290d0fb157284a51d19a8fbf08ba1f97c65cf
+  data.tar.gz: 986f2c19ece82f97e8f28c6d846f14661e2ba400d28983f28ce04c786052bcb9
+SHA512:
+  metadata.gz: da246a3fd150d0f55649db524a7b0f68205aaaa59885b382b42ee3fb8705512e0093138760a827f677401483778c5dda94d1a87982171216a47e34f91813261e
+  data.tar.gz: daefa8c60fe9e5bf4f29cac4cf87ae8aaf80e1c4f9f7fef4ef91d3a3a7e699d883b8990ce7a294901bbd08ec9643897e0f03a3d56b4f774382320c08a9e34156

data/README.md

@@ -0,0 +1,118 @@
+# proxy_method
+
+Prevent running an inherited method directly.
+
+The purpose of this gem is to prevent directly running the inherited
+methods you choose to block, and instead raise a custom Error message.
+The original method can still be called under a different name.
+
+This was created to help enforce the use of interactors over directly
+calling ActiveRecord methods like create, save, and update. One downside
+of interactors is that they require top-of-mind awareness in order to use
+them, and by default new/forgetful/overworked developers will create
+ActiveRecord instances all willy nilly until society crumbles.
+
+While this was created for ActiveRecord models specifically, it works
+with *any* inherited methods. The method being proxied has to already
+exist, or it can't be overridden.
+
+## Usage
+
+Given these basic classes:
+
+    class Animal
+      def self.create
+        'created'
+      end
+    
+      def save
+        'saved'
+      end
+      
+      def update
+        'updated'
+      end
+    end
+    
+    class Turtle < Animal
+      include ProxyMethod
+    
+      proxy_class_method :create
+      proxy_instance_method :save
+      
+      # for instance methods, you can also just call "proxy_method"
+      proxy_method :update
+    end
+
+You can do this:
+
+    Turtle.create
+    # => RuntimeError: Disabled by proxy_method
+    
+    Turtle.new.save
+    # => RuntimeError: Disabled by proxy_method
+    
+    Turtle.proxied_create
+    # => 'created'
+    
+    Turtle.new.proxied_save
+    # => 'saved'
+
+Specify a custom error message:
+
+    class CustomCow < Animal
+      include ProxyMethod
+      
+      proxy_method :save, message: "Don't save here, use an interactor!"
+    end
+    
+    CustomCow.new.save
+    # => RunTimeError: Don't save here, use an interactor!
+
+Specify multiple methods at once:
+
+    class MultiMonkey < Animal
+      include ProxyMethod
+      
+      proxy_method [:save, :update], message: "Use an interactor!"
+    end
+    
+    MultiMonkey.new.save
+    # => RunTimeError: Use an interactor!
+    
+    MultiMonkey.new.update
+    # => RunTimeError: Use an interactor!    
+
+Supply your own prefix for the original, unproxied method:
+
+    class PrefixPelican < Animal
+      include ProxyMethod
+      
+      proxy_method :save, prefix: 'pelican'
+    end
+    
+    PrefixPelican.new.pelican_save
+    # => 'saved'
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'proxy_method'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install proxy_method
+```
+
+## Contributing
+Feel free to fork and create a pull request. 
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/lib/proxy_method.rb

@@ -0,0 +1,32 @@
+module ProxyMethod
+  module ClassMethods
+    DEFAULT_PROXY_MESSAGE = 'Disabled by proxy_method'
+    DEFAULT_PREFIX = 'unproxied_'
+
+    def proxy_class_method(original_method_names, options = {})
+      error_message = options[:message] || DEFAULT_PROXY_MESSAGE
+      prefix = options[:prefix] || DEFAULT_PREFIX
+
+      Array(original_method_names).each do |original_method_name|
+        self.singleton_class.send(:alias_method, :"#{prefix}#{original_method_name}", original_method_name)
+        define_singleton_method(original_method_name){ raise error_message }
+      end
+    end
+
+    def proxy_instance_method(original_method_names, options = {})
+      error_message = options[:message] || DEFAULT_PROXY_MESSAGE
+      prefix = options[:prefix] || DEFAULT_PREFIX
+
+      Array(original_method_names).each do |original_method_name|
+        alias_method :"#{prefix}#{original_method_name}", original_method_name
+        define_method(original_method_name){ raise error_message }
+      end
+    end
+
+    alias_method :proxy_method, :proxy_instance_method
+  end
+
+  def self.included(base)
+    base.extend ClassMethods
+  end
+end

data/lib/proxy_method/version.rb

@@ -0,0 +1,3 @@
+module ProxyMethod
+  VERSION = '0.1.0'
+end

data/test/test_proxy_method.rb

@@ -0,0 +1,171 @@
+require 'minitest/autorun'
+require 'proxy_method'
+
+class Animal
+  def self.create
+    'created'
+  end
+
+  def self.destroy_all
+    'destroyed'
+  end
+
+  def save
+    'saved'
+  end
+
+  def update
+    'updated'
+  end
+end
+
+class Turtle < Animal
+  include ProxyMethod
+
+  proxy_class_method :create, message: "Don't Create directly, use Interactor!"
+  proxy_instance_method :update, message: "Don't Update directly, use Interactor!"
+  proxy_method :save, message: "Don't Save directly, use Interactor!"
+end
+
+class DefaultDuck < Animal
+  include ProxyMethod
+
+  proxy_class_method :create
+  proxy_method :save
+end
+
+class MultiMonkey < Animal
+  include ProxyMethod
+
+  proxy_class_method [:create, :destroy_all]
+  proxy_method [:save, :update]
+end
+
+class PrefixPelican < Animal
+  include ProxyMethod
+
+  proxy_class_method :create, prefix: 'pelican_'
+  proxy_method :save, prefix: 'pelican_'
+end
+
+class ProxyMethodTest < MiniTest::Test
+  describe "proxying class methods" do
+    it "does not allow original method name to be called" do
+      exception = assert_raises StandardError do
+        Turtle.create
+      end
+
+      assert_equal "Don't Create directly, use Interactor!", exception.message
+    end
+
+    it "allows proxied method name to be called" do
+      assert 'created', Turtle.unproxied_create
+    end
+
+    it "does not confuse proxied class method with instance method" do
+      assert_raises NoMethodError do
+        Turtle.save
+      end
+
+      assert_raises NoMethodError do
+        Turtle.unproxied_save
+      end
+    end
+
+    it "provides default error message" do
+      exception = assert_raises StandardError do
+        DefaultDuck.create
+      end
+
+      assert_equal "Disabled by proxy_method", exception.message
+    end
+
+    it "allows for multiple methods to be proxied in one call" do
+      exception = assert_raises StandardError do
+        MultiMonkey.create
+      end
+
+      assert_equal "Disabled by proxy_method", exception.message
+
+      exception = assert_raises StandardError do
+        MultiMonkey.destroy_all
+      end
+
+      assert_equal "Disabled by proxy_method", exception.message
+    end
+
+    it "allows for a custom prefix" do
+      exception = assert_raises StandardError do
+        PrefixPelican.create
+      end
+
+      assert_equal "Disabled by proxy_method", exception.message
+
+      assert 'created', PrefixPelican.pelican_create
+    end
+  end
+
+  describe "proxying instance methods" do
+    it "does not allow original method name to be called" do
+      exception = assert_raises StandardError do
+        Turtle.new.save
+      end
+
+      assert_equal "Don't Save directly, use Interactor!", exception.message
+    end
+
+    it "allows proxied method name to be called" do
+      assert 'saved', Turtle.new.unproxied_save
+    end
+
+    it "does not confuse proxied class method with instance method" do
+      assert_raises NoMethodError do
+        Turtle.new.create
+      end
+
+      assert_raises NoMethodError do
+        Turtle.new.unproxied_create
+      end
+    end
+
+    it "aliases proxy_method to proxy_instance_method" do
+      exception = assert_raises StandardError do
+        Turtle.new.update
+      end
+
+      assert_equal "Don't Update directly, use Interactor!", exception.message
+    end
+
+    it "provides default error message" do
+      exception = assert_raises StandardError do
+        DefaultDuck.new.save
+      end
+
+      assert_equal "Disabled by proxy_method", exception.message
+    end
+
+    it "allows for multiple methods to be proxied in one call" do
+      exception = assert_raises StandardError do
+        MultiMonkey.new.save
+      end
+
+      assert_equal "Disabled by proxy_method", exception.message
+
+      exception = assert_raises StandardError do
+        MultiMonkey.new.update
+      end
+
+      assert_equal "Disabled by proxy_method", exception.message
+    end
+
+    it "allows for a custom prefix" do
+      exception = assert_raises StandardError do
+        PrefixPelican.new.save
+      end
+
+      assert_equal "Disabled by proxy_method", exception.message
+
+      assert 'saved', PrefixPelican.new.pelican_save
+    end
+  end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: proxy_method
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jaime Bellmyer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-18 00:00:00.000000000 Z
+dependencies: []
+description: |2
+      The purpose of this gem is to prevent directly running the inherited
+      methods you choose to block, and instead raise a custom Error message.
+      The original method can still be called under a different name.
+
+      This was created to help enforce the use of interactors over directly
+      calling ActiveRecord methods like create, save, and update.
+email:
+- online@bellmyer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/proxy_method.rb
+- lib/proxy_method/version.rb
+- test/test_proxy_method.rb
+homepage: https://rubygems.org/gems/proxy_method
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Prevent running an inherited method directly
+test_files: []