object_oculus 1.2.3 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13c75e4eff1e0a849c8a2162097995baa400503a112fb2c41c167a1ab91d194a
-  data.tar.gz: da3566f45634c1718bf235c95c58ce9762e4f1c0770206a460e09c11efa79fc2
+  metadata.gz: f6bf6c8c81d9d8151e5da58daa71c3eb340d87fce888472a9741af82b1f8eab2
+  data.tar.gz: 9244bf6c9509b7516ae71ed328eb83bb1749bc55a16a3da1382152968dabcd8e
 SHA512:
-  metadata.gz: 2489cd1b412bd62a5880de14a4452d816bef3a2e4693b482a8e1ffaae6db969854d52a027396c7d641028b9bd2174f7ea73136877a7f34d3a2b29dd0c6d6cdde
-  data.tar.gz: 3ed6a105543d05053b0ca088824e4b83ceffbd1785694260992dd17cb45b9e84cbedc1d4409cbc7daf2873beb2895d3e2bd15a9e42954b2a64fe6f555630e2cb
+  metadata.gz: db7b2a5fa81503cf677e221b05a332f6b9c2209ef538e0c1402c530f23e9270345f6db2c3498e269ace001eb3cb489337d8168149288a1831215b79865098cef
+  data.tar.gz: b0a4f2751afae3dbfc7106f10856f89ce1060efd3a5701cdf6e08928486347715ce82c02edf694a45ebe040b66acea95348434738c63a5dfcc5d5756955d5b44

data/Gemfile.lock

@@ -1,12 +1,23 @@
 PATH
   remote: .
   specs:
-    object_oculus (1.2.3)
+    object_oculus (1.2.4)
 
 GEM
   remote: http://rubygems.org/
   specs:
+    ast (2.4.2)
     diff-lcs (1.5.1)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    parallel (1.24.0)
+    parser (3.3.0.5)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.3)
+    rainbow (3.1.1)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -20,6 +31,21 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
+    rubocop (1.61.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.1)
+      parser (>= 3.3.0.4)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.5.0)
 
 PLATFORMS
   ruby
@@ -27,6 +53,7 @@ PLATFORMS
 DEPENDENCIES
   object_oculus!
   rspec (~> 3.0)
+  rubocop (~> 1.0)
 
 BUNDLED WITH
    2.5.6

data/lib/object_oculus/classic.rb

@@ -9,14 +9,14 @@ module ObjectOculus
   #   require "object_oculus/classic"
   #
   # or, if object_oculus is already loaded:
-  # 
+  #
   #   ObjectOculus::Classic  # which triggers object_oculus/classic to autoload
   module Classic
-    alias :what?      :what_equals
-    alias :exactly?   :whats_exactly
-    alias :matches?   :what_matches
-    alias :works?     :what_works_with
-    alias :not_blank? :whats_not_blank_with
+    alias what? what_equals
+    alias exactly? whats_exactly
+    alias matches? what_matches
+    alias works? what_works_with
+    alias not_blank? whats_not_blank_with
   end
 
   class MethodFinder
@@ -24,6 +24,6 @@ module ObjectOculus
   end
 end
 
-class Object  # :nodoc:
+class Object # :nodoc:
   include ObjectOculus::Classic
 end

data/lib/object_oculus/dummy_out.rb

@@ -4,7 +4,7 @@ module ObjectOculus
     # Does nothing (instead of writing to an IO stream)
     def write(*args)
     end
-    alias :print :write
-    alias :puts  :write
+    alias print write
+    alias puts write
   end
 end

data/lib/object_oculus/frozen_section.rb

@@ -21,7 +21,8 @@ module ObjectOculus
 
     # An override of Methods#show_methods that passes the object stored in <tt>@object</tt> instead of
     # +self+
-    def show_methods(expected_result, opts = {}, *args, &block)  # :doc:
+    # :doc:
+    def show_methods(expected_result, opts = {}, *args, &)
       @args = args unless args.empty?
       MethodFinder.show(@object, expected_result, opts, *@args)
     end

data/lib/object_oculus/method_finder.rb

@@ -3,16 +3,37 @@ module ObjectOculus
   # values with an expected result. ny matches will then be pretty printed to the console.
   class MethodFinder
     # A list of symbols indicated which methods to always ignore
-    @@blacklist  = %w(daemonize debug debugger display ed emacs exec exit! fork mate nano sleep
-                      stub stub! stub_chain syscall system unstub unstub! vi vim).map(&:to_sym)
+    @@blacklist = %w[
+      daemonize
+      debug
+      debugger
+      display
+      ed
+      emacs
+      exec
+      exit!
+      fork
+      mate
+      nano
+      sleep
+      stub
+      stub!
+      stub_chain
+      syscall
+      system
+      unstub
+      unstub!
+      vi
+      vim
+    ].map(&:to_sym)
     @@blacklist += Methods.instance_methods
 
     # A list of symbols for infix operators for which Ruby has special syntax
-    @@infixes    = %w(+ - * / % ** == != =~ !~ !=~ > < >= <= <=> === & | ^ << >>).map(&:to_sym)
-    
+    @@infixes = %w[+ - * / % ** == != =~ !~ !=~ > < >= <= <=> === & | ^ << >>].map(&:to_sym)
+
     # A list of symbols for prefix operators for which Ruby has special syntax
-    @@prefixes   = %w(+@ -@ ~ !).map(&:to_sym)
-    
+    @@prefixes = %w[+@ -@ ~ !].map(&:to_sym)
+
     class << self
       # Builds a lambda for checking against the provided +expected_result+ given a hash of options.
       # Given the value of a method, the result of this lambda will determine whether that method
@@ -37,7 +58,7 @@ module ObjectOculus
           if opts[:exclude_blank]
             ->(value) { !value.nil? && !(value.respond_to?(:empty?) && value.empty?) }
           else
-            ->(value) { true }
+            ->(_value) { true }
           end
         else
           ->(value) { expected_result == value }
@@ -46,7 +67,7 @@ module ObjectOculus
 
       # Find all methods on +an_object+ which, when called with +args+ return +expected_result+
       def find(an_object, expected_result, opts = {}, *args, &block)
-        check_result    = build_check_lambda(expected_result, opts)
+        check_result = build_check_lambda(expected_result, opts)
 
         # Prevent any writing to the terminal
         stdout, stderr = $stdout, $stderr
@@ -60,33 +81,32 @@ module ObjectOculus
         methods.select! { |n| an_object.method(n).arity <= args.size && !@@blacklist.include?(n) }
 
         # Collect all methods equaling the expected result
-        results = methods.inject({}) do |res, name|
+        results = methods.each_with_object({}) do |name, res|
           stdout.print ""
           begin
             value = an_object.clone.method(name).call(*args, &block)
             res[name] = value if check_result.call(value)
-          rescue
+          rescue StandardError
           end
-          res
         end
 
         # Restore printing to the terminal
         $stdout, $stderr = stdout, stderr if restore_std
         results
       end
-      
+
       # Pretty prints the results of #find
-      def show(an_object, expected_result, opts = {}, *args, &block)
+      def show(an_object, expected_result, opts = {}, *args, &)
         opts = {
           exclude_blank: false,
-          force_exact:   false,
-          force_regex:   false,
-          show_all:      false
+          force_exact: false,
+          force_regex: false,
+          show_all: false,
         }.merge(opts)
 
-        found      = find(an_object, expected_result, opts, *args, &block)
+        found = find(an_object, expected_result, opts, *args, &)
         prettified = prettify_found(an_object, found, *args)
-        max_length = prettified.map { |k, v| k.length }.max
+        max_length = prettified.map { |k, _v| k.length }.max
 
         prettified.each { |k, v| puts "#{k.ljust max_length} == #{v}" }
 
