parser_node_ext 1.2.2 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6c6c18cd96c8260a6318584861952e15597a1e89e3ad765459cbcd7ee09811e
-  data.tar.gz: 9b60771fe8b4428ef615e0bc7064d275027f3a292c13b2936266b1e19c0c2178
+  metadata.gz: 50a45e7affbc066c77b4b1ced9b3b9e95f44dda27d545406a81835c3272eada5
+  data.tar.gz: 20b65501f3e92ea387a1a3f28ec67627cd3c6ea48228a7988c309730a68d380d
 SHA512:
-  metadata.gz: cd2ebf1060bca500fb0ea333ddd8819040095566ccf385eafed3bfe0da15f9d5659147e83547d2a714a7393debc934c3c791404d0595d7ca3fbaa29d0434b3f4
-  data.tar.gz: 9238796ab318e28ec2a1df877142985d4461e39d74923ff5055ab3fcc4267ca234c1ce89110ef3e947b1f1bfc136c168486962db36ec952342b1617123423cb0
+  metadata.gz: 69a851d7c5e73797708dd354c5b9f145d6d6c525b234b5be9c2d7c9e79ef690117a1c8c9bdb068a428a0796403d67a91104dd327551c004f42c6168d7e41d92a
+  data.tar.gz: 660151c08259100c51194e374c8db31ff66fb2acaf76a9f8c41c594029de8ef775f2a4bdc352718860224c31531fca0e63b6cefdb7e85bc1511e1ce26e86a462

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # CHANGELOG
 
+## 1.3.1 (2024-04-18)
+
+* Remove `.key?` method
+
+## 1.3.0 (2024-04-07)
+
+* Add github actions
+* Remove `siblings` method
+* Abstract `parser_node_ext/parent_node_ext`
+
 ## 1.2.2 (2024-02-10)
 
 * Remove `to_hash` extend

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    parser_node_ext (1.2.2)
+    parser_node_ext (1.3.1)
       parser
 
 GEM

data/README.md

@@ -1,5 +1,8 @@
 # ParserNodeExt
 
+[![Build Status](https://github.com/synvert-hq/parser_node_ext/actions/workflows/main.yml/badge.svg)](https://github.com/synvert-hq/parser_node_ext/actions/workflows/main.yml)
+[![Gem Version](https://img.shields.io/gem/v/parser_node_ext.svg)](https://rubygems.org/gems/parser_node_ext)
+
 It assigns names to the child nodes of the [parser](https://rubygems.org/gems/parser).
 
 ```ruby
@@ -16,6 +19,12 @@ It also adds some helpers
 node.foo_pair # get the pair node of hash foo key
 node.foo_value # get the value node of the hash foo key
 node.foo_source # get the source of the value node of the hash foo key
+node.keys # get key nodes of the hash node
+node.values # get value nodes of the hash node
+
+# all nodes
+node.to_value # get the value of the node, like `true`, `false`, `nil`, `1`, `"foo"`
+node.to_source # get the source code of the node
 ```
 
 ## Installation

data/lib/parser_node_ext/parent_node_ext.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+class Parser::AST::Node
+  # Initialize a Node.
+  #
+  # It extends {Parser::AST::Node} and set parent for its child nodes.
+  def initialize(type, children = [], properties = {})
+    @mutable_attributes = {}
+    super
+    # children could be nil for s(:array)
+    Array(children).each do |child_node|
+      if child_node.is_a?(Parser::AST::Node)
+        child_node.parent = self
+      end
+    end
+  end
+
+  # Get the parent node.
+  # @return [Parser::AST::Node] parent node.
+  def parent
+    @mutable_attributes[:parent]
+  end
+
+  # Set the parent node.
+  # @param node [Parser::AST::Node] parent node.
+  def parent=(node)
+    @mutable_attributes[:parent] = node
+  end
+end

data/lib/parser_node_ext/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ParserNodeExt
-  VERSION = "1.2.2"
+  VERSION = "1.3.1"
 end

data/lib/parser_node_ext.rb

@@ -119,39 +119,6 @@ module ParserNodeExt
 
   def self.included(base)
     base.class_eval do
-      # Initialize a Node.
-      #
-      # It extends {Parser::AST::Node} and set parent for its child nodes.
-      def initialize(type, children = [], properties = {})
-        @mutable_attributes = {}
-        super
-        # children could be nil for s(:array)
-        Array(children).each do |child_node|
-          if child_node.is_a?(Parser::AST::Node)
-            child_node.parent = self
-          end
-        end
-      end
-
-      # Get the parent node.
-      # @return [Parser::AST::Node] parent node.
-      def parent
-        @mutable_attributes[:parent]
-      end
-
-      # Set the parent node.
-      # @param node [Parser::AST::Node] parent node.
-      def parent=(node)
-        @mutable_attributes[:parent] = node
-      end
-
-      # Get the sibling nodes.
-      # @return [Array<Parser::AST::Node>] sibling nodes.
-      def siblings
-        index = parent.children.index(self)
-        parent.children[index + 1..]
-      end
-
       # Dyamically defined method based on const TYPE_CHILDREN.
       TYPE_CHILDREN.values.flatten.uniq.each do |method_name|
         define_method(method_name) do
@@ -352,21 +319,6 @@ module ParserNodeExt
         end
       end
 
-      # Check if :hash node contains specified key.
-      # @example
-      #   node # s(:hash, s(:pair, s(:sym, :foo), s(:sym, :bar)))
-      #   node.key?(:foo) # true
-      # @param [Symbol, String] key value.
-      # @return [Boolean] true if specified key exists.
-      # @raise [MethodNotSupported] if calls on other node.
-      def key?(key)
-        if %i[hash hash_pattern].include?(type)
-          pairs.any? { |pair_node| pair_node.key.to_value == key }
-        else
-          raise MethodNotSupported, "key? is not supported for #{self}"
-        end
-      end
-
       # Get :hash pair node according to specified key.
       # @example
       #   node # s(:hash, s(:pair, s(:sym, :foo), s(:sym, :bar)))
@@ -455,20 +407,20 @@ module ParserNodeExt
           return children.send(method_name, *args, &block)
         elsif :hash == type && method_name.to_s.end_with?('_pair')
           key = method_name.to_s[0..-6]
-          return hash_pair(key.to_sym) if key?(key.to_sym)
-          return hash_pair(key.to_s) if key?(key.to_s)
+          return hash_pair(key.to_sym) if keys.map(&:to_value).include?(key.to_sym)
+          return hash_pair(key.to_s) if keys.map(&:to_value).include?(key.to_s)
 
           return nil
         elsif :hash == type && method_name.to_s.end_with?('_value')
           key = method_name.to_s[0..-7]
-          return hash_value(key.to_sym) if key?(key.to_sym)
-          return hash_value(key.to_s) if key?(key.to_s)
+          return hash_value(key.to_sym) if keys.map(&:to_value).include?(key.to_sym)
+          return hash_value(key.to_s) if keys.map(&:to_value).include?(key.to_s)
 
           return nil
         elsif :hash == type && method_name.to_s.end_with?('_source')
           key = method_name.to_s[0..-8]
-          return hash_value(key.to_sym)&.to_source if key?(key.to_sym)
-          return hash_value(key.to_s)&.to_source if key?(key.to_s)
+          return hash_value(key.to_sym)&.to_source if keys.map(&:to_value).include?(key.to_sym)
+          return hash_value(key.to_s)&.to_source if keys.map(&:to_value).include?(key.to_s)
 
           return ''
         end
@@ -481,13 +433,13 @@ module ParserNodeExt
           return true
         elsif :hash == type && method_name.to_s.end_with?('_pair')
           key = method_name.to_s[0..-6]
-          return key?(key.to_sym) || key?(key.to_s)
+          return keys.map(&:to_value).include?(key.to_sym) || keys.map(&:to_value).include?(key.to_s)
         elsif :hash == type && method_name.to_s.end_with?('_value')
           key = method_name.to_s[0..-7]
-          return key?(key.to_sym) || key?(key.to_s)
+          return keys.map(&:to_value).include?(key.to_sym) || keys.map(&:to_value).include?(key.to_s)
         elsif :hash == type && method_name.to_s.end_with?('_source')
           key = method_name.to_s[0..-8]
-          return key?(key.to_sym) || key?(key.to_s)
+          return keys.map(&:to_value).include?(key.to_sym) || keys.map(&:to_value).include?(key.to_s)
         end
 
         super
@@ -497,32 +449,6 @@ module ParserNodeExt
 end
 
 # Extend Parser::AST::Node.
-# {https://github.com/whitequark/parser/blob/master/lib/parser/ast/node.rb}
-#
-# Rules
-#
-# Synvert compares ast nodes with key / value pairs, each ast node has
-# multiple attributes, e.g. +receiver+, +message+ and +arguments+, it
-# matches only when all of key / value pairs match.
-#
-# +type: 'send', message: :include, arguments: ['FactoryGirl::Syntax::Methods']+
-#
-# Synvert does comparison based on the value type
-#
-# 1. if value is a symbol, then compares ast node value as symbol, e.g. +message: :include+
-# 2. if value is a string, then compares ast node original source code, e.g. +name: 'Synvert::Application'+
-# 3. if value is a regexp, then compares ast node original source code, e.g. +message: /find_all_by_/+
-# 4. if value is an array, then compares each ast node, e.g. +arguments: ['FactoryGirl::Syntax::Methods']+
-# 5. if value is nil, then check if ast node is nil, e.g. +arguments: [nil]+
-# 6. if value is true or false, then check if ast node is :true or :false, e.g. +arguments: [false]+
-# 7. if value is ast, then compare ast node directly, e.g. +to_ast: Parser::CurrentRuby.parse("self.class.serialized_attributes")+
-#
-# It can also compare nested key / value pairs, like
-#
-# +type: 'send', receiver: { type: 'send', receiver: { type: 'send', message: 'config' }, message: 'active_record' }, message: 'identity_map='+
-#
-# Source Code to Ast Node
-# {https://playground.synvert.net/ruby}
 class Parser::AST::Node
   include ParserNodeExt
 end

data/parser_node_ext.gemspec

@@ -10,12 +10,12 @@ Gem::Specification.new do |spec|
 
   spec.summary = "extend parser node"
   spec.description = "extend parser node, add parent and sibling, use meaning properties to get child node"
-  spec.homepage = "https://github.com/xinminlabs/parser_node_ext"
+  spec.homepage = "https://github.com/synvert-hq/parser_node_ext"
   spec.required_ruby_version = ">= 2.6.0"
 
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/xinminlabs/parser_node_ext"
-  spec.metadata["changelog_uri"] = "https://github.com/xinminlabs/parser_node_ext/blob/main/CHANGELOG.md"
+  spec.metadata["source_code_uri"] = "https://github.com/synvert-hq/parser_node_ext"
+  spec.metadata["changelog_uri"] = "https://github.com/synvert-hq/parser_node_ext/blob/main/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parser_node_ext
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.1
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-10 00:00:00.000000000 Z
+date: 2024-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -39,14 +39,15 @@ files:
 - README.md
 - Rakefile
 - lib/parser_node_ext.rb
+- lib/parser_node_ext/parent_node_ext.rb
 - lib/parser_node_ext/version.rb
 - parser_node_ext.gemspec
-homepage: https://github.com/xinminlabs/parser_node_ext
+homepage: https://github.com/synvert-hq/parser_node_ext
 licenses: []
 metadata:
-  homepage_uri: https://github.com/xinminlabs/parser_node_ext
-  source_code_uri: https://github.com/xinminlabs/parser_node_ext
-  changelog_uri: https://github.com/xinminlabs/parser_node_ext/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/synvert-hq/parser_node_ext
+  source_code_uri: https://github.com/synvert-hq/parser_node_ext
+  changelog_uri: https://github.com/synvert-hq/parser_node_ext/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: