aoc_cli 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9fd67606e3738d60e1a45a761ffd1bf6dec09520ff84806f2229dd10f69eb6b3
+  data.tar.gz: '09d5c4d55577546d743f0ea4aafee798303a9807851af02c73903d24a1be3ffb'
+SHA512:
+  metadata.gz: bc10df6bdf33971314fedf6511fe85d0cf871bb61af2c2828218991bdcf0fa83ac6adec3027e884c88af4a80c9bcfeba3740e8379066557f0f85b040927cc41e
+  data.tar.gz: 4f18b284284dc1c537f242860a07942cdc8ada757bf85f768d478cfd3a43c487986297d54e1a873b73622022ff405a1ddc5488b715f6b6a62327d95fe10248e4

data/.gitignore

@@ -0,0 +1 @@
+tags

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in aoc_cli.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+#gem "pandoc-ruby"
+#gem "curb"
+#gem "colorize"
+#gem "rspec"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Christian Welham
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,282 @@
+# `Advent of Code - cli`
+
+![](https://github.com/apexatoll/aoc-files/blob/master/demo2.gif)
+
+A command-line interface to interact with Advent of Code puzzles, built in Ruby.
+
+
+## Main Features
+- Download puzzles as markdown and raw inputs directly from the command line
+- Submit answers for puzzles and receive feedback
+- Track progress through your calendar file which is automatically updated as you progress
+- View data about how you answer puzzles, for example your previous attempts, how long it takes to solve a puzzle successfully and how many attempts it took you
+- Inputs and puzzles are cached locally to prevent strain on AoC server
+- Hot keys to open solution megathreads in Reddit if you get stuck
+- Support for multiple AoC accounts by use of session-key aliases
+
+
+## Installation
+
+Install gem
+
+```bash
+$ gem install aoc_cli`
+```
+
+Manual install
+
+```bash
+$ git clone "https://github.com/apexatoll/aoc-cli"
+$ cd aoc-cli
+$ rake build install
+```
+
+## Setup
+
+### Finding your Session Key
+
+To use aoc-cli you must first find and store your unique session cookie. To find this, log into the Advent of Code website as usual and load any page. 
+
+Open developer tools and open the network tab. Refresh the page and you should see a file that contains your session cookie.
+
+It will contain a field that looks something like:
+
+```
+cookie: session=ALPHANUMERIC STRING
+```
+
+This is unique to your account, and allows aoc-cli to interact with the AoC server - do not share this!
+
+
+### Storing your Session Key
+
+- Copy the session key (including "session=") to the clipboard and open your terminal
+- Run the following command
+
+```bash
+aoc -k "your key" 
+
+```
+
+- AoC-cli stores this key under the alias 'main' by default. 
+- To store the key under a different alias use the `-u` or `--user` flags followed by the desired alias.
+- Session keys are stored in the aoc config file located at `~/.config/aoc-cli/aoc.rc`.
+
+- Keys can be stored manually in your config file using the format:
+
+```bash
+cookie=>$alias=>$key
+```
+
+For example:
+
+```bash
+cookie=>account2=>1234abc
+```
+
+### Default Alias
+
+aoc-cli allows for multiple keys to be stored within the config file. 
+
+By default, the key under the "main" alias is used when initialising year directories and another alias is not specified
+
+To see which alias is currently deafult run `aoc -U` or `aoc --default`
+
+- You can update the default alias by running 
+
+```bash
+aoc -U $new_default_alias
+```
+
+For example:
+
+```bash
+aoc -U account2
+```
+
+Alternatively you could add the following line to your config file
+
+```bash
+default=>account2
+```
+
+## Usage
+
+aoc-cli is designed to run in a file-tree generated by the interface. 
+
+There are two types of directories
+1. Year directories
+	- These contain your calendar and all day subdirectories
+2. Day subdirectories
+	- These contain the puzzles, your input and your code
+
+
+## Initialising the Year
+
+To begin using the cli you must first initialise the year directory. 
+
+aoc-cli will intialise within your current working directory, so first create a directory for the year and cd into it
+
+```bash
+mkdir 2020
+cd 2020
+```
+- Initialise the year directory using the command 
+
+```bash
+aoc -y 2020
+```
+
+This will set the session key for the year directory to the default alias. To use a different AoC account run:
+
+```bash
+aoc -y 2020 -u $alias
+```
+
+This command will create necessary metafiles, download the year calendar and fill it with your current progress (if any). This is stored in a markdown file in the year directory.
+
+By default, your stats in the leaderboard are also added to this file. To turn this off add the line `include_leaderboard=>false` to your config file.
+
+
+## Initialising a Day
+
+You can now get day data! 
+
+To fetch puzzle instructions and inputs you can run the following command from within the year directory
+
+```bash
+aoc -d $day_number
+```
+
+This command performs the following actions
+
+- Creates a day subdirectory
+- Fetches the puzzle as markdown
+- Fetches raw puzzle input
+- The time you downloaded the puzzle is logged
+
+All puzzles and inputs are cached in aoc-cli on a per-user basis. This means that if you have previously initialised this day under this alias before, your puzzle and input will be transferred from the cache locally rather than downloading from the aoc server.
+
+
+## Solving Puzzles
+
+From the day subdirectory you can attempt to solve puzzles by running the command 
+
+```bash
+aoc -s $answer
+```
+
+You will then receive one of three responses
+
+1. The answer is correct
+2. The answer is not correct
+3. You have time to wait before submitting an answer
+
+If your answer is correct, aoc-cli will automatically update the puzzle instructions and your calendar file. Additionally aoc-cli will calculate how long and how many attempts it took to solve the puzzle (see the Tables section)
+
+Incorrect attempts will be logged along with any hint as to whether your answer was too high or too low. 
+
+If you have sent multiple incorrect attempts AoC will ask you to wait before trying again - be patient!
+
+
+## Tables
+
+aoc-cli uses a local database to store information about your progress with puzzles. There are two main databases of use:
+
+1. Your attempts
+2. Your stats
+
+
+### Attempts
+
+Previous attempts for a puzzle can be viewed from the day directory by the use of the command
+
+```bash
+aoc -a 
+```
+
+To specify which attempts to show from outside the day subdirectory you can use the command
+
+```bash
+aoc -a -u $user_alias -Y $year -D $day -p $part
+```
+
+Data is shown in a formatted table with incorrect attempts shown in red and the correct answer in green.
+
+![](https://github.com/apexatoll/aoc-files/blob/master/attempts.png)
+
+### Stats
+
+aoc-cli also tracks data related to your performance in puzzles, namely:
+- The time taken to complete a puzzle
+- How many attempts it took
+
+To view this, run the following command from the day subdirectory
+
+```bash
+aoc -S 
+```
+
+To view the stats for the year as a whole run the same command from the year directory. Flags can be also be added manually for showing data for other users, years and days in a similar way to that of the attempts table
+
+![](https://github.com/apexatoll/aoc-files/blob/master/stats.png)
+
+## Reddit Integration
+
+You can run the command `aoc -R` from the day subdirectory, or by manual flags to open the solution megathread for the specified day in Reddit
+
+If one is installed, aoc-cli will default to opening the thread within a reddit-clu such as RTV or TTRV. If one isn't found however, the thread will be opened within your default browser.
+
+To always open megathread in your browser run
+
+```bash
+aoc -B true
+```
+
+## Vim Integration
+
+if you use vim you may wish to set a keybinding to automatically run your code and submit it for validation once you have solved a puzzle.
+
+Using Ruby as an example, you could add the following line to your .vimrc:
+
+```vim
+autocmd filetype ruby nmap <silent><leader>ac :! aoc -s $(ruby %)<CR>
+```
+
+Executing leader + ac would then run your program and send the answer to the server for verification (as long as your program only outputs an answer and no other text). 
+
+Do not send endless attempts - only send when you are comfortable with your answer!
+ 
+
+## All Flags
+
+| Flag Short | Flag Long      | Action                                    |
+|------------|----------------|-------------------------------------------|
+| `-a`       | `--attempts`   | Print attempts table                      |
+| `-b`       | `--in-browser` | Open reddit in browser                    |
+| `-d`       | `--init-day`   | Initialise day subdirectory               |
+| `-h`       | `--help`       | Show help screen                          |
+| `-k`       | `--key`        | Store session key                         |
+| `-p`       | `--part`       | Specify part for aoc command              |
+| `-r`       | `--refresh`    | Refresh calendar (year dir)               |
+|            |                | Refresh puzzle (day subdir)               |
+| `-s`       | `--solve`      | Solve puzzle                              |
+| `-u`       | `--user`       | Specify alias for aoc command             |
+| `-y`       | `--init-year`  | Initialise year directory                 |
+| `-B`       | `--browser`    | View reddit browser setting (no argument) |
+|            |                | Set reddit browser (with argument)        |
+| `-D`       | `--day`        | Specify day for aoc command               |
+| `-R`       | `--reddit`     | Open solution megathread                  |
+| `-S`       | `--stats`      | Print stats table                         |
+| `-U`       | `--default`    | View default alias (no argument)          |
+|            |                | Set default alias (with argument)         |
+| `-Y`       | `--year`       | Specify year for aoc command              |
+
+
+## Acknowledgments
+
+I am in no way affiliated with AoC, but I would like to take this opportunity to thank the creator Eric Wastl for the taking the time and great effort to produce these fantastic puzzles!
+
+Please note that requests are hard-coded to be throttled to a maximum of 1 HTTP request per 5 seconds. This is to ensure that the AoC server is not overloaded with requests. Please do not try and change this - it is to protect the server!
+
+Please let me know if there are any bugs or issues with the cli within the issues section - I will try to address them as quickly as I can

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+require "bundler/gem_tasks"
+task default: %i[]

data/aoc_cli.gemspec

@@ -0,0 +1,30 @@
+require_relative "lib/aoc_cli/version"
+
+Gem::Specification.new do |spec|
+	spec.name    = "aoc_cli"
+	spec.version = AocCli::VERSION
+	spec.authors = ["Christian Welham"]
+	spec.email   = ["welhamm@gmail.com"]
+	spec.summary = "A command-line interface for the Advent of Code puzzles"
+	spec.description = "A command-line interface for the Advent of Code puzzles. Features include downloading puzzles and inputs, solving puzzles and tracking year progress from within the terminal"
+	spec.homepage = "https://github.com/apexatoll/aoc-cli"
+	spec.license = "MIT"
+	spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+	spec.metadata["homepage_uri"] = spec.homepage
+	spec.metadata["source_code_uri"] = "https://github.com/apexatoll/aoc-cli"
+	spec.metadata["changelog_uri"] = "https://github.com/apexatoll/aoc-cli/changelog.md"
+	spec.files = Dir.chdir(File.expand_path(__dir__)) do
+		`git ls-files -z`
+			.split("\x0")
+			.reject{|f| f.match(%r{\A(?:test|spec|features)/}) }
+	end
+	spec.bindir = "bin"
+	spec.executables << 'aoc'
+	spec.require_paths = ["lib"]
+	spec.add_dependency("colorize")
+	spec.add_dependency("curb")
+	spec.add_dependency("json")
+	spec.add_dependency("pandoc-ruby")
+	spec.add_dependency("sqlite3")
+	spec.add_dependency("terminal-table")
+end

data/bin/aoc

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/aoc_cli.rb'
+AocCli::Interface::Query.new

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "aoc_cli"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/aoc_cli.rb

@@ -0,0 +1,22 @@
+require 'colorize'
+require 'json'
+require 'sqlite3'
+
+require_relative 'aoc_cli/errors'
+require_relative 'aoc_cli/interface'
+require_relative "aoc_cli/version"
+require_relative 'aoc_cli/files'
+require_relative 'aoc_cli/commands'
+require_relative 'aoc_cli/tools'
+require_relative 'aoc_cli/year'
+require_relative 'aoc_cli/day'
+require_relative 'aoc_cli/solve'
+require_relative 'aoc_cli/database'
+require_relative 'aoc_cli/paths'
+require_relative 'aoc_cli/tables'
+
+module AocCli
+	Metafile = AocCli::Files::Metafile
+	Validate = AocCli::Interface::Validate
+	E = AocCli::Errors
+end

data/lib/aoc_cli/commands.rb

@@ -0,0 +1,215 @@
+module AocCli
+	module Commands
+		class KeyStore
+			attr_reader :user, :key
+			def initialize(args)
+				args = defaults.merge(args).compact
+				@user, @key = args[:user], args[:key]
+			end
+			def exec
+				Files::Cookie.new(u:user).store(key:key)
+				self
+			end
+			def respond
+				puts "Key added successfully"
+			end
+			def defaults
+				{user:Files::Config.new.def_acc}
+			end
+		end
+		class YearInit
+			attr_reader :user, :year
+			def initialize(args)
+				args = defaults.merge(args).compact
+				@user, @year = args[:user], args[:year]
+			end
+			def exec
+				Year::Init
+					.new(u:user, y:year)
+					.write
+				Year::Stars
+					.new(u:user, y:year)
+					.write.update_meta
+				self
+			end
+			def respond
+				puts "Year initialised"
+			end
+			def defaults
+				{user:Files::Config.new.def_acc}
+			end
+		end
+		class DayInit
+			attr_reader :user, :year, :day
+			def initialize(args)
+				args  = defaults.merge(args).compact
+				@user = args[:user]
+				@year = args[:year]
+				@day  = args[:day]
+			end
+			def exec
+				Day::Init
+					.new(u:user, y:year, d:day)
+					.mkdir
+					.write
+					#.init_db
+				Day::Pages
+					.new(u:user, y:year, d:day)
+					.write
+				self
+			end
+			def defaults
+				{user:Metafile.get(:user), 
+				 year:Metafile.get(:year)}
+			end
+			def respond
+				puts "Day #{day} initialised"
+			end
+		end
+		class DaySolve
+			attr_reader :user, :year, :day, :part, :ans
+			def initialize(args)
+				args  = defaults.merge(args).compact
+				@user = args[:user]
+				@year = args[:year]
+				@day  = args[:day]
+				@part = args[:part]
+				@ans  = args[:ans]
+			end
+			def exec 
+				Solve::Attempt
+					.new(u:user, y:year, d:day, p:part, a:ans)
+					.respond
+				self
+			end
+			def defaults
+				{user:Metafile.get(:user),
+				 year:Metafile.get(:year),
+				  day:Metafile.get(:day),
+				 part:Metafile.get(:part)}
+			end
+		end
+		class OpenReddit
+			attr_reader :year, :day, :browser
+			def initialize(args)
+				args  = defaults.merge(args).compact
+				@year = Validate.year(args[:year])
+				@day  = Validate.day(args[:day])
+				@browser = args[:browser]
+			end
+			def exec
+				Day::Reddit.new(y:year, d:day, b:browser).open
+				self
+			end
+			def defaults
+				{year:Metafile.get(:year),
+				 day:Metafile.get(:day),
+				 browser:Files::Config
+					.new.get_bool(key:"browser")}
+			end
+		end
+		class DefaultUser
+			attr_reader :user, :mode
+			def initialize(args)
+				@user = args[:user]
+				@mode = user.nil? ? :get : :set
+			end
+			def exec
+				case mode
+				when :get then get_default
+				when :set then set_default end
+				self
+			end
+			def get_default
+				puts "Current default alias: "\
+					 "#{(Files::Config.new
+						.get_line(key:"default") || "main")
+						.to_s.yellow}"
+			end
+			def set_default
+				Files::Config.new.mod_line(
+					key:"default", 
+					val:Validate.user(user))
+				puts "Default account succesfully changed to "\
+					 "#{user.yellow}"
+			end
+		end
+		class DefaultReddit
+			attr_reader :value, :mode
+			def initialize(args)
+				@value = args[:value]
+				@mode = value.nil? ? :get : :set
+			end
+			def exec
+				case mode
+				when :get then get_default
+				when :set then set_default
+				end
+			end
+			def get_default
+				puts "Always open Reddit in browser? "\
+					 "#{Files::Config.new
+						.get_bool(key:"browser")
+						.to_s.yellow}"
+			end
+			def set_default
+				Files::Config.new.mod_line(
+					key:"browser", val:value)
+				puts "Reddit browser setting changed to "\
+					 "#{value.yellow}"
+			end
+		end
+		class Refresh
+			attr_reader :dir
+			def initialize(args)
+				@dir = Metafile.type
+			end
+			def exec
+				case dir
+				when :DAY  then Day.refresh
+				when :ROOT then Year.refresh end
+				self
+			end
+		end
+		class AttemptsTable
+			attr_reader :user, :year, :day, :part
+			def initialize(args)
+				args = defaults.merge(args).compact
+				@user = args[:user]
+				@year = args[:year]
+				@day  = args[:day]
+				@part = args[:part]
+			end
+			def exec
+				Tables::Attempts
+					.new(u:user, y:year, d:day, p:part).show
+				self
+			end
+			def defaults
+				{user:Metafile.get(:user),
+				 year:Metafile.get(:year),
+				  day:Metafile.get(:day),
+				 part:Metafile.get(:part)}
+			end
+		end
+		class StatsTable
+			attr_reader :user, :year, :day
+			def initialize(args)
+				args = defaults.merge(args).compact
+				@user = args[:user]
+				@year = args[:year]
+				@day  = args[:day]
+			end
+			def exec
+				day.nil? ?
+					Tables::Stats::Year.new(u:user, y:year).print :
+					Tables::Stats::Day.new(u:user, y:year, d:day).print
+			end
+			def defaults
+				{ user:Metafile.get(:user),
+				  year:Metafile.get(:year),
+				   day:Metafile.get(:day) }
+			end
+		end
+	end
+end