syntax_tree_ext 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76f93356ad00c2206f575f6aa8117de178eb2710a6534f8df11c10871f68a9b8
-  data.tar.gz: a846f03d2f62bf8928764a6423df58ded2b1f524cf677c886f069f9e835cc7e9
+  metadata.gz: c33e697b9e1cdb6dd491d93f8dc78482ac0a358e1ecb2127a9f377d940df901c
+  data.tar.gz: 07f73e482d4740e1bfa13cd9d293accebe5e0fcb52374335c5f1d756bf5c6591
 SHA512:
-  metadata.gz: 7e677f857fe5e663a92d2e2905535647ce0c4c6927da6a151a1ab88fd7c3265d465efba409cd4147c7c20486e7aedde93cb7bfa715c00f19d499708bfb5ae17e
-  data.tar.gz: f9b15130df4786bb1b9548ea3d21eb234508270c38599b80cf01600fa7cd8de8c6150283c6e1e13bb69975b5aea6ad0535410fc952d8013963921ec4926efd7b
+  metadata.gz: 5e6dd31f3504dcca0ac4d70d0282ee7ab4d56523c31f2394ef16f5908abb17cccc2933e5d18207833f615d43d56eeebf9e3576e931a9ee63d442d2fdf45a9340
+  data.tar.gz: 0bff0422c3e75dd21dec2de6d0d991ec71c18d5a974cc1a72ccc2ba854fd49e4a8ab42994fc7c6290e90f5867ad62c96a566f5a7deddaa84497d88849a73cf69

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # CHANGELOG
 
+## 0.8.0 (2024-04-07)
+
+* Abstract `syntax_tree_ext/parent_node_ext`
+* Abstract `syntax_tree_ext/source_ext`
+* Inject hash helper methods only to `HashLiteral` and `BareAssocHash`
+
+## 0.7.2 (2024-02-17)
+
+* Use `Hash#filter` instead of `Hash#reject`
+
 ## 0.7.1 (2024-02-11)
 
 * Reuse `respond_to_assocs`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    syntax_tree_ext (0.7.1)
+    syntax_tree_ext (0.8.0)
       syntax_tree
 
 GEM

data/README.md

@@ -1,15 +1,9 @@
 # SyntaxTreeExt
 
