aoc_generator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7c7406ac54325c97120e78a4eb03b1b6cf1ffaa17729bbee090459eb1c41ea69
+  data.tar.gz: ddb0ddd4e9b6756fbc085b33497e937d1f5cbb6a0c8322c466cb58dfba9c97fb
+SHA512:
+  metadata.gz: f7be5d7348c737ed8c29a4f9ce2607b36c750341694d67022a558a38b252a27d41e0d69ba8aa2536a7004c0c19a1078de66c19e46b95c19ce26f86a0fc5094f5
+  data.tar.gz: 53ac78a563c392c9833d2b5dfc38da6e9bfadd3d508aa730c596353ab8f0d1447f9374f4bb0555b96ffd72276edc2c8df09ce5162fd888c8d12a74a181af7fc2

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,20 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  DisplayCopNames: true
+  NewCops: enable
+  TargetRubyVersion: 3.3
+
+Metrics/MethodLength:
+  CountAsOne: heredoc
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+RSpec/ExampleLength:
+  Enabled: false

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.3.4

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+ruby file: ".tool-versions"
+
+gem "debug", "~> 1.9"
+gem "nokogiri", "~> 1.16"
+gem "rake", "~> 13.2"
+gem "rspec", "~> 3.13"
+gem "rubocop", "~> 1.68"
+gem "rubocop-rake", "~> 0.6.0"
+gem "rubocop-rspec", "~> 3.2"
+gem "thor", "~> 1.3"
+gem "webmock", "~> 3.24"

data/Gemfile.lock

@@ -0,0 +1,107 @@
+PATH
+  remote: .
+  specs:
+    aoc_generator (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    ast (2.4.2)
+    bigdecimal (3.1.8)
+    crack (1.0.0)
+      bigdecimal
+      rexml
+    debug (1.9.2)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
+    diff-lcs (1.5.1)
+    hashdiff (1.1.2)
+    io-console (0.7.2)
+    irb (1.14.1)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.8.2)
+    language_server-protocol (3.17.0.3)
+    mini_portile2 (2.8.8)
+    nokogiri (1.16.7)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
+    nokogiri (1.16.7-arm64-darwin)
+      racc (~> 1.4)
+    parallel (1.26.3)
+    parser (3.3.6.0)
+      ast (~> 2.4.1)
+      racc
+    psych (5.2.0)
+      stringio
+    public_suffix (6.0.1)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    rdoc (6.8.1)
+      psych (>= 4.0.0)
+    regexp_parser (2.9.2)
+    reline (0.5.11)
+      io-console (~> 0.5)
+    rexml (3.3.9)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.2)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.68.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.4, < 3.0)
+      rubocop-ast (>= 1.32.2, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.36.1)
+      parser (>= 3.3.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (3.2.0)
+      rubocop (~> 1.61)
+    ruby-progressbar (1.13.0)
+    stringio (3.1.2)
+    thor (1.3.2)
+    unicode-display_width (2.6.0)
+    webmock (3.24.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  arm64-darwin-23
+  ruby
+
+DEPENDENCIES
+  aoc_generator!
+  debug (~> 1.9)
+  nokogiri (~> 1.16)
+  rake (~> 13.2)
+  rspec (~> 3.13)
+  rubocop (~> 1.68)
+  rubocop-rake (~> 0.6.0)
+  rubocop-rspec (~> 3.2)
+  thor (~> 1.3)
+  webmock (~> 3.24)
+
+RUBY VERSION
+   ruby 3.3.4p94
+
+BUNDLED WITH
+   2.5.22

data/README.md

@@ -0,0 +1,39 @@
+# Advent of Code Generator
+
+A Ruby gem that generates daily puzzle templates for Advent of Code.
+
+## Usage
+
+```sh
+  # With default arguments
+  aoc generate
+
+  # With custom arguments
+  aoc generate -y=2023 -d=1 -u=cheddachedda -s=$SESSION_KEY
+```
+
+### Options
+
+```sh
+  -y, [--year=N]             # Defaults to the current year.
+                             # Default: 2024
+  -d, [--day=N]              # Defaults to the current day.
+                             # Default: 28
+  -u, [--username=USERNAME]  # Files will be generated in a directory with this name. Useful for multi-user repos.
+                             # Default: advent_of_code
+  -s, [--session=SESSION]    # Your adventofcode.com session key. Necessary for scraping data files and specs for part two.
+```
+
+## Generated file structure
+
+```sh
+adventofcode/
+│
+└── year_2024/
+    |
+    └── day_01/
+        ├── main.rb
+        ├── spec.rb
+        ├── data.txt
+        └── README.md
+```

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+Dir[File.join(__dir__, "../lib/**/*.rb")].each do |file|
+  require file
+end
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/exe/aoc

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require_relative "../lib/advent_of_code_generator/cli"
+
+AdventOfCodeGenerator::CLI.start(ARGV)

data/lib/advent_of_code_generator/cli.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "thor"
+require_relative "generator"
+require_relative "scraper"
+
+module AdventOfCodeGenerator
+  # Command Line Interface for generating Advent of Code puzzle templates
+  class CLI < Thor
+    desc "generate", "Generate files for a new Advent of Code puzzle"
+
+    method_option :year,
+                  required: false,
+                  aliases: "-y",
+                  type: :numeric,
+                  desc: "Defaults to the current year.",
+                  default: Time.now.year
+
+    method_option :day,
+                  required: false,
+                  aliases: "-d",
+                  type: :numeric,
+                  desc: "Defaults to the current day.",
+                  default: Time.now.day
+
+    method_option :username,
+                  required: false,
+                  aliases: "-u",
+                  desc: "Files will be generated in a directory with this name. Useful for multi-user repos.",
+                  default: "advent_of_code"
+
+    method_option :session,
+                  required: false,
+                  aliases: "-s",
+                  desc: "Your adventofcode.com session key. Necessary for scraping data files and specs for part two."
+
+    def generate
+      scraper = AdventOfCodeGenerator::Scraper.new(options)
+      generator = AdventOfCodeGenerator::Generator.new(options, scraper)
+
+      generator.call
+    end
+
+    def self.exit_on_failure?
+      true
+    end
+  end
+end

data/lib/advent_of_code_generator/generator.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module AdventOfCodeGenerator
+  # Creates directory structure and files for daily Advent of Code puzzles:
+  #
+  # Generates a file structure like:
+  #
+  #   username/
+  #   │
+  #   └── year_2024/
+  #       |
+  #       └── day_01/
+  #           ├── main.rb
+  #           ├── spec.rb
+  #           ├── data.txt
+  #           └── README.md
+  #
+  class Generator
+    FileData = Struct.new(:path, :content)
+
+    def initialize(options, scraper)
+      @year = options[:year].to_s
+      @day = options[:day].to_s.rjust(2, "0") # Ensures day is two digits (e.g., "01" instead of "1")
+      @username = options[:username].gsub(/[_\-\.\s]/, "")
+      @scraper = scraper
+    end
+
+    def call
+      FileUtils.mkdir_p(daily_directory)
+
+      [readme, data_file, main_file, spec_file].each do |file_data|
+        next if File.exist?(file_data.path)
+
+        File.write(file_data.path, file_data.content)
+      end
+    end
+
+    private
+
+    def daily_directory
+      @daily_directory ||= "#{@username}/year_#{@year}/day_#{@day}"
+    end
+
+    def readme
+      path = "#{daily_directory}/README.md"
+      content = @scraper.puzzle_description
+
+      FileData.new(path, content)
+    end
+
+    def data_file
+      path = "#{daily_directory}/data.txt"
+      content = @scraper.input_data
+
+      FileData.new(path, content)
+    end
+
+    def main_file
+      path = "#{daily_directory}/main.rb"
+      content = <<~RUBY
+        # frozen_string_literal: true
+
+        module #{@username.capitalize}
+          module Year#{@year}
+            class Day#{@day}
+              def initialize(input)
+                @input = input
+              end
+
+              def part_one
+                raise NotImplementedError
+              end
+
+              def part_two
+                raise NotImplementedError
+              end
+            end
+          end
+        end
+      RUBY
+
+      FileData.new(path, content)
+    end
+
+    def spec_file
+      path = "#{daily_directory}/spec.rb"
+      content = <<~RUBY
+        # frozen_string_literal: true
+
+        require_relative "main"
+
+        RSpec.describe #{@username.capitalize}::Year#{@year}::Day#{@day} do
+          subject(:puzzle) { described_class.new(input) }
+
+          let(:input) { File.read("\#{__dir__}/data.txt") }
+
+          it "solves Part One" do
+            expect(puzzle.part_one).to eq("")
+          end
+
+          xit "solves Part Two" do
+            expect(puzzle.part_two).to eq("some other value")
+          end
+        end
+      RUBY
+
+      FileData.new(path, content)
+    end
+  end
+end

data/lib/advent_of_code_generator/scraper.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "net/http"
+
+module AdventOfCodeGenerator
+  # Fetches puzzle descriptions and input data from adventofcode.com.
+  class Scraper
+    def initialize(options)
+      @year = options[:year]
+      @day = options[:day]
+      @session_key = options[:session]
+    end
+
+    def puzzle_description
+      warn "You'll need to provide a session key to scrape Part Two." unless @session_key
+
+      uri = URI("https://adventofcode.com/#{@year}/day/#{@day}")
+      response = Net::HTTP.get_response(uri, headers)
+
+      response.body
+    end
+
+    def input_data
+      return @input_data if @input_data
+      return warn "No session key provided; unable to download data file." unless @session_key
+
+      uri = URI("https://adventofcode.com/#{@year}/day/#{@day}/input")
+      response = Net::HTTP.get_response(uri, headers)
+      @input_data ||= response.body
+    end
+
+    private
+
+    def headers
+      return {} unless @session_key
+
+      @headers ||= { cookie: "session=#{@session_key}" }
+    end
+  end
+end

data/lib/advent_of_code_generator.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module AdventOfCodeGenerator
+  VERSION = "0.1.0"
+
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: aoc_generator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Nguyen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-11-27 00:00:00.000000000 Z
+dependencies: []
+description: |
+  Automatically creates daily puzzle files and test templates for Advent of Code challenges,
+  helping developers focus on solving the puzzles rather than project setup.
+  Includes support for multiple years and customizable templates.
+email:
+- daniel.n.q.nguyen@gmail.com
+executables:
+- aoc
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".tool-versions"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/aoc
+- lib/advent_of_code_generator.rb
+- lib/advent_of_code_generator/cli.rb
+- lib/advent_of_code_generator/generator.rb
+- lib/advent_of_code_generator/scraper.rb
+homepage: https://github.com/cheddachedda/advent_of_code_generator
+licenses: []
+metadata:
+  rubygems_mfa_required: 'true'
+  allowed_push_host: https://rubygems.org
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.23
+signing_key:
+specification_version: 4
+summary: A Ruby gem that generates daily puzzle templates for Advent of Code.
+test_files: []