amazing_print 1.8.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab76db037a1c38f0bd372838a92ae03e453f2d81eb73e9c9df5c272b600747dc
-  data.tar.gz: 45a2b9d7de1d5b9f04a57277364646762fd0b84021e91ee71d7a01e966a9e6e7
+  metadata.gz: 8072cc250156956633f6956bdb3bc23c93b8c1e2c578471bfac37de210b8dc2d
+  data.tar.gz: 1abd0d9bc13804532c4fd5c4c2c2c180a32980809d3381866b367981d5396c62
 SHA512:
-  metadata.gz: ba4f13b020e16874a0313582279b5e8d5e32455da5d8cdb6ccfac4fd21a150e6061000099558e5ae280c01ddd8c460bf8b2a1ea40301dec4e87fc47046678013
-  data.tar.gz: 1f60c6eb6b2b302aabb011323dae7d78ec37855b727d884c5b83256d075b416de84c87b35e6eb6d21d72e9a5670f53331f639a8310e8bbee285235e24a9c5782
+  metadata.gz: 9797830f7ff0055f00ce07a86ecb28ad912e1081c7718d5e0f41bd04167d11c93553182f96b029df10759116e29348434e153419a14c3fd3b11c358b842280c9
+  data.tar.gz: f9e236e54d4a1d10c2f54f70f71ebbd51fb799485cb9ccb5dd15aa33b5a33d60281f44117b81d414a8b57a69f79d8fb79b54e823684045c543fdab5c9943abe0

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # CHANGELOG
 
+## Unreleased
+
+## 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
+- Use array.length.zero? to avoid issues with ActiveRecord collection proxy #129
+- grammar glowup in README.md #130
+
 ## v1.8.0
 
 - Drop Ruby 3.0 and add Ruby 3.4 #125

data/README.md

@@ -8,7 +8,7 @@
 |
 [![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)
 
-AmazingPrint is a fork of [AwesomePrint](https://github.com/awesome-print/awesome_print) which became stale and should be used in its 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 its 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)
 
@@ -43,7 +43,7 @@ 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 called to report the instance class name. (e.g. :to_s)
 object_id:     true,   # Show object id.
 color: {
@@ -266,7 +266,7 @@ rails>
 ```
 
 ### IRB integration ###
-To use amazing_print as default formatter in irb and Rails console add the following
+To use amazing_print as the default formatter in irb and the Rails console, add the following
 code to your ~/.irbrc file:
 
 ```ruby
@@ -293,7 +293,7 @@ By default, this logs at the :debug level. You can override that globally with:
 
     :log_level => :info
 
-in the custom defaults (see below). You can also override on a per call basis with:
+in the custom defaults (see below). You can also override it on a per call basis with:
 
     logger.ap object, :warn
     # or
@@ -310,7 +310,7 @@ within Rails templates. For example:
     <%= ap @accounts.first %>   # ERB
     != ap @accounts.first       # HAML
 
-With other web frameworks (ex: in Sinatra templates) you can explicitly request HTML
+With other web frameworks (for example in Sinatra templates) you can explicitly request HTML
 formatting:
 
     <%= ap @accounts.first, :html => true %>
@@ -324,8 +324,8 @@ red text # (it's red)
 ```
 
 ### Setting Custom Defaults ###
-You can set your own default options by creating ``aprc`` file in your `$XDG_CONFIG_HOME`
-directory (defaults to `~/.config` if undefined). Within that file assign your defaults
+You can set your own default options by creating an ``aprc`` file in your `$XDG_CONFIG_HOME`
+directory (which defaults to `~/.config` if undefined). Within that file assign your defaults
 to ``AmazingPrint.defaults``.
 For example:
 
@@ -340,7 +340,7 @@ AmazingPrint.defaults = {
 }
 ```
 
-The previous `~/.aprc` location is still supported as fallback.
+The previous `~/.aprc` location is still supported as a fallback.
 
 ## Versioning
 

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[:plain] = true 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/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)
@@ -15,7 +18,7 @@ module AmazingPrint
       end
 
       def format
-        if array.empty?
+        if array.length.zero? # rubocop:disable Style/ZeroLengthPredicate
           '[]'
         elsif methods_array?
           methods_array
@@ -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/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
@@ -91,13 +106,36 @@ 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 = inspector.awesome(key).sub(/#{Regexp.escape(key.inspect)}/, "#{key_string}:")
 
         "#{align(awesome_key, width)} #{inspector.awesome(value)}"
       end

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/struct_formatter.rb

@@ -61,7 +61,11 @@ module AmazingPrint
         # 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)
+        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
 

data/lib/amazing_print/inspector.rb

@@ -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
@@ -37,7 +37,7 @@ module AmazingPrint
         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
 

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.0'
+    '2.0.0'
   end
 end

metadata

@@ -1,11 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: amazing_print
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Michael Dvorkin
-- Kevin McCormackPatrik Wenger
+- Kevin McCormack
+- Patrik Wenger
 bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
@@ -55,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
@@ -76,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Pretty print Ruby objects with proper indentation and colors
 test_files: []