aoc_rb 0.0.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c55b5953ec5f5609a93d35056a675811dd5777a71514b6f3ed90eb64223212a4
-  data.tar.gz: 1cc0e2404ad5efb0a38b5f4870785089fbd3b9d9edf86f8134cb793f43b47d2b
+  metadata.gz: 9c58f8fae503e8530a04cfb7e3adffab28dda605946ddcd8ca5d3a1eda2efa88
+  data.tar.gz: f6801d662d3ca723f0d88ccf5eda4172f5c172219fbc2eebb99a21442035718c
 SHA512:
-  metadata.gz: f1d9532728421583243011320330aeb9a5279627fd2c05b842ced50b92ff19650cbaf7e31aa336c71d35f80a6f1dc5e02060aafc9dfb6718cde52f519eb845de
-  data.tar.gz: d13d273694aa76935fd809ee3c7a777dbb9ba3449b2a18b411b905c06dd7876961b78e539fa33c4906d7ceaf929c8831615f2d818593cf32900553f6c16be3ff
+  metadata.gz: 6a9646f1149312b0fa36e6de7c473cb34d83458fff21caf85987475848dfd9d3e75c9d8fade76305280b012780d2f91842c0da64b28008c57e164b7677aed4c6
+  data.tar.gz: f0e89fb9eaaee8d28110c94d67ce821309b57835ba3286670426290030ffb1c7ca218212f554c006a64a646971c5a2fdf5476cd48e84239392bf3dc491bac049

data/.github/workflows/tests.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/Gemfile.lock
 
 # rspec failure tracking
 .rspec_status

data/README.md

@@ -1,39 +1,65 @@
 # AocRb
 
-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/aoc_rb`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Tests](https://github.com/pacso/aoc_rb/actions/workflows/tests.yml/badge.svg)](https://github.com/pacso/aoc_rb/actions/workflows/tests.yml)
+[![Gem Version](https://badge.fury.io/rb/aoc_rb.svg)](https://badge.fury.io/rb/aoc_rb)
 
-TODO: Delete this and the text above, and describe your gem
+This gem provides a simple way to create a project for solving [Advent of Code](https://adventofcode.com) puzzles.
 
-## Installation
+It also provides some handy tools to automate your interactions with the Advent of Code website.
 
-Add this line to your application's Gemfile:
+## Getting Started
 
-```ruby
-gem 'aoc_rb'
-```
+First of all, install the gem:
 
-And then execute:
+    $ gem install aoc_rb
 
-    $ bundle install
+Next, generate your Advent of Code project:
 
-Or install it yourself as:
+    $ aoc new my-project-name
+    
+This will generate a new project with the given name. After this you should be ready to go!
 
-    $ gem install aoc_rb
+    $ cd my-project-name
+    $ aoc
+    
+Before running any commands, you must set up your `AOC_COOKIE` environment variable:
 
-## Usage
+    $ cp .env-template .env
 
-TODO: Write usage instructions here
+You'll need to log in to the [Advent of Code](https://adventofcode.com) website and then grab a copy of your session key from your cookies.
+In Chrome you can do this via [chrome settings](chrome://settings/cookies/detail?site=adventofcode.com) by entering `chrome://settings/cookies/detail?site=adventofcode.com` in your address bar. Just click on `session` and copy your key from the `Content` section.
 
-## Development
+Now edit the new `.env` file, so that it looks like the following, replacing `ABCDE12345` with the session key you just copied:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+    AOC_COOKIE=ABCDE12345
 
-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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+You're now able to run all the `aoc` commands provided by this gem.
+    
+You'll see you have a few options when running the `aoc` command within your project.
 
-## Contributing
+`prep` will set everything up for a new daily puzzle. It defaults to the puzzle for today, but you can work with older puzzles by passing the year and day: 
+
+    $ aoc prep 2017 12
+
+This will generate a `challenges/2017/12` folder with an `input.txt` file (your puzzle input), a `part_1.md` file with the instructions for part 1, and a `solution.rb` file for you to use when implementing your solution.
+
+In `spec/2017/12` there will be a `solution_spec.rb` which you can use to write tests for your solution. It's a good idea to use the examples provided in the `part_1.md` to test your solution!
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/aoc_rb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/aoc_rb/blob/master/CODE_OF_CONDUCT.md).
+When you've got a working solution you can see what it generates by running:
+
+    $ aoc exec
+
+Which runs todays solution. For previous days, just like with `prep`, you can provide a date:
+
+    $ aoc exec 2017 12
+    
+If you're happy with the output, you can respond to the prompt and `aoc` will submit your answer for you. If you're successful with part 1, it will automatically download the instructions for part 2 for you.
+
+Rinse & repeat!
+
+## Contributing
 
+Bug reports and pull requests are welcome on GitHub at https://github.com/pacso/aoc_rb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/pacso/aoc_rb/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 

data/aoc_rb.gemspec

@@ -26,10 +26,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "dotenv", "~> 2.7.6"
-  spec.add_dependency "httparty", "~> 0.18.1"
-  spec.add_dependency "thor", "~> 1.0.1"
+  spec.add_dependency "httparty", "~> 0.20.0"
+  spec.add_dependency "thor", "~> 1.1.0"
   spec.add_dependency "rspec", "~> 3.0"
