aoc_rb_helpers 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 87b50db9a3acbc96dbf8cb70e3a3fa2f3e1341166616c3e9c29a53b6d9994201
+  data.tar.gz: 109fc954d7f8ec4d396ee76f51f22bb0289aed2ee68c2e605898c7204049c079
+SHA512:
+  metadata.gz: c03ddeaafa12bb07fd9c87a2d23f11d18edf593ba3ea4390dbea32d5322d0e77e1d0662e08062729f978c1cfc4e77c7437f3b9a06bb46b61bb3a876865577dbd
+  data.tar.gz: 204a9d87b4eb34b6b9ae37875d2e2b22235e585180522eae6a25dd100f326e682a3d68e0967ea9bfc258ab39fa53376322c24457b68093718a9ff93a0e26fdc5

data/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,70 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ main ]
+  schedule:
+    - cron: '21 7 * * 4'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

data/.github/workflows/tests.yml

@@ -0,0 +1,51 @@
+# 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 ]
+    types:
+      - opened
+      - synchronize
+      - reopened
+      - ready_for_review
+      - labeled
+      - unlabeled
+
+jobs:
+  changelog:
+    runs-on: ubuntu-latest
+    steps:
+      - 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'`"
+      - uses: dangoslen/changelog-enforcer@v2.3.1
+        with:
+          skipLabels: 'skip-changelog'
+          expectedLatestVersion: ${{ steps.read-version.outputs.VERSION }}
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.1', '3.2', '3.3']
+    steps:
+    - 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@v1
+      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

