unparser 0.4.8 → 0.5.3

data/lib/unparser/buffer.rb

@@ -3,8 +3,6 @@
 module Unparser
 
   # Buffer used to emit into
-  #
-  # ignore :reek:TooManyMethods
   class Buffer
 
     NL = "\n".freeze
@@ -82,6 +80,13 @@ module Unparser
       self
     end
 
+    def root_indent
+      before = @indent
+      @indent = 0
+      yield
+      @indent = before
+    end
+
     # Test for a fresh line
     #
     # @return [Boolean]
@@ -114,26 +119,24 @@ module Unparser
       @content[size_before..-1]
     end
 
-  private
-
-    INDENT_SPACE = '  '.freeze
-
-    # Write prefix
-    #
-    # @return [String]
+    # Write raw fragment to buffer
     #
-    # @api private
-    #
-    def prefix
-      write(INDENT_SPACE * @indent)
-    end
-
-    # Write to content buffer
+    # Does not do indentation logic.
     #
     # @param [String] fragment
     #
+    # @return [self]
     def write(fragment)
       @content << fragment
+      self
+    end
+
+  private
+
+    INDENT_SPACE = '  '.freeze
+
+    def prefix
+      write(INDENT_SPACE * @indent)
     end
 
   end # Buffer

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)