seeing_is_believing 3.0.0.beta.5 → 3.0.0.beta.6

data/spec/evaluate_by_moving_files_spec.rb

@@ -130,11 +130,24 @@ RSpec.describe SeeingIsBelieving::EvaluateByMovingFiles do
     expect(result.stdout).to eq %("b"\n)
   end
 
-  it 'can set a timeout' do
+  it 'must provide an event handler, which receives the process\'s events' do
+    # raises error
+    expect { described_class.new("", filename, {}) }
+      .to raise_error ArgumentError, /event_handler/
+
+    # sees all the events
+    seen = []
+    invoke '1', event_handler: lambda { |e| seen << e }
+    expect(seen).to_not be_empty
+    expect(seen.last).to eq SeeingIsBelieving::EventStream::Events::Finished.new
+  end
+
+  it 'can set a timeout, which KILL interrupts the process and then waits for the events to finish' do
     expect(Timeout).to receive(:timeout).with(123).and_raise(Timeout::Error)
-    expect(Process).to receive(:kill)
-    expect { expect(invoke('p gets', timeout_seconds: 123).stdout).to eq %("a"\n) }
-      .to raise_error Timeout::Error
+    expect(Process).to receive(:kill).with("KILL", an_instance_of(Fixnum))
+    result = invoke 'p gets', timeout_seconds: 123
+    expect(result.timeout?).to eq true
+    expect(result.timeout_seconds).to eq 123
   end
 
   it 'raises an ArgumentError if given arguments it doesn\'t know' do

data/spec/event_stream_spec.rb

@@ -106,19 +106,30 @@ module SeeingIsBelieving::EventStream
         expect(consumer.call.value).to eq "a� å"          # space just so its easier to see
       end
 
+      it 'scrubs any invalid bytes to "�" when encoding was already UTF8, but was invalid' do
+        producer.record_sib_version("\xff√")
+        expect(consumer.call.value).to eq "�√"
+      end
+
       it 'raises NoMoreEvents if input is closed before it finishes reading the number of requested inputs' do
         finish!
         expect { consumer.call 10 }.to raise_error SeeingIsBelieving::NoMoreEvents
       end
 
-      it 'raises NoMoreEvents once it its input streams are all closed and its seen the exit status' do
+      it 'raises NoMoreEvents once its input streams are all closed and its seen an exit status' do
         close_streams eventstream_producer, stdout_producer, stderr_producer
-        producer.finish!
         consumer.process_exitstatus 0
         consumer.each { }
         expect { consumer.call }.to raise_error SeeingIsBelieving::NoMoreEvents
       end
 
+      it 'raises NoMoreEvents once its input streams are all closed and its seen a timeout' do
+        close_streams eventstream_producer, stdout_producer, stderr_producer
+        consumer.process_timeout 1
+        consumer.each { }
+        expect { consumer.call }.to raise_error SeeingIsBelieving::NoMoreEvents
+      end
+
       it 'gracefully handles its side of the streams getting closed' do
         close_streams eventstream_consumer, stdout_consumer, stderr_consumer
         consumer.process_exitstatus 0
@@ -383,14 +394,15 @@ module SeeingIsBelieving::EventStream
                          backtrace_filename: __FILE__
       end
 
-      example 'Example: Common edge case: name error' do
-        backtrace_line  = record_exception(99) { not_a_local_or_meth }
-        backtrace_frame = 1 # b/c this one will get caught by rspec's method missing
+      example 'Example: Common edge case: name error', t:true do
+        backtrace_line  = record_exception(99) { BasicObject.new.instance_eval { not_a_local_or_meth } }
+        backtrace_frame = 0
+        backtrace_frame += 1 if defined? Rubinius # their method missing goes into the kernel
         assert_exception consumer.call,
                          recorded_line_no:   99,
                          class_name_matcher: /^NameError$/,
                          message_matcher:    /\bnot_a_local_or_meth\b/,
-                         backtrace_index:    1,
+                         backtrace_index:    backtrace_frame,
                          backtrace_line:     backtrace_line,
                          backtrace_filename: __FILE__
       end
@@ -579,13 +591,25 @@ module SeeingIsBelieving::EventStream
         expect(consumer.call).to eq Events::Exitstatus.new(value: 92)
       end
 
-      it 'emits a Finished event when all streams are closed and it has the exit status' do
-        finish!
-        event_classes = consumer.each.map(&:class)
-        expect(event_classes).to include Events::Finished
+      it 'emits a Finished event when all streams are closed and it has an exit status' do
+        consumer.process_exitstatus 1
+        close_streams eventstream_producer, stdout_producer, stderr_producer
+        expect(consumer.each.to_a.last).to eq Events::Finished.new
+      end
+
+      it 'emits a Timeout event on process_timeout' do
+        consumer.process_timeout 1.23
+        expect(consumer.call).to eq Events::Timeout.new(seconds:1.23)
+      end
+
+      it 'emits a Finished event when all streams are closed and it has a timeout' do
+        consumer.process_timeout 1
+        close_streams eventstream_producer, stdout_producer, stderr_producer
+        expect(consumer.each.to_a.last).to eq Events::Finished.new
       end
     end
 
