seeing_is_believing 0.0.7 → 0.0.8

data/Readme.md

@@ -64,15 +64,6 @@ result[2]   # => ['"A"', '"B"', '"C"']
 Install
 =======
 
-For now, since Rubygems is not allowing pushes:
-
-    $ git clone https://github.com/JoshCheek/seeing_is_believing/
-    $ cd seeing_is_believing
-    $ gem build seeing_is_believing.gemspec
-    $ gem install seeing_is_believing-0.0.7.gem
-    $ cd ..
-    $ rm -rf "./seeing_is_believing"
-
 When Rubygems gets back up:
 
     $ gem install seeing_is_believing
@@ -81,6 +72,15 @@ Or if you haven't fixed your gem home, and you aren't using any version managers
 
     $ sudo gem install seeing_is_believing
 
+Rubygems is allowing pushes again, but if it goes back down, you can install like this:
+
+    $ git clone https://github.com/JoshCheek/seeing_is_believing/
+    $ cd seeing_is_believing
+    $ gem build seeing_is_believing.gemspec
+    $ gem install seeing_is_believing-0.0.8.gem
+    $ cd ..
+    $ rm -rf "./seeing_is_believing"
+
 Hook it into TextMate
 =====================
 
@@ -97,9 +97,9 @@ It should look like this:
 Known Issues
 ============
 
-* There are expressions which continue on the next line even though the previous line is a valid expression, e.g. "3\n.times { |i| i }" which will blow up. This is a fundamental flaw in the algorithm and will either require a smarter algorithm, or some sort of more sophisticated parsing in order to handle correctly
-* `BEGIN/END` breaks things and I probably won't take the time to fix it, becuase it's nontrivial, but there is currently a cuke for it
+* `BEGIN/END` breaks things and I probably won't take the time to fix it, becuase it's nontrivial and its really meant for command-line scripts, but there is currently a cuke for it
 * Heredocs aren't recorded. It might actually be possible if the ExpressionList were to get smarter
+* Return statements are dealt with poorly, causing some situations where you could capture and display a value to not capture
 
 License
 =======

data/features/binary_examples.feature

@@ -35,6 +35,9 @@ Feature: Running the binary successfully
     <<HERE
     is a doc
     HERE
+
+    [*1..10]
+      .select(&:even?)
     """
     When I run "seeing_is_believing basic_functionality.rb"
     Then stderr is empty
@@ -42,16 +45,16 @@ Feature: Running the binary successfully
     And stdout is:
     """
     5.times do |i|
-      i * 2         # => 0, 2, 4, 6, 8
-    end             # => 5
+      i * 2             # => 0, 2, 4, 6, 8
+    end                 # => 5
 
     def meth(n)
-      n             # => "12", "34"
-    end             # => nil
+      n                 # => "12", "34"
+    end                 # => nil
 
     # some invocations
-    meth "12"       # => "12"
-    meth "34"       # => "34"
+    meth "12"           # => "12"
+    meth "34"           # => "34"
 
     =begin
     I don't ever actually write
@@ -61,12 +64,15 @@ Feature: Running the binary successfully
     # multilinezzz
     "a
      b
-     c"             # => "a\n b\n c"
+     c"                 # => "a\n b\n c"
 
     # don't record heredocs b/c they're just too fucking different
     <<HERE
     is a doc
     HERE
