aoc_generator 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 938e976e4342e3115907290c0c0c90385ca25c67f80bde2befc904baeb510a56
-  data.tar.gz: 2900af440cc153869f1f5575c8a162a53b60ff36b702b8628dcc22e8cdb3c814
+  metadata.gz: 4c2e50281fb4c3f191cbe11ca0417cb2ca969178f87a124572a5b34e07e01b17
+  data.tar.gz: b00f142cd08f4ca55e651974c7d923f2c62515a49a4f07c4d3443f5584f24e4d
 SHA512:
-  metadata.gz: 11471565e51be4d99ad7e11cd4e1aa2bb43546301aa485c1fbd64d4b5ce9fc78c02b85128e0f6c608caddae2dbeb63ca59d676b5712e1c91d3de72b933d52360
-  data.tar.gz: 66b8d3dc1df84f44f5600aa3ec497f75b4245c955e54f287431e200d1e34eec3cf2efe3a7ec16f7363be522ae140f18b2060b276882b043d39f9f7dd3e44f6e2
+  metadata.gz: ce6d572095bf2acc47c429e5ece1fee0c335ed0403c94c47f33063a996193d0848deacf49a981fa18546b418d05c2425a553317f1677c5fb714d3de9163caf18
+  data.tar.gz: 93ccfd82a61cb9ea1eb8b096cfa1c0a922a002abb923c93f06c25796a5af6d4356be28e06a88d9b62d4e489f04328e15d37569c24a7480cec366c57560bdd0ab

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 # Changelog
 
-## [0.1.2] - 2024-11-28
+## [0.1.4] - 2024-11-28
+
+- Add test data to spec file
+
+## [0.1.3]
+
+- Allow to read a AOC_SESSION environment variable
+- Change file names
+- Convert HTML to Markdown
+
+## [0.1.2]
 
 - [Fix] Add the correct FileUtils gem
 

data/Gemfile.lock

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

data/README.md

@@ -16,12 +16,11 @@ A Ruby gem that generates daily puzzle templates for Advent of Code.
 
 ```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.
+                             # Default: reads AOC_SESSION environment variable if it exists.
 ```
 
 ## Generated file structure
@@ -32,8 +31,8 @@ adventofcode/
 └── year_2024/
     |
     └── day_01/
