rogerdpack-remembered_evals 0.0.1 → 0.0.3

data/README

@@ -0,0 +1,19 @@
+remembered_evals:
+
+A library to make debugging eval'ed code possible.  It monkey patches Kernel.eval, module_eval, and class_eval to save eval'ed code to a file at ._remembered_evals/hash_of_that_file
+
+Thus you can debug [ex: using ruby-debug] THROUGH eval'ed code, now, as well as see appropriate (better) eval'ed code lines in exception backtraces.
+
+Since it saves files by hash, and doesn't rewrite them once saved, you could also edit eval'ed blocks and it will use the edited versions--i.e. it allows you to override certain strings passed to eval [it uses yours instead of the original]-- quite useful for debugging purposes if you use eval at all.
+
+Note that if all you want to do is save the code away [not debug through] then you can 
+set
+SCRIPT_LINES__ = {}
+somewhere in your script.
+
+Note also that it breaks eval'ed code that assumes the default binding, i.e.
+a = 3
+eval("a = 4") # breaks
+eval("a = 4", binding) # works though
+
+The price we pay for debugging convenience.  You may want to therefore do all you gem requires before loading it.

data/lib/remembered_evals.rb

@@ -1,37 +1,94 @@
 require 'digest/md5'
 require 'rubygems'
 require 'facets/file/write'
+require 'facets/file/read' # File.sanitize
 
-module Kernel
- alias :original_eval :eval
 
 =begin rdoc
-
  doctest: eval saves away files into some path, then eval's them from there
  >> eval "$a = 3"
- >> File.directory? '.remembered_evals'
+ >> File.directory? '._remembered_evals'
  => true
  >> $a
  => 3
 
- TODO work with class_eval, too
 
-
- Using it causes the backtraces to behave slightly differently
- >> eval "begin; raise; rescue Exception => e; $a = e; end"
- >> $a.backtrace[0].include? '.remembered_evals/'
- >> true
+ Using it causes the backtraces to behave slightly differently [I'd call it better]
+ >> eval "begin; raise; rescue Exception => e; $exception = e; end"
+ >> $exception.backtrace[0]
+ => "._remembered_evals/beginraiserescueExceptiona48fc331d57ebd559347525d306d6a67:1:in `eval'"
 
 =end
-
- def eval *args # string, binding, file, line [file and line are hereby ignored since ours supplant it]
-  path = '.remembered_evals'
+class RememberedEval
+ def self.cache_code code_string
+  path = '._remembered_evals'
   Dir.mkdir path unless File.directory? path
-  digest = Digest::MD5.hexdigest("Hello World\n")
-  fullpath = path + '/' + Digest::MD5.hexdigest(args[0])
-  saved = File.write(fullpath, args[0])
-  original_eval args[0], args[1], fullpath, 1
+  # create something like /code0xdeadbeef for filename
+  fullpath = path + '/' + File.sanitize(code_string[0..31]).gsub('_', '') + Digest::MD5.hexdigest(code_string)[0..63] # don't need too long here
+  if File.exist? fullpath
+    code_string = File.read(fullpath)
+  else
+    File.write(fullpath, code_string) # write it out [prefer old data there, so people can edit them by hand if they are experimenting with eval'ed code]
+  end
+  [code_string, fullpath]
  end
 
 end
 
+class Module
+ alias :original_class_eval :module_eval
+
+ def module_eval *args
+  if block_given? # this one is already sourced
+    original_class_eval { yield }
+  else
+    code, path = RememberedEval.cache_code args[0]
+    original_class_eval code, path, 1 # no binding here
+  end
+ end
+end
+
+class Class
+ alias :original_class_eval :class_eval
+
+ def class_eval *args
+  if block_given? # this one is already sourced
+    original_class_eval { yield }
+  else
+    code, path = RememberedEval.cache_code args[0]
+    original_class_eval code, path, 1 # no binding here
+  end
+ end
+end
+
+
+class Object
+ alias :original_eval :eval
+ def eval *args
+   code, path = RememberedEval.cache_code args[0]
+   original_eval code, args[1], path, 1 # args[1] is binding, ignore args[2], 3 [file, line no]
+ end
+
+end
+
+=begin rdoc
+ doctest: work with mod, too
+ >> class A; end
+ >> A.class_eval "def go3; 3; end"
+ >> A.new.go3
+ => 3
+
+ doctest: it reverts back to normal [non-cached] behavior unless you pass it a binding [?]
+ >> a = 3
+ >> eval "a = 4"
+ >> a
+ => 4
+
+ doctest: works with modules, too
+ >> module M; end
+ >> M.module_eval "def go; 3; end"
+ >> M.instance_methods
+ => ["go"]
+
+=end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rogerdpack-remembered_evals
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors: 
 - Roger Pack
@@ -39,15 +39,17 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README
 files: 
 - lib/remembered_evals.rb
+- README
 has_rdoc: false
 homepage: http://github.com/rogerdpack/ruby_remembered_eval/tree/master
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --main
+- README
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement