to_source 0.2.15 → 0.2.16

data/lib/to_source/emitter/element_reference.rb

@@ -1,11 +1,20 @@
 module ToSource
   class Emitter
+    # Emitter for element reference nodes
     class ElementReference < self
 
     private
 
+      delegate(:receiver)
+
+      # Perform dispatch
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def dispatch
-        visit(node.receiver)
+        visit(receiver)
         emit('[')
         visit(node.arguments.array.first)
         emit(']')

data/lib/to_source/emitter/empty_body.rb

@@ -1,9 +1,18 @@
 module ToSource
   class Emitter
+    # Emitter for empty body
     class EmptyBody < self
 
       handle(Rubinius::AST::EmptyBody)
 
+    private
+
+      # Perform dispatch
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def dispatch
       end
 

data/lib/to_source/emitter/ensure.rb

@@ -1,20 +1,47 @@
 module ToSource
   class Emitter
+    # Emitter for ensure nodes
     class Ensure < self
 
       handle(Rubinius::AST::Ensure)
 
     private
 
+      # Perform dispatch
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def dispatch
-        emit('begin')
-        indent
-        visit(node.body)
-        unindent
+        emit_begin
+        emit_enusure
+      end
+
+      # Emit begin
+      #
+      # @return [undefined]
+      #
+      # @api private
+      # 
+      def emit_begin
+        emit(:begin)
+        indented do
+          visit(node.body)
+        end
+      end
+
+      # Emit ensure
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
+      def emit_enusure
         emit(:ensure)
-        indent
-        visit(node.ensure)
-        unindent
+        indented do
+          visit(node.ensure)
+        end
         emit_end
       end
 

data/lib/to_source/emitter/ensure_body.rb

@@ -1,16 +1,25 @@
 module ToSource
   class Emitter
+    # Emitter for ensure body
     class EnsureBody < self
 
     private
 
+      delegate(:body)
+
+      # Perform dispatch
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def dispatch
-        visit(node.body)
-        unindent
-        emit('ensure')
-        indent
-        visit(node.ensure)
+        visit(body)
         unindent
+        emit(:ensure)
+        indented do
+          visit(node.ensure)
+        end
       end
 
     end

data/lib/to_source/emitter/execute_string.rb

@@ -1,9 +1,18 @@
 module ToSource
   class Emitter
+    # Emitter for execute string
     class ExecuteString < self
 
       handle(Rubinius::AST::ExecuteString)
 
+    private
+
+      # Perform dispatch
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def dispatch
         emit("`#{node.string}`")
       end

data/lib/to_source/emitter/formal_arguments.rb

@@ -1,112 +1,205 @@
 module ToSource
   class Emitter
+    # Emitter for formal arguments
     class FormalArguments < self
 
     private
 
+      delegate(:arguments)
+      predicate(:splat, :block_arg, :defaults)
+
+      # Perform dispatch
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
+      def dispatch
+        return unless any?
+        util = self.class
+        emit(util::OPEN)
+        emit_required
+        emit_defaults
+        emit_splat
+        emit_block_arg
+        emit(util::CLOSE)
+      end
+
+      # Test if any argument is present
+      #
+      # @return [true]
+      #   if any argument is present
+      #
+      # @return [false]
+      #   otherwise
+      #
+      # @api private
+      #
       def any?
-        required? or defaults? or splat? or block_arg?
+        required? || defaults? || splat? || block_arg?
       end
 
+      # Return required
+      #
+      # @return [Array]
+      #
+      # @api private
+      #
       def required
         arguments.required
       end
 
+      # Test if any required arguments are present
+      #
+      # @return [true]
+      #   if any required arguments are presnet
+      #
+      # @return [false]
+      #   otherwise
+      #
+      # @api private
+      #
       def required?
         required.any?
       end
 
+      # Return defaults
+      #
+      # @return [Rubinius::AST::Node]
+      #
+      # @api private
+      #
       def defaults
         arguments.defaults
       end
 
-      def defaults?
-        !!defaults
-      end
-
+      # Return splat arguments
+      #
+      # @return [Rubinius::AST::Node]
+      #
+      # @api private
+      #
       def splat
         arguments.splat
       end
 
-      def splat?
-        !!splat
-      end
-
+      # Return block argument
+      #
+      # @return [Rubinius::AST::Node]
+      #
+      # @api private
+      #
       def block_arg
         arguments.block_arg
       end
 
-      def block_arg?
-        !!block_arg
-      end
-
+      # Emit required
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def emit_required
         array = required
         max = array.length - 1
         array.each_with_index do |member, index|
-          if member.kind_of?(Rubinius::AST::Node)
-            visit(member)
-          else
-            emit(member)
-          end
+          emit_member(member)
           emit(', ') if index < max
         end
       end
 
+      # Emit member
+      #
+      # @param [Object, Rubinius::AST::Node] member
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
+      def emit_member(member)
+        if member.kind_of?(Rubinius::AST::Node)
+          visit(member)
+        else
+          emit(member)
+        end
+      end
+
+      # Emit defaults
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def emit_defaults
         return unless defaults?
         emit(', ') if required?
         visit(defaults)
       end
 
+      # Emit splat
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def emit_splat
         return unless splat?
 
         emit(', ') if required? or defaults?
         emit('*')
-        value = splat
+        emit_splat_value(splat)
+      end
+
+      # Emit splat value
+      #
+      # @param [Object] value
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
+      def emit_splat_value(value)
         unless value == :@unnamed_splat
           emit(value)
         end
       end
 
+      # Emit block arg
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def emit_block_arg
         return unless block_arg?
         emit(', ') if required? or defaults? or splat?
         visit(block_arg)
       end
 
-      def arguments
-        node.arguments
-      end
-
-      def dispatch
-        return unless any?
-
-        util = self.class
-
-        emit(util::OPEN)
-
-        emit_required
-        emit_defaults
-        emit_splat
-        emit_block_arg
-
-        emit(util::CLOSE)
-      end
-
+      # Emmiter for block arguments
       class Block < self
         OPEN = ' |'.freeze
         CLOSE = '|'.freeze
       end
 
+      # Emitter for method arguments
       class Method < self
         OPEN = '('.freeze
         CLOSE = ')'.freeze
 
+        # Generic emitter for method arguments
         class Generic < self
+
           handle(Rubinius::AST::FormalArguments19)
 
+        private
+
+          # Return arguments
+          #
+          # @return [Rubnius::AST::Node]
+          #
+          # @api private
+          #
           def arguments
             node
           end
@@ -114,7 +207,6 @@ module ToSource
         end
 
       end
-
     end
   end
 end

data/lib/to_source/emitter/if.rb

@@ -1,19 +1,18 @@
 module ToSource
   class Emitter
+    # Emitter for if nodes
     class If < self
 
       handle(Rubinius::AST::If)
 
     private
 
-      def if_branch?
-        !node.body.kind_of?(Rubinius::AST::NilLiteral)
-      end
-
-      def else_branch?
-        !node.else.kind_of?(Rubinius::AST::NilLiteral)
-      end
-
+      # Perform dispatch
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def dispatch
         if else_branch? and !if_branch?
           run(Unless, node)
@@ -23,6 +22,40 @@ module ToSource
         normal_dispatch
       end
 
+      # Test if if branch is present
+      #
+      # @return [true]
+      #   if if branch is present
+      #
+      # @return [false]
+      #   otherwise
+      #
+      # @api private
+      #
+      def if_branch?
+        !node.body.kind_of?(Rubinius::AST::NilLiteral)
+      end
+
+      # Test if else branch is present
+      #
+      # @return [true]
+      #   if else branch is present
+      #
+      # @return [false]
+      #   otherwise
+      #
+      # @api private
+      #
+      def else_branch?
+        !node.else.kind_of?(Rubinius::AST::NilLiteral)
+      end
+
+      # Perform normal dispatch
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def normal_dispatch
         emit('if ')
         visit(node.condition)
@@ -31,19 +64,31 @@ module ToSource
         emit('end')
       end
 
+      # Emit if brnach
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def emit_if_branch
-        indent
-        visit(node.body)
-        unindent
+        indented do
+          visit(node.body)
+        end
       end
 
+      # Emit else branch
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
       def emit_else_branch
         body = node.else
         return unless else_branch?
         emit('else')
-        indent
-        visit(body)
-        unindent
+        indented do
+          visit(body)
+        end
       end
 
     end