unparser 0.4.3 → 0.4.8

data/lib/unparser/dsl.rb

@@ -45,7 +45,7 @@ module Unparser
     #
     # @return [undefined]
     #
-    # @pai private
+    # @api private
     #
     def define_group(name, range)
       define_method(name) do

data/lib/unparser/emitter.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Unparser
+  UnknownNodeError = Class.new(ArgumentError)
 
   # Emitter base class
   #
@@ -79,7 +80,7 @@ module Unparser
 
     # Register emitter for type
     #
-    # @param [Symbol] type
+    # @param [Symbol] types
     #
     # @return [undefined]
     #
@@ -116,7 +117,7 @@ module Unparser
     def self.emitter(node, parent)
       type = node.type
       klass = REGISTRY.fetch(type) do
-        raise ArgumentError, "No emitter for node: #{type.inspect}"
+        raise UnknownNodeError, "Unknown node type: #{type.inspect}"
       end
       klass.new(node, parent)
     end
@@ -249,7 +250,6 @@ module Unparser
     # Emit delimited body
     #
     # @param [Enumerable<Parser::AST::Node>] nodes
-    # @param [String] delimiter
     #
     # @return [undefined]
     #
@@ -262,7 +262,6 @@ module Unparser
     # Emit delimited body
     #
     # @param [Enumerable<Parser::AST::Node>] nodes
-    # @param [String] delimiter
     #
     # @return [undefined]
     #
@@ -432,7 +431,7 @@ module Unparser
 
     # Emit non nil body
     #
-    # @param [Parser::AST::Node] node
+    # @param [Parser::AST::Node] body
     #
     # @return [undefined]
     #

data/lib/unparser/emitter/argument.rb

@@ -240,7 +240,7 @@ module Unparser
 
       handle :procarg0
 
-      children :first_argument
+      PARENS = %i[restarg mlhs].freeze
 
     private
 
@@ -251,22 +251,18 @@ module Unparser
       # @api private
       #
       def dispatch
-        if first_argument.instance_of?(Symbol)
-          write(first_argument.to_s)
+        if needs_parens?
+          parentheses do
+            delimited(children)
+          end
         else
-          emit_multiple_children
+          delimited(children)
         end
       end
 
-      # Emit multiple children
-      #
-      # @return [undefined]
-      #
-      # @api private
-      #
-      def emit_multiple_children
-        parentheses do
-          delimited(children)
+      def needs_parens?
+        children.length > 1 || children.any? do |node|
+          PARENS.include?(node.type)
         end
       end
     end

data/lib/unparser/emitter/literal/primitive.rb

@@ -107,7 +107,7 @@ module Unparser
 
           # Write rational format
           #
-          # @param [#to_s]
+          # @param [#to_s] value
           #
           # @return [undefined]
           #

data/lib/unparser/emitter/literal/range.rb

@@ -27,7 +27,7 @@ module Unparser
         def dispatch
           visit(begin_node)
           write(TOKENS.fetch(node.type))
-          visit(end_node)
+          visit(end_node) if end_node
         end
 
       end # Range

data/lib/unparser/node_helpers.rb

@@ -5,7 +5,8 @@ module Unparser
 
     # Helper for building nodes
     #
-    # @param [Symbol]
+    # @param [Symbol] type
+    # @param [Parser::AST::Node] children
     #
     # @return [Parser::AST::Node]
     #
@@ -19,9 +20,10 @@ module Unparser
 
     # Helper for building nodes
     #
-    # @param [Symbol]
+    # @param [Symbol] type
     #
     # @return [Parser::AST::Node]
+    # @param [Array] children
     #
     # @api private
     #

data/lib/unparser/preprocessor.rb

@@ -114,7 +114,7 @@ module Unparser
 
       # Return preprocessor result
       #
-      # @param [Parser::AST::Node]
+      # @return [Parser::AST::Node]
       #
       # @api private
       #

data/lib/unparser/validation.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+module Unparser
+  # Validation of unparser results
+  #
+  # ignore :reek:TooManyMethods
+  class Validation
+    include Adamantium::Flat, Anima.new(
+      :generated_node,
+      :generated_source,
+      :identification,
+      :original_node,
+      :original_source
+    )
+
+    # Test if source could be unparsed successfully
+    #
+    # @return [Boolean]
+    #
+    # @api private
+    #
+    def success?
+      [
+        original_source,
+        original_node,
+        generated_source,
+        generated_node
+      ].all?(&:right?) && generated_node.from_right.eql?(original_node.from_right)
+    end
+
+    # Return error report
+    #
+    # @return [String]
+    #
+    # @api private
+    #
+    def report
+      message = [identification]
+
+      message.concat(make_report('Original-Source',  :original_source))
+      message.concat(make_report('Generated-Source', :generated_source))
+      message.concat(make_report('Original-Node',    :original_node))
+      message.concat(make_report('Generated-Node',   :generated_node))
+      message.concat(node_diff_report)
+
+      message.join("\n")
+    end
+    memoize :report
+
+    # Create validator from string
+    #
+    # @param [String] original_source
+    #
+    # @return [Validator]
+    def self.from_string(original_source)
+      original_node = Unparser
+        .parse_either(original_source)
+        .fmap(&Preprocessor.method(:run))
+
+      generated_source = original_node
+        .lmap(&method(:const_unit))
+        .bind(&method(:unparse_either))
+
+      generated_node = generated_source
+        .lmap(&method(:const_unit))
+        .bind(&Unparser.method(:parse_either))
+        .fmap(&Preprocessor.method(:run))
+
+      new(
+        identification:   '(string)',
+        original_source:  MPrelude::Either::Right.new(original_source),
+        original_node:    original_node,
+        generated_source: generated_source,
+        generated_node:   generated_node
+      )
+    end
+
+    # Create validator from file
+    #
+    # @param [Pathname] path
+    #
+    # @return [Validator]
+    def self.from_path(path)
+      from_string(path.read).with(identification: path.to_s)
+    end
+
+  private
+
+    # Create a labeled report from
+    #
+    # @param [String] label
+    # @param [Symbol] attribute_name
+    #
+    # @return [Array<String>]
+    def make_report(label, attribute_name)
+      ["#{label}:"].concat(public_send(attribute_name).either(method(:report_exception), ->(value) { [value] }))
+    end
+
+    # Report optional exception
+    #
+    # @param [Exception, nil] exception
+    #
+    # @return [Array<String>]
+    def report_exception(exception)
+      if exception
+        [exception.inspect].concat(exception.backtrace.take(20))
+      else
+        ['undefined']
+      end
+    end
+
+    # Report the node diff
+    #
+    # @return [Array<String>]
+    def node_diff_report
+      diff = nil
+
+      original_node.fmap do |original|
+        generated_node.fmap do |generated|
+          diff = Diff.new(
+            original.to_s.lines.map(&:chomp),
+            generated.to_s.lines.map(&:chomp)
+          ).colorized_diff
+        end
+      end
+
+      diff ? ['Node-Diff:', diff] : []
+    end
+
+    # Create unit represented as nil
+    #
+    # @param [Object] _value
+    #
+    # @return [nil]
+    def self.const_unit(_value); end
+    private_class_method :const_unit
+
+    # Unparse capturing errors
+    #
+    # @param [Parser::AST::Node] node
+    #
+    # @return [Either<RuntimeError, String>]
+    def self.unparse_either(node)
+      MPrelude::Either
+        .wrap_error(RuntimeError) { Unparser.unparse(node) }
+    end
+    private_class_method :unparse_either
+  end # Validation
+end # Unparser

data/spec/integration/unparser/corpus_spec.rb

@@ -81,26 +81,40 @@ describe 'Unparser on ruby corpus', mutant: false do
       end
     end
 
-    LOADER = Morpher.build do
-      s(:block,
-        s(:guard, s(:primitive, Array)),
-        s(:map,
-          s(:block,
-            s(:guard, s(:primitive, Hash)),
-            s(:hash_transform,
-              s(:key_symbolize, :repo_uri, s(:guard, s(:primitive, String))),
-              s(:key_symbolize, :repo_ref, s(:guard, s(:primitive, String))),
-              s(:key_symbolize, :name,     s(:guard, s(:primitive, String))),
-              s(:key_symbolize, :exclude,  s(:map, s(:guard, s(:primitive, String))))),
-            s(:load_attribute_hash,
-              # NOTE: The domain param has no DSL currently!
-              Morpher::Evaluator::Transformer::Domain::Param.new(
-                Project,
-                [:repo_uri, :repo_ref, :name, :exclude]
-              )))))
-    end
+    transform    = Mutant::Transform
+    string       = transform::Primitive.new(String)
+    string_array = transform::Array.new(string)
+    path         = ROOT.join('spec', 'integrations.yml')
+
+    loader =
+      transform::Named.new(
+        path.to_s,
+        transform::Sequence.new(
+          [
+            transform::Exception.new(SystemCallError, :read.to_proc),
+            transform::Exception.new(YAML::SyntaxError, YAML.method(:safe_load)),
+            transform::Array.new(
+              transform::Sequence.new(
+                [
+                  transform::Hash.new(
+                     optional: [],
+                     required: [
+                       transform::Hash::Key.new('exclude',  string_array),
+                       transform::Hash::Key.new('name',     string),
+                       transform::Hash::Key.new('repo_ref', string),
+                       transform::Hash::Key.new('repo_uri', string)
+                    ]
+                  ),
+                  transform::Hash::Symbolize.new,
+                  transform::Exception.new(Anima::Error, Project.public_method(:new))
+                ]
+              )
+            )
+          ]
+        )
+      )
 
