deprecate_public 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 025fabce1f816909e8411a204224ee6e7f725678
-  data.tar.gz: e6ad2a3fbcb5836b2fc701160bf064794e81ed37
+SHA256:
+  metadata.gz: ab37faf4d1b174216b1792ae0445c764e6496021a352d8a10f679585a275609a
+  data.tar.gz: bce063415049ac301059cda3f01aa78496326faaab26a481f4db49c805bdcf47
 SHA512:
-  metadata.gz: 1adfd5e7564c6d009116bff272d51ae20522db1ac2310d305f864e2826e3318802f012303433cfb703042cc3e0f59a0afba2cdc5d8f8173737eff6692f3af2fa
-  data.tar.gz: bc32579cfe6621f694c9c8dec37b37caf758eadb6e24e619eff279a18ffc195b4ac9f9d6b4fe1981282775650d06f86554327f266d087f90f195f41e92ae7bb6
+  metadata.gz: ebb882d17816dd086e6470db2d0ca46ad3672e16706f827ee39070367bcbbe4120f8e2aff8f383eac29ac5a94d8c026738f83a9ecb6cd65fc5aecbef5a58f1fd
+  data.tar.gz: 364e7d2e9eb435e6d1896a4ea5f603fe1828f7a30b0d2b8bf2aa7bd2a3bd42b2ff3927c6e2ab51f4eed7ad07556fed4cdcafca314e1c37abc908a98459171db0

data/CHANGELOG

@@ -1,3 +1,9 @@
+=== 1.1.0 (2019-04-24)
+
+* Add Module#deprecate_public_constant on Ruby 2.6+ (jeremyevans)
+
+* Work on Ruby 1.8+, fix tests on Ruby 2.0-2.4 (jeremyevans)
+
 === 1.0.0 (2017-12-13)
 
 * Initial public release

data/README.rdoc

@@ -5,6 +5,10 @@ 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.
 
+On Ruby 2.6+, you can also take an existing public constant,
+make it a private constant, but still allow it to be accessed as a
+public constant, emitting a warning if accessed as a public constant.
+
 == Usage
 
 === Basic
@@ -31,6 +35,21 @@ emitting a warning if called as a public method.
   # warning emitting: "calling Foo#meth using deprecated public interface"
   # => :return_value
 
+  ## Ruby 2.6+: Deprecating Constants
+
+  class Foo
+    BAR = 1
+    private_constant :BAR
+  end
+
+  Foo::BAR
+  # raises NameError: private constant Foo::BAR referenced
+
+  Foo.deprecate_public_constant :Bar
+  Foo::BAR
+  # warning emitting: "accessing Foo::BAR using deprecated public interface"
+  # => 1
+
 === Arguments
 
   # Deprecate multiple methods at once
@@ -39,19 +58,26 @@ emitting a warning if called as a public method.
   # Override message
   deprecate_public(:meth1, "meth1 is private method, stop calling it!")
 
+  # Ruby 2.6+: deprecate_public_constant uses same interface
+
 == Design
 
-deprecate_public works by overriding method_missing, which is called
++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.
+of the reasons calling a private method raises +NoMethodError+ instead
+of +MethodVisibilityError+ or something like that.
+
+On Ruby 2.6+, +deprecate_public_constant+ works by overriding
++const_missing+, which is called if you access a constant using the
+public interface (<tt>Foo::BAR</tt> in the above example).
 
 == 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.
+included in a class.  The same is true for +deprecate_public_constant+
+on Ruby 2.6+..
 
 == Installation
 

data/lib/deprecate_public.rb

@@ -2,14 +2,16 @@ 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.
+    # 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)
+        elsif RUBY_VERSION >= '2.0'
+          Kernel.warn("#{caller(1,1)[0].sub(/in `.*'\z/, '')} warning: #{msg}")
         else
-          Kernel.warn(msg)
+          Kernel.warn("#{caller(1)[0].sub(/in `.*'\z/, '')} warning: #{msg}")
         end
 
         send(meth, *args, &block)
@@ -35,4 +37,38 @@ class Module
 
     nil
   end
