custom_elements_manifest_parser 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 510fa863ae80956f1521f6b10c1b36d24e7d5397e14337de1ab424a46a60e00c
-  data.tar.gz: 17ff0b9d57ab3343919a32bd0f73a37c8839355817f27fdc9302d5c617f8c057
+  metadata.gz: 66c8bdbc69aa76da418725dd7a36f155378aa6af3e88a8d2743e519c2edea4f0
+  data.tar.gz: 966d6a3b1678f7d8ab2135db6248fbd0cfa86f72ee0f0ad5971f4f61f5a56788
 SHA512:
-  metadata.gz: f5636133ef9fde39a1c4ca70d87bf8879ed17495322a098d7ab465e21dbdf352fd75aece557e321a4bfb6705d1b0b816e89cc39e09c8afd9c306cabaab1d2881
-  data.tar.gz: 64ce1244a7226f6641b5007cc1fb58021110bc31a89d89d003f0056bc233e460dc8a145def0232937e1d1a294a4011b3a410af65f77fbcf3ce8f31a52b665c95
+  metadata.gz: 8ff7c6e45d310418da1a780b2ba26a88382c91f0e682dccdb8159fdc3ae5aa36af0d2629003bbd92fd622d401533956a4e637a06f83e50b97c4fbb9a430b9832
+  data.tar.gz: 3a5aafc4e04d5619e2f15bef227e1a7e7d741e03caaa1587d3aee0a6533b7608a9816bd475b2a8275ae93478a157d664d5e7f7383100b651a615718925797069

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+# [0.2.0] - 10/07/2023
+
+- Added a `Parser#find_by_tag_names(['tag-name'])` method to the parser that returns a Hash keyed off the tag name.
+- Removed `tag_names` as a parameters for `Parser#find_custom_elements`
+
 ## [0.1.0] - 2023-10-03
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    custom_elements_manifest_parser (0.1.0)
+    custom_elements_manifest_parser (0.2.0)
       dry-struct (~> 1.0)
       dry-types (~> 1.0)
       dry-validation (~> 1.0)

data/README.md

@@ -60,8 +60,11 @@ end
 ## Convenience Helpers
 
 # Searches for the tagName of the custom elements
-parser.find_custom_elements("light-pen", "light-preview").each { |declaration| declaration }
-parser.find_custom_elements(["light-pen", "light-preview"]).each { |declaration| declaration }
+hash = parser.find_by_tag_names("light-pen", "light-preview")
+hash = parser.find_by_tag_names(["light-pen", "light-preview"])
+
+hash["light-pen"] # => declaration
+hash["light-preview"] # => declaration
 
 # Searches for all custom elements regardless of tagName
 parser.find_custom_elements.each do |declaration|

data/lib/custom_elements_manifest_parser/nodes/mixin_declaration.rb

@@ -68,6 +68,7 @@ module CustomElementsManifestParser
         attribute attr.name, attr.type
       end
 
+      # @!parse Structs::FunctionLikeStruct
       attributes_from Structs::DeclarableNodeStruct
 
       # @!attribute kind

data/lib/custom_elements_manifest_parser/parser.rb

@@ -81,27 +81,42 @@ module CustomElementsManifestParser
     #   ]
     # end
 
-    # Hash{String, symbol => unknown}
     def visit_node(node)
       kind = node["kind"] || node[:kind]
       @visitable_nodes[kind].new(node).visit(parser: self)
     end
 
-    def find_custom_elements(tag_names = [])
+    # @return [Array<ClassDeclaration>] - Returns an array of {Nodes::ClassDeclaration}s that describe the customElement.
+    def find_custom_elements
       custom_elements = []
 
       manifest.modules.flatten.each do |mod|
         mod.declarations.flatten.each do |dec|
           next if dec.attributes[:customElement] != true
 
-          if tag_names.empty?
-            custom_elements << dec
-            next
-          end
+          custom_elements << dec
+        end
+      end
+
+      custom_elements
+    end
+
+    # @param {Array<String>} tag_names - An array of tag names to parse through
+    # @return [Hash{String => Nodes::ClassDeclaration}] - Returns a hash keyed off of found tagNames
+    def find_by_tag_names(*tag_names)
+      custom_elements = {}
+
+      tag_names = tag_names.flatten
+
+      manifest.modules.flatten.each do |mod|
+        mod.declarations.flatten.each do |dec|
+          # Needs to be != true because == false fails nil checks.
+          next if dec.attributes[:customElement] != true
+
+          tag_name = dec.attributes[:tagName]
+          next if tag_names.include?(tag_name) == false
 
-          if tag_names.include?(dec.attributes[:tagName])
-            custom_elements << dec
-          end
+          custom_elements[tag_name] = dec
         end
       end
 

data/lib/custom_elements_manifest_parser/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CustomElementsManifestParser
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: custom_elements_manifest_parser
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - konnorrogers