seeing_is_believing 0.0.19 → 0.0.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c10c0902071eb7d3040e445ffe14eb65b4add43d
-  data.tar.gz: db2421790aa48eb53f3f4e79168392835e1a52c4
+  metadata.gz: c9ba8a14985e629d8a7aa7f9f850bbbe9b720563
+  data.tar.gz: 562f431d621620445ab1387c8a20f781f0cfb26c
 SHA512:
-  metadata.gz: 2fe36a0cfefd4b0c7f378094e9ffc8f3f5324a1ab9c370c47beee66abf45811e2b6af9a919c9d84abb3470e6629cfb866372745ff8b70cbeb1aacdddaac0fae3
-  data.tar.gz: 36ff482a6a34c232276633d8193665f20ec3fdbe29310d7d6cee9a5195c4e08781d450e4e79bf4575daa6e41d88514aa823130ceb4ed2482801b2dd7daea285e
+  metadata.gz: b1c475f28d6b6125acdcd00c42393a623d72f3a89fa07b31619b484fa18e427bbdce098386e23ab3d4add181be07ed513aa5b4caeb41e48ff002e4f130520cb6
+  data.tar.gz: 61fd93446e41d472e1d4afd745e7d5bd981af84c7bf139154fec8dfcf5416330374f87e91759be6f21c64f369d60c0628f1f055e359cf7377167d99cc7e3a921

data/.gitignore

@@ -1,2 +1,3 @@
 proving_grounds/*
 *.gem
+Gemfile.lock

data/features/errors.feature

@@ -5,7 +5,6 @@ Feature: Running the binary unsuccessfully
 
   # show that it displalys next to the first place in the file
   # and should maybe print the stacktrace at the bottom
-  @wip
   Scenario: Raising exceptions
     Given the file "raises_exception.rb":
     """
@@ -30,7 +29,7 @@ Feature: Running the binary unsuccessfully
     """
     def first_defined
       second_defined
-    end                                    # => nil
+    end                # => nil
 
     def second_defined
       require_relative 'raises_exception'  # ~> RuntimeError: ZOMG!
@@ -46,26 +45,26 @@ Feature: Running the binary unsuccessfully
     """
     When I run "seeing_is_believing invalid_syntax.rb"
     Then stderr includes "1: unterminated string meets end of file"
-    And the exit status is 1
+    And the exit status is 2
     And stdout is empty
 
   Scenario: Passing a nonexistent file
     When I run "seeing_is_believing this_file_does_not_exist.rb"
     Then stderr is "this_file_does_not_exist.rb does not exist!"
-    And the exit status is 1
+    And the exit status is 2
     And stdout is empty
 
   Scenario: Passing unknown options
     Given the file "some_file" "1"
     When I run "seeing_is_believing --unknown-option"
     Then stderr is 'Unknown option: "--unknown-option"'
-    And the exit status is 1
+    And the exit status is 2
     And stdout is empty
 
   Scenario: Passing an unknown option with a value but forgetting the filename
     When I run "seeing_is_believing --unknown-option some-value"
     Then stderr is 'Unknown option: "--unknown-option"'
-    And the exit status is 1
+    And the exit status is 2
     And stdout is empty
 
   Scenario: Stack overflow

data/features/examples.feature

@@ -64,16 +64,16 @@ Feature: Running the binary successfully
     """
     # iteration
     5.times do |i|
-      i * 2                 # => 0, 2, 4, 6, 8
-    end                     # => 5
+      i * 2         # => 0, 2, 4, 6, 8
+    end             # => 5
 
     # method and invocations
     def meth(n)
-      n                     # => "12", "34"
-    end                     # => nil
+      n          # => "12", "34"
+    end          # => nil
 
-    meth "12"               # => "12"
-    meth "34"               # => "34"
+    meth "12"  # => "12"
+    meth "34"  # => "34"
 
     # block style comments
     =begin
@@ -83,9 +83,9 @@ Feature: Running the binary successfully
 
     # multilinezzz
     "a
-     b"                     # => "a\n b"
+     b"   # => "a\n b"
     /a
-     b/x                    # => /a\n b/x
+     b/x  # => /a\n b/x
 
     # don't record heredocs b/c they're just too fucking different
     <<HERE
@@ -94,7 +94,7 @@ Feature: Running the binary successfully
 
     # method invocation that occurs entirely on the next line
     [*1..10]
-      .select(&:even?)      # => [2, 4, 6, 8, 10]
+      .select(&:even?)  # => [2, 4, 6, 8, 10]
 
     # mutliple levels of nesting
     class User
@@ -103,12 +103,12 @@ Feature: Running the binary successfully
       end                   # => nil
 
       def name
-        @name               # => "Josh", "Rick"
-      end                   # => nil
-    end                     # => nil
+        @name   # => "Josh", "Rick"
+      end       # => nil
+    end         # => nil
 
-    User.new("Josh").name   # => "Josh"
-    User.new("Rick").name   # => "Rick"
+    User.new("Josh").name  # => "Josh"
+    User.new("Rick").name  # => "Rick"
     """
 
   Scenario: Passing previous output back into input

data/features/flags.feature

@@ -9,7 +9,7 @@ Feature: Using flags
     2
     3
     """
-    When I run "seeing_is_believing --start-line 2 start_line.rb"
+    When I run "seeing_is_believing -s file --start-line 2 start_line.rb"
     Then stderr is empty
     And the exit status is 0
     And stdout is:
@@ -18,6 +18,20 @@ Feature: Using flags
     2  # => 2
     3  # => 3
     """
+    When I run "seeing_is_believing -s chunk --start-line 2 start_line.rb"
+    Then stdout is:
+    """
+    1 + 1
+    2  # => 2
+    3  # => 3
+    """
+    When I run "seeing_is_believing -s line --start-line 2 start_line.rb"
+    Then stdout is:
+    """
+    1 + 1
+    2  # => 2
+    3  # => 3
+    """
 
   Scenario: --end-line
     Given the file "end_line.rb":
@@ -26,7 +40,7 @@ Feature: Using flags
     2
     3 + 3
     """
-    When I run "seeing_is_believing --end-line 2 end_line.rb"
+    When I run "seeing_is_believing -s file --end-line 2 end_line.rb"
     Then stderr is empty
     And the exit status is 0
     And stdout is:
@@ -35,6 +49,20 @@ Feature: Using flags
     2  # => 2
     3 + 3
     """
+    When I run "seeing_is_believing -s chunk --end-line 2 end_line.rb"
+    Then stdout is:
+    """
+    1  # => 1
+    2  # => 2
+    3 + 3
+    """
+    When I run "seeing_is_believing -s line --end-line 2 end_line.rb"
+    Then stdout is:
+    """
+    1  # => 1
+    2  # => 2
+    3 + 3
+    """
 
   Scenario: --start-line and --end-line
     Given the file "start_and_end_line.rb":
@@ -44,7 +72,7 @@ Feature: Using flags
     3
     4 + 4
     """
-    When I run "seeing_is_believing --start-line 2 --end-line 3 start_and_end_line.rb"
+    When I run "seeing_is_believing -s file --start-line 2 --end-line 3 start_and_end_line.rb"
     Then stderr is empty
     And the exit status is 0
     And stdout is:
@@ -54,6 +82,22 @@ Feature: Using flags
     3  # => 3
     4 + 4
     """
+    When I run "seeing_is_believing -s chunk --start-line 2 --end-line 3 start_and_end_line.rb"
+    Then stdout is:
+    """
+    1 + 1
+    2  # => 2
+    3  # => 3
+    4 + 4
+    """
+    When I run "seeing_is_believing -s line --start-line 2 --end-line 3 start_and_end_line.rb"
+    Then stdout is:
+    """
+    1 + 1
+    2  # => 2
+    3  # => 3
+    4 + 4
+    """
 
   Scenario: --result-length sets the length of the portion including and after the # =>
     Given the file "result_lengths.rb":
@@ -68,7 +112,7 @@ Feature: Using flags
 
     raise        "a"*100
     """
-    When I run "seeing_is_believing --result-length 10 result_lengths.rb"
+    When I run "seeing_is_believing -s file --result-length 10 result_lengths.rb"
     Then stderr is empty
     And stdout is:
     """
@@ -98,7 +142,7 @@ Feature: Using flags
 
     raise        "a"*100
     """
-    When I run "seeing_is_believing --line-length 32 line_lengths.rb"
+    When I run "seeing_is_believing -s file --line-length 32 line_lengths.rb"
     Then stderr is empty
     And stdout is:
     """
@@ -247,7 +291,7 @@ Feature: Using flags
     Given the file "example.rb" "sleep 1"
     When I run "seeing_is_believing --timeout 0.1 example.rb"
     Then stdout is empty
-    And the exit status is 1
+    And the exit status is 2
     And stderr is "Timeout Error after 0.1 seconds!"
 
   Scenario: --timeout

data/lib/seeing_is_believing/binary.rb

@@ -6,6 +6,10 @@ require 'timeout'
 
 class SeeingIsBelieving
   class Binary
+    SUCCESS_STATUS              = 0
+    DISPLAYABLE_ERROR_STATUS    = 1 # e.g. there was an error, but the output is legit (we can display exceptions)
+    NONDISPLAYABLE_ERROR_STATUS = 2 # e.g. an error like incorrect invocation or syntax that can't be displayed in the input program
+
     attr_accessor :argv, :stdin, :stdout, :stderr, :timeout_error
 
     def initialize(argv, stdin, stdout, stderr)
@@ -16,14 +20,16 @@ class SeeingIsBelieving
     end
 
     def call
-      @exitstatus ||= if    flags_have_errors?          then print_errors          ; 1
-                      elsif should_print_help?          then print_help            ; 0
-                      elsif should_print_version?       then print_version         ; 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
-                      elsif program_timedout?           then print_timeout_error   ; 1
-                      else                                   print_program         ; (results.has_exception? ? 1 : 0)
+      @exitstatus ||= if    flags_have_errors?          then print_errors          ; NONDISPLAYABLE_ERROR_STATUS
+                      elsif should_print_help?          then print_help            ; SUCCESS_STATUS
+                      elsif should_print_version?       then print_version         ; SUCCESS_STATUS
+                      elsif has_filename? && file_dne?  then print_file_dne        ; NONDISPLAYABLE_ERROR_STATUS
+                      elsif should_clean?               then print_cleaned_program ; SUCCESS_STATUS
+                      elsif invalid_syntax?             then print_syntax_error    ; NONDISPLAYABLE_ERROR_STATUS
+                      elsif program_timedout?           then print_timeout_error   ; NONDISPLAYABLE_ERROR_STATUS
+                      else                                   print_program         ; (results.has_exception? ?
+                                                                                        DISPLAYABLE_ERROR_STATUS :
+                                                                                        SUCCESS_STATUS)
                       end
     end
 

data/lib/seeing_is_believing/binary/align_chunk.rb

@@ -22,7 +22,9 @@ class SeeingIsBelieving
               .reject            { |line, index| SyntaxAnalyzer.ends_in_comment? line }
               .slice_before      { |line, index| line == '' }
               .map { |slice|
-                max_chunk_length = 2 + slice.map { |line, index| line.length }.max
+                max_chunk_length = 2 + slice.select { |line, index| start_line <= index && index <= end_line }
+                                            .map { |line, index| line.length }
+                                            .max
                 slice.map { |line, index| [index, max_chunk_length] }
               }
               .flatten(1)

data/lib/seeing_is_believing/binary/arg_parser.rb

@@ -77,7 +77,7 @@ class SeeingIsBelieving
           errors:             [],
           require:            [],
           load_path:          [],
-          alignment_strategy: AlignFile,
+          alignment_strategy: AlignChunk,
         }
       end
 
@@ -124,9 +124,9 @@ class SeeingIsBelieving
 
     def ArgParser.help_screen
 <<HELP_SCREEN
-Usage: #{$0} [options] [filename]
+Usage: seeing_is_believing [options] [filename]
 
-  #{$0} is a program and library that will evaluate a Ruby file and capture/display the results.
+  seeing_is_believing is a program and library that will evaluate a Ruby file and capture/display the results.
 
   If no filename is provided, the binary will read the program from standard input.
 
@@ -135,8 +135,8 @@ Usage: #{$0} [options] [filename]
   -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 "# => "
   -s, --alignment-strategy  # select the alignment strategy:
-                              file  (DEFAULT) =>  the entire file is at the same alignment
-                              chunk           =>  each chunk of code is at the same alignment
+                              chunk (DEFAULT) =>  each chunk of code is at the same alignment
+                              file            =>  the entire file is at the same alignment
                               line            =>  each line is at its own alignment
   -t, --timeout n           # timeout limit in seconds when evaluating source file (ex. -t 0.3 or -t 3)
   -I, --load-path dir       # a dir that should be added to the $LOAD_PATH

data/lib/seeing_is_believing/version.rb

@@ -1,3 +1,3 @@
 class SeeingIsBelieving
-  VERSION = '0.0.19'
+  VERSION = '0.0.20'
 end

data/spec/arg_parser_spec.rb

@@ -290,8 +290,8 @@ describe SeeingIsBelieving::Binary::ArgParser do
     AlignChunk = SeeingIsBelieving::Binary::AlignChunk
 
     # maybe change the default?
-    it 'defaults to AlignFile' do
-      parse([])[:alignment_strategy].should == AlignFile
+    it 'defaults to AlignChunk' do
+      parse([])[:alignment_strategy].should == AlignChunk
     end
 
     specify '-s and --alignment-strategy sets the alignment strategy' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: seeing_is_believing
 version: !ruby/object:Gem::Version
-  version: 0.0.19
+  version: 0.0.20
 platform: ruby
 authors:
 - Josh Cheek