ruby_traverser 0.1.0 → 0.1.1

data/README.markdown

@@ -1,10 +1,14 @@
 # Ruby traverser ##
 
 A DSL for traversing ruby code as an object model (graph), which lets you find parts of the ruby code of interest.
-The traverser leverages `ripper2ruby`, which leverages `ripper`, which comes with ruby 1.9. Ruby 1.9 is thus required.
+The traverser leverages `ripper2ruby`, a library for generating a model from ruby source code. `ripper2ruby` leverages `ripper` which comes with ruby 1.9. 
 
 See the unit tests in the test directory for examples of use.
 
+## Requirements ##
+* Ruby 1.9
+* ripper2ruby >= 0.0.2 
+
 ## Finders ##
 
 * find_module(name)
@@ -178,7 +182,92 @@ The API now also supports a wide variety of code mutations using a DSL.
 More information will soon be available here or on the github wiki.
 Check the test/mutate folder for test demonstrating what is currently possible.
 
-Note: The mutation API code was developed in a test-driven fashion, but is in need of a major refactoring overhaul sometime soon...
+## Example use of Mutation API ##
+
+Source BEFORE mutations:
+<pre>
+class Monty < Abc::Blip  
+end
+</pre>
+
+<pre>
+    src = %q{  class Monty < Abc::Blip 
+  end}
+    
+    def_src = %q{
+def my_fun
+end}
+
+    def_code = Ripper::RubyBuilder.build(def_src)    
+    code = Ripper::RubyBuilder.build(src)
+
+    # append code examples                  
+    code.inside_class('Monty', :superclass => 'Abc::Blip') do |b|
+      assert_equal Ruby::Class, b.class                                  
+      gem_abc = b.append_code("gem 'abc'")
+      blip = b.append_code("blip")
+      gem_123 = gem_abc.append_code("gem '123'")      
+      gem_123.append_comment("hello")      
+      my_def = b.append_code(def_src)      
+      
+      b.prepend_code("gem '789'")
+      puts b.to_ruby
+    end
+</pre>
+
+Source AFTER mutations:
+<pre>
+class Monty < Abc::Blip  
+  gem '789'  
+  gem 'abc'  
+  gem '123'  
+  blip  
+
+  def my_fun
+  end 
+end
+</pre>  
+
+
+## Replace example ##
+
+Source BEFORE mutations:
+<pre>
+group :test do
+  gem 'ripper', :src 
+  my_var = 2  
+end  
+</pre>
+
+<pre>
+    src = %q{                 
+group :test do
+  gem 'ripper', :src 
+  my_var = 2  
+end  
+    }
+
+    code = Ripper::RubyBuilder.build(src) 
+    # replace examples                                      
+    code.inside_block('group', :args => [:test]) do |b|
+      call_node = b.find_call('gem', :args => ['ripper'])
+      assert_equal Ruby::Call, call_node.class
+      call_node.replace(:arg => :src , :replace_code => "{:src => 'unknown'}")
+      call_node.replace(:value => "3")            
+      puts b.to_ruby
+    end       
+  end  
+</pre>
+
+Source AFTER mutations:
+<pre>
+group :test do
+  gem 'ripper', {:src => 'unknown'} 
+  my_var = 3
+end  
+</pre>  
+
+Note: The mutation API code was developed quickly in a test-driven fashion, but is in need of a major refactoring overhaul sometime soon...
 
 ## Note on Patches/Pull Requests ##
  

data/Rakefile

@@ -11,7 +11,7 @@ begin
     gem.homepage = "http://github.com/kristianmandrup/ruby_trav"
     gem.authors = ["Kristian Mandrup"]
     gem.add_development_dependency "rspec", ">= 2.0.0"
-    gem.add_dependency "ripper2ruby", "> 0.0.2"
+    gem.add_dependency "ripper2ruby", ">= 0.0.2"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
     
     # add more gem options here    

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/mutate/api.rb

@@ -84,13 +84,13 @@ module RubyAPI
     def last_position(elements) 
       last_element = elements.last
       return position.col 
-      return position.col if simple_pos?
+      return position.col if simple_pos?(last_element)
       return last_element.identifier.position.col if elements && elements.size > 0
       inside_indent
     end
 
-    def simple_pos?       
-      [Ruby::Token, Ruby::Variable].include?(last_element.class)
+    def simple_pos?(elem)       
+      [Ruby::Token, Ruby::Variable].include?(elem.class)
     end
 
     def first_indent
@@ -104,7 +104,7 @@ module RubyAPI
 
     def first_position(elements) 
       first_element = elements.first
-      return position.col if simple_pos?
+      return position.col if simple_pos?(first_element)
       return first_element.identifier.position.col if elements && elements.size > 0
       inside_indent
     end

data/ruby_traverser.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruby_traverser}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
@@ -66,14 +66,14 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<rspec>, [">= 2.0.0"])
-      s.add_runtime_dependency(%q<ripper2ruby>, ["> 0.0.2"])
+      s.add_runtime_dependency(%q<ripper2ruby>, [">= 0.0.2"])
     else
       s.add_dependency(%q<rspec>, [">= 2.0.0"])
-      s.add_dependency(%q<ripper2ruby>, ["> 0.0.2"])
+      s.add_dependency(%q<ripper2ruby>, [">= 0.0.2"])
     end
   else
     s.add_dependency(%q<rspec>, [">= 2.0.0"])
-    s.add_dependency(%q<ripper2ruby>, ["> 0.0.2"])
+    s.add_dependency(%q<ripper2ruby>, [">= 0.0.2"])
   end
 end
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Kristian Mandrup
@@ -36,7 +36,7 @@ dependencies:
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version 
         segments: 
         - 0