cute_print 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 3c81ac7440cf8ecc4b2e2957630e8a8d103f1091
-  data.tar.gz: 04d54e1adfc14c9ca499d2f267a1600c64962c9d
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NzAxMjU2ZDA2ZjFlYjJmOThhOWZkYTlhZjMxNzVlYjI4ZGY2ZTNjMQ==
+  data.tar.gz: !binary |-
+    ODA2ZGNjNTQ0M2EzMTBlYmEyMTg2M2ZhZTg4NzEzOWM4MmE4Zjk5Nw==
 SHA512:
-  metadata.gz: b8f5c915635c2e033d36af1bb55eea49b478e76e97e27993173e29055ae18f0084cc083cdeea0c188e148129f1b272b1ca119e1b5d941f6fae9ac8e8c1f02599
-  data.tar.gz: eb6cdda8838c7261337e4c76a9549729fb7174fc20f6c882ddb459ffb2a5086e6a6ccc64202047fe2d661eb408cdc27d581c4870d292e2d7fe16c3af97e82bf7
+  metadata.gz: !binary |-
+    N2U5OGFkZTMwZDFiNTNhNjRlNjA3NTliNzM1OWFmMjg0ZGViZWRmZDE1MWE0
+    YzJiNjhmZmM2NDMzZWVkNWY1NzU2ZmVhODRiNzA2NWVlY2NmMzM5MjIyOTY0
+    NzBmMWFlYzRjZTRlOTgyYjRkMmMxMmM0ZmE3NTMzZmE0MjM3Mzc=
+  data.tar.gz: !binary |-
+    ZmU3NjFhOGNhODVkN2EwMWYwZDFhY2FlZDBiNzQwYjA3MDQxN2FiZjUwMGIy
+    ZWIzM2MzN2YxMzdlMGM4NTY5NWRhNWZjYjNlNjQwZjNlMjdjYzFhODAwNzA2
+    N2JlNGVjYTNhMDMyMDk2YWZjOWI1YzcwNWJmYjgzNDk5ZThkNGY=

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+- 1.9.3
+- 2.0
+- 2.1

data/.yardopts

@@ -4,3 +4,4 @@
 lib/**/*.rb
 -
 LICENSE
+CHANGELOG.md

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+### Development
+
+Breaking changes:
+
+* Configure.position_format removed
+* Added Configure.location_format, which takes either :filename or
+  :path
+
+Enhancements:
+
+* Kernel#ql with no arguments prints source location
+* Added Kernel#qq (pretty-print)
+* Added Kernel#qql (pretty-print with source location)
+
+### 0.1.0 / 2014-09-04
+
+Initial release

data/README.md

@@ -1,13 +1,21 @@
 # cute_print
+[![Gem Version](https://badge.fury.io/rb/cute_print.png)](http://badge.fury.io/rb/cute_print)
+[![Dependency Status](https://gemnasium.com/wconrad/cute_print.svg)](https://gemnasium.com/wconrad/cute_print)
+[![Build Status](https://travis-ci.org/wconrad/cute_print.png)](https://travis-ci.org/wconrad/cute_print)
+[![Code Climate](https://codeclimate.com/github/wconrad/cute_print.png)](https://codeclimate.com/github/wconrad/cute_print)
 
-Write debug output to the console, with flair.  Features:
+Write debug output to stderr.  Optionally print the source filename
+and line number, or the source of the debug statement.  Easily debug
+the middle of a call chain.
 
-* Inspects its output, like Kernel#p
-* Writes to $stderr by default (good when $stdout is redirected)
-* Can print the filename and line number
-* Can print the source of the value
-* Can print a value in the middle of a call chain
-* Configurable output device
+## Features
+
+* Inspects its output, like Kernel#p.
+* Writes to $stderr by default (good when $stdout is redirected).
+* Can print the filename and line number.
+* Can print the source of the value.
+* Can print a value in the middle of a call chain.
+* Configurable output device.
 
 This is for those who prefer to debug by writing things to the
 console.
@@ -43,11 +51,15 @@ You can have the debug source printed along with the value:
     i = 1
     q {i + 2}         # i + 2 is 3
 
-Kernel#ql will add the source position:
+Kernel#ql will add the source location:
 
     ql "abc"        # foo.rb:12: "abc"
     ql {1 + 2}      # foo.rb:13: 1 + 2 is 3
 
+When called with no arguments, #ql just prints the source location:
+
+    ql              # foo.rb:14
+
 Call chains can be a pain to debug, but it's easy with Kernel#tapq and
 Kernel#tapql:
 
@@ -59,14 +71,15 @@ Kernel#tapql:
 
 ## Documentation
 
-[Full documentation (relishapp)][2]
+There's more.  Please see the [Full documentation][2] (relishapp).
 
 ## Rubies supported
 
 This gem is known to work with these Rubies:
 
-* ruby-1.9.3
-* ruby-2.1.2
+* ruby-1.9.3-p547
+* ruby-2.0.0-p481
+* ruby-2.1.2p95
 
 ## Platforms supported
 
@@ -82,9 +95,15 @@ statement's source is derived from the _wrong_ gem.
 
 Differences between the _wrong_ gem and this gem:
 
+* This gem can print the source location
+* This gem writes to $stderr
+* This gem's output is configurable
+* This gem requires Ruby >= 1.9
+* This gem debugs call chains
 * The _wrong_ gem supports color output
-* The _wrong_ gem writes only to stdout
+* The _wrong_ gem writes to stdout
 * The _wrong_ gem supports Ruby 1.8
+* The _wrong_ gem has assertions and more
 
 ## Versioning
 
@@ -105,5 +124,5 @@ version, e.g.:
 5. Create new Pull Request
 
 [1]: http://rubygems.org/gems/wrong
-[2]: https://www.relishapp.com/wconrad/cute-print/docs
+[2]: https://www.relishapp.com/wconrad/cute-print/v/0-2-0/docs
 [3]: http://semver.org/spec/v2.0.0.html

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/cute_print.gemspec

@@ -2,17 +2,17 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: cute_print 0.1.0 ruby lib
+# stub: cute_print 0.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "cute_print"
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Wayne Conrad"]
-  s.date = "2014-09-02"
-  s.description = "Write debug output to the console, with flair.  Features:  * Inspects its output, like Kernel#p * Writes to $stderr by default (good when $stdout is redirected) * Can print the filename and line number * Can print the source of the value * Can print a value in the middle of a call chain * Configurable output device  This is for those who prefer to debug by writing things to the console."
+  s.date = "2014-09-05"
+  s.description = "Write debug output to stderr.  Optionally print the source filename and line number, or the source of the debug statement.  Easily debug the middle of a call chain."
   s.email = "wconrad@yagni.com"
   s.extra_rdoc_files = [
     "LICENSE",
@@ -21,25 +21,29 @@ Gem::Specification.new do |s|
   s.files = [
     ".config/cucumber.yml",
     ".rspec",
+    ".travis.yml",
     ".yardopts",
+    "CHANGELOG.md",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE",
     "README.md",
     "Rakefile",
     "VERSION",
-    "basic101.gemspec",
     "cute_print.gemspec",
     "features/.nav",
+    "features/call_chain.feature",
     "features/configuring/configure_output.feature",
     "features/configuring/configure_position_format.feature",
     "features/configuring/readme.md",
     "features/configuring/reset_configuration.feature",
-    "features/inspect_call_chain.feature",
-    "features/inspect_objects/inspect.feature",
-    "features/inspect_objects/label_and_inspect.feature",
-    "features/inspect_objects/print_source_location.feature",
-    "features/inspect_objects/readme.md",
+    "features/inspect/inspect.feature",
+    "features/inspect/inspect_with_location.feature",
+    "features/inspect/inspect_with_source.feature",
+    "features/inspect/readme.md",
+    "features/pretty_print/pretty_print.feature",
+    "features/pretty_print/pretty_print_with_location.feature",
+    "features/pretty_print/pretty_print_with_source.feature",
     "features/readme.md",
     "features/support/env.rb",
     "features/support/helpers/example.rb",
@@ -51,6 +55,8 @@ Gem::Specification.new do |s|
     "lib/cute_print/core_ext/object.rb",
     "lib/cute_print/default_printer.rb",
     "lib/cute_print/finds_foreign_caller.rb",
+    "lib/cute_print/formatter.rb",
+    "lib/cute_print/location.rb",
     "lib/cute_print/mixin.rb",
     "lib/cute_print/printer.rb",
     "lib/cute_print/ruby_generator.rb",

data/features/.nav

@@ -1,6 +1,10 @@
-- inspect_objects:
+- inspect:
   - inspect.feature
-  - label_and_inspect.feature
-  - print_source_location.feature
-- inspect_call_chain.feature
+  - inspect_with_source.feature
+  - inspect_with_location.feature
+- pretty_print:
+  - pretty_print.feature
+  - pretty_print_with_source.feature
+  - pretty_print_with_location.feature
+- call_chain.feature
 - configuring:

data/features/configuring/configure_position_format.feature

@@ -1,30 +1,40 @@
-Feature: Configure position format
+Feature: Configure location format
 
   You can change the format which Kernel#ql uses to print the source
-  position.  String#% is called on the string you supply, with
-  a hash argument having these keys:
+  location.  By default, just the filename is printed, but you can
+  cause the full path. to be printed instead.
 
-  * :path
-  * :filename
-  * :line_number
+  Scenario: Write full path
+    Given a file named "example.rb" with:
+      """
+      require "cute_print"
+
+      CutePrint.configure do |c|
+        c.location_format = :path
+      end
 
-  The default position format is:
+      ql 123
+      """
+    Then stderr should be
+    """
+    /tmp/.../example.rb:7:
+      123
 
-      "%<filename>s:%<line_number>d: "
+    """
 
-  Scenario: Write full path
+  Scenario: Write filename
     Given a file named "example.rb" with:
       """
       require "cute_print"
 
       CutePrint.configure do |c|
-        c.position_format = "%<path>s:%<line_number>d: "
+        c.location_format = :filename
       end
 
       ql 123
       """
     Then stderr should be
     """
-    /tmp/.../example.rb:7: 123
+    example.rb:7: 123
 
-    """
+    """

data/features/configuring/reset_configuration.feature

@@ -7,10 +7,7 @@ Feature: Reset configuration
       """
       require "cute_print"
 
-      CutePrint.configure do |c|
-        c.out = $stdout
-      end
-
+      CutePrint.configure { |c| c.out = $stdout }
       q "abc"
       CutePrint.configure { |c| c.reset }
       q 123

data/features/{inspect_objects → inspect}/inspect.feature

@@ -1,4 +1,4 @@
-Feature: Inspect an object
+Feature: Inspect
 
   Kernel#q inspects its arguments and prints them, one per line.  This
   is just like Kernel#p, except that it writes to $stderr by default.

data/features/{inspect_objects/print_source_location.feature → inspect/inspect_with_location.feature}

@@ -1,7 +1,8 @@
-Feature: Print the source location
+Feature: Inspect with source location
 
-  Kernel#ql works just like Kernel#q, except that it also prints the
-  source location
+  Kernel#ql works just like Kernel#pp from the built-in pp library,
+  except that it writes to $stderr, _and_ it prints the source
+  location.
 
   Scenario: Inspect an object
     Given a file named "example.rb" with:
@@ -28,7 +29,7 @@ Feature: Print the source location
 
       """
 
-  Scenario: Label and inspect and object
+  Scenario: Inspect with location
     Given a file named "example.rb" with:
       """
       require "cute_print"
@@ -39,3 +40,15 @@ Feature: Print the source location
       example.rb:2: (1 + 2) is 3
 
       """
+
+  Scenario: Just print the location
+    Given a file named "example.rb" with:
+      """
+      require "cute_print"
+      ql
+      """
+    Then stderr should be
+      """
+      example.rb:2
+
+      """

data/features/{inspect_objects/label_and_inspect.feature → inspect/inspect_with_source.feature}

@@ -1,9 +1,9 @@
-Feature: Label and inspect an object
+Feature: Inspect with source
 
   Kernel#q, if given a block, prints the source for the block and then
   the inspected result of running the block.
 
-  Scenario: Label and inspect and object
+  Scenario: Label and inspect an object
     Given a file with:
       """
       require "cute_print"

data/features/pretty_print/pretty_print.feature

@@ -0,0 +1,41 @@
+Feature: Pretty-print
+
+  Kernel#qq pretty-prints its arguments and prints them, one per line.  This
+  is just like Kernel#pp from the pp library, except that it writes to $stderr
+  by default.
+
+  Scenario: One argument
+    Given a file with:
+      """
+      require "cute_print"
+      a = [
+        "Once upon a time there were four little Rabbits, and their names were",
+        "Flopsy,",
+        "Mopsy,",
+        "Cotton-tail, and",
+        "Peter.",
+      ]
+      qq a
+      """
+    Then stderr should be
+      """
+      ["Once upon a time there were four little Rabbits, and their names were",
+       "Flopsy,",
+       "Mopsy,",
+       "Cotton-tail, and",
+       "Peter."]
+ 
+      """
+
+  Scenario: Two arguments
+    Given a file with:
+      """
+      require "cute_print"
+      qq 1, "foo"
+      """
+    Then stderr should be
+      """
+      1
+      "foo"
+
+      """

data/features/pretty_print/pretty_print_with_location.feature

@@ -0,0 +1,73 @@
+Feature: Pretty-print with source location
+
+  Kernel#qql works just like Kernel#pp from the built-in pp library,
+  except that it writes to $stderr _and_ it labels the output with
+  the source location.
+
+  If the filename is long, then the source location is printed on a
+  line of its own.
+
+  Scenario: One argument
+    Given a file named "example.rb" with:
+      """
+      require "cute_print"
+      a = [
+        "Once upon a time there were four little Rabbits, ",
+        "and their names were",
+        "Flopsy,",
+        "Mopsy,",
+        "Cotton-tail, and",
+        "Peter.",
+      ]
+      qql a
+      """
+    Then stderr should be
+      """
+      example.rb:10: ["Once upon a time there were four little Rabbits, ",
+                      "and their names were",
+                      "Flopsy,",
+                      "Mopsy,",
+                      "Cotton-tail, and",
+                      "Peter."]
+ 
+      """
+
+  Scenario: Two arguments
+    Given a file named "example.rb" with:
+      """
+      require "cute_print"
+      qql 1, "foo"
+      """
+    Then stderr should be
+      """
+      example.rb:2: 1
+      example.rb:2: "foo"
+
+      """
+
+  Scenario: Very long label
+
+    Given a file named "long____________________________filename.rb" with:
+      """
+      require "cute_print"
+      a = [
+        "Once upon a time there were four little Rabbits, ",
+        "and their names were",
+        "Flopsy,",
+        "Mopsy,",
+        "Cotton-tail, and",
+        "Peter.",
+      ]
+      qql a
+      """
+    Then stderr should be
+      """
+      long____________________________filename.rb:10:
+        ["Once upon a time there were four little Rabbits, ",
+         "and their names were",
+         "Flopsy,",
+         "Mopsy,",
+         "Cotton-tail, and",
+         "Peter."]
+ 
+      """

data/features/pretty_print/pretty_print_with_source.feature

@@ -0,0 +1,27 @@
+Feature: Pretty-print with source
+
+  Kernel#pp, if given a block, prints the source for the block and then
+  the pretty-printed result of running the block.
+
+  Scenario: Label and pretty-print an object
+    Given a file with:
+      """
+      require "cute_print"
+      a = [
+        "Once upon a time there were four little Rabbits, and their names were",
+        "Flopsy,",
+        "Mopsy,",
+        "Cotton-tail, and",
+        "Peter.",
+      ]
+      qq {a}
+      """
+    Then stderr should be
+      """
+      a is ["Once upon a time there were four little Rabbits, and their names were",
+            "Flopsy,",
+            "Mopsy,",
+            "Cotton-tail, and",
+            "Peter."]
+ 
+      """

data/lib/cute_print/configure.rb

@@ -22,10 +22,10 @@ module CutePrint
       def_delegator :@printer, "#{name}="
     end
 
-    # @!attribute [rw] position_format
-    #   @return [String] The position format
-    #   @see Printer#position_format
-    delegate_accessor :position_format
+    # @!attribute [rw] location_format
+    #   @return [String] The location format
+    #   @see Printer#location_format
+    delegate_accessor :location_format
 
     # @!attribute [rw] out
     #   @return [#puts] The file to write to

data/lib/cute_print/finds_foreign_caller.rb

@@ -3,6 +3,8 @@ module CutePrint
   # @api private
   module FindsForeignCaller
 
+    extend self
+
     def nearest_foreign_caller
       caller.find do |s|
         path = s.split(":").first
@@ -11,7 +13,7 @@ module CutePrint
     end
 
     def lib_path
-      File.dirname(__FILE__)
+      File.join(File.dirname(__FILE__), '..')
     end
 
   end

data/lib/cute_print/formatter.rb

@@ -0,0 +1,150 @@
+require "pp"
+require "stringio"
+
+require_relative "location"
+require_relative "ruby_parser"
+
+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
+    end
+
+    def write
+      if labeled_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
+        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
+    end
+
+    def inspect
+      @inspector = ->(value, value_width) do
+        [value.inspect]
+      end
+    end
+
+    def pretty_print
+      @inspector = ->(value, value_width) do
+        out = StringIO.new
+        PP.pp(value, out, value_width)
+        out.string.lines
+      end
+    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]
+      else
+        @values
+      end
+    end
+
+    def write_lines(lines)
+      lines.each do |line|
+        write_line line
+      end
+    end
+
+    def write_line(line)
+      @out.puts line
+    end
+
+    def label
+      @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),
+      ].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/location.rb

@@ -0,0 +1,34 @@
+require_relative "finds_foreign_caller"
+
+module CutePrint
+  class Location
+
+    extend FindsForeignCaller
+
+    def self.find
+      path, line_number = nearest_foreign_caller.split(':')
+      line_number = line_number.to_i
+      new(path, line_number)
+    end
+
+    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
+
+  end
+end

data/lib/cute_print/mixin.rb

@@ -7,7 +7,6 @@ module CutePrint
   #
   # @note The methods in this module are part of the public API, but
   #   the module itself is not.
-
   module Mixin
 
     # @see Printer#q
@@ -25,6 +24,11 @@ module CutePrint
       CutePrint::DefaultPrinter.printer.qq(*args, &block)
     end
 
+    # @see Printer#qql
+    def qql(*args, &block)
+      CutePrint::DefaultPrinter.printer.qql(*args, &block)
+    end
+
     # Debug a call chain by printing self and then returning self.
     # @return [Object] self
     def tapq

data/lib/cute_print/printer.rb

@@ -1,5 +1,4 @@
-require_relative "finds_foreign_caller"
-require_relative "ruby_parser"
+require_relative "formatter"
 require_relative "stderr_out"
 
 module CutePrint
@@ -7,23 +6,18 @@ module CutePrint
 
     include FindsForeignCaller
 
-    DEFAULT_POSITION_FORMAT = "%<filename>s:%<line_number>d: "
-
     # The object to write to.  Defaults to $stderr.
     # @return [#puts]
     attr_accessor :out
 
-    # The position format.  To format a position, String#% is called
-    # with a hash having these keys:
+    # The location format.
     #
-    # * :path
+    # One of:
     # * :filename
-    # * :line_number
+    # * :path
     #
-    # The default format prints the filename and line number.
-    # @see Printer::DEFAULT_POSITION_FORMAT
     # @return [String]
-    attr_accessor :position_format
+    attr_accessor :location_format
 
     # Create an instance.  If attributes are supplied, they override
     # the defaults.  For example:
@@ -39,7 +33,7 @@ module CutePrint
     # Set all attributes to their defaults.
     def set_defaults
       @out = StderrOut.new
-      @position_format = DEFAULT_POSITION_FORMAT
+      @location_format = :filename
     end
 
     # Inspect and write one or more objects.
@@ -50,12 +44,17 @@ module CutePrint
     # If called with a block, prints the source code of the block and
     # the inspected result of the block.
     def q(*values, &block)
-      print(__method__, values, block) do |line|
-        @out.puts line
-      end
+      formatter = Formatter.new(
+        method: __method__,
+        out: @out,
+        block: block,
+        values: values
+      )
+      formatter.inspect
+      formatter.write
     end
 
-    # Inspect and write one or more objects, with source position.
+    # Inspect and write one or more objects, with source location.
     #
     # If called without a block, prints the inspected arguments, one
     # on a line.
@@ -63,44 +62,52 @@ module CutePrint
     # If called with a block, prints the source code of the block and
     # the inspected result of the block.
     def ql(*values, &block)
-      path, line_number = nearest_foreign_caller.split(":")
-      line_number = line_number.to_i
-      print(__method__, values, block) do |line|
-        position = format_position(path, line_number)
-        @out.puts "#{position}#{line}"
-      end
+      formatter = Formatter.new(
+        method: __method__,
+        out: @out,
+        block: block,
+        values: values)
+      formatter.inspect
+      formatter.with_location @location_format
+      formatter.write
     end
 
-    private
-
-    def print(method, values, block)
-      if block && !values.empty?
-        raise ArgumentError, "arguments and block are mutually exclusive"
-      end
-      if block
-        ruby_parser = RubyParser.from_block(block)
-        parsed_code = ruby_parser.parse
-        method_call = parsed_code.first_call_to_method(method)
-        block_code = method_call.block.to_ruby
-        yield "%s is %s" % [
-          block_code,
-          block.call.inspect,
-        ]
-      else
-        values.each do |value|
-          yield value.inspect
-        end
-      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.
+    def qq(*values, &block)
+      formatter = Formatter.new(
+        method: __method__,
+        out: @out,
+        block: block,
+        values: values)
+      formatter.pretty_print
+      formatter.write
     end
 
-    def format_position(path, line_number)
-      position_values = {
-        path: path,
-        filename: File.basename(path),
-        line_number: line_number,
-      }
-      @position_format % position_values
+    # Pretty-print and write one or more objects, with source location.
+    #
+    # 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.
+    def qql(*values, &block)
+      formatter = Formatter.new(
+        method: __method__,
+        out: @out,
+        block: block,
+        values: values)
+      formatter.pretty_print
+      formatter.with_location @location_format
+      formatter.write
     end
 
+    private
+
   end
 end

data/lib/cute_print/stderr_out.rb

@@ -3,6 +3,7 @@ module CutePrint
   # Writing to an instance of this class, rather than directly to
   # $stderr, allows the tests to capture output by assigning to
   # $stderr.
+  # @api private
   class StderrOut
 
     def puts(*args)

data/spec/cute_print_spec.rb

@@ -53,6 +53,31 @@ describe CutePrint do
     Then { @stderr == "#{@location}: [1, 2]\n" }
   end
 
+  describe "#qq" do
+    Given(:object) do
+      [
+        "Once upon a time there were four little Rabbits, and their names were",
+        "Flopsy,",
+        "Mopsy,",
+        "Cotton-tail, and",
+        "Peter.",
+      ]
+    end
+    Given(:expected_output) do
+      %Q'["Once upon a time there were four little Rabbits, and their names were",\n' +
+        %Q' "Flopsy,",\n' +
+        %Q' "Mopsy,",\n' +
+        %Q' "Cotton-tail, and",\n' +
+        %Q' "Peter."]\n'
+    end
+    When do
+      @stderr = capture_stderr do
+        qq object
+      end
+    end
+    Then { @stderr == expected_output }
+  end
+
   describe 'configure output' do
     Given(:io) { StringIO.new }
     Given do

data/tasks/jeweler.rake

@@ -6,11 +6,21 @@ def readme
   File.read(File.join(File.dirname(__FILE__), '../README.md'))
 end
 
+def remove_badges(s)
+  s.gsub(/^\[![^\n]+\n/, '')
+end
+
+def join_lines(s)
+  s.gsub(/\n/, ' ').strip
+end
+
 def description
   unless (desc = readme[/\A#[^\n]*\n*(.*?)\n*^#/m, 1])
     raise "Failed to extract description from readme"
   end
-  desc.gsub(/\n/, ' ').strip
+  desc = remove_badges(desc)
+  desc = join_lines(desc)
+  desc
 end
 
 Jeweler::Tasks.new do |gem|

metadata

@@ -1,48 +1,46 @@
 --- !ruby/object:Gem::Specification
 name: cute_print
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Wayne Conrad
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-02 00:00:00.000000000 Z
+date: 2014-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.6'
 - !ruby/object:Gem::Dependency
   name: ruby2ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.1'
-description: 'Write debug output to the console, with flair.  Features:  * Inspects
-  its output, like Kernel#p * Writes to $stderr by default (good when $stdout is redirected)
-  * Can print the filename and line number * Can print the source of the value * Can
-  print a value in the middle of a call chain * Configurable output device  This is
-  for those who prefer to debug by writing things to the console.'
+description: Write debug output to stderr.  Optionally print the source filename and
+  line number, or the source of the debug statement.  Easily debug the middle of a
+  call chain.
 email: wconrad@yagni.com
 executables: []
 extensions: []
@@ -50,27 +48,31 @@ extra_rdoc_files:
 - LICENSE
 - README.md
 files:
-- ".config/cucumber.yml"
-- ".rspec"
-- ".yardopts"
+- .config/cucumber.yml
+- .rspec
+- .travis.yml
+- .yardopts
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
 - VERSION
-- basic101.gemspec
 - cute_print.gemspec
 - features/.nav
+- features/call_chain.feature
 - features/configuring/configure_output.feature
 - features/configuring/configure_position_format.feature
 - features/configuring/readme.md
 - features/configuring/reset_configuration.feature
-- features/inspect_call_chain.feature
-- features/inspect_objects/inspect.feature
-- features/inspect_objects/label_and_inspect.feature
-- features/inspect_objects/print_source_location.feature
-- features/inspect_objects/readme.md
+- features/inspect/inspect.feature
+- features/inspect/inspect_with_location.feature
+- features/inspect/inspect_with_source.feature
+- features/inspect/readme.md
+- features/pretty_print/pretty_print.feature
+- features/pretty_print/pretty_print_with_location.feature
+- features/pretty_print/pretty_print_with_source.feature
 - features/readme.md
 - features/support/env.rb
 - features/support/helpers/example.rb
@@ -82,6 +84,8 @@ files:
 - lib/cute_print/core_ext/object.rb
 - lib/cute_print/default_printer.rb
 - lib/cute_print/finds_foreign_caller.rb
+- lib/cute_print/formatter.rb
+- lib/cute_print/location.rb
 - lib/cute_print/mixin.rb
 - lib/cute_print/printer.rb
 - lib/cute_print/ruby_generator.rb
@@ -113,12 +117,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []

data/basic101.gemspec

@@ -1,64 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-# stub: basic101 0.1.0 ruby lib
-
-Gem::Specification.new do |s|
-  s.name = "basic101"
-  s.version = "0.1.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib"]
-  s.authors = ["Wayne Conrad"]
-  s.date = "2014-08-29"
-  s.description = "Write debug output to stderr.  Optionally print the source filename and line number, or the source of the debug statement.  Easily print debug from the middle of call chains.  This is for those who prefer to debug by writing things to the console.  Since it writes to stderr, it's more useful than Kernel#p when working with a program that is run with stdout redirection.  Output goes to $stderr by default, but that's configurable."
-  s.email = "wconrad@yagni.com"
-  s.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.md"
-  ]
-  s.files = [
-    ".document",
-    ".rspec",
-    "Gemfile",
-    "LICENSE.txt",
-    "Rakefile",
-    "VERSION",
-    "lib/cute_print.rb",
-    "spec/cute_print_spec.rb",
-    "spec/spec_helper.rb"
-  ]
-  s.homepage = "http://github.com/wconrad/basic101"
-  s.licenses = ["MIT"]
-  s.rubygems_version = "2.2.2"
-  s.summary = "print debug to stderr, with flair"
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<bundler>, ["~> 1.7"])
-      s.add_development_dependency(%q<jeweler>, ["~> 2.0"])
-      s.add_development_dependency(%q<rake>, ["~> 10.3"])
-      s.add_development_dependency(%q<redcarpet>, ["~> 3.1"])
-      s.add_development_dependency(%q<rspec>, ["~> 3.0"])
-      s.add_development_dependency(%q<yard>, ["~> 0.8.7"])
-    else
-      s.add_dependency(%q<bundler>, ["~> 1.7"])
-      s.add_dependency(%q<jeweler>, ["~> 2.0"])
-      s.add_dependency(%q<rake>, ["~> 10.3"])
-      s.add_dependency(%q<redcarpet>, ["~> 3.1"])
-      s.add_dependency(%q<rspec>, ["~> 3.0"])
-      s.add_dependency(%q<yard>, ["~> 0.8.7"])
-    end
-  else
-    s.add_dependency(%q<bundler>, ["~> 1.7"])
-    s.add_dependency(%q<jeweler>, ["~> 2.0"])
-    s.add_dependency(%q<rake>, ["~> 10.3"])
-    s.add_dependency(%q<redcarpet>, ["~> 3.1"])
-    s.add_dependency(%q<rspec>, ["~> 3.0"])
-    s.add_dependency(%q<yard>, ["~> 0.8.7"])
-  end
-end
-