ruby_traverser 0.2.0 → 0.2.1

data/README.markdown

@@ -40,6 +40,21 @@ The insert and update API support blocks and always returns the updated or inser
 * update(:select, :with_code, &block)
 * update(:value, &block)
 
+Supports updating 
+* arguments (for method calls, block and method definitions)
+* assignment values (for assignments)
+
+Argument find for update
+* by position (fx :arg => '#1')
+* by key name (fx :arg => :src) 
+* by value (fx :arg => 'blip')
+
+Note:
+Update needs some polishing and is still a little buggy!
+                                                              
+TODO:
+update identifier of module, class, method call and method definition. 
+
 ### Delete ##
 * delete
 

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/lib/manipulation/delete/api.rb

@@ -1,6 +1,9 @@
 module RubyCodeAPI
   module Manipulation  
     module Delete
+      class DeleteError < StandardError
+      end
+
       def delete
         # index = parent.find_index(self)
         parent.get_elements.delete(self)    

data/lib/manipulation/insert/api.rb

@@ -1,36 +1,8 @@
 module RubyCodeAPI
   module Manipulation  
     module Insert
-      def append_code(code)
-        return append_code_simple(code) if !elemental?
-        obj = object
-        indentation = obj.last_indent  
-        code =  "\n#{code}\n".indent(' ', indentation)
-        ruby_code = Ripper::RubyBuilder.build(code)
-        inject_code = ruby_code.elements[0]
-        obj.get_elements << inject_code
-        inject_code
-      end
-
-      def append_code_simple(code)
-        indentation = position.col
-        code =  "\n#{code}\n".indent(' ', indentation)
-        ruby_code = Ripper::RubyBuilder.build(code)
-        inject_code = ruby_code.elements[0]
-        index = parent.find_index(self)
-        parent.get_elements.insert(index+1, inject_code)
-        inject_code
-      end
-
-      def prepend_code(code)
-        obj = object
-        indentation = obj.first_indent  
-        code =  "\n#{code}\n".indent(' ', indentation)
-        ruby_code = Ripper::RubyBuilder.build(code)
-        inject_code = ruby_code.elements[0]
-        obj.get_elements.insert(0, inject_code)
-        obj
-      end
+      class InsertError < StandardError
+      end      
 
       def insert_comment(position, text, &block)
         insert(position, "# #{text}", &block)    
@@ -43,7 +15,7 @@ module RubyCodeAPI
         when :before
           s = prepend_code(code)
         else
-          raise Error, "Invalid position given: #{position}, must be either :before or :after"
+          raise InsertError, "Invalid position given: #{position}, must be either :before or :after"
         end  
     
         if block_given?
@@ -52,6 +24,40 @@ module RubyCodeAPI
           s
         end    
       end  
+
+      protected
+      
+        def append_code(code)
+          return append_code_simple(code) if !elemental?
+          obj = object
+          indentation = obj.last_indent  
+          code =  "\n#{code}\n".indent(' ', indentation)
+          ruby_code = Ripper::RubyBuilder.build(code)
+          inject_code = ruby_code.elements[0]
+          obj.get_elements << inject_code
+          inject_code
+        end
+
+        def append_code_simple(code)
+          indentation = position.col
+          code =  "\n#{code}\n".indent(' ', indentation)
+          ruby_code = Ripper::RubyBuilder.build(code)
+          inject_code = ruby_code.elements[0]
+          index = parent.find_index(self)
+          parent.get_elements.insert(index+1, inject_code)
+          inject_code
+        end
+
+        def prepend_code(code)
+          obj = object
+          indentation = obj.first_indent  
+          code =  "\n#{code}\n".indent(' ', indentation)
+          ruby_code = Ripper::RubyBuilder.build(code)
+          inject_code = ruby_code.elements[0]
+          obj.get_elements.insert(0, inject_code)
+          obj
+        end
+
     end  
   end
 end

data/lib/manipulation/update/api.rb

@@ -1,100 +1,18 @@
-module PositionReplacer
-  def replace_position_arg(options)
-    pos = position_arg?(options[:arg])
-    self.arguments.elements[pos.to_i].replace_pos_argument(options)      
-  end
-
-  def replace_pos_argument(options)                                    
-    case self.arg
-    when Ruby::String                                    
-      replace_arg_token(options[:with])
-    end
-  end
-
-  def position_arg?(arg)       
-    return arg[1] if arg && arg[0]  == '#'
-    nil
-  end
-end
-
-module TokenReplacer
-  def replace_arg_token(replacement)
-    self.arg.elements[0].token = replacement         
-  end
-
-  def matching_string_arg?(txt)
-    self.arg.elements[0].token == txt
-  end                    
-end
-
-module HashReplacer
-  def hash_arg?(arg) 
-    case arg
-    when Hash 
-      matching_hash_arg?(arg)
-    when Symbol
-      matching_symbol_arg?(arg)      
-    end
-  end                    
-
-  def replace_hash_arg(options) 
-    src = options[:replace_code]        
-    code = Ripper::RubyBuilder.build(src)
-    code.set_ldelim(self.arg) 
-    self.arg = code
-  end
-
-  def set_ldelim(arg)
-    if arg.respond_to? :elements
-      self.ldelim = arg.elements[0].key.ldelim
-      self.ldelim.token = ''
-    else                  
-      self.ldelim = arg.ldelim
-    end
-  end
-  
-  def matching_hash_arg?(arg)
-    if self.arg.respond_to? :elements
-      if self.arg.elements[0].class == Ruby::Assoc
-        key = self.arg.elements[0].key
-        value = self.arg.elements[0].value
-        arg_key = arg.first[0]
-        arg_value = arg.first[1]
-        return key.identifier.token.to_sym == arg_key && value.elements[0].token == arg_value
-      end
-    end
-    false
-  end
-  
-  def matching_symbol_arg?(arg)
-    if self.arg.respond_to? :elements
-      if self.arg.elements[0].class == Ruby::Assoc
-        return self.arg.elements[0].key.identifier.token.to_sym == arg
-      end
-    else
-      # remove ':' token from symbol      
-      self.arg.ldelim.token = ''
-      return self.arg.identifier.token.to_sym == arg       
-    end
-    false
-  end
-end
-
-module ValueReplacer
-  def replace_value(options)
-    if self.class == Ruby::Assignment 
-      self.right.token = options[:value]
-    end
-  end 
-end
+require 'manipulation/update/value'
+require 'manipulation/update/position'
+require 'manipulation/update/hash'
+require 'manipulation/update/token'
 
 module RubyCodeAPI
   module Manipulation  
     module Update
-      include PositionReplacer
-      include TokenReplacer  
-      include HashReplacer
-      include ValueReplacer              
+      include Position
+      include Token  
+      include Hash
+      include Value              
+
+      class UpdateError < StandardError
+      end      
 
       # update :select => {...}, :with => {...}
       # update :select => {...}, :with_code => 'code'
@@ -111,9 +29,12 @@ module RubyCodeAPI
       # :arg => 'ripper', :replace_arg => 'rapper'
       def replace(options)                               
         return replace_value(options) if options[:value]
-        return replace_position_arg(options) if position_arg?(options[:arg])
+        if position_arg?(options[:arg])
+          puts "POSITION ARG"
+          return replace_position_arg(options) 
+        end
         return replace_arg(options) if options[:arg]
-        raise Error, "Invalid options: #{options}"
+        raise UpdateError, "Invalid replace options: #{options}"
       end
 
       def replace_arg(options)
@@ -132,6 +53,8 @@ module RubyCodeAPI
         case self.arg
         when Ruby::String                                    
           replace_arg_token(options[:with]) if matching_string_arg?(options[:arg])  
+        else
+          raise UpdateError, "Invalid replace_argument options: #{options}"          
         end
       end
 

data/lib/manipulation/update/hash.rb

@@ -0,0 +1,58 @@
+module RubyCodeAPI
+  module Manipulation  
+    module Update
+      module Hash
+        def hash_arg?(arg) 
+          case arg
+          when Hash 
+            matching_hash_arg?(arg)
+          when Symbol
+            matching_symbol_arg?(arg)      
+          end
+        end                    
+
+        def replace_hash_arg(options) 
+          src = options[:replace_code]        
+          code = Ripper::RubyBuilder.build(src)
+          code.set_ldelim(self.arg) 
+          self.arg = code
+        end
+
+        def set_ldelim(arg)
+          if arg.respond_to? :elements
+            self.ldelim = arg.elements[0].key.ldelim
+            self.ldelim.token = ''
+          else                  
+            self.ldelim = arg.ldelim
+          end
+        end
+  
+        def matching_hash_arg?(arg)
+          if self.arg.respond_to? :elements
+            if self.arg.elements[0].class == Ruby::Assoc
+              key = self.arg.elements[0].key
+              value = self.arg.elements[0].value
+              arg_key = arg.first[0]
+              arg_value = arg.first[1]
+              return key.identifier.token.to_sym == arg_key && value.elements[0].token == arg_value
+            end
+          end
+          false
+        end
+  
+        def matching_symbol_arg?(arg)
+          if self.arg.respond_to? :elements
+            if self.arg.elements[0].class == Ruby::Assoc
+              return self.arg.elements[0].key.identifier.token.to_sym == arg
+            end
+          else
+            # remove ':' token from symbol      
+            self.arg.ldelim.token = ''
+            return self.arg.identifier.token.to_sym == arg       
+          end
+          false
+        end
+      end
+    end
+  end
+end

data/lib/manipulation/update/position.rb

@@ -0,0 +1,29 @@
+module RubyCodeAPI
+  module Manipulation  
+    module Update
+      module Position
+        class UpdatePositionError < StandardError
+        end
+        
+        def replace_position_arg(options)
+          pos = position_arg?(options[:arg])
+          self.arguments.elements[pos.to_i].replace_pos_argument(options)      
+        end
+
+        def replace_pos_argument(options)                                    
+          case self.arg
+          when Ruby::String                                    
+            replace_arg_token(options[:with])
+          else
+            raise UpdatePositionError, "Unknown type for replacing positional argument: #{self.arg.class}"
+          end
+        end
+
+        def position_arg?(arg)       
+          return arg[1] if arg && arg[0]  == '#'
+          nil
+        end
+      end            
+    end
+  end
+end

data/lib/manipulation/update/token.rb

@@ -0,0 +1,15 @@
+module RubyCodeAPI
+  module Manipulation  
+    module Update
+      module Token
+        def replace_arg_token(replacement)
+          self.arg.elements[0].token = replacement         
+        end
+
+        def matching_string_arg?(txt)
+          self.arg.elements[0].token == txt
+        end                    
+      end         
+    end
+  end
+end

data/lib/manipulation/update/value.rb

@@ -0,0 +1,13 @@
+module RubyCodeAPI
+  module Manipulation  
+    module Update
+      module Value
+        def replace_value(options)
+          if self.class == Ruby::Assignment 
+            self.right.token = options[:value]
+          end
+        end 
+      end         
+    end
+  end
+end

data/lib/query/find.rb

@@ -11,6 +11,9 @@ module RubyCodeAPI
       :call => Ruby::Call, 
       :def => Ruby::Method
     }
+
+    class FindError < StandardError
+    end      
     
     def find(type, name, options = {}, &block) 
       s = send :"find_#{type.to_s}", name, options
@@ -23,7 +26,7 @@ module RubyCodeAPI
     end        
 
     def inside(type, name, options = {}, &block) 
-      raise StandardError, "Must have block argument" if !block_given?
+      raise FindError, "Must have block argument" if !block_given?
       find(type, name, options = {}, &block)       
     end
 

data/ruby_traverser.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruby_traverser}
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
@@ -35,6 +35,10 @@ Gem::Specification.new do |s|
     "lib/manipulation/insert/api.rb",
     "lib/manipulation/position.rb",
     "lib/manipulation/update/api.rb",
+    "lib/manipulation/update/hash.rb",
+    "lib/manipulation/update/position.rb",
+    "lib/manipulation/update/token.rb",
+    "lib/manipulation/update/value.rb",
     "lib/query/api.rb",
     "lib/query/find.rb",
     "lib/rails/api.rb",

data/test/mutate/mutate_test.rb

@@ -15,7 +15,6 @@ end
     code = Ripper::RubyBuilder.build(src)                 
     
     code.find(:block, 'group', :args => [:test]) do |b|
-      puts "BLOCK"
       call_node = b.find(:call, 'gem', :args => ['ripper', {:src => 'github'}])
       assert_equal Ruby::Call, call_node.class
       b.insert(:after, "gem 'abc'")
@@ -42,15 +41,16 @@ end
   define_method :"test find gem statement inside group using DSL and then replace matching hash with new hash" do                           
     src = %q{                 
 group :test do
-  gem 'ripper', :src => 'blip'
+  gem 'kris', 2, :src => 'goody', 
 end  
     }
 
     code = Ripper::RubyBuilder.build(src)                 
     code.inside(:block, 'group', :args => [:test]) do |b|
-      call_node = b.find(:call, 'gem', :args => ['ripper'])
+      call_node = b.find(:call, 'gem', :args => ['kris'])
       assert_equal Ruby::Call, call_node.class
-      call_node.update(:select => {:arg => {:src => 'blip'}} , :with_code => "{:src => 'unknown'}")
+      # call_node.update(:select => {:arg => {:src => 'goody'}} , :with_code => "{:src => 'unknown'}")
+      # call_node.replace(:arg => '#1' , :with_code => "{:src => 'known'}")
       puts b.to_ruby
     end       
   end  
@@ -65,8 +65,6 @@ end
     code = Ripper::RubyBuilder.build(src)               
 
     code.find(:def, 'hello_world', :params => ['a']) do |b|
-      puts "HELLO"
-      # call_node = b.find_call('gem', :args => ['ripper', {:src => 'github'}], :verbose => true)
       ass_node = b.find(:assignment, 'my_var')
       assert_equal Ruby::Assignment, ass_node.class
       

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Kristian Mandrup
@@ -73,6 +73,10 @@ files:
 - lib/manipulation/insert/api.rb
 - lib/manipulation/position.rb
 - lib/manipulation/update/api.rb
+- lib/manipulation/update/hash.rb
+- lib/manipulation/update/position.rb
+- lib/manipulation/update/token.rb
+- lib/manipulation/update/value.rb
 - lib/query/api.rb
 - lib/query/find.rb
 - lib/rails/api.rb