orthoses-yard 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d57da650c9fa9921fe11457ff26920168316e9eb43ff101cc9aedd6472c998e5
-  data.tar.gz: 96fab97f4f9ea79e773a5f0bd4eaf8fa5be3aac236be6819b74c89c9acf8a80f
+  metadata.gz: 4360149f5950080699830fd17881758b818f6b02df358056975744cb3f883e47
+  data.tar.gz: 877833515ad18d0e39f04a7526a055eacbc5bd92d6b3404363a747f67cb38edb
 SHA512:
-  metadata.gz: ed202e833e51fe62faf2b2c2d2554d5f14af1399dfca052f4fa38a06cda920232bcd66a46b1e2cd3b7683322527fddd6b3dbcc0504b4a99a0d996675253a33f9
-  data.tar.gz: 4af5a24ec753a2d92371deed81de517bc558b7c30a215986f9b1b138def44d65ffaa105c6853dc757f2d2a3fd9442434d19a95c50fa227688fd186840b84442a
+  metadata.gz: a20fe50f64fd4b0bef16fe325b80a539a6fe3424cbaab57a42e6f20a290c3497d519f629a5509ee181493d05019f10fa1dda10f85bdb7c44ef4fced8c0283d84
+  data.tar.gz: 87ea6a5128e5a37635e6f294f8fb1c96491bcd672cfce54f4682982727943f69e037fa683283800cc3fd62d8198671969817d040f34cce5210450f0a20499fc1

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    orthoses-yard (0.1.0)
-      orthoses
+    orthoses-yard (0.2.0)
+      orthoses (~> 1.3.0)
       yard
 
 GEM
@@ -22,14 +22,14 @@ GEM
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     io-console (0.5.11)
-    irb (1.4.1)
+    irb (1.4.2)
       reline (>= 0.3.0)
     language_server-protocol (3.17.0.1)
     listen (3.7.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     minitest (5.16.3)
-    orthoses (1.1.0)
+    orthoses (1.3.0)
       rbs (~> 2.0)
     parallel (1.22.1)
     parser (3.1.2.1)
@@ -39,18 +39,20 @@ GEM
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rbs (2.6.0)
+    rbs (2.7.0)
     reline (0.3.1)
       io-console (~> 0.5)
     rgot (1.1.0)
-    steep (1.1.1)
+    securerandom (0.2.0)
+    steep (1.2.0)
       activesupport (>= 5.1)
       language_server-protocol (>= 3.15, < 4.0)
       listen (~> 3.0)
       parallel (>= 1.0.0)
       parser (>= 3.1)
       rainbow (>= 2.2.2, < 4.0)
-      rbs (>= 2.3.2)
+      rbs (>= 2.7.0)
+      securerandom (>= 0.1)
       terminal-table (>= 2, < 4)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)

data/examples/yard/Gemfile

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "yard", path: "src"
+gem "yard"
 gem "orthoses-yard", path: "../../"
 gem "rake"
 gem "rack"

data/examples/yard/Gemfile.lock

@@ -2,15 +2,9 @@ PATH
   remote: ../..
   specs:
     orthoses-yard (0.1.0)
-      orthoses
+      orthoses (~> 1.2.0)
       yard
 
-PATH
-  remote: src
-  specs:
-    yard (0.9.28)
-      webrick (~> 1.7.0)
-
 GEM
   remote: https://rubygems.org/
   specs:
@@ -22,9 +16,9 @@ GEM
       reline (>= 0.3.1)
     highline (2.0.3)
     io-console (0.5.11)
-    irb (1.4.1)
+    irb (1.4.2)
       reline (>= 0.3.0)
-    orthoses (1.1.0)
+    orthoses (1.2.0)
       rbs (~> 2.0)
     parlour (5.0.0)
       commander (~> 4.5)
@@ -36,16 +30,19 @@ GEM
     rack (3.0.0)
     rainbow (3.1.1)
     rake (13.0.6)
-    rbs (2.6.0)
+    rbs (2.7.0)
     reline (0.3.1)
       io-console (~> 0.5)
-    sorbet-runtime (0.5.10445)
-    sord (4.0.0)
+    sorbet-runtime (0.5.10482)
+    sord (5.0.0)
       commander (~> 4.5)
       parlour (~> 5.0)
+      rbs (~> 2.0)
       sorbet-runtime
       yard
     webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
 
 PLATFORMS
   arm64-darwin-21
@@ -56,7 +53,7 @@ DEPENDENCIES
   rack
   rake
   sord
-  yard!
+  yard
 
 BUNDLED WITH
-   2.4.0.dev
+   2.3.16

data/examples/yard/Rakefile

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

data/examples/yard/generate.rb

@@ -1,12 +1,19 @@
 require 'orthoses-yard'
 require 'fileutils'
 require 'pathname'
+require 'erb'
 
-FileUtils.rm_rf('out')
+output_dir = 'out'
+FileUtils.rm_rf(output_dir)
 Orthoses.logger.level = :warn
+
+gem_path = Gem::Specification.find_by_name("yard").load_paths.first
+notice = "# !!! GENERATED FILE !!!\n# Please see generators/yard-generator/README.md\n"
+
 Orthoses::Builder.new do
   use Orthoses::CreateFileByName,
-    base_dir: 'out'
+    base_dir: output_dir,
+    header: notice
   use Orthoses::Filter do |name, content|
     name.start_with?('YARD') ||
       name.start_with?('Ripper') ||
@@ -25,11 +32,14 @@ Orthoses::Builder.new do
     store['YARD::Handlers::Ruby'].header = 'module YARD::Handlers::Ruby'
     # TODO: support generics
     store['YARD::Tags::Library'] << 'def self.labels: () -> SymbolHash'
+
+    # FIXME: YARD's issue?
+    store['YARD::CLI::YardocOptions'].delete("# @return [Numeric] An index value for rendering sequentially related templates\nattr_accessor index: Numeric")
   end
   use Orthoses::YARD,
-    globs: [
-      'src/lib/yard.rb',
-      'src/lib/yard/**/*.rb'
+    parse: [
+      "#{gem_path}/yard.rb",
+      "#{gem_path}/yard/**/*.rb",
     ]
   use Orthoses::Autoload
   run -> {
@@ -37,35 +47,35 @@ Orthoses::Builder.new do
     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
+stdlib_dependencies = %w[
+  set
+  optparse
+  logger
+  monitor
+]
 
+def erb(template_filename, **vars)
+  "templates/#{template_filename}.erb"
+    .then { File.expand_path(_1) }
+    .then { File.read(_1) }
+    .then { ERB.new(_1, trim_mode: '<>').result_with_hash(vars) }
+end
 
-  module WEBrick
-    module HTTPServlet
-      class AbstractServlet
-      end
-    end
-  end
-
-  module RDoc
-    module Markup
-      class ToHtml
-      end
-    end
+out = Pathname(output_dir)
+out.join("EXTERNAL_TODO.rbs").write(erb("EXTERNAL_TODO.rbs", notice: notice))
+out.join("manifest.yaml").write(erb("manifest.yaml", notice: notice, stdlib_dependencies: stdlib_dependencies))
+out.join('_scripts').tap do |scripts|
+  scripts.mkpath
+  scripts.join("test").tap do |test|
+    test.write(erb("_scripts/test", notice: notice, stdlib_dependencies: stdlib_dependencies))
+    test.chmod(0o755)
   end
-RBS
+end
+out.join('_test').tap do |test|
+  test.mkpath
+  test.join("yard.rb").write(erb("_test/yard.rb", notice: notice))
+  test.join('Steepfile').write(erb("_test/Steepfile", notice: notice, stdlib_dependencies: stdlib_dependencies))
+end

data/examples/yard/rbs_collection.lock.yaml

@@ -7,15 +7,23 @@ sources:
 path: ".gem_rbs_collection"
 gems:
 - name: rbs
-  version: 2.6.0
+  version: 2.7.0
   source:
     type: rubygems
+- name: ast
+  version: '2.4'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 6b07483f37484e2b7df168598b95b0c79be2924f
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
 - name: io-console
   version: '0'
   source:
     type: stdlib
 - name: orthoses
-  version: 1.1.0
+  version: 1.2.0
   source:
     type: rubygems
 - name: orthoses-yard
@@ -23,11 +31,19 @@ gems:
   source:
     type: rubygems
 - name: rack
-  version: 2.2.2
+  version: '2.2'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 6b07483f37484e2b7df168598b95b0c79be2924f
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: rainbow
+  version: '3.0'
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: d5d79cf5cc4df61ccb4a28f3e744ea7970cfabf9
+    revision: 6b07483f37484e2b7df168598b95b0c79be2924f
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: logger
@@ -50,11 +66,11 @@ gems:
   version: '0'
   source:
     type: stdlib
-- name: rubygems
+- name: tsort
   version: '0'
   source:
     type: stdlib
-- name: tsort
+- name: rdoc
   version: '0'
   source:
     type: stdlib

data/examples/yard/templates/EXTERNAL_TODO.rbs

@@ -0,0 +1,30 @@
+# It is a temporary definition of a type definition
+# for which the library RBS does not currently exist.
+# Once the library RBS is defined and included in rbs_collection.lock.yaml,
+# the duplicate type definitions in this file should be removed.
+
+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

data/examples/yard/templates/_scripts/test.erb

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+
+# Exit command with non-zero status code, Output logs of every command executed, Treat unset variables as an error when substituting.
+set -eou pipefail
+# Internal Field Separator - Linux shell variable
+IFS=$'
+	'
+# Print shell input lines
+set -v
+
+# Set RBS_DIR variable to change directory to execute type checks using `steep check`
+RBS_DIR=$(cd $(dirname $0)/..; pwd)
+# Set REPO_DIR variable to validate RBS files added to the corresponding folder
+REPO_DIR=$(cd $(dirname $0)/../../..; pwd)
+# Validate RBS files, using the bundler environment present
+bundle exec rbs --repo $REPO_DIR -r yard:0.9 <%= stdlib_dependencies.map { "-r #{_1}" }.join(' ') %> -r rack:2.2.2 validate --silent
+
+cd ${RBS_DIR}/_test
+# Run type checks
+bundle exec steep check

data/examples/yard/templates/_test/Steepfile.erb

@@ -0,0 +1,17 @@
+D = Steep::Diagnostic
+
+target :test do
+  check "."
+  signature '.'
+
+  repo_path "../../../"
+
+<% stdlib_dependencies.each do |stdlib| %>
+  library "<%= stdlib %>"
+<% end %>
+
+  library "yard:0.9"
+  library "rack:2.2.2"
+
+  configure_code_diagnostics(D::Ruby.all_error)
+end

data/examples/yard/templates/_test/yard.rb

@@ -0,0 +1,6 @@
+require 'yard'
+
+YARD::Registry.root.children.each do |child|
+  child.name(false)
+  child.docstring.all
+end

data/examples/yard/templates/manifest.yaml.erb

@@ -0,0 +1,4 @@
+dependencies:
+<% stdlib_dependencies.each do |stdlib| %>
+  - <%= stdlib %>
+<% end %>

data/lib/orthoses/yard/version.rb

@@ -2,6 +2,6 @@
 
 module Orthoses
   class YARD
-    VERSION = "0.1.0"
+    VERSION = "0.2.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
@@ -194,7 +202,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 +211,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 +232,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

@@ -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"
   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,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: orthoses-yard
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - ksss
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-01 00:00:00.000000000 Z
+date: 2022-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: orthoses
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.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::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -56,6 +56,11 @@ files:
 - examples/yard/generate.rb
 - examples/yard/rbs_collection.lock.yaml
 - examples/yard/rbs_collection.yaml
+- examples/yard/templates/EXTERNAL_TODO.rbs
+- examples/yard/templates/_scripts/test.erb
+- examples/yard/templates/_test/Steepfile.erb
+- examples/yard/templates/_test/yard.rb
+- examples/yard/templates/manifest.yaml.erb
 - lib/orthoses-yard.rb
 - lib/orthoses/yard.rb
 - lib/orthoses/yard/version.rb