cute_print 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74ff62c5850c2503e438573080264cf4a70b019a
-  data.tar.gz: 77872c08f0efe90db4a30ec5d2bed7fae48186a4
+  metadata.gz: 38450810673262d8825d6c9e249b8372df8f46a1
+  data.tar.gz: 1a6af72afb22b28d3a940eb7e117457c8dc1b90c
 SHA512:
-  metadata.gz: b98616421885ff3035e7090ff3ab7ea0dc823cfe1dbc51c06e866058ac059da12f2a4e518cb58b2bfca92f9ac2dfc141a3ffbd763a67682d6e3168a9e9ca880d
-  data.tar.gz: e43cef47529e511e49636874265a61249c3bf23cfb0a24e96f5aa87592d8593ef33da858b342d33b13806f4ed294f997fcabd125c65911b7d2732ecfc218d8a1
+  metadata.gz: ac83eb665b16c82b9736eb1d8ff7719ff1590b7a2ed6631d927d59c7a35a4d519e3b5a311065354188e57f8830737baeabadd5acc752a417d25a62435ea0ccc0
+  data.tar.gz: adaa3bc601bcbbd863949801d96f13af40db7017bf546f172550881c9eec14489beda90135ba2ea6e215e4afe4bb94ffe16fb390d773c3a4f0a4ec308a5adf8c

data/CHANGELOG.md

@@ -1,9 +1,18 @@
+### Development
+
+### 0.4.0 2014-10-25
+
+API changes
+
+* Can be used without patching any core Ruby classes (see README)
+* Use fewer output lines when possible while better respecting term width
+
 ### 0.3.0 / 2014-09-27
 
 Breaking changes:
 
 * Configure.out must respond to #print rather than #puts
-# Kernel#q, #qq and #qql return nil
+* Kernel#q, #qq and #qql return nil
 
 Enhancements:
 

data/README.md

@@ -8,6 +8,17 @@ Write debug output to stderr.  Optionally print the source filename
 and line number, or the source of the debug statement.  Easily inspect
 the middle of a call chain.
 
