aoc_generator 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 938e976e4342e3115907290c0c0c90385ca25c67f80bde2befc904baeb510a56
-  data.tar.gz: 2900af440cc153869f1f5575c8a162a53b60ff36b702b8628dcc22e8cdb3c814
+  metadata.gz: 4b769226917de985f62166b06a18ac48433df5e5ca362fdfc7248338d368ce39
+  data.tar.gz: 9f1be6d33fe107041e8ebcbc90c9dc67b05d5ad27506a84ee2ebe5239cf4920b
 SHA512:
-  metadata.gz: 11471565e51be4d99ad7e11cd4e1aa2bb43546301aa485c1fbd64d4b5ce9fc78c02b85128e0f6c608caddae2dbeb63ca59d676b5712e1c91d3de72b933d52360
-  data.tar.gz: 66b8d3dc1df84f44f5600aa3ec497f75b4245c955e54f287431e200d1e34eec3cf2efe3a7ec16f7363be522ae140f18b2060b276882b043d39f9f7dd3e44f6e2
+  metadata.gz: 0fad21368f7c4033a73670fdb2dece5a1ed468de3e0075d50426b821d65a3e15ae840bf2c8f6e20f5e8070f836ffe21bb72eb7abd100162bed5ee60101ca8821
+  data.tar.gz: 1ec320f03139f386435f78e21f3922e840a36433795f7e34421ff4d464b53073497c7c742da1998a025b15e31c1c34e719a5f008cd049a8ad65d2351f1ad8234

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 # Changelog
 
-## [0.1.2] - 2024-11-28
+## [0.1.3] - 2024-11-28
+
+- 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.3)
       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,7 +32,10 @@ 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)

data/lib/advent_of_code_generator/generator.rb

@@ -12,8 +12,8 @@ module AdventOfCodeGenerator
   #   └── year_2024/
   #       |
   #       └── day_01/
-  #           ├── main.rb
-  #           ├── spec.rb
+  #           ├── day_01.rb
+  #           ├── day_01_spec.rb
   #           ├── data.txt
   #           └── README.md
   #
@@ -58,7 +58,7 @@ module AdventOfCodeGenerator
     end
 
     def main_file
-      path = "#{daily_directory}/main.rb"
+      path = "#{daily_directory}/day_#{@day}.rb"
       content = <<~RUBY
         # frozen_string_literal: true
 
@@ -85,11 +85,11 @@ module AdventOfCodeGenerator
     end
 
     def spec_file
-      path = "#{daily_directory}/spec.rb"
+      path = "#{daily_directory}/day_#{@day}_spec.rb"
       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) }

data/lib/advent_of_code_generator/html_parser.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "nokogiri"
+
+module AdventOfCodeGenerator
+  # Converts HTML puzzle descriptions from adventofcode.com into markdown format.
+  class HTMLParser
+    def initialize(input)
+      @input = input
+    end
+
+    def call
+      articles.map do |node|
+        process_article(node)
+      end.join("\n").strip
+    end
+
+    private
+
+    def articles
+      doc = Nokogiri::HTML(@input)
+      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,14 +1,16 @@
 # frozen_string_literal: true
 
 require "net/http"
+require_relative "html_parser"
 
 module AdventOfCodeGenerator
   # Fetches puzzle descriptions and input data from adventofcode.com.
   class Scraper
-    def initialize(options)
+    def initialize(options, parser = AdventOfCodeGenerator::HTMLParser)
       @year = options[:year]
       @day = options[:day]
       @session_key = options[:session]
+      @parser = parser
     end
 
     def puzzle_description
@@ -17,7 +19,7 @@ module AdventOfCodeGenerator
       uri = URI("https://adventofcode.com/#{@year}/day/#{@day}")
       response = Net::HTTP.get_response(uri, headers)
 
-      response.body
+      @parser.new(response.body).call
     end
 
     def input_data

data/lib/advent_of_code_generator.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module AdventOfCodeGenerator
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 
   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.3
 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: []