unparser 0.8.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9a2bc4c065381b615f71cb36770c6edc2633ce160540426d28ebb6ccda689d8
-  data.tar.gz: c0952ffb8269388f5de64ea68719d785a59dd7f9869907c69df623aeb10d9006
+  metadata.gz: 55ff925fe35a0edc1d97f78f4c2cf18590a3f2b4a11bc33e4b786a5954b4a38b
+  data.tar.gz: 41298c66c043f4f886215b23f6e1b16cd5bfc4fda9cac590a4dcfbf79c7b3ad8
 SHA512:
-  metadata.gz: f0151e34f94305994a4e6fac9ea360fb5918b114e3e1f2ab9e1a6a6b5359134baa972d27a5c09410406185a1c91b5424590eb33ce1d343e928a4eb09bdbfa4e3
-  data.tar.gz: 0fe83efcc1cc934e3d045530c06f1addac19bf30bc101740bf56d8c4129ef2c5c7989498797d5098858b946094ec8962aecf55fa42bba866774ef34fc323fcf7
+  metadata.gz: '08b368b24f292f467d75f2cbbea4488dc117fbfc1619c0ab14eee351121221bf63d0c60aa8cffb1cc9f795eb87fd0a5e0d1cefd196ec955f8d3c0b12784f57a6'
+  data.tar.gz: 9a21fffcd287e446c6e5a459556d1c863490ebbaa906ea4f775619286405d18fab3821c5fc3e14ba4ab8fc8f68de344b6a71565f7e8980f8eac43a762b7caf66

data/README.md

@@ -10,7 +10,7 @@ The following constraints apply:
 
 * No support for macruby extensions
 * Only support for the [modern AST](https://github.com/whitequark/parser/#usage) format
-* Only support for Ruby >= 3.2
+* Only support for Ruby >= 3.3
 
 Notable Users:
 
@@ -173,12 +173,12 @@ Included Libraries
 
 For dependency reduction reasons unparser ships vendored (and reduced) versions of:
 
-* [abstract_type](https://github.com/mbj/concord) -> Unparser::AbstractType
+* [abstract_type](https://github.com/dkubb/abstract_type) -> Unparser::AbstractType
 * [adamantium](https://github.com/dkubb/adamantium) -> Unparser::Adamantium
-* [anima](https://github.com/mbj/concord) -> Unparser::Anima
-* [concord](https://github.com/mbj/concord) -> Unparser::Concord
-* [memoizable](https://github.com/dkubb/memoizable) -> Unparser::Adamantium
-* [mprelude](https://github.com/dkubb/memoizable) -> Unparser::Either
+* [anima](https://github.com/mbj/anima) -> Unparser::Anima
+* [equalizer](https://github.com/dkubb/equalizer) -> Unparser::Equalizer
+* [memoizable](https://github.com/dkubb/memoizable) -> Unparser::Memoizable
+* [mprelude](http://prelude.rubyforge.org/) -> Unparser::Either
 
 Contributing
 -------------

data/lib/unparser/anima.rb

@@ -50,9 +50,7 @@ module Unparser
     #
     # @return [Hash]
     def attributes_hash(object)
-      attributes.each_with_object({}) do |attribute, attributes_hash|
-        attributes_hash[attribute.name] = attribute.get(object)
-      end
+      attributes.to_h { |attribute| [attribute.name, attribute.get(object)] }
     end
 
     # Return attribute names

data/lib/unparser/ast.rb

@@ -90,7 +90,14 @@ module Unparser
 
     # AST enumerator
     class Enumerator
-      include Adamantium, Concord.new(:node, :controller), Enumerable
+      include Adamantium, Equalizer.new(:node, :controller), Enumerable
+
+      attr_reader :node, :controller
+
+      def initialize(node, controller)
+        @node = node
+        @controller = controller
+      end
 
       # Return each node
       #
@@ -130,38 +137,18 @@ module Unparser
         select { |node| node.type.equal?(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)
+      include Equalizer.new(:block, :controller)
+
+      attr_reader :block, :controller
+
+      def initialize(block, controller)
+        @block = block
+        @controller = controller
+      end
 
       # Call ast walker
       #

data/lib/unparser/cli.rb

@@ -14,7 +14,15 @@ module Unparser
 
       # Path target
       class Path < self
-        include Concord.new(:path)
+        include Equalizer.new(:path)
+
+        attr_reader :path
+
+        # rubocop:disable Lint/MissingSuper
+        def initialize(path)
+          @path = path
+        end
+        # rubocop:enable Lint/MissingSuper
 
         # Validation for this target
         #
@@ -33,7 +41,13 @@ module Unparser
 
       # String target
       class String
-        include Concord.new(:string)
+        include Equalizer.new(:string)
+
+        attr_reader :string
+
+        def initialize(string)
+          @string = string
+        end
 
         # Validation for this target
         #

data/lib/unparser/color.rb

@@ -3,7 +3,13 @@
 module Unparser
   # Class to colorize strings
   class Color
-    include Adamantium, Concord.new(:code)
+    include Adamantium, Equalizer.new(:code)
+
+    attr_reader :code
+
+    def initialize(code)
+      @code = code
+    end
 
     # Format text with color
     #

data/lib/unparser/diff.rb

@@ -3,7 +3,14 @@
 module Unparser
   # Class to create diffs from source code
   class Diff
-    include Adamantium, Concord.new(:old, :new)
+    include Adamantium, Equalizer.new(:old, :new)
+
+    attr_reader :old, :new
+
+    def initialize(old, new)
+      @old = old
+      @new = new
+    end
 
     ADDITION = '+'
     DELETION = '-'

data/lib/unparser/either.rb

@@ -19,11 +19,13 @@ module Unparser
   end # RequireBLock
 
   class Either
-    include(
-      Adamantium,
-      Concord.new(:value),
-      RequireBlock
-    )
+    include Adamantium, Equalizer.new(:value), RequireBlock
+
+    attr_reader :value
+
+    def initialize(value)
+      @value = value
+    end
 
     # Execute block and wrap error in left
     #

data/lib/unparser/emitter/primitive.rb

@@ -13,23 +13,8 @@ module Unparser
 
         private
 
-        # mutant:disable
         def dispatch
-          if inspect_breaks_parsing?
-            write(":#{value.name.inspect}")
-          else
-            write(value.inspect)
-          end
-        end
-
-        # mutant:disable
-        def inspect_breaks_parsing?
-          return false unless RUBY_VERSION < '3.2.'
-
-          Unparser.parse(value.inspect)
-          false
-        rescue Parser::SyntaxError
-          true
+          write(value.inspect)
         end
       end # Symbol
 

data/lib/unparser/equalizer.rb

@@ -4,95 +4,129 @@ module Unparser
   # Define equality, equivalence and inspection methods
   #
   # Original code before vendoring and reduction from: https://github.com/dkubb/equalizer.
-  class Equalizer < Module
-    # Initialize an Equalizer with the given keys
+  module Equalizer
+    # Creates a module providing equality methods based on the given attributes
     #
-    # Will use the keys with which it is initialized to define #cmp?,
-    # #hash, and #inspect
+    # @param keys [Array<Symbol>] attribute names to use for equality
+    # @param inspect [Boolean] whether to override #inspect and #pretty_print
+    # @return [Module] a module to include in your class
+    # @raise [ArgumentError] if keys is empty or contains non-Symbols
     #
-    # @param [Array<Symbol>] keys
-    #
-    # @return [undefined]
-    #
-    # @api private
-    #
-    # rubocop:disable Lint/MissingSuper
-    def initialize(*keys)
-      @keys = keys
-      define_methods
-      freeze
-    end
-    # rubocop:enable Lint/MissingSuper
-
-    private
-
-    def included(descendant)
-      descendant.include(Methods)
-    end
-
-    def define_methods
-      define_cmp_method
-      define_hash_method
-      define_inspect_method
+    # @api public
+    def self.new(*keys, inspect: true)
+      build_module(keys.freeze, inspect:)
     end
 
-    def define_cmp_method
-      keys = @keys
-      define_method(:cmp?) do |comparator, other|
-        keys.all? do |key|
-          __send__(key).public_send(comparator, other.__send__(key))
-        end
+    # Instance methods mixed into classes that include an Equalizer module
+    #
+    # @api private
+    module InstanceMethods
+      # Equality comparison allowing subclasses
+      #
+      # @param other [Object] object to compare
+      # @return [Boolean] true if other is_a? same class with equal attributes
+      def ==(other)
+        other.is_a?(self.class) &&
+          cmp?(:==, other)
       end
-      private :cmp?
-    end
 
-    def define_hash_method
-      keys = @keys
-      define_method(:hash) do
-        keys.map(&public_method(:__send__)).push(self.class).hash
+      # Strict equality requiring exact class match
+      #
+      # @param other [Object] object to compare
+      # @return [Boolean] true if other is exact same class with eql? attributes
+      def eql?(other)
+        other.instance_of?(self.class) &&
+          cmp?(:eql?, other)
       end
-    end
 
-    def define_inspect_method
-      keys = @keys
-      define_method(:inspect) do
-        klass = self.class
-        name  = klass.name || klass.inspect
-        "#<#{name}#{keys.map { |key| " #{key}=#{__send__(key).inspect}" }.join}>"
+      # Hash code based on class and attribute values
+      #
+      # @return [Integer] hash code
+      def hash
+        [self.class, *deconstruct].hash
       end
-    end
 
-    # The comparison methods
-    module Methods
-      # Compare the object with other object for equality
+      # Array deconstruction for pattern matching
       #
-      # @example
-      #   object.eql?(other)  # => true or false
+      # @return [Array] attribute values in order
+      def deconstruct
+        equalizer_keys.map { |key| public_send(key) }
+      end
+
+      # Hash deconstruction for pattern matching
       #
-      # @param [Object] other
-      #   the other object to compare with
+      # @param requested [Array<Symbol>, nil] keys to include, or nil for all
+      # @return [Hash{Symbol => Object}] requested attribute key-value pairs
+      def deconstruct_keys(requested)
+        subset = requested.nil? ? equalizer_keys : equalizer_keys & requested
+        subset.to_h { |key| [key, public_send(key)] }
+      end
+
+      private
+
+      # Compare all attributes using the given comparator
       #
-      # @return [Boolean]
+      # @param comparator [Symbol] method to use for comparison
+      # @param other [Object] object to compare against
+      # @return [Boolean] true if all attributes match
       #
-      # @api public
-      def eql?(other)
-        instance_of?(other.class) && cmp?(__method__, other)
+      # @api private
+      def cmp?(comparator, other)
+        equalizer_keys.all? do |key|
+          public_send(key)
+            .public_send(comparator, other.public_send(key))
+        end
       end
+    end
 
-      # Compare the object with other object for equivalency
-      #
-      # @example
-      #   object == other  # => true or false
+    # Instance methods for inspect and pretty print output
+    #
+    # @api private
+    module InspectMethods
+      # String representation showing only equalizer attributes
       #
-      # @param [Object] other
-      #   the other object to compare with
+      # @return [String] inspect output
+      def inspect
+        attrs = equalizer_keys
+          .map { |key| "@#{key}=#{public_send(key).inspect}" }
+          .join(', ')
+        Object.instance_method(:to_s).bind_call(self).sub(/>\z/, " #{attrs}>")
+      end
+
+      # Pretty print output using PP's object formatting
       #
-      # @return [Boolean]
+      # @param q [PP] pretty printer
+      # @return [void]
+      def pretty_print(pretty_printer)
+        pretty_printer.pp_object(self)
+      end
+
+      # Instance variables to display in pretty print output
       #
-      # @api public
-      def ==(other)
-        instance_of?(other.class) && cmp?(__method__, other)
+      # @return [Array<Symbol>] instance variable names
+      def pretty_print_instance_variables
+        equalizer_keys.map { |key| :"@#{key}" }
       end
-    end # module Methods
-  end # class Equalizer
+    end
+
+    # Builds the module with equality methods for the given keys
+    #
+    # @param keys [Array<Symbol>] attribute names (frozen)
+    # @param inspect [Boolean] whether to include inspect methods
+    # @return [Module] the configured module
+    #
+    # @api private
+    def self.build_module(keys, inspect:)
+      Module.new do
+        include InstanceMethods
+        include InspectMethods if inspect
+
+        set_temporary_name("Equalizer(#{keys.join(', ')})")
+
+        define_method(:equalizer_keys) { keys }
+        private :equalizer_keys
+      end
+    end
+    private_class_method :build_module
+  end # module Equalizer
 end # Unparser

data/lib/unparser/node_details.rb

@@ -7,7 +7,13 @@ module Unparser
     # mutant:disable
     def self.included(descendant)
       descendant.class_eval do
-        include Adamantium, Concord.new(:node)
+        include Adamantium, Equalizer.new(:node)
+
+        attr_reader :node
+
+        def initialize(node)
+          @node = node
+        end
 
         extend DSL
       end

data/lib/unparser.rb

@@ -9,7 +9,6 @@ require 'unparser/adamantium'
 require 'unparser/adamantium/method_builder'
 require 'unparser/abstract_type'
 
-require 'unparser/concord'
 require 'unparser/either'
 require 'unparser/anima'
 require 'unparser/anima/attribute'
@@ -73,7 +72,7 @@ module Unparser # rubocop:disable Metrics/ModuleLength
   EMPTY_STRING = ''.freeze
   EMPTY_ARRAY  = [].freeze
 
-  private_constant(*constants(false) - %i[Adamantium AbstractType Anima Concord Either Equalizer Memoizable])
+  private_constant(*constants(false) - %i[Adamantium AbstractType Anima Either Equalizer Memoizable])
 
   # Error raised when unparser encounters an invalid AST
   class InvalidNodeError < RuntimeError

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: unparser
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.9.0
 platform: ruby
 authors:
 - Markus Schirp
@@ -75,28 +75,28 @@ dependencies:
   name: mutant
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.14.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.14.2
 - !ruby/object:Gem::Dependency
   name: mutant-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.14.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.14.2
 - !ruby/object:Gem::Dependency
@@ -204,7 +204,6 @@ files:
 - lib/unparser/cli.rb
 - lib/unparser/color.rb
 - lib/unparser/comments.rb
-- lib/unparser/concord.rb
 - lib/unparser/constants.rb
 - lib/unparser/diff.rb
 - lib/unparser/dsl.rb
@@ -294,10 +293,11 @@ files:
 - lib/unparser/writer/send/conditional.rb
 - lib/unparser/writer/send/regular.rb
 - lib/unparser/writer/send/unary.rb
-homepage: http://github.com/mbj/unparser
+homepage: https://github.com/mbj/unparser
 licenses:
 - MIT
 metadata:
+  homepage_uri: https://github.com/mbj/unparser
   bug_tracker_uri: https://github.com/mbj/unparser/issues
   changelog_uri: https://github.com/mbj/unparser/blob/main/Changelog.md
   funding_uri: https://github.com/sponsors/mbj
@@ -310,14 +310,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.8
 specification_version: 4
 summary: Generate equivalent source for parser gem AST nodes
 test_files: []

data/lib/unparser/concord.rb

@@ -1,114 +0,0 @@
-# frozen_string_literal: true
-
-module Unparser
-  # A mixin to define a composition
-  #
-  # Original code before vendoring and reduction from: https://github.com/mbj/concord.
-  class Concord < Module
-    include Adamantium, Equalizer.new(:names)
-
-    # The maximum number of objects the hosting class is composed of
-    MAX_NR_OF_OBJECTS = 3
-
-    # Return names
-    #
-    # @return [Enumerable<Symbol>]
-    #
-    # @api private
-    #
-    attr_reader :names
-
-    private
-
-    # Initialize object
-    #
-    # @return [undefined]
-    #
-    # @api private
-    #
-    # rubocop:disable Lint/MissingSuper
-    def initialize(*names)
-      if names.length > MAX_NR_OF_OBJECTS
-        fail "Composition of more than #{MAX_NR_OF_OBJECTS} objects is not allowed"
-      end
-
-      @names = names
-      define_initialize
-      define_readers
-      define_equalizer
-    end
-    # rubocop:enable Lint/MissingSuper
-
-    # Define equalizer
-    #
-    # @return [undefined]
-    #
-    # @api private
-    #
-    def define_equalizer
-      include(Equalizer.new(*names))
-    end
-
-    # Define readers
-    #
-    # @return [undefined]
-    #
-    # @api private
-    #
-    def define_readers
-      attribute_names = names
-      attr_reader(*attribute_names)
-
-      protected(*attribute_names) if attribute_names.any?
-    end
-
-    # Define initialize method
-    #
-    # @return [undefined]
-    #
-    # @api private
-    #
-    #
-    def define_initialize
-      ivars = instance_variable_names
-      size = names.size
-
-      define_method :initialize do |*args|
-        args_size = args.size
-        unless args_size.equal?(size)
-          fail ArgumentError, "wrong number of arguments (#{args_size} for #{size})"
-        end
-
-        ivars.zip(args) { |ivar, arg| instance_variable_set(ivar, arg) }
-      end
-    end
-
-    # Return instance variable names
-    #
-    # @return [String]
-    #
-    # @api private
-    #
-    def instance_variable_names
-      names.map { |name| "@#{name}" }
-    end
-
-    # Mixin for public attribute readers
-    class Public < self
-
-      # Hook called when module is included
-      #
-      # @param [Class,Module] descendant
-      #
-      # @return [undefined]
-      #
-      # @api private
-      #
-      def included(descendant)
-        names.each do |name|
-          descendant.__send__(:public, name)
-        end
-      end
-    end # Public
-  end # Concord
-end # Unparser