amazing_print 1.8.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c54bf5089bc3eb9ecb72f953d2b7972ec91f512d17d85f64e0e68bfffe963eb
-  data.tar.gz: e25109a0515688c4a3212e2dfa1a9a65a615959f67372a88f77011d8e0a531e0
+  metadata.gz: 6020ecb594da670f3354aaddf2444e65b65d0ebe513d0ca2d42c879afb1921ae
+  data.tar.gz: cffea382697c97a5c9984b1fdcb5533ed705539e96fd26d36a5fe9c05e4bce30
 SHA512:
-  metadata.gz: 53eb2f3a3bba9510f098ea1d550a2c4ce2080f21c4b19daea1e40e7b4fdc8df4336ef494bdb2626892e73f17ab6dc4bc2001dea1f64168d8d331baeb998ee273
-  data.tar.gz: 5cf3937b23f27e89a75c2a0adbf0353f8a2fb5f936f836b44f7e152559bdb0c7f8b1e30c95f9bca506342bf08b2da3e29b377bf1757ccf031de7e24cf7ccdc99
+  metadata.gz: 051f4d8f6bda59fdcd09f52eea6775cc80ddce2bd130dc86880172e76693980a93b87cff63a73b08e037ded38bb8846746f778bfb589a8d45f8b4795e7245031
+  data.tar.gz: 126faa9850f7e963c8b6c0de45a4353cee2715557dbe714189ad718f5ceaaa09212131e943255ce9bba153cb8a25f13c8fdddb90f3498d7698164519a283ab37

data/CHANGELOG.md

@@ -2,6 +2,27 @@
 
 ## Unreleased
 
+## v3.0.0
+
+- Support Rails 8.2 (#144, #158)
+- Change default coloring behavior to only color values, instead of keys and values (#151)
+- Support Ruby 4.0 (#150)
+- Fix alignment when using html: true with colors (#146)
+- Fix forcing colors on future version of Rails (#144)
+- Add `colors` option that can have the following values (#143):
+    - `:all`. Colors hash keys and values.
+    - `:values_only`. Only colors hash values, not hash keys. Default.
+    - `:none`. Disables colors.
+- Deprecate `plain` option in favor of `colors: :none` (#143)
+- Fix alignment when using `html: true` with colors (#146)
+- Add option disable colors for hash keys (#142)
+- Document `rdbg!` feature (#139)
+
+## v2.0.0
+
+- Rework hash formats and add JSON format (#83)
+- Format Data objects using StructFormatter (#138)
+
 ## v1.8.1
 
 - Fix authors list in gemspec #128

data/README.md

@@ -14,7 +14,7 @@ AmazingPrint is a fork of [AwesomePrint](https://github.com/awesome-print/awesom
 
 ### Supported Versions ###
 
-- Ruby >= 3.1
+- Ruby >= 3.2
 - Rails >= 6.1
 
 ### Installation ###
@@ -34,18 +34,18 @@ ap object, options = {}
 Default options:
 
 ```ruby
-indent:        4,      # Number of spaces for indenting.
-index:         true,   # Display array indices.
-html:          false,  # Use ANSI color codes rather than HTML.
-multiline:     true,   # Display in multiple lines.
-plain:         false,  # Use colors.
-raw:           false,  # Do not recursively format instance variables.
-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.
+indent:        4,            # Number of spaces for indenting.
+index:         true,         # Display array indices.
+html:          false,        # Use ANSI color codes rather than HTML.
+multiline:     true,         # Display in multiple lines.
+colors:        :values_only, # Controls what should be colored. Can be one of :all, :values_only, or :none
+raw:           false,        # Do not recursively format instance variables.
+sort_keys:     false,        # Do not sort hash keys.
+sort_vars:     true,         # Sort instance variables.
+limit:         false,        # Limit arrays & hashes. Accepts bool or int.
+hash_format:   :symbol,      # The format for printing hashes. Can be one of :json, :rocket, or :symbol
+class_name:    :class,       # Method called to report the instance class name. (e.g. :to_s)
+object_id:     true,         # Show object id.
 color: {
   args:       :whiteish,
   array:      :white,
@@ -267,16 +267,17 @@ rails>
 
 ### IRB integration ###
 To use amazing_print as the default formatter in irb and the Rails console, add the following
-code to your ~/.irbrc file:
+code to your `~/.irbrc` file:
 
 ```ruby
 require "amazing_print"
 AmazingPrint.irb!
+AmazingPrint.rdbg! # Enables integration with ruby debug
 ```
 
 ### PRY integration ###
 If you miss amazing_print's way of formatting output, here's how you can use it in place
-of the formatting which comes with pry. Add the following code to your ~/.pryrc:
+of the formatting which comes with pry. Add the following code to your `~/.pryrc`:
 
 ```ruby
 require "amazing_print"
@@ -284,7 +285,7 @@ AmazingPrint.pry!
 ```
 
 ### Logger Convenience Method ###
-amazing_print adds the 'ap' method to the Logger and ActiveSupport::BufferedLogger classes
+amazing_print adds the `ap` method to the `Logger` and `ActiveSupport::BufferedLogger` classes
 letting you call:
 
     logger.ap object
@@ -304,7 +305,7 @@ You can also pass additional options (providing `nil` or leaving off `level` wil
     logger.ap object, { level: :info, sort_keys: true }
 
 ### ActionView Convenience Method ###
-amazing_print adds the 'ap' method to the ActionView::Base class making it available
+amazing_print adds the `ap` method to the `ActionView::Base` class making it available
 within Rails templates. For example:
 
     <%= ap @accounts.first %>   # ERB

data/lib/amazing_print/colorize.rb

@@ -10,7 +10,7 @@ module AmazingPrint
     #------------------------------------------------------------------------------
     def colorize(str, type)
       str = CGI.escapeHTML(str) if options[:html]
-      return str if options[:plain] || !options[:color][type] || !inspector.colorize?
+      return str if options[:colors] == :none || !options[:color][type] || !inspector.colorize?
 
       AmazingPrint::Colors.public_send(options[:color][type], str, options[:html])
     end

data/lib/amazing_print/custom_defaults.rb

@@ -53,6 +53,35 @@ module AmazingPrint
       end
     end
 
+    def rdbg!
+      return unless defined?(::DEBUGGER__::SESSION)
+
+      ::DEBUGGER__::SESSION.extend_feature(
+        thread_client: Module.new do
+          # rdbg calls this for both p and pp printing paths
+          def color_pp(obj, width)
+            opts = {
+              multiline: true,
+              index: false,
+              indent: 2
+            }
+
+            opts[:colors] = :none if ::DEBUGGER__::CONFIG[:no_color]
+
+            if obj.respond_to?(:ai)
+              obj.ai(opts)
+            else
+              # Fallback if AP isn't mixed into the object for some reason
+              super
+            end
+          rescue StandardError
+            # Never break the debugger; fall back to rdbg default
+            super
+          end
+        end
+      )
+    end
+
     ##
     # Reload the cached custom configurations.
     #
@@ -65,7 +94,7 @@ module AmazingPrint
     # Takes a value and returns true unless it is false or nil
     # This is an alternative to the less readable !!(value)
     # https://github.com/bbatsov/ruby-style-guide#no-bang-bang
-    def boolean(value)
+    def boolean(value) # rubocop:todo Naming/PredicateMethod
       value ? true : false
     end
   end

data/lib/amazing_print/ext/active_support.rb

@@ -42,4 +42,6 @@ AmazingPrint::Formatter.include AmazingPrint::ActiveSupport
 #
 # Colorize Rails logs.
 #
-AmazingPrint.force_colors! colors: ActiveSupport::LogSubscriber.colorize_logging if defined?(ActiveSupport::LogSubscriber)
+AmazingPrint.force_colors!(
+  colors: ActiveSupport.try(:colorize_logging) || ActiveSupport::LogSubscriber.try(:colorize_logging)
+)

data/lib/amazing_print/ext/nobrainer.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# rubocop:disable Style/HashTransformValues
-
 # Copyright (c) 2010-2016 Michael Dvorkin and contributors
 #
 # AmazingPrint is freely distributable under the terms of MIT license.
@@ -53,5 +51,3 @@ module AmazingPrint
 end
 
 AmazingPrint::Formatter.include AmazingPrint::NoBrainer
-
-# rubocop:enable Style/HashTransformValues

data/lib/amazing_print/ext/sequel.rb

@@ -29,8 +29,8 @@ module AmazingPrint
     # Format Sequel Document object.
     #------------------------------------------------------------------------------
     def awesome_sequel_document(object)
-      data = object.values.sort_by(&:to_s).each_with_object({}) do |c, hash|
-        hash[c[0].to_sym] = c[1]
+      data = object.values.sort_by(&:to_s).to_h do |c|
+        [c[0].to_sym, c[1]]
       end
       data = { errors: object.errors, values: data } unless object.errors.empty?
       "#{object} #{awesome_hash(data)}"

data/lib/amazing_print/formatters/array_formatter.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
 require_relative 'base_formatter'
+require_relative '../json_helper'
 
 module AmazingPrint
   module Formatters
     class ArrayFormatter < BaseFormatter
+      include AmazingPrint::JSONHelper
+
       attr_reader :array, :inspector, :options
 
       def initialize(array, inspector)
@@ -51,7 +54,9 @@ module AmazingPrint
       def generate_printable_array
         array.map.with_index do |item, index|
           array_prefix(index, width(array)).tap do |temp|
-            indented { temp << inspector.awesome(item) }
+            indented do
+              temp << json_awesome(item)
+            end
           end
         end
       end
@@ -127,7 +132,7 @@ module AmazingPrint
       end
 
       def generic_prefix(iteration, width, padding = '')
-        if options[:index]
+        if options[:index] && options[:hash_format] != :json
           indent + colorize("[#{iteration.to_s.rjust(width)}] ", :array)
         else
           indent + padding

data/lib/amazing_print/formatters/base_formatter.rb

@@ -144,7 +144,8 @@ module AmazingPrint
       end
 
       def colorless(string)
-        string.gsub(/\e\[[\d;]+m/, '')
+        result = string.gsub(/\e\[[\d;]+m/, '')
+        result.gsub(%r{<kbd[^>]*>|</kbd>}, '')
       end
 
       def colorless_size(string)

data/lib/amazing_print/formatters/hash_formatter.rb

@@ -1,10 +1,17 @@
 # frozen_string_literal: true
 
 require_relative 'base_formatter'
+require_relative '../json_helper'
 
 module AmazingPrint
   module Formatters
     class HashFormatter < BaseFormatter
+      include AmazingPrint::JSONHelper
+
+      VALID_HASH_FORMATS = %i[json rocket symbol].freeze
+
+      class InvalidHashFormatError < StandardError; end
+
       attr_reader :hash, :inspector, :options
 
       def initialize(hash, inspector)
@@ -12,6 +19,11 @@ module AmazingPrint
         @hash = hash
         @inspector = inspector
         @options = inspector.options
+
+        return if VALID_HASH_FORMATS.include?(options[:hash_format])
+
+        raise(InvalidHashFormatError, "Invalid hash_format: #{options[:hash_format].inspect}. " \
+                                      "Must be one of #{VALID_HASH_FORMATS}")
       end
 
       def format
@@ -48,10 +60,13 @@ module AmazingPrint
 
         data.map! do |key, value|
           indented do
-            if options[:ruby19_syntax] && symbol?(key)
-              ruby19_syntax(key, value, width)
-            else
+            case options[:hash_format]
+            when :json
+              json_syntax(key, value, width)
+            when :rocket
               pre_ruby19_syntax(key, value, width)
+            when :symbol
+              ruby19_syntax(key, value, width)
             end
           end
         end
@@ -69,9 +84,9 @@ module AmazingPrint
         return key.inspect.size if symbol?(key)
 
         if options[:html]
-          single_line { inspector.awesome(key) }.size
+          colorless_size(single_line { inspector.awesome(key) })
         else
-          plain_single_line { inspector.awesome(key) }.size
+          no_colors { single_line { inspector.awesome(key) }.size }
         end
       end
 
@@ -91,28 +106,60 @@ module AmazingPrint
         end
       end
 
+      def string?(key)
+        key[0] == '"' && key[-1] == '"'
+      end
+
       def symbol?(key)
         key.is_a?(Symbol)
       end
 
+      def json_format?
+        options[:hash_format] == :json
+      end
+
+      def json_syntax(key, value, width)
+        unless defined?(JSON)
+          warn 'JSON is not defined. Defaulting hash format to symbol'
+          return ruby19_syntax(key, value, width)
+        end
+
+        formatted_key = json_awesome(key, is_key: true)
+        formatted_value = json_awesome(value)
+
+        "#{align(formatted_key, width)}#{colorize(': ', :hash)}#{formatted_value}"
+      end
+
       def ruby19_syntax(key, value, width)
+        return pre_ruby19_syntax(key, value, width) unless symbol?(key)
+
         # Move the colon to the right side of the symbol
-        awesome_key = inspector.awesome(key).sub(/#{key.inspect}/, "#{key}:")
+        key_string = key.inspect.include?('"') ? key.inspect.sub(':', '') : key.to_s
+        awesome_key = format_key(key).sub(/#{Regexp.escape(key.inspect)}/, "#{key_string}:")
 
         "#{align(awesome_key, width)} #{inspector.awesome(value)}"
       end
 
       def pre_ruby19_syntax(key, value, width)
-        awesome_key = single_line { inspector.awesome(key) }
+        awesome_key = single_line { format_key(key) }
+
         "#{align(awesome_key, width)}#{colorize(' => ', :hash)}#{inspector.awesome(value)}"
       end
 
-      def plain_single_line(&)
-        plain = options[:plain]
-        options[:plain] = true
-        single_line(&)
+      def format_key(key)
+        if options[:colors] == :values_only
+          no_colors { inspector.awesome(key) }
+        else
+          inspector.awesome(key)
+        end
+      end
+
+      def no_colors
+        old_colors = options[:colors]
+        options[:colors] = :none
+        yield
       ensure
-        options[:plain] = plain
+        options[:colors] = old_colors
       end
 
       def single_line

data/lib/amazing_print/formatters/mswin_helper.rb

@@ -7,6 +7,7 @@ module AmazingPrint
   module Formatters
     module Kernel32
       extend Fiddle::Importer
+
       dlload 'kernel32'
       extern 'unsigned long GetFileAttributesA(const char*)'
     end

data/lib/amazing_print/formatters/object_formatter.rb

@@ -35,7 +35,7 @@ module AmazingPrint
             align(declaration, declaration.size)
           end
 
-          unless options[:plain]
+          if options[:colors] != :none
             key = if key =~ /(@\w+)/
                     key.sub(Regexp.last_match(1), colorize(Regexp.last_match(1), :variable))
                   else
@@ -67,9 +67,8 @@ module AmazingPrint
 
         # We need to ensure that the original Kernel#format is used here instead of the one
         # defined above.
-        # rubocop:disable Style/ColonMethodCall
+        # rubocop:disable-next Style/ColonMethodCall
         str + Kernel::format(':0x%08x', object.__id__ * 2)
-        # rubocop:enable Style/ColonMethodCall
       end
 
       def left_aligned

data/lib/amazing_print/formatters/struct_formatter.rb

@@ -35,7 +35,7 @@ module AmazingPrint
             align(declaration, declaration.size)
           end
 
-          unless options[:plain]
+          if options[:colors] != :none
             key = if key =~ /(@\w+)/
                     key.sub(Regexp.last_match(1), colorize(Regexp.last_match(1), :variable))
                   else
@@ -60,9 +60,12 @@ module AmazingPrint
       def awesome_instance
         # We need to ensure that the original Kernel#format is used here instead of the one defined
         # above.
-        # rubocop:disable Style/ColonMethodCall
-        Kernel::format("#{struct.class.superclass}:#{struct.class}:0x%08x", struct.__id__ * 2)
-        # rubocop:enable Style/ColonMethodCall
+        # rubocop:disable-next Style/ColonMethodCall
+        if defined?(Data) && struct.is_a?(Data)
+          Kernel::format("data #{struct.class}:0x%08x", struct.__id__ * 2)
+        else
+          Kernel::format("#{struct.class.superclass}:#{struct.class}:0x%08x", struct.__id__ * 2)
+        end
       end
 
       def left_aligned

data/lib/amazing_print/inspector.rb

@@ -6,7 +6,7 @@
 # See LICENSE file or http://www.opensource.org/licenses/mit-license.php
 #------------------------------------------------------------------------------
 
-# rubocop:disable Metrics/ClassLength, Metrics/MethodLength
+# rubocop:disable Metrics/MethodLength
 
 require_relative 'indentator'
 require_relative 'ext_loader'
@@ -20,7 +20,7 @@ module AmazingPrint
     ##
     # Unload the cached dotfile and load it again.
     #
-    def self.reload_dotfile
+    def self.reload_dotfile # rubocop:todo Naming/PredicateMethod
       @@dotfile = nil
       new.send :load_dotfile
       true
@@ -32,12 +32,12 @@ module AmazingPrint
         index: true, # Display array indices.
         html: false, # Use ANSI color codes rather than HTML.
         multiline: true, # Display in multiple lines.
-        plain: false, # Use colors.
+        colors: :values_only, # Controls what should be colored. Can be one of :all, :values_only, or :none
         raw: false, # Do not recursively format instance variables.
         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.
+        hash_format: :symbol, # The format for printing hashes. Can be one of :json, :rocket, or :symbol
         class_name: :class, # Method used to get Instance class name.
         object_id: true, # Show object_id.
         color: {
@@ -150,7 +150,12 @@ module AmazingPrint
       when File   then :file
       when Dir    then :dir
       when Struct then :struct
-      else object.class.to_s.gsub(/:+/, '_').downcase.to_sym
+      else
+        if defined?(Data) && object.is_a?(Data)
+          :struct
+        else
+          object.class.to_s.gsub(/:+/, '_').downcase.to_sym
+        end
       end
     end
 
@@ -159,6 +164,8 @@ module AmazingPrint
     #---------------------------------------------------------------------------
     def merge_options!(options = {})
       @options[:color].merge!(options.delete(:color) || {})
+      @options[:colors] = :none if options[:plain]
+
       @options.merge!(options)
     end
 
@@ -199,4 +206,4 @@ module AmazingPrint
   end
 end
 
-# rubocop:enable Metrics/ClassLength, Metrics/MethodLength
+# rubocop:enable Metrics/MethodLength

data/lib/amazing_print/json_helper.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+##
+# Helper module for hash_format: :json
+#
+module AmazingPrint
+  module JSONHelper
+    VALUE_CLASSES_NOT_TO_CONVERT = %w[Array BigDecimal Float Hash Integer String].freeze
+
+    def json_awesome(object, is_key: false)
+      return inspector.awesome(object) unless options[:hash_format] == :json && object.respond_to?(:to_json)
+
+      if object.nil?
+        # Color null like we do nil
+        colorize(object.to_json, :nilclass)
+      elsif is_key && object.is_a?(Numeric)
+        # JSON keys should be a string
+        inspector.awesome(object.to_s)
+      elsif VALUE_CLASSES_NOT_TO_CONVERT.include?(object.class.name) || !object.respond_to?(:to_json)
+        # These objects should not be converted to strings with #to_json so we can treat them normally
+        inspector.awesome(object)
+      else
+        # Remove surrounding quotes added by #to_json from the standard library since
+        # inspector.awesome is going to add those for us for strings.
+        inspector.awesome(object.to_json.gsub(/\A"/, '').gsub(/"\z/, ''))
+      end
+    end
+  end
+end

data/lib/amazing_print/version.rb

@@ -7,6 +7,6 @@
 #------------------------------------------------------------------------------
 module AmazingPrint
   def self.version
-    '1.8.1'
+    '3.0.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: amazing_print
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Michael Dvorkin
@@ -56,6 +56,7 @@ files:
 - lib/amazing_print/formatters/struct_formatter.rb
 - lib/amazing_print/indentator.rb
 - lib/amazing_print/inspector.rb
+- lib/amazing_print/json_helper.rb
 - lib/amazing_print/version.rb
 - lib/ap.rb
 homepage: https://github.com/amazing-print/amazing_print
@@ -70,14 +71,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Pretty print Ruby objects with proper indentation and colors
 test_files: []