seeing_is_believing 3.6.1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abaf2ec44d75ad4ca500c71bf90128baea06be5c0bd61fef5a0de81a402fef49
-  data.tar.gz: b487790b90fb61b27e77fee26622c8210a0b6e435c2084205bb791bcf3e28c08
+  metadata.gz: d4cc5ca0f30eacf4bb2729e295c557de2dcc20acb856389dda16f776bb0df2ad
+  data.tar.gz: e5711ae5d11fff1d65259beb1f65f9bbf6fba5e2d1494e22394d652fac26dfa6
 SHA512:
-  metadata.gz: '03996ee758737b276089eec6037a0c999678097759fc1dac9a1a338eae62327cb5d76253e0c491ae77a7e0852edb104da629e59db1c60228c43076d100ae8215'
-  data.tar.gz: 915f7e561d0bcb18f863c068e72305fa445f1b4f5f9d390843478a4ddb662cf8c38af388d5cc8da5f9ddaeeba1e569ad803c5d5c5b913d92bc6642e60155484e
+  metadata.gz: c00e05b913ad9122b4f2a76146c447868cec4b53dad4f8cc71ee6ef8e0607005c9b6cf8c31bd5e439096ea52ee445f71ff06be44872b65b4e6ce00a3931cfe64
+  data.tar.gz: 155ee68e5acaaf7b9d6e813bb3f1710b759c9b093a467c8aeb9d84f4df298716ab1cfba2cab504b75c9b98aad8f6d0d6146ae13be35db1f26dbacfa70e035e14

data/.travis.yml

@@ -1,11 +1,8 @@
 language: ruby
-before_install: gem install bundler
 install: rake install
 script: bundle exec rake ci
 rvm:
-  - 2.0.0
-  - 2.1.2
-  - 2.2.0
-  - 2.3.1
   - 2.4.1
   - 2.5.0
+  - 2.6.3
+  - 2.7.1

data/Rakefile

@@ -42,6 +42,8 @@ task cuke: :bundle do
   sh 'ruby', '--disable-gem',
      *require_paths,
      '-S', 'bundle/bin/cucumber',
+     '--quiet',     # omit stepdefs, which are usually spammy for me https://twitter.com/josh_cheek/status/1082767053071765504
+     '--fail-fast', # stop as soon as we see an error (don't waste CI time, don't make it hard to find error info later)
      '--tags', '~@not-implemented',
      '--tags', "~@not-#{RUBY_VERSION}",
      '--tags', "~@not-#{ruby_version_without_patchlevel}",

data/Readme.md

@@ -8,7 +8,7 @@ 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/wiki/Editor-Integration)).
 If you like Swift Playgrounds, you'll like SiB.
 
-![example](https://s3.amazonaws.com/josh.cheek/images/scratch/sib-example1.gif)
+![example](docs/example.gif)
 
 
 Helpful links

data/appveyor.yml

@@ -26,8 +26,6 @@ test_script:
 
 environment:
   matrix:
-    - ruby_version: '21'
-    - ruby_version: '22'
-    - ruby_version: '23'
-    # - ruby_version: '24'
-    # - ruby_version: '25'
+    - ruby_version: '24'
+    - ruby_version: '25'
+    - ruby_version: '26'

data/features/regression.feature

@@ -267,6 +267,8 @@ Feature:
     """
 
 
+  # ChildProcess doesn't seem to handle this well in Windows. IDK.
+  @not-windows
   Scenario: Long DATA segment in a valid file
     Given the file "long_valid_data_segment.rb":
     """
@@ -434,6 +436,9 @@ Feature:
     """
 
 
+  # 2.4 and 2.5 don't correclty detect deadlock on Windows: https://bugs.ruby-lang.org/issues/16110
+  @not-2.4
+  @not-2.5
   Scenario: Deadlocked
     Given the file "deadlocked.rb":
     """
@@ -472,6 +477,8 @@ Feature:
   # but just generally that it doesn't fkn blow up
   @not-2.4
   @not-2.5
+  @not-2.6
+  @not-2.7
   Scenario: Old JSON bug
     Given the file "json_and_encodings.rb":
     """

data/features/xmpfilter-style.feature

@@ -72,6 +72,7 @@ Feature: Xmpfilter style
     #     :wibble=>{:magic_word=>"xyzzy"}}
     """
 
+  @not-2.3
   Scenario: --xmpfilter-style, when displayed on the next line, prints the string across multiple lines
     Given the file "xmpfilter-prev-line-is-multiline-string.rb":
     """

data/lib/seeing_is_believing.rb

@@ -43,8 +43,9 @@ class SeeingIsBelieving
       options.debugger.context("REWRITTEN PROGRAM") { new_program }
 
       EvaluateByMovingFiles.call \
-        new_program,
         filename,
+        @program,
+        new_program,
         event_handler:     event_handler(options.debugger, options.event_handler),
         provided_input:    options.stdin,
         require_files:     options.require_files,

data/lib/seeing_is_believing/binary.rb

@@ -23,7 +23,7 @@ class SeeingIsBelieving
       end
 
       if config.errors.any?
-        stderr.puts *config.errors, *config.deprecations
+        stderr.puts(*config.errors, *config.deprecations)
         return NONDISPLAYABLE_ERROR_STATUS
       end
 

data/lib/seeing_is_believing/binary/annotate_marked_lines.rb

@@ -46,6 +46,7 @@ class SeeingIsBelieving
           should_pp      = false
           WrapExpressions.call \
             program,
+            before_all: -> { "BEGIN { $SiB.file_loaded };" },
             before_each: -> line_number {
               inspect        = "$SiB.record_result(:inspect, #{line_number}, ("
               pp             = "$SiB.record_result(:pp, #{line_number}, ("

data/lib/seeing_is_believing/binary/comment_lines.rb

@@ -17,7 +17,7 @@ class SeeingIsBelieving
       def call
         @call ||= begin
           commentable_lines = CommentableLines.new raw_code
-          commentable_lines.call.each do |line_number, (index_of_newline, col)|
+          commentable_lines.call.each do |line_number, (index_of_newline, _col)|
             first_index  = last_index = index_of_newline
             first_index -= 1 while first_index > 0 && raw_code[first_index-1] != "\n"
             comment_text = commenter.call raw_code[first_index...last_index], line_number

data/lib/seeing_is_believing/binary/commentable_lines.rb

@@ -54,13 +54,13 @@ class SeeingIsBelieving
       def remove_lines_whose_newline_is_escaped(line_num_to_location)
         ors_indexes = code_obj.indexes_of_ors_at_eol
         line_num_to_location
-          .select { |line_number, (index_of_newline, col)|
+          .select { |line_number, (index_of_newline, _col)|
             code[index_of_newline-1] == '\\'
           }
-          .reject { |line_number, (index_of_newline, col)|
+          .reject { |line_number, (index_of_newline, _col)|
             ors_indexes.include? index_of_newline
           }
-          .each { |line_number, (index_of_newline, col)|
+          .each { |line_number, (_index_of_newline, _col)|
             line_num_to_location.delete line_number
           }
       end
@@ -73,8 +73,8 @@ class SeeingIsBelieving
             begin_pos = comment.location.expression.begin_pos
             end_pos   = comment.location.expression.end_pos
             range     = begin_pos...end_pos
-            line_num_to_location.select { |line_number, (index_of_newline, col)| range.include? index_of_newline }
-                                .each   { |line_number, (index_of_newline, col)| line_num_to_location.delete line_number }
+            line_num_to_location.select { |line_number, (index_of_newline, _col)| range.include? index_of_newline }
+                                .each   { |line_number, (_index_of_newline, _col)| line_num_to_location.delete line_number }
           end
         end
       end
@@ -82,8 +82,8 @@ class SeeingIsBelieving
       def remove_lines_inside_of_strings_and_things(line_num_to_location, ast)
         invalid_boundaries = ranges_of_atomic_expressions ast, []
         invalid_boundaries.each do |invalid_boundary|
-          line_num_to_location.select { |line_number, (index_of_newline, col)| invalid_boundary.include? index_of_newline }
-                              .each   { |line_number, (index_of_newline, col)| line_num_to_location.delete line_number }
+          line_num_to_location.select { |line_number, (index_of_newline, _col)| invalid_boundary.include? index_of_newline }
+                              .each   { |line_number, (_index_of_newline, _col)| line_num_to_location.delete line_number }
         end
       end
 

data/lib/seeing_is_believing/binary/config.rb

@@ -108,7 +108,6 @@ class SeeingIsBelieving
             self.lib_options.rewrite_code  = AnnotateMarkedLines.code_rewriter(markers)
             self.remove_value_prefixes     = false
             self.lib_options.require_files << 'pp'
-            self.lib_options.require_files << 'seeing_is_believing/customize_pp'
 
           when '--toggle-mark'
             extract_positive_int_for.call arg do |n|
@@ -313,8 +312,7 @@ class SeeingIsBelieving
   end
 
   def Binary.help_screen(markers)
-    value  = markers[:value][:prefix]
-    stdout = markers[:stdout][:prefix]
+    value = markers[:value][:prefix]
 
     <<FLAGS
 Usage: seeing_is_believing [options] [filename]

data/lib/seeing_is_believing/binary/remove_annotations.rb

@@ -76,7 +76,7 @@ class SeeingIsBelieving
             [annotation, comment]
           }
           .slice_before { |annotation, comment| annotation }    # annotations begin chunks
-          .select       { |(annotation, start), *| annotation } # discard chunks not beginning with an annotation (probably can only happens on first comment)
+          .select       { |(annotation, _start), *| annotation } # discard chunks not beginning with an annotation (probably can only happens on first comment)
           .map { |(annotation, start), *rest|                   # end the chunk if the comment doesn't meet nextline criteria
             nextline_comments = []
             prev              = start

data/lib/seeing_is_believing/code.rb

@@ -91,8 +91,8 @@ class SeeingIsBelieving
     def indexes_of_ors_at_eol
       Set.new(
         @tokens.select { |type, *| type == :tGVAR }
-               .select { |_, (var, range)| var == '$\\'.freeze }
-               .map    { |_, (var, range)| range.end_pos }
+               .select { |_, (var, _range)| var == '$\\'.freeze }
+               .map    { |_, (_var, range)| range.end_pos }
       )
     end
 
@@ -106,7 +106,7 @@ class SeeingIsBelieving
 
     def body_range_from_tokens(tokens)
       return range_for(0, 0) if raw.start_with? "__END__\n"
-      (name, (_, range)) = tokens.max_by { |name, (data, range)| range.end_pos } ||
+      (name, (_, range)) = tokens.max_by { |name, (_data, range)| range.end_pos } ||
                             [nil, [nil, range_for(0, 1)]]
       end_pos = range.end_pos
       end_pos += 1 if name == :tCOMMENT || name == :tSTRING_END || name == :tSEMI

data/lib/seeing_is_believing/evaluate_by_moving_files.rb

@@ -17,8 +17,9 @@ require "childprocess"
 
 require 'seeing_is_believing/result'
 require 'seeing_is_believing/debugger'
-require 'seeing_is_believing/backup_file'
+require 'seeing_is_believing/swap_files'
 require 'seeing_is_believing/event_stream/consumer'
+require 'seeing_is_believing/event_stream/events'
 
 ChildProcess.posix_spawn = true # forking locks up for some reason when we run SiB inside of SiB
 
@@ -28,13 +29,14 @@ class SeeingIsBelieving
       new(*args).call
     end
 
-    attr_accessor :program, :provided_input, :require_flags, :load_path_flags, :encoding, :timeout_seconds, :debugger, :event_handler, :max_line_captures
+    attr_accessor :user_program, :rewritten_program, :provided_input, :require_flags, :load_path_flags, :encoding, :timeout_seconds, :debugger, :event_handler, :max_line_captures
 
-    attr_accessor :file_directory, :file_path, :local_cwd, :relative_filename, :backup_filename
+    attr_accessor :file_directory, :file_path, :local_cwd, :relative_filename, :backup_path
 
-    def initialize(program, file_path,  options={})
+    def initialize(file_path, user_program, rewritten_program, options={})
       options = options.dup
-      self.program           = program
+      self.user_program      = user_program
+      self.rewritten_program = rewritten_program
       self.encoding          = options.delete(:encoding)           || "u"
       self.timeout_seconds   = options.delete(:timeout_seconds)    || 0 # 0 is the new infinity
       self.provided_input    = options.delete(:provided_input)     || String.new
@@ -47,26 +49,20 @@ class SeeingIsBelieving
       self.file_directory    = File.dirname file_path
       file_name              = File.basename file_path
       self.relative_filename = local_cwd ? file_name : file_path
-      self.backup_filename   = File.join file_directory, "seeing_is_believing_backup.#{file_name}"
+      self.backup_path       = File.join file_directory, "seeing_is_believing_backup.#{file_name}"
 
       options.any? && raise(ArgumentError, "Unknown options: #{options.inspect}")
     end
 
     def call
-      BackupFile.call file_path, backup_filename do
-        write_program_to_file
-        evaluate_file
+      SwapFiles.call file_path, backup_path, user_program, rewritten_program do |swap_files|
+        evaluate_file swap_files
       end
     end
 
     private
 
-    def write_program_to_file
-      File.open(file_path, 'w', external_encoding: "utf-8") { |f| f.write program.to_s }
-    end
-
-
-    def evaluate_file
+    def evaluate_file(swap_files)
       event_server = TCPServer.new(0) # dynamically allocates an available port
 
       # setup streams
@@ -78,7 +74,7 @@ class SeeingIsBelieving
                                 [Marshal.dump(
                                   event_stream_port: event_server.addr[1],
                                   max_line_captures: max_line_captures,
-                                  num_lines:         program.lines.count,
+                                  num_lines:         user_program.lines.count,
                                   filename:          relative_filename,
                                 )].pack('m0')
 
@@ -113,7 +109,12 @@ class SeeingIsBelieving
 
       # set up the event consumer
       consumer = EventStream::Consumer.new(events: eventstream, stdout: stdout, stderr: stderr)
-      consumer_thread = Thread.new { consumer.each { |e| event_handler.call e } }
+      consumer_thread = Thread.new do
+        consumer.each do |e|
+          swap_files.show_user_program if e.is_a? SeeingIsBelieving::EventStream::Events::FileLoaded
+          event_handler.call e
+        end
+      end
 
       # wait for completion
       if timeout_seconds == 0
@@ -131,13 +132,19 @@ class SeeingIsBelieving
       # On Windows, we need to call stop if there is an error since it interrupted
       # the previos waiting/polling. If we don't call stop, in that situation, it will
       # leave orphan processes. On Unix, we need to always call stop or it may leave orphans
-      if ChildProcess.unix?
-        child.stop
-      elsif $!
-        child.stop
-        consumer.process_exitstatus(child.exit_code)
+      begin
+        if ChildProcess.unix?
+          child.stop
+        elsif $!
+          child.stop
+          consumer.process_exitstatus(child.exit_code)
+        end
+        child.alive? && child.stop
+      rescue ChildProcess::Error
+        # On AppVeyor, I keep getting errors
+        #   The handle is invalid: https://ci.appveyor.com/project/JoshCheek/seeing-is-believing/build/22
+        #   Access is denied:      https://ci.appveyor.com/project/JoshCheek/seeing-is-believing/build/24
       end
-      cleanup_run(child)
       close_streams(stdout, stderr, eventstream, event_server)
     end
 
@@ -154,14 +161,5 @@ class SeeingIsBelieving
     def close_streams(*streams)
       streams.each { |io| io.close unless io.closed? }
     end
-
-    # On AppVeyor, I keep getting errors
-    #   The handle is invalid: https://ci.appveyor.com/project/JoshCheek/seeing-is-believing/build/22
-    #   Access is denied:      https://ci.appveyor.com/project/JoshCheek/seeing-is-believing/build/24
-    def cleanup_run(child, *streams)
-      child.alive? && child.stop
-    rescue ChildProcess::Error
-      # noop
-    end
   end
 end

data/lib/seeing_is_believing/event_stream/consumer.rb

@@ -208,6 +208,8 @@ class SeeingIsBelieving
           Events::RubyVersion.new(value: shift_string(line))
         when :filename
           Events::Filename.new(value: shift_string(line))
+        when :file_loaded
+          Events::FileLoaded.new
         when :exec
           Events::Exec.new(args: shift_string(line))
         else

data/lib/seeing_is_believing/event_stream/events.rb

@@ -58,6 +58,13 @@ class SeeingIsBelieving
         attributes :value
       end
 
+      # For knowing when you can perform certain tasks (eg moving the file back)
+      class FileLoaded < Event
+        def self.event_name
+          :file_loaded
+        end
+      end
+
       # Number of lines in the program.
       class NumLines < Event
         def self.event_name

data/lib/seeing_is_believing/event_stream/handlers/record_exit_events.rb

@@ -7,8 +7,8 @@ class SeeingIsBelieving
         attr_reader :exitstatus
         attr_reader :timeout_seconds
 
-        def initialize(next_observer)
-          @next_observer = next_observer
+        def initialize(next_handler)
+          @next_handler = next_handler
         end
 
         def call(event)
@@ -18,7 +18,7 @@ class SeeingIsBelieving
           when Events::Timeout
             @timeout_seconds = event.seconds
           end
-          @next_observer.call(event)
+          @next_handler.call(event)
         end
       end
     end

data/lib/seeing_is_believing/event_stream/handlers/update_result.rb

@@ -29,7 +29,8 @@ class SeeingIsBelieving
                Finished,
                StdoutClosed,
                StderrClosed,
-               EventStreamClosed
+               EventStreamClosed,
+               FileLoaded
                # no op
           else raise "Unknown event: #{event.inspect}"
           end

data/lib/seeing_is_believing/event_stream/producer.rb

@@ -7,6 +7,16 @@ using SeeingIsBelieving::Safe
 class SeeingIsBelieving
   module EventStream
     class Producer
+
+      # Guarding against hostile users (e.g. me) that do ridiculous things like blowing away these constants
+      old_w, $-w = $-w, nil # Ruby warns about accessing deprecated constants
+      Object.constants.each do |name|
+        const_set name, Object.const_get(name)
+      end
+      $-w = old_w
+
+      ErrnoEPIPE = Errno::EPIPE # not actually tested, but we can see it is referenced below
+
       module NullQueue
         extend self
         Queue.instance_methods(false).each do |name|
@@ -40,6 +50,10 @@ class SeeingIsBelieving
         queue << "max_line_captures #{max_line_captures}"
       end
 
+      def file_loaded
+        queue << "file_loaded"
+      end
+
       StackErrors = [SystemStackError]
       StackErrors << Java::JavaLang::StackOverflowError if defined?(RUBY_PLATFORM) && RUBY_PLATFORM == 'java'
       def record_result(type, line_number, value)

data/lib/seeing_is_believing/safe.rb

@@ -50,13 +50,7 @@ class SeeingIsBelieving
       alias to_str to_str
     end
 
-    # in 2.4 we should use Integer instead, but it's not obvious to me how
-    # to detect this. eg defined?(Fixnum) returns "constant". Accessing it
-    # leads to a warning, but SiB turns warnings off so you don't see it.
-    # So.... for now, it incidentally doesn't do anything annoying, but would
-    # be good to figure out something better (eg if we ever wanted to allow the
-    # user to decide whether warnings should display or not)
-    refine Fixnum do
+    refine Integer do
       alias to_s to_s
       alias next next
       alias <    <

data/lib/seeing_is_believing/swap_files.rb

@@ -0,0 +1,90 @@
+require 'seeing_is_believing/error'
+require 'seeing_is_believing/hard_core_ensure'
+
+class SeeingIsBelieving
+  class SwapFiles
+    # Might honeslty make more sense to break this out into 2 different classes.
+    # We've got to do some confusing state accounting since there are really 2
+    # algorithms here:
+    #
+    # if the file exists:
+    #   make sure there isn't a backup (could cause the user to lose their file)
+    #   back the file up
+    #   write the rewritten code to the file
+    #   if we are told to show the user program
+    #     move the backup over the top of the rewritten file
+    #     do nothing in the ensure block
+    #   else
+    #     in the ensure block: move the backup over the top of the rewritten file
+    # if the file DNE:
+    #   write the rewritten code to the file
+    #   if we are told to show the user program
+    #     write the user program to the file
+    #   delete the file in the ensure block
+    def self.call(*args, &block)
+      new(*args, &block).call
+    end
+
+    def initialize(file_path, backup_path, user_program, rewritten_program, &block)
+      self.file_path         = file_path
+      self.block             = block
+      self.backup_path       = backup_path
+      self.user_program      = user_program
+      self.rewritten_program = rewritten_program
+    end
+
+    def call
+      HardCoreEnsure.call \
+        code: -> {
+          File.exist? backup_path and
+            raise TempFileAlreadyExists.new(file_path, backup_path)
+
+          @has_file = File.exist? file_path
+
+          if @has_file
+            File.rename file_path, backup_path
+            @needs_restore = true
+          end
+
+          save_file rewritten_program
+
+          block.call self
+        },
+        ensure: -> {
+          set_back_to_initial_conditions
+        }
+    end
+
+    def show_user_program
+      if @needs_restore
+        restore
+      else
+        save_file user_program
+      end
+    end
+
+    private
+
+    attr_accessor :block, :file_path, :backup_path, :rewritten_program, :user_program
+
+    def restore
+      File.rename(backup_path, file_path)
+      @needs_restore = false
+    end
+
+
+    def save_file(program)
+      File.open file_path, 'w', external_encoding: "utf-8" do |f|
+        f.write program.to_s
+      end
+    end
+
+    def set_back_to_initial_conditions
+      if @needs_restore
+        restore
+      elsif !@has_file
+        File.delete(file_path)
+      end
+    end
+  end
+end