-It adds `parent_node` and `source` methods to the `ParserTree::Node`.
+[![Build Status](https://github.com/synvert-hq/syntax_tree_ext/actions/workflows/main.yml/badge.svg)](https://github.com/synvert-hq/syntax_tree_ext/actions/workflows/main.yml)
+[![Gem Version](https://img.shields.io/gem/v/syntax_tree_ext.svg)](https://rubygems.org/gems/syntax_tree_ext)
 
-It also adds some helpers
-
-```ruby
-# node is a HashLiteral node
-node.foo_assoc # get the assoc 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
-```
+It adds some helpers syntax_tree node.
 
 ## Installation
 
@@ -26,6 +20,17 @@ If bundler is not being used to manage dependencies, install the gem by executin
 ```ruby
 require 'syntax_tree'
 require 'syntax_tree_ext'
+
+# node is a HashLiteral or BareAssocHash node
+node.foo_assoc # get the assoc 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
 ```
 
 ## Development
@@ -36,4 +41,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/xinminlabs/syntax_tree_ext.
+Bug reports and pull requests are welcome on GitHub at https://github.com/synvert-hq/syntax_tree_ext.

data/lib/syntax_tree_ext/parent_node_ext.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module SyntaxTree
+  class << self
+    alias_method :original_parse, :parse
+
+    def parse(source)
+      node = original_parse(source)
+      node.set_parent_node(source)
+      node
+    end
+  end
+
+  class Node
+    attr_accessor :parent_node
+
+    def set_parent_node_and_source(source)
+      self.deconstruct_keys([]).filter { |key, _value| ![:location, :comments].include?(key) }.values.each do |child_node|
+        if child_node.is_a?(Array)
+          child_node.each do |child_child_node|
+            next unless child_child_node.is_a?(Node)
+
+            child_child_node.parent_node = self
+            child_child_node.set_parent_node(source)
+          end
+        end
+
+        next unless child_node.is_a?(Node)
+
+        child_node.parent_node = self
+        child_node.set_parent_node(source)
+      end
+    end
+  end
+end

data/lib/syntax_tree_ext/source_ext.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module SyntaxTree
+  class << self
+    alias_method :original_parse, :parse
+
+    def parse(source)
+      node = original_parse(source)
+      node.set_source(source)
+      node
+    end
+  end
+
+  class Node
+    attr_accessor :source
+
+    def set_source(source)
+      self.source = source
+      self.deconstruct_keys([]).filter { |key, _value| ![:location, :comments].include?(key) }.values.each do |child_node|
+        if child_node.is_a?(Array)
+          child_node.each do |child_child_node|
+            next unless child_child_node.is_a?(Node)
+
+            child_child_node.set_source(source)
+          end
+        end
+
+        next unless child_node.is_a?(Node)
+
+        child_node.set_source(source)
+      end
+    end
+  end
+end

data/lib/syntax_tree_ext/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SyntaxTreeExt
-  VERSION = "0.7.1"
+  VERSION = "0.8.0"
 end

data/lib/syntax_tree_ext.rb

@@ -3,14 +3,7 @@
 require_relative "syntax_tree_ext/version"
 
 require 'syntax_tree'
-
-if RUBY_VERSION.to_i < 3
-  class Hash
-    def except(*keys)
-      self.reject { |k, _| keys.include?(k) }
-    end
-  end
-end
+require_relative "syntax_tree_ext/source_ext"
 
 module SyntaxTreeExt
   class Error < StandardError; end
@@ -18,101 +11,25 @@ module SyntaxTreeExt
 end
 
 module SyntaxTree
-  class << self
-    alias_method :original_parse, :parse
-
-    def parse(source)
-      node = original_parse(source)
-      node.set_parent_node_and_source(source)
-      node
-    end
-  end
-
-  class Node
-    attr_accessor :parent_node, :source
-
-    def set_parent_node_and_source(source)
-      self.source = source
-      self.deconstruct_keys([]).except(:location, :comments).values.each do |child_node|
-        if child_node.is_a?(Array)
-          child_node.each do |child_child_node|
-            next unless child_child_node.is_a?(Node)
-
-            child_child_node.parent_node = self
-            child_child_node.set_parent_node_and_source(source)
-          end
-        end
-
-        next unless child_node.is_a?(Node)
-
-        child_node.parent_node = self
-        child_node.set_parent_node_and_source(source)
-      end
-    end
-
+  module HashNodeExt
     def keys
-      if respond_to_assocs?
-        assocs.map(&:key)
-      else
-        raise MethodNotSupported, "keys is not supported for #{self}"
-      end
+      assocs.map(&:key)
     end
 
     def values
-      if respond_to_assocs?
-        assocs.map(&:value)
-      else
-        raise MethodNotSupported, "values is not supported for #{self}"
-      end
+      assocs.map(&:value)
     end
 
     def hash_assoc(key)
-      if respond_to_assocs?
-        assocs.find { |assoc_node| assoc_node.key.to_value == key }
-      else
-        raise MethodNotSupported, "hash_assoc is not supported for #{self}"
-      end
+      assocs.find { |assoc_node| assoc_node.key.to_value == key }
     end
 
     def hash_value(key)
-      if respond_to_assocs?
-        assocs.find { |assoc_node| assoc_node.key.to_value == key }&.value
-      else
-        raise MethodNotSupported, "hash_value is not supported for #{self}"
-      end
-    end
-
-    def to_value
-      case self
-      when SymbolLiteral
-        value.value.to_sym
-      when StringLiteral
-        parts.map(&:to_value).join
-      when FloatLiteral
-        value.to_f
-      when Int
-        value.to_i
-      when Kw
-        value == 'true'
-      when VarRef
-        value.to_value
-      when Const, Label, TStringContent, Ident
-        value
-      when ArrayLiteral
-        contents ? contents.parts.map { |part| part.to_value } : []
-      else
-        self
-      end
-    end
-
-    def to_source
-      source[location.start_char...location.end_char]
+      assocs.find { |assoc_node| assoc_node.key.to_value == key }&.value
     end
 
     # Respond key value and source for hash node
     def method_missing(method_name, *args, &block)
-      return super unless respond_to_assocs?
-
       if method_name.to_s.end_with?('_assoc')
         key = method_name.to_s[0..-7]
         return assocs.find { |assoc| assoc_key_equal?(assoc, key) }
@@ -128,8 +45,6 @@ module SyntaxTree
     end
 
     def respond_to_missing?(method_name, *args)
-      return super unless respond_to_assocs?
-
       if method_name.to_s.end_with?('_assoc')
         key = method_name[0..-7]
         return !!assocs.find { |assoc| assoc_key_equal?(assoc, key) }
@@ -146,13 +61,46 @@ module SyntaxTree
 
     private
 
-    def respond_to_assocs?
-      is_a?(HashLiteral) || is_a?(BareAssocHash)
-    end
-
     def assoc_key_equal?(assoc, key)
       assoc_key = assoc.key.to_value.to_s
       assoc_key.end_with?(':') ? assoc_key == "#{key}:" : assoc_key == key
     end
   end
+
+  class HashLiteral
+    include HashNodeExt
+  end
+
+  class BareAssocHash
+    include HashNodeExt
+  end
+
+  class Node
+    def to_value
+      case self
+      when SymbolLiteral
+        value.value.to_sym
+      when StringLiteral
+        parts.map(&:to_value).join
+      when FloatLiteral
+        value.to_f
+      when Int
+        value.to_i
+      when Kw
+        value == 'true'
+      when VarRef
+        value.to_value
+      when Const, Label, TStringContent, Ident
+        value
+      when ArrayLiteral
+        contents ? contents.parts.map { |part| part.to_value } : []
+      else
+        self
+      end
+    end
+
+    def to_source
+      source[location.start_char...location.end_char]
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: syntax_tree_ext
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-11 00:00:00.000000000 Z
+date: 2024-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: syntax_tree
@@ -38,14 +38,16 @@ files:
 - README.md
 - Rakefile
 - lib/syntax_tree_ext.rb
+- lib/syntax_tree_ext/parent_node_ext.rb
+- lib/syntax_tree_ext/source_ext.rb
 - lib/syntax_tree_ext/version.rb
 - sig/syntax_tree_ext.rbs
-homepage: https://github.com/xinminlabs/syntax_tree_ext
+homepage: https://github.com/synvert-hq/syntax_tree_ext
 licenses: []
 metadata:
-  homepage_uri: https://github.com/xinminlabs/syntax_tree_ext
-  source_code_uri: https://github.com/xinminlabs/syntax_tree_ext
-  changelog_uri: https://github.com/xinminlabs/syntax_tree_ext/blob/main/CHANGELOG
+  homepage_uri: https://github.com/synvert-hq/syntax_tree_ext
+  source_code_uri: https://github.com/synvert-hq/syntax_tree_ext
+  changelog_uri: https://github.com/synvert-hq/syntax_tree_ext/blob/main/CHANGELOG
 post_install_message:
 rdoc_options: []
 require_paths: