live_ast 0.2.0 → 0.2.1

data/CHANGES.rdoc

@@ -1,6 +1,13 @@
 
 = LiveAST ChangeLog
 
+== Version 0.2.1
+
+* fixed some rdoc issues
+* removed rubyforge references
+* update ruby_parser
+* less MRI-centric tests
+
 == Version 0.2.0
 
 * initial release

data/MANIFEST

@@ -7,7 +7,6 @@ lib/live_ast.rb
 lib/live_ast/ast_eval.rb
 lib/live_ast/ast_load.rb
 lib/live_ast/base.rb
-lib/live_ast/cache.rb
 lib/live_ast/error.rb
 lib/live_ast/evaler.rb
 lib/live_ast/linker.rb

data/README.rdoc

@@ -56,6 +56,8 @@ methods and procs.
 
   % gem install live_ast
 
+A manual install option is also available.
+
 == Description
 
 LiveAST enables a program to find the ASTs of objects created by
@@ -69,15 +71,18 @@ another parser may be easily substituted (in fact the name +to_ast+ is
 used instead of +to_sexp+ because LiveAST has no understanding of what
 the parser outputs).
 
+Note that RubyParser does not currently support the newer Ruby 1.9
+syntax features (<code>Racc::ParseError</code> will be raised).
+
 LiveAST is thread-safe.
 
 Ruby 1.9.2 or higher is required.
 
 == Links
 
-* Documentation: http://liveast.rubyforge.org
-* Rubyforge home: http://rubyforge.org/projects/liveast/
-* Repository: http://github.com/quix/live_ast
+* Home: https://github.com/quix/live_ast
+* Documentation: http://quix.github.com/live_ast
+* Feature Requests, Bug Reports: http://github.com/quix/live_ast/issues
 
 == +to_ruby+
 
@@ -149,6 +154,18 @@ or blocks in order for its AST to be available.
   a = lambda { } ; b = lambda { }
   a.to_ast # => raises LiveAST::MultipleDefinitionsOnSameLineError
 
+== Manual Download/Install
+
+http://github.com/quix/live_ast/archives/master
+
+  % tar zxvf live_ast-x.x.x.tgz
+  % cd live_ast-x.x.x
+  % rake install
+
+To uninstall,
+
+  % rake uninstall
+
 == Technical Issues
 
 You can probably ignore this section. Goodbye.
@@ -240,19 +257,18 @@ give the old AST,
   load "foo.rb"                       # oops! forgot to use ast_load
   p Foo.instance_method(:bar).to_ast  # => stale AST
 
-Realize that +foo.rb+ may be referenced by an unknown number of
-methods and blocks. If the original +foo.rb+ source were dumped in
-favor of the modified +foo.rb+, then an unknown number of those
-references would be invalidated (and some may even point to the wrong
-AST!).
+Realize that <code>foo.rb</code> may be referenced by an unknown
+number of methods and blocks. If the original <code>foo.rb</code>
+source were dumped in favor of the modified <code>foo.rb</code>, then
+an unknown number of those references would be invalidated (and some
+may even point to the wrong AST!).
 
 This is the reason for the caching that results in the stale AST
 above. It should now be clear why the default behavior of
 <code>require 'live_ast'</code> is to redefine +load+: doing so
 prevents this problem entirely. On the other hand if it is fully known
 where and when files are being reloaded (if at all) then there's no
-need for paranoia; this noninvasive option may be most the
-appropriate.
+need for paranoia; the noninvasive option may be the most appropriate.
 
 === The Source/AST Cache
 
@@ -351,7 +367,7 @@ to fill in the missing binding argument. Unfortunately a limitation
 with tracing events in MRI places a few odd restrictions on the syntax
 surrounding +eval+, though all restrictions can be trivially
 sidestepped. Nonetheless it does work (it passes rubyspec minus the
-backtrace issue) despite being somewhat impractical.
+above backtrace issue) despite being somewhat impractical.
 
 This (mis)feature is maintained in a separate branch named
 +replace_eval+ on github (not part of the gem). For more information see

data/Rakefile

@@ -2,17 +2,19 @@ require_relative 'devel/jumpstart'
 
 Jumpstart.new "live_ast" do |s|
   s.developer "James M. Lawrence", "quixoticsycophant@gmail.com"
