cute_print 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: b77c74c7dd08701b1565f5c5c31716ee0db3e047
-  data.tar.gz: 0755262ff0105ecdb4b482ca308a91537b810604
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODg0NWRlYWY0NTcwOTA2NzQyYTNkYjlkMzE1OGRmNjcwYTE0NDU1NQ==
+  data.tar.gz: !binary |-
+    Y2M4YTVlZjgyMThhZDhmM2M1OGM3MTkwODM2MmEyY2RjZDE4ZmIzNQ==
 SHA512:
-  metadata.gz: 6a0121678c3b1f7e924889f629bb46ec9e944de20a2b9c50101a31b14bb1b67496475f07e4d42175dd47319f57073b70c22d300ce2facd7447ed2c78422d8f3b
-  data.tar.gz: 4c27d895e6dda812b3391da579b63ae310e25230d76deb7bca55132b25fa05763cbf92612899c682b1e836e026feb124552edc234e147ccc9a733dd51beb7963
+  metadata.gz: !binary |-
+    ZGJiMzU1NGM4YmMxYWM5NTBiMzU0MTNmNWUzNDEzMmYzZGNhMWFmYTA1MDI5
+    MTE2OTlkZmFlNTMwNWM0NGIyNzIyZjExNTRmODc5N2FiNWMzZDViMTQ4ODMy
+    ZTc5M2Y2ZmVlN2E3NjlhYTNhNjgyNmViZmQ5ZGQ5YjNjZDJlOTE=
+  data.tar.gz: !binary |-
+    M2E2NWMwNjViM2MyMjliNjEwM2JmZjdiZDk3ZWJiODMwZDdiODRlZjY4ODJj
+    NjNmNzczMDcwMDg2MGI0NDM2OWY1MWUwM2Y2Y2Y2YmY1M2VmNzlhNTRkMWU0
+    NmNhN2VmNDMwN2FiNjJkYTMzODkzZDY3MTlmNDJlY2I5ODE3NjQ=

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+* 1.1.0 - 2015-06-13
+
+Enhancements:
+
+* Determine the terminal width and use it instead of just hard-coding
+  "79"
+
+API changes
+
+* Added Configure#term_width to set the term width
+
 # 1.0.1 - 2014-12-21
 
 * Eliminate warnings in "-w" mode

data/Gemfile

@@ -2,10 +2,11 @@ source "http://rubygems.org"
 
 gem "ruby_parser", "~> 3.6"
 gem "ruby2ruby", "~> 2.1"
+gem "hirb", "~> 0.7"
 
 group :test do
   gem "bundler", "~> 1.7"
-  gem "cucumber", "~> 1.3"
+  gem "cucumber", "~> 2.0"
   gem "rake", "~> 10.4"
   gem "rspec", "~> 3.1"
   gem "rspec-given", "~> 3.5"

data/Gemfile.lock

@@ -1,23 +1,26 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    addressable (2.3.6)
+    addressable (2.3.8)
     builder (3.2.2)
-    cucumber (1.3.17)
+    cucumber (2.0.0)
       builder (>= 2.1.2)
+      cucumber-core (~> 1.1.3)
       diff-lcs (>= 1.1.3)
       gherkin (~> 2.12)
       multi_json (>= 1.7.5, < 2.0)
-      multi_test (>= 0.1.1)
+      multi_test (>= 0.1.2)
+    cucumber-core (1.1.3)
+      gherkin (~> 2.12.0)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.2.5)
-    faraday (0.9.0)
+    faraday (0.9.1)
       multipart-post (>= 1.2, < 3)
     gherkin (2.12.2)
       multi_json (~> 1.3)
-    git (1.2.8)
-    github_api (0.12.2)
+    git (1.2.9.1)
+    github_api (0.12.3)
       addressable (~> 2.3)
       descendants_tracker (~> 0.0.4)
       faraday (~> 0.8, < 0.10)
@@ -25,10 +28,11 @@ GEM
       multi_json (>= 1.7.5, < 2.0)
       nokogiri (~> 1.6.3)
       oauth2
-    given_core (3.5.4)
+    given_core (3.7.0)
       sorcerer (>= 0.3.7)
-    hashie (3.3.2)
-    highline (1.6.21)
+    hashie (3.4.2)
+    highline (1.7.2)
+    hirb (0.7.3)
     jeweler (2.0.1)
       builder
       bundler (>= 1.0)
