to_source 0.2.15 → 0.2.16

data/lib/to_source/emitter/send_with_arguments.rb

@@ -4,8 +4,20 @@ module ToSource
 
       handle(Rubinius::AST::SendWithArguments)
 
+      BINARY_OPERATORS = %w(
+        + - * / & | && || << >> == 
+        === != <= < <=> > >= =~ !~ ^ 
+        **
+      ).map(&:to_sym).to_set
+
     private
 
+      # Perform dispatch
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def dispatch
         if element_reference?
           run(ElementReference)
@@ -18,20 +30,40 @@ module ToSource
         normal_dispatch
       end
       
+      # Test for element reference
+      #
+      # @return [true]
+      #   if node is an element reference
+      #
+      # @return [false]
+      #   otherwise
+      #
+      # @api private
+      #
       def element_reference?
         name == :[]
       end
 
-      BINARY_OPERATORS = %w(
-        + - * / & | && || << >> == 
-        === != <= < <=> > >= =~ !~ ^ 
-        **
-      ).map(&:to_sym).to_set
-
+      # Test for binary operator method
+      #
+      # @return [true]
+      #   if node is a binary operator method
+      #
+      # @return [false]
+      #   otherwise
+      #
+      # @api private
+      #
       def binary_operator_method?
-        BINARY_OPERATORS.include?(node.name)
+        BINARY_OPERATORS.include?(name)
       end
 
+      # Perform normal dispatch
+      #
+      # @return [undefined]
+      #
+      # @api private
+      # 
       def normal_dispatch
         emit_receiver
         emit_name
@@ -39,6 +71,12 @@ module ToSource
         emit_block
       end
 
+      # Emit arguments
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def emit_arguments
         emit('(')
         emitter = visit(node.arguments)
@@ -46,6 +84,14 @@ module ToSource
         emit(')')
       end
 
+      # Emit block pass
+      #
+      # @param [Class:Emitter] emitter
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def emit_block_pass(emitter)
         return unless block_pass?
         emit(', ') if emitter.any?

data/lib/to_source/emitter/singleton_class.rb

@@ -1,12 +1,18 @@
 module ToSource
   class Emitter
-
+    # Emitter for singleton class nodes
     class SingletonClass < self
 
       handle(Rubinius::AST::SClass)
 
     private
 
+      # Perform dispatch
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def dispatch
         emit('class << ')
         visit(node.receiver)
@@ -14,11 +20,17 @@ module ToSource
         emit_end
       end
 
+      # Emit body
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def emit_body
-        indent
-        # FIXME: attr_reader missing on Rubinius::AST::SClass
-        visit(node.instance_variable_get(:@body))
-        unindent
+        indented do
+          # FIXME: attr_reader missing on Rubinius::AST::SClass
+          visit(node.instance_variable_get(:@body))
+        end
       end
 
     end

data/lib/to_source/emitter/splat.rb

@@ -1,5 +1,6 @@
 module ToSource
   class Emitter
+    # Emitter for splat nodes
     class Splat < self
 
       handle(Rubinius::AST::SplatValue)
@@ -7,6 +8,12 @@ module ToSource
 
     private
 
+      # Perform dispatch
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def dispatch
         emit('*')
         visit(node.value)

data/lib/to_source/emitter/splat_when.rb

@@ -1,11 +1,18 @@
 module ToSource
   class Emitter
+    # Emitter for spat when nodes
     class SplatWhen < self
 
       handle(Rubinius::AST::SplatWhen)
 
     private
 
+      # Perform dispatch
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def dispatch
         emit('*')
         visit(node.condition)

data/lib/to_source/emitter/static.rb

@@ -1,31 +1,50 @@
 module ToSource
   class Emitter
+    # Base class for emitters with static content
     class Static < self
 
     private
 
+      # Perform dispatch
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def dispatch
         emit(self.class::SYMBOL)
       end
 
+      # Emitter for next nodes
       class Next < self
+
         handle(Rubinius::AST::Next)
         SYMBOL = :next
+
       end
 
+      # Emitter for current exception node
       class CurrentException < self
+
         handle(Rubinius::AST::CurrentException)
         SYMBOL = :'$!'