-  spec.add_dependency "nokogiri", "~> 1.10.10"
+  spec.add_dependency "nokogiri", "~> 1.12.5"
 
-  spec.add_development_dependency "webmock", "~> 3.10.0"
+  spec.add_development_dependency "webmock", "~> 3.14.0"
 end

data/lib/aoc_rb/app.rb

@@ -1,5 +1,6 @@
 require "httparty"
 require 'dotenv/load'
+require "fileutils"
 require "thor"
 
 require 'aoc_rb/aoc_api'
@@ -8,8 +9,16 @@ require 'aoc_rb/puzzle_input'
 require 'aoc_rb/puzzle_solution'
 require 'aoc_rb/puzzle_source'
 
-src_files = File.join(Dir.getwd, "challenges", "**", "*.rb")
+shared_files = File.join(Dir.getwd, "challenges", "shared", "**", "*.rb")
+Dir[shared_files].each do |file|
+  if File.exist? file
+    require file
+  else
+    puts "missing file #{file}"
+  end
+end
 
+src_files = File.join(Dir.getwd, "challenges", "20**", "**", "*.rb")
 Dir[src_files].each do |file|
   if File.exist? file
     require file
@@ -71,12 +80,12 @@ module AocRb
     method_option :day, aliases: "-d", type: :numeric, default: Time.now.day
 
     def exec(year = options[:year], day = options[:day])
-      puzzle = AocRb::PuzzleSource.create_puzzle(year, day)
       input = AocRb::PuzzleInput.load(year, day)
+      puzzle = AocRb::PuzzleSource.create_puzzle(year, day, input)
 
       level = Puzzle.instructions_exist?(year, day, :part_2) ? 2 : 1
       puts "#{year} Day #{day}"
-      solution = PuzzleSource.run_part("part #{level}") { puzzle.send("part_#{level}", input) }
+      solution = PuzzleSource.run_part("part #{level}") { puzzle.send("part_#{level}") }
 
       puts "Submit solution? #{solution} (y/N)"
       submit = STDIN.gets.chomp.downcase

data/lib/aoc_rb/app_loader.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'pathname'
+
 module AocRb
   module AppLoader
     extend self

data/lib/aoc_rb/cli.rb

@@ -13,7 +13,7 @@ module AocRb
       project_dir = File.join(Dir.getwd, name)
       if File.exist?(project_dir)
         puts "ERROR: #{project_dir} already exists!"
-        exit 0
+        exit -1
       end
 
       bin_dir = File.join(project_dir, "bin")
@@ -22,6 +22,12 @@ module AocRb
       FileUtils.mkdir_p bin_dir
       File.open(bin_path, "w") { |f| f.write(File.read(bin_template)) }
 
+      shared_dir = File.join(project_dir, "challenges", "shared")
+      solution_path = File.join(shared_dir, "solution.rb")
+      solution_template = File.join(File.dirname(__FILE__), "../../templates/solution_base.rb")
+      FileUtils.mkdir_p shared_dir
+      File.open(solution_path, "w") { |f| f.write(File.read(solution_template)) }
+
       spec_dir = File.join(project_dir, "spec")
       spec_helper_path = File.join(spec_dir, "spec_helper.rb")
       spec_helper_template = File.join(File.dirname(__FILE__), "../../templates/spec/spec_helper.rb")

data/lib/aoc_rb/puzzle_input.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module AocRb
   module PuzzleInput
     extend self

data/lib/aoc_rb/puzzle_solution.rb

@@ -6,9 +6,9 @@ module AocRb
 
     def submit(level, year, day, answer = nil, allow_waiting = true)
       if answer.nil?
-        puzzle   = PuzzleSource.create_puzzle(year, day)
         input    = PuzzleInput.load(year, day)
-        answer = level == 1 ? puzzle.part_1(input) : puzzle.part_2(input)
+        puzzle   = PuzzleSource.create_puzzle(year, day, input)
+        answer = level == 1 ? puzzle.part_1 : puzzle.part_2
       end
 
       aoc_api  = AocApi.new(ENV['AOC_COOKIE'])

data/lib/aoc_rb/puzzle_source.rb

@@ -5,10 +5,10 @@ module AocRb
   module PuzzleSource
     extend self
 
-    def create_puzzle(year, day)
+    def create_puzzle(year, day, input)
       padded_day = Puzzle.padded(day)
       begin
-        Module.const_get("Year#{year}").const_get("Day#{padded_day}").new
+        Module.const_get("Year#{year}").const_get("Day#{padded_day}").new(input)
       rescue NameError
         puts "There is no solution for this puzzle"
       end

data/lib/aoc_rb/version.rb

@@ -1,3 +1,3 @@
 module AocRb
-  VERSION = "0.0.0"
+  VERSION = "0.2.1"
 end

data/templates/solution.rb.erb

@@ -1,12 +1,26 @@
 # frozen_string_literal: true
 module Year<%= @year %>
