amazing_print 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8072cc250156956633f6956bdb3bc23c93b8c1e2c578471bfac37de210b8dc2d
-  data.tar.gz: 1abd0d9bc13804532c4fd5c4c2c2c180a32980809d3381866b367981d5396c62
+  metadata.gz: 6020ecb594da670f3354aaddf2444e65b65d0ebe513d0ca2d42c879afb1921ae
+  data.tar.gz: cffea382697c97a5c9984b1fdcb5533ed705539e96fd26d36a5fe9c05e4bce30
 SHA512:
-  metadata.gz: 9797830f7ff0055f00ce07a86ecb28ad912e1081c7718d5e0f41bd04167d11c93553182f96b029df10759116e29348434e153419a14c3fd3b11c358b842280c9
-  data.tar.gz: f9e236e54d4a1d10c2f54f70f71ebbd51fb799485cb9ccb5dd15aa33b5a33d60281f44117b81d414a8b57a69f79d8fb79b54e823684045c543fdab5c9943abe0
+  metadata.gz: 051f4d8f6bda59fdcd09f52eea6775cc80ddce2bd130dc86880172e76693980a93b87cff63a73b08e037ded38bb8846746f778bfb589a8d45f8b4795e7245031
+  data.tar.gz: 126faa9850f7e963c8b6c0de45a4353cee2715557dbe714189ad718f5ceaaa09212131e943255ce9bba153cb8a25f13c8fdddb90f3498d7698164519a283ab37

data/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 ## 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)

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.
-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.
+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

@@ -66,7 +66,7 @@ module AmazingPrint
               indent: 2
             }
 
-            opts[:plain] = true if ::DEBUGGER__::CONFIG[:no_color]
+            opts[:colors] = :none if ::DEBUGGER__::CONFIG[:no_color]
 
             if obj.respond_to?(:ai)
               obj.ai(opts)

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/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

@@ -84,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
 
@@ -135,22 +135,31 @@ module AmazingPrint
 
         # Move the colon to the right side of the symbol
         key_string = key.inspect.include?('"') ? key.inspect.sub(':', '') : key.to_s
-        awesome_key = inspector.awesome(key).sub(/#{Regexp.escape(key.inspect)}/, "#{key_string}:")
+        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/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,13 +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
+        # 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
-        # rubocop:enable Style/ColonMethodCall
       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'
@@ -32,7 +32,7 @@ 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.
@@ -164,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
 
@@ -204,4 +206,4 @@ module AmazingPrint
   end
 end
 
-# rubocop:enable Metrics/ClassLength, Metrics/MethodLength
+# rubocop:enable Metrics/MethodLength

data/lib/amazing_print/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: amazing_print
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Michael Dvorkin
@@ -71,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.9
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Pretty print Ruby objects with proper indentation and colors
 test_files: []