Skip to content
IRC bot that tells you about ruby core documentation
Ruby Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app
bin
config
db
lib
log
spec
.gitignore
.reek
.travis.yml
.yardopts
Gemfile
Gemfile.lock
LICENSE
README.md
Rakefile
yarr.gemspec
yarr.service

README.md

Yarr

This application is the workhorse behind the rubydoc bot on freenode.net #ruby.

Build Status Maintainability Inline docs

Installation

$ cd yarr
$ bundle install

Configuration

Copy the configuration sample:

$ cp config/yarr_sample.yml config/yarr.yml

Edit the config/yarr.yml file, fill in the blanks.

Set up the database and load it with default data:

$ rake db:setup

Usage

You can run the bot, or you can run yarr in a console (no IRC connection). To run the application you have to run the following command:

$ bundle exec ruby bin/console # run console mode.
$ bundle exec ruby app/yarr # run bot mode.

In irc mode all commands have to be prefixed with `&'.

>>

Evaluates arbitrary ruby code by posting it to carc.in and then links the result. Ruby version can be specified by prepending it to >>, like 20>>, 21>> etc. The command can be modified to send a disassembly, tokenisation, or parse request on the code to carc.in. These modifiers can also be combined with the ruby version, action modifier comes first.

asm dissassemble
tok lexer output
ast parser output
bare bare code (no implicit p or begin/end)
&>> 1 + 1
>>> => 2 (http://...)
&asm20>> 1 + 1
>>> I have disassembled your code, the result is at http://...

url

The url command fetches the source that is sent to the evaluation service from a user specified url. This is useful if we want to evaluate for instance a gist with the bot.

&url http://somegist.raw/gist.rb
>>> # => 13 (http://...)

ri

ri looks up the documentation of a class name, a method name, an instance method call (in the form of ri Array#size) and a class method call (in the form of ri File.size). If the query is ambiguous the bot will tell you that.

&ri instance_methods
>>> https://ruby-doc.org/core-2.5.1/Module.html#method-i-instance_methods
&ri puts
>>> I found 3 entries matching with method: puts. Use &list puts if you would like to see a list

Class or module name ambiguity

In case of class or module names ri implicitly resolves ambiguous names if there is a definition in core (no file needs to be required to use the class) or if the required file matches the class name. This helps when classes are patched in multiple places and we just want to get the url of the main documentation. We can list all names, or be explicit in the query.

&ri Array
>>> https://ruby-doc.org/core-2.5.1/Array.html
&list Array
>>> Array, Array (abbrev), Array (mkmf), Array (rexml), Array (shellwords)
&ri Array (mkmf)
>>> https://ruby-doc.org/stdlib-2.5.1/libdoc/mkmf/rdoc/Array.html

list

list lists the matching names. % is taken as a wildcard character that can match any string fragment.

&list puts
>>> ARGF#puts, IO#puts, Kernel#puts
&list %!
>>> BasicObject#!, String#capitalize!, String#chomp!, String#chop!, Array#collect!, Array#compact!, Hash#compact!, String#delete!, String#delete_prefix!,...

For ambiguous method names we simply call list:

&list size
>>> ENV.size, File.size, Array#size, Enumerator#size, File#size, File::Stat#size, FileTest#size, Hash#size, Integer#size, MatchData#size,...

One caveat is that yarr decides if a token is a class name or not by checking if the first character is upcase. Therefore we can't list the File class this way:

&list %ile
>>> Enumerable#chunk_while, Enumerator::Lazy#chunk_while, Regexp.compile, RubyVM::InstructionSequence.compile, RubyVM::InstructionSequence.compile_file,...

However it is possible to force it to be part of a class or module name by this trick:

&list %ile.%
>>> File.absolute_path, File.atime, File.basename, File.birthtime, File.blockdev?, File.chardev?, File.chmod, File.chown, File.ctime, File.delete,...

fake

An easter egg command, using Classname.methodname ri notation. It responds with the result of Faker::Classname.methodname from the faker gem.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/phaul/yarr.

The lint:all rake task kicks off a bunch of checks on the project including branch coverage.

Debug can be enabled by running the app in development environment by setting the YARR_DEVELOPMENT=1 environment variable. In development mode the bot outputs more verbose logs to the console.

Testing

The environment variable YARR_TEST controls if the test database needs to be loaded. The Rake tasks take care of this variable before kicking tasks off like running rspec, or coverage. Without setting this variable the specs are allowed to fail. This isn't a bug, simply some tests are expecting certain fixtures in the database.

API documentation can be found rubydoc.info.

You can’t perform that action at this time.