aoc_rb 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f512d480998f52892cd50b4ab4f2ede65c6a658f05d51d7a94cdc435737f7b3c
-  data.tar.gz: 36fa102cf29463ec5e66c98683cc4be5b33a055799c94b18370a2158fc373f43
+  metadata.gz: 02b8501bb62be5f7f1103b8b7a1b032bdde616ea8ce384bbf9ea6ef95b0974a5
+  data.tar.gz: c298a15ee511530586a1189254564383ab1a8bdcc3e8b1edf2d4a012544adf66
 SHA512:
-  metadata.gz: 3b51f8cee053e999a534a61076d4884bf4b1a0e02372af6901f51f5057fa16193d2cb269fffa1639ae7ecda36faf2dc0836a73d6c396314ee2a1a06df321c4d5
-  data.tar.gz: df718b45fde0c6cf0d3510b995158d846ea9d03114b903be7cd18c765ee19715f5dd4699a13a9dbbf0c1db34f064263ff84c536d43cc54a6887060b261d9eaaf
+  metadata.gz: 4dee4989b3bd15376712a7dcb2207598c24f8df82ee9d955c130c59dbf2695f0cf5c1413bfe2f1c7aca04f48b947daa0aa63b077e62f619218c3a16d2a6d48d9
+  data.tar.gz: ce87654277f3c3ed7e4a7d296790044ec0b6da6de41ef721e35b76ea7c3c2dca6bf66f918951717bb53f7391da272ba82b4862d040bdee5185cf36b45aa7898a

data/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 - No unreleased changes!
 
+## [0.2.7]
+### Added
+- Version command, which outputs the installed version of the gem ([#30](https://github.com/pacso/aoc_rb/pull/30) by [@pacso](https://github.com/pacso))
+
 ## [0.2.6]
 ### Changed
 - Updated minimum gem versions for dependencies ([#26](https://github.com/pacso/aoc_rb/pull/26) by [@pacso](https://github.com/pacso))
@@ -62,7 +66,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 Initial release.
 
-[Unreleased]: https://github.com/pacso/aoc_rb/compare/v0.2.5...HEAD
+[Unreleased]: https://github.com/pacso/aoc_rb/compare/v0.2.7...HEAD
+[0.2.7]: https://github.com/pacso/aoc_rb/compare/v0.2.6...v0.2.7
+[0.2.6]: https://github.com/pacso/aoc_rb/compare/v0.2.5...v0.2.6
 [0.2.5]: https://github.com/pacso/aoc_rb/compare/v0.2.4...v0.2.5
 [0.2.4]: https://github.com/pacso/aoc_rb/compare/v0.2.3...v0.2.4
 [0.2.3]: https://github.com/pacso/aoc_rb/compare/v0.2.2...v0.2.3

data/README.md

@@ -7,6 +7,8 @@ This gem provides a simple way to create a project for solving [Advent of Code](
 
 It also provides some handy tools to automate your interactions with the Advent of Code website.
 
+If you want more help with your puzzles (use with care ... it'll take the fun out of doing it yourself) then take a look at [aoc_rb_helpers](https://github.com/pacso/aoc_rb_helpers).
+
 ## Getting Started
 
 First of all, install the gem:
@@ -27,7 +29,7 @@ Before running any commands, you must set up your `AOC_COOKIE` environment varia
     $ cp .env-template .env
 
 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.
+In Chrome you can do this by opening the `Developer Tools` window (`⌥ ⌘ I` on Mac) when browsing the Advent of Code website. Within the `Application` tab, expand `Cookies` under `Storage` in the side menu and select `https://adventofcode.com`. This will then show you all of the cookies set by the website. You need to select the `session` cookie and copy the value. 
 
 Now edit the new `.env` file, so that it looks like the following, replacing `ABCDE12345` with the session key you just copied:
 
@@ -35,9 +37,28 @@ Now edit the new `.env` file, so that it looks like the following, replacing `AB
 
 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.
+You'll see you have a few options when running the `aoc` command within your project. Running `aoc help` will show you all of your options:
+
+    $ aoc help
+    Commands:
+      aoc exec            # executes and optionally submits the puzzle for today, or the specified date
+      aoc help [COMMAND]  # Describe available commands or one specific command
+      aoc output          # outputs results from your solution for the given day
+      aoc prep            # preps everything you need for a new puzzle
+      aoc spec            # runs tests for today, or the specified date
+      aoc version         # prints the current installed version of AocRb
+
+If you want to see you options for a given command:
+
+    $ aoc help prep
+    Usage:
+      aoc prep
+    
+    Options:
+      -y, [--year=N]  
+      -d, [--day=N]   
 
-`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: 
+Running `aoc 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
 

data/aoc_rb.gemspec

@@ -13,7 +13,6 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/pacso/aoc_rb"
   spec.metadata["changelog_uri"] = "https://github.com/pacso/aoc_rb/blob/main/CHANGELOG"
 
   # Specify which files should be added to the gem when it is released.

data/exe/aoc

@@ -2,3 +2,5 @@
 # frozen_string_literal: true
 
 require "aoc_rb/cli"
+
+AocRb::Cli.start

data/lib/aoc_rb/app.rb

@@ -142,7 +142,11 @@ module AocRb
       fetch(year, day)
       bootstrap(year, day)
     end
+
+    desc "version", "prints the current installed version of AocRb"
+
+    def version
+      puts "AocRb version #{AocRb::VERSION}"
+    end
   end
 end
-
-AocRb::App.start

data/lib/aoc_rb/cli.rb

@@ -47,7 +47,11 @@ module AocRb
       gemfile_src = File.join(File.dirname(__FILE__), "../../templates/Gemfile")
       File.open(gemfile_dst, "w") { |f| f.write(File.read(gemfile_src))}
     end
+
+    desc "version", "prints the current installed version of AocRb"
+
+    def version
+      puts "AocRb version #{AocRb::VERSION}"
+    end
   end
 end
-
-AocRb::Cli.start

data/lib/aoc_rb/version.rb

@@ -1,3 +1,3 @@
 module AocRb
-  VERSION = "0.2.6"
+  VERSION = "0.2.7"
 end

data/lib/aoc_rb.rb

@@ -1,5 +1,3 @@
-puts "lib/aoc_rb.rb"
-
 Dir[File.join(File.dirname(__FILE__), "aoc_rb", "**", "*.rb")].each { |file| require file }
 
 module AocRb

data/templates/bin/aoc

@@ -33,3 +33,5 @@ require "bundler/setup"
 # load Gem.bin_path("aoc_rb", "aoc")
 
 require 'aoc_rb/app'
+
+AocRb::App.start

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aoc_rb
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - Jon Pascoe
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-30 00:00:00.000000000 Z
+date: 2024-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -112,7 +112,6 @@ files:
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
-- LICENSE.txt
 - README.md
 - Rakefile
 - aoc_rb.gemspec
@@ -141,7 +140,6 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/pacso/aoc_rb
-  source_code_uri: https://github.com/pacso/aoc_rb
   changelog_uri: https://github.com/pacso/aoc_rb/blob/main/CHANGELOG
 post_install_message:
 rdoc_options: []
@@ -158,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: A Ruby toolkit for Advent of Code

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2020 TODO: Write your name
-
-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.