seeing_is_believing 3.0.0.beta.7 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 866178b03727394e7c24c5cfbaa48ea4edbca4e1
-  data.tar.gz: cfe4540e781ec9aa65b79a950d8760058136a85d
+  metadata.gz: c0318721dea2259939dac9f239eaf465f9a7d605
+  data.tar.gz: a9c3681770369df1da596a736c266ff51624603e
 SHA512:
-  metadata.gz: 514947858dab6b669eeb25f8b729e330d9435b438f2821073a56a12226451710a54f775415591e56c8673d071e276c102ec7ca001f4f6f2ce03fe9d2f1282b7b
-  data.tar.gz: 341dea9e96e9e1c57565254830f5f22648bcd2b9363d492b1a8718dddc54e30861c449d5374f3822e7ef7c88ce89ea107c79e5049c7e216a35a88c3b8440f735
+  metadata.gz: 06109b5b546f05c712f17d3856fb5faf8e41579a00758dd3fe05a4bec5dd12028a532c6429529db257a15aebfe4bee5a574999f714f0ac2e22ab1986eafc267c
+  data.tar.gz: 12f47cae8b1613713ec81bc66a7156d89ed15a967b8c1b3a54af4bdc520cb25541bf2327cadf452eef2da14f4cf35ec4cd103c4718a3319ecbd1bdc035e076a4

data/.travis.yml

@@ -1,9 +1,8 @@
 language: ruby
-install: gem install bundler && bundle install --standalone --binstubs bundle/bin
+before_install: gem install bundler
+install: rake install
 script: bundle exec rake ci
 rvm:
-  - 1.9.3
-  - 2.0.0
   - 2.1.2
   - 2.2.0
-  - 2.3.0
+  - 2.3.1

data/Gemfile

@@ -1,2 +1,3 @@
 source 'http://rubygems.org'
 gemspec
+gem 'pry'

data/Rakefile

@@ -1,9 +1,14 @@
-require 'bundler'
-
 desc 'Have Bundler setup a standalone environment -- run tests in this, b/c its faster and safer'
 task :install 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'
+  `which bundle`
+  unless $?.success?
+    sh 'gem', 'install', 'bundler'
+  end
+
+  unless Dir.exist? 'bundle'
+    # 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
 end
 
 desc 'Remove generated and irrelevant files'
@@ -24,12 +29,19 @@ 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/mrspec'
+  require 'bundler'
+  sh 'ruby', '--disable-gem',
+             *Bundler.load.specs.flat_map(&:full_require_paths).flat_map { |p| ['-I', p ] },
+             '-S', 'bundle/bin/mrspec'
 end
 
 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'
+  require 'bundler'
+  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'

data/Readme.md

@@ -6,17 +6,34 @@ Seeing Is Believing
 
 Evaluates Ruby code, recording the results of each line.
 Integrates with any extensible editor (I've integrated it with many already, see [the list](https://github.com/JoshCheek/seeing_is_believing#editor-integration)).
+If you like Swift Playgrounds, you'll like SiB.
 
 ![example](https://s3.amazonaws.com/josh.cheek/images/scratch/sib-example1.gif)
 
 Watch a [longer video](http://vimeo.com/73866851).
 
-Works in Ruby 1.9, 2.0, 2.1, 2.2, rubinius (I **think**, need to make better tests), still trying to get it working with Jruby.
+
+Install
+=======
+
+Requires Ruby >= 2.1
+
+```sh
+$ gem install seeing_is_believing
+```
+
+Verify the install with
+
+```sh
+$ seeing_is_believing -e '1 + 1'
+1 + 1  # => 2
+```
+
 
 Use The Binary
 ==============
 
-`cat simple_example.rb`
+Given the file `simple_example.rb`
 
 ```ruby
 5.times do |i|
@@ -24,25 +41,29 @@ Use The Binary
 end
 ```
 
-`seeing_is_believing simple_example.rb`
+`$ seeing_is_believing simple_example.rb` will print:
+
 ```ruby
+
 5.times do |i|  # => 5
   i * 2         # => 0, 2, 4, 6, 8
 end             # => 5
 ```
 
+
 Use The Lib
 ===========
 
 ```ruby
 require 'seeing_is_believing'
-believer = SeeingIsBelieving.new("[:a, :b, :c].each do |i|
+
+# There are a lot of options you can pass here, including a custom handler
+handler = SeeingIsBelieving.call("[:a, :b, :c].each do |i|
                                     i.upcase
                                   end")
+result = handler.result
 
-result = believer.call # => #<SIB::Result @results={1=>#<SIB:Line["[:a, :b, :c]"] no exception>, 2=>#<SIB:Line[":A", ":B", ":C"] no exception>, 3=>#<SIB:Line["[:a, :b, :c]"] no exception>}\n  @stdout=""\n  @stderr=""\n  @exitstatus=0\n  @bug_in_sib=nil>
-
-result[2]            # => #<SIB:Line[":A", ":B", ":C"] no exception>
+result[2]            # => [":A", ":B", ":C"]
 result[2][0]         # => ":A"
 result[2][1]         # => ":B"
 result[2][2]         # => ":C"
@@ -53,12 +74,6 @@ result.stderr    # => ""
 result.exception # => nil
 ```
 
-Install
-=======
-
-Currently requires Ruby 1.9 or 2.x
-
-    $ gem install seeing_is_believing
 
 
 Editor Integration
@@ -69,20 +84,44 @@ Editor Integration
 * [TextMate 1](https://github.com/JoshCheek/text_mate_1-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 Believing. 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.
+These packages support SiB:
 
-* [vim-ruby-xmpfilter](https://github.com/t9md/vim-ruby-xmpfilter)
 * [vim-seeing-is-believing](https://github.com/hwartig/vim-seeing-is-believing)
+* [vim-ruby-xmpfilter](https://github.com/t9md/vim-ruby-xmpfilter)
+
+Personally, I had difficulty with them, but this configuration has gotten me pretty far:
+
+```viml
+" ===== Seeing Is Believing =====
+" Assumes you have a Ruby with SiB available in the PATH
+" If it doesn't work, you may need to `gem install seeing_is_believing -v 3.0.0.beta.6`
+" ...yeah, current release is a beta, which won't auto-install
+
+" Annotate every line
+  nmap <leader>b :%!seeing_is_believing --timeout 12 --line-length 500 --number-of-captures 300 --alignment-strategy chunk<CR>;
+" Annotate marked lines
+  nmap <leader>n :%.!seeing_is_believing --timeout 12 --line-length 500 --number-of-captures 300 --alignment-strategy chunk --xmpfilter-style<CR>;
+" Remove annotations
+  nmap <leader>c :%.!seeing_is_believing --clean<CR>;
+" Mark the current line for annotation
+  nmap <leader>m A # => <Esc>
+" Mark the highlighted lines for annotation
+  vmap <leader>m :norm A # => <Esc>
+```
+
 
 Emacs Integration
-=================
+-----------------
 
 You can use my friend's configuration [file](https://github.com/jcinnamond/seeing-is-believing).
+You can see him use it in [this](http://brightonruby.com/2016/the-point-of-objects-john-cinnamond/?utm_source=rubyweekly&utm_medium=email)
+presentation at 10 minutes.
 
-Or, adding this function to your Emacs configuration will get you pretty far:
+Alternatively, adding this function to your Emacs configuration will get you pretty far:
 
 ```scheme
 (defun seeing-is-believing ()
@@ -100,6 +139,13 @@ You can now call `seeing-is-believing` to replace the current region
 or current buffer contents with the output of running it through
 `seeing_is_believing`.
 
+
+Features
+========
+
+Check the [features](features) directory.
+
+
 Known Issues
 ============
 
@@ -108,15 +154,22 @@ Known Issues
   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
-=========
+Setting up Development
+======================
 
-Feature complete, I'll fix bugs in it until version 3 is released, though
+* Make sure you have Ruby (I use [chruby](https://github.com/postmodern/chruby) and [ruby-install](https://github.com/postmodern/ruby-install) for this).
+* Make sure you have bundler and rake (`gem install bundler rake`)
+* Fork the repo (there's a button on Github)
+* Clone your fork (`git clone git@github.com:YOUR_GITHUB_NAME/seeing_is_believing.git`)
+* Install the dependencies (`rake install`) This approach is painful, but it means the test suite is like 30s instead of 5min.
+* Get a list of rake tasks (`rake -T`)
+* Run the full test suite (`rake`)
+* Run the rspec tests `bundle exec rspec` from here you can pass options you want, such as a tag for the tests you're interested in.
+* Run the Cucumber tests `bundle exec cucumber` (these literally invoke the executable, as a user would)
 
-Version 3
-=========
 
-These need to be done before release:
+Some stuff that might happen one day
+====================================
 
 * Add default to number of captures (1000), require user to explicitly set it to infinity
 * Expose markers via the CLI
@@ -127,10 +180,6 @@ These need to be done before release:
     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
-=========
-
 * How about if begin/rescue/end was able to record the result on the rescue section
 * How about if you could configure which kinds of results you were interested in
   (e.g. turn on/off recording of method definitions, and other results)
@@ -145,6 +194,8 @@ Version 4
   Could have fallback strategies, so e.g. `-s min=40,fallback=line`
 * Package Ruby with the editor downloads so that they don't require you to know so fkn much to set it up.
 * Allow user to set marker
+* Maybe rename xmpfilter style, not many people know what that is, so the name doesn't help users
+
 
 Inspiration
 ===========
@@ -153,10 +204,6 @@ Inspiration
 * Bret Victor's completely inspiring talk [Inventing on Principle](https://www.youtube.com/watch?v=PUv66718DII).
 * My 8th Light mentor, [Doug Bradbury](http://blog.8thlight.com/doug-bradbury/archive.html) who asked me to make it for his Kids Ruby sessions (I don't think we ever finished integrating it, though >.<)
 
-Interestingly, [Swift playground](https://www.youtube.com/watch?v=oY6nQS3MiF8&t=25m51s)
-are very similar (though better integrated since they cerce you into using xcode).
-Released about a year and a half before them, but maybe I should take advantage of
-their marketing anyway: Swift Playgrounds for Ruby!! :P
 
 Shout outs
 ==========

data/features/examples.feature

@@ -258,8 +258,6 @@ 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":
     """
@@ -268,7 +266,7 @@ Feature: Running the binary successfully
       :parent
       exec 'echo', 'hello'
     else
-      sleep 1
+      sleep 1 #
       :child
     end
     :child
@@ -283,15 +281,14 @@ Feature: Running the binary successfully
       :parent               # => :parent
       exec 'echo', 'hello'
     else
-      sleep 1               # => 1
+      sleep 1 #
       :child                # => :child
-    end
+    end                     # => :child
     :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":
     """
@@ -317,7 +314,7 @@ Feature: Running the binary successfully
     else
       :child                # => :child
       exec 'echo', 'hello'
-    end
+    end                     # => :parent
     :parent                 # => :parent
 
     # >> hello

data/lib/seeing_is_believing/binary/config.rb

@@ -123,7 +123,12 @@ class SeeingIsBelieving
             self.help_screen = Binary.help_screen_extended(markers)
 
           when '-g', '--debug'
-            self.debug                = true
+            self.debug = true
+
+          when '--debug-to'
+            next_arg.call arg, "a filename" do |filename|
+              self.debug = filename
+            end
 
           when '-d', '--line-length'
             extract_positive_int_for.call arg do |n|
@@ -237,10 +242,14 @@ class SeeingIsBelieving
           lib_options.event_handler = EventStream::Handlers::StreamJsonEvents.new(stdout)
         end
 
-        if debug?
-          self.debugger             = Debugger.new stream: stderr, colour: true
-          self.lib_options.debugger = debugger
+        case debug
+        when String
+          debug_file    = File.open(debug, 'a').tap { |f| f.sync = true }
+          self.debugger = Debugger.new stream: debug_file, colour: false
+        when true
+          self.debugger = Debugger.new stream: stderr, colour: stderr.tty?
         end
+        self.lib_options.debugger = debugger
 
         if filename && body
           add_error("Cannot give a program body and a filename to get the program body from.")

data/lib/seeing_is_believing/evaluate_by_moving_files.rb

@@ -11,6 +11,7 @@
 # read the wrong file... of course, since we rewrite the file,
 # its body will be incorrect, anyway.
 
+require 'rbconfig'
 require 'timeout'
 require 'seeing_is_believing/error'
 require 'seeing_is_believing/result'
@@ -74,9 +75,11 @@ class SeeingIsBelieving
     end
 
     def set_back_to_initial_conditions
-      @was_backed_up ?
-        File.rename(backup_filename, filename) :
+      if @was_backed_up
+        File.rename(backup_filename, filename)
+      else
         File.delete(filename)
+      end
     end
 
     def write_program_to_file
@@ -97,32 +100,33 @@ class SeeingIsBelieving
       # setup environment variables
       env = ENV.to_hash.merge 'SIB_VARIABLES.MARSHAL.B64' =>
                                 [Marshal.dump(
-                                  event_stream_fd:   child_eventstream.to_i,
+                                  event_stream_fd:   4,
                                   max_line_captures: max_line_captures,
                                   num_lines:         program.lines.count,
                                   filename:          filename
                                 )].pack('m0')
 
       # evaluate the code in a child process
-      opts = { in:                  child_stdin,
-               out:                 child_stdout,
-               err:                 child_stderr,
-               child_eventstream => child_eventstream }
-      child = Process.detach Kernel.spawn(env, *popen_args, opts)
+      opts = {
+        4 =>    child_eventstream,
+        in:     child_stdin,
+        out:    child_stdout,
+        err:    child_stderr,
+        pgroup: true, # run it in its own process group so we can SIGINT the whole group
+      }
+      child_pid  = Kernel.spawn(env, *popen_args, opts)
+      child_pgid = Process.getpgid(child_pid)
 
       # close child streams b/c they won't emit EOF
       # until both child and parent references are closed
-      child_eventstream.close
-      child_stdout.close
-      child_stderr.close
-      child_stdin.close
+      close_streams(child_eventstream, child_stdout, child_stderr, child_stdin)
       stdin.sync = true
 
-      # send stdin
-      Thread.new {
+      # send stdin (char at a time b/c input could come from a stream)
+      Thread.new do
         provided_input.each_char { |char| stdin.write char }
         stdin.close
-      }
+      end
 
       # set up the event consumer
       consumer = EventStream::Consumer.new(events: eventstream, stdout: stdout, stderr: stderr)
@@ -130,16 +134,17 @@ class SeeingIsBelieving
 
       # wait for completion
       Timeout.timeout timeout_seconds do
-        exitstatus = child.value.exitstatus
-        consumer.process_exitstatus exitstatus
+        Process.wait child_pid
+        consumer.process_exitstatus($?.exitstatus)
         consumer_thread.join
       end
     rescue Timeout::Error
-      Process.kill "KILL", child.pid
       consumer.process_timeout timeout_seconds
-      consumer_thread.join # finish consuming events
     ensure
-      [stdin, stdout, stderr, eventstream].each { |io| io.close unless io.closed? }
+      allow_error(Errno::ESRCH)  { Process.kill "-INT", child_pgid } # negative makes it apply to the group
+      allow_error(Errno::ECHILD) { Process.wait child_pid } # I can't tell if this actually works, or just creates enough of a delay for the OS to finish cleaning up the thread
+      consumer_thread.join
+      close_streams(stdin, stdout, stderr, eventstream)
     end
 
     def popen_args
@@ -151,5 +156,14 @@ class SeeingIsBelieving
          *require_flags,                            # users can inject files to be required
          filename]
     end
+
+    def allow_error(error)
+      yield
+    rescue error
+    end
+
+    def close_streams(*streams)
+      streams.each { |io| io.close unless io.closed? }
+    end
   end
 end