unparser 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46f62b35c534e13da34486c1650bb14e406fe48b
-  data.tar.gz: 3bdedfa5f88178cd4ebeafedb72e2ce47a5552a2
+  metadata.gz: bd330877f92585ef66cfd283dba22e1d6202446c
+  data.tar.gz: ec9dbaaf5b7e460bc19e2f6564e25e016b4149c8
 SHA512:
-  metadata.gz: cdfc4fb2f77e221b2af12dc14cb7504e3220e6e08c4da8919617f9b3cd9f9082d6b69129bf46aa7caba119681aed1255240eaf97b888a3b274c2432def82155e
-  data.tar.gz: efd08e3645878e75d316e07b2fb58de2c254c6588183e725c48af4739079856d41d547354114e33acd2c29c010fffea17cb211065c8823fde55692adc475e30a
+  metadata.gz: 2ac84d618bb92e5b9ec2f8360378c820f55545f993532febac3b5b4715cf85e16ccc88271fad3a2c6a8efa34e5297432799b0cc31481396807799c415ecab7b0
+  data.tar.gz: 45bc61077ae22a0c74538fda91621319ea99ace383338a5e6a6f90f66eb5e02ed88938f07f2d5f95999b1ed2372f68c8ddddc9009b23ea1df493854d6d52de90

data/Changelog.md

@@ -1,3 +1,8 @@
+# v0.1.4 2013-11-01
+
+* Code cleanups.
+* Remove warnings.
+
 # v0.0.3 2013-06-17
 
 * Adjust to changes in parser 2.0.0.beta5 => beta6

data/Gemfile

@@ -2,5 +2,5 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'devtools', :git => 'https://github.com/rom-rb/devtools.git'
+gem 'devtools', git: 'https://github.com/rom-rb/devtools.git'
 eval_gemfile 'Gemfile.devtools'

data/Gemfile.devtools

@@ -7,7 +7,7 @@ group :development do
 end
 
 group :yard do
-  gem 'kramdown', '~> 1.1.0'
+  gem 'kramdown', '~> 1.2.0'
 end
 
 group :guard do
@@ -15,7 +15,7 @@ group :guard do
   gem 'guard-bundler', '~> 1.0.0'
   gem 'guard-rspec',   '~> 3.0.2'
   gem 'guard-rubocop', '~> 0.2.0'
-  # gem 'guard-mutant',  '~> 0.0.1'
+  gem 'guard-mutant',  '~> 0.0.1'
 
   # file system change event handling
   gem 'listen',     '~> 1.3.0'
@@ -30,16 +30,16 @@ group :guard do
 end
 
 group :metrics do
-  gem 'coveralls', '~> 0.6.7'
+  gem 'coveralls', '~> 0.7.0'
   gem 'flay',      '~> 2.4.0'
   gem 'flog',      '~> 4.1.1'
   gem 'reek',      '~> 1.3.2'
-  gem 'rubocop',   '~> 0.11.0'
+  gem 'rubocop',   '~> 0.14.1'
   gem 'simplecov', '~> 0.7.1'
   gem 'yardstick', '~> 0.9.7', git: 'https://github.com/dkubb/yardstick.git'
 
   platforms :ruby_19, :ruby_20 do
-    # gem 'mutant', git: 'https://github.com/mbj/mutant.git'
+    gem 'mutant', git: 'https://github.com/mbj/mutant.git'
     gem 'yard-spellcheck', '~> 0.1.5'
   end
 end

data/README.md

@@ -58,7 +58,7 @@ People
 ------
 
 * [Markus Schirp (mbj)](https://github.com/mbj) Author
-* [Trent Ogren](https://github.com/misfo) Adding comment reproduction
+* [Trent Ogren (misfo)](https://github.com/misfo) Adding comment reproduction
 
 Contributing
 -------------

data/bin/test-unparser

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 trap('INT') do |status|
-  exit! 128+status
+  exit! 128 + status
 end
 
 require 'unparser'
@@ -13,14 +13,14 @@ ARGV.each do |file|
   generated = Unparser.unparse(node)
   unparsed  = Parser::CurrentRuby.parse(generated)
   unless unparsed == node
-    $stderr.puts "Node:"
+    $stderr.puts 'Node:'
     $stderr.puts node.inspect
-    $stderr.puts "Unparsed-Node:"
+    $stderr.puts 'Unparsed-Node:'
     $stderr.puts unparsed.inspect
-    $stderr.puts "Original:"
+    $stderr.puts 'Original:'
     $stderr.puts source
-    $stderr.puts "Generated:"
+    $stderr.puts 'Generated:'
     $stderr.puts generated
-    fail "BUG!"
+    fail 'BUG!'
   end
 end

data/config/flay.yml

@@ -1,3 +1,3 @@
 ---
 threshold: 13
-total_score: 352
+total_score: 410

data/config/reek.yml

@@ -63,11 +63,7 @@ NestedIterators:
   enabled: true
   max_allowed_nesting: 1
 TooManyStatements:
-  max_statements: 5
-  exclude:
-  - Unparser::Emitter::Block#dispatch # 6 statements
-  - Unparser::Emitter::Def#dispatch # 6 statements
-  - Unparser::Emitter::Class#dispatch # 6 statements
+  max_statements: 6
   enabled: true
 DuplicateMethodCall:
   allow_calls: []
@@ -91,6 +87,8 @@ UncommunicativeVariableName:
   - !ruby/regexp /[A-Z]/
 RepeatedConditional:
   exclude:
+  - Unparser::Emitter # FIXME
+  - Unparser::Comments # FIXME
   - Unparser::Emitter::Send # TODO Fixme
   - Unparser::Emitter::If
   enabled: true
@@ -103,6 +101,7 @@ DataClump:
 ControlParameter:
   exclude:
     - Unparser::Emitter#emit_body # false positive
+    - Unparser::Emitter#conditional_parentheses # Intentionally a control structure like helper
   enabled: true
 NilCheck:
   enabled: false

data/config/rubocop.yml

@@ -0,0 +1,88 @@
+AllCops:
+  Includes:
+    - '**/*.rake'
+    - 'Gemfile'
+    - 'Gemfile.triage'
+  Excludes:
+    - '**/vendor/**'
+    - '**/benchmarks/**'
+
+# Avoid parameter lists longer than five parameters.
+ParameterLists:
+  Max: 3
+  CountKeywordArgs: true
+
+MethodLength:
+  CountComments: false
+  Max: 15
+
+# Avoid more than `Max` levels of nesting.
+BlockNesting:
+  Max: 3
+
+# Align with the style guide.
+CollectionMethods:
+  PreferredMethods:
+    collect:  'map'
+    inject:   'reduce'
+    find:     'detect'
+    find_all: 'select'
+
+# Do not force public/protected/private keyword to be indented at the same
+# level as the def keyword. My personal preference is to outdent these keywords
+# because I think when scanning code it makes it easier to identify the
+# sections of code and visually separate them. When the keyword is at the same
+# level I think it sort of blends in with the def keywords and makes it harder
+# to scan the code and see where the sections are.
+AccessControl:
+  Enabled: false
+
+# Limit line length
+LineLength:
+  Max: 113  # TODO: lower to 79 once the rubocop branch in shared/Gemfile is removed
+
+# Disabled because of indenting with private keyword in class bodies.
+IndentationWidth:
+  Enabled: false
+
+# I like raise more
+SignalException:
+  Enabled: false
+
+# Disable Symbol cop because unparse has to prodice "WIERD" symbols in his specs
+#
+# I'd love I could ignore a specific occurance.
+#
+SymbolName:
+  Enabled: false
+
+# False positive in unparser source
+OneLineConditional:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+# Disable documentation checking until a class needs to be documented once
+Documentation:
+  Enabled: false
+
+# Do not favor modifier if/unless usage when you have a single-line body
+IfUnlessModifier:
+  Enabled: false
+
+# Allow case equality operator (in limited use within the specs)
+CaseEquality:
+  Enabled: false
+
+# Constants do not always have to use SCREAMING_SNAKE_CASE
+ConstantName:
+  Enabled: false
+
+# Not all trivial readers/writers can be defined with attr_* methods
+TrivialAccessors:
+  Enabled: false
+
+# Do not prefer do/end over {} for multiline blocks
+Blocks:
+  Enabled: false

data/lib/unparser.rb

@@ -7,6 +7,8 @@ module Unparser
 
   EMPTY_STRING = ''.freeze
 
+  EMPTY_ARRAY = [].freeze
+
   # Unparse an AST (and, optionally, comments) into a string
   #
   # @param [Parser::Node, nil] node

data/lib/unparser/buffer.rb

@@ -52,7 +52,7 @@ module Unparser
     # @api private
     #
     def indent
-      @indent+=1
+      @indent += 1
       self
     end
 
@@ -63,7 +63,7 @@ module Unparser
     # @api private
     #
     def unindent
-      @indent-=1
+      @indent -= 1
       self
     end
 
@@ -116,6 +116,8 @@ module Unparser
 
   private
 
+    INDENT_SPACE = '  '.freeze
+
     # Write prefix
     #
     # @return [String]
@@ -123,7 +125,7 @@ module Unparser
     # @api private
     #
     def prefix
-      @content << '  '*@indent
+      @content << INDENT_SPACE * @indent
     end
 
   end # Buffer

data/lib/unparser/comments.rb

@@ -1,9 +1,6 @@
 module Unparser
 
   # Holds the comments that remain to be emitted
-  #
-  # @api private
-  #
   class Comments
 
     # Initialize object
@@ -14,7 +11,7 @@ module Unparser
     #
     def initialize(comments)
       @comments = comments.dup
-      @eol_text_to_skip = nil
+      @last_range_consumed = @eol_text_to_skip = nil
     end
 
     # Consume part or all of the node
@@ -25,8 +22,9 @@ module Unparser
     # @return [undefined]
     #
     def consume(node, source_part = :expression)
-      return unless node.location
-      @last_range_consumed = node.location.public_send(source_part)
+      location = node.location
+      return unless location
+      @last_range_consumed = location.public_send(source_part)
     end
 
     # Skip any EOL comment with the specified text next time they're taken
@@ -46,10 +44,10 @@ module Unparser
     def take_eol_comments
       text_to_skip = @eol_text_to_skip
       @eol_text_to_skip = nil
-      return [] if @last_range_consumed.nil?
+      return [] unless @last_range_consumed
       comments = take_up_to_line(@last_range_consumed.end.line)
       eol_comments = unshift_documents(comments)
-      eol_comments.reject {|comment| comment.text == text_to_skip }
+      eol_comments.reject { |comment| comment.text == text_to_skip }
     end
 
     # Take all remaining comments
@@ -68,10 +66,13 @@ module Unparser
     # @return [Array]
     #
     def take_before(node, source_part)
-      loc = node.location
-      range = loc.public_send(source_part) if loc.respond_to?(source_part)
-      return [] if range.nil?
-      take_while { |comment| comment.location.expression.end_pos <= range.begin_pos }
+      location = node.location
+      if location
+        range = location.public_send(source_part)
+        take_while { |comment| comment.location.expression.end_pos <= range.begin_pos }
+      else
+        EMPTY_ARRAY
+      end
     end
 
   private
@@ -83,7 +84,7 @@ module Unparser
     # @return [Array]
     #
     def take_while
-      number_to_take = @comments.index {|comment| !yield(comment) } || @comments.size
+      number_to_take = @comments.index { |comment| !yield(comment) } || @comments.size
       @comments.shift(number_to_take)
     end
 
@@ -105,8 +106,9 @@ module Unparser
     #
     def unshift_documents(comments)
       doc_comments, other_comments = comments.partition(&:document?)
-      doc_comments.reverse_each {|comment| @comments.unshift(comment) }
+      doc_comments.reverse_each { |comment| @comments.unshift(comment) }
       other_comments
     end
-  end
-end
+
+  end # Comments
+end # Unparser

data/lib/unparser/constants.rb

@@ -91,6 +91,5 @@ module Unparser
       end
     end.to_set.freeze
 
-
   end # Constants
 end # Unparser

data/lib/unparser/emitter.rb

@@ -8,7 +8,7 @@ module Unparser
     # Registry for node emitters
     REGISTRY = {}
 
-    NOINDENT = [:rescue, :ensure].to_set
+    NOINDENT = [:rescue, :ensure].to_set.freeze
 
     DEFAULT_DELIMITER = ', '.freeze
 
@@ -148,7 +148,7 @@ module Unparser
     def buffer
       parent.buffer
     end
-    memoize :buffer, :freezer => :noop
+    memoize :buffer, freezer: :noop
 
     # Return comments
     #
@@ -159,7 +159,7 @@ module Unparser
     def comments
       parent.comments
     end
-    memoize :comments, :freezer => :noop
+    memoize :comments, freezer: :noop
 
   private
 
@@ -169,22 +169,12 @@ module Unparser
     #
     # @api private
     #
-    def parentheses(open=M_PO, close=M_PC)
+    def parentheses(open = M_PO, close = M_PC)
       write(open)
       yield
       write(close)
     end
 
-    # Emit nodes source map
-    #
-    # @return [undefined]
-    #
-    # @api private
-    #
-    def emit_source_map
-      SourceMap.emit(node, buffer)
-    end
-
     # Visit node
     #
     # @param [Parser::AST::Node] node
@@ -208,7 +198,7 @@ module Unparser
     #
     def visit_terminated(node)
       emitter = emitter(node)
-      maybe_parentheses(!emitter.terminated?) do
+      conditional_parentheses(!emitter.terminated?) do
         emitter.write_to_buffer
       end
       emitter.write_to_buffer
@@ -236,7 +226,7 @@ module Unparser
     #
     # @api private
     #
-    def maybe_parentheses(flag)
+    def conditional_parentheses(flag)
       if flag
         parentheses { yield }
       else
@@ -339,15 +329,15 @@ module Unparser
 
     # Write each comment to a separate line
     #
-    # @param [Array] comment_array
+    # @param [Array] comments
     #
     # @return [undefined]
     #
     # @api private
     #
-    def emit_comments(comment_array)
-      max = comment_array.size - 1
-      comment_array.each_with_index do |comment, index|
+    def emit_comments(comments)
+      max = comments.size - 1
+      comments.each_with_index do |comment, index|
         if comment.type == :document
           buffer.append_without_prefix(comment.text.chomp)
         else
@@ -429,7 +419,7 @@ module Unparser
     #
     # @api private
     #
-    def emit_body(body = self.body)
+    def emit_body(body = body)
       unless body
         buffer.indent
         nl
@@ -496,23 +486,5 @@ module Unparser
       comments.skip_eol_comment(comment)
     end
 
-    # Emitter that fully relies on parser source maps
-    class SourceMap < self
-
-      # Perform dispatch
-      #
-      # @param [Node] node
-      # @param [Buffer] buffer
-      #
-      # @return [self]
-      #
-      # @api private
-      #
-      def self.emit(node, buffer)
-        buffer.append(node.location.expression.source)
-        self
-      end
-
-    end # SourceMap
   end # Emitter
 end # Unparser