orthoses-yard 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d57da650c9fa9921fe11457ff26920168316e9eb43ff101cc9aedd6472c998e5
-  data.tar.gz: 96fab97f4f9ea79e773a5f0bd4eaf8fa5be3aac236be6819b74c89c9acf8a80f
+  metadata.gz: b2f6b90fd20646f14534289bd4b876eb0faf8cb4a2d422d442bcbcefd07b2069
+  data.tar.gz: e7283f8f85defc5ac290310d35a8a248c47fd87ef09f54c2dd65e352373bc881
 SHA512:
-  metadata.gz: ed202e833e51fe62faf2b2c2d2554d5f14af1399dfca052f4fa38a06cda920232bcd66a46b1e2cd3b7683322527fddd6b3dbcc0504b4a99a0d996675253a33f9
-  data.tar.gz: 4af5a24ec753a2d92371deed81de517bc558b7c30a215986f9b1b138def44d65ffaa105c6853dc757f2d2a3fd9442434d19a95c50fa227688fd186840b84442a
+  metadata.gz: 1796d238fbfa72d260fce28cf167ca6b0d595bc6b65faa0295e5416bd17aeec384303f8395b5aa5e3c9f8c9587ffb48cbb0a7654301ceb004be457a349a5d34b
+  data.tar.gz: 27a5c5c9dcfdd9d51834aa57c875c1e3600ed1a3841a930b199286624e843054a98653ff9f6e8af397fb46792136735283df49f5ed4aed4411feb14cad3b5f38

data/Gemfile.lock

@@ -1,62 +1,74 @@
 PATH
   remote: .
   specs:
-    orthoses-yard (0.1.0)
-      orthoses
+    orthoses-yard (0.3.0)
+      orthoses (>= 1.3.0, < 2.0)
       yard
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.4)
+    activesupport (7.0.4.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     ast (2.4.2)
-    concurrent-ruby (1.1.10)
-    debug (1.6.2)
-      irb (>= 1.3.6)
+    concurrent-ruby (1.2.2)
+    csv (3.2.6)
+    debug (1.7.1)
+      irb (>= 1.5.0)
       reline (>= 0.3.1)
     ffi (1.15.5)
+    fileutils (1.7.0)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    io-console (0.5.11)
-    irb (1.4.1)
+    io-console (0.6.0)
+    irb (1.6.3)
       reline (>= 0.3.0)
-    language_server-protocol (3.17.0.1)
-    listen (3.7.1)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    listen (3.8.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    minitest (5.16.3)
-    orthoses (1.1.0)
-      rbs (~> 2.0)
+    logger (1.5.3)
+    minitest (5.18.0)
+    orthoses (1.6.0)
+      rbs (~> 3.0)
     parallel (1.22.1)
-    parser (3.1.2.1)
+    parser (3.2.1.1)
       ast (~> 2.4.1)
     rainbow (3.1.1)
     rake (13.0.6)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rbs (2.6.0)
-    reline (0.3.1)
+    rbs (3.0.4)
+    reline (0.3.2)
       io-console (~> 0.5)
-    rgot (1.1.0)
-    steep (1.1.1)
+    rgot (1.3.0)
+    securerandom (0.2.2)
+    steep (1.3.0)
       activesupport (>= 5.1)
+      csv (>= 3.0.9)
+      fileutils (>= 1.1.0)
+      json (>= 2.1.0)
       language_server-protocol (>= 3.15, < 4.0)
       listen (~> 3.0)
+      logger (>= 1.3.0)
       parallel (>= 1.0.0)
       parser (>= 3.1)
       rainbow (>= 2.2.2, < 4.0)
-      rbs (>= 2.3.2)
+      rbs (>= 2.8.0)
+      securerandom (>= 0.1)
+      strscan (>= 1.0.0)
       terminal-table (>= 2, < 4)
+    strscan (3.0.6)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
-    tzinfo (2.0.5)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.3.0)
+    unicode-display_width (2.4.2)
     webrick (1.7.0)
     yard (0.9.28)
       webrick (~> 1.7.0)

data/lib/orthoses/yard/version.rb

@@ -2,6 +2,6 @@
 
 module Orthoses
   class YARD
-    VERSION = "0.1.0"
+    VERSION = "0.3.0"
   end
 end

data/lib/orthoses/yard/yard2rbs.rb

@@ -35,7 +35,7 @@ module Orthoses
       # @return [void]
       def run
         Orthoses.logger.info("YARD will generate about #{yardoc.inspect}")
-        block.call(yardoc.path, yardoc.docstring, nil)
+        block.call(yardoc.path, yardoc.docstring.all, nil)
         yardoc.children.each do |child|
           case child.type
           when :module, :class
@@ -45,6 +45,7 @@ module Orthoses
         generate_for_attributes
         generate_for_methods
         generate_for_constants
+        generate_for_classvariable
       end
 
       # @return [void]
@@ -55,15 +56,15 @@ module Orthoses
             if class_attributes[:read] && class_attributes[:write]
               visibility = class_attributes[:read].visibility == :private ? 'private ' : ''
               type = tag_types_to_rbs_type(class_attributes[:read].tags('return').flat_map(&:types))
-              block.call(yardoc.path, class_attributes[:read].docstring, "#{visibility}attr_accessor #{prefix}#{name}: #{type}")
+              block.call(yardoc.path, class_attributes[:read].docstring.all, "#{visibility}attr_accessor #{prefix}#{name}: #{type}")
             elsif class_attributes[:read]
               visibility = class_attributes[:read].visibility == :private ? 'private ' : ''
               type = tag_types_to_rbs_type(class_attributes[:read].tags('return').flat_map(&:types))
-              block.call(yardoc.path, class_attributes[:read].docstring, "#{visibility}attr_reader #{prefix}#{name}: #{type}")
+              block.call(yardoc.path, class_attributes[:read].docstring.all, "#{visibility}attr_reader #{prefix}#{name}: #{type}")
             elsif class_attributes[:write]
               visibility = class_attributes[:write].visibility == :private ? 'private ' : ''
               type = tag_types_to_rbs_type(class_attributes[:write].tags('return').flat_map(&:types))
-              block.call(yardoc.path, class_attributes[:write].docstring, "#{visibility}attr_writer #{prefix}#{name}: #{type}")
+              block.call(yardoc.path, class_attributes[:write].docstring.all, "#{visibility}attr_writer #{prefix}#{name}: #{type}")
             else
               raise "bug"
             end
@@ -73,6 +74,8 @@ module Orthoses
 
       # @return [void]
       def generate_for_methods
+        return if yardoc.to_s.empty?
+
         yardoc.meths(inherited: false).each do |meth|
           # skip attribute methods because of generate_for_attributes
           next if meth.attr_info
@@ -82,7 +85,6 @@ module Orthoses
 
           namespace = meth.namespace
           method_name = meth.name
-          next if namespace.to_s.empty?
 
           begin
             mod = Object.const_get(namespace.to_s)
@@ -101,6 +103,12 @@ module Orthoses
             next
           end
 
+          if meth.is_alias?
+            orig_key = yardoc.aliases[meth]
+            block.call(yardoc.to_s, "", "alias #{prefix}#{meth.name} #{prefix}#{orig_key}")
+            next
+          end
+
           required_positionals = []
           optional_positionals = []
           rest_positionals = nil
@@ -108,8 +116,6 @@ module Orthoses
           required_keywords = {}
           optional_keywords = {}
           rest_keywords = nil
-          yield_params = []
-          yield_return = nil
 
           requireds = required_positionals
 
@@ -194,7 +200,7 @@ module Orthoses
           )
 
           visibility = meth.visibility == :private ? 'private ' : ''