+
+  if RUBY_VERSION >= '2.6'
+    module DeprecatePublicConstant
+      # Handle access to constants where +deprecate_public_constant+ has been called
+      # for the constant, printing the warning and then using +const_get+ to
+      # access the constant.
+      def const_missing(const)
+        check_meth = "_deprecated_public_constant_message_#{const}"
+        if const_defined?(const, true) && respond_to?(check_meth, true) && (msg = send(check_meth))
+          Kernel.warn(msg, :uplevel => 1)
+          const_get(const, true)
+        else
+          super
+        end
+      end
+    end
+
+    # Allow but deprecate public constant access to +const+, if +const+ is
+    # a private constant.  +const+ 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_constant(const, msg=nil)
+      extend DeprecatePublicConstant
+
+      Array(const).each do |c|
+        message = (msg || "accessing #{name}::#{c} using deprecated public interface").dup.freeze
+        message_meth = :"_deprecated_public_constant_message_#{c}"
+        define_singleton_method(message_meth){message}
+        singleton_class.send(:private, message_meth)
+      end
+
+      nil
+    end
+  end
 end

data/test/deprecate_public_test.rb

@@ -1,16 +1,39 @@
 require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'lib', 'deprecate_public')
 require 'rubygems'
+ENV['MT_NO_PLUGINS'] = '1' # Work around stupid autoloading of plugins
 gem 'minitest'
 require 'minitest/autorun'
 
 warnings = []
 (class << Kernel; self; end).module_eval do
   define_method(:warn) do |*args|
-    warnings << args.first
+    warnings << if args.last == {:uplevel => 1}
+      args.first
+    else
+      args.first.sub(/\A.+warning: (.+)\z/, '\1')
+    end
   end
 end
 
 class DPSTest
+  if RUBY_VERSION >= '2.6'
+    PUB = 1
+
+    DEPPUB = 2
+    deprecate_public_constant :DEPPUB
+
+    PRIV = 3
+    private_constant :PRIV
+
+    DEPPRIV = 4
+    private_constant :DEPPRIV
+    deprecate_public_constant :DEPPRIV
+
+    DEPPRIV2 = 5
+    private_constant :DEPPRIV2
+    deprecate_public_constant :DEPPRIV2, "custom warning for DEPPRIV2"
+  end
+
   def pub; 1 end
   def dep_pub; 8 end
   deprecate_public(:dep_pub)
@@ -51,6 +74,7 @@ end
 describe "Module#deprecate_public" do
   before do
     @obj = DPSTest.new
+    warnings.clear
   end
 
   after do
@@ -106,3 +130,45 @@ describe "Module#deprecate_public" do
     proc{@obj.dep_priv}.must_raise NoMethodError
   end
 end
+
+if RUBY_VERSION >= '2.6'
+describe "Module#deprecate_public_constant" do
+  before do
+    warnings.clear
+  end
+  after do
+    warnings.must_equal []
+  end
+
+  it "should not warn for constant if deprecate_public_constant is not used and access should be allowed" do
+    DPSTest::PUB.must_equal 1
+    class DPSTest
+      PRIV.must_equal 3
+    end
+  end
+
+  it "should raise NameError for private constants if deprecate_public_constant is not used" do
+    proc{DPSTest::PRIV}.must_raise NameError
+  end
+
+  it "should not warn if constants are public and deprecate_public_constant is used" do
+    DPSTest::DEPPUB.must_equal 2
+  end
+
+  it "should warn if constants are private and deprecate_public_constant is used" do
+    DPSTest::DEPPRIV.must_equal 4
+    DPSTest::DEPPRIV2.must_equal 5
+    warnings.must_equal [
+      "accessing DPSTest::DEPPRIV using deprecated public interface",
+      "custom warning for DEPPRIV2"
+    ]
+    warnings.clear
+  end
+
+  it "should raise NameError if the constant is not defined" do
+    c = Class.new
+    c.deprecate_public_constant :PUB
+    proc{c::PUB}.must_raise NameError
+  end
+end
+end

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: deprecate_public
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-13 00:00:00.000000000 Z
+date: 2019-04-24 00:00:00.000000000 Z
 dependencies: []
-description: Warn when calling private methods via public interface
+description: Warn when calling private methods and accessing private constants via
+  public interface
 email: code@jeremyevans.net
 executables: []
 extensions: []
@@ -35,7 +36,8 @@ rdoc_options:
 - "--inline-source"
 - "--line-numbers"
 - "--title"
-- 'deprecate_public: Warn when calling private methods via public interface'
+- 'deprecate_public: Warn when calling private methods and accessing private constants
+  via public interface'
 - "--main"
 - README.rdoc
 require_paths:
@@ -51,9 +53,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Warn when calling private methods via public interface
+summary: Warn when calling private methods and accessing private constants via public
+  interface
 test_files: []