+
     describe Events do
       specify 'Event raises an error if .event_name was not overridden' do
         expect { Event.event_name }.to raise_error NotImplementedError
@@ -600,6 +624,7 @@ module SeeingIsBelieving::EventStream
           [Events::SiBVersion       , :sib_version],
           [Events::RubyVersion      , :ruby_version],
           [Events::Exitstatus       , :exitstatus],
+          [Events::Timeout          , :timeout],
           [Events::Exec             , :exec],
           [Events::ResultsTruncated , :results_truncated],
           [Events::LineResult       , :line_result],
@@ -691,5 +716,15 @@ module SeeingIsBelieving::EventStream
         end
       end
     end
+
+    # most tests are just in the sense that fkn everything uses it all over the place
+    # but they use the valid cases, so this is just hitting the invalid one
+    require 'seeing_is_believing/event_stream/handlers/update_result'
+    describe Handlers::UpdateResult do
+      it 'raises an error if it sees an event it doesn\'t know' do
+        expect { described_class.new(double :result).call("unknown event") }
+          .to raise_error /unknown event/
+      end
+    end
   end
 end

data/spec/seeing_is_believing_spec.rb

@@ -62,11 +62,11 @@ RSpec.describe SeeingIsBelieving do
     expect(result.filename).to eq 'abc.rb'
   end
 
-  it 'makes the Ruby versino info available' do
+  it 'makes the Ruby version info available' do
     expect(invoke('').ruby_version).to eq RUBY_VERSION
   end
 
-  it 'allows uers to pass in their own inspection recorder' do
+  it 'allows users to pass in their own rewrite_code' do
     wrapper = lambda { |program|
       SeeingIsBelieving::WrapExpressions.call program,
         before_each: -> * { '(' },
@@ -348,8 +348,14 @@ RSpec.describe SeeingIsBelieving do
                                                                      ['6']]
   end
 
-  it 'times out if the timeout limit is exceeded' do
-    expect { invoke "sleep 0.2", timeout_seconds: 0.1 }.to raise_error Timeout::Error
+  it 'records the timeouts on the result' do
+    result = invoke "1"
+    expect(result).to_not be_timeout
+    expect(result.timeout_seconds).to eq nil
+
+    result = invoke "sleep 0.2", timeout_seconds: 0.1
+    expect(result).to be_timeout
+    expect(result.timeout_seconds).to eq 0.1
   end
 
   it 'records the exit status' do
@@ -546,4 +552,23 @@ RSpec.describe SeeingIsBelieving do
       expect(invoke('exec "ruby", "-e", "exit 5"').exitstatus).to eq 5
     end
   end
+
+  # Looked through the implementation of event_stream/producer to find a list of core behaviour it depends on
+  # this is a list of things to check that it can work without.
+  # based on this issue: https://github.com/JoshCheek/seeing_is_believing/issues/55
+  describe 'it works even in hostile environments' do
+    specify 'when IO does not have sync, <<, and flush'
+    specify 'when Queue does not have <<, shift, and clear'
+    specify 'when Symbol does not have ==, to_s, inspect'
+    specify 'when String does not have ==, to_s, inspect, to_i'
+    specify 'when Fixnum does not have <, next, =='
+    specify 'when Hash does not have [], []='
+    specify 'when Array does not have pack, <<, to_ary, grep, first, [], []='
+    specify 'when Marshal does not have dump'
+    specify 'when Kernel does not have defined?, kind_of?'
+    specify 'when SystemExit does not have status'
+    specify 'when Enumerable does not have map'
+    specify 'when Exception does not have status'
+    specify 'when Thread does not have new, join'
+  end
 end

data/spec/wrap_expressions_spec.rb

@@ -83,6 +83,12 @@ RSpec.describe SeeingIsBelieving::WrapExpressions do
         expect(heredoc_wrap "<<A.size <<B\nA\nB").to eq "[{<<A.size <<B}]\nA\nB"
         expect(heredoc_wrap "<<A.size(<<B)\nA\nB").to eq "[{<<A.size(<<B)}]\nA\nB"
       end
+
+      example 'heredocs withs spaces in the delimiter' do
+        expect(heredoc_wrap "<<'a b'\n1\na b").to eq "[{<<'a b'}]\n1\na b"
+        expect(heredoc_wrap "<<'a b'\n1\na b\n1").to eq "[{<<'a b'}\n1\na b\n{1}]"
+        expect(heredoc_wrap '<<"a b"'+"\n1\na b").to eq '[{<<"a b"}]'+"\n1\na b"
+      end
     end
 
     it 'identifies the last line of the body' do
@@ -885,7 +891,6 @@ RSpec.describe SeeingIsBelieving::WrapExpressions do
         expect(wrap("a b:1, **c")).to eq "<a b:1, **c>"
         expect(wrap("{\na:1,\n**b\n}")).to eq "<{\na:<1>,\n**<b>\n}>"
         expect(wrap("a(b:1,\n **c\n)")).to eq "<a(b:<1>,\n **<c>\n)>"
-        pending 'Fixed this in Parser, but it\'s not released yet https://github.com/whitequark/parser/commit/aeb95c776d11e212ed95b92c69e96d1cccdb6424'
         expect(wrap("def a(*, **)\n1\nend")).to eq "<def a(*, **)\n<1>\nend>"
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seeing_is_believing
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta.5
+  version: 3.0.0.beta.6
 platform: ruby
 authors:
 - Josh Cheek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-17 00:00:00.000000000 Z
+date: 2015-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.0.2
+        version: 2.2.0.3
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
@@ -26,10 +26,24 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.0.2
+        version: 2.2.0.3
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: what_weve_got_here_is_an_error_to_communicate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: haiti
   requirement: !ruby/object:Gem::Requirement
@@ -70,14 +84,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
@@ -117,8 +131,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".travis.yml"
-- Changelog.md
 - Gemfile
 - Rakefile
 - Readme.md
@@ -156,7 +170,7 @@ files:
 - lib/seeing_is_believing/event_stream/consumer.rb
 - lib/seeing_is_believing/event_stream/events.rb
 - lib/seeing_is_believing/event_stream/handlers/debug.rb
-- lib/seeing_is_believing/event_stream/handlers/record_exitstatus.rb
+- lib/seeing_is_believing/event_stream/handlers/record_exit_events.rb
 - lib/seeing_is_believing/event_stream/handlers/stream_json_events.rb
 - lib/seeing_is_believing/event_stream/handlers/update_result.rb
 - lib/seeing_is_believing/event_stream/producer.rb
@@ -246,7 +260,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: seeing_is_believing
-rubygems_version: 2.4.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Records results of every line of code in your file
@@ -276,4 +290,3 @@ test_files:
 - spec/seeing_is_believing_spec.rb
 - spec/spec_helper.rb
 - spec/wrap_expressions_spec.rb
-has_rdoc: 

data/Changelog.md

@@ -1,33 +0,0 @@
-# Change Log
-All notable changes to this project will be documented in this file.
-The Changelog was introduced on 2014-09-15, and is approximately in
-accordance with [http://keepachangelog.com/](http://keepachangelog.com/).
-I do my best to follow [Semantic Versioning](http://semver.org/).
-
-## 3.0.0.beta - 2014-??-??
-### Added
-- Issue for 3.0 is at https://github.com/JoshCheek/seeing_is_believing/issues/47
-- Added a [Changelog](Changelog.md) in accordance with [http://keepachangelog.com/](http://keepachangelog.com/)
-- `seeing_is_believing/version` is required by default,
-  you can now check your version by just typing `SeeingIsBelieving::VERSION` and running it.
-
-### Changed
-- Communication between SiB and the process running the code is no longer done by
-  serializing the result with JSON. Now, there is an
-  [EventStream](https://github.com/JoshCheek/seeing_is_believing/blob/4b9134ca45e001ebe5f139384bd1beee98b5e371/lib/seeing_is_believing/event_stream.rb)
-  class, which will send the information back to the parent process as soon as it
-  knows about it. For users who interact purely with the binary, this just means that
-  JSON will not already be required.
-- WrapExpressions' `before_all` and `after_all` keys now point to values that are lambdas with no args.
-  Mostly this is for consistency since `before_each` and `after_each` are lambas,
-  But also, because at some point I might want to provide an argument, and this will make it easier.
-  And because it allows certain conveniences, such as setting local vars in the lambda.
-- Loosened version constraints on parser dependency
-- When you iterate over the result, it iterates over a result for each line of the file
-  rather than the number of lines it actually captured.
-- The `--JSON` flag emits a different structure
-
-### Removed
-- Dependency on psych
-- Remove HasException module. The only thing using it now is Result, so just relevant behaviour into there.
-- SeeingIsBelieving::Line class

data/lib/seeing_is_believing/event_stream/handlers/record_exitstatus.rb

@@ -1,18 +0,0 @@
-class SeeingIsBelieving
-  module EventStream
-    module Handlers
-      class RecordExitStatus
-        attr_reader :exitstatus
-
-        def initialize(next_observer)
-          @next_observer = next_observer
-        end
-
-        def call(event)
-          @exitstatus = event.value if event.event_name == :exitstatus
-          @next_observer.call(event)
-        end
-      end
-    end
-  end
-end