docrb-parser 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfa4a19237733b6e0ace1d9af8584eeeb1dc671ec3a08c000d2b5f99adfcfa90
-  data.tar.gz: 02e8182ff82e529c89c99655411a7980a56c89a511263923616468c1bbbc0f65
+  metadata.gz: ad89c50b2d48ce08a1c2c2584fd09f765b43555f8d8daf67b1eb727524f81855
+  data.tar.gz: 4b297fde78ae009658f319812c8f3d605d7bfbaf7f9e9f7621867a2e856323ff
 SHA512:
-  metadata.gz: '048771cd5044806674962f019c76fa4fedbd5f2778ff461b3b7fd4eef77076bf93b4562283b5667318d0f68d99d7c816dd77b6a803c26fe8859f6f8358075ea7'
-  data.tar.gz: ba979ca0cb853ec2a3ef2542957f887f0b5b9e92355e380e1006bfd6883e06506b65ed49c3ed867116f7f11bfc9e32470b595a140e2917d669f5b407667e579c
+  metadata.gz: 39c21d2bc0feb1796b612cdf59e0d1c5f8bc545ce9294765a02153c03f8883f9493bfabe0f570e30b60fc548d40a27f5a41d1fd3c49eff0dc8cc66dc2b4d8433
+  data.tar.gz: 646866daab9663552dd05e253f4cc90cf0081e19cd0c3899dabc83ed6b681f3abe66389820b2703468b2fc77dece7f59c7e14c49329101a0ce258e3e758f782f

data/docrb-parser.gemspec

@@ -5,7 +5,7 @@ require_relative "lib/docrb/parser/version"
 Gem::Specification.new do |spec|
   spec.name = "docrb-parser"
   spec.version = Docrb::Parser::VERSION
-  spec.authors = ["Victor Gama"]
+  spec.authors = ["Vito Sartori"]
   spec.email = ["hey@vito.io"]
 
   spec.summary = "Docrb's Ruby Parser"
@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 3.2"
 
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "#{spec.homepage}/tree/trunk/lib/docrb-parser"
+  spec.metadata["source_code_uri"] = "#{spec.homepage}/tree/master/lib/docrb-parser"
   spec.metadata["changelog_uri"] = spec.homepage
   spec.metadata["rubygems_mfa_required"] = "true"
 
@@ -34,5 +34,5 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "prism", "~> 0.13"
+  spec.add_dependency "prism", "~> 1"
 end

data/lib/docrb/parser/class.rb

@@ -64,7 +64,10 @@ module Docrb
         return false if parent.nil? || !parent.fulfilled?
         return true if parent.resolved.id == obj.parent.id
 
-        is_inherited?(obj, parent.dereference!.inherits)
+        deref = parent.dereference!
+        return is_inherited?(obj, deref.inherits) if deref.is_a? Class
+
+        false
       end
 
       def source_of(obj)

data/lib/docrb/parser/comment_parser.rb

@@ -10,6 +10,11 @@ module Docrb
       SPACE = " "
       DASH = "-"
       COLON = ":"
+      IGNORED_ANNOTATIONS = [
+        ":nodoc:",
+        ":nocov:",
+        /^rubocop:\s?(enable|disable)/
+      ].freeze
 
       attr_accessor :objects, :current_object, :cursor, :visibility
 
@@ -17,8 +22,8 @@ module Docrb
         new(data)
           .tap(&:parse)
           .then do |parser|
-          { meta: { visibility: parser.visibility }.compact, value: parser.objects }
-        end
+            { meta: { visibility: parser.visibility }.compact, value: parser.objects }
+          end
       end
 
       def initialize(data)
@@ -28,6 +33,7 @@ module Docrb
           .split(NEWLINE)
           .map(&:rstrip)
           .map { _1.gsub(/^\s*#\s?/, "") }
+          .reject { reject_annotation? _1 }
           .join(NEWLINE)
           .each_grapheme_cluster
           .to_a
@@ -37,6 +43,16 @@ module Docrb
         @cursor = 0
       end
 
+      def reject_annotation?(value)
+        IGNORED_ANNOTATIONS.any? do |match|
+          case match
+          when Regexp then match.match? value
+          when String then value == match
+          else false
+          end
+        end
+      end
+
       def at_end? = (cursor >= @data_len)
 
       def will_end? = (cursor + 1 >= @data_len)
@@ -173,13 +189,13 @@ module Docrb
       end
 
       # rubocop:disable Layout/LineLength
-      COMMENT_METHOD_REF_REGEXP = /(?:([A-Z][a-zA-Z0-9_]*::)*([A-Z][a-zA-Z0-9_]*))?(::|\.|#)([A-Za-z_][a-zA-Z0-9_@]*[!?]?)(?:\([a-zA-Z0-9=_,\s*]+\))?/
+      COMMENT_METHOD_REF_REGEXP = /(?:((?:::)?(?:[a-z][a-z0-9_]*::)*)([a-z][a-z0-9_]*))?(::|\.|#)([a-z_][a-z0-9_@]*[!?]?)(?:\([a-z0-9:=_,\s*]+\))?/i
       # rubocop:enable Layout/LineLength
 
       def extract_method_reference(text)
         match = COMMENT_METHOD_REF_REGEXP.match(text) or return nil
         value, class_path, target, invocation, name = match.to_a
-        class_path&.gsub!(/::$/, "")
+        class_path&.gsub!(/(^::|::$)/, "")
 
         {
           start_idx: match.begin(0),

data/lib/docrb/parser/computations.rb

@@ -39,11 +39,16 @@ module Docrb
         last_found_node = resolve[:last_found_node] || parser
         if resolve[:missing_segments].empty?
           remove_from_parent!(node, parent: node.parent)
-          node.parent = resolve[:last_found_node]
-          if node.is_a? Class
-            last_found_node.classes << node
-          elsif node.is_a? Module
-            last_found_node.modules << node
+          if last_found_node.is_a? Parser
+            node.parent = nil
+            last_found_node.nodes.append(node)
+          else
+            node.parent = resolve[:last_found_node]
+            if node.is_a? Class
+              last_found_node.classes << node
+            elsif node.is_a? Module
+              last_found_node.modules << node
+            end
           end
 
           return
@@ -93,59 +98,74 @@ module Docrb
           obj[:value].transform_values! { resolve_documentation_reference(node, _1) }
           obj
         when :method_ref
-          resolve_documentation_pure_reference(node, obj)
+          resolve_method_reference(node, obj)
         when :span, :symbol
           obj
+        when :identifier
+          if obj[:value].to_sym == node.try(:name)&.to_sym
+            obj[:type] = :neutral_identifier
+          else
+            container = if node.is_a? Container
+              node
+            else
+              find_next_container(node)
+            end
+            resolved = resolve_path(container, [obj[:value].to_sym])
+            if resolved.respond_to?(:id)
+              obj[:type] = :reference
+              obj[:id] = resolved.id
+              obj[:path] = path_of(resolved)
+            else
+              obj[:type] = :unresolved_identifier
+            end
+          end
+          obj
+        when :class_path_ref
+          resolve_class_path_reference(node, obj)
         else
           puts "Unhandled documentation node #{obj[:type]}"
           obj
         end
+      end
+
+      def resolve_class_path_reference(node, ref)
+        path = (ref[:class_path].gsub(/(^::|::$)/, "").split("::") + [ref[:target]]).flatten.compact.map(&:to_sym)
+        node = find_next_container(node) unless node.is_a? Container
+        resolved = resolve_path_partial(path, node)
+
+        unless resolved[:missing_segments].empty?
+          ref[:type] = :unresolved_identifier
+          return ref
+        end
+
+        prefix = /^(::)/.match(ref[:value])&.to_a&.last
+        segments = resolved[:segment_list]
+        target = resolved[:last_found_node].all_objects.named(ref[:name].to_sym).first
+
+        if target.nil?
+          ref[:type] = :unresolved_identifier
+          return ref
+        end
 
-        # obj[:value].each do |v|
-        #   case v[:type]
-        #   when :identifier
-        #     if v[:value].to_sym == node.try(:name)&.to_sym
-        #       v[:type] = :neutral_identifier
-        #     else
-        #       resolved = resolve_path(node, [v[:value].to_sym])
-        #       if resolved.respond_to?(:id)
-        #         v[:type] = :reference
-        #         v[:id] = resolved.id
-        #         v[:path] = path_of(resolved)
-        #       else
-        #         v[:type] = :unresolved_identifier
-        #       end
-        #     end
-        #   when :reference
-        #     resolve_documentation_pure_reference(v, node)
-        #   when :block
-        #     v[:value]
-        #       .reject { [:span, :symbol].include? _1[:type] }
-        #       .each { resolve_documentation_reference(node, _1) }
-        #   when :fields
-        #     val = v[:value].values.flatten
-        #     resolve_documentation_reference(node, { value: val })
-        #   else
-        #     puts "Unhandled documentation node #{v[:type]}"
-        #   end
-        # end
+        {
+          type: :class_path_reference,
+          prefix:,
+          segments:,
+          target:
+        }
       end
 
-      def resolve_documentation_pure_reference(node, ref)
+      def resolve_method_reference(node, ref)
         return ref if ref.key? :object
 
         node = find_next_container(node) unless node.is_a? Container
         name = ref[:name].to_sym
         obj = if ref[:class_path]
-          resolve_path(ref[:class_path].split("::").map(&:to_sym), node)
+          resolve_path(node, ref[:class_path].split("::").map(&:to_sym))
         else
           node
         end
-        result = if ref[:type] == :method
-          obj.all_instance_methods.named(name).first || obj.all_class_methods.named(name).first
-        else
-          obj.all_objects.named(name).first
-        end
+        result = resolve_path(obj, [ref[:target], name].compact.map(&:to_sym))
 
         if result.nil?
           ref[:type] = :unresolved_identifier
@@ -347,6 +367,7 @@ module Docrb
         c_filter = -> { container_only ? _1.is_a?(Container) : true }
 
         found_segments = []
+        segment_list = []
         until path.empty?
           last_parent = parent
           if parent.is_a? Parser
@@ -357,6 +378,7 @@ module Docrb
             end
 
             found_segments << path.shift
+            segment_list << parent
             next
           end
 
@@ -365,14 +387,15 @@ module Docrb
             parent = last_parent
             break
           end
-
           found_segments << path.shift
+          segment_list << parent
         end
 
         {
           last_found_node: parent,
           found_segments:,
-          missing_segments: path
+          missing_segments: path,
+          segment_list:
         }
       end
 
@@ -455,8 +478,7 @@ module Docrb
           container&.all_class_methods&.named(name)&.first ||
           container&.all_class_attributes&.named(name)&.first ||
           (find_object(container.parent, name, container_only:) if container&.parent) ||
-          parser.nodes.lazy.filter { _1.is_a?(Container) && _1.name == name }.first ||
-          parser.nodes.lazy.filter { _1.is_a? Container }.first { find_object(_1, name) }
+          parser.nodes.lazy.filter { _1.is_a?(Container) && _1.name == name }.first
       end
 
       def find_next_container(obj)

data/lib/docrb/parser/container.rb

@@ -108,9 +108,9 @@ module Docrb
         case
         when parent == id
           :self
-        when @includes.filter(&:fulfilled?).any? { _1.resolved.id == id }
+        when @includes.filter(&:fulfilled?).any? { _1.resolved.id == parent }
           :included
-        when @extends.filter(&:fulfilled?).any? { _1.resolved.id == id }
+        when @extends.filter(&:fulfilled?).any? { _1.resolved.id == parent }
           :extended
         else
           :unknown

data/lib/docrb/parser/method_parameters.rb

@@ -13,7 +13,8 @@ module Docrb
           when Prism::RequiredParameterNode then :arg
           when Prism::OptionalParameterNode then :optarg
           when Prism::RestParameterNode then :rest
-          when Prism::KeywordParameterNode then n.value ? :optkw : :kw
+          when Prism::OptionalKeywordParameterNode then n.value ? :optkw : :kw
+          when Prism::RequiredKeywordParameterNode then :kw
           when Prism::KeywordRestParameterNode then :kwrest
           when Prism::BlockParameterNode then :block
           else raise NotImplementedError, "Unsupported parameter kind #{n.class}"
@@ -75,6 +76,7 @@ module Docrb
           when Prism::StringNode then :string
           when Prism::IntegerNode, Prism::FloatNode then :number
           when Prism::ConstantReadNode, Prism::ConstantPathNode then :const
+          when Prism::HashNode then :hash
           else
             puts "Unhandled parameter value type #{value.class.name}"
           end

data/lib/docrb/parser/version.rb

@@ -2,6 +2,6 @@
 
 module Docrb
   class Parser
-    VERSION = "0.1.0"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docrb-parser
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
-- Victor Gama
+- Vito Sartori
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-28 00:00:00.000000000 Z
+date: 2024-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prism
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '1'
 description: "docrb-parser is responsible for parsing Ruby sources into a structured
   \nformat for usage by docrb and docrb-html.\n"
 email:
@@ -84,7 +84,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/heyvito/docrb
-  source_code_uri: https://github.com/heyvito/docrb/tree/trunk/lib/docrb-parser
+  source_code_uri: https://github.com/heyvito/docrb/tree/master/lib/docrb-parser
   changelog_uri: https://github.com/heyvito/docrb
   rubygems_mfa_required: 'true'
 post_install_message:
@@ -102,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.18
 signing_key:
 specification_version: 4
 summary: Docrb's Ruby Parser