cute_print 0.3.0 → 0.4.0

data/lib/cute_print/formatter.rb

@@ -1,107 +1,56 @@
 require "pp"
 require "stringio"
 
+require_relative "format"
+require_relative "labeler"
 require_relative "location"
-require_relative "ruby_parser"
+require_relative "location_label"
+require_relative "source_label"
 
 module CutePrint
   # @api private
   class Formatter
 
     DEFAULT_WIDTH = 79
-    DEFAULT_MAX_INLINE_LABEL_WIDTH = 40
 
     def initialize(opts = {})
-      @inspector = :inspect
       @method = opts.fetch(:method)
       @out = opts.fetch(:out)
       @block = opts.fetch(:block, nil)
       @values = opts.fetch(:values, [])
       @width = opts.fetch(:width, DEFAULT_WIDTH)
-      @max_inline_label_width = opts.fetch(:max_inline_label_width,
-        DEFAULT_MAX_INLINE_LABEL_WIDTH)
       if @block && !@values.empty?
         raise ArgumentError, "arguments and block are mutually exclusive"
       end
+      @location_label = nil
     end
 
     def write
-      if labeled_values.empty? && !label.empty?
+      if values.empty? && !label.empty?
         write_line label.chomp(": ")
       else
-        labeled_values.each do |lines|
-          write_lines lines
-        end
-      end
-    end
-
-    def inspected_values
-      values.map do |value|
-        @inspector.call(value, value_width)
-      end
-    end
-
-    def labeled_values
-      if label_width > @max_inline_label_width
-        outline_labeled_values
-      else
-        inline_labeled_values
-      end
-    end
-
-    def inline_labeled_values
-      labeled_values = inspected_values.map do |lines|
-        lines.map.with_index do |line, i|
-          if i == 0
-            label + line
-          else
-            indent + line
-          end
-        end
-      end
-    end
-
-    def outline_labeled_values
-      inspected_values.map do |lines|
-        [label.rstrip] + lines.map do |line|
-          "  " + line
+        values.each do |value|
+          labeler = Labeler.new(@format, @width, label, value)
+          write_lines labeler.labeled
         end
       end
     end
 
     def with_location(format_key)
-      @location_format = LOCATION_FORMATS.fetch(format_key) {
-        raise ArgumentError, "Unknown location format: #{format_key.inspect}"
-      }
-      @location = Location.find
+      location = Location.find
+      @location_label = LocationLabel.make(format_key, location)
     end
 
     def inspect
-      @inspector = ->(value, value_width) do
-        [value.inspect]
-      end
+      @format = Format::Inspect.new
     end
 
     def pretty_print
-      @inspector = ->(value, value_width) do
-        out = StringIO.new
-        PP.pp(value, out, value_width)
-        out.string.lines
-      end
+      @format = Format::PrettyPrint.new
     end
 
     private
 
-    LOCATION_FORMATS = {
-      filename: "%<filename>s:%<line_number>d: ",
-      path: "%<path>s:%<line_number>d: ",
-    }
-    private_constant :LOCATION_FORMATS
-
-    def value_width
-      @width - label_width
-    end
-
     def values
       if @block
         [@block.call]
@@ -125,27 +74,12 @@ module CutePrint
       @label ||= make_label
     end
 
-    def label_width
-      label.size
-    end
-
-    def indent
-      " " * label_width
-    end
-
     def make_label
       [
-        (@location.format(@location_format) if @location),
-        ("#{block_code} is " if @block),
+        (@location_label.to_s if @location_label),
+        (SourceLabel.new(@block, @method) if @block),
       ].compact.join
     end
 
-    def block_code
-      ruby_parser = RubyParser.from_block(@block)
-      parsed_code = ruby_parser.parse
-      method_call = parsed_code.first_call_to_method(@method)
-      method_call.block.to_ruby
-    end
-
   end
 end

data/lib/cute_print/inline_labeler.rb

