deprecate_public 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 025fabce1f816909e8411a204224ee6e7f725678
+  data.tar.gz: e6ad2a3fbcb5836b2fc701160bf064794e81ed37
+SHA512:
+  metadata.gz: 1adfd5e7564c6d009116bff272d51ae20522db1ac2310d305f864e2826e3318802f012303433cfb703042cc3e0f59a0afba2cdc5d8f8173737eff6692f3af2fa
+  data.tar.gz: bc32579cfe6621f694c9c8dec37b37caf758eadb6e24e619eff279a18ffc195b4ac9f9d6b4fe1981282775650d06f86554327f266d087f90f195f41e92ae7bb6

data/CHANGELOG

@@ -0,0 +1,3 @@
+=== 1.0.0 (2017-12-13)
+
+* Initial public release

data/MIT-LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2017 Jeremy Evans
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+  
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+   
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,76 @@
+= ruby-deprecate_public
+
+ruby-deprecate_public exists so that library authors can take an
+existing public method in one of their classes, and make it a
+private method, but still allow it to be called as a public method,
+emitting a warning if called as a public method.
+
+== Usage
+
+=== Basic
+
+  require 'deprecate_public'
+  class Foo
+    private
+
+    def meth
+      :return_value
+    end
+  end
+
+  foo = Foo.new
+
+  foo.send(:meth)
+  # => :return_value
+
+  foo.meth
+  # raises NoMethodError: private method `meth' called for ...
+
+  Foo.deprecate_public :meth
+  foo.meth
+  # warning emitting: "calling Foo#meth using deprecated public interface"
+  # => :return_value
+
+=== Arguments
+
+  # Deprecate multiple methods at once
+  deprecate_public([:meth1, :meth2])
+
+  # Override message
+  deprecate_public(:meth1, "meth1 is private method, stop calling it!")
+
+== Design
+
+deprecate_public works by overriding method_missing, which is called
+if you call a private method with a specified receiver.  That's one
+of the reasons calling a private method raises NoMethodError instead
+of MethodVisibilityError or something like that.
+
+== Caveats
+
+While you can call +deprecate_public+ on a Module, you should only do so
+if the module has not been included in another Module or Class, as when
+called on a module it only affects future cases where the module was
+included in a class.
+
+== Installation
+
+ruby-deprecate_public is distributed as a gem, and can be installed with:
+
+  gem install deprecate_public
+
+== Source
+
+ruby-deprecate_public is hosted on GitHub:
+
+  https://github.com/jeremyevans/ruby-deprecate_public
+
+== Issues
+
+ruby-deprecate_public uses GitHub Issues for issue tracking:
+
+  https://github.com/jeremyevans/ruby-deprecate_public/issues
+
+== Author
+
+Jeremy Evans <code@jeremyevans.net>

data/Rakefile

@@ -0,0 +1,23 @@
+require "rake"
+require "rake/clean"
+require "rdoc/task"
+
+CLEAN.include ["*.gem", "rdoc"]
+RDOC_OPTS = ['--inline-source', '--line-numbers', '--title', 'deprecate_public: Warn when calling private methods via public interface', '--main', 'README.rdoc', '-f', 'hanna']
+
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.options += RDOC_OPTS
+  rdoc.rdoc_files.add %w"lib/deprecate_public.rb MIT-LICENSE CHANGELOG README.rdoc"
+end
+
+desc "Run specs"
+task :test do
+  sh "#{FileUtils::RUBY} -v test/deprecate_public_test.rb"
+end
+task :default=>[:test]
+
+desc "Package deprecate_public"
+task :package=>[:clean] do
+  sh "#{FileUtils::RUBY} -S gem build deprecate_public.gemspec"
+end

data/lib/deprecate_public.rb

@@ -0,0 +1,38 @@
+class Module
+  module DeprecatePublic
+    # Handle calls to methods where +deprecate_public+ has been called
+    # for the method, printing the warning and then using +send+ to
+    #invoke the method.
+    def method_missing(meth, *args, &block)
+      check_meth = "_deprecated_public_message_#{meth}"
+      if respond_to?(meth, true) && respond_to?(check_meth, true) && (msg = send(check_meth))
+        if RUBY_VERSION >= '2.5'
+          Kernel.warn(msg, :uplevel => 1)
+        else
+          Kernel.warn(msg)
+        end
+
+        send(meth, *args, &block)
+      else
+        super
+      end
+    end
+  end
+
+  # Allow but deprecate public method calls to +meth+, if +meth+ is
+  # protected or private.  +meth+ can be an array of method name strings
+  # or symbols to handle multiple methods at once.  If +msg+ is specified,
+  # it can be used to customize the warning printed.
+  def deprecate_public(meth, msg=nil)
+    include DeprecatePublic
+
+    Array(meth).each do |m|
+      message = (msg || "calling #{name}##{m} using deprecated public interface").dup.freeze
+      message_meth = :"_deprecated_public_message_#{m}"
+      define_method(message_meth){message}
+      private message_meth
+    end
+
+    nil
+  end
+end

