to_source 0.2.15 → 0.2.16

data/lib/to_source/emitter/loop.rb

@@ -1,32 +1,35 @@
 module ToSource
   class Emitter
+    # Base class for loop node emittrs
     class Loop < self
 
     private
-
+      
+      # Perform dispatch
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def dispatch
         emit(self.class::KEYWORD)
         space
         visit(condition)
-        indent
-        visit(body)
-        unindent
+        indented do
+          visit(body)
+        end
         emit_end
       end
 
-      def condition
-        node.condition
-      end
-
-      def body
-        node.body
-      end
+      delegate :condition, :body
 
+      # Emitter for while nodes
       class While < self
         handle(Rubinius::AST::While)
         KEYWORD = :while
       end
 
+      # Emitter for until nodes
       class Until < self
         handle(Rubinius::AST::Until)
         KEYWORD = :until

data/lib/to_source/emitter/match3.rb

@@ -1,11 +1,18 @@
 module ToSource
   class Emitter
+    # Emitter for match operator
     class Match3 < self
 
       handle(Rubinius::AST::Match3)
 
     private
 
+      # Perform dispatch
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def dispatch
         util = node
         visit(util.value)

data/lib/to_source/emitter/module.rb

@@ -1,18 +1,25 @@
 module ToSource
   class Emitter
+    # Emitter for module nodes
     class Module < self
 
       handle(Rubinius::AST::Module)
 
     private
 
+      # Perform dispatch
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def dispatch
         util = node
         emit('module ')
         visit(util.name)
-        indent
-        visit(util.body)
-        unindent
+        indented do
+          visit(util.body)
+        end
         emit_end
       end
 

data/lib/to_source/emitter/multiple_assignment.rb

@@ -1,21 +1,40 @@
 module ToSource
   class Emitter
+    # Emitter for multiple assignment nodes
     class MultipleAssignment < self
 
       handle(Rubinius::AST::MultipleAssignment)
 
     private
 
+      # Perform dispatch
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def dispatch
         emit_left
         emit(' = ')
         emit_right
       end
 
+      # Emit left
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def emit_left
         run(Util::DelimitedBody, node.left.body)
       end
 
+      # Emit left
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def emit_right
         right = node.right
         if right.kind_of?(Rubinius::AST::ArrayLiteral)

data/lib/to_source/emitter/nth_ref.rb

@@ -1,11 +1,18 @@
 module ToSource
   class Emitter
+    # Emitter for nth global variable reference
     class NthRef < self
 
       handle(Rubinius::AST::NthRef)
 
     private
 
+      # Perform dispatch
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def dispatch
         emit("$#{node.which}")
       end

data/lib/to_source/emitter/op_assign1.rb

@@ -1,11 +1,18 @@
 module ToSource
   class Emitter
+    # Emitter for conditiona element assignment
     class OpAssign1 < self
 
       handle(Rubinius::AST::OpAssign1)
 
     private
 
+      # Perform dispatch
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def dispatch
         util = node
         visit(util.receiver)

data/lib/to_source/emitter/op_assign2.rb

@@ -1,11 +1,18 @@
 module ToSource
   class Emitter
+    # Emitter for conditiona attribute assignment
     class OpAssign2 < self
 
       handle(Rubinius::AST::OpAssign2)
 
     private
 
+      # Perform dispatch
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def dispatch
         util = node
         visit(util.receiver)

data/lib/to_source/emitter/pattern_arguments.rb

@@ -1,11 +1,18 @@
 module ToSource
   class Emitter
+    # Emitter for pattern argument node
     class PatternArguments < self
 
       handle(Rubinius::AST::PatternArguments)
 
     private
 
+      # Perform dispatch
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def dispatch
         emit('(')
         run(Util::DelimitedBody, node.arguments.body)

data/lib/to_source/emitter/rescue.rb

@@ -1,18 +1,24 @@
 module ToSource
   class Emitter
-
+    # Emitter for rescue nodes
     class Rescue < self
 
       handle(Rubinius::AST::Rescue)
 
     private
 
+      # Perform dispatch
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def dispatch
         util = node
         emit('begin')
-        indent
-        visit(util.body)
-        unindent
+        indented do
+          visit(util.body)
+        end
         visit(util.rescue)
         emit_end
       end

data/lib/to_source/emitter/rescue_condition.rb

@@ -1,11 +1,18 @@
 module ToSource
   class Emitter
+    # Emitter for rescue condition within rescue nodes
     class RescueCondition < self
 
       handle(Rubinius::AST::RescueCondition)
 
     private
 
+      # Perform dispatch
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def dispatch
         emit('rescue')
         emit_conditions
@@ -15,12 +22,24 @@ module ToSource
         emit_next
       end
 
+      # Emit body
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def emit_body
-        indent
-        visit(node.body)
-        unindent
+        indented do
+          visit(node.body)
+        end
       end
 
+      # Emit conditions
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def emit_conditions
         conditions = node.conditions || return
         body = conditions.body
@@ -32,6 +51,12 @@ module ToSource
         end
       end
 
+      # Emit splat
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def emit_splat
         util = node
         splat = util.splat || return
@@ -40,12 +65,24 @@ module ToSource
         visit(splat)
       end
 
+      # Emit assignment
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def emit_assignment
         assignment = node.assignment || return
         emit(' => ')
         emit(assignment.name)
       end
 
+      # Emit next
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def emit_next
         next_rescue = node.next || return
         visit(next_rescue)

data/lib/to_source/emitter/scope.rb

@@ -1,5 +1,6 @@
 module ToSource
   class Emitter
+    # Emitter for class module or singleton class scopes
     class Scope < self
 
       handle(Rubinius::AST::ClassScope)
@@ -8,6 +9,12 @@ module ToSource
 
     private
 
+      # Perform dispatch
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def dispatch
         visit(node.body)
       end

data/lib/to_source/emitter/scope_name.rb

@@ -1,5 +1,6 @@
 module ToSource
   class Emitter
+    # Emitter for class or modue scope names
     class ScopeName < self
 
       handle(Rubinius::AST::ClassName)
@@ -7,6 +8,12 @@ module ToSource
 
     private
 
+      # Perform dispatch
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def dispatch
         emit(node.name)
       end

data/lib/to_source/emitter/scoped_name.rb

@@ -1,5 +1,6 @@
 module ToSource
   class Emitter
+    # Emitter for scoped cass module or constant names
     class ScopedName < self
 
       handle(Rubinius::AST::ScopedClassName)
@@ -10,6 +11,12 @@ module ToSource
 
       delegate(:parent, :name)
 
+      # Perform dispatch
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def dispatch
         visit(parent)
         emit('::')

data/lib/to_source/emitter/send.rb

@@ -10,10 +10,14 @@ module ToSource
 
     private
 
-      def unary_operator_method?
-        UNARY_OPERATORS.include?(node.name)
-      end
+      delegate(:block, :name, :receiver)
 
+      # Perform dispatch
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def dispatch
         if unary_operator_method?
           run(UnaryOperatorMethod, node)
@@ -23,6 +27,26 @@ module ToSource
         normal_dispatch
       end
 
+      # Test for unary operator method
+      #
+      # @return [true]
+      #   if node is an unary operator method
+      #
+      # @return [false]
+      #   otherwise
+      #
+      # @api private
+      #
+      def unary_operator_method?
+        UNARY_OPERATORS.include?(name)
+      end
+
+      # Perform normal dispatch
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def normal_dispatch
         emit_receiver
         emit_name
@@ -30,31 +54,73 @@ module ToSource
         emit_block
       end
 
+      # Test for block
+      #
+      # @return [true]
+      #   if block is present
+      #
+      # @return [false]
+      #   otherwise
+      #
+      # @api private
+      #
       def block?
         !!block
       end
 
-      delegate(:block, :name, :receiver)
-
+      # Test for block pass
+      #
+      # @return [true]
+      #   if block pass is present
+      #
+      # @return [false]
+      #   otherwise
+      #
+      # @api private
+      #
       def block_pass?
         block? && block.kind_of?(Rubinius::AST::BlockPass19)
       end
 
+      # Emit name
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def emit_name
         emit(name)
       end
 
+      # Emit receiver
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def emit_receiver
         return if node.privately
         visit(receiver)
         emit('.')
       end
 
+      # Emit block
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def emit_block
         return unless block? and !block_pass?
         visit(block)
       end
 
+      # Emit block pass
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def emit_block_pass
         return unless block_pass?
         emit('(')