algo_scaffold 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ac38dfbee85131564ad37b5642a8705eee27cda2e4e6b9f780f0bc1b20c42df9
+  data.tar.gz: 4ab3fb9bfe399c547aaa5b6cbf0f155e48d3c2727d13fc6c249cf8c2afddbbb6
+SHA512:
+  metadata.gz: ecd51b3a64f702754241b57080670b1d3c1dd3e5f28ba0f9be66c58189bf91bab5cf57c5ee9f0d5bf7789514616a29b749958869d5d89d460e3576e57b3cb513
+  data.tar.gz: 9f2266390ccbe26b876ed82dde49e68b79fd1542b237d5a9b62bf208c89fddca41be111f6ef8aef9e392274cf7b00662b2c9db6a4f42159d6f1c8ebf5a82e004

data/bin/algo_scaffold

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/algo_scaffold'
+
+AlgoScaffold::CLI.start(ARGV)

data/lib/algo_scaffold/cli.rb

@@ -0,0 +1,53 @@
+require 'thor'
+require 'colorize'
+
+module AlgoScaffold
+  class CLI < Thor
+    desc "generate PROBLEM_NAME URL METHOD_NAME [ARGS...]", "Generate algorithm scaffolding files"
+
+    def generate(problem_name, url, method_name, *method_args)
+      generator = Generator.new(
+        problem_name: problem_name,
+        url: url,
+        method_name: method_name,
+        method_args: method_args,
+      )
+
+      generator.generate!
+
+      puts "\n✓ Successfully generated files:".green
+      puts "  📁 src/#{problem_name}.rb".cyan
+      puts "  📁 spec/#{problem_name}_spec.rb".cyan
+
+      puts "\n💡 Next steps:".yellow
+      puts "  1. Implement the #{method_name} method in src/#{problem_name}.rb"
+      puts "  2. Add test cases in spec/#{problem_name}_spec.rb"
+      puts "  3. Run tests with: rspec spec/#{problem_name}_spec.rb"
+    rescue Generator::ValidationError => e
+      puts "❌ #{e.message}".red
+      exit 1
+    end
+
+    desc "list", "List all generated algorithm files"
+    def list
+      src_files = Dir.glob("src/*.rb").map { |f| File.basename(f, '.rb') }
+
+      if src_files.empty?
+        puts "No algorithm files found.".yellow
+        return
+      end
+
+      puts "📚 Generated algorithms:".green
+      src_files.each do |file|
+        spec_exists = File.exist?("spec/#{file}_spec.rb")
+        status = spec_exists ? "✓".green : "✗".red
+        puts "  #{status} #{file}"
+      end
+    end
+
+    desc "version", "Show version"
+    def version
+      puts AlgoScaffold::VERSION
+    end
+  end
+end

data/lib/algo_scaffold/generator.rb

@@ -0,0 +1,90 @@
+require 'fileutils'
+
+module AlgoScaffold
+  class Generator
+    class ValidationError < StandardError; end
+
+    def initialize(problem_name:, url:, method_name:, method_args:)
+      @problem_name = problem_name
+      @url = url
+      @method_name = method_name
+      @method_args = method_args
+
+      validate!
+    end
+
+    def generate!
+      create_directories
+      generate_source_file
+      generate_spec_file
+    end
+
+    private
+
+    attr_reader :problem_name, :url, :method_name, :method_args
+
+    def validate!
+      errors = []
+
+      errors << "Problem name is required" if problem_name.nil? || problem_name.empty?
+      errors << "URL is required" if url.nil? || url.empty?
+      errors << "Method name is required" if method_name.nil? || method_name.empty?
+      errors << "At least one method argument is required" if method_args.empty?
+
+      unless errors.empty?
+        raise ValidationError, errors.map { |e| "• #{e}" }.join("\n")
+      end
+    end
+
+    def create_directories
+      FileUtils.mkdir_p('src')
+      FileUtils.mkdir_p('spec')
+    end
+
+    def generate_source_file
+      class_name = snake_to_camel(problem_name)
+      content = basic_source_template(class_name)
+
+      File.write("src/#{problem_name}.rb", content)
+    end
+
+    def generate_spec_file
+      class_name = snake_to_camel(problem_name)
+      content = basic_spec_template(class_name)
+
+      File.write("spec/#{problem_name}_spec.rb", content)
+    end
+
+    def basic_source_template(class_name)
+      <<~RUBY
+        # #{url}
+
+        class #{class_name}
+          class << self
+
+            def #{method_name}(#{method_args.join(', ')})
+            end
+          end
+        end
+      RUBY
+    end
+
+    def basic_spec_template(class_name)
+      <<~RUBY
+        require 'rspec'
+        require_relative '../src/#{problem_name}.rb'
+
+        RSpec.describe #{class_name} do
+          subject(:output) { described_class.#{method_name}(#{method_args.join(', ')}) }
+
+          context 'TODO - implement test cases' do
+          end
+        end
+      RUBY
+    end
+
+    def snake_to_camel(snake_str)
+      snake_str.split('_').map(&:capitalize).join
+    end
+  end
+end

data/lib/algo_scaffold.rb

@@ -0,0 +1,6 @@
+require_relative 'algo_scaffold/cli'
+require_relative 'algo_scaffold/generator'
+
+module AlgoScaffold
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: algo_scaffold
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Molly Huerster
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: A command-line tool to quickly generate Ruby class and RSpec test files
+  for algorithm practice problems from various sources. Mostly implemented by Claude.
+email:
+- molly.huerster@gmail.com
+executables:
+- algo_scaffold
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/algo_scaffold
+- lib/algo_scaffold.rb
+- lib/algo_scaffold/cli.rb
+- lib/algo_scaffold/generator.rb
+homepage: https://github.com/mhuerster/algo_scaffold
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/mhuerster/algo_scaffold
+  source_code_uri: https://github.com/mhuerster/algo_scaffold
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Generate scaffolding for algorithm practice problems
+test_files: []