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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19acf5dae90b9e2cbad24fb2152392f3d22ab1f2
-  data.tar.gz: 8c9bc8df800a1289cd0997c392027351798cbee1
+  metadata.gz: 8715640842e97ae16fececb478cf4356169e1fdc
+  data.tar.gz: a2bfb634547740e23c0a71710a953496350fb2b0
 SHA512:
-  metadata.gz: d2198f2a94a2c5a570c087d8753feec78e71b08ac1b300d8e68cb4439e73111df75e1e610899853ccf33f205fc23330c65de0c9d19fbb24b4eba844f7ba6ce29
-  data.tar.gz: 0e5842837786d01d8d141c679b877074d0c4297059d1e2d80a7fc9f5d48a9e595b5c1be1ee0f3975b6edb70ffc995f97ba1be2076ae4154352c24818896505ac
+  metadata.gz: a4bbbaaa3640d0dd4b42051eb7416efb940af2b5b7a78df277c8047ec0a91e10b725e0c68a0d0ebf961d20583579ea231c1c2fd90504aded08ce81e20675b9e4
+  data.tar.gz: 319db0b7ee9047fa6c051659f8da8320f83828141e3e47e38448078f87720e7847c35e773ea50331684d644a70917129f0d2e91890aa535023472d797aa0a211

data/.gitignore

@@ -1,4 +1,19 @@
+# Transient test files
 proving_grounds/*
+
+# Don't accidentally commit gems generated from the source code
 *.gem
+
+# Since it's a gem, don't lock it down to specific versions
 Gemfile.lock
+
+# local notes about what I'm working on
 todo
+
+# Bundler stores its configuration information here
+.bundle
+
+# Where I'm vendoring gems for the standalone environment
+# Going with this location b/c Bundler winds up creating this dir anyway
+# to make `require "bundler/setup"` work
+bundle

data/.rspec

@@ -0,0 +1,4 @@
+--colour
+--fail-fast
+--require error_to_communicate/rspec_formatter
+--format WhatWeveGotHereIsAnErrorToCommunicate::RSpecFormatter

data/.travis.yml

@@ -1,5 +1,5 @@
 language: ruby
-script: rake
+script: rake ci
 rvm:
   - 1.9.3
   - 2.0.0

data/Rakefile

@@ -1,29 +1,39 @@
-desc 'run specs'
-task :spec do
-  sh 'rspec -cf d --fail-fast'
+require 'bundler'
+
+desc 'Have Bundler setup a standalone environment -- run tests in this, b/c its faster and safer'
+task :build do
+  # Running without rubygems  # http://myronmars.to/n/dev-blog/2012/03/faster-test-boot-times-with-bundler-standalone
+  sh 'bundle install --standalone --binstubs bundle/bin'
 end
 
-desc 'run cukes'
-task :cuke do
-  sh 'cucumber -t ~@not-implemented -t ~@wip'
+desc 'Remove generated and irrelevant files'
+task :clean do
+  rm_rf [
+    'bundle',
+    '.bundle',
+    'Gemfile.lock',
+    'proving_grounds',
+    *Dir['*.gem'],
+  ]
 end
 
-namespace :cuke do
-  desc 'Run work in progress cukes'
-  task :wip do
-    sh 'cucumber -t @wip'
-  end
+file :bundle do
+  $stderr.puts "\e[31mLooks like the gems aren\'t installed, run `rake build` to install them\e[39m"
+  exit 1
 end
 
-namespace :spec do
-  desc 'Run work in progress specs'
-  task :wip do
-    sh 'rspec -t wip'
-  end
+desc 'Run specs'
+task spec: :bundle do
+  sh 'ruby', '--disable-gem', *Bundler.load.specs.flat_map(&:full_require_paths).flat_map { |p| ['-I', p ] }, '-S', 'bundle/bin/rspec'
 end
 
-desc 'Run work in progress specs and cukes'
-task wip: ['spec:wip', 'cuke:wip']
+desc 'Run cukes'
+task cuke: :bundle do
+  sh 'ruby', '--disable-gem', *Bundler.load.specs.flat_map(&:full_require_paths).flat_map { |p| ['-I', p ] }, '-S', 'bundle/bin/cucumber', '--tags', '~@not-implemented'
+end
 
 desc 'Run all specs and cukes'
 task default: [:spec, :cuke]
+
+desc 'Install dependencies and run tests (mainly for Travis CI)'
+task ci: [:build, :spec, :cuke]

data/Readme.md

@@ -64,19 +64,25 @@ Currently requires Ruby 1.9 or 2.x
 Editor Integration
 ==================
 
-* [sublime-text-2-seeing-is-believing](https://github.com/JoshCheek/sublime-text-2-seeing-is-believing)
+* [Atom](https://github.com/JoshCheek/atom-seeing-is-believing) (prob has best installation instructions, overall best integration, but config and filesystem events are iffy)
+* [Sublime 2 and 3](https://github.com/JoshCheek/sublime-text-2-and-3-seeing-is-believing) (works reasonably, but isn't integrated with the package manager)
 * [TextMate 1](https://github.com/JoshCheek/text_mate_1-seeing-is_believing)
-* [TextMate 2](https://github.com/JoshCheek/text_mate_2-seeing-is_believing)
-* [vim-ruby-xmpfilter](https://github.com/t9md/vim-ruby-xmpfilter) (has support for `seeing_is_believing`)
+* [TextMate 2](https://github.com/JoshCheek/text_mate_2-seeing-is_believing) (TM2 is actually looking really nice these days -- Josh Cheek, 18 Feb 2015)
+
+Vim
+===
+
+I didn't write either of these, but they both support Seeing Is Beleiving. I've looked through the code, it works reasonably. One of them, I wound up having to edit the installed package, don't remember which.
+
+* [vim-ruby-xmpfilter](https://github.com/t9md/vim-ruby-xmpfilter)
 * [vim-seeing-is-believing](https://github.com/hwartig/vim-seeing-is-believing)
-* [atom-seeing-is-believing](https://github.com/JoshCheek/atom-seeing-is-believing) (prob has best installation instructions)
 
 Emacs Integration
 =================
 
 Add this function to your Emacs configuration:
 
-~~~~ scheme
+```scheme
 (defun seeing-is-believing ()
   "Replace the current region (or the whole buffer, if none) with the output
 of seeing_is_believing."
@@ -84,7 +90,7 @@ of seeing_is_believing."
   (let ((beg (if (region-active-p) (region-beginning) (point-min)))
         (end (if (region-active-p) (region-end) (point-max))))
     (shell-command-on-region beg end "seeing_is_believing" nil 'replace)))
-~~~~
+```
 
 You can now call `seeing-is-believing` to replace the current region
 or current buffer contents with the output of running it through
@@ -95,8 +101,8 @@ Known Issues
 
 * `begin; else; break; end` this code (an else without a resecue) will emit a warning in Ruby, and is omitted from `Parser`'s AST.
   As such, I doubt that anyone will ever write it. But if you were to write it, it would blow up, because SiB rewrites your code, wrapping every expression that could have a value.
-  This code will be wrapped. But using the value is syntactically invalid in Ruby, because it constitutes a "void value expression" (aka a nightmare for anyone working with code).
-  I can't easily check it to seee if it's void since it's not in the parsed AST.  But it's so edge taht I don't think it's worth worrying about.
+  This code will be wrapped. But using the value is **syntactically** invalid in Ruby, because it constitutes a "void value expression" (aka a pointless timesink and the cause of many bugs in SiB).
+  Unfortunately, I can't easily check it to seee if it's void since it's not in the parsed AST.  But it's so edge that I don't think it's worth worrying about.
 
 Version 2
 =========
@@ -109,11 +115,14 @@ Version 3
 These need to be done before release:
 
 * Add default to number of captures (1000), require user to explicitly set it to infinity
-* Update changelog with all changes
-* Push the event stream up to the top level so we can expose it via the interface.
-* Get it working on JRuby and Rbx
-* Order frog stickers
-* Figure out how to handle markers
+* Expose markers via the CLI
+* Spruce up editor integration
+  * Integrate with package managers where they are available
+  * Expose options to use the streaming API (update as events are seen)
+  * Ship with Traveling Ruby so that new users can just press a button and it works,
+    rather than having to figure out all the compmlex ecosystem around installing
+  * Would be nice to have real integration with Emacs
+  * Would be nice to support Ruby Mine
 
 Version 4
 =========

data/bin/seeing_is_believing

@@ -2,6 +2,5 @@
 
 $LOAD_PATH.unshift File.expand_path '../../lib', __FILE__
 
-gem 'parser', '~> 2.2.0.2'
 require 'seeing_is_believing/binary'
 exit SeeingIsBelieving::Binary.call(ARGV, $stdin, $stdout, $stderr)

data/features/errors.feature

@@ -69,10 +69,10 @@ Feature: Running the binary unsuccessfully
     And the exit status is 2
     And stdout is empty
 
-  Scenario: Passing unknown options
+  Scenario: Passing unknown flags
     Given the file "some_file" "1"
-    When I run "seeing_is_believing --unknown-option"
-    Then stderr is 'Error: --unknown-option is not an option, see the help screen (-h) for a list of options'
+    When I run "seeing_is_believing --unknown-flag"
+    Then stderr is 'Error: --unknown-flag is not a flag, see the help screen (-h) for a list of options'
     And the exit status is 2
     And stdout is empty
 

data/features/examples.feature

@@ -259,6 +259,71 @@ Feature: Running the binary successfully
     And the exit status is 0
 
 
+  @not-implemented
+  Scenario: Fork records data in parent and child, parent exec does not affect it.
+    Given the file "fork_exec_parent.rb":
+    """
+    :both
+    if fork #
+      :parent
+      exec 'echo', 'hello'
+    else
+      sleep 1
+      :child
+    end
+    :child
+
+    # >> hello
+    """
+    When I run "seeing_is_believing fork_exec_parent.rb"
+    Then stdout is:
+    """
+    :both                   # => :both
+    if fork #
+      :parent               # => :parent
+      exec 'echo', 'hello'
+    else
+      sleep 1               # => 1
+      :child                # => :child
+    end
+    :child                  # => :child
+
+    # >> hello
+    """
+
+  @not-implemented
+  Scenario: Fork records data in parent and child, child exec does not affect it.
+    Given the file "fork_exec_child.rb":
+    """
+    :both
+    if fork #
+      sleep 1
+      :parent
+    else
+      :child
+      exec 'echo', 'hello'
+    end
+    :parent
+
+    # >> hello
+    """
+    When I run "seeing_is_believing fork_exec_child.rb"
+    Then stdout is:
+    """
+    :both                   # => :both
+    if fork #
+      sleep 1               # => 1
+      :parent               # => :parent
+    else
+      :child                # => :child
+      exec 'echo', 'hello'
+    end
+    :parent                 # => :parent
+
+    # >> hello
+    """
+
+
   Scenario: Implicit regexp conditional
     Given the stdin content "abc"
     And the file "implicit_regex_conditional.rb":

data/features/flags.feature

@@ -509,3 +509,22 @@ Feature: Using flags
     """
     ["sib_version",{"value":"{{SeeingIsBelieving::VERSION}}"}]
     """
+
+  Scenario: --stream emits a timeout event and finishes successfully when the process times out.
+    When I run "seeing_is_believing -e 'loop { sleep 1 }' -t 0.01 --stream"
+    Then the exit status is 2
+    And stderr is "Timeout Error after 0.01 seconds!"
+    And stdout includes:
+    """
+    ["finished",{}]
+    """
+    And stdout includes:
+    """
+    ["timeout",{"seconds":0.01}]
+    """
+
+  Scenario: --ignore-unknown-flags prevents errors on unknown flags for forward compatibility
+    When I run "seeing_is_believing -e '1' --ignore-unknown-flags --zomg-wat"
+    Then the exit status is 0
+    And stderr is empty
+    And stdout is "1  # => 1"

data/lib/seeing_is_believing/binary.rb

@@ -40,7 +40,7 @@ class SeeingIsBelieving
       engine.evaluate!
 
       if engine.timed_out?
-        stderr.puts "Timeout Error after #{config.timeout_seconds} seconds!"
+        stderr.puts "Timeout Error after #{engine.timeout_seconds} seconds!"
         return NONDISPLAYABLE_ERROR_STATUS
       end
 

data/lib/seeing_is_believing/binary/align_chunk.rb

@@ -37,14 +37,6 @@ class SeeingIsBelieving
         end
       end
 
-      def trim_trailing_whitespace(line_nums_to_indexes)
-        line_nums_to_indexes.each do |num, indexes|
-          index_in_file = indexes[0]
-          num_to_trim   = amount_of_preceding_whitespace(index_in_file)
-          indexes.map! { |index| index - num_to_trim }
-        end
-      end
-
       def amount_of_preceding_whitespace(index_of_trailing_newline)
         index = index_of_trailing_newline - 1
         index -= 1 while 0 <= index && body[index] !~ /[\S\n]/

data/lib/seeing_is_believing/binary/commentable_lines.rb

@@ -42,18 +42,13 @@ class SeeingIsBelieving
       end
 
       def line_nums_to_last_index_and_col(buffer)
-        line_num_to_location = code.each_char
-                                   .with_index
-                                   .select { |char, index| char == "\n" } # <-- is this okay? what about other OSes?
-                                   .each_with_object(Hash.new) do |(_, index), hash|
-                                     line, col = buffer.decompose_position index
-                                     hash[line] = [index, col]
-                                   end
-        if code[code.size-1] != "\n" # account for the fact that the last line wouldn't have been found above if it doesn't end in a newline
-          line, col = buffer.decompose_position code.size
-          line_num_to_location[line] = [code.size, col]
-        end
-        line_num_to_location
+        code.each_char
+            .with_index
+            .select { |char, index| char == "\n" }
+            .each_with_object(Hash.new) do |(_, index), hash|
+              line, col = buffer.decompose_position index
+              hash[line] = [index, col]
+            end
       end
 
       def remove_lines_whose_newline_is_escaped(line_num_to_location)

data/lib/seeing_is_believing/binary/config.rb

@@ -29,6 +29,7 @@ class SeeingIsBelieving
       predicate(:inherit_exitstatus)    { false }
       predicate(:remove_value_prefixes) { true  }
       predicate(:debug)                 { false }
+      predicate(:ignore_unknown_flags)  { false }
       attribute(:body)                  { nil }
       attribute(:filename)              { nil }
       attribute(:errors)                { [] }
@@ -46,9 +47,10 @@ class SeeingIsBelieving
       end
 
       def parse_args(args)
-        as        = nil
-        filenames = []
-        args      = args.dup
+        args          = args.dup
+        as            = nil
+        filenames     = []
+        unknown_flags = []
 
         extract_positive_int_for = lambda do |flagname, &on_success|
           string = args.shift
@@ -92,6 +94,9 @@ class SeeingIsBelieving
           when '-v', '--version'
             self.print_version = true
 
+          when '--ignore-unknown-flags'
+            self.ignore_unknown_flags = true
+
           when '-x', '--xmpfilter-style'
             self.annotator                 = AnnotateMarkedLines
             self.lib_options.rewrite_code  = AnnotateMarkedLines.code_rewriter(markers)
@@ -194,7 +199,7 @@ class SeeingIsBelieving
             end
 
           when /^(-.|--.*)$/
-            add_error("#{arg} is not an option, see the help screen (-h) for a list of options")
+            unknown_flags << arg
 
           when /^-[^-]/
             args.unshift *arg.scan(/[^-]\+?/).map { |flag| "-#{flag}" }
@@ -204,6 +209,11 @@ class SeeingIsBelieving
           end
         end
 
+        unknown_flags.each do |flag|
+          break if ignore_unknown_flags?
+          add_error "#{flag} is not a flag, see the help screen (-h) for a list of options"
+        end
+
         filenames.size > 1 &&
           add_error("can only have one filename but found #{filenames.map(&:inspect).join ', '}")
 
@@ -264,13 +274,13 @@ Usage: seeing_is_believing [options] [filename]
 
 Notes:
 
-  * If no filename or program (-e flag) are provided, the program will read from standard input.
+  * If no filename or program (-e option) are provided, the program will read from standard input.
   * The process's stdin will be passed to the program unless the program body is on stdin.
   * The exit status will be:
     0 - No errors
     1 - Displayable error (e.g. code raises an exception while running)
     2 - Non-displayable error (e.g. a syntax error, a timeout)
-    n - The program's exit status if the --inherit-exitstatus flag is set
+    n - The program's exit status if the --inherit-exitstatus option is set
 
 Options:
   -d,  --line-length n           # max length of the entire line (only truncates results, not source lines)
@@ -296,6 +306,8 @@ Options:
   -j,  --json                    # print results in json format (i.e. so another program can consume them)
   -i,  --inherit-exitstatus      # exit with the exit status of the program being evaluated
        --stream                  # a JSON stream of every event ias it is seen (such as recording a line)
+       --ignore-unknown-flags    # don't error when flag is not in this list
+                                   allows integrating code to support compatibility with future versions of SiB
   -v,  --version                 # print the version (#{VERSION})
   -h,  --help                    # help screen without examples
   -h+, --help+                   # help screen with examples

data/lib/seeing_is_believing/binary/engine.rb

@@ -1,7 +1,7 @@
 require 'seeing_is_believing/code'
 require 'seeing_is_believing/binary/data_structures'
 require 'seeing_is_believing/binary/remove_annotations'
-require 'seeing_is_believing/event_stream/handlers/record_exitstatus'
+require 'seeing_is_believing/event_stream/handlers/record_exit_events'
 
 class SeeingIsBelieving
   module Binary
@@ -38,7 +38,7 @@ class SeeingIsBelieving
       def evaluate!
         @evaluated || begin
           SeeingIsBelieving.call normalized_cleaned_body,
-                                 config.lib_options.merge(event_handler: record_exitstatus)
+                                 config.lib_options.merge(event_handler: record_exit_events)
           @timed_out = false
           @evaluated = true
         end
@@ -50,7 +50,12 @@ class SeeingIsBelieving
 
       def timed_out?
         @evaluated || raise(MustEvaluateFirst.new __method__)
-        @timed_out
+        !!timeout_seconds
+      end
+
+      def timeout_seconds
+        @evaluated || raise(MustEvaluateFirst.new __method__)
+        record_exit_events.timeout_seconds
       end
 
       def result
@@ -71,7 +76,7 @@ class SeeingIsBelieving
 
       def exitstatus
         @evaluated || raise(MustEvaluateFirst.new __method__)
-        record_exitstatus.exitstatus
+        record_exit_events.exitstatus
       end
 
       private
@@ -86,8 +91,8 @@ class SeeingIsBelieving
         @code ||= Code.new(normalized_cleaned_body, config.filename)
       end
 
-      def record_exitstatus
-        @record_exitstatus ||= SeeingIsBelieving::EventStream::Handlers::RecordExitStatus.new config.lib_options.event_handler
+      def record_exit_events
+        @record_exit_events ||= SeeingIsBelieving::EventStream::Handlers::RecordExitEvents.new config.lib_options.event_handler
       end
 
       def normalized_cleaned_body