seeing_is_believing 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d761a62840425753a50b764d74caad42f1ff790
-  data.tar.gz: eb674e4076644502c643453699d1744de4161315
+  metadata.gz: 1663f4160aa363ccacf2b2f4646c1c5be0e71e3e
+  data.tar.gz: fc685e0084fe91671948e717199f5737366ee23e
 SHA512:
-  metadata.gz: 4e51b01ba8efe1a01b3602132ebb81a7ef935af700dfe05dbf4671cec579729dd3bb86cb83bba124c595bd7623e4612752e7266724fc7f9d3a6ba61b3cee5bba
-  data.tar.gz: 70bd344383af51e11e3edf04dcadfdee0c37535dbda6fbe6c1fe4ff582c9c5603a106db38e6b752e0cac47bc710bac803cdd82d7c37c932fe377cc2e605a5407
+  metadata.gz: 9f3d90bd96f298ccbce4326dee5fa075c1dea4db0e8832fae93bfcdb1d07c02b12fd150863c39d52fbe169024e50abca2e7e4d8da7d37bfd4dd560e82dd9394b
+  data.tar.gz: 651eb6819c8f776e156a8e7a6cde6836eeed51f067b714246837f8a391f5e06cc7c24e51076c56094ed30526e05ead111184b07cd0d078fb0f09a557c27fd62d

data/features/flags.feature

@@ -346,6 +346,14 @@ Feature: Using flags
     Then stderr is empty
     And the exit status is 0
     And stdout includes "Usage"
+    And stdout does not include "Examples:"
+
+  Scenario: --help+
+    When I run "seeing_is_believing --help+"
+    Then stderr is empty
+    And the exit status is 0
+    And stdout includes "Usage"
+    And stdout includes "Examples:"
 
 
   Scenario: --timeout

data/lib/seeing_is_believing/binary/parse_args.rb

@@ -25,25 +25,26 @@ class SeeingIsBelieving
         @result ||= begin
           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 '-v', '--version'             then options[:version]             = true
-            when '-x', '--xmpfilter-style'     then options[:xmpfilter_style]     = true
-            when '-i', '--inherit-exit-status' then options[:inherit_exit_status] = true
-            when '-j', '--json'                then options[:result_as_json]      = true
-            when '-g', '--debug'               then options[:debugger]            = Debugger.new(stream: outstream, colour: 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 :max_line_length,    arg
-            when '-D', '--result-length'       then extract_positive_int_for :max_result_length,  arg
-            when '-n', '--number-of-captures'  then extract_positive_int_for :number_of_captures, arg
-            when '-t', '--timeout'             then extract_non_negative_float_for :timeout,      arg
-            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       '--shebang'             then next_arg("#{arg} expects a ruby executable as the following argument but did not see one") { |executable| options[:shebang]   = executable }
-            when '-s', '--alignment-strategy'  then extract_alignment_strategy
+            when '-h',  '--help'                then options[:help]                = self.class.help_screen(false)
+            when '-h+', '--help+'               then options[:help]                = self.class.help_screen(true)
+            when '-c',  '--clean'               then options[:clean]               = true
+            when '-v',  '--version'             then options[:version]             = true
+            when '-x',  '--xmpfilter-style'     then options[:xmpfilter_style]     = true
+            when '-i',  '--inherit-exit-status' then options[:inherit_exit_status] = true
+            when '-j',  '--json'                then options[:result_as_json]      = true
+            when '-g',  '--debug'               then options[:debugger]            = Debugger.new(stream: outstream, colour: 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 :max_line_length,    arg
+            when '-D',  '--result-length'       then extract_positive_int_for :max_result_length,  arg
+            when '-n',  '--number-of-captures'  then extract_positive_int_for :number_of_captures, arg
+            when '-t',  '--timeout'             then extract_non_negative_float_for :timeout,      arg
+            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        '--shebang'             then next_arg("#{arg} expects a ruby executable as the following argument but did not see one") { |executable| options[:shebang]   = executable }
+            when '-s',  '--alignment-strategy'  then extract_alignment_strategy
             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
@@ -139,39 +140,41 @@ class SeeingIsBelieving
 
     end
 
-    def ParseArgs.help_screen
-<<HELP_SCREEN
+    def ParseArgs.help_screen(include_examples)
+<<FLAGS + if include_examples then <<EXAMPLES else '' end
 Usage: seeing_is_believing [options] [filename]
 
   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.
 
-  -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 "#{VALUE_MARKER}"
-  -n, --number-of-captures n    # how many results to capture for a given line
-                                  if you had 1 million results on a line, it could take a long time to record
-                                  and serialize them, you might limit it to 1000 results as an optimization
-  -s, --alignment-strategy name # select the alignment strategy:
-                                  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
-  -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
-  -g, --debug                   # print debugging information (useful if program is fucking up, or if you want to brag)
-  -x, --xmpfilter-style         # annotate marked lines instead of every line
-  -j, --json                    # print results in json format (i.e. so another program can consume them)
-  -i, --inherit-exit-status     # exit with the exit status of the program being eval
-      --shebang ruby-executable # if you want SiB to use some ruby other than the one in the path
-  -v, --version                 # print the version (#{VERSION})
-  -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 "#{VALUE_MARKER}"
+  -n,  --number-of-captures n    # how many results to capture for a given line
+                                   if you had 1 million results on a line, it could take a long time to record
+                                   and serialize them, you might limit it to 1000 results as an optimization
+  -s,  --alignment-strategy name # select the alignment strategy:
+                                   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
+  -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
+  -g,  --debug                   # print debugging information (useful if program is fucking up, or if you want to brag)
+  -x,  --xmpfilter-style         # annotate marked lines instead of every line
+  -j,  --json                    # print results in json format (i.e. so another program can consume them)
+  -i,  --inherit-exit-status     # exit with the exit status of the program being eval
+       --shebang ruby-executable # if you want SiB to use some ruby other than the one in the path
+  -v,  --version                 # print the version (#{VERSION})
+  -h,  --help                    # help screen without examples
+  -h+, --help+                   # help screen with examples
+FLAGS
 
 Examples: A few examples, for a more comprehensive set of examples, check out features/flags.feature
 
@@ -254,8 +257,7 @@ Examples: A few examples, for a more comprehensive set of examples, check out fe
   If your Ruby binary is named something else (e.g. ruby2.0)
     $ ruby2.0 -S seeing_is_believing --shebang ruby2.0 -e '123'
     123  #{VALUE_MARKER}123
-
-HELP_SCREEN
+EXAMPLES
     end
   end
 end

data/lib/seeing_is_believing/version.rb

@@ -1,3 +1,3 @@
 class SeeingIsBelieving
-  VERSION = '2.0.1'
+  VERSION = '2.0.2'
 end

data/lib/seeing_is_believing/wrap_expressions.rb

@@ -152,17 +152,18 @@ class SeeingIsBelieving
       when :masgn
         # we must look at RHS because [1,<<A] and 1,<<A are both allowed
         #
-        # in the first case, we must take the end_pos of the array, or we'll insert the after_each in the wrong location
+        # in the first case, we must take the end_pos of the array,
+        # or we'll insert the after_each in the wrong location
         #
         # in the second, there is an implicit Array wrapped around it, with the wrong end_pos,
         # so we must take the end_pos of the last arg
         array = ast.children.last
-        if array.type != :array # e.g. `a, g = c`
+        if array.type != :array # e.g. `a, b = c`
           add_to_wrappings ast
-          add_to_wrappings ast.children.last
+          add_children ast, true
         elsif array.location.expression.source.start_with? '['
           add_to_wrappings ast
-          find_wrappings array
+          add_children ast, true
         else
           begin_pos = ast.location.expression.begin_pos
           end_pos   = heredoc_hack(array.children.last).location.expression.end_pos

data/spec/binary/parse_args_spec.rb

@@ -167,9 +167,20 @@ describe SeeingIsBelieving::Binary::ParseArgs do
       parse([])[:help].should be_nil
     end
 
-    it 'is set to the help screen with -h and --help and -help' do
-      parse(['-h'])[:help].should == described_class.help_screen
-      parse(['--help'])[:help].should == described_class.help_screen
+    it 'is set to the flag only help screen with -h and --help and -help' do
+      parse(['-h'])[:help].should include 'Usage:'
+      parse(['--help'])[:help].should include 'Usage:'
+
+      parse(['-h'])[:help].should_not include 'Examples:'
+      parse(['--help'])[:help].should_not include 'Examples:'
+    end
+
+    it 'is set to the flag with examples help screen with --help+ and -h+' do
+      parse(['-h+'])[:help].should include 'Usage:'
+      parse(['--help+'])[:help].should include 'Usage:'
+
+      parse(['-h+'])[:help].should include 'Examples:'
+      parse(['--help+'])[:help].should include 'Examples:'
     end
   end
 

data/spec/wrap_expressions_spec.rb

@@ -347,6 +347,8 @@ describe SeeingIsBelieving::WrapExpressions do
 
     it 'wraps multiple assignment on each line' do
       wrap("a,b=1,\n2").should == "<a,b=<1>,\n2>"
+      wrap("a,b=[1,2]\n.map(&:to_s)").should == "<a,b=<[1,2]>\n.map(&:to_s)>"
+      wrap("a,b=[1,\n2\n.even?\n]").should == "<a,b=[<1>,\n<<2>\n.even?>\n]>"
     end
 
     it 'wraps multiple assignment with splats' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seeing_is_believing
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Josh Cheek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-07 00:00:00.000000000 Z
+date: 2013-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser