orthoses-yard 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2f6b90fd20646f14534289bd4b876eb0faf8cb4a2d422d442bcbcefd07b2069
-  data.tar.gz: e7283f8f85defc5ac290310d35a8a248c47fd87ef09f54c2dd65e352373bc881
+  metadata.gz: 36b54b543b79745b042a7ec072d923adaf37d46a51e61477637a6b14ec2051bc
+  data.tar.gz: 5f591556c56266c92d83e58f6af2f9a970734b5f5c6f2b21894d93a350bf1f55
 SHA512:
-  metadata.gz: 1796d238fbfa72d260fce28cf167ca6b0d595bc6b65faa0295e5416bd17aeec384303f8395b5aa5e3c9f8c9587ffb48cbb0a7654301ceb004be457a349a5d34b
-  data.tar.gz: 27a5c5c9dcfdd9d51834aa57c875c1e3600ed1a3841a930b199286624e843054a98653ff9f6e8af397fb46792136735283df49f5ed4aed4411feb14cad3b5f38
+  metadata.gz: 712dbf70f932c3d5fdea40b6844e5a78a363f51b33bf96dfec250fd0e20d3ca61c2b13ac1320c6edf1e503cbb45d601f9a3da2416731bb6a8efe64a7a5d69426
+  data.tar.gz: a03f7ca554c4548f99ef07eaed0213fd68ab6aa4a5cc3f0dcd5bd7ce2386a81d800efc5aa28a9af0091b30d9b5afdfbe8bf4dff309f23460a9aba0b178db53a9

data/README.md

@@ -50,7 +50,14 @@ end
 
 ## Usage
 
-Please see https://github.com/ksss/orthoses-yard/blob/main/examples/yard/Rakefile
+```rb
+use Orthoses::YARD,
+  parse: ['{lib,app}/**/*.rb'], # Target files (require)
+  use_cache: true,              # Use cache .yardoc database (optional default=true)
+  log_level: :debug             # Set log level for YARD (optional default=nil)
+```
+
+Please see also https://github.com/ksss/orthoses-yard/blob/main/examples/yard/generate.rb
 
 ## Development
 

data/lib/orthoses/yard/version.rb

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

data/lib/orthoses/yard/yard2rbs.rb

@@ -48,6 +48,32 @@ module Orthoses
         generate_for_classvariable
       end
 
+      # @return [RBS::Types::t]
+      def tag_types_to_rbs_type(tag_types)
+        return untyped if tag_types.nil?
+
+        tag_types = tag_types.compact.uniq
+        return untyped if tag_types.empty?
+
+        begin
+          types_explainers = ::YARD::Tags::TypesExplainer::Parser.parse(tag_types.join(", "))
+        rescue SyntaxError => e
+          Orthoses.logger.warn("#{tag_types} in #{yardoc.inspect} cannot parse as tags. use untyped instead")
+          Orthoses.logger.warn("    => exception message=`#{e.message}`")
+          return untyped
+        end
+
+        Utils::TypeList.new(recursive_resolve(types_explainers)).inject.tap do |rbs|
+          Orthoses.logger.debug("#{yardoc.inspect} tag #{tag_types} => #{rbs}")
+        end
+      end
+
+      private
+
+      def class_of(mod)
+        Kernel.instance_method(:class).bind_call(mod)
+      end
+
       # @return [void]
       def generate_for_attributes
         yardoc.attributes.each do |kind, attributes|
@@ -88,13 +114,13 @@ module Orthoses
 
           begin
             mod = Object.const_get(namespace.to_s)
-            case meth.scope
-            when :class
-              prefix = 'self.'
-              method_object = mod.method(method_name)
-            when :instance
+            case
+            when meth.scope == :instance || class_of(meth) == ::YARD::CodeObjects::ExtendedMethodObject
               prefix = ''
               method_object = mod.instance_method(method_name)
+            when meth.scope == :class
+              prefix = 'self.'
+              method_object = mod.method(method_name)
             else
               raise "bug"
             end
@@ -222,65 +248,6 @@ module Orthoses
         end
       end
 
-      # @return [RBS::Types::t]
-      def tag_types_to_rbs_type(tag_types)
-        return untyped if tag_types.nil?
-        return untyped if tag_types.empty?
-
-        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
-
-        wrap(recursive_resolve(types_explainers)).tap do |rbs|
-          Orthoses.logger.debug("#{yardoc.inspect} tag #{tag_types} => #{rbs}")
-        end
-      end
-
-      # @return [RBS::Types::t]
-      def wrap(types)
-        if types.nil? || types.empty? || types == [untyped]
-          return untyped
-        end
-
-        if 1 < types.length
-          if index = types.find_index { |t| t.to_s == "nil" }
-            types.delete_at(index)
-            is_optional = true
-            if types == [untyped]
-              return untyped
-            end
-          end
-        end
-        is_union = 1 < types.length
-
-        if is_union
-          if is_optional
-            ::RBS::Types::Optional.new(
-              type: ::RBS::Types::Union.new(
-                types: types,
-                location: nil,
-              ),
-              location: nil,
-            )
-          else
-            ::RBS::Types::Union.new(
-              types: types,
-              location: nil,
-            )
-          end
-        elsif is_optional
-          ::RBS::Types::Optional.new(
-            type: types.first,
-            location: nil,
-          )
-        else
-          types.first
-        end
-      end
-
       # @return [Array<RBS::Types::t>]
       def recursive_resolve(types_explainer_types)
         types_explainer_types.map do |types_explainer_type|
@@ -291,7 +258,7 @@ module Orthoses
               location: nil
             )
           when ::YARD::Tags::TypesExplainer::CollectionType
-            type = wrap(recursive_resolve(types_explainer_type.types))
+            type = Utils::TypeList.new(recursive_resolve(types_explainer_type.types)).inject
             if types_explainer_type.name == "Class"
               if type.to_s == "untyped"
                 untyped
@@ -302,18 +269,27 @@ module Orthoses
                 )
               end
             else
+              name = TypeName(types_explainer_type.name)
+              type_params = temporary_type_params(name.to_s)
+              args = if 2 <= type_params.length
+                Orthoses.logger.warn("Cannot convert to rbs since generics mismatch. `#{name}` has #{type_params.length} generics in RBS. But YARD tag type is `#{types_explainer_type.to_s}`. Use `#{name}[#{type_params.join(', ')}]` instead.")
+                type_params
+              else
+                [type]
+              end
+
               ::RBS::Types::ClassInstance.new(
-                name: TypeName(types_explainer_type.name),
-                args: [type],
+                name: name,
+                args: args,
                 location: nil
               )
-            end
+          end
           when ::YARD::Tags::TypesExplainer::HashCollectionType
             ::RBS::Types::ClassInstance.new(
               name: TypeName(types_explainer_type.name),
               args: [
-                wrap(recursive_resolve(types_explainer_type.key_types)),
-                wrap(recursive_resolve(types_explainer_type.value_types)),
+                Utils::TypeList.new(recursive_resolve(types_explainer_type.key_types)).inject,
+                Utils::TypeList.new(recursive_resolve(types_explainer_type.value_types)).inject,
               ],
               location: nil
             )
@@ -347,8 +323,14 @@ module Orthoses
               # end
             else
               case types_explainer_type.name
-              when "Object" then next untyped
-              when "Boolean" then next bool
+              when "Object"
+                next untyped
+              when "Boolean", "TrueClass", "FalseClass", "true", "false"
+                next bool
+              when "NilClass", "nil"
+                next ::RBS::Types::Bases::Nil.new(location: nil)
+              when "Fixnum"
+                next ::RBS::Types::ClassInstance.new(name: TypeName("Integer"), args: [], location: nil)
               end
 
               begin
@@ -359,6 +341,7 @@ module Orthoses
                 when ::RBS::Types::Alias
                 end
               rescue ::RBS::ParsingError
+                # will be unresolve type
               end
 
               if Utils.rbs_defined_class?(types_explainer_type.name, collection: true)
@@ -368,22 +351,13 @@ module Orthoses
                   location: nil
                 )
               else
-                name =
-                  case types_explainer_type.name
-                  when "Fixnum"
-                    "Integer"
-                  else
-                    resolved = ::YARD::Registry.resolve(yardoc.namespace, types_explainer_type.name, true, false)
-                    if resolved
-                      resolved.to_s
-                    else
-                      Orthoses.logger.warn("#{types_explainer_type.name} in #{yardoc.namespace} set `untyped` because it cannot resolved type")
-                      next untyped
-                    end
-                  end
-
+                resolved = ::YARD::Registry.resolve(yardoc, types_explainer_type.name, true, false)
+                unless resolved
+                  Orthoses.logger.warn("yardoc type=[#{types_explainer_type.name}] in #{yardoc.path} set `untyped` because it cannot resolved type by `::YARD::Registry.resolve`")
+                  next untyped
+                end
                 ::RBS::Types::ClassInstance.new(
-                  name: TypeName(name),
+                  name: TypeName(resolved.to_s),
                   args: [],
                   location: nil
                 )

