aoc_cli 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24c94cfdcb4cde6a75876adf800bd44f835807df5bfab2ea0039e122fe6cc385
-  data.tar.gz: b0b7e88af483fb95d1f497a984befeaf753e498ff7a2be4dc382859d7a67648f
+  metadata.gz: 3acf7f6fddbd91d2dbdb7e3407eafd03cdb3881c4accd09449c6781f0079ab6b
+  data.tar.gz: d117b869b63189c82829f81009c6c9081bb1beb2c61575340c230275ec54c9c2
 SHA512:
-  metadata.gz: bd6c31e93df159af99140002bd6d49ef15cd56eb194f3df9b79355180310586e831420203960988ea4376bb9779dbf5f2599f77e9ce1cc82ecc309d514fcf160
-  data.tar.gz: 93ccea0cfb58bce12f45676defa5294a85b1abea90cd24a41afa9ad1a8b20491d11d4765b0328c2bfed534ac7ef052c503e6d51b7837e8a2061d39cd5644a9fa
+  metadata.gz: a1b18d80a79c09e48edc79d181cd3512cc274ab267f9d4448696f84db1e71a7a3a2c556f83044b15c538c2584e4a675cbdab3ab561c51b9f9e35de3d62b75455
+  data.tar.gz: 1ee697aa72eb8022b9fddf6d2a3b200c9ee548c56cbc32578330edc22c67ec1ec6e16255edcdbca741f382224a26dec4858a4b89a70d040f019634070bd32e8f

data/.gitignore

@@ -1 +1,3 @@
 tags
+pkg/**
+pkg

data/CHANGELOG.md

@@ -1,4 +1,20 @@
-17-02-21
-	0.1.2
+## 17-02-21
+### 0.1.2
 	- Add changelog
 	- Add user-agent
+
+## 20-02-21 
+###0.2.0
+	- Add calendar tables
+		- Star progress now based off this database rather than meta json
+	- Add cat of calendar from any directory
+	- Auto generate config file
+	- Better key validation
+	- Better default alias handling
+		- List all aliases
+	- Rehaul of year initialisation
+	- Expand config integration
+		- Ability to turn on/off calendar writing
+		- Turn on/off leaderboard stats in calendar file
+	- Git integration
+	- General refactor

data/Gemfile

@@ -1,12 +1,4 @@
-# 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/README.md

@@ -4,6 +4,17 @@
 
 A command-line interface to interact with Advent of Code puzzles, built in Ruby.
 
+## New to 0.2.0
+- Calendar progress tables
+- Quick-print calendar from any directory
+- Configuration expansion
+	- Auto-generate config file
+	- Turn on/off creation of calendar file
+	- Turn on/off leaderboard stats in calendar file
+	- Basic git integration
+- Better key validation
+- Better default alias handling
+- General bug fixes
 
 ## Main Features
 - Download puzzles as markdown and raw inputs directly from the command line
@@ -11,6 +22,7 @@ A command-line interface to interact with Advent of Code puzzles, built in Ruby.
 - 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
+- Automatic git initialisation
 - Hot keys to open solution megathreads in Reddit if you get stuck
 - Support for multiple AoC accounts by use of session-key aliases
 
@@ -19,6 +31,7 @@ A command-line interface to interact with Advent of Code puzzles, built in Ruby.
 
 - aoc-cli uses Pandoc, make sure it is [installed](https://pandoc.org/installing.html)
 - Homebrew users can run `brew install pandoc`
+- Mac OS users need to make sure developer tools is installed (thank you yspreen)
 
 Install gem
 
@@ -45,7 +58,7 @@ Open developer tools and open the network tab. Refresh the page and you should s
 It will contain a field that looks something like:
 
 ```
-cookie: session=ALPHANUMERIC STRING
+cookie: session=HEXADECIMAL_STRING
 ```
 
 This is unique to your account, and allows aoc-cli to interact with the AoC server - do not share this!
@@ -61,28 +74,26 @@ aoc -k $your_key
 
 ```
 
-- AoC-cli stores this key under the alias 'main' by default. 
+- AoC-cli stores this key under the alias 'main' if no custom alias is specified
 - 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:
+Keys can also be stored manually in your config file using the format:
 
-```bash
+```
 cookie=>$alias=>$key
 ```
 
 For example:
 
-```bash
-cookie=>account2=>1234abc
+```
+cookie=>account2=>session=123abc
 ```
 
 ### 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 
@@ -91,16 +102,31 @@ To see which alias is currently deafult run `aoc -U` or `aoc --default`
 aoc -U $new_default_alias
 ```
 
-For example:
+By default, aoc-cli will determine the default alias in the following order of precedence
+
+- The alias explicitly set by `default=>$alias` in your config file or by using the `-U` command
+- The `main` alias (if it exists)
+- The first key in your config file
+
+### Use Case
+
+Say for example you wanted to learn a new language and decided to try out Advent of Code from scratch to get stuck in. You could set up a new account and grab the session key, which for example is `abc123`
+
+Lets use Ruby as our new language. You could then store this new key under the alias `ruby`
 
 ```bash
-aoc -U account2
+aoc -k session=abc123 -u ruby
 ```
 
-Alternatively you could add the following line to your config file
+You could then set `ruby` as your default alias so that you do not have to specify `-u ruby` explicitly when initialising a year directory each time
 
 ```bash
-default=>account2
+aoc -U ruby
+```
+Alternatively you could add the following line to your config file
+
+```
+default=>ruby
 ```
 
 ## Usage
@@ -118,19 +144,19 @@ There are two types of directories
 
 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
+aoc-cli will intialise within your current working directory, so first create a directory for the year and change directory into it
 
 ```bash
 mkdir 2020
 cd 2020
 ```
-- Initialise the year directory using the command 
+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:
+This will set the session key for the year directory to the default alias. To use a different alias run:
 
 ```bash
 aoc -y 2020 -u $alias
@@ -138,8 +164,9 @@ 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. 
+By default, your stats in the leaderboard are also added to this file. This can be changed - see Configuration
 
+aoc-cli can also intialise a git directory on year intialisation (turned off by default)
 
 ## Initialising a Day
 
@@ -158,7 +185,7 @@ This command performs the following actions
 - 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.
+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 the same alias before, your puzzle and input will be transferred from the cache locally rather than downloading from the aoc server.
 
 
 ## Solving Puzzles
@@ -184,18 +211,20 @@ If you have sent multiple incorrect attempts AoC will ask you to wait before try
 
 ## Tables
 
-aoc-cli uses a local database to store information about your progress with puzzles. There are two main databases of use:
+aoc-cli uses a local database to store information about your progress with puzzles. This tracks data on:
 
 1. Your attempts
 2. Your stats
+3. Your progress in the year
 
+This data can be visualised in terminal-friendly tables
 
 ### Attempts
 
 Previous attempts for a puzzle can be viewed from the day directory by the use of the command
 
 ```bash
-aoc -a 
+aoc -a (--attempts)
 ```
 
 To specify which attempts to show from outside the day subdirectory you can use the command
@@ -208,34 +237,66 @@ Data is shown in a formatted table with incorrect attempts shown in red and the
 
 ![](https://github.com/apexatoll/aoc-files/blob/master/attempts.png)
 
+You need to specify the part explicitly using `-p` or `--part` to view attempts for puzzles that are already completed 
+
 ### 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
+To view stats on a specific puzzle run the following command from the day subdirectory
 
 ```bash
-aoc -S 
+aoc -S (--stats)
 ```
 
-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
+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
+### Progress
 
-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
+To view your progress in the year you can run the commands
 
-If one is installed, aoc-cli will default to opening the thread within a reddit-cli such as RTV or TTRV. If one isn't found however, the thread will be opened within your default browser.
+```bash
+aoc -c (--simple-cal)
+```
+
+This will print a simple table showing your stars for each day. This is created on year initialisation and updated as you complete puzzles
 
-To always open megathread in your browser run
+If you have calendar_file set to true in your configuration (default setting), you can quickly print your calendar file by using the command 
 
 ```bash
-aoc -B true
+aoc -C (--fancy-cal)
 ```
 
+![calendars](https://github.com/apexatoll/aoc-files/blob/master/calendars.gif)
+
+## Reddit Integration
+
+![reddit](https://github.com/apexatoll/aoc-files/blob/master/reddit.gif)
+
+You can run the command `aoc -R (--reddit)` 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-cli such as [rtv](https://github.com/michael-lazar/rtv) or [ttrv](https://github.com/tildeclub/ttrv). 
+
+If one isn't found however, the thread will be opened within your default browser.
+
+To open the reddit megathread in your browser, regardless of whether you have a CLI installed, run `aoc -B (--browser)`
+
+## Git Integration
+
+aoc-cli currently supports basic integration with git. At present aoc-cli can:
+- Initialise a git directory on year initialisation
+- Create a gitignore file
+	- Configurable to add markdown and metafiles by default
+
+These settings can be configured in your config file (see configuration)
+
 ## 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.
@@ -247,39 +308,63 @@ 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!
  
+## Configuration
 
-## All Flags
+aoc-cli can be configured using a the config file at `~/.config/aoc-cli/aoc.rc`
+
+To generate an example configuration file you can run `aoc -G` or `aoc --gen-config`. (Note this will throw an error if `~/.config/aoc-cli/aoc.rc` already exists)
 
-| 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              |
+There is also an example aoc.rc file in the `sample` directory of this repo
 
+Settings are added to the aoc-cli config file in the format
+
+```
+setting_name=>setting
+```
+
+Lines can be commented out of the rc file by prefixing with `//`
+
+### List of Configurable Options
+
+| Flag              | Type   | Description                                                   | Default |
+|-------------------|--------|---------------------------------------------------------------|---------|
+| calendar_file     | bool   | Write calendar as a markdown file                             | true    |
+| default           | string | Default alias                                                 | main    |
+| ignore_md_files   | bool   | Auto add md files (calendar and puzzles) to gitignore         | true    |
+| ignore_meta_files | bool   | Auto add meta files to gitignore                              | true    |
+| init_git          | bool   | Initialise a git repository on year initialisation            | false   |
+| lb_in_calendar    | bool   | Include leaderboard stats in calendar file                    | true    |
+| reddit_in_browser | bool   | Always open reddit links in browser                           | false   |
+| unicode_tables    | bool   | Display tables in unicode format. Otherwise ascii format used | true    |
+
+
+## All Flags
+
+| Flag Short | Flag Long      | Action                                               |
+|------------|----------------|------------------------------------------------------|
+| `-a`       | `--attempts`   | Print attempts table                                 |
+| `-B`       | `--browser`    | View reddit megathread in your browser               |
+| `-c`       | `--simple-cal` | Print simplified calendar progress                   |
+| `-C`       | `--fancy-cal`  | Print styled calendar (requires calendar_file=>true) |
+| `-d`       | `--init-day`   | Initialise day subdirectory                          |
+| `-D`       | `--day`        | Manual day specification for aoc command             |
+| `-G`       | `--gen-config` | Write example config file                            |
+| `-h`       | `--help`       | Show help screen                                     |
+| `-k`       | `--key`        | Store session key                                    |
+| `-p`       | `--part`       | Manual part specification for aoc command            |
+| `-r`       | `--refresh`    | Refresh calendar (year dir)                          |
+|            |                | Refresh puzzle (day subdir)                          |
+| `-R`       | `--reddit`     | Open solution megathread                             |
+| `-s`       | `--solve`      | Solve puzzle                                         |
+| `-S`       | `--stats`      | Print stats table                                    |
+| `-u`       | `--user`       | Specify alias for aoc command                        |
+| `-U`       | `--default`    | View default alias, list all aliases (no argument)   |
+| `-y`       | `--init-year`  | Initialise year directory                            |
+| `-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/aoc_cli.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
 	spec.require_paths = ["lib"]
 	spec.add_dependency("colorize")
 	spec.add_dependency("curb")
-	spec.add_dependency("json")
+	spec.add_dependency("git")
 	spec.add_dependency("pandoc-ruby")
 	spec.add_dependency("sqlite3")
 	spec.add_dependency("terminal-table")

data/bin/setup

@@ -3,6 +3,5 @@ set -euo pipefail
 IFS=$'\n\t'
 set -vx
 
-bundle install
 
-# Do any other automated setup that you need to do here
+bundle install

data/lib/aoc_cli.rb

@@ -1,5 +1,4 @@
 require 'colorize'
-require 'json'
 require 'sqlite3'
 
 require_relative 'aoc_cli/errors'
@@ -17,6 +16,7 @@ require_relative 'aoc_cli/tables'
 
 module AocCli
 	Metafile = AocCli::Files::Metafile
+	Prefs    = AocCli::Files::Config::Prefs
 	Validate = AocCli::Interface::Validate
 	E = AocCli::Errors
 end

data/lib/aoc_cli/commands.rb

@@ -7,36 +7,34 @@ module AocCli
 				@user, @key = args[:user], args[:key]
 			end
 			def exec
-				Files::Cookie.new(u:user).store(key:key)
+				Files::Config::Cookie.store(user:user, key:key)
 				self
 			end
 			def respond
 				puts "Key added successfully"
 			end
 			def defaults
-				{user:Files::Config.new.def_acc}
+				{ user:"main" }
 			end
 		end
 		class YearInit
-			attr_reader :user, :year
+			attr_reader :user, :year, :git
 			def initialize(args)
 				args = defaults.merge(args).compact
-				@user, @year = args[:user], args[:year]
+				@user, @year, @git = args[:user], args[:year], args[:git]
 			end
 			def exec
-				Year::Init
-					.new(u:user, y:year)
-					.write
-				Year::Stars
-					.new(u:user, y:year)
-					.write.update_meta
+				Year::Meta.new(u:user, y:year).write
+				Year::Progress.new(u:user, y:year).write.init_calendar_db
+				Year::GitWrap.new if git
 				self
 			end
 			def respond
-				puts "Year initialised"
+				puts "Year #{year} initialised"
 			end
 			def defaults
-				{user:Files::Config.new.def_acc}
+				{ user:Prefs.default_alias,
+				   git:Prefs.bool(key:"init_git") }
 			end
 		end
 		class DayInit
@@ -48,19 +46,13 @@ module AocCli
 				@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
+				Day::Init.new(u:user, y:year, d:day).mkdir.meta
+				Day::Pages.new(u:user, y:year, d:day).load
 				self
 			end
 			def defaults
-				{user:Metafile.get(:user), 
-				 year:Metafile.get(:year)}
+				{ user:Metafile.get(:user), 
+				  year:Metafile.get(:year) }
 			end
 			def respond
 				puts "Day #{day} initialised"
@@ -98,74 +90,54 @@ module AocCli
 				@browser = args[:browser]
 			end
 			def exec
-				Day::Reddit.new(y:year, d:day, b:browser).open
+				Tools::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")}
+				{ year:Metafile.get(:year),
+				  day:Metafile.get(:day),
+				  browser:Prefs.bool(key:"reddit_in_browser") }
 			end
 		end
-		class DefaultUser
+		class DefaultAlias
 			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
+				set if mode == :set && alias_valid
 				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}"
+			def respond
+				case mode
+				when :get then current
+				when :set then update end
 			end
-		end
-		class DefaultReddit
-			attr_reader :value, :mode
-			def initialize(args)
-				@value = args[:value]
-				@mode = value.nil? ? :get : :set
+			private
+			def set
+				Files::Config::Tools
+					.mod_line(key:"default", val:Validate.user(user)) 
 			end
-			def exec
-				case mode
-				when :get then get_default
-				when :set then set_default
-				end
+			def current
+				puts <<~aliases
+				Default alias: #{Prefs.default_alias.yellow}
+				All aliases: #{Prefs.list_aliases.map{|a| a.blue}
+					.join(", ")}
+				aliases
 			end
-			def get_default
-				puts "Always open Reddit in browser? "\
-					 "#{Files::Config.new
-						.get_bool(key:"browser")
-						.to_s.yellow}"
+			def alias_valid
+				Validate.key(Files::Config::Cookie.key(user:user))
 			end
-			def set_default
-				Files::Config.new.mod_line(
-					key:"browser", val:value)
-				puts "Reddit browser setting changed to "\
-					 "#{value.yellow}"
+			def update
+				puts "Default alias changed to: #{user.yellow}"
 			end
 		end
 		class Refresh
-			attr_reader :dir
 			def initialize(args)
-				@dir = Metafile.type
 			end
 			def exec
-				case dir
+				case Metafile.type
 				when :DAY  then Day.refresh
 				when :ROOT then Year.refresh end
 				self
@@ -181,8 +153,7 @@ module AocCli
 				@part = args[:part]
 			end
 			def exec
-				Tables::Attempts
-					.new(u:user, y:year, d:day, p:part).show
+				Tables::Attempts.new(u:user, y:year, d:day, p:part).print
 				self
 			end
 			def defaults
@@ -211,5 +182,51 @@ module AocCli
 				   day:Metafile.get(:day) }
 			end
 		end
+		class CalendarTable
+			attr_reader :user, :year
+			def initialize(args)
+				args = defaults.merge(args).compact
+				@user = Validate.user(args[:user])
+				@year = Validate.year(args[:year])
+			end
+			def exec
+				Tables::Calendar.new(u:user, y:year).print
+			end
+			def defaults
+				{ user:Metafile.get(:user),
+				  year:Metafile.get(:year) }
+			end
+		end
+		class PrintCal
+			attr_reader :path, :year
+			def initialize(args)
+				args  = defaults.merge(args).compact
+				@year = Validate.year(args[:year])
+			end
+			def path
+				case Metafile.type
+				when :DAY  then "../#{year}.md"
+				when :ROOT then "#{year}.md"
+				end
+			end
+			def exec
+				Prefs.bool(key:"calendar_file") ?
+					system("cat #{path} | less") :
+					puts("You have disabled calendar files")
+			end
+			def defaults
+				{year:Metafile.get(:year)}
+			end
+		end
+		class GenerateConfig
+			def initialize(args) end
+			def exec
+				Files::Config::Example.write
+				self
+			end
+			def respond
+				puts "Default config written to #{Paths::Config.path.blue}"
+			end
+		end
 	end
 end