pry-timetravel 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de1866b7ed3e671da6c46593c64cf8a6d67f79b1
-  data.tar.gz: 3250ab254a725690e9918c419eb99e9bea65a213
+  metadata.gz: 5d28f753687e1f5f96c87e7ce51949dc68d8fab6
+  data.tar.gz: be676c5cc7e8ff236314b31e6161aef76ce017a4
 SHA512:
-  metadata.gz: 72cd2382bb52e80f742995b9055c0e4680a0468413b431c26f097e3ffb3c022d45d43930f54c6eea2712ba8b8bca1e4c70ed2933f30eb8ac2c1b4f32b5c1484b
-  data.tar.gz: ddeda18934b6405411a1971a1cfd4a0b5dc68d49cb234bc2f0ca5044ac623668312e06c909c4f63737a3b3801c26b34dba3c45f2ccf90fca5d025ec65516d611
+  metadata.gz: c42224c2d9c89770cf5f22c861b37fa254a71713d11c46696fbc6d912027f21454a0ea98688f13f690a69e7fc7a5e12b8a1c63e2b2d61603c7c192bbebfb0c01
+  data.tar.gz: 27bfcc69e86ff9838820f350c5fb617e24d6d1c456e702b670c8c25d7156b9afdb5be0c728b9416f8645696759c4482930e3f0f9e309344635fc9638b2636fed

data/LICENSE.MIT

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Conrad Irwin <conrad.irwin@gmail.com>
+Copyright (c) 2014 Brock Wilcox <awwaiid@thelackthereof.org>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,21 +1,33 @@
 # pry-timetravel
 
-DOES NOT WORK. DO NOT USE.
-
 Time travel! For your REPL!
 
     > x = 5
     5
-    > checkpoint
+    > snap
     > x = 10
     10
-    > timetravel
+    > back
     > x
     5
 
 This is an attempt to package the proof of concept. API WILL CHANGE!
 
+## How it works
+
+The 'snap' command causes a fork, and the child is sent a SIGSTOP to freeze the
+process. The parent continues on. Later when you do 'back' the saved child is
+sent SIGCONT and the current process is sent a SIGSTOP. Ultimately you can have
+a whole pool of frozen snapshots and can resume any of them.
+
+In theory copy-on-write semantics makes this a tollerable thing to do :)
+
+There are a few more details, but that is the important bit.
+
+WARNING: Time travel may cause zombies.
+
 ## Meta
 
-Released under the MIT license, see LICENSE.MIT for details. Contributions and bug-reports
-are welcome.
+Released under the MIT license, see LICENSE.MIT for details. License is
+negotiable. Contributions and bug-reports are welcome!
+

data/Rakefile

@@ -1,9 +1,9 @@
-require 'rspec/core/rake_task'
+# require 'rspec/core/rake_task'
 
 task :default => :test
 task :spec => :test
 
-RSpec::Core::RakeTask.new(:test)
+# RSpec::Core::RakeTask.new(:test)
 
 task :build do
   sh 'gem build *.gemspec'

data/lib/pry-timetravel.rb

@@ -7,81 +7,110 @@ class PryTimetravel
   class << self
 
     def dlog(msg)
-      #  File.open("meta.log", 'a') do |file|
-        #  file.puts(msg)
-      #  end
+      if ENV["TIMETRAVEL_DEBUG"]
+        File.open("meta.log", 'a') do |file|
+          file.puts("#{Time.now} [#{$$}] #{msg}")
+        end
+      end
+    end
+
+    at_exit do
+      PryTimetravel.dlog "at_exit"
+      if $root_parent && $$ != $root_parent
+        PryTimetravel.dlog "Sending SIGUSR1 up to #{$root_parent}"
+        Process.kill 'SIGUSR1', $root_parent
+      end
+    end
+
+    def enter_suspended_animation
+      old_sigcont_handler = Signal.trap('CONT') do
+        dlog("Got a SIGCONT")
+      end
+
+      old_sigexit_handler = Signal.trap('EXIT') do
+        dlog("got EXIT")
+        Kernel.exit!
+      end
+
+      dlog("Stopping myself")
+      Process.kill 'SIGSTOP', $$
+      dlog("Back from SIGSTOP!")
+
+      dlog("Returning to old SIGCONT")
+      Signal.trap('CONT', old_sigcont_handler)
+      dlog("Returning to old SIGEXIT")
+      Signal.trap('EXIT', old_sigexit_handler)
     end
 
-    def checkpoint
+    def snapshot
+
+      # We need a root-parent to keep the shell happy
+      if ! $root_parent
+        $root_parent = $$
+        child_pid = fork
+        if child_pid
+          Signal.trap('INT') do
+            dlog("root-parent got INT")
+          end
+          Signal.trap('USR1') do
+            dlog("root-parent got USR1")
+            Kernel.exit!
+          end
+          dlog "Root parent waiting on #{child_pid}"
+          Process.waitpid child_pid
+          dlog "Root parent exiting!"
+          Kernel.exit!
+        end
+      end
+
+      $timetravel_root ||= $$
+
       parent_pid = $$
       child_pid = fork
       if child_pid
-        dlog("PARENT #{parent_pid}: I have a child pid #{child_pid}")
-
-        # Method 1: Child suspends themselves, parent adds them to list
-        #  @previous_pid ||= []
-        #  @previous_pid.push child_pid
-
-        # Method 2: Parent does a global-blocking waitall
-        # when the child exits, we can continue
-        # Problem: What if the child exits in a bad way? Check out '$?'
-        Process.waitpid(child_pid)
-        dlog("ME #{$$}: Previous exit: #{$?.inspect}")
-        if $?.exitstatus != 42
-          # Since this wasn't a timetravel return, we must unravel this world
-          Kernel.exit! $?.exitstatus
-        end
+        dlog("I am parent #{parent_pid}: I have a child pid #{child_pid}")
+
+        # Method 3: Child suspends themselves, parent adds them to list
+        @previous_pid ||= []
+        @previous_pid.push child_pid
+
+        # Perform operation
+        yield
 
-        # The parent universe freezes
-        #  dlog("PARENT #{$$}: I am suspending. My child is #{parent_pid}")
-        #  dlog("PARENT #{$$}: suspending")
-        #  Process.setpgrp
-        #  Process.setsid
-        #  dlog("PARENT #{$$}: resumed!")
       else
         child_pid = $$
-        dlog("CHILD: #{child_pid}: I have a parent pid #{parent_pid}")
+        dlog("I am child #{child_pid}: I have a parent pid #{parent_pid}")
+        enter_suspended_animation
+      end
+    end
+
+    def snapshot_list
+      @previous_pid && @previous_pid.join(" ")
+    end
 
-        # Method 1: Child suspends themselves, parent adds them to list
-        # The child is eventually resumed
-        #  Process.kill 'SIGSTOP', child_pid
-        #  dlog("CHILD #{child_pid}: resumed!")
+    def restore_snapshot(target_pid = nil, count = nil)
+      dlog("Thinking about time travel...");
 
-        # Method 2: Parent does a global-blocking waitall
-        # Child doesn't need to keep track of parent at all?
-        # Child will just exit! when it is done
-        @previous_pid ||= []
-        @previous_pid.push parent_pid
+      if target_pid.nil? && @previous_pid && ! @previous_pid.empty?
+        count = 1 if count == 0
+        target_pid = @previous_pid[-count]
+      else
+        target_pid = target_pid
+      end
 
+      if target_pid
+        dlog("ME #{$$}: I found a target pid #{target_pid}! TIME TRAVEL TIME")
+        Process.kill 'SIGCONT', target_pid
+        enter_suspended_animation
+      else
+        dlog("I was unable to time travel. Maybe it is a myth.");
       end
     end
 
