aoc_rb 0.2.5 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9221e43617852ea0a93f97cc13df1dc604b7e597030dffced06b24ee3e3810a6
-  data.tar.gz: 943e273cf7026634f134ae3cc4914187a9ec7f28af2cbdc203d401915a9e66b3
+  metadata.gz: 02b8501bb62be5f7f1103b8b7a1b032bdde616ea8ce384bbf9ea6ef95b0974a5
+  data.tar.gz: c298a15ee511530586a1189254564383ab1a8bdcc3e8b1edf2d4a012544adf66
 SHA512:
-  metadata.gz: 76b52a53c7a2cf3e81b0ab3d84c55ab6c12733ebe2586921999d9a728cdc172deea72389d29439cdb6b9bc752938a81a2152d3d4f15d6a536231b7c0f8ca0068
-  data.tar.gz: db4138ca832aaee0996101a3b2efa5e2facd617c4253e7ef1853912f9062f985da7091caca3af6f29498f5aaa53f908512967d105decfaca19a5cef6185d07c0
+  metadata.gz: 4dee4989b3bd15376712a7dcb2207598c24f8df82ee9d955c130c59dbf2695f0cf5c1413bfe2f1c7aca04f48b947daa0aa63b077e62f619218c3a16d2a6d48d9
+  data.tar.gz: ce87654277f3c3ed7e4a7d296790044ec0b6da6de41ef721e35b76ea7c3c2dca6bf66f918951717bb53f7391da272ba82b4862d040bdee5185cf36b45aa7898a

data/.devcontainer/devcontainer.json

@@ -0,0 +1,26 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/ruby
+{
+  "name": "Advent of Code Ruby Gem",
+  // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+  "image": "mcr.microsoft.com/devcontainers/ruby:1-3.3-bookworm",
+
+  // Features to add to the dev container. More info: https://containers.dev/features.
+  // "features": {},
+
+  // Use 'forwardPorts' to make a list of ports inside the container available locally.
+  // "forwardPorts": [],
+
+  // Use 'postCreateCommand' to run commands after the container is created.
+  // "postCreateCommand": "ruby --version",
+
+  // Configure tool-specific properties.
+  "customizations" : {
+    "jetbrains" : {
+      "backend" : "RubyMine"
+    }
+  },
+
+  // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+  // "remoteUser": "root"
+}

data/.github/workflows/tests.yml

@@ -24,7 +24,7 @@ jobs:
   changelog:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - id: read-version
         run: |
           echo "::set-output name=VERSION::`cat lib/aoc_rb/version.rb | grep -i version | awk '{ print $3 }' | sed -e 's/\"//g'`"
@@ -36,14 +36,14 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.6', '2.7', '3.0', '3.1']
+        ruby-version: ['3.1', '3.2', '3.3']
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - 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@ebaea52cb20fea395b0904125276395e37183dac
+      uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically

data/CHANGELOG.md

@@ -7,6 +7,14 @@ 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))
+
 ## [0.2.5]
 ### Added
 - New spec --all task to run all tests (by [@kauredo](https://github.com/kauredo))
@@ -58,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

@@ -1,12 +1,14 @@
 # AocRb
 
-[![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)
+[![Tests](https://github.com/pacso/aoc_rb/actions/workflows/tests.yml/badge.svg)](https://github.com/pacso/aoc_rb/actions/workflows/tests.yml)
 
 This gem provides a simple way to create a project for solving [Advent of Code](https://adventofcode.com) puzzles.
 
 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.
@@ -25,11 +24,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "dotenv", "~> 2.7.6"
-  spec.add_dependency "httparty", "~> 0.20.0"
-  spec.add_dependency "thor", "~> 1.2.1"
+  spec.add_dependency "dotenv", "~> 3.1"
+  spec.add_dependency "httparty", "~> 0.22"
+  spec.add_dependency "thor", "~> 1.3"
   spec.add_dependency "rspec", "~> 3.0"
-  spec.add_dependency "nokogiri", "~> 1.13.6"
+  spec.add_dependency "nokogiri", "~> 1.16"
 
-  spec.add_development_dependency "webmock", "~> 3.14.0"
+  spec.add_development_dependency "webmock", "~> 3.24"
 end

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.5"
+  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.5
+  version: 0.2.7
 platform: ruby
 authors:
 - Jon Pascoe
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-03 00:00:00.000000000 Z
+date: 2024-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.7.6
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.7.6
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.0
+        version: '0.22'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.0
+        version: '0.22'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -72,28 +72,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.13.6
+        version: '1.16'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.13.6
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.14.0
+        version: '3.24'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.14.0
+        version: '3.24'
 description: Tools for creating a new project for your Advent of Code solutions, built
   using Ruby.
 email:
@@ -103,6 +103,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".devcontainer/devcontainer.json"
 - ".github/workflows/codeql-analysis.yml"
 - ".github/workflows/tests.yml"
 - ".gitignore"
@@ -111,7 +112,6 @@ files:
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
-- LICENSE.txt
 - README.md
 - Rakefile
 - aoc_rb.gemspec
@@ -140,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: []
@@ -157,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+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.