not picking up specs wrapped in context or additional describe blocks

[aaronmallen]

given the spec file:

RSpec.describe MyModule do
  context 'Some context' do
    describe '.myInstanceMethod' do
      it 'should equal foo' do
        expect(MyModule.myInstanceMethod).to eq 'foo'
      end
    end
  end
  context 'Some other context' do
    describe '.myInstanceMethod' do
      it 'should not equal foo' do
        expect(MyModule.myInstanceMethod).not_to eq 'foo'
      end
    end
  end
end

or even given:

RSpec.describe MyModule do
  context 'Some context' do
    describe MyModule.myInstanceMethod do
      it 'should equal foo' do
        expect(MyModule.myInstanceMethod).to eq 'foo'
      end
    end
  end
  context 'Some other context' do
    describe MyModule.myInstanceMethod do
      it 'should not equal foo' do
        expect(MyModule.myInstanceMethod).not_to eq 'foo'
      end
    end
  end
end

Problem:

The plugin doesn't seem to append the specifications to the docs.

Expectation

The plugin should both find these specs (including the string variants in the first example) and respect the context of each spec in the Specifications outline:

.myInstanceMethod

Specifications:

• Some context
  • should equal foo
• Some other context
  • should not equal foo

Other relevant information:

$ ruby -v
#=> ruby 2.3.0p0 (2015-12-25 revision 53290) [x86_64-darwin16]
$ rspec -v
#=> 3.5.4
$ yard -v
#=> yard 0.9.8

# .yardopts
--exclude lib/task/*
--plugin rspec
-r README.md
-
CODE_OF_CONDUCT.md
LICENSE

My file structure is:

• lib/my_module.rb
• spec/lib/my_module_spec.rb

and is being invoked via rake task:

YARD::Rake::YardocTask.new do |t|
  t.files         = ['lib/**/*.rb', 'spec/**/*_spec.rb']
  t.stats_options = ['--list-undoc']
end

[aaronmallen]

this also doesn't work if you use describe in place of context in either of my examples as well.

[lsegal]

This plugin doesn't support nested definitions. When this was written, that feature was not available in RSpec.

[aaronmallen]

ah, ok so less of a bug more of a feature request.

[lsegal]

@aaronmallen PRs accepted, I don't really update this repository anymore. If you want to take over maintainership of yard-rspec, I'm all for it.

[aaronmallen]

@isegal not to pass the buck, but it definitely seems that offer would be better extended to:

• @ogeidix
• @zetaben
• @Jesus
• @nikhgupta

They all seem to have done a lot of great work on top of yours already and might be a little more qualified for the task. I'll def. look into doing a PR though.

[Jesus]

I'd be interested in doing some updates to this plugin, I'd take the offer to be a contributor.

[Jesus]

I'm sorry to bother again, but ping @lsegal 😅