custom_elements_manifest_parser 0.2.7 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3375b5793a6c86dd8198d5e076f0f662f316dc4eeac2561df8e8c928d7d3622f
-  data.tar.gz: 308443a2654e52b9a14da6f82fe73439fc9c23537dd0d93d5d928b2a1db11b38
+  metadata.gz: a001a44dccd2121534449c7bf8b1f3aaa8f21f2254ff384f66ae4fbd23e5274d
+  data.tar.gz: b5a909ac1b9dfa1839ca381f76e43f56eb633e7bcc417317044c836825ef5f88
 SHA512:
-  metadata.gz: 61de78888fbe811281bc0157b626ff6d92e2802902f88e99614a7e26bbe3139ebdd06f1b770807de06d25a5ffab96f2b38978369088e6038699e37dceeea35ce
-  data.tar.gz: 19d9edef8decd36d8511dcfbf31c7403553dd0f59c9023ecadaa51d954f69af6bb0e6c33bef5a8d229e2047d2ffbff14530e826e0faed6a87492db2b6fee0a02
+  metadata.gz: 440c1f987a729a4af2cd776ce324fc2067b397635bded843ed43286d54df62007f5fc8737365d104a116c469ab4cad03dde92b4b2ef15351398ba41f2697034c
+  data.tar.gz: bb6277a2c4e7539410b3a741710d40d3a66800d6853520b11dcf3d9359bed048bf311c9ac5421094ccf1081bc015f58632300122b6819436e5d75ae82f6b3f8c

data/.yardopts

@@ -0,0 +1 @@
+-m markdown

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Unreleased
 
+## [0.2.9] - 11/01/2023
+
+- Fixed a bug where `parent_module` was not serializing `exports` or `children`
+
 ## [0.2.3] - 10/08/2023
 
 - Fixed a bug where `ClassLikeStruct` was not getting properly serialized.

data/Gemfile

@@ -8,3 +8,7 @@ gemspec
 gem "rake", "~> 13.0"
 gem "yard"
 gem "minitest", "~> 5.0"
+
+gem "yard-junk", "~> 0.0.9"
+
+gem "solargraph", "~> 0.49.0", :group => :development

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    custom_elements_manifest_parser (0.2.7)
+    custom_elements_manifest_parser (0.2.9)
       dry-struct (~> 1.0)
       dry-types (~> 1.0)
       dry-validation (~> 1.0)
@@ -9,7 +9,12 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.2)
+    backport (1.2.0)
+    backports (3.24.1)
+    benchmark (0.2.1)
     concurrent-ruby (1.2.2)
+    diff-lcs (1.5.0)
     dry-configurable (1.1.0)
       dry-core (~> 1.0, < 2)
       zeitwerk (~> 2.6)
@@ -47,10 +52,68 @@ GEM
       dry-initializer (~> 3.0)
       dry-schema (>= 1.12, < 2)
       zeitwerk (~> 2.6)
+    e2mmap (0.1.0)
     ice_nine (0.11.2)
+    jaro_winkler (1.5.6)
+    json (2.6.3)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    language_server-protocol (3.17.0.3)
     minitest (5.20.0)
+    nokogiri (1.15.4-arm64-darwin)
+      racc (~> 1.4)
+    parallel (1.23.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
+    rainbow (3.1.1)
     rake (13.0.6)
+    rbs (2.8.4)
+    regexp_parser (2.8.2)
+    reverse_markdown (2.1.1)
+      nokogiri
+    rexml (3.2.6)
+    rubocop (1.57.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    solargraph (0.49.0)
+      backport (~> 1.2)
+      benchmark
+      bundler (~> 2.0)
+      diff-lcs (~> 1.4)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      parser (~> 3.0)
+      rbs (~> 2.0)
+      reverse_markdown (~> 2.0)
+      rubocop (~> 1.38)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    thor (1.3.0)
+    tilt (2.3.0)
+    unicode-display_width (2.5.0)
     yard (0.9.34)
+    yard-junk (0.0.9)
+      backports (>= 3.18)
+      rainbow
+      yard
     zeitwerk (2.6.12)
 
 PLATFORMS
@@ -60,7 +123,9 @@ DEPENDENCIES
   custom_elements_manifest_parser!
   minitest (~> 5.0)
   rake (~> 13.0)
+  solargraph (~> 0.49.0)
   yard
+  yard-junk (~> 0.0.9)
 
 BUNDLED WITH
    2.2.33

data/README.md

@@ -240,7 +240,7 @@ 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/[USERNAME]/custom_elements_manifest_parser. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/custom_elements_manifest_parser/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/custom_elements_manifest_parser. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/konnorrogers/custom_elements_manifest_parser/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -248,4 +248,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the CustomElementsManifestParser project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/custom_elements_manifest_parser/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the CustomElementsManifestParser project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/konnorrogers/custom_elements_manifest_parser/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -21,3 +21,7 @@ YARD::Rake::YardocTask.new do |t|
 end
 
 task default: :test
+
+require 'yard-junk/rake'
+# rake yard:junk
+YardJunk::Rake.define_task

data/lib/custom_elements_manifest_parser/mixins/has_parent_module.rb

@@ -0,0 +1,12 @@
+module CustomElementsManifestParser
+  module Mixins
+    # Any "DeclarableNodeStruct", has a "_parent_module"
+    module HasParentModule
+      def parent_module
+        return parser.visit_node(_parent_module) if parser
+
+        nil
+      end
+    end
+  end
+end

data/lib/custom_elements_manifest_parser/nodes/class_declaration.rb

@@ -11,6 +11,7 @@ module CustomElementsManifestParser
       # @return ["class"]
       def self.kind; 'class'; end
 
+      include Mixins::HasParentModule
 
       # @!parse include Structs::DeclarableNodeStruct
       attributes_from Structs::DeclarableNodeStruct

data/lib/custom_elements_manifest_parser/nodes/class_field.rb

@@ -27,6 +27,8 @@ module CustomElementsManifestParser
       #    @return [SourceReference, nil]
       attribute :source, Types::Nominal::Any.optional.meta(required: false)
 
+      include Mixins::HasParentModule
+
       # @!parse include Structs::DeclarableNodeStruct
       attributes_from Structs::DeclarableNodeStruct
 

data/lib/custom_elements_manifest_parser/nodes/class_method.rb

@@ -8,6 +8,7 @@ module CustomElementsManifestParser
   module Nodes
     # Documents a method attached to a class
     class ClassMethod < BaseStruct
+      include Mixins::HasParentModule
 
       # @!parse Structs::FunctionLikeStruct
       attributes_from Structs::FunctionLikeStruct

data/lib/custom_elements_manifest_parser/nodes/custom_element_export.rb

@@ -20,6 +20,8 @@ module CustomElementsManifestParser
       #    @return ["custom-element-definition"]
       attribute :kind, Types.Value("custom-element-definition")
 
+      include Mixins::HasParentModule
+
       # @!parse Structs::DeclarableNodeStruct
       attributes_from Structs::DeclarableNodeStruct
 

data/lib/custom_elements_manifest_parser/nodes/function_declaration.rb

@@ -7,6 +7,8 @@ module CustomElementsManifestParser
   module Nodes
     # Documents a function
     class FunctionDeclaration < BaseStruct
+      include Mixins::HasParentModule
+
       # @!parse include Structs::DeclarableNodeStruct
       attributes_from Structs::DeclarableNodeStruct
 

data/lib/custom_elements_manifest_parser/nodes/javascript_export.rb

@@ -7,6 +7,8 @@ module CustomElementsManifestParser
   module Nodes
     # A JavaScript export!
     class JavaScriptExport < BaseStruct
+      include Mixins::HasParentModule
+
       # @!parse include Structs::DeclarableNodeStruct
       attributes_from Structs::DeclarableNodeStruct
 

data/lib/custom_elements_manifest_parser/nodes/javascript_module.rb

@@ -48,8 +48,8 @@ module CustomElementsManifestParser
 
       def visit(parser:)
         hash = {}
-        hash[:declarations] = declarations.map { |declaration| parser.visit_node(declaration.merge(parent_module: self)) } unless declarations.nil?
-        hash[:exports] = exports.map { |export| parser.visit_node(export.merge(parent_module: self)) } unless exports.nil?
+        hash[:declarations] = declarations.map { |declaration| parser.visit_node(declaration.merge(_parent_module: self, parser: parser)) } unless declarations.nil?
+        hash[:exports] = exports.map { |export| parser.visit_node(export.merge(_parent_module: self, parser: parser)) } unless exports.nil?
 
         new(hash)
       end

data/lib/custom_elements_manifest_parser/nodes/mixin_declaration.rb

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

data/lib/custom_elements_manifest_parser/nodes/variable_declaration.rb

@@ -8,6 +8,8 @@ module CustomElementsManifestParser
   module Nodes
     # Documents a variable
     class VariableDeclaration < BaseStruct
+      include Mixins::HasParentModule
+
       # @!parse include Structs::DeclarableNodeStruct
       attributes_from Structs::DeclarableNodeStruct
 

data/lib/custom_elements_manifest_parser/parser.rb

@@ -82,7 +82,7 @@ module CustomElementsManifestParser
     # end
 
     def visit_node(node)
-      kind = node["kind"] || node[:kind]
+      kind = node[:kind] || node["kind"]
       @visitable_nodes[kind].new(node).visit(parser: self)
     end
 

data/lib/custom_elements_manifest_parser/structs/declarable_node_struct.rb

@@ -9,7 +9,9 @@ module CustomElementsManifestParser
       #   @return [JavaScriptModule, nil] -
       #     A convenience helper so you don't need to manually traverse the manifest and always go top -> bottom.
       #     By using this you can grab the "path" and "exports" of a custom element.
-      attribute :parent_module, Types::Nominal::Any.optional.meta(required: false)
+      attribute :_parent_module, Types::Nominal::Any.optional.meta(required: false)
+
+      attribute :parser, Types::Nominal::Any.optional.meta(required: false)
 
       def self.build_hash(parser:, struct:)
         {}

data/lib/custom_elements_manifest_parser/version.rb

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

data/lib/custom_elements_manifest_parser.rb

@@ -4,11 +4,8 @@
 # @!parse
 Dir["#{__dir__}/custom_elements_manifest_parser/**/*.rb"].each { |file| require file }
 
-
-#
 # Top level parser
 module CustomElementsManifestParser
-  autoload :Parser, "custom_elements_manifest_parser/parser"
   # Shortuct for `CustomElementsManifestParser::Parser.new().parse()`
   # @return [CustomElementsManifestParser::Parser]
   def self.parse(hash)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: custom_elements_manifest_parser
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.9
 platform: ruby
 authors:
 - konnorrogers
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-30 00:00:00.000000000 Z
+date: 2023-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -59,6 +59,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -84,6 +85,7 @@ files:
 - lib/custom_elements_manifest_parser/data_types/source_reference.rb
 - lib/custom_elements_manifest_parser/data_types/type.rb
 - lib/custom_elements_manifest_parser/data_types/type_reference.rb
+- lib/custom_elements_manifest_parser/mixins/has_parent_module.rb
 - lib/custom_elements_manifest_parser/nodes/class_declaration.rb
 - lib/custom_elements_manifest_parser/nodes/class_field.rb
 - lib/custom_elements_manifest_parser/nodes/class_method.rb