advent_of_ruby 0.2.0 → 0.3.0

data/lib/arb/api/other_solutions.rb

@@ -1,100 +1,92 @@
 module Arb
   module Api
     class OtherSolutions
-      UI_URI = "https://github.com"
-
-      private attr_reader :connection
-
-      PATHS = {
-        "eregon" => ->(year:, day:, part:) {
-          if part == "1"
-            [
-              "adventofcode/tree/master/#{year}/#{day.delete_prefix("0")}.rb",
-              "adventofcode/tree/master/#{year}/#{day.delete_prefix("0")}a.rb",
-            ]
-          elsif part == "2"
-            ["adventofcode/tree/master/#{year}/#{day.delete_prefix("0")}b.rb"]
-          end
-        },
-        "gchan" => ->(year:, day:, part:) {
-          ["advent-of-code-ruby/tree/main/#{year}/day-#{day}/day-#{day}-part-#{part}.rb"]
-        },
-        "ahorner" => ->(year:, day:, part:) {
-          return [] if part == "1"
-          ["advent-of-code/tree/main/lib/#{year}/#{day}.rb"]
-        },
-        "ZogStriP" => ->(year:, day:, part:) {
-          return [] if part == "1"
-
-          puzzle_name = File.read(Files::Instructions.path(year:, day:))
-            .match(/## --- Day \d\d?: (.+)(?= ---)/)
-            .captures
-            .first
-            .downcase
-            .gsub(" ", "_")
-
-          ["adventofcode/tree/master/#{year}/#{day}_#{puzzle_name}.rb"]
-        },
-        "erikw" => ->(year:, day:, part:) {
-          ["advent-of-code-solutions/tree/main/#{year}/#{day}/part#{part}.rb"]
-        },
-      }
-
-      EDITS = {
-        "gchan" => ->(file_str) {
-          # Remove the first 5 lines (boilerplate).
-          file_str.lines[5..].join
-        },
-        "ZogStriP" => ->(file_str) {
-          # Remove input at the end of the file.
-          file_str.split("\n__END__").first
-        },
-        "erikw" => ->(file_str) {
-          # Remove the first 3 lines (boilerplate).
-          file_str.lines[3..].join
-        },
-      }
-
-      def initialize
-        @connection = Faraday.new(
-          url: "https://raw.githubusercontent.com",
-          headers: {
-            "User-Agent" => "github.com/fpsvogel/advent_of_ruby by fps.vogel@gmail.com",
-          }
-        )
+      private attr_reader :year, :day, :part, :gem_directory
+
+      def initialize(year:, day:, part:)
+        @year = year
+        @day = day
+        @part = part
+        @gem_directory = Gem.loaded_specs["advent_of_ruby"].gem_dir
+      end
+
+      def other_solutions
+        unless File.exist?(reddit_file_path)
+          return no_solutions_for_year_message
+        end
+
+        "#{year} Day #{day.to_i} Part #{part}\n\n" \
+          "#{github_solutions}" \
+          "#{reddit_solutions if part.to_i == 2}".rstrip + "\n"
+      end
+
+      private
+
+      def no_solutions_for_year_message
+        "Solutions for #{year} Day #{day.to_i} were not found. Run `gem update " \
+          "advent_of_ruby` and try again. If that doesn't work, and it's been " \
+          "more than a few days since the end of this year's Advent of Code, " \
+          "open an issue at https://github.com/fpsvogel/advent_of_ruby/issues/new" \
+          "?labels=bug&title=Add+#{year}+solutions" \
+          "&body=Solutions+for+#{year}+need+to+be+added+to+the+gem."
       end
 
-      def other_solutions(year:, day:, part:)
-        "# #{year} Day #{day} Part #{part}\n\n" +
-          PATHS
-          .map { |username, path_builder|
-            actual_path = nil
-            solution = nil
-            paths = path_builder.call(year:, day:, part:)
-
-            paths.each do |path|
-              next if solution
-              response = connection.get("/#{username}/#{path.sub("/tree/", "/")}")
-              next if response.status == 404
-
-              actual_path = path
-              solution = (EDITS[username] || :itself.to_proc).call(response.body)
-            end
-
-            if solution
-              <<~SOLUTION
-                # ------------------------------------------------------------------------------
-                # #{username}: #{UI_URI}/#{username}/#{actual_path}
-                # ------------------------------------------------------------------------------
-
-                #{solution}
-
-              SOLUTION
-            end
+      def github_solutions
+        github_directory = File.join(gem_directory, "data", "solutions", "github")
+
+        Dir.children(github_directory)
+          .select { |child| File.directory?(File.join(github_directory, child)) }
+          .map { |author|
+            file_path = File.join(github_directory, author, year.to_s, "#{day.to_s.rjust(2, "0")}_#{part}.yml")
+            # The year subdirectory doesn't exist, if the author has no solutions for the year.
+            next "" unless File.exist?(file_path)
+
+            solutions = YAML.load_file(file_path)
+            next "" if solutions.empty? # if the author has no solutions for the day
+
+            "# #{(solutions.count > 1) ? "Solutions" : "Solution"} by #{author}\n" +
+              solutions
+                .map { |solution|
+                  <<~SOLUTION
+                    #{"## #{solution[:name]}\n" if solutions.count > 1}#{solution[:url]}
+
+                    ```ruby
+                    #{solution[:solution]}
+                    ```
+
+                  SOLUTION
+                }
+                .join
           }
           .compact
           .join
-          .strip + "\n"
+      end
+
+      def reddit_file_path
+        File.join(gem_directory, "data", "solutions", "reddit", "ruby", year.to_s, "#{day.to_s.rjust(2, "0")}.yml")
+      end
+
+      def reddit_solutions
+        comments = YAML.load_file(reddit_file_path)
+
+        comments.map { |comment|
+          reddit_comment_to_markdown(comment)
+        }.join
+      end
+
+      def reddit_comment_to_markdown(comment, level: 0)
+        replies = comment[:replies].map { |reply|
+          reddit_comment_to_markdown(reply, level: level + 1)
+        }.join("\n\n")
+
+        <<~COMMENT.gsub(/(?:\n\s*){3,}/, "\n\n")
+          #{"#" * (level + 1)} #{"↳" * level}#{level.zero? ? "Solution by" : "Reply by"} #{comment[:author]}
+          #{comment[:url]}
+
+          #{comment[:body]}
+
+          #{replies unless replies.empty?}
+        COMMENT
       end
     end
   end

data/lib/arb/arb.rb

@@ -7,12 +7,12 @@ require "open3"
 require "pastel"
 require "reverse_markdown"
 require "rspec/core"
+require "yaml"
 
-class AppError < StandardError; end
-class InputError < AppError; end
-class ConfigError < AppError; end
-
-PASTEL = Pastel.new
+module Arb
+  InputError = Class.new(StandardError)
+  PASTEL = Pastel.new
+end
 
 Dir[File.join(__dir__, "**", "*.rb")].each do |file|
   require file

data/lib/arb/cli/bootstrap.rb

@@ -30,8 +30,8 @@ module Arb
           "you implement the solution. When the spec passes, your solution will " \
           "be run with the real input and you'll be prompted to submit your solution."
       end
-    rescue AppError => e
-      puts Pastel.new.red(e.message)
+    rescue InputError => e
+      puts PASTEL.red(e.message)
     end
   end
 end

data/lib/arb/cli/progress.rb

@@ -7,12 +7,12 @@ module Arb
 
       total_count = committed.values.sum(&:count)
       my_counts_by_year = committed
-        .transform_values { _1.values.count(&:itself) }
+        .transform_values { it.values.count(&:itself) }
         .reject { |k, v| v.zero? }
       my_total_count = my_counts_by_year.values.sum
 
       total_percent = (my_total_count.to_f / total_count * 100).round(1)
-      total_percent = total_percent == total_percent.to_i ? total_percent.to_i : total_percent
+      total_percent = (total_percent == total_percent.to_i) ? total_percent.to_i : total_percent
 
       puts "You have completed:"
       puts
@@ -20,11 +20,12 @@ module Arb
       puts
 
       my_counts_by_year.each do |year, my_count|
-        if year.to_i == Date.today.year
-          year_count = this_year_count
-        else
-          year_count = 25
-        end
+        year_count =
+          if year.to_i == Date.today.year
+            this_year_count
+          else
+            25
+          end
 
         year_percent = (my_count.to_f / year_count * 100).round
 

data/lib/arb/cli/run.rb

@@ -48,13 +48,16 @@ module Arb
             puts
           end
 
-          answers_2 = Runner.run_part(year:, day:, part: "2",correct_answer: correct_answer_2)
+          answers_2 = Runner.run_part(year:, day:, part: "2", correct_answer: correct_answer_2)
         end
-      rescue Runner::SolutionNotFoundError
-        puts PASTEL.red("Solution class not found. Make sure this class exists: #{PASTEL.bold("Year#{year}::Day#{day}")}")
-      rescue Runner::SolutionArgumentError
-        puts PASTEL.red("ArgumentError when running your solution. Make sure every method has a one parameter (the input file).")
-      rescue Runner::SolutionArgumentError
+      rescue Runner::SolutionFileNotFoundError
+        puts PASTEL.red("Solution file not found. Make sure this file exists: #{PASTEL.bold("./src/#{year}/#{day}")}")
+      rescue Runner::SolutionClassNotFoundError
+        puts PASTEL.red("Solution class not found. Make sure the class #{PASTEL.bold("Year#{year}::Day#{day}")} exists in this file (which *does* exist): ./src/#{year}/#{day}")
+      rescue Runner::SolutionMethodNotFoundError
+        puts PASTEL.red("🤔 Couldn't find the method #{PASTEL.bold("##{base_method_name}")}, though the class Year#{year}::Day#{day} exists.")
+      rescue Runner::SolutionArgumentError => e
+        puts PASTEL.red("#{e.message.capitalize}. Make sure that method has one parameter, the input file.")
       end
 
       answer_1, answer_2 = answers_1.compact.first, answers_2.compact.first
@@ -77,11 +80,15 @@ module Arb
 
       puts "Submit solution? (Y/n)"
       print PASTEL.green("> ")
-      submit = STDIN.gets.strip.downcase
+      submit = $stdin.gets.strip.downcase
       puts
 
       if submit == "y" || submit == ""
-        options_part = options[:one] ? "1" : (options[:two] ? "2" : nil)
+        options_part = if options[:one]
+          "1"
+        else
+          (options[:two] ? "2" : nil)
+        end
         inferred_part = correct_answer_1.nil? ? "1" : "2"
         aoc_api = Api::Aoc.new(cookie: ENV["AOC_COOKIE"])
 
@@ -120,7 +127,7 @@ module Arb
           puts "❌ #{short_message}"
         end
       end
-    rescue AppError => e
+    rescue InputError => e
       puts PASTEL.red(e.message)
     end
 

data/lib/arb/cli/shared/git.rb

@@ -33,12 +33,10 @@ module Arb
       def self.last_committed_puzzle(year: nil, exclude_year: nil)
         if exclude_year
           output = `git log -n 1 --diff-filter=A --name-only --pretty=format: -- src spec ':!src/#{exclude_year}' ':!spec/#{exclude_year}'`
+        elsif year && !Dir.exist?(File.join("src", year))
+          return nil
         else
-          if year && !Dir.exist?(File.join("src", year))
-            return nil
-          else
-            output = `git log -n 1 --diff-filter=A --name-only --pretty=format: #{File.join("src", year || "")} #{File.join("spec", year || "")}`
-          end
+          output = `git log -n 1 --diff-filter=A --name-only --pretty=format: #{File.join("src", year || "")} #{File.join("spec", year || "")}`
         end
 
         return nil if output.empty?
@@ -54,25 +52,27 @@ module Arb
       def self.committed_by_year
         committed_solution_files = `git log --diff-filter=A --name-only --pretty=format: src`
 
-        previous_days = (2015..Date.today.year - 1).map { [_1, (1..25).to_a] }.to_h
-        previous_days.merge!(Date.today.year => (1..Date.today.day)) if Date.today.month == 12
+        previous_days = (2015..Date.today.year - 1).map { [it, (1..25).to_a] }.to_h
+        if Date.today.month == 12
+          previous_days[Date.today.year] = (1..Date.today.day)
+        end
 
         committed_days = committed_solution_files
           .split("\n")
           .reject(&:empty?)
           .map {
-            match = _1.match(/(?<year>\d{4})\/(?<day>\d\d).rb$/)
+            match = it.match(/(?<year>\d{4})\/(?<day>\d\d).rb$/)
             year, day = match[:year], match[:day]
             [year.to_i, day.to_i]
           }
           .group_by(&:first)
-          .transform_values { _1.map(&:last) }
+          .transform_values { it.map(&:last) }
 
         previous_days.map { |year, days|
           days_hash = days.map { |day|
             [
               day.to_s.rjust(2, "0"),
-              committed_days.has_key?(year) && committed_days[year].include?(day),
+              committed_days.has_key?(year) && committed_days[year].include?(day)
             ]
           }.to_h
 

data/lib/arb/cli/shared/runner.rb

@@ -1,20 +1,21 @@
 module Arb
   module Cli
     class Runner
-      SolutionNotFoundError = Class.new(StandardError)
+      SolutionFileNotFoundError = Class.new(StandardError)
+      SolutionClassNotFoundError = Class.new(StandardError)
+      SolutionMethodNotFoundError = Class.new(StandardError)
       SolutionArgumentError = Class.new(StandardError)
 
       def self.run_part(year:, day:, part:, correct_answer:)
         solution_class = solution_class(year:, day:)
         base_method_name = "part_#{part}"
         variant_method_names = solution_class
-            .instance_methods(false)
-            .filter { _1.to_s.start_with?(base_method_name)}
-            .sort
+          .instance_methods(false)
+          .filter { it.to_s.start_with?(base_method_name) }
+          .sort
 
         if variant_method_names.empty?
-          puts PASTEL.red("🤔 Couldn't find the method #{PASTEL.bold("Year#{year}::Day#{day}##{base_method_name}")}.")
-          return
+          raise SolutionMethodNotFoundError
         end
 
         answers = []
@@ -30,8 +31,8 @@ module Arb
             end
             variant = variant_method_name.to_s.delete_prefix(base_method_name).delete_prefix("_")
             variant_note = " `#{PASTEL.blue.bold(variant)}`" unless variant.empty?
-          rescue ArgumentError
-            raise SolutionArgumentError
+          rescue ArgumentError => e
+            raise SolutionArgumentError, "#{e.message} at .#{e.backtrace.first.delete_prefix(Dir.pwd)}"
           end
 
           part_name = "#{year}##{day}.#{part}#{variant_note}"
@@ -74,8 +75,10 @@ module Arb
         Module
           .const_get("Year#{year}")
           .const_get("Day#{day}")
+      rescue LoadError
+        raise SolutionFileNotFoundError
       rescue NameError
-        raise SolutionNotFoundError
+        raise SolutionClassNotFoundError
       end
     end
   end

data/lib/arb/cli/shared/working_directory.rb

@@ -24,19 +24,19 @@ module Arb
         FILE
       }
 
-      def self.env_keys = ["EDITOR_COMMAND", "AOC_COOKIE"]
-      def self.default_editor_command = "code"
+      ENV_KEYS = ["EDITOR_COMMAND", "AOC_COOKIE"]
+      DEFAULT_EDITOR_COMMAND = "code"
 
       def self.prepare!
         files_created = []
 
         existing_dotenv = Dotenv.parse(".env")
-        unless env_keys.all? { existing_dotenv.has_key?(_1) }
+        unless ENV_KEYS.all? { existing_dotenv.has_key?(it) }
           create_dotenv!(existing_dotenv)
           files_created << :dotenv
         end
         Dotenv.load
-        Dotenv.require_keys(*env_keys)
+        Dotenv.require_keys(*ENV_KEYS)
 
         files_created += create_other_files!
 
@@ -54,7 +54,7 @@ module Arb
       end
 
       private_class_method def self.generate_dotenv(new_dotenv)
-        new_dotenv.slice(*env_keys).map { |k, v|
+        new_dotenv.slice(*ENV_KEYS).map { |k, v|
           "#{k}=#{v}"
         }.join("\n")
       end
@@ -68,10 +68,10 @@ module Arb
         puts
 
         unless existing_dotenv.has_key?("EDITOR_COMMAND")
-          puts "What's the shell command to start your editor? (default: #{default_editor_command})"
+          puts "What's the shell command to start your editor? (default: #{DEFAULT_EDITOR_COMMAND})"
           print PASTEL.green("> ")
-          editor_command = STDIN.gets.strip
-          editor_command = default_editor_command if editor_command.empty?
+          editor_command = $stdin.gets.strip
+          editor_command = DEFAULT_EDITOR_COMMAND if editor_command.empty?
           new_dotenv["EDITOR_COMMAND"] = editor_command
         end
 
@@ -95,7 +95,7 @@ module Arb
           puts PASTEL.dark.white("  Chrome: Developer Tools ⇨ Application tab ⇨ Cookies")
           print PASTEL.green("> ")
 
-          aoc_cookie = STDIN.gets.strip
+          aoc_cookie = $stdin.gets.strip
 
           puts
           puts

data/lib/arb/cli/shared/year_day_validator.rb

@@ -21,11 +21,12 @@ module Arb
               year, day = Git.last_committed_puzzle(year:)
 
               if day && !default_to_untracked_or_last_committed
-                if day == "25"
-                  day = :end
-                else
-                  day = day.next
-                end
+                day =
+                  if day == "25"
+                    :end
+                  else
+                    day.next
+                  end
               end
 
               if !day || day == :end
@@ -34,13 +35,13 @@ module Arb
                 bootstrap_year_prompt = nil
 
                 committed = Git.committed_by_year
-                total_committed = committed.values.sum { _1.values.count(&:itself) }
+                total_committed = committed.values.sum { it.values.count(&:itself) }
                 if total_committed.zero?
                   bootstrap_year_prompt = "What year's puzzles do you want to start with? (default: #{default_year})"
                 else
                   earliest_year_with_fewest_committed = committed
-                    .transform_values { _1.values.count(&:itself) }
-                    .sort_by(&:last).first.first
+                    .transform_values { it.values.count(&:itself) }
+                    .min_by(&:last).first
                   default_year = earliest_year_with_fewest_committed
                   default_day = committed[default_year].values.index(false)
 
@@ -51,7 +52,7 @@ module Arb
                 loop do
                   puts bootstrap_year_prompt
                   print PASTEL.green("> ")
-                  year_input = STDIN.gets.strip
+                  year_input = $stdin.gets.strip
                   puts
                   puts
 

data/lib/arb/files/instructions.rb

@@ -24,7 +24,7 @@ module Arb
           markdown_instructions = markdown_instructions
             .sub(/\nTo play, please identify yourself via one of these services:.+/m, "")
             .sub(/\nTo begin, \[get your puzzle input\].+/m, "")
-            .sub(/\n\<form method="post".+/m, "")
+            .sub(/\n<form method="post".+/m, "")
             .sub(/\nAt this point, you should \[return to your Advent calendar\].+/m, "")
             .concat("\n#{url}\n")
 

data/lib/arb/files/other_solutions.rb

@@ -6,20 +6,18 @@ module Arb
         Dir.mkdir("others") unless Dir.exist?("others")
         Dir.mkdir(year_directory) unless Dir.exist?(year_directory)
 
-        file_paths = %w[1 2].map do |part|
-          file_path = File.join(year_directory, "#{day}_#{part}.rb")
+        %w[1 2].map do |part|
+          file_path = File.join(year_directory, "#{day}_#{part}.md")
 
           if File.exist?(file_path)
             puts "Already exists: #{file_path}"
           else
-            other_solutions = Api::OtherSolutions.new.other_solutions(year:, day:, part:)
+            other_solutions = Api::OtherSolutions.new(year:, day:, part:).other_solutions
             File.write(file_path, other_solutions)
           end
 
           file_path
         end
-
-        file_paths
       end
     end
   end

data/lib/arb/version.rb

@@ -1,3 +1,3 @@
 module Arb
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/download_solutions/api/github/repos.rb

@@ -0,0 +1,87 @@
+module DownloadSolutions
+  module Api
+    class Github
+      REPOS = {
+        "ahorner" => {
+          repo: "advent-of-code",
+          year_directory: "lib/%<year>d",
+          both_parts: "%<day>.2d.rb"
+        },
+        "eregon" => {
+          repo: "adventofcode",
+          part_1: ->(day:) {
+            /\A#{day}(?:a.*)?\.rb\z/
+          },
+          part_2: ->(day:) {
+            /\A#{day}(?:b.*|\D*)\.rb\z/
+          }
+        },
+        "erikw" => {
+          repo: "advent-of-code-solutions",
+          day_directory: "%<day>.2d",
+          part_1: "part1.rb",
+          part_2: "part2.rb",
+          edits: ->(file_contents) {
+            # Remove the first 3 lines (boilerplate).
+            file_contents.lines[3..].join
+          }
+        },
+        "gchan" => {
+          repo: "advent-of-code-ruby",
+          day_directory: "day-%<day>.2d",
+          part_1: "day-%<day>.2d-part-1.rb",
+          part_2: "day-%<day>.2d-part-2.rb",
+          # rarely, e.g. https://github.com/gchan/advent-of-code-ruby/tree/main/2023/day-17
+          both_parts: "day-%<day>.2d-part-1-and-2.rb",
+          edits: ->(file_contents) {
+            # Remove the first 5 lines (boilerplate).
+            file_contents.lines[5..].join
+          }
+        },
+        "ZogStriP" => {
+          repo: "adventofcode-old",
+          both_parts: ->(day:) {
+            /\A#{day.to_s.rjust(2, "0")}_.+\.rb\z/
+          },
+          edits: ->(file_contents) {
+            # Remove input at the end of the file.
+            file_contents.split("\n__END__").first
+          }
+        }
+      }
+
+      # def other_solutions(year:, day:, part:)
+      #   "# #{year} Day #{day} Part #{part}\n\n" +
+      #     PATHS
+      #       .map { |username, path_builder|
+      #       actual_path = nil
+      #       solution = nil
+      #       paths = path_builder.call(year:, day:, part:)
+
+      #       paths.each do |path|
+      #         next if solution
+      #         response = connection.get("/#{username}/#{path.sub("/tree/", "/")}")
+      #         next if response.status == 404
+
+      #         actual_path = path
+      #         solution = (EDITS[username] || :itself.to_proc).call(response.body)
+      #       end
+
+      #       if solution
+      #         <<~SOLUTION
+      #           # ------------------------------------------------------------------------------
+      #           # #{username}: #{UI_URI}/#{username}/#{actual_path}
+      #           # ------------------------------------------------------------------------------
+
+      #           #{solution}
+
+      #         SOLUTION
+      #       end
+      #     }
+      #       .compact
+      #       .join
+      #       .strip + "\n"
+      # end
+    end
+  end
+end