advent_of_code_cli 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7358ae00fcb5ac752f1512f4c643f8d4244bffc3952217d3e1de47095f14c46
-  data.tar.gz: c769d144252d13015b46a01be1d7f0198242d5903872a5c9881b08a6f4dfbeb5
+  metadata.gz: 874bcb2472449a2b367b4276efabaf1c7b15a19857c0e331d16bf3cd6da7e700
+  data.tar.gz: 36f956b45bb8849b1b17880132842f16194209d3cfaff592be643b98da4d7ca2
 SHA512:
-  metadata.gz: ade57a3e3a2b96b465acf42ea7ccbdd89e2347d32791180faade8a3e3ff0dac1d8eefeca5f0fe30b358af7fb6c0062cb4b26daf88ad8e07b20c57447210eabaf
-  data.tar.gz: d5154c39abd8732678b0b17f3e64f345d2787cebb3c0ff47619c770fa8d28a085ce3feacfaf0b1081e6b50a1ae8ec7a97e31994e641f78ddbed88305dd343eb0
+  metadata.gz: 3387033c1bf3c5f5edd4cd335647c64d3722ba0ffd5a6f716e7ec895d6e789a537d67b181cc44d29d1c99eec79590b3fe69a3627fe4d19e3eeedf180d1b091b1
+  data.tar.gz: e952fb854364b9bfbcfdd6a84e194476c038ed176fde60903818dce824899c570b84cb256819e46f6afe5438402551adef59bc0825520d85adfce1819c9e8d2a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    advent_of_code_cli (0.1.1)
+    advent_of_code_cli (0.1.3)
       thor (>= 1.2.0)
 
 GEM

data/README.md

@@ -1,33 +1,116 @@
-# AdventOfCodeCli
+# 🎄 Advent of Code CLI
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/advent_of_code_cli`. To experiment with that code, run `bin/console` for an interactive prompt.
+> ⚠️ **Note:** This tool is under active development. I built in in a couple hours with no automated tests. Things may change between versions!
 
-TODO: Delete this and the text above, and describe your gem
+A little CLI tool that scaffolds and runs [Advent of Code](https://advent-of-code.com) solutions in Ruby.
 
-## Installation
+This project is heavily based on [advent-of-code-rust](https://github.com/arturopala/advent-of-code-rust). Go check it out!
 
-Install the gem and add to the application's Gemfile by executing:
+## Installation
 
-    $ bundle add advent_of_code_cli
+Add this line to your application's `Gemfile`:
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+```ruby
+gem "advent_of_code_cli"
+```
 
-    $ gem install advent_of_code_cli
+Run `bundle install`.
 
 ## Usage
 
-TODO: Write usage instructions here
+### Scaffold
 
-## Development
+This command will set up the files for any day of Advent of Code. It takes a nubmer between 1 and 25 as an argument.
 
-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.
+```bash
+bundle exec aoc_cli scaffold 1
+```
 
-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](https://rubygems.org).
+This will result in the following output:
 
-## Contributing
+```
+Creating file: 01.rb...
+Creating inputs directory...
+Creating file: inputs/01.txt...
+Creating examples directory...
+Creating examples/01 directory...
+```
+
+The file `01.rb` will have the following structure:
+
+```rb
+module Day01
+  class << self
+    def part_one(input)
+      raise NotImplementedError
+    end
+
+    def part_two(input)
+      raise NotImplementedError
+    end
+  end
+end
+```
+
+I would love to make this structure configurable in the future.
+
+### Download
+
+This command will download the input for a given day.
+
+In order for this to work, you must provide your Advent of Code session cookie to the program in an environment variable:
+
+```bash
+export AOC_COOKIE=your-cookie
+```
+
+Once the environment variable is set, you can request your personal input for any day.
+
+```bash
+bundle exec aoc_cli download 1
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/advent_of_code_cli.
+This will create the following output:
 
-## License
+```
+Fetching input...
+Writing input to inputs/01.txt...
+Done!
+```
+
+By default, the CLI will request the input for this year, but you can request previous years' input by passing a `--year` flag.
+
+```bash
+bundle exec aoc_cli download 1 --year 2021
+```
+
+### Solve
+
+This command will run your solution to a certain day's puzzle.
+
+```
+bundle exec aoc_cli solve 1
+```
+
+This will create the following output:
+
+```
+Reading input...
+Loading solution...
+
+Running part one...
+Part one result: 10000
+Took 0.000259 seconds to solve
+
+Running part two...
+Part two result: 10000
+Took 0.00026 seconds to solve
+
+Done!
+```
+
+This command expects files to be in the format provided by the `scaffold` command. Once again, I would love to make this configurable but haven't gotten around to it yet.
+
+## Contributing
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+Issues and code contributions are welcome! Happy Advent of Code to all who celebrate! 🎁

data/lib/advent_of_code_cli/commands/download.rb

@@ -31,11 +31,11 @@ module AdventOfCode
       private
 
       def cookie
-        @cookie ||= File.read("cookie.txt").strip
+        @cookie ||= ENV["AOC_COOKIE"]
       end
 
       def cookie_present?
-        File.exist?("cookie.txt")
+        ENV.key?("AOC_COOKIE")
       end
 
       def fetch_input

data/lib/advent_of_code_cli/commands/solve.rb

@@ -10,7 +10,7 @@ module AdventOfCode
         raise MissingSolutionError unless File.exist?(solution_file_name)
 
         say "Reading input..."
-        input = File.read(input_file_name).strip
+        input = File.readlines(input_file_name, chomp: true)
 
         say "Loading solution..."
         load(solution_file_name)

data/lib/advent_of_code_cli/commands.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require_relative "commands/command"
-require_relative "commands/cookie"
 require_relative "commands/download"
 require_relative "commands/scaffold"
 require_relative "commands/solve"

data/lib/advent_of_code_cli/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AdventOfCode
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

data/lib/advent_of_code_cli.rb

@@ -20,11 +20,6 @@ module AdventOfCode
       rescue_invalid_day_error
     end
 
-    desc "cookie VALUE", "store your Advent of Code cookie with value VALUE in the cookie.txt file"
-    def cookie(value)
-      AdventOfCode::Commands::Cookie.new(value: value).execute
-    end
-
     desc "download DAY", "download your input for day DAY"
     option :year, default: Time.now.year.to_s
     def download(day)
@@ -32,7 +27,7 @@ module AdventOfCode
     rescue AdventOfCode::InvalidDayError
       rescue_invalid_day_error
     rescue AdventOfCode::MissingCookieError
-      say "Error: Cannot find cookie in cookie.txt file.", :red
+      say "Error: Cannot find cookie in the AOC_COOKIE environment variable.", :red
     end
 
     desc "solve DAY", "run your solutions for day DAY"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: advent_of_code_cli
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Emily Samp
@@ -44,7 +44,6 @@ files:
 - lib/advent_of_code_cli.rb
 - lib/advent_of_code_cli/commands.rb
 - lib/advent_of_code_cli/commands/command.rb
-- lib/advent_of_code_cli/commands/cookie.rb
 - lib/advent_of_code_cli/commands/download.rb
 - lib/advent_of_code_cli/commands/scaffold.rb
 - lib/advent_of_code_cli/commands/solve.rb

data/lib/advent_of_code_cli/commands/cookie.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module AdventOfCode
-  module Commands
-    class Cookie
-      def initialize(value:)
-        @value = value
-      end
-
-      def execute
-        say "Creating cookie.txt file..."
-        File.open("cookie.txt", "w") do |file|
-          file.puts @value
-        end
-
-        say "Done!", :green
-      end
-    end
-  end
-end