docscribe 1.0.0 → 1.2.0

data/lib/docscribe/types/sorbet/base_provider.rb

@@ -0,0 +1,217 @@
+# frozen_string_literal: true
+
+require 'docscribe/types/signature'
+require 'docscribe/types/rbs/type_formatter'
+
+module Docscribe
+  module Types
+    module Sorbet
+      # Shared base for Sorbet-backed signature providers.
+      #
+      # This class parses Sorbet-style signatures through the RBS RBI prototype
+      # API and indexes them into Docscribe's normalized signature model.
+      #
+      # Concrete subclasses decide where the Sorbet source comes from:
+      # - SourceProvider => inline `sig` declarations in the current Ruby file
+      # - RBIProvider    => project RBI files
+      class BaseProvider
+        # @param [Boolean] collapse_generics whether generic container details
+        #   should be simplified during formatting
+        # @return [Object]
+        def initialize(collapse_generics: false)
+          require 'rbs'
+          @collapse_generics = !!collapse_generics
+          @index = {}
+          @warned = false
+        end
+
+        # Look up a normalized method signature by container, scope, and name.
+        #
+        # @param [String] container e.g. "MyModule::MyClass"
+        # @param [Symbol] scope :instance or :class
+        # @param [Symbol, String] name method name
+        # @return [Docscribe::Types::MethodSignature, nil]
+        def signature_for(container:, scope:, name:)
+          @index[[normalize_container(container), scope.to_sym, name.to_sym]]
+        end
+
+        private
+
+        # Parse Sorbet-flavored Ruby/RBI source and index any signatures found.
+        #
+        # Parsing failures are treated as non-fatal so Docscribe can fall back to
+        # other providers or plain inference.
+        #
+        # @private
+        # @param [String] source source text to parse
+        # @param [String] label file label used in debug warnings
+        # @raise [LoadError]
+        # @raise [::RBS::BaseError]
+        # @raise [SyntaxError]
+        # @raise [StandardError]
+        # @return [void]
+        def load_from_string(source, label:)
+          return unless defined?(RubyVM::AbstractSyntaxTree)
+
+          parser = ::RBS::Prototype::RBI.new
+          parser.parse(source)
+          index_decls(parser.decls)
+        rescue LoadError
+          nil
+        rescue ::RBS::BaseError, SyntaxError, StandardError => e
+          warn_once("Docscribe: Sorbet signature load failed for #{label}: #{e.class}: #{e.message}")
+          nil
+        end
+
+        # Index parsed declarations into the provider lookup table.
+        #
+        # @private
+        # @param [Array<Object>] decls parsed RBS declarations
+        # @return [void]
+        def index_decls(decls)
+          Array(decls).each do |decl|
+            next unless decl.respond_to?(:name)
+            next unless decl.respond_to?(:members)
+
+            container = normalize_container(decl.name.to_s)
+
+            decl.members.each do |member|
+              next unless method_definition_member?(member)
+
+              scope = member.kind == :singleton ? :class : :instance
+              overload = member.overloads&.first
+              next unless overload
+
+              func = overload.method_type.type
+              @index[[container, scope, member.name.to_s.to_sym]] = build_signature(func)
+            end
+          end
+        end
+
+        # @private
+        # @param [Object] member
+        # @return [Boolean]
+        def method_definition_member?(member)
+          defined?(::RBS::AST::Members::MethodDefinition) &&
+            member.is_a?(::RBS::AST::Members::MethodDefinition)
+        end
+
+        # Convert an RBS function type into Docscribe's simplified signature model.
+        #
+        # @private
+        # @param [::RBS::Types::Function] func
+        # @return [Docscribe::Types::MethodSignature]
+        def build_signature(func)
+          MethodSignature.new(
+            return_type: format_type(func.return_type),
+            param_types: build_param_types(func),
+            rest_positional: build_rest_positional(func),
+            rest_keywords: build_rest_keywords(func)
+          )
+        end
+
+        # Build a name => type map for ordinary positional/keyword parameters.
+        #
+        # @private
+        # @param [::RBS::Types::Function] func
+        # @return [Hash{String => String}]
+        def build_param_types(func)
+          param_types = {}
+
+          add_positionals!(param_types, func.required_positionals)
+          add_positionals!(param_types, func.optional_positionals)
+          add_positionals!(param_types, func.trailing_positionals)
+
+          func.required_keywords.each { |kw, p| param_types[kw.to_s] = format_type(p.type) }
+          func.optional_keywords.each { |kw, p| param_types[kw.to_s] = format_type(p.type) }
+
+          param_types
+        end
+
+        # Add positional parameters with names to the normalized param map.
+        #
+        # @private
+        # @param [Hash{String => String}] param_types
+        # @param [Array<Object>] list
+        # @return [void]
+        def add_positionals!(param_types, list)
+          list.each do |p|
+            next unless p.name
+
+            param_types[p.name.to_s] = format_type(p.type)
+          end
+        end
+
+        # Build normalized `*args` metadata.
+        #
+        # @private
+        # @param [::RBS::Types::Function] func
+        # @return [Docscribe::Types::RestPositional, nil]
+        def build_rest_positional(func)
+          rp = func.rest_positionals
+          return nil unless rp
+
+          RestPositional.new(
+            name: rp.name&.to_s,
+            element_type: format_type(rp.type)
+          )
+        end
+
+        # Build normalized `**kwargs` metadata.
+        #
+        # Sorbet keyword-rest signatures describe the value type. For generated
+        # YARD output, we expose that as a Hash keyed by Symbol.
+        #
+        # @private
+        # @param [::RBS::Types::Function] func
+        # @return [Docscribe::Types::RestKeywords, nil]
+        def build_rest_keywords(func)
+          rk = func.rest_keywords
+          return nil unless rk
+
+          value_type = format_type(rk.type)
+
+          RestKeywords.new(
+            name: rk.name&.to_s,
+            type: "Hash<Symbol, #{value_type}>"
+          )
+        end
+
+        # Format an RBS type object into the YARD-ish type syntax used by
+        # generated comments.
+        #
+        # @private
+        # @param [Object] type
+        # @return [String]
+        def format_type(type)
+          Docscribe::Types::RBS::TypeFormatter.to_yard(
+            type,
+            collapse_generics: @collapse_generics
+          )
+        end
+
+        # Normalize container names so lookups are consistent.
+        #
+        # @private
+        # @param [String] name
+        # @return [String]
+        def normalize_container(name)
+          name.to_s.delete_prefix('::')
+        end
+
+        # Print one debug warning per provider instance when debugging is enabled.
+        #
+        # @private
+        # @param [String] msg
+        # @return [void]
+        def warn_once(msg)
+          return unless ENV['DOCSCRIBE_RBS_DEBUG'] == '1'
+          return if @warned
+
+          @warned = true
+          warn msg
+        end
+      end
+    end
+  end
+end

data/lib/docscribe/types/sorbet/rbi_provider.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require 'docscribe/types/sorbet/base_provider'
+
+module Docscribe
+  module Types
+    module Sorbet
+      # Sorbet provider that loads signatures from RBI directories.
+      #
+      # Each configured directory is scanned recursively for `.rbi` files, and
+      # any signatures that can be parsed are indexed into Docscribe's normalized
+      # signature model.
+      class RBIProvider < BaseProvider
+        # @param [Array<String>] rbi_dirs directories scanned recursively for
+        #   `.rbi` files
+        # @param [Boolean] collapse_generics whether generic container types
+        #   should be simplified during formatting
+        # @return [Object]
+        def initialize(rbi_dirs:, collapse_generics: false)
+          super(collapse_generics: collapse_generics)
+
+          Array(rbi_dirs).each do |dir|
+            path = Pathname(dir)
+            next unless path.directory?
+
+            path.glob('**/*.rbi').sort.each do |file|
+              load_from_string(file.read, label: file.to_s)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/docscribe/types/sorbet/source_provider.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'docscribe/types/sorbet/base_provider'
+
+module Docscribe
+  module Types
+    module Sorbet
+      # Sorbet provider for inline signatures present in the current Ruby source.
+      #
+      # This provider parses the source being rewritten and indexes any leading
+      # `sig` declarations it can resolve through the RBS RBI prototype bridge.
+      class SourceProvider < BaseProvider
+        # @param [String] source Ruby source containing inline `sig` declarations
+        # @param [String] file source label used in diagnostics/debug warnings
+        # @param [Boolean] collapse_generics whether generic container types
+        #   should be simplified during formatting
+        # @return [Object]
+        def initialize(source:, file:, collapse_generics: false)
+          super(collapse_generics: collapse_generics)
+          load_from_string(source, label: file)
+        end
+      end
+    end
+  end
+end

data/lib/docscribe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Docscribe
-  VERSION = '1.0.0'
+  VERSION = '1.2.0'
 end

data/lib/docscribe.rb

@@ -4,6 +4,7 @@ module Docscribe
   class Error < StandardError; end
 end
 
+require 'docscribe/parsing'
 require_relative 'docscribe/version'
 require_relative 'docscribe/config'
 require_relative 'docscribe/infer'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docscribe
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - unurgunite
@@ -15,14 +15,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: prism
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -65,6 +79,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-sorted_methods_by_call
   requirement: !ruby/object:Gem::Requirement
@@ -85,14 +127,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.34
+        version: 0.9.38
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.34
+        version: 0.9.38
 email:
 - senpaiguru1488@gmail.com
 executables:
@@ -100,25 +142,51 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
-- CODE_OF_CONDUCT.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
-- Rakefile
 - exe/docscribe
 - lib/docscribe.rb
+- lib/docscribe/cli.rb
+- lib/docscribe/cli/config_builder.rb
+- lib/docscribe/cli/init.rb
+- lib/docscribe/cli/options.rb
+- lib/docscribe/cli/run.rb
 - lib/docscribe/config.rb
+- lib/docscribe/config/defaults.rb
+- lib/docscribe/config/emit.rb
+- lib/docscribe/config/filtering.rb
+- lib/docscribe/config/loader.rb
+- lib/docscribe/config/rbs.rb
+- lib/docscribe/config/sorbet.rb
+- lib/docscribe/config/sorting.rb
+- lib/docscribe/config/template.rb
+- lib/docscribe/config/utils.rb
 - lib/docscribe/infer.rb
+- lib/docscribe/infer/ast_walk.rb
+- lib/docscribe/infer/constants.rb
+- lib/docscribe/infer/literals.rb
+- lib/docscribe/infer/names.rb
+- lib/docscribe/infer/params.rb
+- lib/docscribe/infer/raises.rb
+- lib/docscribe/infer/returns.rb
 - lib/docscribe/inline_rewriter.rb
+- lib/docscribe/inline_rewriter/collector.rb
+- lib/docscribe/inline_rewriter/doc_block.rb
+- lib/docscribe/inline_rewriter/doc_builder.rb
+- lib/docscribe/inline_rewriter/source_helpers.rb
+- lib/docscribe/inline_rewriter/tag_sorter.rb
+- lib/docscribe/parsing.rb
+- lib/docscribe/types/provider_chain.rb
+- lib/docscribe/types/rbs/provider.rb
+- lib/docscribe/types/rbs/type_formatter.rb
+- lib/docscribe/types/signature.rb
+- lib/docscribe/types/sorbet/base_provider.rb
+- lib/docscribe/types/sorbet/rbi_provider.rb
+- lib/docscribe/types/sorbet/source_provider.rb
 - lib/docscribe/version.rb
-- rakelib/docs.rake
-- stingray_docs_internal.gemspec
 homepage: https://github.com/unurgunite/docscribe
-licenses: []
+licenses:
+- MIT
 metadata:
   homepage_uri: https://github.com/unurgunite/docscribe
   source_code_uri: https://github.com/unurgunite/docscribe
@@ -131,14 +199,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.9
 specification_version: 4
 summary: Autogenerate documentation for Ruby code with YARD syntax.
 test_files: []

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,11 +0,0 @@
-inherit_from: .rubocop_todo.yml
-
-plugins:
-  - rubocop-sorted_methods_by_call
-
-AllCops:
-  NewCops: enable
-  TargetRubyVersion: 3.0
-
-Layout/LineLength:
-  Max: 120

data/.rubocop_todo.yml

@@ -1,73 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2025-11-12 20:29:05 UTC using RuboCop version 1.81.7.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 5
-# Configuration parameters: EnforcedStyle, AllowedGems.
-# SupportedStyles: Gemfile, gems.rb, gemspec
-Gemspec/DevelopmentDependencies:
-  Exclude:
-    - 'stingray_docs_internal.gemspec'
-
-# Offense count: 10
-# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
-Metrics/AbcSize:
-  Max: 62
-
-# Offense count: 7
-# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
-# AllowedMethods: refine
-Metrics/BlockLength:
-  Max: 49
-
-# Offense count: 3
-# Configuration parameters: CountComments, CountAsOne.
-Metrics/ClassLength:
-  Max: 187
-
-# Offense count: 11
-# Configuration parameters: AllowedMethods, AllowedPatterns.
-Metrics/CyclomaticComplexity:
-  Max: 23
-
-# Offense count: 13
-# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
-Metrics/MethodLength:
-  Max: 47
-
-# Offense count: 2
-# Configuration parameters: CountComments, CountAsOne.
-Metrics/ModuleLength:
-  Max: 189
-
-# Offense count: 10
-# Configuration parameters: AllowedMethods, AllowedPatterns.
-Metrics/PerceivedComplexity:
-  Max: 22
-
-# Offense count: 3
-# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
-# AllowedNames: as, at, by, cc, db, id, if, in, io, ip, of, on, os, pp, to
-Naming/MethodParameterName:
-  Exclude:
-    - 'lib/docscribe/infer.rb'
-
-# Offense count: 4
-# Configuration parameters: AllowedConstants.
-Style/Documentation:
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-    - 'lib/docscribe/config.rb'
-    - 'lib/docscribe/infer.rb'
-    - 'lib/docscribe/inline_rewriter.rb'
-
-# Offense count: 2
-# Configuration parameters: Max.
-Style/SafeNavigationChainLength:
-  Exclude:
-    - 'lib/docscribe/inline_rewriter.rb'

data/CODE_OF_CONDUCT.md

@@ -1,84 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at senpaiguru1488@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in docscribe.gemspec
-gemspec