-        ├── main.rb
-        ├── spec.rb
+        ├── day_01.rb
+        ├── day_01_spec.rb
         ├── data.txt
         └── README.md
 ```

data/lib/advent_of_code_generator/cli.rb

@@ -32,11 +32,13 @@ module AdventOfCodeGenerator
     method_option :session,
                   required: false,
                   aliases: "-s",
-                  desc: "Your adventofcode.com session key. Necessary for scraping data files and specs for part two."
+                  desc: "Your adventofcode.com session key. " \
+                        "Necessary for scraping data files and specs for part two. " \
+                        "Defaults to a AOC_SESSION environment variable if it exists.",
+                  default: ENV.fetch("AOC_SESSION", nil)
 
     def generate
-      scraper = AdventOfCodeGenerator::Scraper.new(options)
-      generator = AdventOfCodeGenerator::Generator.new(options, scraper)
+      generator = AdventOfCodeGenerator::Generator.new(options, content)
 
       generator.call
     end
@@ -44,5 +46,14 @@ module AdventOfCodeGenerator
     def self.exit_on_failure?
       true
     end
+
+    private
+
+    def content
+      scraped_data = AdventOfCodeGenerator::Scraper.new(options).call
+      parsed_data = AdventOfCodeGenerator::HTMLParser.new(scraped_data[:puzzle_description]).call
+
+      scraped_data.merge(parsed_data)
+    end
   end
 end

data/lib/advent_of_code_generator/generator.rb

@@ -12,19 +12,19 @@ module AdventOfCodeGenerator
   #   └── year_2024/
   #       |
   #       └── day_01/
-  #           ├── main.rb
-  #           ├── spec.rb
+  #           ├── day_01.rb
+  #           ├── day_01_spec.rb
   #           ├── data.txt
   #           └── README.md
   #
   class Generator
     FileData = Struct.new(:path, :content)
 
-    def initialize(options, scraper)
+    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]/, "")
-      @scraper = scraper
+      @scraped_data = scraped_data
     end
 
     def call
@@ -45,20 +45,20 @@ module AdventOfCodeGenerator
 
     def readme
       path = "#{daily_directory}/README.md"
-      content = @scraper.puzzle_description
+      content = @scraped_data[:puzzle_description]
 
       FileData.new(path, content)
     end
 
     def data_file
       path = "#{daily_directory}/data.txt"
-      content = @scraper.input_data
+      content = @scraped_data[:input_data]
 
       FileData.new(path, content)
     end
 
     def main_file
-      path = "#{daily_directory}/main.rb"
+      path = "#{daily_directory}/day_#{@day}.rb"
       content = <<~RUBY
         # frozen_string_literal: true
 
@@ -85,23 +85,29 @@ module AdventOfCodeGenerator
     end
 
     def spec_file
-      path = "#{daily_directory}/spec.rb"
+      path = "#{daily_directory}/day_#{@day}_spec.rb"
+      input, expectations = @scraped_data.values_at(:test_input, :test_expectations)
+      input ||= ["", ""]
       content = <<~RUBY
         # frozen_string_literal: true
 
-        require_relative "main"
+        require_relative "day_#{@day}"
 
         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("")
+            input = <<~INPUT
+              #{input[0]&.gsub("\n", "\n      ")}
+            INPUT
+
+            expect(described_class.part_one(input)).to eq(#{expectations[0]})
           end
 
-          xit "solves Part Two" do
-            expect(puzzle.part_two).to eq("some other value")
+          it "solves Part Two", skip: "not implemented yet" do
+            input = <<~INPUT
+              #{input[1]&.gsub("\n", "\n      ")}
+            INPUT
+
+            expect(described_class.part_two(input)).to eq(#{expectations[1]})
           end
         end
       RUBY

data/lib/advent_of_code_generator/html_parser.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "nokogiri"
+
+module AdventOfCodeGenerator
+  # Converts HTML puzzle descriptions from adventofcode.com into markdown format.
+  class HTMLParser
+    def initialize(html_content)
+      @html_content = html_content
+    end
+
+    def call
+      {
+        puzzle_description: part_descriptions.join("\n"),
+        test_input:,
+        test_expectations:
+      }
+    end
+
+    private
+
+    def part_descriptions
+      @part_descriptions ||= articles.map do |node|
+        process_article(node).join("\n")
+      end
+    end
+
+    def test_input
+      part_descriptions.map { |desc| desc.scan(/```sh\n(.*?)\n```/m) }.flatten
+    end
+
+    def test_expectations
+      part_descriptions
+        .flat_map { |desc| desc.scan(/\*\*`(.*?)`\*\*/) }
+        .map do |matches|
+          match = matches.first
+          match&.match?(/\A\d+\z/) ? match.to_i : match
+        end.compact
+    end
+
+    def articles
+      doc = Nokogiri::HTML(@html_content)
+      doc.css("article")
+    end
+
+    def process_article(article)
+      article.children.map { |node| process_node(node) }.compact
+    end
+
+    def process_node(node)
+      case node.name
+      when "h2"
+        "## #{node.text}\n"
+      when "p"
+        "#{process_paragraph(node)}\n"
+      when "pre"
+        "```sh\n#{node.text.strip}\n```\n"
+      end
+    end
+
+    def process_paragraph(para)
+      para.inner_html
+          .gsub(%r{<a[^>]*href="([^"]*)"[^>]*>(.*?)</a>}, '[\2](\1)')
+          .gsub(%r{<code><em>(.*?)</em></code>}, '**`\1`**')
+          .gsub(%r{<em><code>(.*?)</code></em>}, '**`\1`**')
+          .gsub(%r{<em.*?>(.*?)</em>}, '**\1**')
+          .gsub(%r{<code>(.*?)</code>}, '`\1`')
+          .gsub(/<[^>]*>/, "")
+    end
+  end
+end

data/lib/advent_of_code_generator/scraper.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "net/http"
+require_relative "html_parser"
 
 module AdventOfCodeGenerator
   # Fetches puzzle descriptions and input data from adventofcode.com.
@@ -11,6 +12,21 @@ module AdventOfCodeGenerator
       @session_key = options[:session]
     end
 
+    def call
+      {
+        puzzle_description:,
+        input_data:
+      }
+    end
+
+    private
+
+    def headers
+      return {} unless @session_key
+
+      @headers ||= { cookie: "session=#{@session_key}" }
+    end
+
     def puzzle_description
       warn "You'll need to provide a session key to scrape Part Two." unless @session_key
 
@@ -21,20 +37,12 @@ module AdventOfCodeGenerator
     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}" }
+      response.body
     end
   end
 end

data/lib/advent_of_code_generator.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module AdventOfCodeGenerator
-  VERSION = "0.1.2"
+  VERSION = "0.1.4"
 
   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.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Daniel Nguyen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-27 00:00:00.000000000 Z
+date: 2024-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fileutils
@@ -74,6 +74,7 @@ files:
 - 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/html_parser.rb
 - lib/advent_of_code_generator/scraper.rb
 homepage: https://github.com/cheddachedda/advent_of_code_generator
 licenses: []