+
       end
 
+      # Emitter for self node
       class Self < self
+
         handle(Rubinius::AST::Self)
         SYMBOL = :self
+
       end
 
+      # Emitter for file node
       class File < self
+
         handle(Rubinius::AST::File)
         SYMBOL = :__FILE__
+
       end
 
     end

data/lib/to_source/emitter/super.rb

@@ -1,17 +1,32 @@
 module ToSource
   class Emitter
+    # emitter for super node
     class Super < self
 
       handle(Rubinius::AST::Super)
 
     private
 
+      delegate(:block)
+
+      # Perform dispatch
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def dispatch
         emit('super')
         emit_arguments
         emit_block
       end
 
+      # Emit arguments
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def emit_arguments
         emit('(')
         emitter = visit(node.arguments)
@@ -19,24 +34,54 @@ module ToSource
         emit(')')
       end
 
-      def block
-        node.block
-      end
-
+      # Test for block presence
+      #
+      # @return [true]
+      #   if block is present
+      #
+      # @return [false]
+      #   otherwise
+      #
+      # @api private
+      #
       def block?
         !!block
       end
 
+      # Test for block pass
+      #
+      # @return [true]
+      #   if block pass is present
+      #
+      # @return [false]
+      #   otherwise
+      #
+      # @api private
+      #
       def block_pass?
         block.kind_of?(Rubinius::AST::BlockPass19)
       end
 
+      # Emit block pass
+      #
+      # @param [Class:Emitter] emitter
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def emit_block_pass(emitter)
         return unless block? and block_pass?
         emit(', ') if emitter.any?
         visit(block)
       end
 
+      # Emit block
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def emit_block
         return unless block? and !block_pass?
         visit(block)

data/lib/to_source/emitter/to_array.rb

@@ -1,11 +1,18 @@
 module ToSource
   class Emitter
+    # Emit to array node
     class ToArray < self
 
       handle(Rubinius::AST::ToArray)
 
     private
 
+      # Perform dispatch
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def dispatch
         visit(node.value)
       end

data/lib/to_source/emitter/to_string.rb

@@ -1,11 +1,18 @@
 module ToSource
   class Emitter
+    # Emit to string node
     class ToString < self
 
       handle(Rubinius::AST::ToString)
 
     private
 
+      # Perform dispatch
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def dispatch
         emit('#{')
         visit(node.value)

data/lib/to_source/emitter/toplevel.rb

@@ -1,10 +1,19 @@
 module ToSource
   class Emitter
+    # Emitter for toplevel constants or classes
     class Toplevel < self
 
       handle(Rubinius::AST::ToplevelClassName)
       handle(Rubinius::AST::ToplevelConstant)
 
+    private
+
+      # Perform dispatch
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def dispatch
         emit('::')
         emit(node.name)

data/lib/to_source/emitter/unary_operator_method.rb

@@ -1,5 +1,6 @@
 module ToSource
   class Emitter
+    # Emitter for unary operator method
     class UnaryOperatorMethod < Send
 
       UNARY_MAPPING = {
@@ -9,6 +10,12 @@ module ToSource
 
     private
 
+      # Perform dispatch
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def dispatch
         name = node.name
         emit(UNARY_MAPPING.fetch(name, name))

data/lib/to_source/emitter/unless.rb

@@ -1,22 +1,41 @@
 module ToSource
   class Emitter
+    # Emitter for unless
     class Unless < self
 
     private
-      
+
+      # Perform dispatch
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def dispatch
         emit('unless ')
         visit(condition)
-        indent
-        visit(else_body)
-        unindent
+        indented do
+          visit(else_body)
+        end
         emit_end
       end
 
+      # Emit condition
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def condition
         node.condition
       end
 
+      # Emit else
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def else_body
         node.else
       end

data/lib/to_source/emitter/util.rb

@@ -1,10 +1,18 @@
 module ToSource
   class Emitter
+    # base class for utility emitters
     class Util < self
+      # Emitter for delimited bodies
       class DelimitedBody < self
 
       private
 
+        # Perform dispatch
+        #
+        # @return [undefined]
+        #
+        # @api private
+        #
         def dispatch
           body = node
           max = body.length - 1