cute_print 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c81ac7440cf8ecc4b2e2957630e8a8d103f1091
+  data.tar.gz: 04d54e1adfc14c9ca499d2f267a1600c64962c9d
+SHA512:
+  metadata.gz: b8f5c915635c2e033d36af1bb55eea49b478e76e97e27993173e29055ae18f0084cc083cdeea0c188e148129f1b272b1ca119e1b5d941f6fae9ac8e8c1f02599
+  data.tar.gz: eb6cdda8838c7261337e4c76a9549729fb7174fc20f6c882ddb459ffb2a5086e6a6ccc64202047fe2d661eb408cdc27d581c4870d292e2d7fe16c3af97e82bf7

data/.config/cucumber.yml

@@ -0,0 +1 @@
+default: --require features/support/env.rb

data/.rspec

@@ -0,0 +1 @@
+--color

data/.yardopts

@@ -0,0 +1,6 @@
+--exclude '[~#]$'
+--markup markdown
+--readme README.md
+lib/**/*.rb
+-
+LICENSE

data/Gemfile

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+
+gem "ruby_parser", "~> 3.6"
+gem "ruby2ruby", "~> 2.1"
+
+group :test do
+  gem "bundler", "~> 1.7"
+  gem "cucumber", "~> 1.3"
+  gem "rake", "~> 10.3"
+  gem "rspec", "~> 3.0"
+  gem "rspec-given", "~> 3.5"
+end
+
+group :develop do
+  gem "jeweler", "~> 2.0"
+  gem "redcarpet", "~> 3.1"
+  gem "yard", "~> 0.8.7"
+end

data/Gemfile.lock

@@ -0,0 +1,99 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    builder (3.2.2)
+    cucumber (1.3.16)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.12)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    gherkin (2.12.2)
+      multi_json (~> 1.3)
+    git (1.2.8)
+    github_api (0.12.1)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.2)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.3)
+      oauth2
+    given_core (3.5.4)
+      sorcerer (>= 0.3.7)
+    hashie (3.3.1)
+    highline (1.6.21)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (1.0.0)
+    mini_portile (0.6.0)
+    multi_json (1.10.1)
+    multi_test (0.1.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.3.1)
+      mini_portile (= 0.6.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.3.2)
+    rdoc (4.1.1)
+      json (~> 1.4)
+    redcarpet (3.1.2)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-given (3.5.4)
+      given_core (= 3.5.4)
+      rspec (>= 2.12)
+    rspec-mocks (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.4)
+    ruby2ruby (2.1.2)
+      ruby_parser (~> 3.1)
+      sexp_processor (~> 4.0)
+    ruby_parser (3.6.2)
+      sexp_processor (~> 4.1)
+    sexp_processor (4.4.4)
+    sorcerer (1.0.2)
+    thread_safe (0.3.4)
+    yard (0.8.7.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  cucumber (~> 1.3)
+  jeweler (~> 2.0)
+  rake (~> 10.3)
+  redcarpet (~> 3.1)
+  rspec (~> 3.0)
+  rspec-given (~> 3.5)
+  ruby2ruby (~> 2.1)
+  ruby_parser (~> 3.6)
+  yard (~> 0.8.7)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Wayne Conrad
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,109 @@
+# cute_print
+
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "cute_print"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cute_print
+
+## Usage
+
+Start with:
+
+    require "cute_print"
+
+You can use q just like you use Kernel#p.  It will work the same,
+except that its output goes to $stderr instead of $stdout:
+
+    q "abc"            # "abc"
+    q [1, 2, 3 + 4]    # [1, 2, 7]
+
+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:
+
+    ql "abc"        # foo.rb:12: "abc"
+    ql {1 + 2}      # foo.rb:13: 1 + 2 is 3
+
+Call chains can be a pain to debug, but it's easy with Kernel#tapq and
+Kernel#tapql:
+
+    ["1", "2"].map(&:to_i).tapq.inject(&:+)
+    # [1, 2]
+
+    ["1", "2"].map(&:to_i).tapql.inject(&:+)
+    # prints: bar.rb:12: [1, 2]
+
+## Documentation
+
+[Full documentation (relishapp)][2]
+
+## Rubies supported
+
+This gem is known to work with these Rubies:
+
+* ruby-1.9.3
+* ruby-2.1.2
+
+## Platforms supported
+
+This gem is developed and tested with Linux.  It should work on
+Windows and OSX as well.  If it does not work for you, please file an
+issue on github.
+
+## Other gems with similar functions
+
+The [_wrong_][1] gem includes the excellent #d method, which is very
+much like this gem's #q method.  This gem's ability to read the debug
+statement's source is derived from the _wrong_ gem.
+
+Differences between the _wrong_ gem and this gem:
+
+* The _wrong_ gem supports color output
+* The _wrong_ gem writes only to stdout
+* The _wrong_ gem supports Ruby 1.8
+
+## Versioning
+
+This gem uses [semantic versioning 2.0][3].
+
+While the version is < 1.0.0, the API can change with any version
+increment.  If you need stability, lock the gem down to a minor
+version, e.g.:
+
+    gem "cute_print", "~> 0.1.0"
+
+## Contributing
+
+1. Fork it ( http://github.com/wconrad/cute_print/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+[1]: http://rubygems.org/gems/wrong
+[2]: https://www.relishapp.com/wconrad/cute-print/docs
+[3]: http://semver.org/spec/v2.0.0.html

data/Rakefile

@@ -0,0 +1,14 @@
+# encoding: utf-8
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+
+$:.unshift(File.dirname(__FILE__) + '/lib')
+Dir['tasks/**/*.rake'].sort.each { |path| load path }

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/basic101.gemspec

@@ -0,0 +1,64 @@
+# 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
+

data/cute_print.gemspec

@@ -0,0 +1,96 @@
+# Generated by jeweler
+# 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
+
+Gem::Specification.new do |s|
+  s.name = "cute_print"
+  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-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.email = "wconrad@yagni.com"
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+  s.files = [
+    ".config/cucumber.yml",
+    ".rspec",
+    ".yardopts",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "basic101.gemspec",
+    "cute_print.gemspec",
+    "features/.nav",
+    "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/readme.md",
+    "features/support/env.rb",
+    "features/support/helpers/example.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_ext.rb",
+    "lib/cute_print/core_ext/object.rb",
+    "lib/cute_print/default_printer.rb",
+    "lib/cute_print/finds_foreign_caller.rb",
+    "lib/cute_print/mixin.rb",
+    "lib/cute_print/printer.rb",
+    "lib/cute_print/ruby_generator.rb",
+    "lib/cute_print/ruby_parser.rb",
+    "lib/cute_print/ruby_parser/block.rb",
+    "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/stderr_out.rb",
+    "spec/cute_print_spec.rb",
+    "spec/printer_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/captures_stderr.rb",
+    "tasks/cucumber.rake",
+    "tasks/default.rake",
+    "tasks/jeweler.rake",
+    "tasks/spec.rake",
+    "tasks/test.rake",
+    "tasks/yard.rake",
+    "test_support/captures_stderr.rb",
+    "test_support/captures_stdout.rb"
+  ]
+  s.homepage = "http://github.com/wconrad/cute_print"
+  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_runtime_dependency(%q<ruby_parser>, ["~> 3.6"])
+      s.add_runtime_dependency(%q<ruby2ruby>, ["~> 2.1"])
+    else
+      s.add_dependency(%q<ruby_parser>, ["~> 3.6"])
+      s.add_dependency(%q<ruby2ruby>, ["~> 2.1"])
+    end
+  else
+    s.add_dependency(%q<ruby_parser>, ["~> 3.6"])
+    s.add_dependency(%q<ruby2ruby>, ["~> 2.1"])
+  end
+end
+

data/features/.nav

@@ -0,0 +1,6 @@
+- inspect_objects:
+  - inspect.feature
+  - label_and_inspect.feature
+  - print_source_location.feature
+- inspect_call_chain.feature
+- configuring:

data/features/configuring/configure_output.feature

@@ -0,0 +1,21 @@
+Feature: Configure output
+
+  By default, output is written to $stderr.  You can change where
+  output goes.
+
+  Scenario: Write to $stdout
+    Given a file with:
+      """
+      require "cute_print"
+
+      CutePrint.configure do |c|
+        c.out = $stdout
+      end
+
+      q "abc"
+      """
+    Then stdout should be
+      """
+      "abc"
+
+      """

data/features/configuring/configure_position_format.feature

@@ -0,0 +1,30 @@
+Feature: Configure position 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:
+
+  * :path
+  * :filename
+  * :line_number
+
+  The default position format is:
+
+      "%<filename>s:%<line_number>d: "
+
+  Scenario: Write full path
+    Given a file named "example.rb" with:
+      """
+      require "cute_print"
+
+      CutePrint.configure do |c|
+        c.position_format = "%<path>s:%<line_number>d: "
+      end
+
+      ql 123
+      """
+    Then stderr should be
+    """
+    /tmp/.../example.rb:7: 123
+
+    """

data/features/configuring/readme.md

@@ -0,0 +1 @@
+You can configure several things:

data/features/configuring/reset_configuration.feature

@@ -0,0 +1,27 @@
+Feature: Reset configuration
+
+  You can reset the configuration to its defaults.
+
+  Scenario: Write to $stdout
+    Given a file with:
+      """
+      require "cute_print"
+
+      CutePrint.configure do |c|
+        c.out = $stdout
+      end
+
+      q "abc"
+      CutePrint.configure { |c| c.reset }
+      q 123
+      """
+    Then stdout should be
+      """
+      "abc"
+
+      """
+    And stderr should be
+      """
+      123
+
+      """

data/features/inspect_call_chain.feature

@@ -0,0 +1,39 @@
+Feature: Inspect a call chain
+
+  Call chains (aka "train wrecks") can be a bother to debug.
+  Kernel#tapq prints a value in a call chain and then continues the
+  chain.
+
+  Scenario: Without source position
+    Given a file with:
+      """
+      require "cute_print"
+      puts ["1", "2"].map(&:to_i).tapq.inject(:+)
+      """
+    Then stdout should be
+      """
+      3
+
+      """
+    And stderr should be
+      """
+      [1, 2]
+
+      """
+
+  Scenario: With source position
+    Given a file named "example.rb" with:
+      """
+      require "cute_print"
+      puts ["1", "2"].map(&:to_i).tapql.inject(:+)
+      """
+    Then stdout should be
+      """
+      3
+
+      """
+    And stderr should be
+      """
+      example.rb:2: [1, 2]
+
+      """

data/features/inspect_objects/inspect.feature

@@ -0,0 +1,29 @@
+Feature: Inspect an object
+
+  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.
+
+  Scenario: One argument
+    Given a file with:
+      """
+      require "cute_print"
+      q "abc"
+      """
+    Then stderr should be
+      """
+      "abc"
+
+      """
+
+  Scenario: Two arguments
+    Given a file with:
+      """
+      require "cute_print"
+      q "abc", 123
+      """
+    Then stderr should be
+      """
+      "abc"
+      123
+
+      """

data/features/inspect_objects/label_and_inspect.feature

@@ -0,0 +1,16 @@
+Feature: Label and inspect an object
+
+  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
+    Given a file with:
+      """
+      require "cute_print"
+      q {1 + 2}
+      """
+    Then stderr should be
+      """
+      (1 + 2) is 3
+
+      """

data/features/inspect_objects/print_source_location.feature

@@ -0,0 +1,41 @@
+Feature: Print the source location
+
+  Kernel#ql works just like Kernel#q, except that it also prints the
+  source location
+
+  Scenario: Inspect an object
+    Given a file named "example.rb" with:
+      """
+      require "cute_print"
+      ql "abc"
+      """
+    Then stderr should be
+      """
+      example.rb:2: "abc"
+
+      """
+
+  Scenario: Inspect two objects
+    Given a file named "example.rb" with:
+      """
+      require "cute_print"
+      ql "abc", 123
+      """
+    Then stderr should be
+      """
+      example.rb:2: "abc"
+      example.rb:2: 123
+
+      """
+
+  Scenario: Label and inspect and object
+    Given a file named "example.rb" with:
+      """
+      require "cute_print"
+      ql {1 + 2}
+      """
+    Then stderr should be
+      """
+      example.rb:2: (1 + 2) is 3
+
+      """

data/features/inspect_objects/readme.md

@@ -0,0 +1 @@
+There are several ways to inspect objects:

data/features/readme.md

@@ -0,0 +1 @@
+Write debug output to the console, with flair.