@@ -98,14 +118,14 @@ module ObjectOculus
       # Pretty prints a method depending on whether it's an operator, has arguments, is array/hash
       # syntax, etc.
       def prettify_found(an_object, found, *args)
-        args = args.map { |a| a.inspect }.join(", ")
+        args = args.map(&:inspect).join(", ")
         pretty_object = truncate_inspect(an_object, to: 40)
 
         found.map do |key, value|
           pretty_key = if @@infixes.include?(key)
                          "#{pretty_object} #{key} #{args}"
                        elsif @@prefixes.include?(key)
-                         "#{key.to_s.sub /\@$/, ""}#{pretty_object}"
+                         "#{key.to_s.sub(/@$/, '')}#{pretty_object}"
                        elsif key == :[]
                          "#{pretty_object}[#{args}]"
                        elsif args != ""
@@ -117,8 +137,8 @@ module ObjectOculus
           pretty_value =
             begin
               truncate_inspect(value, to: 120)
-            rescue => ex
-              ex.class
+            rescue StandardError => e
+              e.class
             end
 
           [pretty_key, pretty_value]
@@ -129,14 +149,14 @@ module ObjectOculus
       # provided <tt>to:</tt> argument if necessary
       def truncate_inspect(object, opts = {})
         max_length = opts[:to] || 80
-        full       = object.inspect
+        full = object.inspect
 
         if full.length > max_length
-          available_length = max_length - 5  # to account for the " ... "
-          left_cutoff      = available_length * 2 / 3
-          right_cutoff     = available_length - left_cutoff - 1
+          available_length = max_length - 5 # to account for the " ... "
+          left_cutoff = available_length * 2 / 3
+          right_cutoff = available_length - left_cutoff - 1
 
-          "#{full[0..left_cutoff]} ... #{full[-right_cutoff..-1]}"
+          "#{full[0..left_cutoff]} ... #{full[-right_cutoff..]}"
         else
           full
         end

data/lib/object_oculus/methods.rb

@@ -7,7 +7,7 @@ module ObjectOculus
     #   # => 5 + 1 == 6
     def given(*args)
       if frozen?
-        FrozenSection.new self, args: args
+        FrozenSection.new(self, args:)
       else
         @args = args
         self
@@ -16,33 +16,33 @@ module ObjectOculus
 
     # Outputs a list of methods and their values that equal an +expected_result+, allowing for some
     # coercion (e.g. <tt>5 == 5.0</tt>)
-    def what_equals(expected_result, *args, &block)
-      show_methods expected_result, {}, *args, &block
+    def what_equals(expected_result, ...)
+      show_methods(expected_result, {}, ...)
     end
 
     # Outputs a list of methods and their values that exactly equal an +expected_result+
-    def whats_exactly(expected_result, *args, &block)
-      show_methods expected_result, { force_exact: true }, *args, &block
+    def whats_exactly(expected_result, ...)
+      show_methods(expected_result, { force_exact: true }, ...)
     end
 
     # Outputs a list of methods and their values that match an +expected_result+, which is coerced
     # into a regular expression if it's not already one
-    def what_matches(expected_result, *args, &block)
-      show_methods expected_result, { force_regex: true }, *args, &block
+    def what_matches(expected_result, ...)
+      show_methods(expected_result, { force_regex: true }, ...)
     end
 
     # Outputs a list of all methods and their values
-    def what_works_with(*args, &block)
-      show_methods nil, { show_all: true }, *args, &block
+    def what_works_with(...)
+      show_methods(nil, { show_all: true }, ...)
     end
-    alias :what_works :what_works_with
+    alias what_works what_works_with
 
     # Outputs a list of all methods and their values, provided they are not blank (nil, false,
     # undefined, empty)
-    def whats_not_blank_with(*args, &block)
-      show_methods nil, { show_all: true, exclude_blank: true }, *args, &block
+    def whats_not_blank_with(...)
+      show_methods(nil, { show_all: true, exclude_blank: true }, ...)
     end
-    alias :whats_not_blank :whats_not_blank_with
+    alias whats_not_blank whats_not_blank_with
 
     # The list of all methods unique to an object
     def unique_methods
@@ -51,14 +51,13 @@ module ObjectOculus
 
     # Lists all methods available to the object by ancestor
     def methods_by_ancestor
-      ([self] + self.class.ancestors).inject({}) do |result, object|
+      ([self] + self.class.ancestors).each_with_object({}) do |object, result|
         result[object] = object.unique_methods
-        result
       end
     end
 
     # Make sure cloning doesn't cause anything to fail via type errors
-    alias_method :__clone__, :clone
+    alias __clone__ clone
 
     # Adds in a type error check to the default Object#clone method to prevent any interruptions while
     # checking methods. If a TypeError is encountered, +self+ is returned
@@ -72,9 +71,10 @@ module ObjectOculus
 
     # Called by all of the +what_+ methods, this tells MethodFinder to output the result for any methods
     # matching an +expected_result+ for the #given arguments
-    def show_methods(expected_result, opts = {}, *args, &block)  # :doc:
+    # :doc:
+    def show_methods(expected_result, opts = {}, *args, &)
       @args = args unless args.empty?
-      MethodFinder.show(self, expected_result, opts, *@args, &block)
+      MethodFinder.show(self, expected_result, opts, *@args, &)
     end
   end
 end

data/lib/object_oculus/version.rb

@@ -1,4 +1,4 @@
 module ObjectOculus
   # The current version
-  VERSION = "1.2.3"
+  VERSION = "1.2.4"
 end

data/lib/object_oculus.rb

@@ -1,37 +1,37 @@
-# object_oculus enables you to determine what methods can be called on an object that return a given
-# value
-#
-# === Some credits from Dr. Nic
-#
-# Code this version is based on: {Andrew
-# Birkett's}[http://www.nobugs.org/developer/ruby/method_finder.html]
-#
-# Improvements from Why's blog entry:
-# * +what?+ - Why
-# * <tt>@@blacklist</tt> - llasram
-# * +clone+ alias - Daniel Schierbeck
-# * <tt>$stdout</tt> redirect - Why
-#
-# {Improvements from Nikolas Coukouma}[http://atrustheotaku.livejournal.com/339449.html]
-# * Varargs and block support
-# * Improved catching
-# * Redirecting <tt>$stdout</tt> and <tt>$stderr</tt> (independently of Why)
-#
-# {A version posted in 2002 by Steven
-# Grady}[http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/32844]
-#
-# David Tran's versions:
-# * Simple[http://www.doublegifts.com/pub/ruby/methodfinder.rb.html]
-# * {Checks permutations of arguments}[http://www.doublegifts.com/pub/ruby/methodfinder2.rb.html]
-module ObjectOculus
-  autoload :Classic,       "object_oculus/classic"
-  autoload :DummyOut,      "object_oculus/dummy_out"
-  autoload :FrozenSection, "object_oculus/frozen_section"
-  autoload :MethodFinder,  "object_oculus/method_finder"
-  autoload :Methods,       "object_oculus/methods"
-  autoload :VERSION,       "object_oculus/version"
-end
-
-class Object  # :nodoc:
-  include ObjectOculus::Methods
-end
+# object_oculus enables you to determine what methods can be called on an object that return a given
+# value
+#
+# === Some credits from Dr. Nic
+#
+# Code this version is based on: {Andrew
+# Birkett's}[http://www.nobugs.org/developer/ruby/method_finder.html]
+#
+# Improvements from Why's blog entry:
+# * +what?+ - Why
+# * <tt>@@blacklist</tt> - llasram
+# * +clone+ alias - Daniel Schierbeck
+# * <tt>$stdout</tt> redirect - Why
+#
+# {Improvements from Nikolas Coukouma}[http://atrustheotaku.livejournal.com/339449.html]
+# * Varargs and block support
+# * Improved catching
+# * Redirecting <tt>$stdout</tt> and <tt>$stderr</tt> (independently of Why)
+#
+# {A version posted in 2002 by Steven
+# Grady}[http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/32844]
+#
+# David Tran's versions:
+# * Simple[http://www.doublegifts.com/pub/ruby/methodfinder.rb.html]
+# * {Checks permutations of arguments}[http://www.doublegifts.com/pub/ruby/methodfinder2.rb.html]
+module ObjectOculus
+  autoload :Classic, "object_oculus/classic"
+  autoload :DummyOut, "object_oculus/dummy_out"
+  autoload :FrozenSection, "object_oculus/frozen_section"
+  autoload :MethodFinder, "object_oculus/method_finder"
+  autoload :Methods, "object_oculus/methods"
+  autoload :VERSION, "object_oculus/version"
+end
+
+class Object # :nodoc:
+  include ObjectOculus::Methods
+end

data/object_oculus.gemspec

@@ -1,22 +1,24 @@
-$LOAD_PATH.push File.expand_path("../lib", __FILE__)
+$LOAD_PATH.push File.expand_path("lib", __dir__)
 require "object_oculus/version"
 
 Gem::Specification.new do |s|
-  s.name        = "object_oculus"
-  s.authors     = ["Jason Cheong-Kee-You", "Bryan McKelvey", "Dr Nic Williams"]
-  s.email       = "j.chunky@gmail.com"
-  s.homepage    = "https://github.com/jchunky/object_oculus"
-  s.licenses    = ['MIT']
-  s.platform    = Gem::Platform::RUBY
-  s.version     = ObjectOculus::VERSION
-  s.summary     = "Rapidly explore an object's API in 'irb'"
+  s.name = "object_oculus"
+  s.authors = ["Jason Cheong-Kee-You", "Bryan McKelvey", "Dr Nic Williams"]
+  s.email = "j.chunky@gmail.com"
+  s.homepage = "https://github.com/jchunky/object_oculus"
+  s.licenses = ["MIT"]
+  s.platform = Gem::Platform::RUBY
+  s.version = ObjectOculus::VERSION
+  s.summary = "Rapidly explore an object's API in 'irb'"
   s.description = <<~DESCRIPTION
     ObjectOculus is a ruby tool for viewing all of an object's methods and seeing what those
     methods return. ObjectOculus can be used in 'irb' to rapidly explore an object's API.
   DESCRIPTION
 
-  s.files         = `git ls-files`.split("\n")
+  s.files = `git ls-files`.split("\n")
   s.require_paths = ["lib"]
 
   s.add_development_dependency "rspec", "~> 3.0"
+  s.add_development_dependency "rubocop", "~> 1.0"
+  s.metadata["rubygems_mfa_required"] = "true"
 end

data/spec/frozen_section_spec.rb

@@ -20,4 +20,4 @@ RSpec.describe FrozenSection do
       expect(@string.given(1)).to be_a(FrozenSection)
     end
   end
-end
+end

data/spec/methods_spec.rb

@@ -57,4 +57,4 @@ RSpec.describe Methods do
       end
     end
   end
-end
+end

data/spec/spec_helper.rb

@@ -3,5 +3,5 @@ require "object_oculus"
 include ObjectOculus
 
 RSpec.configure do |config|
-  config.deprecation_stream = '/dev/null'
+  config.deprecation_stream = "/dev/null"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: object_oculus
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.4
 platform: ruby
 authors:
 - Jason Cheong-Kee-You
@@ -26,6 +26,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: |
   ObjectOculus is a ruby tool for viewing all of an object's methods and seeing what those
   methods return. ObjectOculus can be used in 'irb' to rapidly explore an object's API.
@@ -55,7 +69,8 @@ files:
 homepage: https://github.com/jchunky/object_oculus
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths: