unparser 0.4.9 → 0.5.4

data/lib/unparser/cli.rb

@@ -1,13 +1,7 @@
 # frozen_string_literal: true
 
-require 'unparser'
-require 'optparse'
-
 module Unparser
   # Unparser CLI implementation
-  #
-  # :reek:InstanceVariableAssumption
-  # :reek:TooManyInstanceVariables
   class CLI
 
     EXIT_SUCCESS = 0
@@ -26,6 +20,13 @@ module Unparser
         def validation
           Validation.from_path(path)
         end
+
+        # Literal for this target
+        #
+        # @return [Validation]
+        def literal_validation
+          Validation::Literal.from_path(path)
+        end
       end
 
       # String target
@@ -38,6 +39,13 @@ module Unparser
         def validation
           Validation.from_string(string)
         end
+
+        # Literal for this target
+        #
+        # @return [Validation]
+        def literal_validation
+          Validation::Literal.from_string(path)
+        end
       end # String
     end # Target
 
@@ -47,7 +55,7 @@ module Unparser
     #
     # @param [Array<String>] arguments
     #
-    # @return [Fixnum]
+    # @return [Integer]
     #   the exit status
     #
     # @api private
@@ -63,15 +71,14 @@ module Unparser
     # @return [undefined]
     #
     # @api private
-    #
-    # ignore :reek:TooManyStatements
     def initialize(arguments)
       @ignore  = Set.new
       @targets = []
 
-      @success   = true
-      @fail_fast = false
-      @verbose   = false
+      @fail_fast  = false
+      @success    = true
+      @validation = :validation
+      @verbose    = false
 
       opts = OptionParser.new do |builder|
         add_options(builder)
@@ -90,7 +97,7 @@ module Unparser
     #
     # @api private
     #
-    # ignore :reek:TooManyStatements
+    # rubocop:disable Metrics/MethodLength
     def add_options(builder)
       builder.banner = 'usage: unparse [options] FILE [FILE]'
       builder.separator('')
@@ -103,6 +110,9 @@ module Unparser
       builder.on('-v', '--verbose') do
         @verbose = true
       end
+      builder.on('-l', '--literal') do
+        @validation = :literal_validation
+      end
       builder.on('--ignore FILE') do |file|
         @ignore.merge(targets(file))
       end
@@ -110,10 +120,11 @@ module Unparser
         @fail_fast = true
       end
     end
+    # rubocop:enable Metrics/MethodLength
 
     # Return exit status
     #
-    # @return [Fixnum]
+    # @return [Integer]
     #
     # @api private
     #
@@ -128,16 +139,8 @@ module Unparser
 
   private
 
-    # Process target
-    #
-    # @param [Target] target
-    #
-    # @return [undefined]
-    #
-    # @api private
-    #
     def process_target(target)
-      validation = target.validation
+      validation = target.public_send(@validation)
       if validation.success?
         puts validation.report if @verbose
         puts "Success: #{validation.identification}"
@@ -148,12 +151,6 @@ module Unparser
       end
     end
 
-    # Return effective targets
-    #
-    # @return [Enumerable<Target>]
-    #
-    # @api private
-    #
     def effective_targets
       if @start_with
         reject = true
@@ -169,15 +166,6 @@ module Unparser
       end.reject(&@ignore.method(:include?))
     end
 
-    # Return targets for file name
-    #
-    # @param [String] file_name
-    #
-    # @return [Enumerable<Target>]
-    #
-    # @api private
-    #
-    # ignore :reek:UtilityFunction
     def targets(file_name)
       if File.directory?(file_name)
         Dir.glob(File.join(file_name, '**/*.rb')).sort
@@ -187,6 +175,5 @@ module Unparser
         Dir.glob(file_name).sort
       end.map { |file| Target::Path.new(Pathname.new(file)) }
     end
-
   end # CLI
 end # Unparser

data/lib/unparser/color.rb

@@ -28,9 +28,6 @@ module Unparser
 
     private
 
-      # Initialize null color
-      #
-      # @return [undefined]
       def initialize; end
 
     end.new

data/lib/unparser/comments.rb

@@ -3,8 +3,6 @@
 module Unparser
 
   # Holds the comments that remain to be emitted