+
+    [*1..10]
+      .select(&:even?)  # => [2, 4, 6, 8, 10]
     """
 
   Scenario: Passing previous output back into input

data/lib/seeing_is_believing.rb

@@ -20,7 +20,7 @@ class SeeingIsBelieving
   def call
     @memoized_result ||= begin
       program = ''
-      program << expression_list.call until eof? || data_segment?
+      program << expression_list.call until peek_next_line.nil? || data_segment?
       program = record_exceptions_in program
       program << "\n" << the_rest_of_the_stream if data_segment?
       result_for program, min_line_number, max_line_number
@@ -32,8 +32,9 @@ class SeeingIsBelieving
   attr_reader :stream
 
   def expression_list
-    @expression_list ||= ExpressionList.new generator:   lambda { get_next_line },
-                                            on_complete: lambda { |line, children, completions, line_number|
+    @expression_list ||= ExpressionList.new get_next_line:  lambda { get_next_line },
+                                            peek_next_line: lambda { peek_next_line },
+                                            on_complete:    lambda { |line, children, completions, line_number|
                                               track_line_number line_number
                                               expression = [line, *children, *completions].map(&:chomp).join("\n")
                                               if do_not_record? expression

data/lib/seeing_is_believing/expression_list.rb

@@ -16,11 +16,12 @@ class SeeingIsBelieving
     end
 
     def initialize(options)
-      self.debug_stream = options.fetch :debug_stream, $stdout
-      self.should_debug = options.fetch :debug, false
-      self.generator    = options.fetch :generator
-      self.on_complete  = options.fetch :on_complete
-      @line_number      = 0
+      self.debug_stream   = options.fetch :debug_stream, $stdout
+      self.should_debug   = options.fetch :debug, false
+      self.get_next_line  = options.fetch :get_next_line
+      self.peek_next_line = options.fetch :peek_next_line
+      self.on_complete    = options.fetch :on_complete
+      @line_number        = 0
     end
 
     def call
@@ -30,22 +31,30 @@ class SeeingIsBelieving
         pending_expression = generate
         debug { "GENERATED: #{pending_expression.expression.inspect}, ADDING IT TO #{inspected_expressions expressions}" }
         expressions << pending_expression
-        expression = reduce expressions
+        expression = reduce expressions unless next_line_modifies_current?
       end until expressions.empty?
       expression
     end
 
     private
 
-    attr_accessor :debug_stream, :should_debug, :generator, :on_complete, :expressions
+    attr_accessor :debug_stream, :should_debug, :get_next_line, :peek_next_line, :on_complete, :expressions
 
     def generate
       @line_number += 1
-      expression = generator.call
+      expression = get_next_line.call
       raise SyntaxError unless expression
       PendingExpression.new(expression, [])
     end
 
+    def next_line_modifies_current?
+      # method invocations can be put on the next line, and begin with a dot.
+      # I think that's the only case we need to worry about. e.g:
+      # 3
+      #  .times { |i| p i }
+      peek_next_line.call && peek_next_line.call =~ /^\s*\./
+    end
+
     def inspected_expressions(expressions)
       "[#{expressions.map { |pe| pe.inspect debug? }.join(', ')}]"
     end

data/lib/seeing_is_believing/version.rb

@@ -1,3 +1,3 @@
 class SeeingIsBelieving
-  VERSION = '0.0.7'
+  VERSION = '0.0.8'
 end

data/spec/expression_list_spec.rb

@@ -2,9 +2,16 @@ require 'seeing_is_believing/expression_list'
 
 describe SeeingIsBelieving::ExpressionList do
 
+  def list_for(generations, options={}, &block)
+    described_class.new({
+      on_complete:    block,
+      get_next_line:  -> { generations.shift || raise("EMPTY!") },
+      peek_next_line: -> { generations.first },
+    }.merge(options))
+  end
+
   def call(generations, options={}, &block)
-    options = { on_complete: block, generator: -> { generations.shift || raise("EMPTY!") } }.merge(options)
-    described_class.new(options).call
+    list_for(generations, options, &block).call
   end
 
   example 'example: multiple children' do
@@ -146,6 +153,24 @@ describe SeeingIsBelieving::ExpressionList do
     end
   end
 
+  example "example: method invocations on next line" do
+    # example 1: consume the expression with lines after
+    list = list_for ['a', '.b', ' .c', 'irrelevant'] do |*expressions, line_number|
+      line_number.should == 3
+      expressions.flatten.join('').should == 'a.b .c'
+      'a.b.c'
+    end
+    list.call.should == 'a.b.c'
+
+    # example 2: consume the expression with no lines after
+    list = list_for ['a', '.b'] do |*expressions, line_number|
+      line_number.should == 2
+      expressions.flatten.join('').should == 'a.b'
+      'result'
+    end
+    list.call.should == 'result'
+  end
+
   example "example: smoke test debug option" do
     stream = StringIO.new
     call(%w[a+ b], debug: true, debug_stream: stream) { |*expressions, _| expressions.join("\n") }
@@ -159,7 +184,9 @@ describe SeeingIsBelieving::ExpressionList do
     generations = ["'"]
     expect do
       described_class.new(
-        on_complete: -> { "" }, generator: -> { generations.shift }
+        on_complete:    -> { "" },
+        get_next_line:  -> { generations.shift },
+        peek_next_line: -> { generations.first }
       ).call
     end.to raise_error SyntaxError
   end

data/spec/seeing_is_believing_spec.rb

@@ -226,4 +226,9 @@ describe SeeingIsBelieving do
   it 'defaults the stdin stream to an empty string' do
     invoke('$stdin.read')[1].should == ['""']
   end
+
+  it 'can deal with methods that are invoked entirely on the next line', wip:true do
+    values_for("1\n.even?").should == [[], ['false']]
+    values_for("1\n.even?\n__END__").should == [[], ['false']]
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: seeing_is_believing
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2013-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70192747454180 !ruby/object:Gem::Requirement
+  requirement: &70138255056540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 10.0.3
   type: :development
   prerelease: false
-  version_requirements: *70192747454180
+  version_requirements: *70138255056540
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70192747453400 !ruby/object:Gem::Requirement
+  requirement: &70138255055760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 2.12.0
   type: :development
   prerelease: false
-  version_requirements: *70192747453400
+  version_requirements: *70138255055760
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70192747452720 !ruby/object:Gem::Requirement
+  requirement: &70138255055080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.2.1
   type: :development
   prerelease: false
-  version_requirements: *70192747452720
+  version_requirements: *70138255055080
 - !ruby/object:Gem::Dependency
   name: ichannel
-  requirement: &70192747452260 !ruby/object:Gem::Requirement
+  requirement: &70138255054620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +54,7 @@ dependencies:
         version: 5.1.1
   type: :development
   prerelease: false
-  version_requirements: *70192747452260
+  version_requirements: *70138255054620
 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"