awesome_print 1.8.0 → 2.0.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cda3844883c76081eb1cbaf6e6188492b51d741d
-  data.tar.gz: be404804711ff00ce4f3720153bf84ba10d012ef
+  metadata.gz: b78e2becdd2b08753b1e78e1c2c46e531f6750a2
+  data.tar.gz: 9e79ebd10b6b47e9026d0e412f83615466e67c89
 SHA512:
-  metadata.gz: 3a83fe61488d2df035585c6d54f9e93dfa5c950bef2a7e05707fdb334090bf91db46921d88f2fac136edf13904ee0c76393e5a7c4d4d5f53cf9b460a0f724696
-  data.tar.gz: 87d8c72172448c0897c668cbefcfe4713802effa219469297ce8b242307998c70f82a087feeb7f0b485ee34941bd833aa5eb14c322143242f09b8f3e7418bc5c
+  metadata.gz: 2b6b91f195831126213e10ffba034c1ed5f6be030b5bc89870aeead7c6edb95a39a3968d24c60f06c4d2c88e16b4c7f7974ee0b81e3b33c66de5e36ce916e4e9
+  data.tar.gz: 4bb762cc93185b014c5f56b8a4b1cccaa2a52277b88efe68c8cc4c85728db7fd9a7e6fd5c1f63677e865a34aa671c03a2239df5a6d91eb4fffb4dc83cb54703e

data/.gitignore

@@ -33,3 +33,4 @@ Gemfile.lock
 # PROJECT::RBENV
 .ruby-gemset
 .awesome-print/
+.byebug_history

data/Appraisals

@@ -1,63 +1,31 @@
-appraise 'rails-3.2' do
-  gem 'rails', '~> 3.2.0'
-end
-
-appraise 'rails-4.0' do
-  gem 'rails', '~> 4.0.0'
-  gem 'json',  '~> 1.8', :platforms => :ruby_19 # Json 2.0 requires Ruby >= 2.0
-
-  # The last version that doesn't need Ruby 2.0 and works with version 4.0 of
-  # Rails. This addresses a build problem with Travis for version 1.9.3 of Ruby
-  gem 'mime-types', '2.6.2', :platforms => :ruby_19
-end
-
-appraise 'rails-4.1' do
-  gem 'rails', '~> 4.1.0'
-
-  # The last version that doesn't need Ruby 2.0 and works with version 4.1 of
-  # Rails. This addresses a build problem with Travis for version 1.9.3 of Ruby
-  gem 'mime-types', '2.6.2', :platforms => :ruby_19
-end
-
-appraise 'rails-4.2' do
-  gem 'rails', '~> 4.2.0'
-
-  # The last version that doesn't need Ruby 2.0 and works with version 4.2 of
-  # Rails. This addresses a build problem with Travis for version 1.9.3 of Ruby
-  gem 'mime-types', '2.6.2', :platforms => :ruby_19
-end
+# appraise 'rails-4.2' do
+#   gem 'rails', '~> 4.2.0'
+#
+#   # The last version that doesn't need Ruby 2.0 and works with version 4.2 of
+#   # Rails. This addresses a build problem with Travis for version 1.9.3 of Ruby
+#   gem 'mime-types', '2.6.2', :platforms => :ruby_19
+# end
 
 appraise 'rails-5.0' do
-  # Only works with Ruby >= 2.2
-  gem 'rails', '>= 5.0.0.racecar1', '< 5.1'
+  gem 'rails', '>= 5.0.0', '< 5.1'
 end
 
-appraise 'mongoid-3.0' do
-  gem 'mongoid', '~> 3.0.0'
+appraise 'rails-5.1' do
+  gem 'rails', '>= 5.1.0', '< 5.2'
 end
 
-appraise 'mongoid-3.1' do
-  gem 'mongoid', '~> 3.1.0'
-  gem 'json',  '~> 1.8', :platforms => :ruby_19 # Json 2.0 requires Ruby >= 2.0
+appraise 'rails-5.2' do
+  gem 'rails', '>= 5.2.0', '< 5.3'
 end
 
 appraise 'mongoid-4.0' do
   gem 'mongoid', '~> 4.0.0'
 end
 
-appraise 'mongo_mapper' do
-  gem 'mongo_mapper'
+appraise 'mongoid-5.0' do
+  gem 'mongoid', '~> 5.0.0'
 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
+appraise 'mongoid-6.0' do
+  gem 'mongoid', '~> 6.0.0'
 end

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## master (unreleased)
-  - new things!
+
+## 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]
+  - ArrayFormatter now returns arrays for has_many :through associations [@chadh13] - [#332]
 
 ## 1.8.0
   - stat("$HOME/.aprc") once [@kstephens] - [#304]

data/LICENSE

@@ -1,22 +1,19 @@
-Copyright (c) 2010-2013 Michael Dvorkin
-http://www.dvorkin.net
-%w(mike dvorkin.net) * "@" || "twitter.com/mid"
+Copyright (c) 2010-2019 Michael Dvorkin
 
-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:
+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 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 OR COPYRIGHT HOLDERS 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.
+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 OR COPYRIGHT HOLDERS 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.md

@@ -43,6 +43,8 @@ sort_keys:     false,  # Do not sort hash keys.
 sort_vars:     true,   # Sort instance variables.
 limit:         false,  # Limit arrays & hashes. Accepts bool or int.
 ruby19_syntax: false,  # Use Ruby 1.9 hash syntax in output.
+class_name:    :class, # Method called to report the instance class name. (e.g. :to_s)
+object_id:     true,   # Show object id.
 color: {
   args:       :pale,
   array:      :white,
@@ -50,7 +52,7 @@ color: {
   class:      :yellow,
   date:       :greenish,
   falseclass: :red,
-  fixnum:     :blue,
+  integer:    :blue,
   float:      :blue,
   hash:       :pale,
   keyword:    :cyan,
@@ -331,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/formatter.rb

@@ -1,126 +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 = [: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.grep(type)[0] || :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 awesome_method(m)
-      Formatters::MethodFormatter.new(m, @inspector).format
-    end
-    alias :awesome_unboundmethod :awesome_method
+    def format(object, type = nil)
+      puts "\n\n[FMT] #{type.to_s.red} >>> #{object}" if AwesomePrint.debug
 
-    def awesome_class(c)
-      Formatters::ClassFormatter.new(c, @inspector).format
-    end
+      format_with = active_formatter(type)
+      puts "[ACTIVE] using > #{format_with.to_s.blueish} < to format" if format_with && AwesomePrint.debug
 
-    def awesome_file(f)
-      Formatters::FileFormatter.new(f, @inspector).format
-    end
+      # if we have an active formatter, and it's good to go, lets return that
 
-    def awesome_dir(d)
-      Formatters::DirFormatter.new(d, @inspector).format
-    end
+      return format_with.new(@inspector).format(object) if format_with&.formattable?(object)
 
-    # Utility methods.
-    #------------------------------------------------------------------------------
-    def convert_to_hash(object)
-      if !object.respond_to?(:to_hash)
-        return nil
-      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
 
-      if object.method(:to_hash).arity != 0
-        return nil
+        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
 
-      hash = object.to_hash
-      if !hash.respond_to?(:keys) || !hash.respond_to?('[]')
-        return nil
-      end
+      # 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
 
-      return hash
+    def active_formatter(type)
+      self.class.registered_formatters[type]
     end
   end
 end
+