visibility_checker 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0c5361039832d163132d6ed6735a0682ba89f2ba6cc25dac95f5e2a87ffd259a
+  data.tar.gz: db1a56409727393c6db2da6ced345647fa876698980ba567f3d64f39de82df92
+SHA512:
+  metadata.gz: f499de1f8dfb91855e20ecd67e6158078246dfdec97c19ca2d81a37eb1685c1d081f6b85b2468ba75c086eb15b29111adc5b46846a3c88d7b7eb5c00e739cdad
+  data.tar.gz: ba12a25846d8f653682d1e05558168c1d66a397a538f3f3eaf6cc67b0cc4b61bbe14bf4f7a94e362b3930f31223160dcb7370270745cae9dd9d5e98f383cd8c7

data/CHANGELOG

@@ -0,0 +1,3 @@
+=== 1.0.0 (2020-04-16)
+
+* Initial Public Release

data/MIT-LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2020 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 @@
+= VisibilityChecker
+
+VisibilityChecker exposes a single method, visibility_changes, for returning
+an array with places where any ancestor of the given class/module has changed the
+visibility of any of the methods classes/modules methods.
+
+= Installation
+
+  gem install visibility_checker
+
+= Source Code
+
+Source code is available on GitHub at https://github.com/jeremyevans/visibility_checker
+
+= Usage
+
+Here's an example showing normal use:
+
+  require 'visibility_checker'
+
+  class C
+    def a
+    end
+  end
+
+  VisibilityChecker.visibility_changes(C)
+  # => []
+
+  module M
+    def a
+    end
+  end
+  C.include M
+
+  VisibilityChecker.visibility_changes(C)
+  # => []
+
+  class C
+    private :a
+  end
+
+  VisibilityChecker.visibility_changes(C)
+  #  => [#<struct VisibilityChecker::VisibilityChange 
+  #        method=:a, defined_in=M, original_visibility=:public,
+  #        overridden_by=C, new_visibility=:private>]
+
+You can also extend classes or modules with +VisibilityChecker+
+and call +visibility_changes+ on them:
+
+  C.extend VisibilityChecker
+  C.visibility_changes
+  # => [#<struct VisibilityChecker::VisibilityChange ... >]
+
+Or if you want to add the +visibility_changes+ method to all
+classes and modules, have +Module+ include it:
+
+  Module.include VisibilityChecker
+  M.visibility_changes
+  # => []
+
++VisibilityChecker.visibility_changes+ accepts two keyword arguments:
+
+stop_at :: The ancestor at which to stop for visibility changes, Object
+           by default.
+skip_owners :: Skip reporting a visibility change if the method that
+               was overridden was defined in this module/class.  Set to
+               Kernel by default as general Ruby practice is that Kernel
+               methods can be overridden (e.g. Enumerable#select).
+
+= License
+
+MIT
+
+= Author
+
+Jeremy Evans <code@jeremyevans.net>

data/lib/visibility_checker.rb

@@ -0,0 +1,38 @@
+module VisibilityChecker
+  # Structure holding data on method visibility changes
+  VisibilityChange = Struct.new(:method, :defined_in, :original_visibility, :overridden_by, :new_visibility)
+
+  # Return an array of VisibilityChanges for any changes in method visibility in any
+  # of the the ancestors of +klass+ before +stop_at+, unless the owner of the method is
+  # in +skip_owners+.  This will be an empty array if there are no visibility changes.
+  def self.visibility_changes(klass, stop_at: Object, skip_owners: [Kernel])
+    meths = {}
+    changes = []
+
+    klass.ancestors.each do |mod|
+      break if mod == stop_at
+
+      [:public, :private, :protected].each do |vis_type|
+        mod.send("#{vis_type}_instance_methods").each do |meth|
+          prev_vis_type, prev_mod = meths[meth]
+          unless prev_vis_type.nil? || prev_vis_type == vis_type
+            owner = mod.instance_method(meth).owner
+            unless skip_owners.include?(owner)
+              changes << VisibilityChange.new(meth, mod.instance_method(meth).owner, vis_type, prev_mod, prev_vis_type)
+            end
+          end
+          meths[meth] = [vis_type, mod]
+        end
+      end
+    end
+
+    changes
+  end
+
+  # Detect visibility changes in the receiver's ancestors.  This should only
+  # be used if you are extending a class or module with VisibilityChecker or
+  # including it in Class or Module.
+  def visibility_changes
+    VisibilityChecker.visibility_changes(self)
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: visibility_checker
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jeremy Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-global_expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  VisibilityChecker exposes a single method, visibility_changes, for returning
+  an array with places where any ancestor of the given class has changed the
+  visibility of any of the classes's methods.
+email: code@jeremyevans.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- CHANGELOG
+- MIT-LICENSE
+files:
+- CHANGELOG
+- MIT-LICENSE
+- README.rdoc
+- lib/visibility_checker.rb
+homepage: http://github.com/jeremyevans/visibility_checker
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/jeremyevans/visibility_checker/issues
+  changelog_uri: https://github.com/jeremyevans/visibility_checker/blob/master/CHANGELOG
+  source_code_uri: https://github.com/jeremyevans/visibility_checker
+post_install_message: 
+rdoc_options:
+- "--quiet"
+- "--line-numbers"
+- "--inline-source"
+- "--title"
+- 'VisibilityChecker: Detect method visibility changes'
+- "--main"
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Detect method visibility changes
+test_files: []