seeing_is_believing 0.0.4 → 0.0.5

data/Rakefile

@@ -0,0 +1,29 @@
+desc 'run specs'
+task :spec do
+  sh 'rspec -cf d --fail-fast'
+end
+
+desc 'run cukes'
+task :cuke do
+  sh 'cucumber -t ~@not-implemented -t ~@wip'
+end
+
+namespace :cuke do
+  desc 'Run work in progress cukes'
+  task :wip do
+    sh 'cucumber -t @wip'
+  end
+end
+
+namespace :spec do
+  desc 'Run work in progress specs'
+  task :wip do
+    sh 'rspec -t wip'
+  end
+end
+
+desc 'Run work in progress specs and cukes'
+task wip: ['spec:wip', 'cuke:wip']
+
+desc 'Run all specs and cukes'
+task default: [:spec, :cuke]

data/bin/seeing_is_believing

@@ -1,17 +1,8 @@
 #!/usr/bin/env ruby
 
 $LOAD_PATH.unshift File.expand_path '../../lib', __FILE__
-require 'seeing_is_believing/example_use'
 
-status = 0
+require 'open3'
+require 'seeing_is_believing/binary'
 
-ARGV.each do |filename|
-  believer = SeeingIsBelieving::ExampleUse.new File.read(filename), filename
-  $stdout.puts believer.call
-  if believer.has_exception?
-    $stderr.puts believer.exception.message
-    status = 1
-  end
-end
-
-exit status
+exit SeeingIsBelieving::Binary.new(ARGV, $stdin, $stdout, $stderr).exitstatus

data/features/binary_errors.feature

@@ -0,0 +1,44 @@
+Feature: Running the binary unsuccessfully
+
+  Sometimes I mess up and use the program in a way that doesn't work.
+  I'd like it to be helpful in these situations so I can fix my use.
+
+  Scenario: Raising exceptions
+    Given the file "raises_exception.rb":
+    """
+    raise "ZOMG!"
+    """
+    And the file "requires_exception_raising_code.rb":
+    """
+    1 + 1
+    require_relative 'raises_exception'
+    1 + 1
+    """
+    When I run "seeing_is_believing requires_exception_raising_code.rb"
+    Then stderr is "ZOMG!"
+    And the exit status is 1
+    And stdout is:
+    """
+    1 + 1                                # => 2
+    require_relative 'raises_exception'  # ~> RuntimeError: ZOMG!
+    1 + 1
+    """
+
+  Scenario: Syntactically invalid file
+    Given the file "invalid_syntax.rb":
+    """
+    'abc
+    """
+    When I run "seeing_is_believing invalid_syntax.rb"
+    Then stderr is:
+    """
+    invalid_syntax.rb:1: unterminated string meets end of file
+    """
+    And the exit status is 1
+    And stdout is empty
+
+  Scenario: Passing a nonexistent file
+    When I run "seeing_is_believing this_file_does_not_exist.rb"
+    Then stderr is "this_file_does_not_exist.rb does not exist!"
+    And the exit status is 1
+    And stdout is empty

data/features/{binary.feature → binary_examples.feature}

@@ -1,4 +1,5 @@
-Feature: Running the binary
+Feature: Running the binary successfully
+
   They say seeing is believing. So to believe that this works
   I want to see that it works by making a binary to use the lib.
 
@@ -48,23 +49,6 @@ Feature: Running the binary
      c"             # => "a\n b\n c"
     """
 
-  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: Passing previous output back into input
     Given the file "previous_output.rb":
     """
@@ -145,8 +129,47 @@ Feature: Running the binary
     2
     """
 
+  @not-implemented
+  Scenario: Doesn't record BEGIN/END since that's apparently a syntax error
+    Given the file "BEGIN_and_END.rb":
+    """
+    puts 1
+    BEGIN {
+      puts "begin code"
+      some_var = 2
+    }
+    puts 3
+    END {
+      puts "end code"
+      puts some_var
+    }
+    puts 4
+    """
+    When I run "seeing_is_believing BEGIN_and_END.rb"
+    Then stderr is empty
+    And the exit status is 0
+    And stdout is:
+    """
+    puts 1               # => nil
+    BEGIN {
+      puts "begin code"  # => nil
+      some_var = 2       # => 2
+    }
+    puts 3               # => nil
+    END {
+      puts "end code"    # => nil
+      puts some_var      # => nil
+    }
+    puts 4               # => nil
+
+    # >> begin code
+    # >> 1
+    # >> 3
+    # >> 4
+    # >> end code
+    # >> 2
+    """
+
   Scenario: Requiring other files
-  Scenario: Syntactically invalid file
-  Scenario: Passing a nonexistent file
   Scenario: Evaluating a file that requires other files, from a different directory
   Scenario: Passing the file on stdin

data/lib/seeing_is_believing/binary.rb

@@ -0,0 +1,52 @@
+require 'seeing_is_believing/print_results_next_to_lines'
+
+class SeeingIsBelieving
+  class Binary
+    attr_accessor :argv, :stdin, :stdout, :stderr
+
+    def initialize(argv, stdin, stdout, stderr)
+      self.argv   = argv
+      self.stdin  = stdin
+      self.stdout = stdout
+      self.stderr = stderr
+    end
+
+    def call
+      return if @already_called
+      @already_called = true
+
+      unless File.exist? filename
+        @exitstatus = 1
+        stderr.puts "#{filename} does not exist!"
+        return
+      end
+
+      out, err, syntax_status = Open3.capture3('ruby', '-c', filename)
+      unless syntax_status.success?
+        @exitstatus = 1
+        stderr.puts err
+        return
+      end
+
+      believer = SeeingIsBelieving::PrintResultsNextToLines.new File.read(filename), filename
+      stdout.puts believer.call
+      if believer.has_exception?
+        stderr.puts believer.exception.message
+        @exitstatus = 1
+      else
+        @exitstatus = 0
+      end
+    end
+
+    def exitstatus
+      call
+      @exitstatus
+    end
+
+    private
+
+    def filename
+      argv.first
+    end
+  end
+end

data/lib/seeing_is_believing/evaluate_by_moving_files.rb

@@ -11,7 +11,6 @@
 # I did look at Ripper, and it will invoke on_kw("__FILE__")
 # when it sees this.
 
-require 'yaml'
 require 'open3'
 require 'fileutils'
 require 'seeing_is_believing/error'
@@ -99,7 +98,7 @@ class SeeingIsBelieving
     end
 
     def deserialize_result
-      YAML.load stdout
+      Marshal.load stdout
     end
 
     def record_error

data/lib/seeing_is_believing/expression_list.rb

@@ -42,6 +42,7 @@ class SeeingIsBelieving
     def generate
       @line_number += 1
       expression = generator.call
+      raise SyntaxError unless expression
       PendingExpression.new(expression, [])
     end
 

data/lib/seeing_is_believing/{example_use.rb → print_results_next_to_lines.rb}

@@ -2,7 +2,7 @@ require 'seeing_is_believing'
 require 'seeing_is_believing/has_exception'
 
 class SeeingIsBelieving
-  class ExampleUse
+  class PrintResultsNextToLines
     include HasException
 
        STDOUT_PREFIX = '# >>'

data/lib/seeing_is_believing/result.rb

@@ -1,10 +1,29 @@
+require 'forwardable'
 require 'seeing_is_believing/has_exception'
 require 'seeing_is_believing/tracks_line_numbers_seen'
 
 class SeeingIsBelieving
   class Result
 
-    Line = Class.new(Array) { include HasException }
+    class Line
+      include HasException
+
+      extend Forwardable
+      def_delegators :@array, :[], :<<, :any?, :join, :to_ary, :to_a
+
+      def initialize
+        @array ||= []
+      end
+
+      def ==(ary_or_line)
+        if Array === ary_or_line
+          @array == ary_or_line
+        else
+          @array == ary_or_line &&
+            has_exception? == ary_or_line.has_exception?
+        end
+      end
+    end
 
     include HasException
     include TracksLineNumbersSeen
@@ -42,7 +61,7 @@ class SeeingIsBelieving
     # probably not really useful, just exists to satisfy the tests, which specified too simple of an interface
     def to_a
       (min_line_number..max_line_number).map do |line_number|
-        [line_number, [*self[line_number], *Array(self[line_number].exception)]]
+        [line_number, [*self[line_number].to_ary, *Array(self[line_number].exception)]]
       end
     end
 

data/lib/seeing_is_believing/the_matrix.rb

@@ -7,7 +7,6 @@ real_stderr = STDERR
 STDOUT = $stdout = fake_stdout = StringIO.new
 STDERR = $stderr = fake_stderr = StringIO.new
 
-require 'yaml'
 require 'seeing_is_believing/result'
 $seeing_is_believing_current_result = SeeingIsBelieving::Result.new
 
@@ -15,5 +14,5 @@ at_exit do
   $seeing_is_believing_current_result.stdout = fake_stdout.string
   $seeing_is_believing_current_result.stderr = fake_stderr.string
 
-  real_stdout.write YAML.dump $seeing_is_believing_current_result
+  real_stdout.write Marshal.dump $seeing_is_believing_current_result
 end

data/lib/seeing_is_believing/version.rb

@@ -1,3 +1,3 @@
 class SeeingIsBelieving
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/lib/seeing_is_believing.rb

@@ -57,7 +57,7 @@ class SeeingIsBelieving
     "begin;"\
       "#{code}\n"\
     "rescue Exception;"\
-      "line_number = $!.backtrace.first[/:\\d+:/][1..-2].to_i;"\
+      "line_number = $!.backtrace.grep(/\#{__FILE__}/).first[/:\\d+:/][1..-2].to_i;"\
       "$seeing_is_believing_current_result.record_exception line_number, $!;"\
     "end"
   end

data/spec/expression_list_spec.rb

@@ -131,4 +131,15 @@ describe SeeingIsBelieving::ExpressionList do
     stream.string.should include "GENERATED"
     stream.string.should include "REDUCED"
   end
+
+  # in reality, the problem may just lie with our lib
+  # but it should be correct in most cases
+  it 'Raises a syntax error if it cannot generate the expression' do
+    generations = ["'"]
+    expect do
+      described_class.new(
+        on_complete: -> { "" }, generator: -> { generations.shift }
+      ).call
+    end.to raise_error SyntaxError
+  end
 end

data/spec/seeing_is_believing_spec.rb

@@ -125,10 +125,11 @@ describe SeeingIsBelieving do
 
     result[3].should == []
     result.to_a.size.should == 3
+  end
 
-    pending 'Not sure how to force the backtrace to render' do
-      result.exception.backtrace.should be_a_kind_of Array
-    end
+  it 'records the backtrace on the errors' do
+    result = invoke("12\nraise Exception, 'omg!'\n12")
+    result.exception.backtrace.should be_a_kind_of Array
   end
 
   it 'does not fuck up __LINE__ macro' do
@@ -149,9 +150,8 @@ describe SeeingIsBelieving do
     values_for("def meth \n return 1 if true  \n end \n meth").should == [[], [], ['nil'], ['1']]
     values_for("def meth \n return 1 if false \n end \n meth").should == [[], [], ['nil'], ['nil']]
     values_for("-> {  \n return 1          \n }.call"        ).should == [[], [], ['1']]
-    pending "this doesn't work because the return detecting code is a very conservative regexp" do
-      values_for("-> { return 1 }.call"        ).should == [['1']]
-    end
+    # this doesn't work because the return detecting code is a very conservative regexp
+    # values_for("-> { return 1 }.call"        ).should == [['1']]
   end
 
   it 'does not affect its environment' do
@@ -201,6 +201,7 @@ describe SeeingIsBelieving do
     values_for("1+1\nDATA.read\n__END__\n....").should == [['2'], ['"...."']]
   end
 
-  # something about when the whole input is invalid
-  # something about multi-line strings
+  it 'raises a SyntaxError when the whole program is invalid' do
+    expect { invoke '"' }.to raise_error SyntaxError
+  end
 end

data/spec/syntax_analyzer_spec.rb

@@ -121,10 +121,12 @@ describe SeeingIsBelieving::SyntaxAnalyzer do
     will_return["o.return"].should be_false
     will_return[":return"].should be_false
     will_return["'return'"].should be_false
-    # will_return["'return\nreturn\nreturn'"].should be_false
     will_return["def a\nreturn 1\nend"].should be_false
     will_return["-> {\nreturn 1\n}"].should be_false
     will_return["Proc.new {\nreturn 1\n}"].should be_false
-    # will_return["return \\\n1"].should be_true
+    pending "this doesn't work because the return detecting code is an insufficient regexp" do
+      will_return["'return\nreturn\nreturn'"].should be_false
+      will_return["return \\\n1"].should be_true
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: seeing_is_believing
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-28 00:00:00.000000000 Z
+date: 2013-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70133565808080 !ruby/object:Gem::Requirement
+  requirement: &70333793492220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.12.0
   type: :development
   prerelease: false
-  version_requirements: *70133565808080
+  version_requirements: *70333793492220
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70133565807280 !ruby/object:Gem::Requirement
+  requirement: &70333793491440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.2.1
   type: :development
   prerelease: false
-  version_requirements: *70133565807280
+  version_requirements: *70333793491440
 - !ruby/object:Gem::Dependency
   name: ichannel
-  requirement: &70133565806600 !ruby/object:Gem::Requirement
+  requirement: &70333793490760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,7 @@ dependencies:
         version: 5.1.1
   type: :development
   prerelease: false
-  version_requirements: *70133565806600
+  version_requirements: *70333793490760
 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"
@@ -57,18 +57,21 @@ files:
 - .gitignore
 - Gemfile
 - Gemfile.lock
+- Rakefile
 - Readme.md
 - bin/seeing_is_believing
-- features/binary.feature
+- features/binary_errors.feature
+- features/binary_examples.feature
 - features/step_definitions/steps.rb
 - features/support/env.rb
 - lib/seeing_is_believing.rb
+- lib/seeing_is_believing/binary.rb
 - lib/seeing_is_believing/error.rb
 - lib/seeing_is_believing/evaluate_by_moving_files.rb
-- lib/seeing_is_believing/example_use.rb
 - lib/seeing_is_believing/expression_list.rb
 - lib/seeing_is_believing/hard_core_ensure.rb
 - lib/seeing_is_believing/has_exception.rb
+- lib/seeing_is_believing/print_results_next_to_lines.rb
 - lib/seeing_is_believing/result.rb
 - lib/seeing_is_believing/syntax_analyzer.rb
 - lib/seeing_is_believing/the_matrix.rb
@@ -105,7 +108,8 @@ signing_key:
 specification_version: 3
 summary: Records results of every line of code in your file
 test_files:
-- features/binary.feature
+- features/binary_errors.feature
+- features/binary_examples.feature
 - features/step_definitions/steps.rb
 - features/support/env.rb
 - spec/evaluate_by_moving_files_spec.rb