Parsing documentation on gem install fails

Open Beginner friendly
#136 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
62/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Stale
Tech stack
ruby
Domain
cli

Research direction

Start with lib/ey-core/cli/deploy.rb at line 72 and inspect the option/options reference in the abort message. Run ruby -c on the file, then retry gem install ey-core -v 3.6.5 to confirm whether documentation parsing succeeds. Done means the gem installs and its documentation parses without the reported NoMethodError.

Written by the indexing model from the issue text.

Description

Installing ey-core via gem install ey-core -v 3.6.5 throws the following error while parsing documentation.

Successfully installed ey-core-3.6.5
Parsing documentation for ey-core-3.6.5
Before reporting this, could you check that the file you're documenting
has proper syntax:

  /Users/user/.rbenv/versions/2.6.8/bin/ruby -c lib/ey-core/cli/deploy.rb

RDoc is not a full Ruby parser and will fail when fed invalid ruby programs.

The internal error was:

	(NoMethodError) undefined method `[]' for nil:NilClass

ERROR:  While executing gem ... (NoMethodError)
    undefined method `[]' for nil:NilClass

Upon navigating to the file in question, it looks like the problem may lie at deploy.rb:72. I'd guess abort "Unable to locate environment #{option[:environment]} in #{operator.name}".red should be abort "Unable to locate environment #{**options**[:environment]} in #{operator.name}".red, instead?

Dominant language
Ruby
Stars
4
Forks
19
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from engineyard/core-client-rb

All issues in engineyard/core-client-rb

Similar issues

More Ruby issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.