@@ -38,14 +42,14 @@ GEM
       nokogiri (>= 1.5.10)
       rake
       rdoc
-    json (1.8.1)
-    jwt (1.2.0)
-    mini_portile (0.6.1)
-    multi_json (1.10.1)
-    multi_test (0.1.1)
+    json (1.8.3)
+    jwt (1.5.0)
+    mini_portile (0.6.2)
+    multi_json (1.11.1)
+    multi_test (0.1.2)
     multi_xml (0.5.5)
     multipart-post (2.0.0)
-    nokogiri (1.6.5)
+    nokogiri (1.6.6.2)
       mini_portile (~> 0.6.0)
     oauth2 (1.0.0)
       faraday (>= 0.8, < 0.10)
@@ -53,34 +57,35 @@ GEM
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (~> 1.2)
-    rack (1.5.2)
+    rack (1.6.1)
     rake (10.4.2)
     rdoc (4.2.0)
       json (~> 1.4)
-    redcarpet (3.2.2)
-    rspec (3.1.0)
-      rspec-core (~> 3.1.0)
-      rspec-expectations (~> 3.1.0)
-      rspec-mocks (~> 3.1.0)
-    rspec-core (3.1.7)
-      rspec-support (~> 3.1.0)
-    rspec-expectations (3.1.2)
+    redcarpet (3.3.1)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.0)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.1.0)
-    rspec-given (3.5.4)
-      given_core (= 3.5.4)
-      rspec (>= 2.12)
-    rspec-mocks (3.1.3)
-      rspec-support (~> 3.1.0)
-    rspec-support (3.1.2)
-    ruby2ruby (2.1.3)
+      rspec-support (~> 3.3.0)
+    rspec-given (3.7.0)
+      given_core (= 3.7.0)
+      rspec (>= 2.14.0)
+    rspec-mocks (3.3.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    ruby2ruby (2.2.0)
       ruby_parser (~> 3.1)
       sexp_processor (~> 4.0)
-    ruby_parser (3.6.3)
+    ruby_parser (3.7.0)
       sexp_processor (~> 4.1)
-    sexp_processor (4.4.4)
+    sexp_processor (4.6.0)
     sorcerer (1.0.2)
-    thread_safe (0.3.4)
+    thread_safe (0.3.5)
     yard (0.8.7.6)
 
 PLATFORMS
@@ -88,7 +93,8 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.7)
-  cucumber (~> 1.3)
+  cucumber (~> 2.0)
+  hirb (~> 0.7)
   jeweler (~> 2.0)
   rake (~> 10.4)
   redcarpet (~> 3.2)
@@ -97,3 +103,6 @@ DEPENDENCIES
   ruby2ruby (~> 2.1)
   ruby_parser (~> 3.6)
   yard (~> 0.8.7)
+
+BUNDLED WITH
+   1.10.3

data/README.md

@@ -154,6 +154,18 @@ the filename:
       c.location_format = :path
     end
 
+The terminal width is detected, if possible, but you can override it:
+
+    CutePrint.configure do |c|
+      c.term_width = 132
+    end
+
+To set the terminal width back to being detected:
+
+    CutePrint.configure do |c|
+      c.term_width = :detect
+    end
+
 To reset the configuration to its defaults:
 
     CutePrint.configure do |c|
