unparser 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bbd1a7e700a15704cf6045d49b60c819fa098a56
-  data.tar.gz: c4309776665a4ee2703ff6569d57423d17b20bd7
+  metadata.gz: d247e782f83bba8d99fdba92eb8cf9fb010ea6cf
+  data.tar.gz: 51ead40ddaae1b6424a80d9e9ade1617b3189209
 SHA512:
-  metadata.gz: 96cad113e6bd2c968267edb3f3008e64bcb7c1e217f7256b182ebb3e7412a51a8bb7675204a9b897a926da7e3cdb8ed49a9f34c2516f2db901adcef65c302c68
-  data.tar.gz: a9a4694e7475058e25e97f107a835cf704533937ea9bfa08985593abb85dfd150daa48633497d354f1ed53ebee3c27bb8fbc04bf1833d2e096933adcad29b214
+  metadata.gz: 3a5d334a76e0cab7091514c88ad8abcb12b56c2a7553eb22e4f74f79b893353a6bbbbf68fd04f3fd36528320731a70bb1517b0f8116c994d69a0643881d79fe4
+  data.tar.gz: 7549efa3f744f4190aef927f38f1467667d911a0b123ff4d37e014506d7e93c854a892863a22f8b26c46a4e4f8f36bfe384568a2355bcf485e316f350508b00e

data/.rubocop.yml

@@ -0,0 +1,7 @@
+AllCops:
+  Includes:
+    - 'Gemfile'
+  Excludes:
+    - 'Gemfile.devtools'
+    - 'vendor/**'
+    - 'benchmarks/**'

data/.travis.yml

@@ -6,6 +6,9 @@ rvm:
   - ruby
   - jruby
   - rbx
+matrix:
+  allowed_failures:
+    rvm: rbx
 notifications:
   irc:
     channels:

data/Changelog.md

@@ -1,3 +1,7 @@
+# v0.1.8 2013-01-xx
+
+* Fix all bugs found while round tripping rubyspec.
+
 # v0.1.7 2013-12-31
 
 * Add back support for root nodes of type resbody https://github.com/mbj/unparser/issues/24

data/README.md

@@ -5,12 +5,14 @@ unparser
 [![Dependency Status](https://gemnasium.com/mbj/unparser.png)](https://gemnasium.com/mbj/unparser)
 [![Code Climate](https://codeclimate.com/github/mbj/unparser.png)](https://codeclimate.com/github/mbj/unparser)
 
-Generate equivalent source for ASTs from whitequarks awesome [parser](https://github.com/whitequark/parser).
+Generate equivalent source for ASTs from whitequarks [parser](https://github.com/whitequark/parser).
 
 This library is able to reproduce 100% of ruby 1.9 and 2.0 syntax. Including its own source code.
+
 It serves well for [mutant](https://github.cm/mbj/mutant) mutators and the in-memory vendoring for self hosting.
 
-This library dropped the reproduction of 1.8 syntax in the 0.1.0 release. It currently does not have support for 2.1 specific syntax.
+This library dropped the reproduction of 1.8 syntax in the 0.1.0 release.
+It currently does not have support for 2.1 specific syntax.
 
 Usage
 -----

data/config/flay.yml

@@ -1,3 +1,3 @@
 ---
 threshold: 13
-total_score: 497
+total_score: 700

data/config/flog.yml

@@ -1,2 +1,2 @@
 ---
-threshold: 24.5
+threshold: 20.7

data/config/reek.yml

@@ -10,7 +10,8 @@ UncommunicativeParameterName:
   - !ruby/regexp /[0-9]$/
   - !ruby/regexp /[A-Z]/
 TooManyInstanceVariables:
-  exclude: []
+  exclude:
+  - Unparser::CLI
   enabled: true
   max_instance_variables: 3
 TooManyMethods:
@@ -21,6 +22,7 @@ TooManyMethods:
 UncommunicativeMethodName:
   accept:
   - s
+  - n
   exclude: []
   enabled: true
   reject:
@@ -35,14 +37,12 @@ LongParameterList:
   overrides: {}
 FeatureEnvy:
   exclude:
-  - Unparser::Emitter::Literal::Regexp#escape # TODO Fixme!
-  - Unparser::Emitter::Send::Arguments#effective_arguments # False positive
-  - Unparser::Emitter::Send#binary_receiver?
-  - Unparser::Emitter#visit_terminated
-  - Unparser::CLI#add_options
-  - Unparser::CLI::Source#error_report
-  - Unparser::CLI::Preprocessor::Dstr#collapsed_children
-  - Unparser::Comments#take_before
+  # False positives
+  - Unparser::CLI::Differ#collapsed_hunks
+  - Unparser::Emitter::Send::Arguments#effective_arguments
+  # Helper methods, false positive
+  - Unparser::StripHelper#strip
+  - Unparser::CLI#sources
   enabled: true
 ClassVariable:
   exclude: []
@@ -63,10 +63,10 @@ UncommunicativeModuleName:
 NestedIterators:
   ignore_iterators: []
   exclude:
-  - Unparser::Emitter#self.children
+  # Acceptable cases:
   - Unparser::Emitter::Literal::Regexp#dispatch
-  - Unparser::Emitter::Return#emit_break_return_arguments
   - Unparser::CLI::Preprocessor::Dstr#collapsed_children
+  - Unparser::Preprocessor::CollapseStrChildren#collapsed_children
   enabled: true
   max_allowed_nesting: 1
 TooManyStatements:
@@ -81,7 +81,10 @@ DuplicateMethodCall:
   max_calls: 1
 UtilityFunction:
   max_helper_calls: 1
-  exclude: []
+  exclude:
+  # Intent to be helper methods
+  - Unparser::StripHelper#strip
+  - Unparser::CLI#sources
   enabled: true
 Attribute:
   exclude: []
@@ -96,11 +99,11 @@ UncommunicativeVariableName:
   - !ruby/regexp /[A-Z]/
 RepeatedConditional:
   exclude:
-  - Unparser::Emitter # FIXME
-  - Unparser::Comments # FIXME
-  - Unparser::Emitter::Send # TODO Fixme
+  # TODO:
+  - Unparser::Comments
+  # False positives
   - Unparser::Emitter::If
-  - Unparser::CLI # False positive
+  - Unparser::CLI
   enabled: true
   max_ifs: 1
 DataClump:
@@ -110,12 +113,14 @@ DataClump:
   min_clump_size: 3
 ControlParameter:
   exclude:
-    - Unparser::Emitter#emit_body # false positive
-    - Unparser::Emitter#conditional_parentheses # Intentionally a control structure like helper
+    # False positive:
+    - Unparser::Emitter#emit_body
+    - Unparser::Emitter#conditional_parentheses
   enabled: true
 NilCheck:
   enabled: false
 LongYieldList:
   max_params: 1
-  exclude: []
+  exclude:
+  - Unparser::AST::LocalVariableScope#visit
   enabled: true

data/config/rubocop.yml

@@ -1,11 +1,10 @@
+inherit_from: ../.rubocop.yml
+
 AllCops:
   Includes:
     - '**/*.rake'
     - 'Gemfile'
     - 'Gemfile.triage'
-  Excludes:
-    - '**/vendor/**'
-    - '**/benchmarks/**'
 
 # Avoid parameter lists longer than five parameters.
 ParameterLists:

data/lib/unparser.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
 
+require 'set'
 require 'abstract_type'
 require 'procto'
 require 'concord'
@@ -23,37 +24,24 @@ module Unparser
   # @api private
   #
   def self.unparse(node, comment_array = [])
-    if node.nil?
-      node = Parser::AST::Node.new(:empty)
-    end
+    node = Preprocessor.run(node)
     buffer = Buffer.new
     comments = Comments.new(comment_array)
-    root = Emitter::Root.new(buffer, comments)
+    root = Emitter::Root.new(Parser::AST::Node.new(:root, [node]), buffer, comments)
     Emitter.emitter(node, root).write_to_buffer
     buffer.content
   end
 
-  # Transquote string
-  #
-  # @param [String] raw_quoted
-  # @param [String] current_delimiter
-  # @param [String] target_delimiter
-  #
-  # @return [String]
-  #
-  # @api private
-  #
-  def self.transquote(raw_quoted, current_delimiter, target_delimiter)
-    raw = raw_quoted.gsub("\\#{current_delimiter}", current_delimiter)
-    raw.gsub(target_delimiter, "\\#{target_delimiter}").freeze
-  end
-
 end # Unparser
 
+require 'unparser/strip_helper'
 require 'unparser/buffer'
 require 'unparser/node_helpers'
+require 'unparser/preprocessor'
 require 'unparser/comments'
 require 'unparser/constants'
+require 'unparser/ast'
+require 'unparser/ast/local_variable_scope'
 require 'unparser/emitter'
 require 'unparser/emitter/literal'
 require 'unparser/emitter/literal/primitive'
@@ -79,7 +67,7 @@ require 'unparser/emitter/splat'
 require 'unparser/emitter/cbase'
 require 'unparser/emitter/argument'
 require 'unparser/emitter/begin'
-require 'unparser/emitter/return'
+require 'unparser/emitter/flow_modifier'
 require 'unparser/emitter/undef'
 require 'unparser/emitter/def'
 require 'unparser/emitter/class'
@@ -88,10 +76,8 @@ require 'unparser/emitter/op_assign'
 require 'unparser/emitter/defined'
 require 'unparser/emitter/hookexe'
 require 'unparser/emitter/super'
-require 'unparser/emitter/break'
 require 'unparser/emitter/retry'
 require 'unparser/emitter/redo'
-require 'unparser/emitter/next'
 require 'unparser/emitter/if'
 require 'unparser/emitter/alias'
 require 'unparser/emitter/yield'

data/lib/unparser/ast.rb

@@ -0,0 +1,232 @@
+# encoding: UTF-8
+
+module Unparser
+  # Namespace for AST processing tools
+  module AST
+
+    FIRST_CHILD = ->(node) { node.children.first }.freeze
+    TAUTOLOGY   = ->(node) { true }.freeze
+
+    # Test if local variable was first at given assignment
+    #
+    # @param [Parser::AST::Node] root
+    # @param [Parser::AST::Node] assignment
+    #
+    # @return [true]
+    #   if local variable was firstly introduced in body
+    #
+    # @return [false]
+    #   otherwise
+    #
+    # @api private
+    #
+    def self.first_assignment?(root, assignment)
+      name = assignment.children.first
+      AST::LocalVariableScope.each(root) do |node, current, before|
+        if node.equal?(assignment) && current.include?(name) && !before.include?(name)
+          return true
+        end
+      end
+
+      false
+    end
+
+    # Test if local variable is defined for given node
+    #
+    # @param [Parser::AST::Node] root
+    # @param [Parser::AST::Node] node
+    # @param [Symbol] name
+    #
+    # @return [true]
+    #   if local variable is defined
+    #
+    # @return [false]
+    #   otherwise
+    #
+    # @api private
+    #
+    def self.local_variable_defined_for_node?(root, node, name)
+      AST::LocalVariableScope.each(root) do |child, current, before|
+        if child.equal?(node) && current.include?(name)
+          return true
+        end
+      end
+
+      false
+    end
+
+    # Test if local variables where first assigned in body and read by conditional
+    #
+    # @param [Parser::AST::Node] root
+    # @param [Parser::AST::Node] conditional
+    # @param [Parser::AST::Node] body
+    #
+    # @api private
+    #
+    def self.first_assignment_in_body_and_used_in_condition?(root, body, condition)
+      condition_reads = local_variables_read_in_scope(condition)
+
+      candidates = AST.local_variable_assignments_in_scope(body).select do |node|
+        name = node.children.first
+        condition_reads.include?(name)
+      end
+
+      candidates.any? do |node|
+        first_assignment?(root, node)
+      end
+    end
+
+    # Return local variables that get assigned in scope
+    #
+    # @param [Parser::AST::Node]
+    #
+    # @return [Set<Symbol>]
+    #
+    # @api private
+    #
+    def self.local_variable_assignments_in_scope(node)
+      Enumerator.new(
+        node,
+        LocalVariableScope.method(:not_reset_scope?),
+      ).types(LocalVariableScope::ASSIGN_NODES)
+    end
+
+    # Return local variables read
+    #
+    # @param [Parser::AST::Node] node
+    #
+    # @return [Set<Symbol>]
+    #
+    # @api private
+    #
+    def self.local_variables_read_in_scope(node)
+      Enumerator.new(
+        node,
+        LocalVariableScope.method(:not_close_scope?),
+      ).type(:lvar).map(&FIRST_CHILD).to_set
+    end
+
+    # AST enumerator
+    class Enumerator
+      include Adamantium::Flat, Concord.new(:node, :controller), Enumerable
+
+      # Return new instance
+      #
+      # @param [Parser::AST::Node] node
+      # @param [#call(node)] controller
+      #
+      # @return [Enumerator]
+      #
+      # @api private
+      #
+      def self.new(node, controller = TAUTOLOGY)
+        super
+      end
+
+      # Return each node
+      #
+      # @return [Enumerator<Parser::AST::Node>]
+      #   if no block given
+      #
+      # @return [self]
+      #   otherwise
+      #
+      # @api private
+      #
+      def each(&block)
+        return to_enum unless block_given?
+        Walker.call(node, controller, &block)
+      end
+
+      # Return nodes selected by types
+      #
+      # @param [Enumerable<Symbol>] types
+      #
+      # @return [Enumerable<Parser::AST::Node>]
+      #
+      # @api private
+      #
+      def types(types)
+        select { |node| types.include?(node.type) }
+      end
+
+      # Return nodes selected by type
+      #
+      # @param [Symbol] type
+      #
+      # @return [Enumerable<Parser::AST::Node>]
+      #
+      # @api private
+      #
+      def type(type)
+        select { |node| node.type == type }
+      end
+
+      # Return frozne set of objects
+      #
+      # @param [Enumerable] enumerable
+      #
+      # @return [Set]
+      #
+      # @api private
+      #
+      def self.set(enumerable)
+        enumerable.to_set.freeze
+      end
+      private_class_method :set
+
+      # Return nodes of type
+      #
+      # @param [Parser::AST::Node] node
+      # @param [Symbol] type
+      #
+      # @return [Enumerable<Parser::AST::Node]
+      #
+      # @api private
+      #
+      def self.type(node, type)
+        new(node).type(type)
+      end
+      private_class_method :type
+
+    end # Enumerator
+
+    # Controlled AST walker walking the AST in deeth first search with pre order
+    class Walker
+      include Concord.new(:block, :controller)
+
+      # Call ast walker
+      #
+      # @param [Parser::AST::Node] node
+      #
+      # @return [self]
+      #
+      # @api private
+      #
+      def self.call(node, controller = TAUTOLOGY, &block)
+        new(block, controller).call(node)
+        self
+      end
+
+      # Call walker with node
+      #
+      # @param [Parser::AST::Node] node
+      #
+      # @return [self]
+      #
+      # @api private
+      #
+      def call(node)
+        return unless controller.call(node)
+        block.call(node)
+        node.children.each do |child|
+          if child.kind_of?(Parser::AST::Node)
+            call(child)
+          end
+        end
+        self
+      end
+
+    end # Walker
+  end # AST
+end # Unparser