+## Why?
+
+* You want to print debug output very quickly, and remove it just as
+  quickly.
+* You want to easily label the debug output with the source
+  location.
+* You want to easily label the debug output with the debug
+  code itself.
+* You want to easily debug the middle of a call chain.
+* You are debugging a program that is run with stdout redirected.
+
 ## Links
 
 * This is a [rubygem](http://rubygems.org/gems/cute_print)
@@ -15,7 +26,7 @@ the middle of a call chain.
 * Cucumber-driven documentation is on
   [relishapp](https://www.relishapp.com/wconrad/cute-print/v/0-2-0/docs)
 * API docs are at
-  [rubydoc.info](http://rubydoc.info/gems/cute_print/0.2.0/frames)
+  [rubydoc.info](http://rubydoc.info/gems/cute_print)
 
 ## Installation
 
@@ -71,6 +82,15 @@ it even get to that method?"
                     #  20,
                     #  30]
 
+When called with a bock, qq prints the debug source as well:
+
+    a = (1..30).to_a
+    qq {a}          # a is [1,
+                    #       2,
+                    #       ...
+                    #       20,
+                    #       30]
+
 **qql** also prints the source location:
 
     a = (1..30).to_a
@@ -80,6 +100,15 @@ it even get to that method?"
                     #            20,
                     #            30]
 
+When called with a block, qql prints the debug source as well:
+
+    a = (1..30).to_a
+    qq {a}          # foo.rb:12: a is [1,
+                    #                  2,
+                    #                  ...
+                    #                  20,
+                    #                  30]
+
 **tapq** inspects the middle of a call chain:
 
     ["1", "2"].map(&:to_i).tapq.inject(&:+)
@@ -131,6 +160,18 @@ To reset the configuration to its defaults:
       c.reset
     end
 
+## Without modifying Ruby classes
+
+By default, this gem defines many methods on Object, making them
+globally available.  To use this gem without any global methods,
+require "cute_print/core" and then call one of the CutePrint class
+methods:
+
+    require "cute_print/core"
+    CutePrint.q {1 + 2}        # 1 + 2 is 3
+
+The "tap" methods are not available when using CutePrint this way.
+
 ## Rubies supported
 
 This gem is known to work with these Rubies:

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/cute_print.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: cute_print 0.3.0 ruby lib
+# stub: cute_print 0.4.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "cute_print"
-  s.version = "0.3.0"
+  s.version = "0.4.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-27"
+  s.date = "2014-10-26"
   s.description = "Write debug output to stderr.  Optionally print the source filename and line number, or the source of the debug statement.  Easily inspect the middle of a call chain."
   s.email = "wconrad@yagni.com"
   s.extra_rdoc_files = [
@@ -37,6 +37,7 @@ Gem::Specification.new do |s|
     "features/configuring/configure_position_format.feature",
     "features/configuring/readme.md",
     "features/configuring/reset_configuration.feature",
+    "features/inspect/core.feature",
     "features/inspect/inspect.feature",
     "features/inspect/inspect_with_location.feature",
     "features/inspect/inspect_with_source.feature",
@@ -47,18 +48,32 @@ Gem::Specification.new do |s|
     "features/readme.md",
     "features/support/env.rb",
     "features/support/helpers/example.rb",
+    "features/support/helpers/example_runner.rb",
+    "features/support/helpers/fork_example_runner.rb",
+    "features/support/helpers/lib_path.rb",
+    "features/support/helpers/shell_example_runner.rb",
     "features/support/helpers/temp_dir.rb",
     "features/support/step_definitions.rb",
     "lib/cute_print.rb",
     "lib/cute_print/configure.rb",
+    "lib/cute_print/core.rb",
     "lib/cute_print/core_ext.rb",
     "lib/cute_print/core_ext/irb.rb",
     "lib/cute_print/core_ext/object.rb",
-    "lib/cute_print/default_printer.rb",
+    "lib/cute_print/cute_print.rb",
     "lib/cute_print/finds_foreign_caller.rb",
+    "lib/cute_print/format.rb",
+    "lib/cute_print/format/inspect.rb",
+    "lib/cute_print/format/pretty_print.rb",
     "lib/cute_print/formatter.rb",
+    "lib/cute_print/inline_labeler.rb",
+    "lib/cute_print/labeler.rb",
     "lib/cute_print/location.rb",
+    "lib/cute_print/location_label.rb",
+    "lib/cute_print/location_label/filename.rb",
+    "lib/cute_print/location_label/path.rb",
     "lib/cute_print/mixin.rb",
+    "lib/cute_print/outline_labeler.rb",
     "lib/cute_print/printer.rb",
     "lib/cute_print/ruby_generator.rb",
     "lib/cute_print/ruby_parser.rb",
@@ -66,9 +81,15 @@ Gem::Specification.new do |s|
     "lib/cute_print/ruby_parser/method_call.rb",
     "lib/cute_print/ruby_parser/parsed_code.rb",
     "lib/cute_print/ruby_parser/wraps_sexp.rb",
+    "lib/cute_print/source_label.rb",
     "lib/cute_print/stderr_out.rb",
     "spec/cute_print_spec.rb",
+    "spec/format/inspect_spec.rb",
+    "spec/format/pretty_print_spec.rb",
+    "spec/inline_labeler_spec.rb",
     "spec/irb_spec.rb",
+    "spec/labeler_spec.rb",
+    "spec/outline_labeler_spec.rb",
     "spec/printer_spec.rb",
     "spec/spec_helper.rb",
     "spec/support/captures_stderr.rb",

data/features/call_chain.feature

@@ -86,10 +86,11 @@ Feature: Inspect a call chain
       """
     And stderr should be
       """
-      example.rb:9: ["Once upon a time there were four little Rabbits, and their names were",
-                     "Flopsy,",
-                     "Mopsy,",
-                     "Cotton-tail, and",
-                     "Peter."]
+      example.rb:9:
+        ["Once upon a time there were four little Rabbits, and their names were",
+         "Flopsy,",
+         "Mopsy,",
+         "Cotton-tail, and",
+         "Peter."]
  
       """

data/features/configuring/configure_position_format.feature

@@ -17,8 +17,7 @@ Feature: Configure location format
       """
     Then stderr should be
     """
-    /tmp/.../example.rb:7:
-      123
+    /tmp/.../example.rb:7: 123
 
     """
 

data/features/inspect/core.feature

@@ -0,0 +1,18 @@
+Feature: Core functionality
+
+  cute_print, by default, adds a fair number of methods to Object,
+  making them available globally.  You can use cute_print without any
+  changes to Object, by requiring "cute_print/core" instead of
+  "cute_print".
+
+  Scenario: Inspect an object
+    Given a file with:
+      """
+      require "cute_print/core"
+      CutePrint.q "abc"
+      """
+    Then stderr should be
+      """
+      "abc"
+
+      """

data/features/inspect/inspect_with_location.feature

@@ -29,7 +29,7 @@ Feature: Inspect with source location
 
       """
 
-  Scenario: Inspect with location
+  Scenario: Inspect with source
     Given a file named "example.rb" with:
       """
       require "cute_print"

data/features/support/env.rb

@@ -1,9 +1,9 @@
 require "rspec/expectations"
 
 # Instead of letting cucumber load all of the .rb, we configure
-# cucumber to require them (see .config/cucumber.yml).
+# cucumber to require them (in .config/cucumber.yml)
+
 glob = File.join(File.dirname(__FILE__), '**/*.rb')
-ruby_paths = Dir[glob].sort
-ruby_paths.each do |path|
+Dir[glob].sort.each do |path|
   require path
 end

data/features/support/helpers/example.rb

@@ -1,13 +1,8 @@
-require_relative "../../../test_support/captures_stderr.rb"
-require_relative "../../../test_support/captures_stdout.rb"
-
+require_relative "example_runner"
 require_relative "temp_dir"
 
 class Example
 
-  include CapturesStderr
-  include CapturesStdout
-
   def initialize(contents, opts = {})
     @contents = contents
     @filename = opts.fetch(:filename, "example.rb")
@@ -16,21 +11,24 @@ class Example
   end
 
   def run
-    @stdout = capture_stdout do
-      @stderr = capture_stderr do
-        load path
+    ExampleRunner.run(path) do |stdout, stderr, exit_status|
+      @stdout = stdout
+      @stderr = stderr
+      @exit_status = exit_status
+      if @exit_status != 0
+        fail "Failed: #{@stdout}\n#{@stderr}"
       end
     end
   end
 
-  def stderr
-    filter_output(@stderr)
-  end
-
   def stdout
     filter_output(@stdout)
   end
 
+  def stderr
+    filter_output(@stderr)
+  end
+
   private
 
   def create_file

data/features/support/helpers/example_runner.rb

@@ -0,0 +1,24 @@
+require "open3"
+
+require_relative "fork_example_runner"
+require_relative "shell_example_runner"
+
+class ExampleRunner
+
+  def self.run(*args, &block)
+    instance.run(*args, &block)
+  end
+
+  def self.instance
+    @instance ||= make
+  end
+
+  def self.make
+    if ForkExampleRunner.supported?
+      ForkExampleRunner.new
+    else
+      ShellExampleRunner.new
+    end
+  end
+
+end

data/features/support/helpers/fork_example_runner.rb

@@ -0,0 +1,37 @@
+require_relative "../../../test_support/captures_stderr"
+require_relative "../../../test_support/captures_stdout"
+require_relative "lib_path"
+
+require "open3"
+
+# This example runner is relatively fast, but isn't available on all
+# platforms.
+class ForkExampleRunner
+
+  include CapturesStderr
+  include CapturesStdout
+  include LibPath
+
+  def self.supported?
+    Process.respond_to?(:fork)
+  end
+
+  def run(path)
+    stdout_rd, stdout_wr = IO.pipe
+    stderr_rd, stderr_wr = IO.pipe
+    pid = fork do
+      $stdout.reopen stdout_wr
+      $stderr.reopen stderr_wr
+      load path
+      exit! 0
+    end
+    Process.wait(pid)
+    exit_status = $?
+    stdout_wr.close
+    stderr_wr.close
+    stdout = stdout_rd.read
+    stderr = stderr_rd.read
+    yield stdout, stderr, exit_status
+  end
+
+end

data/features/support/helpers/lib_path.rb

@@ -0,0 +1,7 @@
+module LibPath
+
+  def lib_path
+    File.join(File.dirname(__FILE__), '../../../lib')
+  end
+
+end

data/features/support/helpers/shell_example_runner.rb

@@ -0,0 +1,26 @@
+require "open3"
+
+require_relative "lib_path"
+
+# This example runner is relatively slow, but should work on platforms
+# which do not support fork, such as Windows.
+class ShellExampleRunner
+
+  include LibPath
+
+  def run(path)
+    command = [
+      "ruby",
+      "-I", lib_path,
+      path,
+    ]
+    Open3.popen3(*command) do |stdin, stdout, stderr, wait_thr|
+      stdin.close
+      stdout = stdout.read
+      stderr = stderr.read
+      exit_status = wait_thr.value
+      yield stdout, stderr, exit_status
+    end
+  end
+
+end

data/features/support/step_definitions.rb

@@ -1,9 +1,3 @@
-require_relative "../../lib/cute_print"
-
-Before do
-  CutePrint.configure { |c| c.reset }
-end
-
 Given(/^a file with:$/) do |contents|
   @example = Example.new(contents)
   @example.run

data/lib/cute_print/core.rb

@@ -0,0 +1,3 @@
+# Require this file to get everything except the monkey-patches.
+
+require_relative "cute_print"

data/lib/cute_print/core_ext.rb

@@ -1,2 +1,4 @@
+# Load all monkey-patches
+
 require_relative "core_ext/irb"
 require_relative "core_ext/object"

data/lib/cute_print/cute_print.rb

@@ -0,0 +1,83 @@
+require_relative "configure"
+require_relative "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(printer, &block)
+  end
+
+  # @return [Printer] the singleton printer
+  # @api private
+  def self.printer
+    @printer ||= Printer.new
+  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
+  def self.q(*args, &block)
+    printer.q(*args, &block)
+  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
+  def self.ql(*args, &block)
+    printer.ql(*args, &block)
+  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
+  def self.qq(*args, &block)
+    printer.qq(*args, &block)
+  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
+  def self.qql(*args, &block)
+    printer.qql(*args, &block)
+  end
+
+end

data/lib/cute_print/format/inspect.rb

@@ -0,0 +1,12 @@
+module CutePrint
+  module Format
+    # @api private
+    class Inspect
+
+      def format(width, value)
+        [value.inspect + "\n"]
+      end
+
+    end
+  end
+end

data/lib/cute_print/format/pretty_print.rb

@@ -0,0 +1,17 @@
+require 'pp'
+require 'stringio'
+
+module CutePrint
+  module Format
+    # @api private
+    class PrettyPrint
+
+      def format(width, value)
+        out = StringIO.new
+        PP.pp(value, out, width)
+        out.string.lines
+      end
+
+    end
+  end
+end

data/lib/cute_print/format.rb

@@ -0,0 +1,2 @@
+require_relative "format/inspect"
+require_relative "format/pretty_print"