@@ -196,12 +208,6 @@ statement's source is derived from the _wrong_ gem.
 
 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 )

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.1.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 1.0.1 ruby lib
+# stub: cute_print 1.1.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "cute_print"
-  s.version = "1.0.1"
+  s.version = "1.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-12-21"
+  s.date = "2015-06-13"
   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 = [
@@ -83,6 +83,9 @@ Gem::Specification.new do |s|
     "lib/cute_print/ruby_parser/wraps_sexp.rb",
     "lib/cute_print/source_label.rb",
     "lib/cute_print/stderr_out.rb",
+    "lib/cute_print/term_width.rb",
+    "lib/cute_print/term_width/detected.rb",
+    "lib/cute_print/term_width/static.rb",
     "lib/cute_print/values.rb",
     "spec/cute_print_spec.rb",
     "spec/format/inspect_spec.rb",
@@ -107,7 +110,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/wconrad/cute_print"
   s.licenses = ["MIT"]
-  s.rubygems_version = "2.4.4"
+  s.rubygems_version = "2.4.8"
   s.summary = "print debug to stderr, with flair"
 
   if s.respond_to? :specification_version then
@@ -116,13 +119,16 @@ Gem::Specification.new do |s|
     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"])
+      s.add_runtime_dependency(%q<hirb>, ["~> 0.7"])
     else
       s.add_dependency(%q<ruby_parser>, ["~> 3.6"])
       s.add_dependency(%q<ruby2ruby>, ["~> 2.1"])
+      s.add_dependency(%q<hirb>, ["~> 0.7"])
     end
   else
     s.add_dependency(%q<ruby_parser>, ["~> 3.6"])
     s.add_dependency(%q<ruby2ruby>, ["~> 2.1"])
+    s.add_dependency(%q<hirb>, ["~> 0.7"])
   end
 end
 

data/features/support/step_definitions.rb

@@ -1,3 +1,35 @@
+module EnvUtil
+
+  extend self
+
+  # Set environment variables for the duration of the block, then
+  # restore them to their original value.
+  # @param h [Hash]
+  def set(h)
+    orig = {}
+    h.keys.each do |key|
+      orig[key] = ENV[key]
+    end
+    begin
+      h.each do |key, value|
+        ENV[key] = value.to_s
+      end
+      yield
+    ensure
+      orig.each do |key, value|
+        ENV[key] = value
+      end
+    end
+  end
+
+end
+
+Around do |scenario, block|
+  EnvUtil.set("CUTE_PRINT_TERM_WIDTH" => 79) do
+    block.call
+  end
+end
+
 Given(/^a file with:$/) do |contents|
   @example = Example.new(contents)
   @example.run

data/lib/cute_print/configure.rb

@@ -32,6 +32,12 @@ module CutePrint
     #   @see Printer#out
     delegate_accessor :out
 
+    # @!attribute [rw] term_width
+    #   @return [Integer, Symbol] The terminal width, or :detect if it
+    #     is being detected automatically.
+    #   @see Printer#term_width
+    delegate_accessor :term_width
+
   end
 
 end

data/lib/cute_print/formatter.rb

@@ -12,15 +12,13 @@ module CutePrint
   # @api private
   class Formatter
 
-    DEFAULT_WIDTH = 79
-
     def initialize(opts = {})
       @method = opts.fetch(:method)
       @out = opts.fetch(:out)
       @block = opts.fetch(:block, nil)
       @args = opts.fetch(:values, [])
       @values = Values.new(@args, @block)
-      @width = opts.fetch(:width, DEFAULT_WIDTH)
+      @width = opts.fetch(:width)
       @location_label = nil
     end
 

data/lib/cute_print/printer.rb

@@ -1,5 +1,6 @@
 require_relative "formatter"
 require_relative "stderr_out"
+require_relative "term_width"
 
 module CutePrint
   class Printer
@@ -10,7 +11,7 @@ module CutePrint
     # @return [#print]
     attr_accessor :out
 
-    # The location format.
+    # The location format.  Defaults to :filename
     #
     # One of:
     # * :filename
@@ -19,6 +20,21 @@ module CutePrint
     # @return [String]
     attr_accessor :location_format
 
+    # The terminal width.  May be an integer, or :detect to cause the
+    # terminal width to be determined automatically.  Defaults to
+    # :detect
+    #
+    # @!attribute [rw] term_width
+    #   @return [Integer, Symbol]
+
+    def term_width
+      @term_width.visible
+    end
+
+    def term_width=(value)
+      @term_width = TermWidth.make(value)
+    end
+
     # Create an instance.  If attributes are supplied, they override
     # the defaults.  For example:
     #
@@ -34,16 +50,12 @@ module CutePrint
     def set_defaults
       @out = StderrOut.new
       @location_format = :filename
+      self.term_width = :detect
     end
 
     # @see CutePrint.q
     def q(*values, &block)
-      formatter = Formatter.new(
-        method: __method__,
-        out: @out,
-        block: block,
-        values: values
-      )
+      formatter = make_formatter(__method__, values, block)
       formatter.inspect
       formatter.write
       nil
@@ -51,11 +63,7 @@ module CutePrint
 
     # @see CutePrint.ql
     def ql(*values, &block)
-      formatter = Formatter.new(
-        method: __method__,
-        out: @out,
-        block: block,
-        values: values)
+      formatter = make_formatter(__method__, values, block)
       formatter.inspect
       formatter.with_location @location_format
       formatter.write
@@ -64,11 +72,7 @@ module CutePrint
 
     # @see CutePrint.qq
     def qq(*values, &block)
-      formatter = Formatter.new(
-        method: __method__,
-        out: @out,
-        block: block,
-        values: values)
+      formatter = make_formatter(__method__, values, block)
       formatter.pretty_print
       formatter.write
       nil
@@ -76,11 +80,7 @@ module CutePrint
 
     # @see CutePrint.qql
     def qql(*values, &block)
-      formatter = Formatter.new(
-        method: __method__,
-        out: @out,
-        block: block,
-        values: values)
+      formatter = make_formatter(__method__, values, block)
       formatter.pretty_print
       formatter.with_location @location_format
       formatter.write
@@ -89,5 +89,14 @@ module CutePrint
 
     private
 
+    def make_formatter(method, values, block)
+      Formatter.new(
+        method: method,
+        block: block,
+        values: values,
+        out: @out,
+        width: @term_width.width)
+    end
+
   end
 end

data/lib/cute_print/term_width/detected.rb

@@ -0,0 +1,42 @@
+require "hirb"
+
+module CutePrint
+  class TermWidth
+
+    # A terminal width that tries to determine the terminal width
+    # automatically.
+    # @api private
+    class Detected
+
+      attr_reader :width
+
+      def initialize
+        @width = detect_width
+      end
+
+      def visible
+        :detect
+      end
+
+      private
+
+      FALLBACK_WIDTH = 79
+
+      def detect_width
+        return width_override_for_tests if width_override_for_tests
+        width, _height = Hirb::Util.detect_terminal_size
+        # Hirb returns nil if it can't determine the terminal width.
+        # Program run in Emacs have an apparent terminal width of "0".
+        width = FALLBACK_WIDTH if width.nil? || width == 0
+        width
+      end
+
+      def width_override_for_tests
+        n = ENV['CUTE_PRINT_TERM_WIDTH']
+        n && Integer(n)
+      end
+
+    end
+
+  end
+end

data/lib/cute_print/term_width/static.rb

@@ -0,0 +1,21 @@
+module CutePrint
+  class TermWidth
+
+    # A terminal width with a fixed value
+    # @api private
+    class Static
+
+      attr_reader :width
+
+      def initialize(width)
+        @width = width
+      end
+
+      def visible
+        @width
+      end
+
+    end
+
+  end
+end

data/lib/cute_print/term_width.rb

@@ -0,0 +1,29 @@
+require_relative "term_width/detected"
+require_relative "term_width/static"
+
+module CutePrint
+  
+  # @api private
+  class TermWidth
+
+    # Given a width, make an appropriate TermWidth object.  The object
+    # returned has these readers:
+    # * #width [Integer] Return the actual terminal width
+    # * #visible [Object] Return the terminal width that
+    #   #Configuration#term_width should return.
+    # @param width [Object] Either the static terminal width,
+    #   or :detect to automatically detect the terminal width.
+    # @return [#width, #visible]
+    def self.make(width)
+      case width
+      when Integer
+        Static.new(width)
+      when :detect
+        Detected.new
+      else
+        raise ArgumentError, "Invalid terminal width: #{width.inspect}"
+      end
+    end
+
+  end
+end

metadata

@@ -1,43 +1,59 @@
 --- !ruby/object:Gem::Specification
 name: cute_print
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Wayne Conrad
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-21 00:00:00.000000000 Z
+date: 2015-06-13 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'
+        version: !binary |-
+          My42
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: !binary |-
+          My42
 - !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'
+- !ruby/object:Gem::Dependency
+  name: hirb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
 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.
@@ -48,10 +64,10 @@ extra_rdoc_files:
 - LICENSE
 - README.md
 files:
-- ".config/cucumber.yml"
-- ".rspec"
-- ".travis.yml"
-- ".yardopts"
+- .config/cucumber.yml
+- .rspec
+- .travis.yml
+- .yardopts
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -112,6 +128,9 @@ files:
 - lib/cute_print/ruby_parser/wraps_sexp.rb
 - lib/cute_print/source_label.rb
 - lib/cute_print/stderr_out.rb
+- lib/cute_print/term_width.rb
+- lib/cute_print/term_width/detected.rb
+- lib/cute_print/term_width/static.rb
 - lib/cute_print/values.rb
 - spec/cute_print_spec.rb
 - spec/format/inspect_spec.rb
@@ -143,17 +162,17 @@ 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: []
 rubyforge_project: 
-rubygems_version: 2.4.4
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: print debug to stderr, with flair