seeing_is_believing 2.2.0 → 3.0.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a2d2874d2ed6cf8165af907b62ecee8e271b5f6
-  data.tar.gz: b84abdaafa69646c8a71fabf979cfb334beaa197
+  metadata.gz: c4baad8edd542826d976fb5439fe4523724e25c2
+  data.tar.gz: 806d6b1cb7b43dc168c7653ff9995b3dd1b37220
 SHA512:
-  metadata.gz: fb5fe068ff82a068246a81865807c2aa9acd711f29dd93223b4950968a7c2d3e394df146e99832b655f73d8abe44c00acb5e34ccc8105c527d97065e61cd8799
-  data.tar.gz: 31c4079565ae48e1fe9c15b81dcbbf775f21588afe4b6372ee818ef06ab333cac5da3670013c41b5496e36a9f68c808cc235961f94212954f60e1a5ed326e108
+  metadata.gz: 74cde1ec9bd35565d7e49110210fadc6e8b9eb01538e78411138babf50abf5bc299a6cb592e3e7cc0d873c97c5549d8ddb5aa0a6a3e2eb07dc76130f433f077c
+  data.tar.gz: 57811be453dd99be97df3c4ed6a17b7a0329178776c2bce14a4247f13d51acac04f1d9ccfc9930a7ae55983b2f285e0ad6c351c703041cab3dafa071e09f8941

data/.gitignore

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

data/Changelog.md

@@ -0,0 +1,33 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+The Changelog was introduced on 2014-09-15, and is approximately in
+accordance with [http://keepachangelog.com/](http://keepachangelog.com/).
+I do my best to follow [Semantic Versioning](http://semver.org/).
+
+## 3.0.0.beta - 2014-??-??
+### Added
+- Issue for 3.0 is at https://github.com/JoshCheek/seeing_is_believing/issues/47
+- Added a [Changelog](Changelog.md) in accordance with [http://keepachangelog.com/](http://keepachangelog.com/)
+- `seeing_is_believing/version` is required by default,
+  you can now check your version by just typing `SeeingIsBelieving::VERSION` and running it.
+
+### Changed
+- Communication between SiB and the process running the code is no longer done by
+  serializing the result with JSON. Now, there is an
+  [EventStream](https://github.com/JoshCheek/seeing_is_believing/blob/4b9134ca45e001ebe5f139384bd1beee98b5e371/lib/seeing_is_believing/event_stream.rb)
+  class, which will send the information back to the parent process as soon as it
+  knows about it. For users who interact purely with the binary, this just means that
+  JSON will not already be required.
+- WrapExpressions' `before_all` and `after_all` keys now point to values that are lambdas with no args.
+  Mostly this is for consistency since `before_each` and `after_each` are lambas,
+  But also, because at some point I might want to provide an argument, and this will make it easier.
+  And because it allows certain conveniences, such as setting local vars in the lambda.
+- Loosened version constraints on parser dependency
+- When you iterate over the result, it iterates over a result for each line of the file
+  rather than the number of lines it actually captured.
+- The `--JSON` flag emits a different structure
+
+### Removed
+- Dependency on psych
+- Remove HasException module. The only thing using it now is Result, so just relevant behaviour into there.
+- SeeingIsBelieving::Line class

data/bin/seeing_is_believing

@@ -3,4 +3,4 @@
 $LOAD_PATH.unshift File.expand_path '../../lib', __FILE__
 
 require 'seeing_is_believing/binary'
-exit SeeingIsBelieving::Binary.new(ARGV, $stdin, $stdout, $stderr).call
+exit SeeingIsBelieving::Binary.call(ARGV, $stdin, $stdout, $stderr)

data/features/errors.feature

@@ -3,7 +3,7 @@ Feature: Running the binary unsuccessfully
   Sometimes I mess up and use the program in a way that doesn't work.
   I'd like it to be helpful in these situations so I can fix my use.
 
-  # show that it displalys next to the first place in the file
+  # show that it displays next to the first place in the file
   # and should maybe print the stacktrace at the bottom
   Scenario: Raising exceptions
     Given the file "raises_exception.rb":
@@ -29,11 +29,11 @@ Feature: Running the binary unsuccessfully
     """
     def first_defined
       second_defined
-    end
+    end                # => {{method_result :first_defined}}
 
     def second_defined
       require_relative 'raises_exception'  # ~> RuntimeError: ZOMG\n!!!!
-    end
+    end                                    # => {{method_result :second_defined}}
 
     first_defined
 

data/features/examples.feature

@@ -1,10 +1,10 @@
 Feature: Running the binary successfully
 
   They say seeing is believing. So to believe that this works
-  I want to see that it works by making a binary to use the lib.
+  I want to execute the actual binary and look at actual results.
 
-  It should be approximately like xmpfilter, except that it should
-  run against every line.
+  It should generally record every line of code and display the results
+  adjacent to the line, with output and errors displayed at the end of the file.
 
   Scenario: Some basic functionality
     Given the file "basic_functionality.rb":
@@ -70,7 +70,7 @@ Feature: Running the binary successfully
     # method and invocations
     def meth(n)
       n          # => "12", "34"
-    end
+    end          # => {{method_result :meth}}
 
     meth "12"  # => "12"
     meth "34"  # => "34"
@@ -100,11 +100,11 @@ Feature: Running the binary successfully
     class User
       def initialize(name)
         @name = name        # => "Josh", "Rick"
-      end
+      end                   # => {{method_result :initialize}}
 
       def name
         @name   # => "Josh", "Rick"
-      end
+      end       # => {{method_result :name}}
     end
 
     User.new("Josh").name  # => "Josh"

data/features/flags.feature

@@ -1,107 +1,7 @@
 Feature: Using flags
 
   Sometimes you want more control over what comes out, for that we give you flags.
-
-
-  Scenario: --start-line
-    Given the file "start_line.rb":
-    """
-    1 + 1
-    2
-    3
-    """
-    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:
-    """
-    1 + 1
-    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":
-    """
-    1
-    2
-    3 + 3
-    """
-    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:
-    """
-    1  # => 1
-    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":
-    """
-    1 + 1
-    2
-    3
-    4 + 4
-    """
-    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:
-    """
-    1 + 1
-    2  # => 2
-    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
-    """
-
+  Note that some flags are significant enough to have their own file.
 
   Scenario: --result-length sets the length of the portion including and after the # =>
     Given the file "result_lengths.rb":
@@ -184,6 +84,7 @@ Feature: Using flags
     When I run "seeing_is_believing --line-length 14 line_lengths2.rb"
     Then stdout is "12345"
 
+
   Scenario: --number-of-captures determines how many times a line will be recorded
     Given the file "number_of_captures.rb":
     """
@@ -206,25 +107,12 @@ Feature: Using flags
     end             # => 5
     """
 
-  Scenario: --xmpfilter-style respects the line formatting (but not currently alignment strategies, it just preserves submitted alignment)
-    Given the file "line_lengths3.rb":
-    """
-    '1' * 30 # =>
-    # =>
-    """
-    When I run "seeing_is_believing --xmpfilter-style --line-length 19 line_lengths3.rb"
-    Then stdout is:
-    """
-    '1' * 30 # => "1...
-    # => "1111111111...
-    """
-
 
   Scenario: --require
-    Given the file "print_1.rb" "puts 1"
-    Given the file "print_2.rb" "puts 2"
-    And the file "print_3.rb" "puts 3"
-    When I run "seeing_is_believing --require ./print_1 --require ./print_2 print_3.rb"
+    Given the file "r_print_1.rb" "puts 1"
+    Given the file "r_print_2.rb" "puts 2"
+    And the file "r_print_3.rb" "puts 3"
+    When I run "seeing_is_believing --require ./r_print_1 --require ./r_print_2 r_print_3.rb"
     Then stderr is empty
     And the exit status is 0
     And stdout is:
@@ -248,16 +136,16 @@ Feature: Using flags
 
 
   Scenario: --load-path
-    Given the file "print_1.rb" "puts 1"
-    And the file "some_dir/print_2.rb" "puts 2"
-    And the file "require_print_1.rb" "require 'print_1'"
-    When I run "seeing_is_believing require_print_1.rb"
+    Given the file "lp_print_1.rb" "puts 1"
+    And the file "some_dir/lp_print_2.rb" "puts 2"
+    And the file "require_lp_print_1.rb" "require 'lp_print_1'"
+    When I run "seeing_is_believing require_lp_print_1.rb"
     Then the exit status is 1
-    When I run "seeing_is_believing --load-path . -I ./some_dir -r print_2  require_print_1.rb"
+    When I run "seeing_is_believing --load-path . -I ./some_dir -r lp_print_2  require_lp_print_1.rb"
     Then stderr is empty
     And stdout is:
     """
-    require 'print_1'  # => true
+    require 'lp_print_1'  # => true
 
     # >> 2
     # >> 1
@@ -277,32 +165,36 @@ Feature: Using flags
 
 
   Scenario: --as and stdin
-    Given the file "example.rb" "1+1"
     Given the stdin content:
     """
-    1+1
     __FILE__
     """
-    When I run "seeing_is_believing --as example.rb"
+    When I run "seeing_is_believing --as as_and_stdin.rb"
     Then stderr is empty
     Then the exit status is 0
     And stdout is:
     """
-    1+1       # => 2
-    __FILE__  # => "example.rb"
+    __FILE__  # => "as_and_stdin.rb"
     """
 
 
   Scenario: --as and -e
-    Given the file "example.rb" "1+1"
-    When I run 'seeing_is_believing --as example.rb -e "__FILE__"'
+    When I run 'seeing_is_believing --as as_and_e.rb -e "__FILE__"'
     Then stderr is empty
     And the exit status is 0
-    And stdout is '__FILE__  # => "example.rb"'
+    And stdout is '__FILE__  # => "as_and_e.rb"'
+
+
+  Scenario: --as and filename
+    Given the file "as_and_filename.rb" "__FILE__"
+    When I run 'seeing_is_believing as_and_filename.rb --as not_as_and_filename.rb'
+    Then stderr is empty
+    And the exit status is 0
+    And stdout is '__FILE__  # => "not_as_and_filename.rb"'
 
 
   Scenario: --clean
-    Given the file "example.rb":
+    Given the file "uncleaned.rb":
     """
     1 + 1  # => not 2
     2 + 2  # ~> Exception, something
@@ -314,7 +206,7 @@ Feature: Using flags
     __END__
     1
     """
-    When I run "seeing_is_believing --clean example.rb"
+    When I run "seeing_is_believing --clean uncleaned.rb"
     Then stderr is empty
     And the exit status is 0
     And stdout is:
@@ -348,6 +240,7 @@ Feature: Using flags
     And stdout includes "Usage"
     And stdout does not include "Examples:"
 
+
   Scenario: --help+
     When I run "seeing_is_believing --help+"
     Then stderr is empty
@@ -357,16 +250,16 @@ Feature: Using flags
 
 
   Scenario: --timeout
-    Given the file "example.rb" "sleep 1"
-    When I run "seeing_is_believing --timeout 0.1 example.rb"
+    Given the file "will_timeout.rb" "sleep 1"
+    When I run "seeing_is_believing --timeout 0.1 will_timeout.rb"
     Then stdout is empty
     And the exit status is 2
     And stderr is "Timeout Error after 0.1 seconds!"
 
 
   Scenario: --timeout
-    Given the file "example.rb" "1 + 1"
-    When I run "seeing_is_believing --timeout 1.0 example.rb"
+    Given the file "will_not_timeout.rb" "1 + 1"
+    When I run "seeing_is_believing --timeout 1.0 will_not_timeout.rb"
     Then stderr is empty
     And the exit status is 0
     And stdout is "1 + 1  # => 2"
@@ -399,6 +292,7 @@ Feature: Using flags
     1 + 1 + 1  # => 3
     """
 
+
   Scenario: --alignment-strategy chunk
     Given the file "chunk_alignments.rb":
     """
@@ -442,6 +336,7 @@ Feature: Using flags
     1 + 1          # => 2
     """
 
+
   Scenario: --alignment-strategy line
     Given the file "line_alignments.rb":
     """
@@ -469,6 +364,7 @@ Feature: Using flags
     1 + 1 + 1  # => 3
     """
 
+
   Scenario: --inherit-exit-status
     Given the file "exit_status.rb" "exit 123"
     When I run "seeing_is_believing exit_status.rb"
@@ -494,40 +390,6 @@ Feature: Using flags
     Then the exit status is 10
 
 
-  Scenario: --xmpfilter-style
-    Given the file "magic_comments.rb":
-    """
-    1+1# =>
-    2+2    # => 10
-    "a
-     b" # =>
-    /a
-     b/ # =>
-    1
-    "omg"
-    # =>
-    "omg2"
-    # => "not omg2"
-    """
-    When I run "seeing_is_believing --xmpfilter-style magic_comments.rb"
-    Then stderr is empty
-    And the exit status is 0
-    And stdout is:
-    """
-    1+1# => 2
-    2+2    # => 4
-    "a
-     b" # => "a\n b"
-    /a
-     b/ # => /a\n b/
-    1
-    "omg"
-    # => "omg"
-    "omg2"
-    # => "omg2"
-    """
-
-
   Scenario: --debug
     Given the file "simple_program.rb":
     """
@@ -550,24 +412,22 @@ Feature: Using flags
     2  # => 2
     """
 
+
   Scenario: --shebang
     Given the file "fake_ruby":
     """
     #!/usr/bin/env ruby
-    # yes, this uses knowledge of where the proving grounds is
     $LOAD_PATH.unshift File.expand_path "{{Haiti.config.proving_grounds_dir}}/../lib", __FILE__
-
-    require 'seeing_is_believing'
-    result = SeeingIsBelieving::Result.new
-    result.record_result(1, /omg/)
-
-    require 'json'
-    puts JSON.dump result.to_primitive
+    require 'seeing_is_believing/event_stream/producer'
+    sib = SeeingIsBelieving::EventStream::Producer.new($stdout)
+    sib.record_result(:inspect, 1, /omg/)
+    sib.finish!
     """
     When I run "chmod +x fake_ruby"
     When I run "seeing_is_believing -e 123 --shebang ./fake_ruby"
     Then stdout is "123  # => /omg/"
 
+
   Scenario: --json
     Given the file "all_kinds_of_output.rb":
     """
@@ -579,22 +439,17 @@ Feature: Using flags
     raise "omg"
     """
     When I run "seeing_is_believing --json all_kinds_of_output.rb"
-    Then the exit status is 0
-    And stdout is the JSON:
-    """
-      {
-        "lines": {
-          "1": { "exception": null, "results": ["3"] },
-          "2": { "exception": null, "results": ["\"0\"", "\"1\"", "\"2\""] },
-          "3": { "exception": null, "results": ["3"] },
-          "4": { "exception": null, "results": ["nil"] },
-          "5": { "exception": null, "results": ["nil"] },
-          "6": { "exception": { "class_name": "RuntimeError",
-                                "message":    "omg",
-                                "backtrace":  ["all_kinds_of_output.rb:6:in `<main>'"]
-                              },
-                 "results": []
-               }
+    Then stderr is empty
+    And  the exit status is 0
+    And  stdout is the JSON:
+    """
+      { "lines": {
+          "1": ["3"],
+          "2": ["\"0\"", "\"1\"", "\"2\""],
+          "3": ["3"],
+          "4": ["nil"],
+          "5": ["nil"],
+          "6": []
         },
         "exception": {
           "line_number_in_this_file": 6,