advent_of_code_cli 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35f78ceadc5e206cc38c1384188d68b60fd1e7c747836493f65ff140f771946f
-  data.tar.gz: 811234a1a95f4e87fb93f5b842ab057c1c5a9f5e0b3a8eb19a05aeaa350e72e6
+  metadata.gz: 0b2cac14f5226dc5a7c96642991455c2f33c794d2897669393c095ca350cdae2
+  data.tar.gz: e3d32b4654fc79cfb0fb86e2a33004019142ba6fb523215e2da7692b071879c5
 SHA512:
-  metadata.gz: d95a59af2fcc9fda9ecc953e8156edb826329637ba6c5093af53ddd118e4becff8b65c92a41868a9612e79512cb54e15411a6c6a664c65b75b84e59e1ddd7411
-  data.tar.gz: c469d86e56cbf45d67b3f28966a724f7c6036ed642d30ca218f3d1908429e62929491fed86da69ae1eb6eecb80168720ec8d3c992c94aa7e7e013f48a4d1c3b3
+  metadata.gz: 2e1723a650da1f128a8f3cae5af52ae0f2e7b04845a883a82181f076d47b14b984a26b3ad6cc79ea4c1ce2272b6232531d2892e8790cd202dbcd053d1ccab98f
+  data.tar.gz: 71fc3eed81a924700eddb86a9c1f06c2a3ce0c43cbaf09e64f34c6078e3876f6d5409bbfbb4e37952165db444c866e3ebbbd5daaf63a79b7a725402570705f92

data/.rubocop.yml

@@ -1,5 +1,6 @@
 AllCops:
   TargetRubyVersion: 2.6
+  NewCops: enable
 
 Style/Documentation:
   Enabled: false
@@ -14,3 +15,9 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false

data/Gemfile.lock

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

data/README.md

@@ -1,33 +1,118 @@
-# 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://adventofcode.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
+```
+
+...where `input` is an `Array[String]` of all the lines without newlines.
+
+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,7 +31,7 @@ module AdventOfCode
       private
 
       def cookie
-        @cookie ||= ENV["AOC_COOKIE"]
+        @cookie ||= ENV.fetch("AOC_COOKIE", nil)
       end
 
       def cookie_present?
@@ -46,6 +46,9 @@ module AdventOfCode
 
         request = Net::HTTP::Get.new(url)
         request["Cookie"] = "session=#{cookie}"
+        # The creator of Advent of Code has requested that automated tools send identifying information
+        # when making requests: https://www.reddit.com/r/adventofcode/comments/z9dhtd
+        request["User-Agent"] = "github.com/egiurleo/advent_of_code_cli by emily.samp@icloud.com"
 
         response = https.request(request)
         response.read_body

data/lib/advent_of_code_cli/commands/scaffold.rb

@@ -32,17 +32,17 @@ module AdventOfCode
 
       def solution_file_contents
         <<~RUBY
-        module Day#{day_string}
-          class << self
-            def part_one(input)
-              raise NotImplementedError
-            end
-
-            def part_two(input)
-              raise NotImplementedError
+          module Day#{day_string}
+            class << self
+              def part_one(input)
+                raise NotImplementedError
+              end
+
+              def part_two(input)
+                raise NotImplementedError
+              end
             end
           end
-        end
         RUBY
       end
     end

data/lib/advent_of_code_cli/commands/solve.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'benchmark'
-
 module AdventOfCode
   module Commands
     class Solve < Command
@@ -10,7 +8,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)
@@ -34,7 +32,7 @@ module AdventOfCode
         end_time = Time.now
 
         say "Part #{part} result: #{result}"
-        say "Took #{end_time-start_time} seconds to solve"
+        say "Took #{end_time - start_time} seconds to solve"
       end
     end
   end

data/lib/advent_of_code_cli/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: advent_of_code_cli
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Emily Samp
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-01 00:00:00.000000000 Z
+date: 2022-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -54,6 +54,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/egiurleo/advent_of_code_cli
   source_code_uri: https://github.com/egiurleo/advent_of_code_cli
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -69,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: A CLI tool to scaffold and run Advent of Code solutions.