seeing_is_believing 0.0.1 → 0.0.2

data/Readme.md

@@ -0,0 +1,83 @@
+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"][inventing_on_principle].
+Except, obviously, his is like a million better.
+
+Reeaally rough at the moment, but it works for simple examples.
+
+Also comes with a binary to show how it might be used.
+
+Install
+=======
+
+    gem install seeing_is_believing
+
+Use
+===
+
+    $ cat proving_grounds/basic_functionality.rb
+
+```ruby
+a = '12'
+a + a
+
+5.times do |i|
+  i * 2
+end
+```
+
+    $ seeing_is_believing proving_grounds/basic_functionality.rb
+
+```ruby
+a = '12'        # => "12"
+a + a           # => "1212"
+
+5.times do |i|
+  i * 2         # => 0, 2, 4, 6, 8
+end             # => 5
+```
+
+    $ cat proving_grounds/raises_exception.rb
+
+```ruby
+1 + 1
+raise "ZOMG!"
+1 + 1
+```
+
+    $ bin/seeing_is_believing proving_grounds/raises_exception.rb 2>/dev/null
+
+```ruby
+1 + 1          # => 2
+raise "ZOMG!"  # ~> RuntimeError: ZOMG!
+1 + 1
+```
+
+    $ bin/seeing_is_believing proving_grounds/raises_exception.rb 1>/dev/null
+
+```bash
+ZOMG!
+```
+
+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.
+
+
+
+[inventing_on_principle]: http://vimeo.com/36579366

data/bin/seeing_is_believing

@@ -3,6 +3,16 @@
 $LOAD_PATH.unshift File.expand_path '../../lib', __FILE__
 require 'seeing_is_believing/example_use'
 
+status = 0
+
 ARGV.each do |filename|
-  puts SeeingIsBelieving::ExampleUse.new(File.read filename).call
+  believer = SeeingIsBelieving::ExampleUse.new(File.read filename)
+  believer.call
+  $stdout.puts believer.output
+  if believer.has_exception?
+    $stderr.puts believer.exception.message
+    status = 1
+  end
 end
+
+exit status

data/features/binary.feature

@@ -6,7 +6,7 @@ Feature: Running the binary
   run against every line.
 
   Scenario: Some basic functionality
-    Given the file "f.rb":
+    Given the file "basic_functionality.rb":
     """
     a = '12'
     a + a
@@ -15,9 +15,9 @@ Feature: Running the binary
       i * 2
     end
     """
-    When I run "seeing_is_believing f.rb"
-    And stderr is empty
-    Then the exit status is 0
+    When I run "seeing_is_believing basic_functionality.rb"
+    Then stderr is empty
+    And the exit status is 0
     And stdout is:
     """
     a = '12'        # => "12"
@@ -26,10 +26,25 @@ Feature: Running the binary
     5.times do |i|
       i * 2         # => 0, 2, 4, 6, 8
     end             # => 5
+    """
 
+  Scenario: Raising exceptions
+    Given the file "raises_exception.rb":
+    """
+    1 + 1
+    raise "ZOMG!"
+    1 + 1
+    """
+    When I run "seeing_is_believing raises_exception.rb"
+    Then stderr is "ZOMG!"
+    And the exit status is 1
+    And stdout is:
+    """
+    1 + 1          # => 2
+    raise "ZOMG!"  # ~> RuntimeError: ZOMG!
+    1 + 1
     """
 
   Scenario: Printing within the file
-  Scenario: Raising exceptions
   Scenario: Requiring other files
   Scenario: Syntactically invalid file

data/features/step_definitions/steps.rb

@@ -7,7 +7,11 @@ When 'I run "$command"' do |command|
 end
 
 Then /^(stderr|stdout) is:$/ do |stream_name, output|
-  @last_executed.send(stream_name).should == output
+  @last_executed.send(stream_name).chomp.should == output
+end
+
+Then /^(stderr|stdout) is "(.*?)"$/ do |stream_name, output|
+  @last_executed.send(stream_name).chomp.should == output
 end
 
 Then 'the exit status is $status' do |status|

data/lib/seeing_is_believing/example_use.rb

@@ -2,17 +2,27 @@ require 'seeing_is_believing'
 
 class SeeingIsBelieving
   class ExampleUse
+    attr_accessor :exception
+
     def initialize(body)
       self.body = body
     end
 
     def call
       body.each_line.with_index 1 do |line, index|
-        write_line line.chomp, results[index], line_length
+        write_line line.chomp, results[index]
       end
       output
     end
 
+    def output
+      @result ||= ''
+    end
+
+    def has_exception?
+      !!@exception
+    end
+
     private
 
     attr_accessor :body
@@ -21,13 +31,12 @@ class SeeingIsBelieving
       @results ||= SeeingIsBelieving.new(body).call
     end
 
-    def output
-      @result ||= ''
-    end
-
-    def write_line(line, results, line_length)
+    def write_line(line, results)
       if results.any?
         output << sprintf("%-#{line_length}s# => %s\n", line, results.join(', '))
+      elsif results.has_exception?
+        self.exception = results.exception
+        output << sprintf("%-#{line_length}s# ~> %s: %s\n", line, results.exception.class, results.exception.message)
       else
         output << line << "\n"
       end

data/lib/seeing_is_believing/result.rb

@@ -1,5 +1,27 @@
 class SeeingIsBelieving
   class Result
+    class Line
+      attr_reader :results
+      attr_accessor :exception
+
+      def initialize
+        @results = []
+      end
+
+      def <<(result)
+        results << result
+      end
+
+      def any?
+        results.any?
+      end
+
+      def join(*args)
+        results.join(*args)
+      end
+
+      alias has_exception? exception
+    end
     attr_reader :min_line_number, :max_line_number
 
     def initialize
@@ -14,18 +36,17 @@ class SeeingIsBelieving
 
     def record_exception(line_number, exception)
       contains_line_number line_number
-      @exception_line_number = line_number
-      @exception = exception
+      results[line_number].exception = exception
     end
 
     def [](line_number)
       results[line_number]
     end
 
-    # uhm, maybe switch to #each and including Enumerable?
+    # probably not really useful, just exists to satisfy the tests
     def to_a
       (min_line_number..max_line_number).map do |line_number|
-        [line_number, [*self[line_number], *Array(exception_at line_number)]]
+        [line_number, [*self[line_number].results, *Array(self[line_number].exception)]]
       end
     end
 
@@ -36,13 +57,8 @@ class SeeingIsBelieving
 
     private
 
-    def exception_at(line_number)
-      return unless @exception_line_number == line_number
-      @exception
-    end
-
     def results
-      @results ||= Hash.new { |hash, line_number| hash[line_number] = [] }
+      @results ||= Hash.new { |hash, line_number| hash[line_number] = Line.new }
     end
   end
 end

data/lib/seeing_is_believing/version.rb

@@ -1,3 +1,3 @@
 class SeeingIsBelieving
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/seeing_is_believing.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.email       = ["josh.cheek@gmail.com"]
   s.homepage    = "https://github.com/JoshCheek/seeing_is_believing"
   s.summary     = %q{Records results of every line of code in your file}
-  s.description = %q{Records the results of every line of code in your file (intended to be like xmpfilter), inspired by Brett Victor's JavaScript example in his talk "Inventing on Principle"}
+  s.description = %q{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"}
 
   s.rubyforge_project = "seeing_is_believing"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: seeing_is_believing
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2013-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70170924125400 !ruby/object:Gem::Requirement
+  requirement: &70263953788620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.12.0
   type: :development
   prerelease: false
-  version_requirements: *70170924125400
+  version_requirements: *70263953788620
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70170924124580 !ruby/object:Gem::Requirement
+  requirement: &70263953787880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,9 +32,9 @@ dependencies:
         version: 1.2.1
   type: :development
   prerelease: false
-  version_requirements: *70170924124580
+  version_requirements: *70263953787880
 description: Records the results of every line of code in your file (intended to be
-  like xmpfilter), inspired by Brett Victor's JavaScript example in his talk "Inventing
+  like xmpfilter), inspired by Bret Victor's JavaScript example in his talk "Inventing
   on Principle"
 email:
 - josh.cheek@gmail.com
@@ -46,6 +46,7 @@ files:
 - .gitignore
 - Gemfile
 - Gemfile.lock
+- Readme.md
 - bin/seeing_is_believing
 - features/binary.feature
 - features/step_definitions/steps.rb