unparser 0.4.4 → 0.4.9

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unparser
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.9
 platform: ruby
 authors:
 - Markus Schirp
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-03-27 00:00:00.000000000 Z
+date: 2020-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: abstract_type
@@ -39,19 +39,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.2.0
 - !ruby/object:Gem::Dependency
-  name: equalizer
+  name: anima
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.9
+        version: 0.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.9
+        version: 0.3.1
+- !ruby/object:Gem::Dependency
+  name: concord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.5
 - !ruby/object:Gem::Dependency
   name: diff-lcs
   requirement: !ruby/object:Gem::Requirement
@@ -67,33 +81,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: concord
+  name: equalizer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.5
+        version: 0.0.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.5
+        version: 0.0.9
 - !ruby/object:Gem::Dependency
-  name: parser
+  name: mprelude
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.6.2
+        version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.6.2
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.5
 - !ruby/object:Gem::Dependency
   name: procto
   requirement: !ruby/object:Gem::Requirement
@@ -109,47 +137,89 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.0.2
 - !ruby/object:Gem::Dependency
-  name: anima
+  name: mutant
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.9.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.9.9
+- !ruby/object:Gem::Dependency
+  name: mutant-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
 - !ruby/object:Gem::Dependency
-  name: devtools
+  name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.23
+        version: 1.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.23
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
-  name: morpher
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.6
+        version: 0.79.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.6
+        version: 0.79.0
 description: Generate equivalent source for parser gem AST nodes
 email: mbj@schirp-dso.com
 executables:
@@ -158,34 +228,17 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- ".circleci/config.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- Changelog.md
-- Gemfile
-- Gemfile.lock
-- LICENSE
 - README.md
-- Rakefile
 - bin/unparser
-- config/devtools.yml
-- config/flay.yml
-- config/flog.yml
-- config/mutant.yml
-- config/reek.yml
-- config/rubocop.yml
-- config/yardstick.yml
 - lib/unparser.rb
 - lib/unparser/ast.rb
 - lib/unparser/ast/local_variable_scope.rb
 - lib/unparser/buffer.rb
 - lib/unparser/cli.rb
-- lib/unparser/cli/color.rb
-- lib/unparser/cli/differ.rb
-- lib/unparser/cli/source.rb
+- lib/unparser/color.rb
 - lib/unparser/comments.rb
 - lib/unparser/constants.rb
+- lib/unparser/diff.rb
 - lib/unparser/dsl.rb
 - lib/unparser/emitter.rb
 - lib/unparser/emitter/alias.rb
@@ -242,29 +295,12 @@ files:
 - lib/unparser/finalize.rb
 - lib/unparser/node_helpers.rb
 - lib/unparser/preprocessor.rb
-- spec/integration/unparser/corpus_spec.rb
-- spec/integrations.yml
-- spec/spec_helper.rb
-- spec/unit/unparser/buffer/append_spec.rb
-- spec/unit/unparser/buffer/append_without_prefix_spec.rb
-- spec/unit/unparser/buffer/capture_content_spec.rb
-- spec/unit/unparser/buffer/content_spec.rb
-- spec/unit/unparser/buffer/fresh_line_spec.rb
-- spec/unit/unparser/buffer/indent_spec.rb
-- spec/unit/unparser/buffer/nl_spec.rb
-- spec/unit/unparser/buffer/unindent_spec.rb
-- spec/unit/unparser/comments/consume_spec.rb
-- spec/unit/unparser/comments/take_all_spec.rb
-- spec/unit/unparser/comments/take_before_spec.rb
-- spec/unit/unparser/comments/take_eol_comments_spec.rb
-- spec/unit/unparser/emitter/class_methods/handle_spec.rb
-- spec/unit/unparser_spec.rb
-- unparser.gemspec
+- lib/unparser/validation.rb
 homepage: http://github.com/mbj/unparser
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -280,24 +316,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Generate equivalent source for parser gem AST nodes
-test_files:
-- spec/integration/unparser/corpus_spec.rb
-- spec/integrations.yml
-- spec/spec_helper.rb
-- spec/unit/unparser/buffer/append_spec.rb
-- spec/unit/unparser/buffer/append_without_prefix_spec.rb
-- spec/unit/unparser/buffer/capture_content_spec.rb
-- spec/unit/unparser/buffer/content_spec.rb
-- spec/unit/unparser/buffer/fresh_line_spec.rb
-- spec/unit/unparser/buffer/indent_spec.rb
-- spec/unit/unparser/buffer/nl_spec.rb
-- spec/unit/unparser/buffer/unindent_spec.rb
-- spec/unit/unparser/comments/consume_spec.rb
-- spec/unit/unparser/comments/take_all_spec.rb
-- spec/unit/unparser/comments/take_before_spec.rb
-- spec/unit/unparser/comments/take_eol_comments_spec.rb
-- spec/unit/unparser/emitter/class_methods/handle_spec.rb
-- spec/unit/unparser_spec.rb
+test_files: []