orthoses-yard 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4360149f5950080699830fd17881758b818f6b02df358056975744cb3f883e47
-  data.tar.gz: 877833515ad18d0e39f04a7526a055eacbc5bd92d6b3404363a747f67cb38edb
+  metadata.gz: b2f6b90fd20646f14534289bd4b876eb0faf8cb4a2d422d442bcbcefd07b2069
+  data.tar.gz: e7283f8f85defc5ac290310d35a8a248c47fd87ef09f54c2dd65e352373bc881
 SHA512:
-  metadata.gz: a20fe50f64fd4b0bef16fe325b80a539a6fe3424cbaab57a42e6f20a290c3497d519f629a5509ee181493d05019f10fa1dda10f85bdb7c44ef4fced8c0283d84
-  data.tar.gz: 87ea6a5128e5a37635e6f294f8fb1c96491bcd672cfce54f4682982727943f69e037fa683283800cc3fd62d8198671969817d040f34cce5210450f0a20499fc1
+  metadata.gz: 1796d238fbfa72d260fce28cf167ca6b0d595bc6b65faa0295e5416bd17aeec384303f8395b5aa5e3c9f8c9587ffb48cbb0a7654301ceb004be457a349a5d34b
+  data.tar.gz: 27a5c5c9dcfdd9d51834aa57c875c1e3600ed1a3841a930b199286624e843054a98653ff9f6e8af397fb46792136735283df49f5ed4aed4411feb14cad3b5f38

data/Gemfile.lock

@@ -1,64 +1,74 @@
 PATH
   remote: .
   specs:
-    orthoses-yard (0.2.0)
-      orthoses (~> 1.3.0)
+    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.2)
+    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.3.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.7.0)
-    reline (0.3.1)
+    rbs (3.0.4)
+    reline (0.3.2)
       io-console (~> 0.5)
-    rgot (1.1.0)
-    securerandom (0.2.0)
-    steep (1.2.0)
+    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.7.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.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.2.0"
+    VERSION = "0.3.0"
   end
 end

data/lib/orthoses/yard/yard2rbs.rb

@@ -116,8 +116,6 @@ module Orthoses
           required_keywords = {}
           optional_keywords = {}
           rest_keywords = nil
-          yield_params = []
-          yield_return = nil
 
           requireds = required_positionals
 

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", "~> 1.3.0"
+  spec.add_dependency "orthoses", ">= 1.3.0", "< 2.0"
   spec.add_dependency "yard"
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: orthoses-yard
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - ksss
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-12 00:00:00.000000000 Z
+date: 2023-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: orthoses
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         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: 1.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -50,17 +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
-- 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
@@ -91,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"
-gem "orthoses-yard", path: "../../"
-gem "rake"
-gem "rack"
-gem "sord"
-gem "debug"

data/examples/yard/Gemfile.lock

@@ -1,59 +0,0 @@
-PATH
-  remote: ../..
-  specs:
-    orthoses-yard (0.1.0)
-      orthoses (~> 1.2.0)
-      yard
-
-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.2)
-      reline (>= 0.3.0)
-    orthoses (1.2.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.7.0)
-    reline (0.3.1)
-      io-console (~> 0.5)
-    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
-
-DEPENDENCIES
-  debug
-  orthoses-yard!
-  rack
-  rake
-  sord
-  yard
-
-BUNDLED WITH
-   2.3.16

data/examples/yard/Rakefile

@@ -1,7 +0,0 @@
-task :generate do
-  load 'generate.rb'
-end
-
-task :validate do
-  sh "rbs -I out validate --silent"
-end

data/examples/yard/generate.rb

@@ -1,81 +0,0 @@
-require 'orthoses-yard'
-require 'fileutils'
-require 'pathname'
-require 'erb'
-
-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: output_dir,
-    header: notice
-  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'
-
-    # 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,
-    parse: [
-      "#{gem_path}/yard.rb",
-      "#{gem_path}/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)
-  }
-end.call
-
-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
-
-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
-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

@@ -1,80 +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.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.2.0
-  source:
-    type: rubygems
-- name: orthoses-yard
-  version: 0.1.0
-  source:
-    type: rubygems
-- name: rack
-  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: 6b07483f37484e2b7df168598b95b0c79be2924f
-    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: tsort
-  version: '0'
-  source:
-    type: stdlib
-- name: rdoc
-  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

data/examples/yard/templates/EXTERNAL_TODO.rbs

@@ -1,30 +0,0 @@
-# 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

@@ -1,20 +0,0 @@
-#!/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

@@ -1,17 +0,0 @@
-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

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

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

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