@@ -0,0 +1,20 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock
+
+# rspec failure tracking
+.rspec_status
+/.idea/
+
+# environment files
+.ruby-gemset
+.ruby-version
+
+# gem build files
+*.gem

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+- No unreleased changes!
+
+## [0.0.1]
+Initial release.
+
+### Added
+- Created `AocInput` class with initial helper methods
+
+[Unreleased]: https://github.com/pacso/aoc_rb_helpers/compare/v0.0.1...HEAD
+[0.0.1]: https://github.com/pacso/aoc_rb_helpers

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in aoc_rb.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "puts_debuggerer"

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Jon Pascoe
+
+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,73 @@
+# AocRbHelpers
+
+[![Gem Version](https://badge.fury.io/rb/aoc_rb_helpers.svg)](https://badge.fury.io/rb/aoc_rb_helpers)
+
+This gem provides helper classes and functions to simplify solving [Advent of Code](https://adventofcode.com) puzzles. 
+It is a companion gem to the [aoc_rb](https://github.com/pacso/aoc_rb) gem.
+
+Be warned - using this gem might suck the fun out of solving the puzzles yourself!
+
+## Getting Started
+
+First of all, install the [aoc_rb](https://github.com/pacso/aoc_rb) gem and set up your project.
+
+Next, add this gem to your project Gemfile, and run `bundle install`.
+
+Open up `challenges/shared/solution.rb` in your project and require this gem at the top:
+
+```ruby
+# frozen_string_literal: true
+
+require "aoc_rb_helpers"     # <-- Add this line
+
+class Solution
+  ...
+end
+```
+
+You're good to go!
+
+This gem additionally installs the excellent [puts_debuggerer](https://github.com/AndyObtiva/puts_debuggerer) gem, which you can use like this:
+
+```ruby
+pd some_object
+```
+
+You can read more on how you can use `pd` in their [README](https://github.com/AndyObtiva/puts_debuggerer/blob/master/README.md).
+
+## Examples
+
+Below are some examples of how you can use the features of this gem.
+
+### Input manipulation
+
+This example solution for 2024 Day 1 shows how the convenience methdos can be used to format the puzzle input:
+
+```ruby
+# frozen_string_literal: true
+
+module Year2024
+  class Day01 < Solution
+    def part_1
+      list_1, list_2 = data
+      list_1.each_with_index.sum { |item, index| (item - list_2[index]).abs }
+    end
+
+    def part_2
+      list_1, list_2 = data
+      list_1.each.sum { |item| item * list_2.count(item) }
+    end
+
+    private
+
+    def data
+      aoc_input
+        .multiple_lines
+        .columns_of_numbers
+        .transpose
+        .sort_arrays
+        .data
+    end
+  end
+end
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/aoc_rb_helpers.gemspec

@@ -0,0 +1,28 @@
+require_relative "lib/aoc_rb_helpers/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "aoc_rb_helpers"
+  spec.version = AocRbHelpers::VERSION
+  spec.authors = ["Jon Pascoe"]
+  spec.email = ["jon.pascoe@me.com"]
+
+  spec.summary = %q{Helper methods to simplify solving Advent of Code puzzles}
+  spec.description = %q{Enhances the aoc_rb gem with tools for parsing puzzle input, and handling various data manipulations within Advent of Code puzzle solutions.}
+  spec.homepage = "https://github.com/pacso/aoc_rb_helpers"
+  spec.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new("~> 3.1", ">= 3.1.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/pacso/aoc_rb_helpers"
+  spec.metadata["changelog_uri"] = "https://github.com/pacso/aoc_rb_helpers/blob/main/CHANGELOG"
+
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "aoc_rb", "~> 0.2", ">= 0.2.6"
+  spec.add_dependency "puts_debuggerer"
+end

data/lib/aoc_rb_helpers/aoc_input.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+class AocInput
+  def initialize(input)
+    @raw_input = input
+    configure_method_access
+  end
+
+  def data
+    @data ||= @raw_input
+  end
+
+  def multiple_lines
+    @data = data.lines(chomp: true)
+    allow(:columns_of_numbers)
+    self
+  end
+
+  def columns_of_numbers(divider = nil)
+    can_call?(:columns_of_numbers, "call .multiple_lines first")
+    @data = data.map { |line| line.split(divider).map(&:to_i) }
+    allow(:sort_arrays)
+    allow(:transpose)
+    self
+  end
+
+  def transpose
+    can_call?(:transpose, "call .columns_of_numbers first")
+    @data = data.transpose
+    self
+  end
+
+  def sort_arrays
+    can_call?(:sort_arrays, "call .columns_of_numbers first")
+    @data = data.map { |ary| ary.sort }
+    self
+  end
+
+  private
+  def configure_method_access
+    @can_call = {
+      columns_of_numbers: false,
+      sort_arrays: false,
+      transpose: false
+    }
+  end
+
+  def allow(method_name)
+    @can_call[method_name.to_sym] = true
+  end
+
+  def can_call?(method_name, msg = "operation not permitted")
+    raise RuntimeError, msg unless @can_call[method_name.to_sym]
+  end
+end

data/lib/aoc_rb_helpers/solution/input_handling.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class Solution
+  private
+  def aoc_input
+    @aoc_input = AocInput.new(@input)
+  end
+end

data/lib/aoc_rb_helpers/version.rb

@@ -0,0 +1,3 @@
+module AocRbHelpers
+  VERSION = "0.0.1"
+end

data/lib/aoc_rb_helpers.rb

@@ -0,0 +1,3 @@
+require "pd"
+
+Dir[File.join(File.dirname(__FILE__), "aoc_rb_helpers", "**", "*.rb")].each { |file| require file }

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: aoc_rb_helpers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jon Pascoe
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aoc_rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.6
+- !ruby/object:Gem::Dependency
+  name: puts_debuggerer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Enhances the aoc_rb gem with tools for parsing puzzle input, and handling
+  various data manipulations within Advent of Code puzzle solutions.
+email:
+- jon.pascoe@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/codeql-analysis.yml"
+- ".github/workflows/tests.yml"
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- aoc_rb_helpers.gemspec
+- lib/aoc_rb_helpers.rb
+- lib/aoc_rb_helpers/aoc_input.rb
+- lib/aoc_rb_helpers/solution/input_handling.rb
+- lib/aoc_rb_helpers/version.rb
+homepage: https://github.com/pacso/aoc_rb_helpers
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/pacso/aoc_rb_helpers
+  source_code_uri: https://github.com/pacso/aoc_rb_helpers
+  changelog_uri: https://github.com/pacso/aoc_rb_helpers/blob/main/CHANGELOG
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '3.1'
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Helper methods to simplify solving Advent of Code puzzles
+test_files: []