seeing_is_believing 0.0.11 → 0.0.13

data/Readme.md

@@ -88,15 +88,23 @@ TextMate Integration
 Go to the bundle editor, create this new command in the Ruby bundle:
 
 ```shell
-"${TM_RUBY}" -r seeing_is_believing/binary -e '
-  SeeingIsBelieving::Binary.new(ARGV, $stdin, $stdout, $stderr).call
-'  $TM_FILEPATH 2>/dev/null
+if [ -z "$TM_FILEPATH" ]; then
+  "${TM_RUBY}" -S seeing_is_believing -Ku --result-length 200
+else
+  "${TM_RUBY}" -S seeing_is_believing -Ku --result-length 200 --as "$TM_FILEPATH"
+fi
 ```
 
 It should look like this:
 
 ![textmate-integration][textmate-integration]
 
+I also recommend a second command for cleaning the output:
+
+```shell
+"${TM_RUBY}" -S seeing_is_believing -Ku --clean
+```
+
 Emacs Integration
 =================
 

data/features/flags.feature

@@ -177,6 +177,60 @@ Feature: Using flags
     'ç'  # => "ç"
     """
 
+  Scenario: --as and stdin
+    Given the file "example.rb" "1+1"
+    Given I have the stdin content:
+    """
+    1+1
+    __FILE__
+    """
+    When I run "seeing_is_believing --as example.rb"
+    Then stderr is empty
+    Then the exit status is 0
+    And stdout is:
+    """
+    1+1       # => 2
+    __FILE__  # => "example.rb"
+    """
+
+  Scenario: --as and -e
+    Given the file "example.rb" "1+1"
+    When I run 'seeing_is_believing --as example.rb -e "__FILE__"'
+    Then stderr is empty
+    And the exit status is 0
+    And stdout is '__FILE__  # => "example.rb"'
+
+  Scenario: --clean
+    Given the file "example.rb":
+    """
+    1 + 1  # => not 2
+    2 + 2  # ~> Exception, something
+
+
+    # >> some stdout output
+
+    # !> some stderr output
+    __END__
+    1
+    """
+    When I run "seeing_is_believing --clean example.rb"
+    Then stderr is empty
+    And the exit status is 0
+    And stdout is:
+    """
+    1 + 1
+    2 + 2
+
+    __END__
+    1
+    """
+
+  Scenario: --clean on an invalid file will clean
+    When I run 'seeing_is_believing --clean -e "1+  # => lkj"'
+    Then stderr is empty
+    And the exit status is 0
+    And stdout is '1+'
+
   Scenario: --help
     When I run "seeing_is_believing --help"
     Then stderr is empty

data/features/step_definitions/steps.rb

@@ -1,35 +1,11 @@
-Given 'the file "$filename":' do |filename, body|
-  CommandLineHelpers.write_file filename, body
-end
-
-Given 'the file "$filename" "$body"' do |filename, body|
-  CommandLineHelpers.write_file filename, body
-end
-
-Given 'I have the stdin content "$content"' do |content|
-  @stdin_data = content
-end
-
-When 'I run "$command"' do |command|
-  @last_executed = CommandLineHelpers.execute command, @stdin_data
-end
-
-Then /^(stderr|stdout) is:$/ do |stream_name, output|
-  @last_executed.send(stream_name).chomp.should == eval_curlies(output)
-end
-
-Then /^(stderr|stdout) is "(.*?)"$/ do |stream_name, output|
-  @last_executed.send(stream_name).chomp.should == eval_curlies(output)
-end
-
-Then 'the exit status is $status' do |status|
-  @last_executed.exitstatus.to_s.should == status
-end
-
-Then /^(stderr|stdout) is empty$/ do |stream_name|
-  @last_executed.send(stream_name).should == ''
-end
-
-Then /^(stderr|stdout) includes "([^"]*)"$/ do |stream_name, content|
-  @last_executed.send(stream_name).should include content
-end
+Given('the file "$filename" "$body"')        { |filename, body|       CommandLineHelpers.write_file filename, body }
+Given('the file "$filename":')               { |filename, body|       CommandLineHelpers.write_file filename, body }
+Given('I have the stdin content "$content"') { |content|              @stdin_data = content }
+Given('I have the stdin content:')           { |content|              @stdin_data = content }
+When('I run "$command"')                     { |command|              @last_executed = CommandLineHelpers.execute command, @stdin_data }
+When("I run '$command'")                     { |command|              @last_executed = CommandLineHelpers.execute command, @stdin_data }
+Then(/^(stderr|stdout) is:$/)                { |stream_name, output|  @last_executed.send(stream_name).chomp.should == output }
+Then(/^(stderr|stdout) is ["'](.*?)["']$/)   { |stream_name, output|  @last_executed.send(stream_name).chomp.should == output }
+Then(/^(stderr|stdout) is empty$/)           { |stream_name|          @last_executed.send(stream_name).should == '' }
+Then(/^(stderr|stdout) includes "([^"]*)"$/) { |stream_name, content| @last_executed.send(stream_name).should include content }
+Then('the exit status is $status')           { |status|               @last_executed.exitstatus.to_s.should == status }

data/lib/seeing_is_believing/binary.rb

@@ -15,11 +15,12 @@ class SeeingIsBelieving
     end
 
     def call
-      @exitstatus ||= if    flags_have_errors?          then print_errors       ; 1
-                      elsif should_print_help?          then print_help         ; 0
-                      elsif has_filename? && file_dne?  then print_file_dne     ; 1
-                      elsif invalid_syntax?             then print_syntax_error ; 1
-                      else                                   print_program      ; (results.has_exception? ? 1 : 0)
+      @exitstatus ||= if    flags_have_errors?          then print_errors          ; 1
+                      elsif should_print_help?          then print_help            ; 0
+                      elsif has_filename? && file_dne?  then print_file_dne        ; 1
+                      elsif should_clean?               then print_cleaned_program ; 0
+                      elsif invalid_syntax?             then print_syntax_error    ; 1
+                      else                                   print_program         ; (results.has_exception? ? 1 : 0)
                       end
     end
 
@@ -31,14 +32,14 @@ class SeeingIsBelieving
       flags[:filename]
     end
 
-    def body
+    def cleaned_body
       @body ||= PrintResultsNextToLines.remove_previous_output_from \
         flags[:program] || (file_is_on_stdin? && stdin.read) || File.read(flags[:filename])
     end
 
     def results
-      @results ||= SeeingIsBelieving.call body,
-                                          filename:  flags[:filename],
+      @results ||= SeeingIsBelieving.call cleaned_body,
+                                          filename:  (flags[:as] || flags[:filename]),
                                           require:   flags[:require],
                                           load_path: flags[:load_path],
                                           encoding:  flags[:encoding],
@@ -46,7 +47,7 @@ class SeeingIsBelieving
     end
 
     def printer
-      @printer ||= PrintResultsNextToLines.new body, results, flags
+      @printer ||= PrintResultsNextToLines.new cleaned_body, results, flags
     end
 
     def flags
@@ -86,7 +87,7 @@ class SeeingIsBelieving
     end
 
     def syntax_error_notice
-      out, err, syntax_status = Open3.capture3 'ruby', '-c', stdin_data: body
+      out, err, syntax_status = Open3.capture3 'ruby', '-c', stdin_data: cleaned_body
       return err unless syntax_status.success?
     end
 
@@ -98,5 +99,12 @@ class SeeingIsBelieving
       stderr.puts syntax_error_notice
     end
 
+    def should_clean?
+      flags[:clean]
+    end
+
+    def print_cleaned_program
+      stdout.print cleaned_body
+    end
   end
 end

data/lib/seeing_is_believing/binary/arg_parser.rb

@@ -17,13 +17,16 @@ class SeeingIsBelieving
           until args.empty?
             case (arg = args.shift)
             when '-h', '--help'          then options[:help] = self.class.help_screen
+            when '-c', '--clean'         then options[:clean] = true
             when '-l', '--start-line'    then extract_positive_int_for :start_line,    arg
             when '-L', '--end-line'      then extract_positive_int_for :end_line,      arg
             when '-d', '--line-length'   then extract_positive_int_for :line_length,   arg
             when '-D', '--result-length' then extract_positive_int_for :result_length, arg
-            when '-r', '--require'       then next_arg("#{arg} expected a filename but did not see one")                  { |filename| options[:require]   << filename }
-            when '-I', '--load-path'     then next_arg("#{arg} expected a directory but did not see one")                 { |dir|      options[:load_path] << dir }
-            when '-e', '--program'       then next_arg("#{arg} expects a program as the following argument")              { |program|  options[:program]  = program }
+            when '-r', '--require'       then next_arg("#{arg} expected a filename as the following argument but did not see one")  { |filename| options[:require]   << filename }
+            when '-I', '--load-path'     then next_arg("#{arg} expected a directory as the following argument but did not see one") { |dir|      options[:load_path] << dir }
+            when '-e', '--program'       then next_arg("#{arg} expected a program as the following argument but did not see one")   { |program|  options[:program]   = program }
+            when '-a', '--as'            then next_arg("#{arg} expected a filename as the following argument but did not see one")  { |filename| options[:as]        = filename }
+            when /\A-K(.+)/              then options[:encoding] = $1
             when '-K', '--encoding'      then next_arg("#{arg} expects an encoding, see `man ruby` for possibile values") { |encoding| options[:encoding] = encoding }
             when /^-/                    then options[:errors] << "Unknown option: #{arg.inspect}" # unknown flags
             else
@@ -54,13 +57,14 @@ class SeeingIsBelieving
 
       def options
         @options ||= {
+          clean:         false,
           program:       nil,
           filename:      nil,
-          errors:        [],
           start_line:    1,
           line_length:   Float::INFINITY,
           end_line:      Float::INFINITY,
           result_length: Float::INFINITY,
+          errors:        [],
           require:       [],
           load_path:     [],
         }
@@ -90,13 +94,17 @@ Usage: #{$0} [options] [filename]
 
   If no filename is provided, the binary will read the program from standard input.
 
-  -l, --start-line    # line number to begin showing results on
-  -L, --end-line      # line number to stop showing results on
-  -d, --line-length   # max length of the entire line (only truncates results, not source lines)
-  -D, --result-length # max length of the portion after the "# => "
-  -r, --require       # additional files to be required before running the program
-  -e, --program       # Pass the program to execute as an argument
-  -h, --help          # this help screen
+  -l, --start-line n      # line number to begin showing results on
+  -L, --end-line n        # line number to stop showing results on
+  -d, --line-length n     # max length of the entire line (only truncates results, not source lines)
+  -D, --result-length n   # max length of the portion after the "# => "
+  -I, --load-path dir     # a dir that should be added to the $LOAD_PATH
+  -r, --require file      # additional files to be required before running the program
+  -e, --program program   # Pass the program to execute as an argument
+  -K, --encoding encoding # sets file encoding, equivalent to Ruby's -Kx (see `man ruby` for valid values)
+  -a, --as filename       # run the program as if it was the specified filename
+  -c, --clean             # remove annotations from previous runs of seeing_is_believing
+  -h, --help              # this help screen
 HELP_SCREEN
     end
   end

data/lib/seeing_is_believing/evaluate_by_moving_files.rb

@@ -49,7 +49,7 @@ class SeeingIsBelieving
           end
         },
         ensure: -> {
-          restore_backup
+          set_back_to_initial_conditions
         }
     end
 
@@ -75,9 +75,12 @@ class SeeingIsBelieving
       @was_backed_up = true
     end
 
-    def restore_backup
-      return unless @was_backed_up
-      FileUtils.mv temp_filename, filename
+    def set_back_to_initial_conditions
+      if @was_backed_up
+        FileUtils.mv temp_filename, filename
+      else
+        FileUtils.rm filename
+      end
     end
 
     def write_program_to_file

data/lib/seeing_is_believing/version.rb

@@ -1,3 +1,3 @@
 class SeeingIsBelieving
-  VERSION = '0.0.11'
+  VERSION = '0.0.13'
 end

data/spec/arg_parser_spec.rb

@@ -41,8 +41,8 @@ describe SeeingIsBelieving::Binary::ArgParser do
   end
 
   specify 'unknown options set an error' do
-    parse(['--abc']).should have_error 'Unknown option: "--abc"'
-    parse(['-a']).should have_error 'Unknown option: "-a"'
+    parse(['--xyz']).should have_error 'Unknown option: "--xyz"'
+    parse(['-x']).should have_error 'Unknown option: "-x"'
   end
 
   example 'example: multiple args' do
@@ -206,10 +206,42 @@ describe SeeingIsBelieving::Binary::ArgParser do
       parse(%w[--encoding u])[:encoding].should == 'u'
     end
 
+    specify 'with -K, the argument can be placed immediately after it (e.g. -Ku) because Ruby allows this' do
+      parse(['-Ku'])[:encoding].should == 'u'
+      parse(['-Ku']).should_not have_error /-K/
+    end
+
     it 'sets an error if not provided with an encoding' do
       parse(['-K']).should have_error /-K/
       parse(['--encoding']).should have_error /--encoding/
     end
   end
+
+  describe ':as' do
+    it 'defaults to nil' do
+      parse([])[:as].should be_nil
+    end
+
+    it 'can be set with -a and --as' do
+      parse(%w[-a   abc])[:as].should == 'abc'
+      parse(%w[--as abc])[:as].should == 'abc'
+    end
+
+    it 'sets an error if not provided with a filename' do
+      parse(%w[-a]).should have_error /-a/
+      parse(%w[--as]).should have_error /--as/
+    end
+  end
+
+  describe ':clean' do
+    it 'defaults to false' do
+      parse([])[:clean].should == false
+    end
+
+    it 'can be set with -c and --clean' do
+      parse(%w[-c])[:clean].should == true
+      parse(%w[--clean])[:clean].should == true
+    end
+  end
 end
 

data/spec/evaluate_by_moving_files_spec.rb

@@ -63,6 +63,24 @@ describe SeeingIsBelieving::EvaluateByMovingFiles do
     evaluator.call
   end
 
+  it 'uses HardCoreEnsure to delete the file if it wrote it where one did not previously exist' do
+    evaluator = described_class.new 'PROGRAM', filename, error_stream: StringIO.new
+    FileUtils.rm_rf filename
+    SeeingIsBelieving::HardCoreEnsure.should_receive(:call) do |options|
+      # initial state
+      File.exist?(filename).should == false
+
+      # after code
+      options[:code].call rescue nil
+      File.read(filename).should == 'PROGRAM'
+
+      # after ensure
+      options[:ensure].call
+      File.exist?(filename).should == false
+    end
+    evaluator.call
+  end
+
   it 'can require files' do
     other_filename1 = File.join filedir, 'other1.rb'
     other_filename2 = File.join filedir, 'other2.rb'

data/spec/queue_spec.rb

@@ -53,7 +53,7 @@ describe SeeingIsBelieving::Queue do
   end
 
   describe 'conditional iteration' do
-    it 'will iterate while a condition is met' do
+    it 'can iterate while a condition is met' do
       queue = queue_for *1..5
       seen = []
       queue.while { |arg| arg < 4 }.each { |arg| seen << arg }
@@ -61,7 +61,7 @@ describe SeeingIsBelieving::Queue do
       queue.peek.should == 4
     end
 
-    it 'will iterate until a condition is met' do
+    it 'can iterate until a condition is met' do
       queue = queue_for *1..5
       seen = []
       queue.until { |arg| arg == 4 }.each { |arg| seen << arg }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: seeing_is_believing
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.13
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2013-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70217249132080 !ruby/object:Gem::Requirement
+  requirement: &70333554807460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 10.0.3
   type: :development
   prerelease: false
-  version_requirements: *70217249132080
+  version_requirements: *70333554807460
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70217249131460 !ruby/object:Gem::Requirement
+  requirement: &70333554806960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 2.12.0
   type: :development
   prerelease: false
-  version_requirements: *70217249131460
+  version_requirements: *70333554806960
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70217249130620 !ruby/object:Gem::Requirement
+  requirement: &70333554806500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.2.1
   type: :development
   prerelease: false
-  version_requirements: *70217249130620
+  version_requirements: *70333554806500
 - !ruby/object:Gem::Dependency
   name: ichannel
-  requirement: &70217249129100 !ruby/object:Gem::Requirement
+  requirement: &70333554806040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +54,7 @@ dependencies:
         version: 5.1.1
   type: :development
   prerelease: false
-  version_requirements: *70217249129100
+  version_requirements: *70333554806040
 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"