aoc_generator 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 579687651649a576b4a217b4db66695d9b8da18c373fd1fc5c61bcab91874916
-  data.tar.gz: 9090643816096affbd2b0588652a7dc270668b5deebcd2752edd0ed5fde6e8eb
+  metadata.gz: 4b769226917de985f62166b06a18ac48433df5e5ca362fdfc7248338d368ce39
+  data.tar.gz: 9f1be6d33fe107041e8ebcbc90c9dc67b05d5ad27506a84ee2ebe5239cf4920b
 SHA512:
-  metadata.gz: 84772a24e510af0c88595a7191d9edb67bfa51b645ccba9cdc0accce29407f94980a69eb86d09e1ba6aaef187ee55d52f1b6f9c089fc7369536379727bcf1d8b
-  data.tar.gz: 53495eba8e1ac78e30e59fdcab46a221ffb5384f28efafbc7a5788c9cdad78d48efe6f24b90a287eafb3a2210223fa7316a58bf0a6b6871d7419a2740d9f4399
+  metadata.gz: 0fad21368f7c4033a73670fdb2dece5a1ed468de3e0075d50426b821d65a3e15ae840bf2c8f6e20f5e8070f836ffe21bb72eb7abd100162bed5ee60101ca8821
+  data.tar.gz: 1ec320f03139f386435f78e21f3922e840a36433795f7e34421ff4d464b53073497c7c742da1998a025b15e31c1c34e719a5f008cd049a8ad65d2351f1ad8234

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 # Changelog
 
-## [0.1.1] - 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
+
+## [0.1.1]
 
 - Add FileUtils gem
 - Specify dependencies

data/Gemfile

@@ -7,7 +7,7 @@ gemspec
 ruby file: ".tool-versions"
 
 gem "debug", "~> 1.9"
-gem "file_utils", "~> 1.1"
+gem "fileutils", "~> 1.7"
 gem "nokogiri", "~> 1.16"
 gem "rake", "~> 13.2"
 gem "rspec", "~> 3.13"

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    aoc_generator (0.1.1)
-      file_utils (~> 1.1)
+    aoc_generator (0.1.3)
+      fileutils (~> 1.7)
       nokogiri (~> 1.16)
       thor (~> 1.3)
 
@@ -20,7 +20,7 @@ GEM
       irb (~> 1.10)
       reline (>= 0.3.8)
     diff-lcs (1.5.1)
-    file_utils (1.1.2)
+    fileutils (1.7.3)
     hashdiff (1.1.2)
     io-console (0.7.2)
     irb (1.14.1)
@@ -95,7 +95,7 @@ PLATFORMS
 DEPENDENCIES
   aoc_generator!
   debug (~> 1.9)
-  file_utils (~> 1.1)
+  fileutils (~> 1.7)
   nokogiri (~> 1.16)
   rake (~> 13.2)
   rspec (~> 3.13)

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "fileutils"
+
 module AdventOfCodeGenerator
   # Creates directory structure and files for daily Advent of Code puzzles:
   #
@@ -10,8 +12,8 @@ module AdventOfCodeGenerator
   #   └── year_2024/
   #       |
   #       └── day_01/
-  #           ├── main.rb
-  #           ├── spec.rb
+  #           ├── day_01.rb
+  #           ├── day_01_spec.rb
   #           ├── data.txt
   #           └── README.md
   #
@@ -56,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
 
@@ -83,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.1"
+  VERSION = "0.1.3"
 
   class Error < StandardError; end
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: aoc_generator
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  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: file_utils
+  name: fileutils
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -63,20 +63,18 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
-- ".rubocop.yml"
 - ".tool-versions"
 - CHANGELOG.md
 - 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/html_parser.rb
 - lib/advent_of_code_generator/scraper.rb
 homepage: https://github.com/cheddachedda/advent_of_code_generator
 licenses: []

data/.rspec

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

data/.rubocop.yml

@@ -1,20 +0,0 @@
-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/Rakefile

@@ -1,12 +0,0 @@
-# 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]