amazing_print 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 806491a973073e36b330fad7b64e69dbc283647d2509609c5aa79d24269ee17b
-  data.tar.gz: 96ec9502e108582a6f54f01950d52b5de151928af721bcb8c4696f4a10baa14a
+  metadata.gz: c49ac51983ec5dc57570bb8e77591c4aa837da01afec64fe9d62139f296ac42b
+  data.tar.gz: c1145227423a78c989a8d9a49f8e3ab33b8a39c33b3a197e16a3353300ed20dd
 SHA512:
-  metadata.gz: 33030793c2ebf21436b3633a5316e961ad73e5caed621509a36447146ba452634ff5a5ab791002382e07fccf43e3f06b4fbea594e17cf057ae7839629ca2864e
-  data.tar.gz: d401f7bb5f85f052a6155864dfbbdb73c257f2b0e982226ecf203b6a024f05b8f3e30413d82ae2c02a983363fdd46a44c4ed7f6cfbe57395727d1eb69f0785c8
+  metadata.gz: b0039aa9251d996bb7fa516b33ebfd354861caee637c3f5d48dcbd0200739a362159ecad59aa83ba90ec1b607d39ce919ea0b1cee746535b7da05fb9785acfd1
+  data.tar.gz: fc2fe38dab3c905483c1f946c6239d479bb827de954cc6504a2046d02762cdbdd3435e411837e7bfa3d319bcff99cdba502eba66c32c688c61b05733e2758c1e

data/.gitignore

@@ -32,4 +32,4 @@ Gemfile.lock
 
 # PROJECT::RBENV
 .ruby-gemset
-.awesome-print/
+*.gem

data/Appraisals

@@ -42,6 +42,12 @@ appraise 'mongoid-6.0' do
   gem 'mongoid', '~> 6.0.0'
 end
 
+appraise 'sequel-5.0' do
+  gem 'jdbc-sqlite3', platform: :jruby
+  gem 'sequel', '~> 5.0'
+  gem 'sqlite3', platform: :mri
+end
+
 # appraise 'mongo_mapper' do
 #   gem 'mongo_mapper'
 # end

data/README.md

@@ -1,13 +1,17 @@
 ## Amazing Print ##
 
 [![RubyGems][gem_version_badge]][ruby_gems]
-[![Travis CI][travis_ci_badge]][travis_ci]
-[![Code Climate][code_climate_badge]][code_climate]
-[![Code Climate Coverage][code_climate_coverage_badge]][code_climate]
 [![RubyGems][gem_downloads_badge]][ruby_gems]
+|
+[![Travis CI][travis_ci_badge]][travis_ci]
+![Specs](https://github.com/amazing-print/amazing_print/workflows/Specs/badge.svg)
+![Lint](https://github.com/amazing-print/amazing_print/workflows/Lint/badge.svg)
+|
 [![Gitter](https://badges.gitter.im/amazing-print/community.svg)](https://gitter.im/amazing-print/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
 
-Amazing Print is a fork of [AmazingPrint](https://github.com/awesome-print/awesome_print) which became stale and should be used in it's place to avoid conflicts. It is a Ruby library that pretty prints Ruby objects in full color exposing their internal structure with proper indentation. Rails ActiveRecord objects and usage within Rails templates are supported via included mixins.
+AmazingPrint is a fork of [AwesomePrint](https://github.com/awesome-print/awesome_print) which became stale and should be used in it's place to avoid conflicts. It is a Ruby library that pretty prints Ruby objects in full color exposing their internal structure with proper indentation. Rails ActiveRecord objects and usage within Rails templates are supported via included mixins.
+
+![GitHub API demo](github-api-demo.gif)
 
 ### Supported Versions ###
 
@@ -305,7 +309,7 @@ With other web frameworks (ex: in Sinatra templates) you can explicitly request
 formatting:
 
     <%= ap @accounts.first, :html => true %>
-    
+
 ### String Convenience Methods ###
 Use methods such as `.red` to set string color:
 
@@ -351,6 +355,3 @@ Released under the MIT license. See LICENSE file for details.
 [ruby_gems]: http://rubygems.org/gems/amazing_print
 [travis_ci]: http://travis-ci.org/amazing-print/amazing_print
 [travis_ci_badge]: https://img.shields.io/travis/amazing-print/amazing_print/master.svg?style=flat
-[code_climate]: https://codeclimate.com/github/amazing-print/amazing_print
-[code_climate_badge]: http://img.shields.io/codeclimate/github/amazing-print/amazing_print.svg?style=flat
-[code_climate_coverage_badge]: https://codeclimate.com/github/amazing-print/amazing_print/badges/coverage.svg

data/lib/amazing_print.rb

@@ -9,38 +9,38 @@
 #
 unless defined?(AmazingPrint::Inspector)
   %w[awesome_method_array string method object class kernel].each do |file|
-    require "amazing_print/core_ext/#{file}"
+    require_relative "amazing_print/core_ext/#{file}"
   end
 
-  require 'amazing_print/custom_defaults'
-  require 'amazing_print/inspector'
-  require 'amazing_print/formatter'
-  require 'amazing_print/version'
-  require 'amazing_print/core_ext/logger' if defined?(Logger)
+  require_relative 'amazing_print/custom_defaults'
+  require_relative 'amazing_print/inspector'
+  require_relative 'amazing_print/formatter'
+  require_relative 'amazing_print/version'
+  require_relative 'amazing_print/core_ext/logger' if defined?(Logger)
   #
   # Load the following under normal circumstances as well as in Rails
   # console when required from ~/.irbrc or ~/.pryrc.
   #
   if defined?(ActiveRecord) || AmazingPrint.rails_console?
-    require 'amazing_print/ext/active_record'
+    require_relative 'amazing_print/ext/active_record'
   end
   if defined?(ActiveSupport) || AmazingPrint.rails_console?
-    require 'amazing_print/ext/active_support'
+    require_relative 'amazing_print/ext/active_support'
   end
   #
   # Load remaining extensions.
   #
   if defined?(ActiveSupport.on_load)
     ActiveSupport.on_load(:action_view) do
-      require 'amazing_print/ext/action_view'
+      require_relative 'amazing_print/ext/action_view'
     end
   end
-  require 'amazing_print/ext/mongo_mapper'   if defined?(MongoMapper)
-  require 'amazing_print/ext/mongoid'        if defined?(Mongoid)
-  require 'amazing_print/ext/nokogiri'       if defined?(Nokogiri)
-  require 'amazing_print/ext/nobrainer'      if defined?(NoBrainer)
-  require 'amazing_print/ext/ripple'         if defined?(Ripple)
-  require 'amazing_print/ext/sequel'         if defined?(Sequel)
-  require 'amazing_print/ext/ostruct'        if defined?(OpenStruct)
+  require_relative 'amazing_print/ext/mongo_mapper'   if defined?(MongoMapper)
+  require_relative 'amazing_print/ext/mongoid'        if defined?(Mongoid)
+  require_relative 'amazing_print/ext/nokogiri'       if defined?(Nokogiri)
+  require_relative 'amazing_print/ext/nobrainer'      if defined?(NoBrainer)
+  require_relative 'amazing_print/ext/ripple'         if defined?(Ripple)
+  require_relative 'amazing_print/ext/sequel'         if defined?(Sequel)
+  require_relative 'amazing_print/ext/ostruct'        if defined?(OpenStruct)
 end
 # test

data/lib/amazing_print/ext/sequel.rb

@@ -16,7 +16,7 @@ module AmazingPrint
       cast = cast_without_sequel(object, type)
       if defined?(::Sequel::Model) && object.is_a?(::Sequel::Model)
         cast = :sequel_document
-      elsif defined?(::Sequel::Model) && object.is_a?(Class) && object.ancestors.include?(::Sequel::Model)
+      elsif defined?(::Sequel::Model) && object.is_a?(Class) && object.ancestors.include?(::Sequel::Model) && object&.name != "Sequel::Model"
         cast = :sequel_model_class
       elsif defined?(::Sequel::Mysql2::Dataset) && object.class.ancestors.include?(::Sequel::Mysql2::Dataset)
         cast = :sequel_dataset

data/lib/amazing_print/formatter.rb

@@ -3,7 +3,7 @@
 # AmazingPrint is freely distributable under the terms of MIT license.
 # See LICENSE file or http://www.opensource.org/licenses/mit-license.php
 #------------------------------------------------------------------------------
-require 'amazing_print/formatters'
+require_relative 'formatters'
 
 module AmazingPrint
   class Formatter
@@ -26,7 +26,7 @@ module AmazingPrint
                   send(:"awesome_#{core_class}", object) # Core formatters.
                 else
                   awesome_self(object, type) # Catch all that falls back to object.inspect.
-      end
+                end
       awesome
     end
 

data/lib/amazing_print/formatters.rb

@@ -1,14 +1,14 @@
 module AmazingPrint
   module Formatters
-    require 'amazing_print/formatters/object_formatter'
-    require 'amazing_print/formatters/struct_formatter'
-    require 'amazing_print/formatters/hash_formatter'
-    require 'amazing_print/formatters/array_formatter'
-    require 'amazing_print/formatters/simple_formatter'
-    require 'amazing_print/formatters/method_formatter'
-    require 'amazing_print/formatters/class_formatter'
-    require 'amazing_print/formatters/dir_formatter'
-    require 'amazing_print/formatters/file_formatter'
-    require 'amazing_print/colorize'
+    require_relative 'formatters/object_formatter'
+    require_relative 'formatters/struct_formatter'
+    require_relative 'formatters/hash_formatter'
+    require_relative 'formatters/array_formatter'
+    require_relative 'formatters/simple_formatter'
+    require_relative 'formatters/method_formatter'
+    require_relative 'formatters/class_formatter'
+    require_relative 'formatters/dir_formatter'
+    require_relative 'formatters/file_formatter'
+    require_relative 'colorize'
   end
 end

data/lib/amazing_print/formatters/base_formatter.rb

@@ -70,6 +70,8 @@ module AmazingPrint
             name ||= (type == :block ? 'block' : "arg#{arr.size + 1}")
             arr << case type
                    when :req        then name.to_s
+                   when :keyreq     then "#{name}:"
+                   when :key        then "*#{name}:"
                    when :opt, :rest then "*#{name}"
                    when :block      then "&#{name}"
                    else '?'
@@ -123,7 +125,6 @@ module AmazingPrint
       end
 
       def outdent
-        ' ' * (indentation - options[:indent].abs)
         i = indentation - options[:indent].abs
 
         INDENT_CACHE[i] || ' ' * i

data/lib/amazing_print/formatters/dir_formatter.rb

@@ -1,6 +1,7 @@
-require_relative 'base_formatter'
 require 'shellwords'
 
+require_relative 'base_formatter'
+
 module AmazingPrint
   module Formatters
     class DirFormatter < BaseFormatter

data/lib/amazing_print/formatters/file_formatter.rb

@@ -1,6 +1,7 @@
-require_relative 'base_formatter'
 require 'shellwords'
 
+require_relative 'base_formatter'
+
 module AmazingPrint
   module Formatters
     class FileFormatter < BaseFormatter

data/lib/amazing_print/formatters/object_formatter.rb

@@ -19,7 +19,7 @@ module AmazingPrint
                        object.respond_to?(property) ? :accessor : :writer
                      else
                        object.respond_to?(property) ? :reader : nil
-          end
+                     end
           if accessor
             ["attr_#{accessor} :#{property}", var]
           else

data/lib/amazing_print/formatters/struct_formatter.rb

@@ -19,7 +19,7 @@ module AmazingPrint
                        struct.respond_to?(property) ? :accessor : :writer
                      else
                        struct.respond_to?(property) ? :reader : nil
-          end
+                     end
           if accessor
             ["attr_#{accessor} :#{property}", var]
           else

data/lib/amazing_print/version.rb

@@ -5,6 +5,6 @@
 #------------------------------------------------------------------------------
 module AmazingPrint
   def self.version
-    '1.0.0'
+    '1.1.0'
   end
 end

data/lib/ap.rb

@@ -7,4 +7,4 @@
 # Keeping this for backwards compatibility to allow
 # require "ap"
 #
-require File.dirname(__FILE__) + '/amazing_print'
+require_relative 'amazing_print'

data/spec/ext/active_record_spec.rb

@@ -255,6 +255,10 @@ RSpec.describe 'AmazingPrint/ActiveRecord', skip: -> { !ExtVerifier.has_rails? }
           expect(out).to match(
             /\s+first\(\*args,\s&block\)\s+#<Class:\w+>\s+\(ActiveRecord::Querying\)/
           )
+        elsif RUBY_VERSION >= '2.7.0'
+          expect(out).to match(
+            /\s*first\(\*args,\s+&block\)\s+#<Class:ActiveRecord::Base> \(ActiveRecord::Querying\)/
+          )
         elsif RUBY_VERSION >= '2.4.4'
           expect(out).to match(/\sfirst\(\*arg.*?\)\s+User/)
         elsif RUBY_VERSION >= '1.9'
@@ -272,6 +276,10 @@ RSpec.describe 'AmazingPrint/ActiveRecord', skip: -> { !ExtVerifier.has_rails? }
         expect(out).to match(
           /\sprimary_key\(.*?\)\s+#<Class:\w+>\s\(ActiveRecord::AttributeMethods::PrimaryKey::ClassMethods\)/
         )
+      elsif RUBY_VERSION >= '2.7.0'
+        expect(out).to match(
+          /\sprimary_key\(.*?\)\s+.+Class.+\(ActiveRecord::AttributeMethods::PrimaryKey::ClassMethods\)/
+        )
       elsif RUBY_VERSION >= '2.4.4'
         expect(out).to match(/\sprimary_key\(.*?\)\s+User/)
       else
@@ -286,7 +294,11 @@ RSpec.describe 'AmazingPrint/ActiveRecord', skip: -> { !ExtVerifier.has_rails? }
       else
         if RUBY_PLATFORM == 'java'
           expect(out).to match(/\svalidate\(\*arg.*?\)\s+#<Class:\w+> \(ActiveModel::Validations::ClassMethods\)/)
-        elsif RUBY_VERSION >= '2.4.4'
+       elsif RUBY_VERSION >= '2.7.0'
+          expect(out).to match(
+            /\svalidate\(\*args.*?\)\s+#<Class:ActiveRecord::Base> \(ActiveModel::Validations::ClassMethods\)/
+          )
+       elsif RUBY_VERSION >= '2.4.4'
           expect(out).to match(/\svalidate\(\*arg.*?\)\s+User/)
         else
           expect(out).to match(/\svalidate\(\*arg.*?\)\s+Class \(ActiveModel::Validations::ClassMethods\)/)

data/spec/ext/sequel_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+require 'sequel_helper'
+
+RSpec.describe 'AmazingPrint/Sequel', skip: -> { !ExtVerifier.has_sequel? }.call do
+  before do
+    @ap = AmazingPrint::Inspector.new plain: true, sort_keys: true
+    @user1 = SequelUser.new first_name: 'Jeremy', last_name: 'Evans'
+    @user2 = SequelUser.new first_name: 'Sequel', last_name: 'Five'
+  end
+
+    it 'display single record' do
+      out = @ap.awesome(@user1)
+      str = <<~EOS.strip
+        #<SequelUser:placeholder_id> {
+            :first_name => "Jeremy",
+             :last_name => "Evans"
+        }
+      EOS
+      expect(out).to be_similar_to(str)
+    end
+
+    it 'display multiple records' do
+      out = @ap.awesome([@user1, @user2])
+      str = <<~EOS.strip
+        [
+            [0] #<SequelUser:placeholder_id> {
+                :first_name => "Jeremy",
+                 :last_name => "Evans"
+            },
+            [1] #<SequelUser:placeholder_id> {
+                :first_name => "Sequel",
+                 :last_name => "Five"
+            }
+        ]
+      EOS
+      expect(out).to be_similar_to(str)
+    end
+
+  it 'does not crash if on Sequel::Model' do
+    out = @ap.awesome(::Sequel::Model)
+    expect(out).to be_similar_to("Sequel::Model < Object")
+  end
+end

data/spec/methods_spec.rb

@@ -33,6 +33,38 @@ RSpec.describe 'Single method' do
     expect(method.ai).to eq("\e[1;33mString\e[0m#\e[0;35minclude?\e[0m\e[0;37m(arg1)\e[0m")
   end
 
+  it 'plain: should handle a method with one required keyword argument' do
+    class A
+      def one(foo:); end
+    end
+    method = A.new.method(:one)
+    expect(method.ai(plain: true)).to eq('A#one(foo:)')
+  end
+
+  it 'color: should handle a method with one required keyword argument' do
+    class A
+      def one(foo:); end
+    end
+    method = A.new.method(:one)
+    expect(method.ai).to eq("\e[1;33mA\e[0m#\e[0;35mone\e[0m\e[0;37m(foo:)\e[0m")
+  end
+
+  it 'plain: should handle a method with one required and one optional keyword arguments' do
+    class A
+      def one(foo:, bar: 'baz'); end
+    end
+    method = A.new.method(:one)
+    expect(method.ai(plain: true)).to eq('A#one(foo:, *bar:)')
+  end
+
+  it 'color: should handle a method with one required and one optional keyword arguments' do
+    class A
+      def one(foo:, bar: 'baz'); end
+    end
+    method = A.new.method(:one)
+    expect(method.ai).to eq("\e[1;33mA\e[0m#\e[0;35mone\e[0m\e[0;37m(foo:, *bar:)\e[0m")
+  end
+
   it 'plain: should handle a method with two arguments' do
     method = ''.method(:tr)
     expect(method.ai(plain: true)).to eq('String#tr(arg1, arg2)')

data/spec/sequel_helper.rb

@@ -0,0 +1,16 @@
+if ExtVerifier.has_sequel?
+  # Establish connection to in-memory SQLite DB
+  DB = RUBY_PLATFORM == 'java' ? Sequel.connect('jdbc:sqlite::memory:') : Sequel.sqlite
+
+  # Create the users table
+  DB.create_table :sequel_users do
+    primary_key :id
+    String :first_name
+    String :last_name
+    TrueClass :admin
+    DateTime :created_at
+  end
+
+  # Create models
+  class SequelUser < Sequel::Model; end
+end

data/spec/spec_helper.rb

@@ -35,6 +35,7 @@ ExtVerifier.require_dependencies!(
     mongo_mapper
     ripple nobrainer
     ostruct
+    sequel
   ]
 )
 require 'nokogiri'

data/spec/support/ext_verifier.rb

@@ -33,6 +33,11 @@ module ExtVerifier
     defined?(NoBrainer)
   end
   module_function :has_nobrainer?
+
+  def has_sequel?
+    defined?(::Sequel::Model)
+  end
+  module_function :has_sequel?
 end
 
 RSpec.configure do |config|

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: amazing_print
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Michael Dvorkin
-- Kevin McCormack
+- Kevin McCormackPatrik Wenger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-03 00:00:00.000000000 Z
+date: 2020-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -146,10 +146,12 @@ files:
 - spec/ext/nokogiri_spec.rb
 - spec/ext/ostruct_spec.rb
 - spec/ext/ripple_spec.rb
+- spec/ext/sequel_spec.rb
 - spec/formats_spec.rb
 - spec/methods_spec.rb
 - spec/misc_spec.rb
 - spec/objects_spec.rb
+- spec/sequel_helper.rb
 - spec/spec_helper.rb
 - spec/support/active_record_data.rb
 - spec/support/active_record_data/3_2_diana.txt
@@ -210,6 +212,7 @@ test_files:
 - spec/ext/ostruct_spec.rb
 - spec/ext/mongoid_spec.rb
 - spec/ext/ripple_spec.rb
+- spec/ext/sequel_spec.rb
 - spec/ext/active_support_spec.rb
 - spec/ext/nokogiri_spec.rb
 - spec/ext/mongo_mapper_spec.rb
@@ -240,4 +243,5 @@ test_files:
 - spec/support/rails_versions.rb
 - spec/support/active_record_data.rb
 - spec/support/ext_verifier.rb
+- spec/sequel_helper.rb
 - spec/misc_spec.rb