-    ALL = LOADER.call(YAML.load_file(ROOT.join('spec', 'integrations.yml')))
+    ALL = loader.apply(path).lmap(&:compact_message).from_right
   end
 
   Project::ALL.each do |project|

data/spec/integrations.yml

@@ -18,7 +18,7 @@
 - name: rubyspec
   repo_uri: 'https://github.com/ruby/spec.git'
   # Revision of rubyspec on the last CI build of unparser that passed
-  repo_ref: 'origin/master'
+  repo_ref: 'b40189b88'
   exclude:
     - command_line/fixtures/bad_syntax.rb
     - core/array/pack/shared/float.rb
@@ -40,10 +40,12 @@
     - core/env/element_reference_spec.rb
     - core/io/readpartial_spec.rb
     - core/io/shared/gets_ascii.rb
+    - core/kernel/shared/sprintf_encoding.rb
     - core/marshal/dump_spec.rb
     - core/marshal/fixtures/marshal_data.rb
     - core/marshal/shared/load.rb
     - core/random/bytes_spec.rb
+    - core/regexp/shared/new.rb
     - core/regexp/shared/new_ascii.rb
     - core/regexp/shared/new_ascii_8bit.rb
     - core/regexp/shared/quote.rb
@@ -51,6 +53,8 @@
     - core/string/casecmp_spec.rb
     - core/string/codepoints_spec.rb
     - core/string/count_spec.rb
+    - core/string/encode_spec.rb
+    - core/string/inspect_spec.rb
     - core/string/shared/codepoints.rb
     - core/string/shared/each_codepoint_without_block.rb
     - core/string/shared/eql.rb
@@ -71,6 +75,7 @@
     - language/regexp/escapes_spec.rb
     - language/source_encoding_spec.rb
     - language/string_spec.rb
+    - library/base64/decode64_spec.rb
     - library/digest/md5/shared/constants.rb
     - library/digest/md5/shared/sample.rb
     - library/digest/sha1/shared/constants.rb

data/spec/spec_helper.rb

@@ -1,12 +1,34 @@
-require 'yaml'
+require 'anima'
+require 'mutant'
 require 'pathname'
+require 'timeout'
 require 'unparser'
-require 'anima'
-require 'morpher'
-require 'devtools/spec_helper'
+require 'yaml'
 
 require 'parser/current'
 
+RSpec.configuration.around(file_path: %r{spec/unit}) do |example|
+  Timeout.timeout(0.1, &example)
+end
+
+RSpec.shared_examples_for 'a command method' do
+  it 'returns self' do
+    should equal(object)
+  end
+end
+
+RSpec.shared_examples_for 'an idempotent method' do
+  it 'is idempotent' do
+    first = subject
+    fail 'RSpec not configured for threadsafety' unless RSpec.configuration.threadsafe?
+    mutex    = __memoized.instance_variable_get(:@mutex)
+    memoized = __memoized.instance_variable_get(:@memoized)
+
+    mutex.synchronize { memoized.delete(:subject) }
+    should equal(first)
+  end
+end
+
 module SpecHelper
   def s(type, *children)
     Parser::AST::Node.new(type, children)

data/spec/unit/unparser/color_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe Unparser::Color do
+  shared_examples 'actual color' do |code|
+    describe '#format' do
+
+      it 'returns formatted string' do
+        expect(apply).to eql("\e[#{code}mexample-string\e[0m")
+      end
+    end
+  end
+
+  describe '#format' do
+    let(:input) { 'example-string' }
+
+    def apply
+      object.format(input)
+    end
+
+    context 'RED' do
+      let(:object) { described_class::RED }
+
+      include_examples 'actual color', 31
+    end
+
+    context 'GREEN' do
+      let(:object) { described_class::GREEN }
+
+      include_examples 'actual color', 32
+    end
+
+    context 'NONE' do
+      let(:object) { described_class::NONE }
+
+      it 'returns original input' do
+        expect(apply).to be(input)
+      end
+    end
+  end
+end