data/test/deprecate_public_test.rb

@@ -0,0 +1,108 @@
+require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'lib', 'deprecate_public')
+require 'rubygems'
+gem 'minitest'
+require 'minitest/autorun'
+
+warnings = []
+(class << Kernel; self; end).module_eval do
+  define_method(:warn) do |*args|
+    warnings << args.first
+  end
+end
+
+class DPSTest
+  def pub; 1 end
+  def dep_pub; 8 end
+  deprecate_public(:dep_pub)
+
+  def test_prot(other)
+    other.prot
+  end
+  def test_dep_prot(other)
+    other.dep_prot
+  end
+
+  protected
+
+  def prot; 2 end
+  def dep_prot; 9 end
+  deprecate_public(:dep_prot)
+
+  private
+
+  def priv; 3 end
+  def dep_priv; 4 end
+  deprecate_public(:dep_priv)
+
+  def dep_priv1; 5 end
+  def dep_priv2; 6 end
+  deprecate_public([:dep_priv1, :dep_priv2])
+
+  def dep_priv_msg; 7 end
+  deprecate_public(:dep_priv_msg, "custom warning for dep_priv_msg")
+end
+
+class DPSTest2
+  def test_dep_prot(other)
+    other.dep_prot
+  end
+end
+
+describe "Module#deprecate_public" do
+  before do
+    @obj = DPSTest.new
+  end
+
+  after do
+    warnings.must_equal []
+  end
+
+  it "should not warn for methods if deprecate_public is not used and access should be allowed" do
+    @obj.pub.must_equal 1
+    @obj.test_prot(DPSTest.new).must_equal 2
+    @obj.instance_exec do
+      prot.must_equal 2
+      priv.must_equal 3
+    end
+  end
+
+  it "should raise NoMethodError for private/protected method calls if deprecate_public is not used" do
+    proc{@obj.prot}.must_raise NoMethodError
+    proc{@obj.priv}.must_raise NoMethodError
+  end
+
+  it "should not warn if methods are public and deprecate_public is used" do
+    @obj.dep_pub.must_equal 8
+  end
+
+  it "should not warn if methods are protected and deprecate_public is used and access should be allowed" do
+    @obj.test_dep_prot(DPSTest.new).must_equal 9
+  end
+
+  it "should warn if methods are private and deprecate_public is used" do
+    @obj.dep_priv.must_equal 4
+    @obj.dep_priv1.must_equal 5
+    @obj.dep_priv2.must_equal 6
+    @obj.dep_priv_msg.must_equal 7
+    warnings.must_equal [
+      "calling DPSTest#dep_priv using deprecated public interface",
+      "calling DPSTest#dep_priv1 using deprecated public interface",
+      "calling DPSTest#dep_priv2 using deprecated public interface",
+      "custom warning for dep_priv_msg"
+    ]
+    warnings.clear
+  end
+
+  it "should warn if methods are protected and deprecate_public is used" do
+    DPSTest2.new.test_dep_prot(@obj).must_equal 9
+    warnings.must_equal ["calling DPSTest#dep_prot using deprecated public interface"]
+    warnings.clear
+  end
+
+  it "should raise NoMethodError if the method is not defined" do
+    class << @obj
+      undef :dep_priv
+    end
+    proc{@obj.dep_priv}.must_raise NoMethodError
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: deprecate_public
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jeremy Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-13 00:00:00.000000000 Z
+dependencies: []
+description: Warn when calling private methods via public interface
+email: code@jeremyevans.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- CHANGELOG
+- MIT-LICENSE
+files:
+- CHANGELOG
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- lib/deprecate_public.rb
+- test/deprecate_public_test.rb
+homepage: https://github.com/jeremyevans/ruby-deprecate_public
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--quiet"
+- "--inline-source"
+- "--line-numbers"
+- "--title"
+- 'deprecate_public: Warn when calling private methods via public interface'
+- "--main"
+- README.rdoc
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Warn when calling private methods via public interface
+test_files: []