-  #
-  # ignore :reek:RepeatedConditional
   class Comments
 
     # Proxy to singleton
@@ -113,39 +111,15 @@ module Unparser
 
   private
 
-    # Take comments while the provided block returns true
-    #
-    # @yield [Parser::Source::Comment]
-    #
-    # @return [Array]
-    #
-    # @api private
-    #
     def take_while
       number_to_take = @comments.index { |comment| !yield(comment) } || @comments.size
       @comments.shift(number_to_take)
     end
 
-    # Take comments up to the line number
-    #
-    # @param [Fixnum] line
-    #
-    # @return [Array]
-    #
-    # @api private
-    #
     def take_up_to_line(line)
       take_while { |comment| comment.location.expression.line <= line }
     end
 
-    # Unshift document comments and return the rest
-    #
-    # @param [Array] comments
-    #
-    # @return [Array]
-    #
-    # @api private
-    #
     def unshift_documents(comments)
       doc_comments, other_comments = comments.partition(&:document?)
       doc_comments.reverse_each { |comment| @comments.unshift(comment) }

data/lib/unparser/constants.rb

@@ -2,66 +2,19 @@
 
 module Unparser
   # All unparser constants maybe included in other libraries.
-  #
-  # False positive since constants are frozen dynamically
-  # to avoid duplication of `.freeze` calls
-  #
-  # :reek:TooManyConstants
   module Constants
 
-    # Return frozen symbol set from enumerable
-    #
-    # @param [Enumerable] enumerable
-    #
-    # @return [Set<Symbol>]
-    #
-    # @api private
-    #
-    def self.symbol_set(enumerable)
-      enumerable.map(&:to_sym).freeze
-    end
-    private_class_method :symbol_set
-
-    BRACKETS_CURLY  = IceNine.deep_freeze(%w[{ }])
-    BRACKETS_ROUND  = IceNine.deep_freeze(%w[( )])
-    BRACKETS_SQUARE = IceNine.deep_freeze(%w([ ]))
-
     # All unary operators of the ruby language
-    UNARY_OPERATORS = symbol_set %w[
+    UNARY_OPERATORS = %i[
       ! ~ -@ +@
-    ]
+    ].to_set.freeze
 
     # All binary operators of the ruby language
-    BINARY_OPERATORS = symbol_set %w[
+    BINARY_OPERATORS = %i[
       + - * / & | && || << >> ==
       === != <= < <=> > >= =~ !~ ^
       ** %
-    ]
-
-    COMMENT = '#'
-
-    WS       = ' '
-    NL       = "\n"
-    T_DOT    = '.'
-    T_LT     = '<'
-    T_DLT    = '<<'
-    T_AMP    = '&'
-    T_ASN    = '='
-    T_SPLAT  = '*'
-    T_DSPLAT = '**'
-    T_ASR    = '=>'
-    T_PIPE   = '|'
-    T_DCL    = '::'
-    T_NEG    = '!'
-    T_OR     = '||'
-    T_AND    = '&&'
-    T_COLON  = ':'
-
-    M_PO  = '('
-    M_PC  = ')'
-
-    SNGL_QUOTE = "'"
-    DBL_QUOTE  = '"'
+    ].to_set.freeze
 
     # Keywords
     K_DO       = 'do'
@@ -107,8 +60,6 @@ module Unparser
     K_FILE     = '__FILE__'
     K_THEN     = 'then'
 
-    DEFAULT_DELIMITER = ', '.freeze
-
     KEYWORDS = constants.each_with_object([]) do |name, keywords|
       value = const_get(name).freeze
       next unless name.to_s.start_with?('K_')

data/lib/unparser/diff.rb

@@ -59,25 +59,16 @@ module Unparser
 
   private
 
-    # Diffs between old and new
-    #
-    # @return [Array<Array>]
     def diffs
       ::Diff::LCS.diff(old, new)
     end
 
-    # Raw diff-lcs hunks
-    #
-    # @return [Array<Diff::LCS::Hunk>]
     def hunks
       diffs.map do |diff|
         ::Diff::LCS::Hunk.new(old.map(&:dup), new, diff, max_length, 0)
       end
     end
 
-    # Minimized hunk
-    #
-    # @return Diff::LCS::Hunk
     def minimized_hunk
       head, *tail = hunks
 
@@ -87,18 +78,10 @@ module Unparser
       end
     end
 
-    # Max length of source line in new and old
-    #
-    # @return [Integer]
     def max_length
       [old, new].map(&:length).max
     end
 
-    # Colorized a unified diff line
-    #
-    # @param [String] line
-    #
-    # @return [String]
     def self.colorize_line(line)
       case line[0]
       when ADDITION

data/lib/unparser/dsl.rb

@@ -6,14 +6,6 @@ module Unparser
 
   private
 
-    # Define remaining children
-    #
-    # @param [Enumerable<Symbol>] names
-    #
-    # @return [undefined]
-    #
-    # @api private
-    #
     def define_remaining_children(names)
       range = names.length..-1
       define_method(:remaining_children) do
@@ -22,15 +14,6 @@ module Unparser
       private :remaining_children
     end
 
-    # Define named child
-    #
-    # @param [Symbol] name
-    # @param [Fixnum] index
-    #
-    # @return [undefined]
-    #
-    # @api private
-    #
     def define_child(name, index)
       define_method(name) do
         children.at(index)
@@ -38,15 +21,6 @@ module Unparser
       private name
     end
 
-    # Define a group of children
-    #
-    # @param [Symbol] name
-    # @param [Range] range
-    #
-    # @return [undefined]
-    #
-    # @api private
-    #
     def define_group(name, range)
       define_method(name) do
         children[range]
@@ -55,12 +29,6 @@ module Unparser
       memoize(name)
     end
 
-    # Create name helpers
-    #
-    # @return [undefined]
-    #
-    # @api private
-    #
     def children(*names)
       define_remaining_children(names)
 

data/lib/unparser/emitter.rb

@@ -4,34 +4,20 @@ module Unparser
   UnknownNodeError = Class.new(ArgumentError)
 
   # Emitter base class
-  #
-  # buggy, argument values are sends to self
-  #
-  # ignore :reek:TooManyMethods
   class Emitter
-    include Adamantium::Flat, AbstractType, Constants, NodeHelpers
-    include Concord.new(:node, :parent)
-    extend DSL
+    include Adamantium::Flat, AbstractType, Constants, Generation, NodeHelpers
+    include Anima.new(:buffer, :comments, :node, :local_variable_scope)
 
-    # Registry for node emitters
-    REGISTRY = {} # rubocop:disable MutableConstant
+    public :node
 
-    NOINDENT = %i[rescue ensure].to_set.freeze
+    extend DSL
 
-    module Unterminated
-      def terminated?
-        false
-      end
-    end
+    # Registry for node emitters
+    REGISTRY = {} # rubocop:disable Style/MutableConstant
 
-    module Terminated
-      def terminated?
-        true
-      end
-    end
+    NO_INDENT = %i[ensure rescue].freeze
 
     module LocalVariableRoot
-
       # Return local variable root
       #
       # @return [Parser::AST::Node]
@@ -47,33 +33,8 @@ module Unparser
           memoize :local_variable_scope
         end
       end
-
     end # LocalVariableRoot
 
-    # Return local variable root
-    #
-    # @return [Parser::AST::Node]
-    #
-    # @api private
-    #
-    def local_variable_scope
-      parent.local_variable_scope
-    end
-
-    # Return assigned lvars
-    #
-    # @return [Array<Symbol>]
-    #
-    # @api private
-    #
-    abstract_method :local_variables
-
-    # Return node type
-    #
-    # @return [Symbol]
-    #
-    # @api private
-    #
     def node_type
       node.type
     end
@@ -88,25 +49,16 @@ module Unparser
     #
     def self.handle(*types)
       types.each do |type|
+        fail "Handler for type: #{type} already registered" if REGISTRY.key?(type)
+
         REGISTRY[type] = self
       end
     end
     private_class_method :handle
 
-    # Trigger write to buffer
-    #
-    # @return [self]
-    #
-    # @api private
-    #
-    def write_to_buffer
-      emit_comments_before if buffer.fresh_line?
+    def emit_mlhs
       dispatch
-      comments.consume(node)
-      emit_eof_comments if parent.is_a?(Root)
-      self
     end
-    memoize :write_to_buffer
 
     # Return emitter
     #
@@ -114,384 +66,30 @@ module Unparser
     #
     # @api private
     #
-    def self.emitter(node, parent)
+    # rubocop:disable Metrics/ParameterLists
+    def self.emitter(buffer:, comments:, node:, local_variable_scope:)
       type = node.type
-      klass = REGISTRY.fetch(type) do
-        raise UnknownNodeError, "Unknown node type: #{type.inspect}"
-      end
-      klass.new(node, parent)
-    end
-
-    # Dispatch node
-    #
-    # @return [undefined]
-    #
-    # @api private
-    #
-    abstract_method :dispatch
-
-    # Test if node is emitted as terminated expression
-    #
-    # @return [Boolean]
-    #
-    # @api private
-    #
-    abstract_method :terminated?
 
-  protected
-
-    # Return buffer
-    #
-    # @return [Buffer] buffer
-    #
-    # @api private
-    #
-    def buffer
-      parent.buffer
-    end
-    memoize :buffer, freezer: :noop
-
-    # Return comments
-    #
-    # @return [Comments] comments
-    #
-    # @api private
-    #
-    def comments
-      parent.comments
-    end
-    memoize :comments, freezer: :noop
-
-  private
-
-    # Emit contents of block within parentheses
-    #
-    # @return [undefined]
-    #
-    # @api private
-    #
-    def parentheses(open = M_PO, close = M_PC)
-      write(open)
-      yield
-      write(close)
-    end
-
-    # Visit node
-    #
-    # @param [Parser::AST::Node] node
-    #
-    # @return [undefined]
-    #
-    # @api private
-    #
-    def visit_plain(node)
-      emitter = emitter(node)
-      emitter.write_to_buffer
-    end
-
-    # Visit ambiguous node
-    #
-    # @param [Parser::AST::Node] node
-    #
-    # @return [undefined]
-    #
-    # @api private
-    #
-    def visit(node)
-      emitter = emitter(node)
-      conditional_parentheses(!emitter.terminated?) do
-        emitter.write_to_buffer
-      end
-    end
-
-    # Visit within parentheses
-    #
-    # @param [Parser::AST::Node] node
-    #
-    # @return [undefined]
-    #
-    # @api private
-    #
-    def visit_parentheses(node, *arguments)
-      parentheses(*arguments) do
-        visit_plain(node)
-      end
-    end
-
-    # Call block in optional parentheses
-    #
-    # @param [true, false] flag
-    #
-    # @return [undefined]
-    #
-    # @api private
-    #
-    # ignore :reek:ControlParameter
-    def conditional_parentheses(flag)
-      if flag
-        parentheses { yield }
-      else
-        yield
-      end
-    end
-
-    # Return emitter for node
-    #
-    # @param [Parser::AST::Node] node
-    #
-    # @return [Emitter]
-    #
-    # @api private
-    #
-    def emitter(node)
-      self.class.emitter(node, self)
-    end
-
-    # Emit delimited body
-    #
-    # @param [Enumerable<Parser::AST::Node>] nodes
-    #
-    # @return [undefined]
-    #
-    # @api private
-    #
-    def delimited_plain(nodes)
-      delimited(nodes, &method(:visit_plain))
-    end
-
-    # Emit delimited body
-    #
-    # @param [Enumerable<Parser::AST::Node>] nodes
-    #
-    # @return [undefined]
-    #
-    # @api private
-    #
-    def delimited(nodes, &block)
-      return if nodes.empty?
-
-      block ||= method(:visit)
-      head, *tail = nodes
-      block.call(head)
-      tail.each do |node|
-        write(DEFAULT_DELIMITER)
-        block.call(node)
-      end
-    end
-
-    # Return children of node
-    #
-    # @return [Array<Parser::AST::Node>]
-    #
-    # @api private
-    #
-    def children
-      node.children
-    end
-
-    # Write newline
-    #
-    # @return [undefined]
-    #
-    # @api private
-    #
-    def nl
-      emit_eol_comments
-      buffer.nl
-    end
-
-    # Write comments that appeared before source_part in the source
-    #
-    # @param [Symbol] source_part
-    #
-    # @return [undefined]
-    #
-    # @api private
-    #
-    def emit_comments_before(source_part = :expression)
-      comments_before = comments.take_before(node, source_part)
-      return if comments_before.empty?
-
-      emit_comments(comments_before)
-      buffer.nl
-    end
-
-    # Write end-of-line comments
-    #
-    # @return [undefined]
-    #
-    # @api private
-    #
-    def emit_eol_comments
-      comments.take_eol_comments.each do |comment|
-        write(WS, comment.text)
-      end
-    end
-
-    # Write end-of-file comments
-    #
-    # @return [undefined]
-    #
-    # @api private
-    #
-    def emit_eof_comments
-      emit_eol_comments
-      comments_left = comments.take_all
-      return if comments_left.empty?
-
-      buffer.nl
-      emit_comments(comments_left)
-    end
-
-    # Write each comment to a separate line
-    #
-    # @param [Array] comments
-    #
-    # @return [undefined]
-    #
-    # @api private
-    #
-    def emit_comments(comments)
-      max = comments.size - 1
-      comments.each_with_index do |comment, index|
-        if comment.type.equal?(:document)
-          buffer.append_without_prefix(comment.text.chomp)
-        else
-          write(comment.text)
-        end
-        buffer.nl if index < max
-      end
-    end
-
-    # Write strings into buffer
-    #
-    # @return [undefined]
-    #
-    # @api private
-    #
-    def write(*strings)
-      strings.each do |string|
-        buffer.append(string)
-      end
-    end
-
-    # Write end keyword
-    #
-    # @return [undefined]
-    #
-    # @api private
-    #
-    def k_end
-      buffer.indent
-      emit_comments_before(:end)
-      buffer.unindent
-      write(K_END)
-    end
-
-    # Return first child
-    #
-    # @return [Parser::AST::Node]
-    #   if present
-    #
-    # @return [nil]
-    #   otherwise
-    #
-    # @api private
-    #
-    def first_child
-      children.first
-    end
-
-    # Write whitespace
-    #
-    # @return [undefined]
-    #
-    # @api private
-    #
-    def ws
-      write(WS)
-    end
-
-    # Call emit contents of block indented
-    #
-    # @return [undefined]
-    #
-    # @api private
-    #
-    # False positive:
-    #
-    def indented
-      buffer = buffer()
-      buffer.indent
-      nl
-      yield
-      nl
-      buffer.unindent
-    end
-
-    # Emit non nil body
-    #
-    # @param [Parser::AST::Node] body
-    #
-    # @return [undefined]
-    #
-    # @api private
-    #
-    # rubocop:disable MethodCallWithoutArgsParentheses
-    def emit_body(body = body())
-      unless body
-        buffer.indent
-        nl
-        buffer.unindent
-        return
-      end
-      visit_indented(body)
-    end
-    # rubocop:enable MethodCallWithoutArgsParentheses
-
-    # Visit indented node
-    #
-    # @param [Parser::AST::Node] node
-    #
-    # @return [undefined]
-    #
-    # @api private
-    #
-    def visit_indented(node)
-      if NOINDENT.include?(node.type)
-        visit_plain(node)
-      else
-        indented { visit_plain(node) }
+      klass = REGISTRY.fetch(type) do
+        fail UnknownNodeError, "Unknown node type: #{type.inspect}"
       end
-    end
 
-    # Return parent type
-    #
-    # @return [Symbol]
-    #   if parent is present
-    #
-    # @return [nil]
-    #   otherwise
-    #
-    # @api private
-    #
-    def parent_type
-      parent.node_type
+      klass.new(
+        buffer:               buffer,
+        comments:             comments,
+        local_variable_scope: local_variable_scope,
+        node:                 node
+      )
     end
+    # rubocop:enable Metrics/ParameterLists
 
-    # Delegate to emitter
-    #
-    # @param [Class:Emitter] emitter
+    # Dispatch node write as statement
     #
     # @return [undefined]
     #
     # @api private
     #
-    # rubocop:disable MethodCallWithoutArgsParentheses
-    def run(emitter, node = node())
-      emitter.new(node, self).write_to_buffer
-    end
-    # rubocop:enable MethodCallWithoutArgsParentheses
+    abstract_method :dispatch
 
   end # Emitter
 end # Unparser