report_print 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95d2ad3bb32255b708ff4f8b2e8f60e300cd40a1d7bab2e352ca1b355ddf8bad
-  data.tar.gz: 13740735a26e08b56e1f0d2e790524afd3ec73789465a65117f2f62555177220
+  metadata.gz: d6bc69172badef1f367d722882bf9dfc8dcaffb66926811cc37ddebcffac68a8
+  data.tar.gz: 1fdb2ce8ed7441c34f6cc792480fc9b7ad614c0d26204cf237ada5c52f9969bc
 SHA512:
-  metadata.gz: 87218676c7e05ef0ec0f7243dc2558da038c4abac79f21a9eee2df00e730545e5add08761195d40238303241b9181198bab19da7acef422e57656d00f5b86db3
-  data.tar.gz: 5b17164200cdbc4fbb24a39e5206368766bead5277126c81753be4d9cfdcdf52df202d857eda1e15bc28b39bae95cd7641c015e0fc8eae6301fc48e18eef6884
+  metadata.gz: b701bc0e9ac1896140001a39967d96ea4acc369fc7ae8a619a0e62035aa16ace37dcebcb6757abb5f0d3deb93be1e1f8381b31cc90c1e7aadd4a687cbcec0bec
+  data.tar.gz: 74c6fb521894a4f14591d5d0e23f1b941c04b5209fe9dfb880b35f84041a27c6f917aee484e6402ec555e466fd5a6e3fb582ba60c3ad1432b452f1385c7b4baa

data/README.md

@@ -23,7 +23,29 @@ gem install report_print
 ```ruby
 require 'report_print'
 
-rp object
+class Example
+  def initialize
+    @foo = { a: [1,2,3] }
+    @bar = Object.new
+  end
+end
+
+rp Example.new
+```
+
+Output:
+
+```text
+Example 0x378
+  @foo = {
+    a: [
+      1,
+      2,
+      3
+    ]
+  }
+  @bar = Object 0x3a8
+end
 ```
 
 See the [full documentation](https://benoithiller.github.io/report_print/) for more details.

data/doc/Formatters.md

@@ -10,6 +10,7 @@ A number of simple value types are configured to produce colorized versions of t
 
     rp :symbols
     rp "strings"
+    rp /regex/
 
     # All Numeric types
     rp 1
@@ -27,7 +28,8 @@ Output:
 
 <pre>
 <span style="color:var(--code-blue)">:symbols<span style="color:var(--code-green)">
-"strings"<span style="color:var(--code-purple)">
+"strings"<span style="color:var(--code-orange)">
+/regex/<span style="color:var(--code-purple)">
 1
 0.5
 Infinity
@@ -165,3 +167,19 @@ Output:
 </pre>
 
 Note that the object id is included for `Struct` but not for `Data` as the latter is a flyweight while the former is essentially an ordinary class.
+
+## `Range` and `ArithmeticSequence`
+
+    rp(1..10)
+    rp(..10)
+    rp((1...10).step(2))
+    rp("a".."z")
+
+Output:
+
+<pre>
+(<span style="color:var(--code-purple)">1</span>..<span style="color:var(--code-purple)">10</span>)
+(..<span style="color:var(--code-purple)">10</span>)
+(<span style="color:var(--code-purple)">1</span>...<span style="color:var(--code-purple)">10</span>).step(<span style="color:var(--code-purple)">2</span>)
+(<span style="color:var(--code-green)">"a"</span>..<span style="color:var(--code-green)">"z"</span>)</span>
+</pre>

data/gem_description.rdoc

@@ -2,8 +2,4 @@ A hybrid between PrettyPrint and AwesomePrint/AmazingPrint. Providing you both a
 
 The name ReportPrint comes from the desire to output detailed reports of the program state at a given point in time, rather than merely inspecting an object.
 
-== Usage
-
-  require 'report_print'
-
-  rp object
+After requiring simply use the global `rp` method to print objects like you do with `pp` or `ap`.

data/lib/.document

@@ -1,2 +1,3 @@
 report_print/printer.rb
 report_print/dsl.rb
+report_print/api.rb

data/lib/report_print/api.rb

@@ -0,0 +1,61 @@
+module ReportPrint
+  ##
+  # These are the extensions that are included into the Module class that
+  # enabled you to customize the behaviour of ReportPrint for your own classes.
+  module Api
+    ##
+    # Defines options used by the printer when printing instances of the
+    # current class.
+    #
+    # The currently supported options are:
+    #
+    # * `detect_cycles:` whether instances of this class should display just a
+    #   header and id when printed multiple times by the same report print
+    #   command.
+    #   <br>
+    #   Defaults to `true` except for in the case of the simple value types and
+    #   Data classes.
+    # * `color:` the color value to apply when using #report_print_inspect!.
+    #   <br>
+    #   Defaults to `nil`.
+    #
+    # #### Example Usage
+    #
+    # ```
+    # class WithColor
+    #   report_print_options(color: :bright_blue)
+    #   report_print_inspect!
+    # end
+    #
+    # class CustomContainer
+    #   report_print_options(detect_cycles: false)
+    # end
+    # ```
+    #
+    # #### Option Loading
+    #
+    # Setting any value to `nil` means: take the global value if it is defined.
+    #
+    # When ReportPrint fetches options for a given class it first fetches the
+    # superclass options (recursively), then it merges the options for the
+    # current class on top.
+    #
+    # After which it compacts the options (removing the nils) and merges them
+    # on top of any global options. Where the global options are currently
+    # specified by calling `ReportPrint.report_print_options`.
+    def report_print_options(**kwargs)
+      @report_print_options = (@report_print_options || {}).merge(kwargs)
+    end
+
+    ##
+    # Helper that defines a `report_print` method which calls `inspect` and
+    # applies the `color:` specified in #report_print_options.
+    def report_print_inspect!
+      define_method(:report_print) do |rp|
+        rp.write(inspect, color: rp.options_for(self)[:color])
+      end
+    end
+  end
+end
+
+Module.prepend(ReportPrint::Api)

data/lib/report_print/core_extensions.rb

@@ -1,47 +1,114 @@
 using ReportPrint::Refinements
 
-class ::Object < ::BasicObject
+class ::Module < ::Object
   def report_print(rp)
-    rp.unless_seen(self) do
-      rp.write_header(self)
-      rp.multiline(after: rp.color("end", :bright_blue), after_empty: false) do
-        rp.write_instance_variables(self)
-      end
-    end
+    rp.write(short_class_name, color: :bright_yellow)
   end
 end
 
-class ::Module < ::Object
+class ::Object < ::BasicObject
+  report_print_options(detect_cycles: true)
+
   def report_print(rp)
-    rp.write(short_class_name, color: :bright_yellow)
+    rp.write_header(self)
+    rp.multiline(after: rp.color("end", :bright_blue), after_empty: false) do
+      rp.write_instance_variables(self)
+    end
+  end
+
+  def report_print_cycle(rp)
+    rp.write_header(self)
   end
 end
 
 class ::Symbol < ::Object
-  report_print_inspect!(color: :bright_blue)
+  report_print_options(color: :bright_blue, detect_cycles: false)
+  report_print_inspect!
 end
 
 class ::TrueClass < ::Object
-  report_print_inspect!(color: :bright_blue)
+  report_print_options(color: :bright_blue, detect_cycles: false)
+  report_print_inspect!
 end
 
 class ::FalseClass < ::Object
-  report_print_inspect!(color: :bright_blue)
+  report_print_options(color: :bright_blue, detect_cycles: false)
+  report_print_inspect!
 end
 
 class ::Numeric < ::Object
-  report_print_inspect!(color: :bright_magenta)
+  report_print_options(color: :bright_magenta, detect_cycles: false)
+  report_print_inspect!
 end
 
 class ::String < ::Object
-  report_print_inspect!(color: :bright_green)
+  report_print_options(color: :bright_green, detect_cycles: false)
+  report_print_inspect!
 end
 
 class ::NilClass < ::Object
-  report_print_inspect!(color: :bright_blue)
+  report_print_options(color: :bright_blue, detect_cycles: false)
+  report_print_inspect!
+end
+
+class ::Regexp < ::Object
+  report_print_options(color: :yellow, detect_cycles: false)
+  report_print_inspect!
+end
+
+class ::Range < ::Object
+  report_print_options(detect_cycles: false)
+
+  def report_print(rp)
+    first = self.first rescue nil
+    last = self.last rescue nil
+
+    rp.inline("") do
+      rp.write("(")
+      unless first.nil?
+        rp.rp(first)
+      end
+      rp.write("..")
+      if exclude_end?
+        rp.write(".")
+      end
+      unless last.nil?
+        rp.rp(last)
+      end
+      rp.write(")")
+    end
+  end
+end
+
+class ::Enumerator::ArithmeticSequence ::Enumerator
+  report_print_options(detect_cycles: false)
+
+  def report_print(rp)
+    rp.inline("") do
+      rp.write("(")
+      unless self.begin.nil?
+        rp.rp(self.begin)
+      end
+      rp.write("..")
+      if exclude_end?
+        rp.write(".")
+      end
+      unless self.end.nil?
+        rp.rp(self.end)
+      end
+      rp.write(")")
+      unless step == 1
+        rp.write(".step(")
+        rp.rp(step)
+        rp.write(")")
+      end
+    end
+  end
 end
 
 class ::Array < ::Object
+  report_print_options(detect_cycles: false)
+
   def report_print(rp)
     rp.write("[")
     rp.multiline(after: "]", separator: ",") do
@@ -53,6 +120,8 @@ class ::Array < ::Object
 end
 
 class ::Hash < ::Object
+  report_print_options(detect_cycles: false)
+
   def report_print(rp)
     rp.write("{")
     rp.multiline(after: "}", separator: ",") do
@@ -74,6 +143,8 @@ class ::Hash < ::Object
 end
 
 class ::Set < ::Object
+  report_print_options(detect_cycles: false)
+
   def report_print(rp)
     rp.inline("") do
       rp.write("Set", color: :yellow)
@@ -88,6 +159,8 @@ class ::Set < ::Object
 end
 
 class ::Data < ::Object
+  report_print_options(detect_cycles: false)
+
   def report_print(rp)
     name = self.class.short_class_name
     rp.inline("") do

data/lib/report_print/dsl.rb

@@ -19,3 +19,5 @@ module ReportPrint
     end
   end
 end
+
+Kernel.prepend(ReportPrint::Dsl)

data/lib/report_print/printer.rb

@@ -13,16 +13,12 @@ module ReportPrint
       :next_inline_separator,
       :after,
       :start_of_line,
-      :start_of_block
+      :start_of_block,
+      :start_of_output
     ) do
-      # Ruby type checking can't really handle this type of dynamic programming
-      # very well yet, so we just skip type checking here as there is only the
-      # one short function.
-      # steep:ignore:start
       def inline?
         mode == :inline
       end
-      # steep:ignore:end
     end
 
     ##
@@ -32,10 +28,7 @@ module ReportPrint
     def initialize(output = $>, color: :auto)
       @output = output
       if color == :auto
-        # Ignore block performing runtime type check.
-        # steep:ignore:start
         color = output.respond_to?(:tty?) && output.tty?
-        # steep:ignore:end
       end
       @rainbow = Rainbow::Wrapper.new(color)
 
@@ -47,9 +40,12 @@ module ReportPrint
         inline_separator: "",
         next_inline_separator: nil,
         after: nil,
-        start_of_line: false,
-        start_of_block: true
+        start_of_line: true,
+        start_of_block: true,
+        start_of_output: true
       ]
+
+      @options = ScopedOptions.new(ReportPrint.report_print_options)
     end
 
     ##
@@ -60,7 +56,14 @@ module ReportPrint
     def rp(object)
       case object
       when Object
-        object.report_print(self)
+        if @seen.include?(object.__id__)
+          object.report_print_cycle(self)
+        else
+          if options_for(object)[:detect_cycles]
+            @seen.add(object.__id__)
+          end
+          object.report_print(self)
+        end
       else
         write("BasicObject", color: :bright_yellow)
       end
@@ -120,7 +123,8 @@ module ReportPrint
       if @state.inline?
         set_state(
           start_of_line: @state.start_of_line && result.start_of_line,
-          start_of_block: @state.start_of_block && result.start_of_block
+          start_of_block: @state.start_of_block && result.start_of_block,
+          start_of_output: @state.start_of_output && result.start_of_output
         )
         if @state.next_inline_separator != result.next_inline_separator
           # If the inner inline state is requesting a separator, then that
@@ -129,7 +133,8 @@ module ReportPrint
         end
       else
         set_state(
-          start_of_block: @state.start_of_block && result.start_of_block
+          start_of_block: @state.start_of_block && result.start_of_block,
+          start_of_output: @state.start_of_output && result.start_of_output
         )
       end
     end
@@ -167,7 +172,8 @@ module ReportPrint
       )
 
       set_state(
-        start_of_block: @state.start_of_block && result.start_of_block
+        start_of_block: @state.start_of_block && result.start_of_block,
+        start_of_output: @state.start_of_output && result.start_of_output
       )
 
       did_write = !result.start_of_block
@@ -205,7 +211,7 @@ module ReportPrint
     # first concatenated into a single string, as in `IO#write`. Meaning no
     # separators or line breaks will be rendered between them.
     def write(*strings, color: nil)
-      if @state.start_of_line
+      if @state.start_of_line && !@state.start_of_output
         unless @state.start_of_block
           @output.write(@state.separator)
         end
@@ -226,12 +232,14 @@ module ReportPrint
         set_state(
           start_of_line: false,
           start_of_block: false,
+          start_of_output: false,
           next_inline_separator: @state.inline_separator
         )
       else
         set_state(
           start_of_block: false,
-          start_of_line: true
+          start_of_line: true,
+          start_of_output: false
         )
       end
     end
@@ -309,13 +317,13 @@ module ReportPrint
       end
     end
 
-    def unless_seen(object)
-      if @seen.include?(object.__id__)
-        write_header(object)
-      else
-        @seen.add(object.__id__)
-        yield
-      end
+    ##
+    # Fetch the options which are set for the class of `object`.
+    #
+    # See Api#report_print_options for more details about the available
+    # options.
+    def options_for(object)
+      @options.options_for(object.class)
     end
 
     private

data/lib/report_print/refinements.rb

@@ -1,14 +1,5 @@
 module ReportPrint
   module Refinements
-    refine Object.singleton_class do
-      def report_print_inspect!(color: nil)
-        define_method(:report_print) do |rp|
-          # @type self: Object
-          rp.write(inspect, color:)
-        end
-      end
-    end
-
     refine Module do
       def short_class_name
         name.sub(/^.*::/, "")

data/lib/report_print/scoped_options.rb

@@ -0,0 +1,21 @@
+module ReportPrint
+  class ScopedOptions
+    def initialize(global_options)
+      @global_options = global_options
+      @cache = {
+        Object => Object.report_print_options,
+        BasicObject => {}
+      }
+    end
+
+    def options_for(klass)
+      @global_options.merge(self_options_for(klass).compact)
+    end
+
+    private def self_options_for(klass)
+      @cache[klass] ||= (
+        self_options_for(klass.superclass).merge(klass.report_print_options)
+      )
+    end
+  end
+end

data/lib/report_print/version.rb

@@ -1,3 +1,3 @@
 module ReportPrint
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/report_print.rb

@@ -1,9 +1,11 @@
 require_relative "report_print/version"
 require_relative "report_print/refinements"
+require_relative "report_print/api"
+require_relative "report_print/scoped_options"
 require_relative "report_print/printer"
 require_relative "report_print/core_extensions"
 require_relative "report_print/dsl"
 
-module ReportPrint; end
-
-Kernel.prepend(ReportPrint::Dsl)
+module ReportPrint
+  @report_print_options = {}
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: report_print
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Benoit Hiller
@@ -28,11 +28,7 @@ description: |
 
   The name ReportPrint comes from the desire to output detailed reports of the program state at a given point in time, rather than merely inspecting an object.
 
-  == Usage
-
-    require 'report_print'
-
-    rp object
+  After requiring simply use the global `rp` method to print objects like you do with `pp` or `ap`.
 email:
 - benoit.hiller@gmail.com
 executables: []
@@ -48,17 +44,19 @@ files:
 - gem_description.rdoc
 - lib/.document
 - lib/report_print.rb
+- lib/report_print/api.rb
 - lib/report_print/core_extensions.rb
 - lib/report_print/dsl.rb
 - lib/report_print/printer.rb
 - lib/report_print/refinements.rb
+- lib/report_print/scoped_options.rb
 - lib/report_print/version.rb
-homepage: https://github.com/BenoitHiller/report_print
+homepage: https://benoithiller.github.io/report_print/
 licenses:
 - MIT-0
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/BenoitHiller/report_print
+  homepage_uri: https://benoithiller.github.io/report_print/
   source_code_uri: https://github.com/BenoitHiller/report_print
 rdoc_options: []
 require_paths: