Skip to content

dnlgrv/advent-rb

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Advent

Gem Version

Have fun with the Advent of Code using Ruby.

Installation

Install the gem and add to the application's Gemfile by executing:

$ bundle add advent

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install advent

Usage

Advent expects you to have a working directory resembling something like:

$ tree
.
├── 2015
└── 2016

advent commands should be run from the root of this directory tree.

If you want to use advent for downloading challenge inputs, first auth:

$ advent auth

It will prompt you for your session cookie from adventofcode.com. Log in to the website and look at your cookies, grab the session value and paste it into the prompt (it's hidden). This will be saved in .advent_session which should also have been added to your .gitignore if you're in a git repo.

The typical flow for tackling a daily challenge would be:

$ advent new 2015 1 # generates working files
$ advent download 2015 1 # downloads the input file

$ vim 2015/day1.rb test/2015/day1_test.rb # do your work

$ ruby test/2015/day1_test.rb # run any tests you may have
$ advent solve 2015/day1.rb # get your answers to submit on adventofcode.com

A list of commands and help is available using advent:

$ advent help

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/dnlgrv/advent-rb.

License

The gem is available as open source under the terms of the MIT License.