aoc_generator 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 224ddd170a1b90b1f49ec1b74ae9f866469dfe4613f7e79c74fe21bc7e50df6e
-  data.tar.gz: ce15c6c8269ce2fbfcbb9a13c435c2ff05f3f87595ab073eec0452fbd261ec4c
+  metadata.gz: 4bba636ebf82c12a3532f3b89e1ef4190b6f6c3bd7a44e87ca7c1cc4458c203c
+  data.tar.gz: dc0db27bf0088b133e1417bb043bf4df8739ed77b9bad86b84ccb5769dec5b94
 SHA512:
-  metadata.gz: 39b6cb3425c18ce2f88628e4d44a603481578e3cdb49096e252c10ff2edc1994c748ba859be5f67c6b6f3360331dd0caf4bbaad608e573939b13f1875fb018fb
-  data.tar.gz: 29e5215ba788af0c801933c96167f1872bd1c54f722257c9118fa981cd5a9b49b3821cc7f5f64a2bb1592121bd9a2c1cebc2ab651d7a79e0c840d4f409045767
+  metadata.gz: 8b377602a3fb8fb57bc3a63652d88ac280e1f879443e19cce3cb5eeb95e69719b8badc3169aedee722f58113d5c3ba1d7180a0b5d578cff941b1d4539c0cc1a3
+  data.tar.gz: a6b06f2cb5dce4de4c9e34355fe65e21c16329269e52ba83e1389d5dd4318e2f6a41f68fe02f17aa39467da55dc6c0ead2358b20c95ea33e61054d82ea096089

data/CHANGELOG.md

@@ -1,8 +1,15 @@
 # Changelog
 
+## [0.1.7] - 2024-12-01
+
+- Change README.md to PUZZLE_DESCRIPTION.md
+- Add more setup instructions to the README
+- Allow generator to overwrite PUZZLE_DESCRIPTION.md
+- Don't generate data.txt if there is no session key
+
 ## [0.1.6] - 2024-11-29
 
-- Handle <ul> and <ol> HTML elements
+- Handle HTML list elements
 
 ## [0.1.5] - 2024-11-28
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    aoc_generator (0.1.6)
+    aoc_generator (0.1.7)
       fileutils (~> 1.7)
       nokogiri (~> 1.16)
       thor (~> 1.3)

data/README.md

@@ -1,6 +1,35 @@
 # Advent of Code Generator
 
-A Ruby gem that generates daily puzzle templates for Advent of Code.
+A Ruby gem that generates daily puzzle templates for Advent of Code with automatically scraped puzzle descriptions and input data.
+
+## Installation
+
+```sh
+gem install advent_of_code_generator
+```
+
+### Prerequisites
+
+- RSpec: This gem uses RSpec for testing. If you haven't installed it yet, run:
+
+  ```sh
+  gem install rspec
+  ```
+
+- Or optionally, set it up as you would for a normal Ruby project by adding `rspec` to your `Gemfile` and running `bundle install`.
+
+### Setting up your session key
+
+1. Log in to [Advent of Code](https://adventofcode.com)
+2. In your browser's developer tools, find the `session` cookie value
+   - Chrome: DevTools (F12) > Application > Cookies > adventofcode.com
+   - Firefox: DevTools (F12) > Storage > Cookies
+3. Store the session key in your environment:
+
+```sh
+# Add to your ~/.bashrc, ~/.zshrc, or equivalent
+export AOC_SESSION='your_session_key_here'
+```
 
 ## Usage
 
@@ -34,5 +63,35 @@ adventofcode/
         ├── day_01.rb
         ├── day_01_spec.rb
         ├── data.txt
-        └── README.md
+        └── PUZZLE_DESCRIPTION.md
+```
+
+## Generated File Contents
+
+The generator creates the following files with basic templates:
+
+### `day_XX.rb`
+
+```ruby
+class DayXX
+  def part_one(input)
+    # Your solution for part 1
+  end
+
+  def part_two(input)
+    # Your solution for part 2
+  end
+end
+```
+
+### `day_XX_spec.rb`
+
+```ruby
+RSpec.describe DayXX do
+  # Example test cases from the puzzle
+end
 ```
+
+## Acknowledgments
+
+- Thanks to [Eric Wastl](https://twitter.com/ericwastl) for creating [Advent of Code](https://adventofcode.com)

data/lib/advent_of_code_generator/generator.rb

@@ -15,25 +15,24 @@ module AdventOfCodeGenerator
   #           ├── day_01.rb
   #           ├── day_01_spec.rb
   #           ├── data.txt
-  #           └── README.md
+  #           └── PUZZLE_DESCRIPTION.md
   #
   class Generator
-    FileData = Struct.new(:path, :content)
+    FileData = Struct.new(:path, :content, :require_session, :allow_overwrite)
 
     def initialize(options, scraped_data)
       @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]/, "")
+      @session = options[:session]
       @scraped_data = scraped_data
     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)
+      [puzzle_description, data_file, main_file, spec_file].each do |file_data|
+        generate_file(file_data)
       end
     end
 
@@ -43,18 +42,25 @@ module AdventOfCodeGenerator
       @daily_directory ||= "#{@username}/year_#{@year}/day_#{@day}"
     end
 
-    def readme
-      path = "#{daily_directory}/README.md"
+    def generate_file(file_data)
+      return if file_data.require_session && @session.nil?
+      return if File.exist?(file_data.path) && !file_data.allow_overwrite
+
+      File.write(file_data.path, file_data.content)
+    end
+
+    def puzzle_description
+      path = "#{daily_directory}/PUZZLE_DESCRIPTION.md"
       content = @scraped_data[:puzzle_description]
 
-      FileData.new(path, content)
+      FileData.new(path, content, false, true)
     end
 
     def data_file
       path = "#{daily_directory}/data.txt"
       content = @scraped_data[:input_data]
 
-      FileData.new(path, content)
+      FileData.new(path, content, true, false)
     end
 
     def main_file
@@ -77,7 +83,7 @@ module AdventOfCodeGenerator
         end
       RUBY
 
-      FileData.new(path, content)
+      FileData.new(path, content, false, false)
     end
 
     def spec_file
@@ -108,7 +114,7 @@ module AdventOfCodeGenerator
         end
       RUBY
 
-      FileData.new(path, content)
+      FileData.new(path, content, false, false)
     end
   end
 end

data/lib/advent_of_code_generator.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aoc_generator
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Daniel Nguyen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-28 00:00:00.000000000 Z
+date: 2024-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fileutils