katagen 1.0.1

data/lib/katagen/generators/logging.rb

@@ -0,0 +1,38 @@
+module Katagen
+  module Generators
+    # Colorization for puts, no need for another gem
+    # TODO: should I move this into a small gem?
+    module Logging
+      COLOR_CODES = {
+        red: 31,
+        green: 32,
+        yellow: 33,
+        blue: 34,
+        pink: 35,
+        light_blue: 36
+      }
+
+      def info(message)
+        puts "#{colorize("info", :blue)} #{message}"
+      end
+
+      def success(message)
+        puts "#{colorize("success", :green)} #{message}"
+      end
+
+      def warning(message)
+        puts "#{colorize("warning", :yellow)} #{message}"
+      end
+
+      private
+
+      # :reek:UtilityFunction
+
+      # Colorize string with provided code. Defaults to none(0)
+      # NOTE: reek should not complain about this in a module IMO
+      def colorize(message, color)
+        "\e[#{COLOR_CODES[color] || 0}m#{message}\e[0m"
+      end
+    end
+  end
+end

data/lib/katagen/generators/solution.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "json"
+require "erb"
+require "time"
+require_relative "utils"
+
+module Katagen
+  module Generators
+    # Generates a solution package
+    class Solution
+      include Utils
+      #
+      # Initialize generator with chosen method.
+      #
+      # @param [#build_question_info] strategy: instance of FromId or FromUrl
+      # @param [Hash] options: see cli.rb
+      # @option options [String] cwd current working directory, defaults is "./"
+      # @option options [String] lang_ext solution file extension, defaults to "rb" (ruby)
+      def initialize(strategy, options)
+        @strategy = strategy
+        @lang_ext = options[:lang] || "rb"
+        @cwd = options[:cwd] || "./"
+      end
+
+      #
+      # Create the folder containing: solution.rb, solution_spec.rb (defaults to rb)
+      #
+      # @param [String] cwd: default to ./
+      #
+      def create_package
+        question_info = @strategy.build_question_info
+        root = File.expand_path(File.join(@cwd, question_info.root))
+        generate_folder(root)
+        create_solution(root, question_info.url)
+        create_solution_spec(root)
+      end
+
+      private
+
+      def create_solution(root, url)
+        solution_path = File.join(root, "solution.#{@lang_ext}")
+        template_path = File.join(File.dirname(__FILE__), "../templates/solution.#{@lang_ext}.erb")
+
+        @timestamp = Time.now.iso8601
+        @url = url
+
+        generate_file(solution_path, dup_when_exists: true) do |file|
+          write_template(file, template_path) if File.exist?(template_path)
+        end
+      end
+
+      def create_solution_spec(root)
+        solution_spec_path = File.join(root, "solution_spec.#{@lang_ext}")
+        template_path = File.join(File.dirname(__FILE__), "../templates/solution_spec.#{@lang_ext}.erb")
+
+        generate_file(solution_spec_path) do |file|
+          write_template(file, template_path) if File.exist?(template_path)
+        end
+      end
+
+      private
+
+      def write_template(file, template_path)
+        template = File.read(template_path)
+        result = ERB.new(template).result(binding)
+        file.write(result)
+      end
+    end
+  end
+end

data/lib/katagen/generators/utils.rb

@@ -0,0 +1,37 @@
+require "fileutils"
+require_relative "logging"
+
+module Katagen
+  module Generators
+    # Common path utilities :reek:UtilityFunction
+    module Utils
+      include Generators::Logging
+      # Generate a file ifne with custom body
+      def generate_file(path, options = {}, &block)
+        if !File.exist?(path)
+        elsif options[:dup_when_exists]
+          _, folder, target_file, ext = path.match(/(.+)\/(.+)\.(.+)\Z/).to_a
+          count = Dir["#{folder}/*"].count { |file| file.match(/#{target_file}\d*\.#{ext}/) }
+          path = "#{folder}/#{target_file}#{count + 1}.#{ext}"
+        else
+          warning "File already exists: #{path}, skipping..."
+          return nil
+        end
+
+        block ||= ->(file) {} unless block_given?
+        File.open(path, "w", &block)
+        success "Created file #{path}"
+      end
+
+      # Mkdir ifne
+      def generate_folder(dir_path)
+        if File.directory?(dir_path)
+          warning "Dir already exists: #{dir_path}, skipping..."
+        else
+          FileUtils.mkdir_p(dir_path)
+          success "Created dir #{dir_path}"
+        end
+      end
+    end
+  end
+end

data/lib/katagen/question_info.rb

@@ -0,0 +1,12 @@
+module Katagen
+  #
+  # Contains question info to create kata folder, can be extended further.
+  #
+  class QuestionInfo
+    attr_reader :root, :url
+    def initialize(root, url)
+      @root = root
+      @url = url
+    end
+  end
+end

data/lib/katagen/strategy/base.rb

@@ -0,0 +1,11 @@
+module Katagen
+  module Strategy
+    #
+    # @abstract Interface for question
+    #
+    class Base
+      # @return [QuestionInfo] path for directory
+      def build_question_info = raise(NotImplementedError)
+    end
+  end
+end

data/lib/katagen/strategy/leetcode.rb

@@ -0,0 +1,49 @@
+require_relative "../question_info"
+
+module Katagen
+  module Strategy
+    # :reek:U
+    class InvalidIndex < StandardError
+      def initialize(input) = super("#{input} is not a valid index")
+    end
+
+    # :reek:U
+    class QuestionNotExist < StandardError
+      def initialize(input) = super("question #{input} does not exist")
+    end
+
+    #
+    # Generator for leetcode questions
+    #
+    class LeetCode
+      def initialize(id)
+        @id = id.to_i
+        raise InvalidIndex.new(@id) unless @id.positive?
+      end
+
+      def build_question_info
+        summary = questions_summary.find { |q| q["id"] == @id }
+        raise QuestionNotExist.new(@id) unless summary
+        topic, difficulty = summary.values_at("topic", "difficulty")
+
+        QuestionInfo.new(
+          "#{difficulty}/#{@id}.#{topic}",
+          "https:/leetcode.com/problems/#{topic}"
+        )
+      end
+
+      private
+
+      #
+      # @return [Array<Hash{String=>String}>] array of question summary
+      #
+      def questions_summary
+        @summary ||= begin
+          path = File.join(File.dirname(__FILE__), "../data/leetcode.json")
+          raw_summary_text = File.read(path)
+          JSON.parse(raw_summary_text)
+        end
+      end
+    end
+  end
+end

data/lib/katagen/templates/solution.rb.erb

@@ -0,0 +1,9 @@
+# timestamp: <%= @timestamp %>
+# question: <%= @url %>
+
+# train of thought
+TRAIN_OF_THOUGHT = <<DOC.freeze
+  <how I came up with this solution>
+DOC
+
+# code goes here

data/lib/katagen/templates/solution_spec.rb.erb

@@ -0,0 +1,27 @@
+FILE_NAME = ENV["TESTEE"] || "solution.rb"
+require_relative FILE_NAME
+
+TEST_CASES = [
+  {
+    input: [],
+    output: 0
+  },
+  {
+    input: [],
+    output: 0
+  }
+].freeze
+
+RSpec.describe FILE_NAME do
+  context TRAIN_OF_THOUGHT do
+    TEST_CASES.each do |tc|
+      case tc
+      in { input: input, output: output}
+        pending "TODO: assert solution output with expected"
+        # it "#{input}  =>  #{output}" do
+        #   expect(___).to eq(output)
+        # end
+      end
+    end
+  end
+end

data/lib/katagen/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Katagen
+  VERSION = "1.0.1"
+end

data/lib/katagen.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "katagen/version"
+require_relative "katagen/cli"

data/sig/katagen.rbs

@@ -0,0 +1,4 @@
+module Katagen
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: katagen
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- harryuan65
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: erb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.29'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.29'
+description: Generate a folder for a question to put all practice records for better
+  reviewing
+email:
+- harryuan.65@gmail.com
+executables:
+- katagen
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/katagen
+- bin/setup
+- lib/katagen.rb
+- lib/katagen/cli.rb
+- lib/katagen/command.rb
+- lib/katagen/data/leetcode.json
+- lib/katagen/generators/logging.rb
+- lib/katagen/generators/solution.rb
+- lib/katagen/generators/utils.rb
+- lib/katagen/question_info.rb
+- lib/katagen/strategy/base.rb
+- lib/katagen/strategy/leetcode.rb
+- lib/katagen/templates/solution.rb.erb
+- lib/katagen/templates/solution_spec.rb.erb
+- lib/katagen/version.rb
+- sig/katagen.rbs
+homepage: https://github.com/harryuan65/Katagen
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/harryuan65/Katagen
+  source_code_uri: https://github.com/harryuan65/Katagen
+  changelog_uri: https://github.com/harryuan65/Katagen/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key:
+specification_version: 4
+summary: Generates a folder for leet code practice
+test_files: []