seeing_is_believing 2.1.4 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1952064fe97bbd42814728d8562a23f401b11ccc
-  data.tar.gz: 41ebff3b5b92e9003ef4e587d25367a610ea45e3
+  metadata.gz: 9a2d2874d2ed6cf8165af907b62ecee8e271b5f6
+  data.tar.gz: b84abdaafa69646c8a71fabf979cfb334beaa197
 SHA512:
-  metadata.gz: d40b823e70ff45521c324895cde5d0d76195ef26339ba0dc431d6009ec901bcc1e0e9ad509eb752477a3973035b88667ab6e0ef3ca97e354a2c8c90369a3dc2e
-  data.tar.gz: c766a89c201e945347575eed23044fd1635628bfb1b6857bfa4d62bc4641dfe809e15fe91322f7590d344db752e562a533e7d56ce926649befe5e4aa1353b31a
+  metadata.gz: fb5fe068ff82a068246a81865807c2aa9acd711f29dd93223b4950968a7c2d3e394df146e99832b655f73d8abe44c00acb5e34ccc8105c527d97065e61cd8799
+  data.tar.gz: 31c4079565ae48e1fe9c15b81dcbbf775f21588afe4b6372ee818ef06ab333cac5da3670013c41b5496e36a9f68c808cc235961f94212954f60e1a5ed326e108

data/Readme.md

@@ -1,22 +1,32 @@
+[![Stories in Ready](https://badge.waffle.io/JoshCheek/seeing_is_believing.png?label=ready&title=Ready)](https://waffle.io/JoshCheek/seeing_is_believing)
 [![Build Status](https://secure.travis-ci.org/JoshCheek/seeing_is_believing.png?branch=master)](http://travis-ci.org/JoshCheek/seeing_is_believing)
 
 Seeing Is Believing
 ===================
 
 Evaluates a file, recording the results of each line of code.
-You can then use this to display output values like Bret Victor does with JavaScript in his talk [Inventing on Principle](http://vimeo.com/36579366).
-Except, obviously, his is like a million times better.
+Integrates with any extensible editor (I've integrated it with many already, see [the list](https://github.com/JoshCheek/seeing_is_believing#editor-integration).
 
-Also comes with a binary to show how it might be used.
+![example](https://s3.amazonaws.com/josh.cheek/images/scratch/sib-example1.gif)
 
-For whatever reason, I can't embed videos, but **here's a [video](http://vimeo.com/73866851)** showing it off.
+Watch a [longer video](http://vimeo.com/73866851).
 
-Works in Ruby 1.9 and 2.0
+Works in Ruby 1.9, 2.0, 2.1, rubinius (I **think**, need to make better tests), still trying to get it working with Jruby.
 
 Use The Binary
 ==============
 
-```ruby
+* Show every line of code (last expression)
+* Show only marked lines (xmpfilter style, except better b/c it understands expressions)
+* Clear annotations when they get in your way (even if code is invalid)
+* Smart enough to show
+  * method arguments
+  * if statement clauses
+  * values in a hash
+  * methods that are chained together across lines
+  * multiline string/symbol/regex
+
+```sh
 $ cat simple_example.rb
 5.times do |i|
   i * 2
@@ -25,7 +35,7 @@ end
 
 $ seeing_is_believing simple_example.rb
 5.times do |i|  # => 5
-    i * 2       # => 0, 2, 4, 6, 8
+  i * 2         # => 0, 2, 4, 6, 8
 end             # => 5
 ```
 
@@ -54,8 +64,7 @@ result.exception # => nil
 Install
 =======
 
-Currently requires Ruby 1.9 or 2.0. I don't have specific plans to make it available on 1.8,
-but it could happen.
+Currently requires Ruby 1.9 or 2.0.
 
     $ gem install seeing_is_believing
 
@@ -100,25 +109,20 @@ Shit that will probably never get done (or if it does, won't be until after 2.0)
 ================================================================================
 
 * How about if begin/rescue/end was able to record the result on the rescue section
+* How about if you could configure which kinds of results ou were interested in (e.g. turn on/off recording of method definitions, and other results)
 * What about recording the result of a line inside of a string interpolation, e.g. "a#{\n1\n}b" could record line 2 is 1 and line 3 is "a\n1\nb"
 * If given a file with a Unicode character, but not set Unicode, inform the user
 
 License
 =======
 
-           DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
-                       Version 2, December 2004
-
-    Copyright (C) 2012 Josh Cheek <josh.cheek@gmail.com>
-
-    Everyone is permitted to copy and distribute verbatim or modified
-    copies of this license document, and changing it is allowed as long
-    as the name is changed.
-
-               DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
-      TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-
-     0. You just DO WHAT THE FUCK YOU WANT TO.
-
+<a href="http://www.wtfpl.net/"><img src="http://www.wtfpl.net/wp-content/uploads/2012/12/wtfpl.svg" height="20" alt="WTFPL" /></a>
 
+    Copyright (C) 2014 Josh Cheek <josh.cheek@gmail.com>
 
+    This program is free software. It comes without any warranty,
+    to the extent permitted by applicable law.
+    You can redistribute it and/or modify it under the terms of the
+    Do What The Fuck You Want To Public License,
+    Version 2, as published by Sam Hocevar.
+    See http://www.wtfpl.net/ for more details.

data/lib/seeing_is_believing/binary.rb

@@ -111,7 +111,7 @@ class SeeingIsBelieving
     end
 
     def evaluate_program
-      self.interpolated_program = printer.call
+      self.interpolated_program = annotator.call
     rescue Timeout::Error
       self.timeout_error = true
     rescue Exception
@@ -150,12 +150,12 @@ class SeeingIsBelieving
       @body ||= (flags[:program] || (file_is_on_stdin? && stdin.read) || File.read(flags[:filename]))
     end
 
-    def printer
-      @printer ||= AddAnnotations.new body, flags.merge(stdin: (file_is_on_stdin? ? '' : stdin))
+    def annotator
+      @annotator ||= AddAnnotations.new body, flags.merge(stdin: (file_is_on_stdin? ? '' : stdin))
     end
 
     def results
-      printer.results
+      annotator.results
     end
 
     def file_is_on_stdin?
@@ -182,7 +182,7 @@ class SeeingIsBelieving
     end
 
     def result_as_data_structure
-      results = printer.results
+      results = annotator.results
       { stdout:      results.stdout,
         stderr:      results.stderr,
         exit_status: results.exitstatus,

data/lib/seeing_is_believing/evaluate_by_moving_files.rb

@@ -101,7 +101,7 @@ class SeeingIsBelieving
     end
 
     def evaluate_file
-      Open3.popen3 *popen_args do |process_stdin, process_stdout, process_stderr, thread|
+      Open3.popen3 ENV, *popen_args do |process_stdin, process_stdout, process_stderr, thread|
         out_reader = Thread.new { process_stdout.read }
         err_reader = Thread.new { process_stderr.read }
         Thread.new do

data/lib/seeing_is_believing/line.rb

@@ -54,12 +54,14 @@ class SeeingIsBelieving
       array.each { |element| record_result element }
     end
 
+    StackErrors = [SystemStackError]
+    StackErrors << Java::JavaLang::StackOverflowError if defined?(RUBY_PLATFORM) && RUBY_PLATFORM == 'java'
     def record_result(value)
       begin
         inspected = value.inspect.to_str # only invoke inspect once, b/c the inspection may be recorded
       rescue NoMethodError
         inspected = "#<no inspect available>"
-      rescue SystemStackError
+      rescue *StackErrors
         # this is necessary because SystemStackError won't show the backtrace of the method we tried to call
         # which means there won't be anything showing the user where this came from
         # so we need to re-raise the error to get a backtrace that shows where we came from

data/lib/seeing_is_believing/parser_helpers.rb

@@ -1,4 +1,14 @@
-require 'parser/current'
+module Parser
+  class << self
+    # With new versioning, there's lots of small versions
+    # we don't need it to complain that we're on 2.1.1 and its parsing 2.1.5
+    # https://github.com/whitequark/parser/blob/e2249d7051b1adb6979139928e14a81bc62f566e/lib/parser/current.rb#L3
+    def warn(*) end
+    require 'parser/current'
+    remove_method :warn
+  end
+end
+
 class SeeingIsBelieving
   module ParserHelpers
 

data/lib/seeing_is_believing/version.rb

@@ -1,3 +1,3 @@
 class SeeingIsBelieving
-  VERSION = '2.1.4'
+  VERSION = '2.2.0'
 end

data/lib/seeing_is_believing/wrap_expressions.rb

@@ -1,4 +1,3 @@
-require 'parser/current'
 require 'seeing_is_believing/parser_helpers'
 
 # comprehensive list of syntaxes that can come up

data/seeing_is_believing.gemspec

@@ -19,15 +19,15 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency             "parser",   "~> 2.1.4"
+  s.add_dependency             "parser",   ">= 2.2", "< 3.0"
   s.add_dependency             "psych",    "~> 2.0"
 
   s.add_development_dependency "pry",      "~> 0.10.0"
   s.add_development_dependency "haiti",    "~> 0.1.0"
-  s.add_development_dependency "rake",     "~> 10.0.3"
-  s.add_development_dependency "rspec",    "~> 3.0.0"
-  s.add_development_dependency "cucumber", "~> 1.2.1"
-  s.add_development_dependency "ichannel", "~> 5.1.1"
+  s.add_development_dependency "rake",     "~> 10.0"
+  s.add_development_dependency "rspec",    "~> 3.0"
+  s.add_development_dependency "cucumber", "~> 1.2"
+  s.add_development_dependency "ichannel", "~> 5.1"
 
   s.post_install_message = <<'Omg, frogs <3'.gsub(/(gg+)/) { |capture| "\e[32m#{capture.gsub 'g', '.'}\e[0m" }.gsub("brown", "\e[33m").gsub("off", "\e[0m")
               .7

data/spec/hard_core_ensure_spec.rb

@@ -83,6 +83,7 @@ describe SeeingIsBelieving::HardCoreEnsure do
 
     if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby'
       pending "Skipping this test on jruby b/c the JVM doesn't have a fork"
+      raise # new rspec will keep executing code and fail b/c nothing is raised
     elsif (!defined?(RUBY_ENGINE) || RUBY_ENGINE == 'ruby') && (RUBY_VERSION == '2.1.1' || RUBY_VERSION == '2.1.2')
       pending 'This test can\'t run on MRI (2.1.1 or 2.1.2) b/c of bug, see https://github.com/JoshCheek/seeing_is_believing/issues/26'
       raise # new rspec will keep executing code and fail b/c nothing is raised

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: seeing_is_believing
 version: !ruby/object:Gem::Version
-  version: 2.1.4
+  version: 2.2.0
 platform: ruby
 authors:
 - Josh Cheek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-12 00:00:00.000000000 Z
+date: 2015-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: psych
   requirement: !ruby/object:Gem::Requirement
@@ -72,56 +78,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.0.3
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.0.3
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: ichannel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.1.1
+        version: '5.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.1.1
+        version: '5.1'
 description: Records the results of every line of code in your file (intended to be
   like xmpfilter), inspired by Bret Victor's JavaScript example in his talk "Inventing
   on Principle"
@@ -138,6 +144,7 @@ files:
 - Rakefile
 - Readme.md
 - bin/seeing_is_believing
+- docs/example.gif
 - docs/for-presentations
 - docs/frog-brown.png
 - features/errors.feature
@@ -241,7 +248,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: seeing_is_believing
-rubygems_version: 2.2.2
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: Records results of every line of code in your file