-          block.call(yardoc.to_s, meth.docstring, "#{visibility}def #{prefix}#{method_name}: #{method_type}")
+          block.call(yardoc.to_s, meth.docstring.all, "#{visibility}def #{prefix}#{method_name}: #{method_type}")
         end
       end
 
@@ -203,7 +209,16 @@ module Orthoses
         yardoc.constants(inherited: false).each do |const|
           return_tags = const.tags('return')
           return_type = return_tags.empty? ? untyped : tag_types_to_rbs_type(return_tags.flat_map(&:types))
-          block.call(const.namespace.to_s, const.docstring, "#{const.name}: #{return_type}")
+          block.call(const.namespace.to_s, const.docstring.all, "#{const.name}: #{return_type}")
+        end
+      end
+
+      # @return [void]
+      def generate_for_classvariable
+        yardoc.cvars.each do |cvar|
+          return_tags = cvar.tags('return')
+          return_type = return_tags.empty? ? untyped : tag_types_to_rbs_type(return_tags.flat_map(&:types))
+          block.call(cvar.namespace.to_s, cvar.docstring.all, "#{cvar.name}: #{return_type}")
         end
       end
 
@@ -215,6 +230,7 @@ module Orthoses
         begin
           types_explainers = ::YARD::Tags::TypesExplainer::Parser.parse(tag_types.uniq.join(", "))
         rescue SyntaxError
+          Orthoses.logger.warn("#{tag_types} in #{yardoc.inspect} cannot parse as tags. use untyped instead")
           return untyped
         end
 

data/lib/orthoses/yard.rb

@@ -4,28 +4,28 @@ require_relative "yard/version"
 require_relative "yard/yard2rbs"
 
 module Orthoses
-  # use Orthoses::YARD, globs: "lib/**/*.rb"
+  # use Orthoses::YARD, parse: "lib/**/*.rb"
   class YARD
-    def initialize(loader, globs:)
+    def initialize(loader, parse:)
       @loader = loader
-      @globs = Array(globs)
+      @parse = Array(parse)
     end
 
     def call
       @loader.call.tap do |store|
         require 'yard'
 
-        ::YARD.parse(@globs)
+        ::YARD.parse(@parse)
         ::YARD::Registry.root.children.each do |yardoc|
           case yardoc.type
           when :class, :module
             YARD2RBS.run(yardoc: yardoc) do |namespace, docstring, rbs|
+              comment = docstring.each_line.map { |line| "# #{line}" }.join
               if rbs.nil?
-                store[namespace]
+                store[namespace].comment = comment
               else
                 Orthoses.logger.debug("#{namespace} << #{rbs}")
-                all = docstring.all.then { |it| it.empty? ? "" : "#{it.gsub(/^/, '# ')}\n" }
-                store[namespace] << "#{all}#{rbs}"
+                store[namespace] << "#{comment}\n#{rbs}"
               end
             end
           end

data/orthoses-yard.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject do |f|
       next true if (f == __FILE__)
-      next true if f.match?(%r{\A(?:bin|known_sig)/}) # dir
+      next true if f.match?(%r{\A(?:bin|known_sig|examples)/}) # dir
       next true if f.match?(%r{\A\.(?:git)}) # git
       next true if f.match?(%r{\A(?:rbs_collection|Steepfile|Rakefile)}) # top file
       next true if f.match?(%r{_test\.rb\z}) # test
@@ -32,6 +32,6 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "orthoses"
+  spec.add_dependency "orthoses", ">= 1.3.0", "< 2.0"
   spec.add_dependency "yard"
 end

data/sig/orthoses/yard.rbs

@@ -1,6 +1,6 @@
 # GENERATED FILE
 
 class Orthoses::YARD
-  def initialize: (untyped loader, globs: untyped) -> void
+  def initialize: (untyped loader, parse: untyped) -> void
   VERSION: untyped
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orthoses-yard
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - ksss
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-01 00:00:00.000000000 Z
+date: 2023-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: orthoses
@@ -16,14 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -50,12 +56,6 @@ files:
 - Gemfile.lock
 - LICENSE.txt
 - README.md
-- examples/yard/Gemfile
-- examples/yard/Gemfile.lock
-- examples/yard/Rakefile
-- examples/yard/generate.rb
-- examples/yard/rbs_collection.lock.yaml
-- examples/yard/rbs_collection.yaml
 - lib/orthoses-yard.rb
 - lib/orthoses/yard.rb
 - lib/orthoses/yard/version.rb
@@ -86,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.16
+rubygems_version: 3.4.8
 signing_key:
 specification_version: 4
 summary: Orthoses extention for YARD.

data/examples/yard/Gemfile

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-gem "yard", path: "src"
-gem "orthoses-yard", path: "../../"
-gem "rake"
-gem "rack"
-gem "sord"
-gem "debug"

data/examples/yard/Gemfile.lock

@@ -1,62 +0,0 @@
-PATH
-  remote: ../..
-  specs:
-    orthoses-yard (0.1.0)
-      orthoses
-      yard
-
-PATH
-  remote: src
-  specs:
-    yard (0.9.28)
-      webrick (~> 1.7.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.2)
-    commander (4.6.0)
-      highline (~> 2.0.0)
-    debug (1.6.2)
-      irb (>= 1.3.6)
-      reline (>= 0.3.1)
-    highline (2.0.3)
-    io-console (0.5.11)
-    irb (1.4.1)
-      reline (>= 0.3.0)
-    orthoses (1.1.0)
-      rbs (~> 2.0)
-    parlour (5.0.0)
-      commander (~> 4.5)
-      parser
-      rainbow (~> 3.0)
-      sorbet-runtime (>= 0.5)
-    parser (3.1.2.1)
-      ast (~> 2.4.1)
-    rack (3.0.0)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    rbs (2.6.0)
-    reline (0.3.1)
-      io-console (~> 0.5)
-    sorbet-runtime (0.5.10445)
-    sord (4.0.0)
-      commander (~> 4.5)
-      parlour (~> 5.0)
-      sorbet-runtime
-      yard
-    webrick (1.7.0)
-
-PLATFORMS
-  arm64-darwin-21
-
-DEPENDENCIES
-  debug
-  orthoses-yard!
-  rack
-  rake
-  sord
-  yard!
-
-BUNDLED WITH
-   2.4.0.dev

data/examples/yard/Rakefile

@@ -1,7 +0,0 @@
-file :src do
-  sh "git clone --depth 1 https://github.com/lsegal/yard.git src"
-end
-
-task :generate => [:src] do
-  load 'generate.rb'
-end

data/examples/yard/generate.rb

@@ -1,71 +0,0 @@
-require 'orthoses-yard'
-require 'fileutils'
-require 'pathname'
-
-FileUtils.rm_rf('out')
-Orthoses.logger.level = :warn
-Orthoses::Builder.new do
-  use Orthoses::CreateFileByName,
-    base_dir: 'out'
-  use Orthoses::Filter do |name, content|
-    name.start_with?('YARD') ||
-      name.start_with?('Ripper') ||
-      name.start_with?('OpenStruct') ||
-      name.start_with?('SymbolHash') ||
-      name.start_with?('Rake') ||
-      name.start_with?('WEBrick') ||
-      name.start_with?('RDoc')
-  end
-  use Orthoses::Tap do |store|
-    store['YARD'].header = 'module YARD'
-    store['YARD::CodeObjects'].header = 'module YARD::CodeObjects'
-    store['YARD::Handlers'].header = 'module YARD::Handlers'
-    store['YARD::Handlers::C'].header = 'module YARD::Handlers::C'
-    store['YARD::Handlers::Common'].header = 'module YARD::Handlers::Common'
-    store['YARD::Handlers::Ruby'].header = 'module YARD::Handlers::Ruby'
-    # TODO: support generics
-    store['YARD::Tags::Library'] << 'def self.labels: () -> SymbolHash'
-  end
-  use Orthoses::YARD,
-    globs: [
-      'src/lib/yard.rb',
-      'src/lib/yard/**/*.rb'
-    ]
-  use Orthoses::Autoload
-  run -> {
-    require 'yard'
-    YARD::Tags::Library.define_tag("YARD Tag Signature", 'yard.signature'.to_sym, nil)
-    YARD::Tags::Library.define_tag("YARD Tag", 'yard.tag'.to_sym, :with_types_and_name)
-    YARD::Tags::Library.define_tag("YARD Directive", 'yard.directive'.to_sym, :with_types_and_name)
-    # YARD::Tags::Library.visible_tags -= ['yard.tag'].map(&:to_sym)
-  }
-end.call
-
-Pathname("out").join("EXTERNAL_TODO.rbs").write(<<~RBS)
-  # !!! GENERATED CODE !!!
-  class OpenStruct
-  end
-
-  class Ripper
-  end
-
-  module Rake
-    class TaskLib
-    end
-  end
-
-
-  module WEBrick
-    module HTTPServlet
-      class AbstractServlet
-      end
-    end
-  end
-
-  module RDoc
-    module Markup
-      class ToHtml
-      end
-    end
-  end
-RBS

data/examples/yard/rbs_collection.lock.yaml

@@ -1,64 +0,0 @@
----
-sources:
-- name: ruby/gem_rbs_collection
-  remote: https://github.com/ruby/gem_rbs_collection.git
-  revision: main
-  repo_dir: gems
-path: ".gem_rbs_collection"
-gems:
-- name: rbs
-  version: 2.6.0
-  source:
-    type: rubygems
-- name: io-console
-  version: '0'
-  source:
-    type: stdlib
-- name: orthoses
-  version: 1.1.0
-  source:
-    type: rubygems
-- name: orthoses-yard
-  version: 0.1.0
-  source:
-    type: rubygems
-- name: rack
-  version: 2.2.2
-  source:
-    type: git
-    name: ruby/gem_rbs_collection
-    revision: d5d79cf5cc4df61ccb4a28f3e744ea7970cfabf9
-    remote: https://github.com/ruby/gem_rbs_collection.git
-    repo_dir: gems
-- name: logger
-  version: '0'
-  source:
-    type: stdlib
-- name: set
-  version: '0'
-  source:
-    type: stdlib
-- name: pathname
-  version: '0'
-  source:
-    type: stdlib
-- name: json
-  version: '0'
-  source:
-    type: stdlib
-- name: optparse
-  version: '0'
-  source:
-    type: stdlib
-- name: rubygems
-  version: '0'
-  source:
-    type: stdlib
-- name: tsort
-  version: '0'
-  source:
-    type: stdlib
-- name: monitor
-  version: '0'
-  source:
-    type: stdlib

data/examples/yard/rbs_collection.yaml

@@ -1,12 +0,0 @@
-# Download sources
-sources:
-  - name: ruby/gem_rbs_collection
-    remote: https://github.com/ruby/gem_rbs_collection.git
-    revision: main
-    repo_dir: gems
-
-# A directory to install the downloaded RBSs
-path: .gem_rbs_collection
-
-gems:
-  - name: rbs