docscribe 1.2.1 → 1.3.0

data/lib/docscribe/plugin.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative 'plugin/tag'
+require_relative 'plugin/context'
+require_relative 'plugin/base/tag_plugin'
+require_relative 'plugin/base/collector_plugin'
+require_relative 'plugin/registry'
+
+module Docscribe
+  # Plugin system entry point.
+  #
+  # Provides two extension points:
+  #
+  # 1. TagPlugin — hooks into already-collected method insertions and appends
+  #    additional YARD tags. Subclass Base::TagPlugin and override #call.
+  #
+  # 2. CollectorPlugin — receives the raw AST and walks it independently.
+  #    Used for non-standard structures that Docscribe's Collector does not
+  #    recognize. Subclass Base::CollectorPlugin and override #collect.
+  module Plugin
+    # Run all registered TagPlugins for one method context.
+    #
+    # Errors in individual plugins are caught so one broken plugin does not
+    # abort the entire run.
+    #
+    # @param [Docscribe::Plugin::Context] context
+    # @raise [StandardError]
+    # @return [Array<Docscribe::Plugin::Tag>]
+    def self.run_tag_plugins(context)
+      Registry.tag_plugins.flat_map do |plugin|
+        plugin.call(context)
+      rescue StandardError => e
+        warn "Docscribe: TagPlugin #{plugin.class} raised #{e.class}: #{e.message}" if debug?
+        []
+      end
+    end
+
+    # Run all registered CollectorPlugins for one file's AST.
+    #
+    # @param [Parser::AST::Node] ast
+    # @param [Parser::Source::Buffer] buffer
+    # @raise [StandardError]
+    # @return [Array<Hash>]
+    def self.run_collector_plugins(ast, buffer)
+      Registry.collector_plugins.flat_map do |plugin|
+        plugin.collect(ast, buffer)
+      rescue StandardError => e
+        warn "Docscribe: CollectorPlugin #{plugin.class} raised #{e.class}: #{e.message}" if debug?
+        []
+      end
+    end
+
+    # @return [Boolean]
+    def self.debug?
+      ENV['DOCSCRIBE_DEBUG'] == '1'
+    end
+  end
+end

data/lib/docscribe/types/rbs/collection_loader.rb

@@ -0,0 +1,50 @@
+# lib/docscribe/types/rbs/collection_loader.rb
+# frozen_string_literal: true
+
+require 'pathname'
+require 'yaml'
+
+module Docscribe
+  module Types
+    module RBS
+      # Resolve the RBS collection directory from rbs_collection.lock.yaml.
+      #
+      # After `bundle exec rbs collection install`, RBS writes a lock-file that
+      # records where gem signatures were installed. This loader reads that file
+      # so Docscribe can discover the collection directory automatically without
+      # requiring the user to pass --sig-dir manually.
+      #
+      # @example Typical lock-file structure
+      #   ---
+      #   sources: [...]
+      #   path: ".gem_rbs_collection"
+      #   gems: [...]
+      module CollectionLoader
+        LOCK_FILE = 'rbs_collection.lock.yaml'
+        DEFAULT_COLLECTION_PATH = '.gem_rbs_collection'
+
+        module_function
+
+        # Resolve the installed RBS collection directory.
+        #
+        # Returns nil when:
+        # - lock-file is absent (collection not initialized)
+        # - resolved directory does not exist on disk (collection not installed)
+        #
+        # @note module_function: when included, also defines #resolve (instance visibility: private)
+        # @param [String] root project root to search from
+        # @return [String, nil] absolute path to the collection directory, or nil
+        def resolve(root: Dir.pwd)
+          lock = Pathname(root).join(LOCK_FILE)
+          return nil unless lock.file?
+
+          data = YAML.safe_load(lock.read, permitted_classes: [Symbol]) || {}
+          rel  = data['path'] || DEFAULT_COLLECTION_PATH
+
+          resolved = Pathname(root).join(rel)
+          resolved.directory? ? resolved.expand_path.to_s : nil
+        end
+      end
+    end
+  end
+end

data/lib/docscribe/types/rbs/provider.rb

@@ -3,6 +3,7 @@
 require 'pathname'
 require 'docscribe/types/signature'
 require 'docscribe/types/rbs/type_formatter'
+require 'docscribe/types/rbs/collection_loader'
 
 module Docscribe
   module Types
@@ -69,6 +70,8 @@ module Docscribe
           return if @env && @builder
 
           loader = ::RBS::EnvironmentLoader.new
+          # Load core types transitively
+          loader.add(library: 'rbs')
 
           @sig_dirs.each do |dir|
             path = Pathname(dir)

data/lib/docscribe/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docscribe
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - unurgunite
@@ -135,8 +135,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.38
-email:
-- senpaiguru1488@gmail.com
 executables:
 - docscribe
 extensions: []
@@ -148,6 +146,7 @@ files:
 - lib/docscribe.rb
 - lib/docscribe/cli.rb
 - lib/docscribe/cli/config_builder.rb
+- lib/docscribe/cli/generate.rb
 - lib/docscribe/cli/init.rb
 - lib/docscribe/cli/options.rb
 - lib/docscribe/cli/run.rb
@@ -156,6 +155,7 @@ files:
 - lib/docscribe/config/emit.rb
 - lib/docscribe/config/filtering.rb
 - lib/docscribe/config/loader.rb
+- lib/docscribe/config/plugin.rb
 - lib/docscribe/config/rbs.rb
 - lib/docscribe/config/sorbet.rb
 - lib/docscribe/config/sorting.rb
@@ -176,7 +176,14 @@ files:
 - lib/docscribe/inline_rewriter/source_helpers.rb
 - lib/docscribe/inline_rewriter/tag_sorter.rb
 - lib/docscribe/parsing.rb
+- lib/docscribe/plugin.rb
+- lib/docscribe/plugin/base/collector_plugin.rb
+- lib/docscribe/plugin/base/tag_plugin.rb
+- lib/docscribe/plugin/context.rb
+- lib/docscribe/plugin/registry.rb
+- lib/docscribe/plugin/tag.rb
 - lib/docscribe/types/provider_chain.rb
+- lib/docscribe/types/rbs/collection_loader.rb
 - lib/docscribe/types/rbs/provider.rb
 - lib/docscribe/types/rbs/type_formatter.rb
 - lib/docscribe/types/signature.rb
@@ -206,7 +213,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.9
+rubygems_version: 4.0.10
 specification_version: 4
-summary: Autogenerate documentation for Ruby code with YARD syntax.
+summary: Auto-generate inline YARD documentation for Ruby by analyzing code AST. Supports
+  RBS and Sorbet type signatures.
 test_files: []