amazing_print 1.3.0 → 1.4.0

data/spec/ext/ripple_spec.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# rubocop:disable Lint/ConstantDefinitionInBlock
+
 require 'spec_helper'
 
 RSpec.describe 'AmazingPrint/Ripple', skip: -> { !ExtVerifier.has_ripple? }.call do
@@ -24,7 +26,7 @@ RSpec.describe 'AmazingPrint/Ripple', skip: -> { !ExtVerifier.has_ripple? }.call
     @ap = AmazingPrint::Inspector.new plain: true, sort_keys: true
   end
 
-  it 'should print class instance' do
+  it 'prints class instance' do
     user = RippleUser.new _id: '12345', first_name: 'Al', last_name: 'Capone'
     out = @ap.send :awesome, user
 
@@ -37,7 +39,7 @@ RSpec.describe 'AmazingPrint/Ripple', skip: -> { !ExtVerifier.has_ripple? }.call
     EOS
   end
 
-  it 'should print the class' do
+  it 'prints the class' do
     expect(@ap.send(:awesome, RippleUser)).to eq <<~EOS.strip
       class RippleUser < Object {
                  :_id => :string,
@@ -47,3 +49,5 @@ RSpec.describe 'AmazingPrint/Ripple', skip: -> { !ExtVerifier.has_ripple? }.call
     EOS
   end
 end
+
+# rubocop:enable Lint/ConstantDefinitionInBlock

data/spec/formats_spec.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# rubocop:disable Lint/ConstantDefinitionInBlock
+
 require 'spec_helper'
 require 'bigdecimal'
 require 'set'
@@ -159,7 +161,7 @@ RSpec.describe 'AmazingPrint' do
 
   #------------------------------------------------------------------------------
   describe 'Limited Output Array' do
-    before(:each) do
+    before do
       @arr = (1..1000).to_a
     end
 
@@ -227,7 +229,7 @@ RSpec.describe 'AmazingPrint' do
 
   #------------------------------------------------------------------------------
   describe 'Limited Output Hash' do
-    before(:each) do
+    before do
       @hash = ('a'..'z').inject({}) { |h, v| h.merge({ v => v.to_sym }) }
     end
 
@@ -305,7 +307,8 @@ RSpec.describe 'AmazingPrint' do
     end
 
     it 'plain single line' do
-      expect(@hash.ai(plain: true, multiline: false)).to eq('{ 1 => { :sym => { "str" => { [ 1, 2, 3 ] => { { :k => :v } => Hash < Object } } } } }')
+      expect(@hash.ai(plain: true,
+                      multiline: false)).to eq('{ 1 => { :sym => { "str" => { [ 1, 2, 3 ] => { { :k => :v } => Hash < Object } } } } }')
     end
 
     it 'colored multiline (default)' do
@@ -390,7 +393,7 @@ RSpec.describe 'AmazingPrint' do
     it 'plain multiline' do
       out = @hash.ai(plain: true)
       if RUBY_VERSION.to_f < 1.9 # Order of @hash keys is not guaranteed.
-        expect(out).to match(/^\{[^\}]+\}/m)
+        expect(out).to match(/^\{[^}]+\}/m)
         expect(out).to match(/        "b" => "b",?/)
         expect(out).to match(/         :a => "a",?/)
         expect(out).to match(/         :z => "z",?/)
@@ -478,18 +481,18 @@ RSpec.describe 'AmazingPrint' do
 
   #------------------------------------------------------------------------------
   describe 'Class' do
-    it 'should show superclass (plain)' do
+    it 'shows superclass (plain)' do
       expect(self.class.ai(plain: true)).to eq("#{self.class} < #{self.class.superclass}")
     end
 
-    it 'should show superclass (color)' do
+    it 'shows superclass (color)' do
       expect(self.class.ai).to eq("#{self.class} < #{self.class.superclass}".yellow)
     end
   end
 
   #------------------------------------------------------------------------------
   describe 'File' do
-    it 'should display a file (plain)' do
+    it 'displays a file (plain)' do
       File.open(__FILE__, 'r') do |f|
         expect(f.ai(plain: true)).to eq("#{f.inspect}\n" + `ls -alF #{f.path}`.chop)
       end
@@ -498,7 +501,7 @@ RSpec.describe 'AmazingPrint' do
 
   #------------------------------------------------------------------------------
   describe 'Dir' do
-    it 'should display a direcory (plain)' do
+    it 'displays a direcory (plain)' do
       Dir.open(File.dirname(__FILE__)) do |d|
         expect(d.ai(plain: true)).to eq("#{d.inspect}\n" + `ls -alF #{d.path}`.chop)
       end
@@ -507,12 +510,12 @@ RSpec.describe 'AmazingPrint' do
 
   #------------------------------------------------------------------------------
   describe 'BigDecimal and Rational' do
-    it 'should present BigDecimal object with arbitrary precision' do
+    it 'presents BigDecimal object with arbitrary precision' do
       big = BigDecimal('201020102010201020102010201020102010.4')
       expect(big.ai(plain: true)).to eq('201020102010201020102010201020102010.4')
     end
 
-    it 'should present Rational object with arbitrary precision' do
+    it 'presents Rational object with arbitrary precision' do
       rat = Rational(201_020_102_010_201_020_102_010_201_020_102_010, 2)
       out = rat.ai(plain: true)
       #
@@ -530,7 +533,7 @@ RSpec.describe 'AmazingPrint' do
 
   #------------------------------------------------------------------------------
   describe 'Utility methods' do
-    it 'should merge options' do
+    it 'merges options' do
       ap = AmazingPrint::Inspector.new
       ap.send(:merge_options!, { color: { array: :black }, indent: 0 })
       options = ap.instance_variable_get('@options')
@@ -576,7 +579,8 @@ RSpec.describe 'AmazingPrint' do
       end
 
       it 'plain single line' do
-        expect(@set.sort_by(&:to_s).ai(plain: true, multiline: false)).to eq(@arr.sort_by(&:to_s).ai(plain: true, multiline: false))
+        expect(@set.sort_by(&:to_s).ai(plain: true,
+                                       multiline: false)).to eq(@arr.sort_by(&:to_s).ai(plain: true, multiline: false))
       end
 
       it 'colored multiline (default)' do
@@ -693,10 +697,10 @@ RSpec.describe 'AmazingPrint' do
       class My < File; end
 
       my = begin
-             File.new('/dev/null')
-           rescue StandardError
-             File.new('nul')
-           end
+        File.new('/dev/null')
+      rescue StandardError
+        File.new('nul')
+      end
       expect(my.ai(plain: true)).to eq("#{my.inspect}\n" + `ls -alF #{my.path}`.chop)
     end
 
@@ -708,7 +712,7 @@ RSpec.describe 'AmazingPrint' do
       expect(my.ai(plain: true)).to eq("#{my.inspect}\n" + `ls -alF #{my.path}`.chop)
     end
 
-    it 'should handle a class that defines its own #send method' do
+    it 'handles a class that defines its own #send method' do
       class My
         def send(arg1, arg2, arg3); end
       end
@@ -717,7 +721,7 @@ RSpec.describe 'AmazingPrint' do
       expect { my.methods.ai(plain: true) }.not_to raise_error
     end
 
-    it 'should handle a class defines its own #method method (ex. request.method)' do
+    it 'handles a class defines its own #method method (ex. request.method)' do
       class My
         def method
           'POST'
@@ -779,3 +783,5 @@ RSpec.describe 'AmazingPrint' do
     end
   end
 end
+
+# rubocop:enable Lint/ConstantDefinitionInBlock

data/spec/methods_spec.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# rubocop:disable Lint/ConstantDefinitionInBlock
+
 require 'spec_helper'
 
 RSpec.describe 'Single method' do
@@ -385,7 +387,8 @@ if RUBY_VERSION >= '1.9.2'
 
     it ':opt' do
       class Hello
-        def m1(a, b = 1, c = 2); end # m1(a, *b, *c)
+        # m1(a, *b, *c)
+        def m1(a, b = 1, c = 2); end
       end
       out = Hello.new.methods.ai(plain: true).split("\n").grep(/m1/)
       expect(out.first).to match(/^\s+\[\s*\d+\]\s+m1\(a, \*b, \*c\)\s+Hello$/)
@@ -393,7 +396,8 @@ if RUBY_VERSION >= '1.9.2'
 
     it ':rest' do
       class Hello
-        def m1(*a); end # m1(*a)
+        # m1(*a)
+        def m1(*a); end
       end
       out = Hello.new.methods.ai(plain: true).split("\n").grep(/m1/)
       expect(out.first).to match(/^\s+\[\s*\d+\]\s+m1\(\*a\)\s+Hello$/)
@@ -401,7 +405,8 @@ if RUBY_VERSION >= '1.9.2'
 
     it ':block' do
       class Hello
-        def m1(a, b = nil, &blk); end # m1(a, *b, &blk)
+        # m1(a, *b, &blk)
+        def m1(a, b = nil, &blk); end
       end
       out = Hello.new.methods.ai(plain: true).split("\n").grep(/m1/)
       expect(out.first).to match(/^\s+\[\s*\d+\]\s+m1\(a, \*b, &blk\)\s+Hello$/)
@@ -431,10 +436,11 @@ RSpec.describe 'Methods arrays' do
 
       def self.m2; end
     end
+
     class World
       def self.m1; end
     end
-    out = (Hello.methods & World.methods - Class.methods).ai(plain: true)
+    out = (Hello.methods & (World.methods - Class.methods)).ai(plain: true)
     expect(out).to eq("[\n    [0] m1() Hello\n]")
   end
 
@@ -510,3 +516,5 @@ RSpec.describe 'Methods arrays' do
     end
   end
 end
+
+# rubocop:enable Lint/ConstantDefinitionInBlock

data/spec/misc_spec.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# rubocop:disable Lint/ConstantDefinitionInBlock, Lint/EmptyClass
+
 require 'spec_helper'
 
 RSpec.describe 'AmazingPrint' do
@@ -24,7 +26,7 @@ RSpec.describe 'AmazingPrint' do
 
     # See https://github.com/awesome-print/awesome_print/issues/35
     it 'handle array grep when pattern contains / chapacter' do
-      hash = { '1/x' => 1, '2//x' => :"2" }
+      hash = { '1/x' => 1, '2//x' => :'2' }
       grepped = hash.keys.sort.grep(%r{^(\d+)/}) { Regexp.last_match(1) }
       expect(grepped.ai(plain: true, multiline: false)).to eq('[ "1", "2" ]')
     end
@@ -46,7 +48,7 @@ RSpec.describe 'AmazingPrint' do
 
     # Require different file name this time (lib/ap.rb vs. lib/amazing_print).
     it "several require 'amazing_print' should do no harm" do
-      require File.expand_path(File.dirname(__FILE__) + '/../lib/ap')
+      require File.expand_path("#{File.dirname(__FILE__)}/../lib/ap")
       expect { rand.ai }.not_to raise_error
     end
 
@@ -127,7 +129,7 @@ RSpec.describe 'AmazingPrint' do
     end
 
     # See https://github.com/awesome-print/awesome_print/issues/98
-    it 'should properly merge the defaults' do
+    it 'properlies merge the defaults' do
       AmazingPrint.defaults = { indent: -2, sort_keys: true }
       hash = { [0, 0, 255] => :yellow, :red => 'rgb(255, 0, 0)', 'magenta' => 'rgb(255, 0, 255)' }
       out = hash.ai(plain: true)
@@ -187,7 +189,7 @@ RSpec.describe 'AmazingPrint' do
 
   #------------------------------------------------------------------------------
   describe 'Console' do
-    it 'should detect IRB' do
+    it 'detects IRB' do
       class IRB; end
       ENV.delete('RAILS_ENV')
       expect(AmazingPrint.console?).to eq(true)
@@ -195,7 +197,7 @@ RSpec.describe 'AmazingPrint' do
       Object.instance_eval { remove_const :IRB }
     end
 
-    it 'should detect Pry' do
+    it 'detects Pry' do
       class Pry; end
       ENV.delete('RAILS_ENV')
       expect(AmazingPrint.console?).to eq(true)
@@ -203,8 +205,9 @@ RSpec.describe 'AmazingPrint' do
       Object.instance_eval { remove_const :Pry }
     end
 
-    it 'should detect Rails::Console' do
+    it 'detects Rails::Console' do
       class IRB; end
+
       module Rails; class Console; end; end
       expect(AmazingPrint.console?).to eq(true)
       expect(AmazingPrint.rails_console?).to eq(true)
@@ -212,7 +215,7 @@ RSpec.describe 'AmazingPrint' do
       Object.instance_eval { remove_const :Rails }
     end
 
-    it "should detect ENV['RAILS_ENV']" do
+    it "detects ENV['RAILS_ENV']" do
       class Pry; end
       ENV['RAILS_ENV'] = 'development'
       expect(AmazingPrint.console?).to eq(true)
@@ -220,12 +223,12 @@ RSpec.describe 'AmazingPrint' do
       Object.instance_eval { remove_const :Pry }
     end
 
-    it 'should return the actual object when *not* running under console' do
+    it 'returns the actual object when *not* running under console' do
       expect(capture! { ap([1, 2, 3]) }).to eq([1, 2, 3])
       expect(capture! { ap({ a: 1 }) }).to eq({ a: 1 })
     end
 
-    it 'should return nil when running under console' do
+    it 'returns nil when running under console' do
       class IRB; end
       expect(capture! { ap([1, 2, 3]) }).to eq(nil)
       expect(capture! { ap({ a: 1 }) }).to eq(nil)
@@ -240,8 +243,10 @@ RSpec.describe 'AmazingPrint' do
       irb.instance_eval { @context = irb_context }
       AmazingPrint.irb!
       expect(irb).to receive(:puts).with("(Object doesn't support #ai)")
-      expect { irb.output_value }.to_not raise_error
+      expect { irb.output_value }.not_to raise_error
       Object.instance_eval { remove_const :IRB }
     end
   end
 end
+
+# rubocop:enable Lint/ConstantDefinitionInBlock, Lint/EmptyClass

data/spec/objects_spec.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# rubocop:disable Lint/ConstantDefinitionInBlock
+
 require 'spec_helper'
 
 RSpec.describe 'Objects' do
@@ -219,3 +221,5 @@ RSpec.describe 'Objects' do
     end
   end
 end
+
+# rubocop:enable Lint/ConstantDefinitionInBlock

data/spec/spec_helper.rb

@@ -23,7 +23,7 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
-Dir[File.dirname(__FILE__) + '/support/**/*.rb'].sort.each do |file|
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].sort.each do |file|
   require file
 end
 
@@ -63,7 +63,7 @@ RSpec.configure do |config|
 
   # Run before all examples. Using suite or all will not work as stubs are
   # killed after each example ends.
-  config.before(:each) do |_example|
+  config.before do |_example|
     stub_dotfile!
   end
 end
@@ -86,12 +86,8 @@ end
 # that an ID is present and not that it matches a certain value. This is
 # necessary as the Object IDs are not deterministic.
 def normalize_object_id_strings(str, options)
-  unless options[:skip_standard]
-    str = str.gsub(/#<(.*?):0x[a-f\d]+/, '#<\1:placeholder_id')
-  end
-  unless options[:skip_bson]
-    str = str.gsub(/BSON::ObjectId\('[a-f\d]{24}'\)/, 'placeholder_bson_id')
-  end
+  str = str.gsub(/#<(.*?):0x[a-f\d]+/, '#<\1:placeholder_id') unless options[:skip_standard]
+  str = str.gsub(/BSON::ObjectId\('[a-f\d]{24}'\)/, 'placeholder_bson_id') unless options[:skip_bson]
   str
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: amazing_print
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Michael Dvorkin
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-08 00:00:00.000000000 Z
+date: 2021-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -87,14 +87,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.81.0
+        version: '1.20'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.81.0
+        version: '1.20'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
 description: 'Great Ruby debugging companion: pretty print Ruby objects to visualize
   their structure. Supports custom object formatting via plugins'
 email: harlemsquirrel@gmail.com
@@ -213,7 +227,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Pretty print Ruby objects with proper indentation and colors