awesome_print 1.9.2 → 2.0.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: bc6d20d854c529b902cfe961bd8271b30f1aa9f82c4db11bfdcaa6ecb6b1f469
-  data.tar.gz: c4f69e0cf2663cb4889b27414bd9f242789fea28790c3252dc5b2788da70bca2
+SHA1:
+  metadata.gz: b78e2becdd2b08753b1e78e1c2c46e531f6750a2
+  data.tar.gz: 9e79ebd10b6b47e9026d0e412f83615466e67c89
 SHA512:
-  metadata.gz: c34cd0b7347ecf6e98afc4ef0647f940a02a5d125c955748917c821e6bbf231830604fcbe0fb524c6bfdaa049d6f945bad658d30433bf878841b30a6d79ad765
-  data.tar.gz: 9cfae5c9646b5194a52c87b1ea38ba3d711cb616a713e66ce0ab83f255293a4b75f4016f349f047aa43d775d14b9f024fc0edccdf40b9f489e46626908162b00
+  metadata.gz: 2b6b91f195831126213e10ffba034c1ed5f6be030b5bc89870aeead7c6edb95a39a3968d24c60f06c4d2c88e16b4c7f7974ee0b81e3b33c66de5e36ce916e4e9
+  data.tar.gz: 4bb762cc93185b014c5f56b8a4b1cccaa2a52277b88efe68c8cc4c85728db7fd9a7e6fd5c1f63677e865a34aa671c03a2239df5a6d91eb4fffb4dc83cb54703e

data/.gitignore

@@ -26,7 +26,6 @@ Gemfile.lock
 /tmp
 /.bundle
 /gemfiles/.bundle
-/gemfiles/vendor/bundle
 
 ## PROJECT::RVM
 .rvmrc
@@ -34,3 +33,4 @@ Gemfile.lock
 # PROJECT::RBENV
 .ruby-gemset
 .awesome-print/
+.byebug_history

data/Appraisals

@@ -8,7 +8,6 @@
 
 appraise 'rails-5.0' do
   gem 'rails', '>= 5.0.0', '< 5.1'
-  gem 'sqlite3', '~> 1.3.6'
 end
 
 appraise 'rails-5.1' do
@@ -19,44 +18,14 @@ appraise 'rails-5.2' do
   gem 'rails', '>= 5.2.0', '< 5.3'
 end
 
-appraise 'rails-6.0' do
-  gem 'rails', '>= 6.0.0', '< 6.1'
-end
-
-appraise 'rails-6.1' do
-  gem 'rails', '>= 6.1.0', '< 6.2'
+appraise 'mongoid-4.0' do
+  gem 'mongoid', '~> 4.0.0'
 end
 
 appraise 'mongoid-5.0' do
   gem 'mongoid', '~> 5.0.0'
-  gem 'bigdecimal', '~> 1.3.5'
 end
 
 appraise 'mongoid-6.0' do
   gem 'mongoid', '~> 6.0.0'
 end
-
-appraise 'mongoid-7.0' do
-  gem 'mongoid', '~> 7.0.0'
-end
-
-appraise 'mongoid-7.1' do
-  gem 'mongoid', '~> 7.1.0'
-end
-
-# appraise 'mongo_mapper' do
-#   gem 'mongo_mapper'
-# end
-#
-# appraise 'ripple' do
-#   gem 'tzinfo'
-#   gem 'ripple'
-# end
-#
-# appraise 'nobrainer' do
-#   gem 'nobrainer'
-#
-#   # When activesupport 5 was released, it required ruby 2.2.2 as a minimum.
-#   # Locking this down to 4.2.6 allows our Ruby 1.9 tests to keep working.
-#   gem 'activesupport', '4.2.6', :platforms => :ruby_19
-# end

data/CHANGELOG.md

@@ -1,19 +1,10 @@
 ## master (unreleased)
 
-
-## 1.9.2
-  - Tests work with Ruby 2.6.6, 2.7.2 and 3.0.0
-  - Update awsome_print.gemspec nokogiri dependency to resolve CVEs [@gvwirth]
-
-## 1.9.1
-  - Updated code so it can be released to rubygems.
-  - Updated nokogiri to resolve vulnerability scan
-
-## 1.9.0
-  - Update method signature after change in IRB [@febeling]
-  - Fixes block and proc definition to work with Ruby 3.0.0 [@csalvato] - [#392]
-  - Removed check for Ruby 2.4 and earlier [@bryanh]
-  - Rails 5.0 builds are failing, because the sqlite3 version being installed is wrong version [#366]
+## 2.0.0-pre
+  - Massive overhaul in the way formatters work. Now they are registered with a factory pattern, which includes 
+    a simple method to determine if that formatter can handle the content. [@imajes]
+  - Remove support for mongo mapper, and ruby pre 2.x [@imajes]
+  - It's probably faster? :)
   - Fixes spec suite to properly work via travis, gets a clean build [@imajes, others]
   - Adds support for ActiveModel::Errors [@dshinzie] - [#301]
   - removes use of `strip_heredoc` from specs as it's a rails dep [@kstephens] - [#303]
@@ -23,7 +14,7 @@
   - stat("$HOME/.aprc") once [@kstephens] - [#304]
   - ActiveRecord: #joins now show the columns #select'ed [@adrianomitre] - [#211]
   - Handles NoMethodError for IRB implicit `ai` [@jtnegrotto] - [#212]
-  - Replaced Fixnum reference with Integer
+  - Replaced Fixnum reference with Integer 
   - Colorize ORM class names [@ixti]
 
 ## 1.7.0

data/CONTRIBUTING.md

@@ -51,7 +51,6 @@ Special thanks goes to awesome team of contributors, namely:
 * Barry Allard -- https://github.com/steakknife
 * Benoit Daloze -- http://github.com/eregon
 * Brandon Zylstra -- https://github.com/brandondrew
-* Bryan Hanks, PMP -- https://github.com/bryanh
 * Dan Lynn -- https://github.com/danlynn
 * Daniel Johnson -- https://github.com/adhd360
 * Daniel Bretoi -- http://github.com/danielb2

data/README.md

@@ -12,8 +12,9 @@ Awesome Print 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.
 
-__NOTE__: awesome_print v1.9.0 may not work on Ruby versions 2.4 or older or Rails versions 4.2 or older.
-The upcoming awesome_print v2.0 will *require* Ruby v1.9.3 or later and Rails v3.0 or later.
+__NOTE__: awesome_print v1.2.0 is the last release supporting Ruby versions
+prior to v1.9.3 and Rails versions prior to v3.0. The upcoming awesome_print
+v2.0 will *require* Ruby v1.9.3 or later and Rails v3.0 or later.
 
 ### Installation ###
     # Installing as Ruby gem
@@ -83,8 +84,6 @@ irb> "awesome print".ai
 
 ### Examples ###
 
-#### Array
-
 ```ruby
 $ cat > 1.rb
 require "awesome_print"
@@ -105,10 +104,7 @@ $ ruby 1.rb
         :distance => 4.2e+43
     }
 ]
-```
-#### Hash
 
-```ruby
 $ cat > 2.rb
 require "awesome_print"
 data = { :now => Time.now, :class => Time.now.class, :distance => 42e42 }
@@ -120,11 +116,7 @@ $ ruby 2.rb
   :now      => Fri Apr 02 19:55:53 -0700 2010,
   :distance => 4.2e+43
 }
-```
 
-#### Nested array
-
-```ruby
 $ cat > 3.rb
 require "awesome_print"
 data = [ false, 42, %w(forty two) ]
@@ -134,11 +126,6 @@ ap data, :multiline => false
 $ ruby 3.rb
 [ false, 42, [ "forty", "two" ], [...] ]
 
-```
-
-#### Class methods
-
-```ruby
 $ cat > 4.rb
 require "awesome_print"
 class Hello
@@ -152,11 +139,6 @@ $ ruby 4.rb
     [0] world(x, y, *z, &blk) Hello
 ]
 
-```
-
-#### Object methods
-
-```ruby
 $ cat > 5.rb
 require "awesome_print"
 ap (''.methods - Object.methods).grep(/!/)
@@ -185,11 +167,6 @@ $ ruby 5.rb
     [19]     upcase!()           String
 ]
 
-```
-
-#### Compare output to value
-
-```ruby
 $ cat > 6.rb
 require "awesome_print"
 ap 42 == ap(42)
@@ -197,13 +174,7 @@ ap 42 == ap(42)
 $ ruby 6.rb
 42
 true
-
-```
-
-#### Array with default output limit
-
-```ruby
-$ cat > 7.rb
+$ cat 7.rb
 require "awesome_print"
 some_array = (1..1000).to_a
 ap some_array, :limit => true
@@ -218,12 +189,8 @@ $ ruby 7.rb
     [998] 999,
     [999] 1000
 ]
-```
 
-#### Array with specific output limit
-
-```ruby
-$ cat > 8.rb
+$ cat 8.rb
 require "awesome_print"
 some_array = (1..1000).to_a
 ap some_array, :limit => 5
@@ -238,7 +205,7 @@ $ ruby 8.rb
 ]
 ```
 
-#### Rails console
+### Example (Rails console) ###
 ```ruby
 $ rails console
 rails> require "awesome_print"
@@ -340,7 +307,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:
 
@@ -366,20 +333,11 @@ AwesomePrint.defaults = {
 ```
 
 ## Versioning
-
 AwesomePrint follows the [Semantic Versioning](http://semver.org/) standard.
 
 ### Contributing ###
 See [CONTRIBUTING.md](CONTRIBUTING.md) for information.
 
-### License ###
-Copyright (c) 2010-2016 Michael Dvorkin and contributors
-
-http://www.dvorkin.net
-
-%w(mike dvorkin.net) * "@" || "twitter.com/mid"
-
-Released under the MIT license. See LICENSE file for details.
 
 [gem_version_badge]: https://img.shields.io/gem/v/awesome_print.svg?style=flat
 [gem_downloads_badge]: http://img.shields.io/gem/dt/awesome_print.svg?style=flat

data/lib/ap.rb

@@ -1,10 +1,6 @@
-# Copyright (c) 2010-2016 Michael Dvorkin and contributors
-#
-# Awesome Print is freely distributable under the terms of MIT license.
-# See LICENSE file or http://www.opensource.org/licenses/mit-license.php
-#------------------------------------------------------------------------------
 #
 # Keeping this for backwards compatibility to allow
 # require "ap"
 #
 require File.dirname(__FILE__) + '/awesome_print'
+

data/lib/awesome_print.rb

@@ -1,41 +1,19 @@
-# Copyright (c) 2010-2016 Michael Dvorkin and contributors
-#
-# Awesome Print is freely distributable under the terms of MIT license.
-# See LICENSE file or http://www.opensource.org/licenses/mit-license.php
-#------------------------------------------------------------------------------
-#
 # AwesomePrint might be loaded implicitly through ~/.irbrc or ~/.pryrc
 # so do nothing for subsequent requires.
 #
 unless defined?(AwesomePrint::Inspector)
-  %w(awesome_method_array string method object class kernel).each do |file|
+  # FIXME: not sure we need these, but..
+  require 'awesome_print/custom_defaults'
+
+  %w(active_support awesome_method_array string object class kernel).each do |file|
     require "awesome_print/core_ext/#{file}"
   end
 
-  require 'awesome_print/custom_defaults'
   require 'awesome_print/inspector'
   require 'awesome_print/formatter'
+
+  Dir["./lib/awesome_print/formatters/**/*.rb"].each { |f| require f }
+
   require 'awesome_print/version'
   require 'awesome_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.
-  #
-  require 'awesome_print/ext/active_record'  if defined?(ActiveRecord)  || AwesomePrint.rails_console?
-  require 'awesome_print/ext/active_support' if defined?(ActiveSupport) || AwesomePrint.rails_console?
-  #
-  # Load remaining extensions.
-  #
-  if defined?(ActiveSupport.on_load)
-    ActiveSupport.on_load(:action_view) do
-      require 'awesome_print/ext/action_view'
-    end
-  end
-  require 'awesome_print/ext/mongo_mapper'   if defined?(MongoMapper)
-  require 'awesome_print/ext/mongoid'        if defined?(Mongoid)
-  require 'awesome_print/ext/nokogiri'       if defined?(Nokogiri)
-  require 'awesome_print/ext/nobrainer'      if defined?(NoBrainer)
-  require 'awesome_print/ext/ripple'         if defined?(Ripple)
-  require 'awesome_print/ext/sequel'         if defined?(Sequel)
-  require 'awesome_print/ext/ostruct'        if defined?(OpenStruct)
 end

data/lib/awesome_print/colorize.rb

@@ -6,6 +6,8 @@ module AwesomePrint
     # Pick the color and apply it to the given string as necessary.
     #------------------------------------------------------------------------------
     def colorize(str, type)
+      # puts "[COLORIZING] - using #{options[:color][type]} for #{type}" if AwesomePrint.debug
+
       str = CGI.escapeHTML(str) if options[:html]
       if options[:plain] || !options[:color][type] || !inspector.colorize?
         str

data/lib/awesome_print/core_ext/active_support.rb

@@ -0,0 +1,7 @@
+#
+# Colorize Rails logs.
+#
+if defined?(ActiveSupport::LogSubscriber)
+  AwesomePrint.force_colors! ActiveSupport::LogSubscriber.colorize_logging
+end
+

data/lib/awesome_print/core_ext/awesome_method_array.rb

@@ -1,9 +1,3 @@
-# Copyright (c) 2010-2016 Michael Dvorkin and contributors
-#
-# Awesome Print is freely distributable under the terms of MIT license.
-# See LICENSE file or http://www.opensource.org/licenses/mit-license.php
-#------------------------------------------------------------------------------
-#
 # The following makes it possible to invoke awesome_print while performing
 # operations on method arrays, ex:
 #

data/lib/awesome_print/core_ext/class.rb

@@ -1,8 +1,3 @@
-# Copyright (c) 2010-2016 Michael Dvorkin and contributors
-#
-# Awesome Print is freely distributable under the terms of MIT license.
-# See LICENSE file or http://www.opensource.org/licenses/mit-license.php
-#------------------------------------------------------------------------------
 class Class #:nodoc:
   #
   # Intercept methods below to inject @__awesome_print__ instance variable

data/lib/awesome_print/core_ext/kernel.rb

@@ -1,8 +1,3 @@
-# Copyright (c) 2010-2016 Michael Dvorkin and contributors
-#
-# Awesome Print is freely distributable under the terms of MIT license.
-# See LICENSE file or http://www.opensource.org/licenses/mit-license.php
-#------------------------------------------------------------------------------
 module Kernel
 
   def ai(options = {})

data/lib/awesome_print/core_ext/logger.rb

@@ -1,8 +1,3 @@
-# Copyright (c) 2010-2016 Michael Dvorkin and contributors
-#
-# Awesome Print is freely distributable under the terms of MIT license.
-# See LICENSE file or http://www.opensource.org/licenses/mit-license.php
-#------------------------------------------------------------------------------
 module AwesomePrint
   module Logger
 

data/lib/awesome_print/core_ext/object.rb

@@ -1,8 +1,3 @@
-# Copyright (c) 2010-2016 Michael Dvorkin and contributors
-#
-# Awesome Print is freely distributable under the terms of MIT license.
-# See LICENSE file or http://www.opensource.org/licenses/mit-license.php
-#------------------------------------------------------------------------------
 class Object #:nodoc:
   #
   # Intercept methods below to inject @__awesome_print__ instance variable

data/lib/awesome_print/core_ext/string.rb

@@ -1,8 +1,3 @@
-# Copyright (c) 2010-2016 Michael Dvorkin and contributors
-#
-# Awesome Print is freely distributable under the terms of MIT license.
-# See LICENSE file or http://www.opensource.org/licenses/mit-license.php
-#------------------------------------------------------------------------------
 class String
   #
   # ANSI color codes:

data/lib/awesome_print/custom_defaults.rb

@@ -27,7 +27,7 @@ module AwesomePrint
 
     def usual_rb
       IRB::Irb.class_eval do
-        def output_value(*args)
+        def output_value
           ap @context.last_value
         rescue NoMethodError
           puts "(Object doesn't support #ai)"

data/lib/awesome_print/formatter.rb

@@ -1,134 +1,66 @@
-# Copyright (c) 2010-2016 Michael Dvorkin and contributors
-#
-# Awesome Print is freely distributable under the terms of MIT license.
-# See LICENSE file or http://www.opensource.org/licenses/mit-license.php
-#------------------------------------------------------------------------------
-require 'awesome_print/formatters'
+require_relative 'colorize'
 
 module AwesomePrint
   class Formatter
+
     include Colorize
 
     attr_reader :inspector, :options
 
-    CORE_FORMATTERS = [:array, :bigdecimal, :class, :dir, :file, :hash, :method, :rational, :set, :struct, :unboundmethod]
+    # Acts as a class ivar
+    @registered_formatters = {}
 
-    def initialize(inspector)
-      @inspector   = inspector
-      @options     = inspector.options
+    # make it accessible
+    def self.registered_formatters
+      @registered_formatters
     end
 
-    # Main entry point to format an object.
+    # register a new formatter..
     #------------------------------------------------------------------------------
-    def format(object, type = nil)
-      core_class = cast(object, type)
-      awesome = if core_class != :self
-        send(:"awesome_#{core_class}", object) # Core formatters.
-      else
-        awesome_self(object, type) # Catch all that falls back to object.inspect.
-      end
-      awesome
+    def self.register(formatter)
+      @registered_formatters[formatter.formatted_object_type.to_sym] = formatter
     end
 
-    # Hook this when adding custom formatters. Check out lib/awesome_print/ext
-    # directory for custom formatters that ship with awesome_print.
-    #------------------------------------------------------------------------------
-    def cast(object, type)
-      CORE_FORMATTERS.include?(type) ? type : :self
+    def initialize(inspector)
+      @inspector = inspector
+      @options   = inspector.options
     end
 
-    private
 
-    # Catch all method to format an arbitrary object.
+    # Main entry point to format an object.
+    # type is determined by Inspector#printable
     #------------------------------------------------------------------------------
-    def awesome_self(object, type)
-      if @options[:raw] && object.instance_variables.any?
-        awesome_object(object)
-      elsif (hash = convert_to_hash(object))
-        awesome_hash(hash)
-      else
-        awesome_simple(object.inspect.to_s, type, @inspector)
-      end
-    end
-
-    def awesome_bigdecimal(n)
-      o = n.to_s('F')
-      type = :bigdecimal
-      awesome_simple(o, type, @inspector)
-    end
-
-    def awesome_rational(n)
-      o = n.to_s
-      type = :rational
-      awesome_simple(o, type, @inspector)
-    end
-
-    def awesome_simple(o, type, inspector = @inspector)
-      AwesomePrint::Formatters::SimpleFormatter.new(o, type, inspector).format
-    end
-
-    def awesome_array(a)
-      Formatters::ArrayFormatter.new(a, @inspector).format
-    end
-
-    def awesome_set(s)
-      Formatters::ArrayFormatter.new(s.to_a, @inspector).format
-    end
-
-    def awesome_hash(h)
-      Formatters::HashFormatter.new(h, @inspector).format
-    end
-
-    def awesome_object(o)
-      Formatters::ObjectFormatter.new(o, @inspector).format
-    end
-
-    def awesome_struct(s)
-      Formatters::StructFormatter.new(s, @inspector).format
-    end
+    def format(object, type = nil)
+      puts "\n\n[FMT] #{type.to_s.red} >>> #{object}" if AwesomePrint.debug
 
-    def awesome_method(m)
-      Formatters::MethodFormatter.new(m, @inspector).format
-    end
-    alias :awesome_unboundmethod :awesome_method
+      format_with = active_formatter(type)
+      puts "[ACTIVE] using > #{format_with.to_s.blueish} < to format" if format_with && AwesomePrint.debug
 
-    def awesome_class(c)
-      Formatters::ClassFormatter.new(c, @inspector).format
-    end
+      # if we have an active formatter, and it's good to go, lets return that
 
-    def awesome_file(f)
-      Formatters::FileFormatter.new(f, @inspector).format
-    end
+      return format_with.new(@inspector).format(object) if format_with&.formattable?(object)
 
-    def awesome_dir(d)
-      Formatters::DirFormatter.new(d, @inspector).format
-    end
+      # if that's not working, lets try discover the format via formattable?
+      self.class.registered_formatters.each do |fmt|
+        puts "[FIND] trying to use [#{fmt.first.to_s.greenish} - #{fmt.last.to_s.blue}] - core: #{fmt.last.core?}" if AwesomePrint.debug
+        #{fmt.last.core?}" if AwesomePrint.debug
+        next if fmt.last.core? # if it's a core level formatter, move on
 
-    # Utility methods.
-    #------------------------------------------------------------------------------
+        if fmt.last.formattable?(object)
+          puts "[FMT] Jackpot! using #{fmt.first.to_s.red} >>> #{object}" if AwesomePrint.debug
+          return fmt.last.new(@inspector).format(object) 
+        end
+      end
 
-    # A class (ex. `Net::HTTP.Get`) might have `attr_reader :method` accessor
-    # which causes `object.method(:to_hash)` throw `ArgumentError (wrong number
-    # of arguments (given 1, expected 0))`. The following tries to avoid that.
-    def has_method_accessor?(object)
-      !object.method(:method)
-    rescue ArgumentError
-      true
+      # we've run out of options. lets try and coerce into something we can work
+      # with
+      puts "[FALLBACK] well darn, we're just gonna have to fb" if AwesomePrint.debug
+      AwesomePrint::Formatters::FallbackFormatter.new(@inspector).format(object)
     end
 
-    def convert_to_hash(object)
-      return nil if has_method_accessor?(object)
-      return nil if !object.respond_to?(:to_hash) || object.method(:to_hash).arity != 0
-
-      # ActionController::Parameters will raise if they are not yet permitted
-      # and we try to convert to hash.
-      # https://api.rubyonrails.org/classes/ActionController/Parameters.html
-      return nil if object.respond_to?(:permitted?) && !object.permitted?
-
-      hash = object.to_hash
-      return nil if !hash.respond_to?(:keys) || !hash.respond_to?(:[])
-
-      hash
+    def active_formatter(type)
+      self.class.registered_formatters[type]
     end
   end
 end
+