data/lib/orthoses/yard.rb

@@ -6,22 +6,39 @@ require_relative "yard/yard2rbs"
 module Orthoses
   # use Orthoses::YARD, parse: "lib/**/*.rb"
   class YARD
-    def initialize(loader, parse:)
+    # @param loader
+    # @param [<String>, String] parse Target files
+    # @param [Boolean] use_cache Use cache .yardoc
+    # @param [Symbol, nil] log_level Set YARD log level
+    def initialize(loader, parse:, use_cache: true, log_level: nil)
       @loader = loader
       @parse = Array(parse)
+      @use_cache = use_cache
+      @log_level = log_level
     end
 
+    # @return [void]
     def call
       @loader.call.tap do |store|
         require 'yard'
 
+        log.level = @log_level if @log_level
+
+        ::YARD::Registry.load if @use_cache
         ::YARD.parse(@parse)
+        ::YARD::Registry.save(true) if @use_cache
         ::YARD::Registry.root.children.each do |yardoc|
+          # Skip anonymous yardoc
+          next unless yardoc.file
+
+          # Skip external doc (e.g. pry-doc)
+          next unless @parse.any? { |pattern| File.fnmatch(pattern, yardoc.file, File::FNM_EXTGLOB | File::FNM_PATHNAME) }
+
           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?
+              if rbs.nil? && comment && !store.has_key?(namespace)
                 store[namespace].comment = comment
               else
                 Orthoses.logger.debug("#{namespace} << #{rbs}")

data/sig/orthoses.rbs

@@ -0,0 +1,43 @@
+# GENERATED FILE
+
+# use Orthoses::YARD, parse: "lib/**/*.rb"
+class Orthoses::YARD
+  # @param loader
+  # @param [<String>, String] parse Target files
+  # @param [Boolean] use_cache Use cache .yardoc
+  # @param [Symbol, nil] log_level Set YARD log level
+  def initialize: (untyped loader, parse: Array[String] | String, ?use_cache: bool, ?log_level: Symbol?) -> void
+  # @return [void]
+  def call: () -> void
+  VERSION: untyped
+end
+
+class Orthoses::YARD::YARD2RBS
+  # @return [YARD::CodeObjects::t]
+  attr_reader yardoc: untyped
+  # @return [Proc]
+  attr_reader block: Proc
+  # @return [RBS::Types::Bases::Any]
+  attr_reader untyped: RBS::Types::Bases::Any
+  # @return [RBS::Types::Bases::Void]
+  attr_reader void: RBS::Types::Bases::Void
+  # @return [RBS::Types::Bases::Bool]
+  attr_reader bool: RBS::Types::Bases::Bool
+  def initialize: (yardoc: untyped, block: untyped) -> void
+  # @return [void]
+  def run: () -> void
+  # @return [RBS::Types::t]
+  def tag_types_to_rbs_type: (untyped tag_types) -> untyped
+  # @return [void]
+  private def generate_for_attributes: () -> void
+  # @return [void]
+  private def generate_for_methods: () -> void
+  # @return [void]
+  private def generate_for_constants: () -> void
+  # @return [void]
+  private def generate_for_classvariable: () -> void
+  # @return [Array<RBS::Types::t>]
+  private def recursive_resolve: (untyped types_explainer_types) -> untyped
+  # @return [Array<RBS::Types::Bases::Any>]
+  private def temporary_type_params: (untyped name) -> Array[RBS::Types::Bases::Any]
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orthoses-yard
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - ksss
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-15 00:00:00.000000000 Z
+date: 2023-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: orthoses
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.5.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.5.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -52,18 +52,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CODE_OF_CONDUCT.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - lib/orthoses-yard.rb
 - lib/orthoses/yard.rb
 - lib/orthoses/yard/version.rb
 - lib/orthoses/yard/yard2rbs.rb
-- orthoses-yard.gemspec
-- sig/orthoses/yard.rbs
-- sig/orthoses/yard/yard2_rbs.rbs
-- sig_patch/yard.rbs
+- sig/orthoses.rbs
 homepage: https://github.com/ksss/orthoses-yard
 licenses:
 - MIT
@@ -86,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.8
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Orthoses extention for YARD.

data/Gemfile

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in orthoses-yard.gemspec
-gemspec
-
-gem "rake", "~> 13.0"
-gem "rgot", "~> 1.1"
-gem "rbs"
-gem "steep"
-gem "debug"

data/Gemfile.lock

@@ -1,89 +0,0 @@
-PATH
-  remote: .
-  specs:
-    orthoses-yard (0.3.0)
-      orthoses (>= 1.3.0, < 2.0)
-      yard
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    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.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.6.0)
-    irb (1.6.3)
-      reline (>= 0.3.0)
-    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)
-    logger (1.5.3)
-    minitest (5.18.0)
-    orthoses (1.6.0)
-      rbs (~> 3.0)
-    parallel (1.22.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 (3.0.4)
-    reline (0.3.2)
-      io-console (~> 0.5)
-    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.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.6)
-      concurrent-ruby (~> 1.0)
-    unicode-display_width (2.4.2)
-    webrick (1.7.0)
-    yard (0.9.28)
-      webrick (~> 1.7.0)
-
-PLATFORMS
-  arm64-darwin-21
-  x86_64-linux
-
-DEPENDENCIES
-  debug
-  orthoses-yard!
-  rake (~> 13.0)
-  rbs
-  rgot (~> 1.1)
-  steep
-
-BUNDLED WITH
-   2.3.16

data/orthoses-yard.gemspec

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/orthoses/yard/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "orthoses-yard"
-  spec.version = Orthoses::YARD::VERSION
-  spec.authors = ["ksss"]
-  spec.email = ["co000ri@gmail.com"]
-
-  spec.summary = "Orthoses extention for YARD."
-  spec.description = "Orthoses extention for YARD."
-  spec.homepage = "https://github.com/ksss/orthoses-yard"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = spec.homepage
-
-  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|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
-      false
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "orthoses", ">= 1.3.0", "< 2.0"
-  spec.add_dependency "yard"
-end

data/sig/orthoses/yard/yard2_rbs.rbs

@@ -1,31 +0,0 @@
-# GENERATED FILE
-
-class Orthoses::YARD::YARD2RBS
-  # @return [YARD::CodeObjects::t]
-  attr_reader yardoc: untyped
-  # @return [Proc]
-  attr_reader block: Proc
-  # @return [RBS::Types::Bases::Any]
-  attr_reader untyped: RBS::Types::Bases::Any
-  # @return [RBS::Types::Bases::Void]
-  attr_reader void: RBS::Types::Bases::Void
-  # @return [RBS::Types::Bases::Bool]
-  attr_reader bool: RBS::Types::Bases::Bool
-  def initialize: (yardoc: untyped, block: untyped) -> void
-  # @return [void]
-  def run: () -> void
-  # @return [void]
-  def generate_for_attributes: () -> void
-  # @return [void]
-  def generate_for_methods: () -> void
-  # @return [void]
-  def generate_for_constants: () -> void
-  # @return [RBS::Types::t]
-  def tag_types_to_rbs_type: (untyped tag_types) -> untyped
-  # @return [RBS::Types::t]
-  def wrap: (untyped types) -> untyped
-  # @return [Array<RBS::Types::t>]
-  def recursive_resolve: (untyped types_explainer_types) -> untyped
-  # @return [Array<RBS::Types::Bases::Any>]
-  def temporary_type_params: (untyped name) -> Array[RBS::Types::Bases::Any]
-end

data/sig/orthoses/yard.rbs

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

data/sig_patch/yard.rbs

@@ -1,38 +0,0 @@
-module YARD
-  module Registry
-  end
-
-  module Tags
-    module TypesExplainer
-      class Parser
-      end
-
-      class Type
-      end
-
-      class CollectionType < Type
-      end
-
-      class FixedCollectionType < CollectionType
-      end
-
-      class HashCollectionType < Type
-      end
-    end
-  end
-
-  module CodeObjects
-    type t = ModuleObject | ClassObject | MethodObject
-    class Base
-      def attributes: () -> { class: Hash[Symbol, untyped], instance: Hash[Symbol, untyped] }
-    end
-    class NamespaceObject < Base
-    end
-    class ModuleObject < NamespaceObject
-    end
-    class ClassObject < NamespaceObject
-    end
-    class MethodObject < Base
-    end
-  end
-end