-  s.rubyforge_user = "quix"
-  s.rubyforge_name = "liveast"
+  s.github_user = "quix"
   s.camel_name = "LiveAST"
   s.rdoc_title = "LiveAST: Live Abstract Syntax Trees"
+  s.extra_rdoc_options = ["-a"]
   
   # my code compensates for a ruby_parser bug; make this equal for now
-  s.dependency("ruby_parser", "= 2.0.5")
+  s.dependency("ruby_parser", "= 2.0.6")
 
   s.rdoc_files = %w[
     README.rdoc
     lib/live_ast/ast_eval.rb
+    lib/live_ast/to_ast.rb
+    lib/live_ast/to_ruby.rb
     lib/live_ast/base.rb
     lib/live_ast/version.rb
   ]

data/devel/jumpstart.rb

@@ -311,14 +311,6 @@ class Jumpstart
     end or "0.0.0"
   end
   
-  attribute :rubyforge_name do
-    name.gsub('_', '')
-  end
-
-  attribute :rubyforge_user do
-    email.first[%r!\A.*?(?=@)!]
-  end
-  
   attribute :readme_file do
     "README.rdoc"
   end
@@ -328,7 +320,7 @@ class Jumpstart
   end
   
   attribute :doc_dir do
-    "documentation"
+    "doc"
   end
   
   attribute :spec_files do
@@ -420,6 +412,10 @@ class Jumpstart
     }
   end
 
+  attribute :extra_rdoc_options do
+    []
+  end
+
   attribute :browser do
     require 'rbconfig'
     if RbConfig::CONFIG["host"] =~ %r!darwin!
@@ -448,10 +444,6 @@ class Jumpstart
         )
       }
 
-      if rubyforge_name
-        g.rubyforge_project = rubyforge_name
-      end
-
       if url
         g.homepage = url
       end
@@ -516,10 +508,14 @@ class Jumpstart
     begin
       readme_contents.match(%r!^\*.*?(http://\S+)!)[1]
     rescue
-      "http://#{rubyforge_name}.rubyforge.org"
+      "http://#{github_user}.github.com/#{name}"
     end
   end
 
+  attribute :github_user do
+    "FIXME"
+  end
+
   attribute :extra_deps do
     []
   end
@@ -642,8 +638,14 @@ class Jumpstart
       
       desc "run full_test then open browser"
       task :show_test => :full_test do
+        show = lambda { open_browser(cov_dir + "/index.html") }
         if ruby_18?
-          open_browser(cov_dir + "/index.html")
+          show.call
+        else
+          SimpleCov.at_exit do
+            SimpleCov.result.format!
+            show.call
+          end
         end
       end
       
@@ -662,9 +664,11 @@ class Jumpstart
   def define_doc
     desc "run rdoc"
     task :doc => :clean_doc do
+      Kernel.send :gem, 'rdoc' rescue nil
       require 'rdoc/rdoc'
       args = (
         gemspec.rdoc_options +
+        extra_rdoc_options +
         gemspec.require_paths.clone +
         gemspec.extra_rdoc_files +
         ["-o", doc_dir]
@@ -687,14 +691,19 @@ class Jumpstart
   end
 
   def define_publish
-    desc "upload docs"
-    task :publish => [:clean_doc, :doc] do
-      require 'rake/contrib/sshpublisher'
-      Rake::SshDirPublisher.new(
-        "#{rubyforge_user}@rubyforge.org",
-        "/var/www/gforge-projects/#{rubyforge_name}",
-        doc_dir
-      ).upload
+    desc "publish docs"
+    task :publish => [:clean, :check_directory, :doc] do
+      git "branch", "-D", "gh-pages"
+      git "checkout", "--orphan", "gh-pages"
+      FileUtils.rm ".git/index"
+      git "clean", "-fdx", "-e", "doc"
+      Dir["doc/*"].each { |path|
+        FileUtils.mv path, "."
+      }
+      FileUtils.rmdir "doc"
+      git "add", "."
+      git "commit", "-m", "generated by rdoc"
+      git "push", "-f", "origin", "gh-pages"
     end
   end
 
@@ -845,7 +854,7 @@ class Jumpstart
       git(*%w(push --tags origin master))
     end
 
-    task :release => [:prerelease, :package, :publish, :finish_release]
+    task :release => [:prerelease, :package, :finish_release]
   end
 
   def define_debug_gem

data/lib/live_ast/ast_eval.rb

@@ -3,10 +3,8 @@ require 'live_ast/base'
 module Kernel
   private
 
-  #
   # The same as +eval+ except that the binding argument is required
   # and AST-accessible objects are created.
-  #
   def ast_eval(*args)
     LiveAST::Evaler.eval(args[0], *args)
   end

data/lib/live_ast/base.rb

@@ -4,7 +4,6 @@ require 'live_ast/parser'
 require 'live_ast/loader'
 require 'live_ast/evaler'
 require 'live_ast/linker'
-require 'live_ast/cache'
 require 'live_ast/error'
 
 module LiveAST
@@ -14,7 +13,7 @@ module LiveAST
     #
     # For use in noninvasive mode (<code>require 'live_ast/base'</code>).
     #
-    # Extract an object's AST.
+    # Equivalent to <code>obj.to_ast</code>.
     #
     def ast(obj)  #:nodoc:
       case obj
@@ -38,7 +37,7 @@ module LiveAST
     #
     # For use in noninvasive mode (<code>require 'live_ast/base'</code>).
     #
-    # Equivalent to Kernel#ast_eval.
+    # Equivalent to <code>Kernel#ast_eval</code>.
     #
     def eval(*args)  #:nodoc:
       Evaler.eval(args[0], *args)
@@ -47,7 +46,7 @@ module LiveAST
     #
     # For use in noninvasive mode (<code>require 'live_ast/base'</code>).
     #
-    # Equivalent to Kernel#ast_load.
+    # Equivalent to <code>Kernel#ast_load</code>.
     #
     def load(file, wrap = false)  #:nodoc:
       Loader.load(file, wrap)

data/lib/live_ast/error.rb

@@ -17,8 +17,7 @@ module LiveAST
   
   class NoSourceError < ASTNotFoundError
     def message
-      "No source found for the requested AST. " <<
-      "Are you sure it was written in ruby?"
+      "No source found for the requested AST."
     end
   end
 

data/lib/live_ast/linker.rb

@@ -1,4 +1,18 @@
 module LiveAST
+  class Cache
+    def initialize(*args)
+      @source, @user_line = args
+      @asts = nil
+    end
+
+    def fetch_ast(line)
+      @asts ||= Parser.new.parse(@source).tap do
+        @source = nil
+      end
+      @asts.delete(line - @user_line + 1)
+    end
+  end
+
   module Attacher
     VAR_NAME = :@_live_ast
       
@@ -77,7 +91,7 @@ module LiveAST
       end
 
       #
-      # create a cache along with a uniquely-identifing key for it
+      # create a cache along with a unique key for it
       #
       def new_cache(contents, file, user_line, file_is_key)
         key = file_is_key ? file : file + REVISION_TOKEN + @counter

data/lib/live_ast/to_ast.rb

@@ -2,8 +2,7 @@ require 'live_ast/base'
 
 [Method, UnboundMethod].each do |klass|
   klass.class_eval do
-    # Extract the AST of this object.
-    def to_ast
+    def to_ast #:nodoc:
       LiveAST::Linker.find_method_ast(owner, name, *source_location)
     end
   end
@@ -15,3 +14,13 @@ class Proc
     LiveAST::Linker.find_proc_ast(self)
   end
 end
+
+class Method
+  # :method: to_ast
+  # Extract the AST of this object.
+end
+
+class UnboundMethod
+  # :method: to_ast
+  # Extract the AST of this object.
+end

data/lib/live_ast/to_ruby.rb

@@ -4,9 +4,32 @@ require 'live_ast/base'
 
 [Method, UnboundMethod, Proc].each do |klass|
   klass.class_eval do
-    # Generate ruby code which reflects the AST of this object.
-    def to_ruby
+    def to_ruby  #:nodoc:
       Ruby2Ruby.new.process(LiveAST.ast(self))
     end
   end
 end
+
+class Method
+  # :method: to_ruby
+  # Generate ruby code which reflects the AST of this object.
+  #
+  # Defined by <code>require 'live_ast/to_ruby'</code>. The ruby2ruby
+  # gem must be installed.
+end
+
+class UnboundMethod
+  # :method: to_ruby
+  # Generate ruby code which reflects the AST of this object.
+  #
+  # Defined by <code>require 'live_ast/to_ruby'</code>. The ruby2ruby
+  # gem must be installed.
+end
+
+class Proc
+  # :method: to_ruby
+  # Generate ruby code which reflects the AST of this object.
+  # 
+  # Defined by <code>require 'live_ast/to_ruby'</code>. The ruby2ruby
+  # gem must be installed.
+end

data/lib/live_ast/version.rb

@@ -1,3 +1,3 @@
 module LiveAST
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/test/shared/main.rb

@@ -66,11 +66,15 @@ class BaseTest < JLMiniTest
 
   DATA_DIR = File.expand_path(File.dirname(__FILE__) + "/../data")
 
-  def temp_file(basename = nil)
-    unless basename
-      basename = ('a'..'z').to_a.shuffle.join + ".rb"
+  def self.stdlib_has_source?
+    case RUBY_ENGINE
+    when "ruby"  # MRI; possibly others; not jruby
+      true
     end
+  end
 
+  def temp_file(basename = nil)
+    basename ||= ('a'..'z').to_a.shuffle.join + ".rb"
     path = DATA_DIR + "/" + basename
     FileUtils.mkdir DATA_DIR unless File.directory? DATA_DIR
 

data/test/stdlib_test.rb

@@ -1,11 +1,13 @@
 require_relative 'shared/main'
 
 class StdlibTest < RegularTest
-  def test_pp
-    assert_not_nil method(:pp).to_ast
-  end
-
-  def test_find
-    assert_not_nil Find.method(:find).to_ast
+  if stdlib_has_source?
+    def test_pp
+      assert_not_nil method(:pp).to_ast
+    end
+    
+    def test_find
+      assert_not_nil Find.method(:find).to_ast
+    end
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: live_ast
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - James M. Lawrence
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-17 00:00:00 -05:00
+date: 2011-02-20 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -21,7 +21,7 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        version: 2.0.5
+        version: 2.0.6
   type: :runtime
   version_requirements: *id001
 description: LiveAST enables a program to find the ASTs of objects created by dynamically generated code.
@@ -42,7 +42,6 @@ files:
 - lib/live_ast/ast_eval.rb
 - lib/live_ast/ast_load.rb
 - lib/live_ast/base.rb
-- lib/live_ast/cache.rb
 - lib/live_ast/error.rb
 - lib/live_ast/evaler.rb
 - lib/live_ast/linker.rb
@@ -89,7 +88,7 @@ files:
 - test/to_ruby_test.rb
 - MANIFEST
 has_rdoc: true
-homepage: http://liveast.rubyforge.org
+homepage: http://quix.github.com/live_ast
 licenses: []
 
 post_install_message: 
@@ -109,8 +108,6 @@ rdoc_options:
 - --exclude
 - lib/live_ast/ast_load.rb
 - --exclude
-- lib/live_ast/cache.rb
-- --exclude
 - lib/live_ast/error.rb
 - --exclude
 - lib/live_ast/evaler.rb
@@ -125,10 +122,6 @@ rdoc_options:
 - --exclude
 - lib/live_ast/replace_raise.rb
 - --exclude
-- lib/live_ast/to_ast.rb
-- --exclude
-- lib/live_ast/to_ruby.rb
-- --exclude
 - test/ast_eval_feature_test.rb
 - --exclude
 - test/ast_load_feature_test.rb
@@ -214,7 +207,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: liveast
+rubyforge_project: 
 rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3

data/lib/live_ast/cache.rb

@@ -1,14 +0,0 @@
-module LiveAST
-  class Cache
-    def initialize(*args)
-      @source, @user_line, @asts = args
-    end
-
-    def fetch_ast(line)
-      @asts ||= Parser.new.parse(@source).tap do
-        @source = nil
-      end
-      @asts.delete(line - @user_line + 1)
-    end
-  end
-end