@@ -0,0 +1,36 @@
+module CutePrint
+  # @api private
+  class InlineLabeler
+
+    def self.label(formatter, width, label, value)
+      new(formatter, width, label, value).labeled
+    end
+
+    def initialize(formatter, width, label, value)
+      @formatter = formatter
+      @width = width
+      @label = label
+      @value = value
+    end
+
+    def labeled
+      [@label.rstrip + "\n"] + indented_lines
+    end
+
+    private
+
+    INDENT = '  '
+    private_constant :INDENT
+
+    def indented_lines
+      lines.map do |line|
+        INDENT + line
+      end
+    end
+
+    def lines
+      @formatter.format(@width - INDENT.size, @value)
+    end
+
+  end
+end

data/lib/cute_print/labeler.rb

@@ -0,0 +1,71 @@
+require_relative "inline_labeler"
+require_relative "outline_labeler"
+
+module CutePrint
+  # @api private
+  class Labeler
+
+    def self.label(format, width, label, value)
+      new(format, width, label, value).labeled
+    end
+
+    def initialize(format, width, label, value)
+      @format = format
+      @width = width
+      @label = label
+      @value = value
+    end
+
+    def labeled
+      # Optimization: Avoid the computation of "outlined", and the
+      # elaborate comparison, in many cases.
+      return outlined if outlined_fits_on_one_line?
+      inlined_fits = lines_fit_horizontally?(inlined)
+      outlined_fits = lines_fit_horizontally?(outlined)
+      if inlined_fits && outlined_fits
+        [inlined, outlined].min_by do |lines|
+          [
+            lines.size,
+            lines.equal?(outlined) ? 0 : 1,
+          ]
+        end
+      elsif inlined_fits && !outlined_fits
+        inlined
+      elsif !inlined_fits && outlined_fits
+        outlined
+      else # neither fits
+        [inlined, outlined].min_by do |lines|
+          [
+            lines.map(&:size).min,
+            lines.size,
+          ]
+        end
+      end
+    end
+
+    private
+
+    def lines_fit_horizontally?(lines)
+      lines.all? do |line|
+        line_fits_horizontally?(line)
+      end
+    end
+
+    def line_fits_horizontally?(line)
+      line.chomp.size <= @width
+    end
+
+    def outlined_fits_on_one_line?
+      outlined.size == 1 && line_fits_horizontally?(outlined.first)
+    end
+
+    def outlined
+      @outlined ||= OutlineLabeler.label(@format, @width, @label, @value)
+    end
+
+    def inlined
+      @inlined ||= InlineLabeler.label(@format, @width, @label, @value)
+    end
+    
+  end
+end

data/lib/cute_print/location.rb

@@ -1,6 +1,7 @@
 require_relative "finds_foreign_caller"
 
 module CutePrint
+  # @api private
   class Location
 
     extend FindsForeignCaller
@@ -11,21 +12,14 @@ module CutePrint
       new(path, line_number)
     end
 
+    attr_reader :path
+    attr_reader :line_number
+
     def initialize(path, line_number)
       @path = path
       @line_number = line_number
     end
 
-    def format(template)
-      template % {
-        path: @path,
-        filename: filename,
-        line_number: @line_number,
-      }
-    end
-
-    private
-
     def filename
       File.basename(@path)
     end

data/lib/cute_print/location_label/filename.rb

@@ -0,0 +1,19 @@
+module CutePrint
+  class LocationLabel
+    # @api private
+    class Filename
+
+      def initialize(location)
+        @location = location
+      end
+
+      def to_s
+        "%s:%d: " % [
+          @location.filename,
+          @location.line_number,
+        ]
+      end
+
+    end
+  end
+end

data/lib/cute_print/location_label/path.rb

@@ -0,0 +1,19 @@
+module CutePrint
+  class LocationLabel
+    # @api private
+    class Path
+
+      def initialize(location)
+        @location = location
+      end
+
+      def to_s
+        "%s:%d: " % [
+          @location.path,
+          @location.line_number,
+        ]
+      end
+
+    end
+  end
+end

data/lib/cute_print/location_label.rb

@@ -0,0 +1,23 @@
+require_relative "location_label/filename"
+require_relative "location_label/path"
+
+module CutePrint
+  # @api private
+  class LocationLabel
+
+    FORMATS = {
+      filename: Filename,
+      path: Path,
+    }
+    private_constant :FORMATS
+
+    def self.make(format, location)
+      klass = FORMATS[format]
+      unless klass
+        raise ArgumentError, "Unknown location format: #{format.inspect}"
+      end
+      klass.new(location)
+    end
+
+  end
+end

data/lib/cute_print/mixin.rb

@@ -1,4 +1,3 @@
-require_relative "default_printer"
 require_relative "printer"
 
 module CutePrint
@@ -9,24 +8,24 @@ module CutePrint
   #   the module itself is not.
   module Mixin
 
-    # @see Printer#q
+    # @see CutePrint#q
     def q(*args, &block)
-      CutePrint::DefaultPrinter.printer.q(*args, &block)
+      CutePrint.q(*args, &block)
     end
 
-    # @see Printer#ql
+    # @see CutePrint#ql
     def ql(*args, &block)
-      CutePrint::DefaultPrinter.printer.ql(*args, &block)
+      CutePrint.ql(*args, &block)
     end
 
-    # @see Printer#qq
+    # @see CutePrint#qq
     def qq(*args, &block)
-      CutePrint::DefaultPrinter.printer.qq(*args, &block)
+      CutePrint.qq(*args, &block)
     end
 
-    # @see Printer#qql
+    # @see CutePrint#qql
     def qql(*args, &block)
-      CutePrint::DefaultPrinter.printer.qql(*args, &block)
+      CutePrint.qql(*args, &block)
     end
 
     # Debug a call chain by printing self and then returning self.
@@ -36,7 +35,7 @@ module CutePrint
       self
     end
 
-    # Debug a call chain by printing self, with source position, and
+    # Debug a call chain by printing self, with source location, and
     # then returning self.
     # @return [Object] self
     def tapql
@@ -46,13 +45,15 @@ module CutePrint
 
     # Debug a call chain by pretty-printing self and then returning
     # self.
+    # @return [Object] self
     def tapqq
       qq self
       self
     end
 
-    # Debug a call chain by printing the source location,
-    # pretty-printing self, and then returning self.
+    # Debug a call chain by pretty-printing self, with source
+    # location, and then returning self.
+    # @return [Object] self
     def tapqql
       qql self
       self

data/lib/cute_print/outline_labeler.rb

@@ -0,0 +1,38 @@
+module CutePrint
+  # @api private
+  class OutlineLabeler
+
+    def self.label(formatter, width, label, value)
+      new(formatter, width, label, value).labeled
+    end
+
+    def initialize(formatter, width, label, value)
+      @formatter = formatter
+      @width = width
+      @label = label
+      @value = value
+    end
+
+    def labeled
+      [labeled_first_line] + indented_remaining_lines
+    end
+
+    private
+
+    def labeled_first_line
+      @label + lines.first
+    end
+
+    def indented_remaining_lines
+      indent = ' ' * @label.size
+      lines.to_a[1..-1].map do |line|
+        indent + line
+      end
+    end
+
+    def lines
+      @lines ||= @formatter.format(@width - @label.size, @value)
+    end
+
+  end
+end

data/lib/cute_print/printer.rb

@@ -36,15 +36,7 @@ module CutePrint
       @location_format = :filename
     end
 
-    # Inspect and write one or more objects.
-    #
-    # If called without a block, prints the inspected arguments, one
-    # on a line.
-    #
-    # If called with a block, prints the source code of the block and
-    # the inspected result of the block.
-    #
-    # @return nil
+    # @see CutePrint.q
     def q(*values, &block)
       formatter = Formatter.new(
         method: __method__,
@@ -57,15 +49,7 @@ module CutePrint
       nil
     end
 
-    # Inspect and write one or more objects, with source location.
-    #
-    # If called without a block, prints the inspected arguments, one
-    # on a line.
-    #
-    # If called with a block, prints the source code of the block and
-    # the inspected result of the block.
-    #
-    # @return nil
+    # @see CutePrint.ql
     def ql(*values, &block)
       formatter = Formatter.new(
         method: __method__,
@@ -78,15 +62,7 @@ module CutePrint
       nil
     end
 
-    # Pretty-print and write one or more objects.
-    #
-    # If called without a block, pretty-prints the pretty-printed
-    # arguments, one on a line.
-    #
-    # If called with a block, prints the source code of the block and
-    # pretty-prints the result of the block.
-    #
-    # @return nil
+    # @see CutePrint.qq
     def qq(*values, &block)
       formatter = Formatter.new(
         method: __method__,
@@ -98,15 +74,7 @@ module CutePrint
       nil
     end
 
-    # Pretty-print and write one or more objects, with source location.
-    #
-    # If called without a block, pretty-prints the arguments, one on a
-    # line.
-    #
-    # If called with a block, prints the source code of the block and
-    # pretty-prints the result of the block.
-    #
-    # @return nil
+    # @see CutePrint.qql
     def qql(*values, &block)
       formatter = Formatter.new(
         method: __method__,

data/lib/cute_print/source_label.rb

@@ -0,0 +1,26 @@
+require_relative "ruby_parser"
+
+module CutePrint
+  # @api private
+  class SourceLabel
+
+    def initialize(block, method)
+      @block = block
+      @method = method
+    end
+
+    def to_s
+      "#{block_code} is "
+    end
+
+    private
+
+    def block_code
+      ruby_parser = RubyParser.from_block(@block)
+      parsed_code = ruby_parser.parse
+      method_call = parsed_code.first_call_to_method(@method)
+      method_call.block.to_ruby
+    end
+
+  end
+end

data/lib/cute_print.rb

@@ -1,26 +1,2 @@
-require_relative "cute_print/configure"
+require_relative "cute_print/core"
 require_relative "cute_print/core_ext"
-require_relative "cute_print/default_printer"
-
-# Like Kernel#p, only fancier.  For example, this code:
-#
-#     require 'cute_print'
-#     q { 1 + 2 }
-#
-# prints this to $stderr:
-#
-#     (1 + 2) is 3
-module CutePrint
-
-  # Configure the library.  For example:
-  #
-  #     CutePrint.configure do |c|
-  #       c.out = $stdout
-  #     end
-  #
-  # @yieldparam config [Configure]
-  def self.configure(&block)
-    Configure.new(DefaultPrinter.printer, &block)
-  end
-
-end

data/spec/format/inspect_spec.rb

@@ -0,0 +1,20 @@
+require_relative "../spec_helper"
+
+require "cute_print/format/inspect"
+
+module CutePrint
+  module Format
+    describe Inspect do
+
+      let(:width) { 80 }
+      let(:value) { (1..5).to_a }
+      subject { Inspect.new.format(width, value) }
+      specify do
+        expect(subject).to eq [
+          "[1, 2, 3, 4, 5]\n",
+        ]
+      end
+
+    end
+  end
+end

data/spec/format/pretty_print_spec.rb

@@ -0,0 +1,36 @@
+require_relative "../spec_helper"
+
+require "cute_print/format/pretty_print"
+
+module CutePrint
+  module Format
+    describe PrettyPrint do
+
+      let(:value) { (1..5).to_a }
+      subject { PrettyPrint.new.format(width, value).to_a }
+
+      context "fits on one line" do
+        let(:width) { 80 }
+        specify do
+          expect(subject).to eq [
+            "[1, 2, 3, 4, 5]\n",
+          ]
+        end
+      end
+
+      context "needs multiple lines" do
+        let(:width) { 5 }
+        specify do
+          expect(subject).to eq [
+            "[1,\n",
+            " 2,\n",
+            " 3,\n",
+            " 4,\n",
+            " 5]\n",
+          ]
+        end
+      end
+
+    end
+  end
+end

data/spec/inline_labeler_spec.rb

@@ -0,0 +1,39 @@
+require_relative "spec_helper"
+
+require "cute_print/inline_labeler"
+
+module CutePrint
+  describe InlineLabeler do
+
+    let(:label) { "foo.rb:1: " }
+    let(:value) { [1, 2, 3, 4, 5] }
+    subject { InlineLabeler.label(formatter, width, label, value) }
+
+    context "single line" do
+      let(:formatter) { Format::Inspect.new }
+      let(:width) { 80 }
+      specify do
+        expect(subject).to eq [
+          "foo.rb:1:\n",
+          "  [1, 2, 3, 4, 5]\n",
+        ]
+      end
+    end
+
+    context "multiple lines" do
+      let(:formatter) { Format::PrettyPrint.new }
+      let(:width) { 4 }
+      specify do
+        expect(subject).to eq [
+          "foo.rb:1:\n",
+          "  [1,\n",
+          "   2,\n",
+          "   3,\n",
+          "   4,\n",
+          "   5]\n",
+        ]
+      end
+    end
+
+  end
+end