-    def go_back
-      dlog("ME #{$$}: Thinking about time travel...");
-      dlog("ME #{$$}: previous_pid = #{ @previous_pid }");
-      if @previous_pid && ! @previous_pid.empty?
-        previous_pid = @previous_pid.pop
-        dlog("ME #{$$}: I found a previous pid #{previous_pid}! TIME TRAVEL TIME")
-
-        # Method 1: Awaken the child and let them take over
-        # Main parent can't exit or shell will get upset, so wait for all children
-        # Once all children are done, kill ourself
-        #  Process.kill 'SIGCONT', previous_pid
-        #  dlog("ME #{$$}: I resumed pid #{previous_pid}... now time to wait")
-        #  #  Process.waitpid(previous_pid)
-        #  Process.waitall
-        #  dlog("ME #{$$}: If you meet your previous self, kill yourself.")
-        #  #  Process.kill 'SIGKILL', $$
-        #  Kernel.exit!
-
-        # Method 2: Kill ourself and let the parent take over
-        # The parent was just doing a waitpid, so it is ready
-        #  Process.kill 'SIGKILL', $$
-        Process.exit! 42
-
-      end
-      dlog("ME #{$$}: I was unable to time travel. Maybe it is a myth.");
+    def restore_root_snapshot
+      restore_snapshot($timetravel_root) if $timetravel_root
     end
+
   end
 end
 

data/lib/pry-timetravel/commands.rb

@@ -1,49 +1,57 @@
 
-Pry::Commands.create_command "checkpoint", "Set a marker in the timeline" do
-  match 'checkpoint'
+Pry::Commands.create_command "snap", "Create a snapshot that you can later return to" do
+  match 'snap'
   group 'Timetravel'
-  #  description 'Snapshot the world so we can timetravel back here later'
   banner <<-'BANNER'
-    Usage: checkpoint
-           checkpoint --list
-           checkpoint --delete [INDEX]
+    Usage: snap [cmd]
+           snap --list
 
-    This will add a checkpoint which you can return to later.
+    This will add a snapshot which you can return to later.
+    
+    If you provide [cmd] then that command will also be run -- nice for "snap next" in conjunction with pry-byebug.
   BANNER
 
-  #  def options(opt)
-    #  opt.on :d, :delete,
-      #  "Delete the checkpoint with the given index. If no index is given delete them all",
+  def options(opt)
+    #  opt.on :d, :delete=,
+      #  "Delete the snapshot with the given index. If no index is given delete them all",
       #  :optional_argument => true, :as => Integer
-    #  opt.on :l, :list,
-      #  "Show all checkpoints"
-  #  end
+    opt.on :l, :list,
+      "Show a list of existing snapshots"
+  end
   def process
-    PryTimetravel.checkpoint
+    if opts.l?
+      output.puts PryTimetravel.snapshot_list
+    else
+      PryTimetravel.snapshot do
+        run(args.join(" ")) unless args.empty?
+      end
+    end
   end
 end
 
-Pry::Commands.create_command "timetravel", "Set a marker in the timeline" do
-  match 'timetravel'
+Pry::Commands.create_command "back", "Go back to the most recent snapshot" do
+  match 'back'
   group 'Timetravel'
-  #  description 'Snapshot the world so we can timetravel back here later'
   banner <<-'BANNER'
-    Usage: checkpoint
-           checkpoint --list
-           checkpoint --delete [INDEX]
+    Usage: back [count]
+           back --pid pid
+           back --home
 
-    This will add a checkpoint which you can return to later.
+    Go back to a previous snapshot.
   BANNER
 
-  #  def options(opt)
-    #  opt.on :d, :delete,
-      #  "Delete the checkpoint with the given index. If no index is given delete them all",
-      #  :optional_argument => true, :as => Integer
-    #  opt.on :l, :list,
-      #  "Show all checkpoints"
-  #  end
+  def options(opt)
+    opt.on :p, :pid=, "Jump (back) to a specific snapshot identified by [pid]",
+      :as => Integer
+    opt.on :home, "Jump to the end of the original execution sequence"
+  end
   def process
-    PryTimetravel.go_back
+    if opts.h?
+      PryTimetravel.restore_root_snapshot
+    else
+      count = args.first.to_i
+      PryTimetravel.restore_snapshot(opts[:p], count)
+    end
   end
 end
 

data/pry-timetravel.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'pry-timetravel'
-  s.version       = '0.0.1'
+  s.version       = '0.0.2'
   s.summary       = 'Timetravel'
   s.description   = 'Allows you to timetravel!'
   s.homepage      = 'https://github.com/awwaiid/pry-timetravel'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pry-timetravel
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Brock Wilcox
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-07 00:00:00.000000000 Z
+date: 2014-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -81,4 +81,3 @@ signing_key:
 specification_version: 4
 summary: Timetravel
 test_files: []
-has_rdoc: