Merge pull request #1 from sinsoku/support-sord

feat: support AaronC81/sord

.github/workflows/main.yml

@@ -27,3 +27,5 @@ jobs:
  run: bundle exec rake
  - name: Run yard with yard-sig
  run: bundle exec yard
+ - name: Run sord
+ run: bundle exec sord --rbs sig/sord.rbs

Gemfile

@@ -8,4 +8,5 @@ gemspec
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 gem "rubocop", "~> 1.21"
+gem "sord"
 gem "yard"

Gemfile.lock

@@ -9,9 +9,17 @@ GEM
  remote: https://rubygems.org/
  specs:
  ast (2.4.2)
+ commander (4.6.0)
+ highline (~> 2.0.0)
  diff-lcs (1.5.0)
+ highline (2.0.3)
  json (2.6.3)
  parallel (1.23.0)
+ parlour (5.0.0)
+ commander (~> 4.5)
+ parser
+ rainbow (~> 3.0)
+ sorbet-runtime (>= 0.5)
  parser (3.2.2.3)
  ast (~> 2.4.1)
  racc
@@ -47,17 +55,26 @@ GEM
  rubocop-ast (1.29.0)
  parser (>= 3.2.1.0)
  ruby-progressbar (1.13.0)
+ sorbet-runtime (0.5.10902)
+ sord (6.0.0)
+ commander (~> 4.5)
+ parlour (~> 5.0)
+ rbs (~> 3.0)
+ sorbet-runtime
+ yard
  unicode-display_width (2.4.2)
  yard (0.9.34)
 
 PLATFORMS
+ arm64-darwin-21
  arm64-darwin-22
  x86_64-linux
 
 DEPENDENCIES
  rake (~> 13.0)
  rspec (~> 3.0)
  rubocop (~> 1.21)
+ sord
  yard
  yard-sig!
 

lib/yard-sig.rb

@@ -12,6 +12,8 @@ class Error < StandardError; end
  class SigDirective < ::YARD::Tags::Directive
  # @!sig () -> void
  def call
+ return unless object
+
  validate_arguments_forwarding!
 
  sig = Sig.new(tag.text, object.parameters, object.namespace.path)

spec/yard_sig_spec.rb

@@ -31,4 +31,19 @@ def m(...); end
 
  expect(log).to have_received(:warn).with("arguments forwarding is not supported.")
  end
+
+ it "does not cause errors within sord processing" do
+ YARD.parse_string(<<~RUBY)
+ # @!sig (Integer) -> void
+ def m(a); end
+ RUBY
+ obj = YARD::Registry.at("#m")
+
+ # refs: https://github.com/AaronC81/sord/blob/6.0.0/lib/sord/generator.rb#L174-L177
+ parser = YARD::Docstring.parser
+ parser.parse(obj.docstring.all)
+ docs_array = parser.text.split("\n")
+
+ expect(docs_array).to eq([])
+ end
 end