-  class Day<%= @day %>
-    def part_1(input)
+  class Day<%= @day %> < Solution
+    # @input is available if you need the raw data input
+    # Call `data` to access either an array of the parsed data, or a single record for a 1-line input file
+
+    def part_1
       nil
     end
 
-    def part_2(input)
+    def part_2
       nil
     end
+
+    private
+      # Processes each line of the input file and stores the result in the dataset
+      # def process_input(line)
+      #   line.map(&:to_i)
+      # end
+
+      # Processes the dataset as a whole
+      # def process_dataset(set)
+      #   set
+      # end
   end
 end

data/templates/solution_base.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true %>
+
+class Solution
+  def self.part_1(*input)
+    new(*input).part_1
+  end
+
+  def self.part_2(*input)
+    new(*input).part_2
+  end
+
+  def initialize(input)
+    @input = input
+  end
+
+  def data
+    @data ||= begin
+                processed = @input.lines(chomp: true).map do |line|
+                  process_input line
+                end
+
+                processed.length == 1 ? processed.first : process_dataset(processed)
+              end
+  end
+
+  private
+    def process_input(line)
+      line
+    end
+
+    def process_dataset(set)
+      set
+    end
+end

data/templates/solution_spec.rb.erb

@@ -2,7 +2,6 @@
 require 'spec_helper'
 
 RSpec.describe Year<%= @year %>::Day<%= @day %> do
-  let(:puzzle) { Year<%= @year %>::Day<%= @day %>.new }
   let(:input) { File.read(File.join(File.dirname(__FILE__), "../../../challenges/<%= @year %>/<%= @day.to_s.rjust(2, "0") %>/input.txt")) }
   let(:example_input) {
     <<~EOF
@@ -13,21 +12,21 @@ RSpec.describe Year<%= @year %>::Day<%= @day %> do
 
   describe "part 1" do
     it "returns nil for the example input" do
-      expect(puzzle.part_1(example_input)).to eq(nil)
+      expect(described_class.part_1(example_input)).to eq(nil)
     end
 
     it "returns nil for my input" do
-      expect(puzzle.part_1(input)).to eq(nil)
+      expect(described_class.part_1(input)).to eq(nil)
     end
   end
 
   describe "part 2" do
     it "returns nil for the example input" do
-      expect(puzzle.part_2(example_input)).to eq(nil)
+      expect(described_class.part_2(example_input)).to eq(nil)
     end
 
     it "returns nil for my input" do
-      expect(puzzle.part_2(input)).to eq(nil)
+      expect(described_class.part_2(input)).to eq(nil)
     end
   end
 end

data/templates/spec/spec_helper.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
-Dir[File.join(File.dirname(__FILE__), "..", "challenges", "**", "*.rb")].each do |file|
+Dir[File.join(File.dirname(__FILE__), "..", "challenges", "shared", "**", "*.rb")].each do |file|
+  require file
+end
+
+Dir[File.join(File.dirname(__FILE__), "..", "challenges", "20*", "**", "*.rb")].each do |file|
   require file
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aoc_rb
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Jon Pascoe
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-02 00:00:00.000000000 Z
+date: 2021-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.1
+        version: 0.20.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.1
+        version: 0.20.0
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -72,28 +72,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.10
+        version: 1.12.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.10
+        version: 1.12.5
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.14.0
 description: Tools for creating a new project for your Advent of Code solutions, built
   using Ruby.
 email:
@@ -103,12 +103,11 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - LICENSE.txt
 - README.md
@@ -131,6 +130,7 @@ files:
 - templates/Gemfile
 - templates/bin/aoc
 - templates/solution.rb.erb
+- templates/solution_base.rb
 - templates/solution_spec.rb.erb
 - templates/spec/spec_helper.rb
 homepage: https://github.com/pacso/aoc_rb
@@ -155,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: A Ruby toolkit for Advent of Code

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.7.0
-before_install: gem install bundler -v 2.1.2

data/Gemfile.lock

@@ -1,62 +0,0 @@
-PATH
-  remote: .
-  specs:
-    aoc_rb (0.0.0)
-      dotenv (~> 2.7.6)
-      httparty (~> 0.18.1)
-      nokogiri (~> 1.10.10)
-      rspec (~> 3.0)
-      thor (~> 1.0.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    byebug (11.1.3)
-    crack (0.4.4)
-    diff-lcs (1.4.4)
-    dotenv (2.7.6)
-    hashdiff (1.0.1)
-    httparty (0.18.1)
-      mime-types (~> 3.0)
-      multi_xml (>= 0.5.2)
-    mime-types (3.3.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2020.1104)
-    mini_portile2 (2.4.0)
-    multi_xml (0.6.0)
-    nokogiri (1.10.10)
-      mini_portile2 (~> 2.4.0)
-    public_suffix (4.0.6)
-    rake (12.3.3)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.0)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.0)
-    thor (1.0.1)
-    webmock (3.10.0)
-      addressable (>= 2.3.6)
-      crack (>= 0.3.2)
-      hashdiff (>= 0.4.0, < 2.0.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  aoc_rb!
-  byebug
-  rake (~> 12.0)
-  webmock (~> 3.10.0)
-
-BUNDLED WITH
-   2.1.4