ikuzo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 341ee328303de83855560af0ab990e8c599d9fae811cf94de96e86057c83b26e
+  data.tar.gz: e062e1eb9fef1001223c9b144419e7e776d4f45e3e9d32d62d324aa7df08646b
+SHA512:
+  metadata.gz: c178da9edd66460dbe86f01fc95478423f62c917ca5c62df24c3f87cd2b14fc9e1ef0222951d29bd8f3b097f5161d192880a66937fe1ac7b906953ed891cb881
+  data.tar.gz: 651e3429246c11d481bf39e57b629f968b09cc8be1f44958ff1aaca63c6f841783c4c1eda74f5535d4f7dc204719719c60977836456f6c94ada09878773f17af

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Dang Quang Minh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,120 @@
+# Ikuzo
+
+Ikuzo is a Ruby gem that generates short, motivational commit messages for developers. Use it as a CLI tool or as a library inside your scripts when you need an instant morale boost.
+
+## Installation
+
+```bash
+gem install ikuzo
+```
+
+If you are developing locally:
+
+```bash
+bundle install
+```
+
+## Usage
+
+### CLI
+
+Outputs vary because messages are chosen at random. Ikuzo commits automatically; add `--no-commit` if you only want to print the message.
+
+Commit with a random message (default: feat):
+
+$ ikuzo
+git commit -m "feat: main linted the vibes not the code"
+[main abc1234] feat: main linted the vibes not the code
+ 1 file changed, 1 insertion(+)
+```
+
+Print a random message from a specific category without committing:
+
+$ ikuzo funny --no-commit
+This commit was pair-programmed with caffeine.
+```
+
+Commit with a random message explicitly (also default behavior):
+
+$ ikuzo commit
+git commit -m "It compiled on my machine, scout's honor."
+[main abc1234] It compiled on my machine, scout's honor.
+ 1 file changed, 1 insertion(+)
+```
+
+Skip committing and just print the message:
+
+$ ikuzo --no-commit
+feat: main linted the vibes not the code
+```
+
+Specify a category explicitly and commit:
+
+$ ikuzo --category dev
+git commit -m "Logs cleaned, metrics gleam."
+[main ghi9012] Logs cleaned, metrics gleam.
+ 1 file changed, 1 insertion(+)
+```
+
+Generate a Conventional Commit message from the current branch (omit `--no-commit` to auto commit):
+
+$ ikuzo feat --no-commit
+feat: main no rubber duck was harmed in this fix
+```
+
+Pick any Conventional Commit type that you need:
+
+$ ikuzo fix
+git commit -m "fix: main stack trace more like snack trace"
+[main jkl3456] fix: main stack trace more like snack trace
+ 1 file changed, 1 insertion(+)
+```
+
+Supported types align with the Conventional Commits 1.0.0 spec: build, ci, chore, docs, feat, fix, perf, refactor, revert, style, and test.
+
+List available categories:
+
+$ ikuzo --list-categories
+Available categories:
+  - general
+  - funny
+  - motivation
+  - dev
+  - build - Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
+  - ci - Changes to CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
+  - chore - Changes which don't affect source code or tests e.g. build process, auxiliary tools, libraries
+  - docs - Documentation only changes
+  - feat
+  - fix
+  - perf
+  - refactor
+  - revert
+  - style
+  - test
+```
+
+Show the installed version:
+
+$ ikuzo --version
+0.1.0
+```
+
+Each Conventional Commit category builds a `<type>: ...` message from your current Git branch, appends a cleaned-up motivational quip, and falls back to a default subject if the branch cannot be detected.
+
+### Library
+
+```ruby
+require "ikuzo"
+
+message = Ikuzo.random
+# Defaults to the feat category
+puts message
+```
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. You can run `bundle exec rake release` to build and release the gem.
+
+## License
+
+MIT License © 2025 Dang Quang Minh

data/bin/ikuzo

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+lib_path = File.expand_path("../lib", __dir__)
+$LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
+
+require "ikuzo"
+
+Ikuzo::CLI.new(ARGV).run

data/ikuzo.gemspec

@@ -0,0 +1,27 @@
+require_relative "lib/ikuzo/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ikuzo"
+  spec.version       = Ikuzo::VERSION
+  spec.authors       = ["Dang Quang Minh"]
+  spec.email         = ["ojisanchamchi@gmail.com"]
+
+  spec.summary       = "Generate fun, motivational commit messages."
+  spec.description   = "Ikuzo delivers short, humorous, and motivational commit messages for developers via both CLI and library usage."
+  spec.homepage      = "https://github.com/ojisanchamchi/ruby_ikuzo#readme"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = ">= 2.7"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/ojisanchamchi/ruby_ikuzo"
+  spec.metadata["changelog_uri"] = "https://github.com/ojisanchamchi/ruby_ikuzo/releases"
+
+  spec.files         = Dir.glob("lib/**/*.rb") + %w[README.md LICENSE ikuzo.gemspec bin/ikuzo]
+  spec.bindir        = "bin"
+  spec.executables   = ["ikuzo"]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+end

data/lib/ikuzo/cli.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+require "optparse"
+
+module Ikuzo
+  # CLI entry point for generating random commit messages.
+  class CLI
+    def initialize(argv, stdout: $stdout, stderr: $stderr, kernel: Kernel)
+      @argv = argv.dup
+      @stdout = stdout
+      @stderr = stderr
+      @kernel = kernel
+    end
+
+    def run
+      options = parse_options
+
+      if options[:list_categories]
+        print_categories
+        return exit_success
+      end
+
+      message = Messages.random(options[:category])
+      @stdout.puts(message)
+
+      return exit_success unless options[:commit]
+
+      commit_with(message)
+    rescue OptionParser::ParseError => e
+      @stderr.puts(e.message)
+      @stderr.puts(option_parser.summarize.join)
+      exit_failure
+    end
+
+    private
+
+    def parse_options
+      options = {
+        commit: true,
+        list_categories: false,
+        category: nil
+      }
+
+      categories_text = Messages.categories.join(", ")
+      option_parser.on("-cCATEGORY", "--category=CATEGORY", "Filter by category (#{categories_text}). Default: #{Messages::DEFAULT_CATEGORY}") do |category|
+        options[:category] = category
+      end
+
+      option_parser.on("--commit", "Run `git commit -m` with the generated message") do
+        options[:commit] = true
+      end
+
+      option_parser.on("--no-commit", "Only print the message; skip running git commit") do
+        options[:commit] = false
+      end
+
+      option_parser.on("--list-categories", "List available message categories") do
+        options[:list_categories] = true
+      end
+
+      option_parser.on("-v", "--version", "Print version") do
+        @stdout.puts(Ikuzo::VERSION)
+        exit_success
+      end
+
+      option_parser.on("-h", "--help", "Show this help message") do
+        @stdout.puts(option_parser)
+        exit_success
+      end
+
+      option_parser.parse!(@argv)
+      apply_positional_arguments(options)
+      options
+    end
+
+    def option_parser
+      @option_parser ||= OptionParser.new do |opts|
+        opts.banner = "Usage: ikuzo [options] [category]"
+        opts.separator("")
+        opts.separator("Examples:")
+        opts.separator("  ikuzo")
+        opts.separator("  ikuzo funny")
+        opts.separator("  ikuzo feat --no-commit")
+        opts.separator("  ikuzo fix")
+        opts.separator("  ikuzo --category motivation --no-commit")
+      end
+    end
+
+    def apply_positional_arguments(options)
+      @argv.each do |arg|
+        normalized = arg.to_s.strip.downcase
+        next if normalized.empty?
+
+        if category_argument?(normalized) && options[:category].nil?
+          options[:category] = normalized
+        elsif normalized == "commit"
+          options[:commit] = true
+        elsif normalized == "no-commit" || normalized == "print"
+          options[:commit] = false
+        end
+      end
+    end
+
+    def category_argument?(value)
+      Messages.categories.include?(value.to_sym)
+    end
+
+    def commit_with(message)
+      success = @kernel.system("git", "commit", "-m", message)
+      return exit_success if success
+
+      @stderr.puts("git commit failed. Please ensure you're inside a Git repository with staged changes.")
+      exit_failure
+    end
+
+    def print_categories
+      @stdout.puts("Available categories:")
+      Messages.categories.each do |category|
+        description = Messages.conventional_type_description(category)
+        if description
+          @stdout.puts("  - #{category} - #{description}")
+        else
+          @stdout.puts("  - #{category}")
+        end
+      end
+    end
+
+    def exit_success
+      @kernel.exit(0)
+    end
+
+    def exit_failure
+      @kernel.exit(1)
+    end
+  end
+end

data/lib/ikuzo/messages.rb

@@ -0,0 +1,201 @@
+# frozen_string_literal: true
+
+require "open3"
+
+module Ikuzo
+  # Provides random commit messages grouped by category.
+  class Messages
+    DEFAULT_CATEGORY = :feat
+    DEFAULT_SUBJECT_CATEGORY = :funny
+    DEFAULT_CONVENTIONAL_SUBJECT = "update functionality"
+
+    CONVENTIONAL_TYPES = {
+      build: "Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)",
+      ci: "Changes to CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)",
+      chore: "Changes which don't affect source code or tests e.g. build process, auxiliary tools, libraries",
+      docs: "Documentation only changes",
+      feat: "A new feature",
+      fix: "A bug fix",
+      perf: "A change that improves performance",
+      refactor: "A change that neither fixes a bug nor adds a feature",
+      revert: "Revert something",
+      style: "Changes that do not affect the meaning of the code (formatting, missing semi-colons, etc.)",
+      test: "Adding missing tests or correcting existing tests"
+    }.freeze
+
+    STATIC_CATALOG = {
+      general: [
+        "Ship it! 🚀",
+        "Refactor today, thrive tomorrow.",
+        "Tests green, vibes high.",
+        "Merge dreams into main.",
+        "Less yak, more ship. 🪒",
+        "Deploy like nobody's watching.",
+        "Debugging wizard at work.",
+        "Automate the boring brilliance.",
+        "Feature flag? More like feature brag.",
+        "Keyboard fueled by optimism.",
+        "Pixels aligned, spirits lifted.",
+        "Compile confidence, execute courage.",
+        "Keep calm and push to main 🧘‍♂️",
+        "Documentation whispers success.",
+        "Breakpoints? Not today!",
+        "Commit like you mean it.",
+        "Sprint with a smile 🙂",
+        "Code, coffee, conquer.",
+        "Patching bugs with high-fives.",
+        "From TODO to ta-da!"
+      ].freeze,
+      funny: [
+        "It compiled on my machine, scout's honor.",
+        "Embracing the chaos-driven-dev methodology.",
+        "This commit was pair-programmed with caffeine.",
+        "¯\\_(ツ)_/¯ ship first, debug later.",
+        "Plot twist: it actually worked.",
+        "Stack trace? More like snack trace.",
+        "Linted the vibes, not the code.",
+        "Documenting bugs as future features.",
+        "No rubber duck was harmed in this fix.",
+        "Debugger? I barely know her!"
+      ].freeze,
+      motivation: [
+        "Great code starts with this commit.",
+        "Refine, refuel, release. 🔁",
+        "Iteration builds innovation.",
+        "Little wins power big releases.",
+        "Stay curious, ship bravely.",
+        "Progress is a pull request away.",
+        "Keep building, keep believing.",
+        "Quality in, confidence out.",
+        "Momentum loves momentum.",
+        "One more push toward greatness."
+      ].freeze,
+      dev: [
+        "Optimized and ready for prod traffic.",
+        "Refactoring debts into assets.",
+        "Test coverage just leveled up.",
+        "Unlocking feature flags with flair.",
+        "API contracts honored, scouts promise.",
+        "Latency drops, morale pops.",
+        "Logs cleaned, metrics gleam.",
+        "DevEx boosted, friction busted.",
+        "Main branch stays evergreen.",
+        "CI lights are greener than ever."
+      ].freeze
+    }.freeze
+
+    CONVENTIONAL_CATALOG = CONVENTIONAL_TYPES.each_with_object({}) do |(type, _), hash|
+      hash[type] = -> { conventional_message(type) }
+    end.freeze
+
+    CATALOG = STATIC_CATALOG.merge(CONVENTIONAL_CATALOG).freeze
+
+    def self.random(category = nil)
+      category = normalize_category(category)
+      candidates = messages_for(category)
+      return candidates.sample unless candidates.empty?
+
+      messages_for(DEFAULT_CATEGORY).sample
+    end
+
+    def self.categories
+      CATALOG.keys
+    end
+
+    def self.conventional_types
+      CONVENTIONAL_TYPES.keys
+    end
+
+    def self.conventional_type_description(type)
+      CONVENTIONAL_TYPES[type.to_sym] if type
+    end
+
+    def self.conventional_type?(value)
+      return false unless value
+
+      CONVENTIONAL_TYPES.key?(value.to_sym)
+    end
+
+    def self.messages_for(category)
+      category = normalize_category(category)
+      entry = CATALOG.fetch(category) { CATALOG.fetch(DEFAULT_CATEGORY) }
+      resolve_entry(entry)
+    end
+
+    def self.normalize_category(category)
+      return DEFAULT_CATEGORY unless category
+
+      sym = category.to_s.strip.downcase.to_sym
+      categories.include?(sym) ? sym : DEFAULT_CATEGORY
+    end
+
+    def self.resolve_entry(entry)
+      case entry
+      when Proc
+        value = entry.call
+        return resolve_entry(CATALOG.fetch(DEFAULT_CATEGORY)) if value.nil? || (value.respond_to?(:empty?) && value.empty?)
+
+        Array(value)
+      when Array
+        entry
+      else
+        Array(entry)
+      end
+    end
+    private_class_method :resolve_entry
+
+    def self.conventional_message(type)
+      subject_parts = [branch_subject, sanitized_default_subject].compact.reject(&:empty?)
+      subject = subject_parts.join(" ").strip
+      subject = DEFAULT_CONVENTIONAL_SUBJECT if subject.empty?
+      "#{type}: #{subject}"
+    end
+    private_class_method :conventional_message
+
+    def self.current_branch
+      stdout, status = Open3.capture2("git", "rev-parse", "--abbrev-ref", "HEAD")
+      return unless status.success?
+
+      branch = stdout.strip
+      return if branch.empty? || branch == "HEAD"
+
+      branch
+    rescue StandardError
+      nil
+    end
+    private_class_method :current_branch
+
+    def self.branch_subject
+      branch = current_branch
+      return unless branch
+
+      short_name = branch.split("/").last
+      sanitize_subject(short_name)
+    end
+    private_class_method :branch_subject
+
+    def self.sanitized_default_subject
+      source_category = STATIC_CATALOG.key?(DEFAULT_CATEGORY) ? DEFAULT_CATEGORY : DEFAULT_SUBJECT_CATEGORY
+      entry = STATIC_CATALOG[source_category] || STATIC_CATALOG[DEFAULT_SUBJECT_CATEGORY]
+      return unless entry
+
+      candidates = resolve_entry(entry)
+      message = candidates.sample
+      sanitized = sanitize_subject(message)
+      sanitized unless sanitized.empty?
+    end
+    private_class_method :sanitized_default_subject
+
+    def self.sanitize_subject(value)
+      return "" unless value
+
+      value
+        .to_s
+        .downcase
+        .gsub(/[^a-z0-9\s\-]/, " ")
+        .gsub(/\s+/, " ")
+        .strip
+    end
+    private_class_method :sanitize_subject
+  end
+end

data/lib/ikuzo/version.rb

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

data/lib/ikuzo.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "ikuzo/version"
+require "ikuzo/messages"
+require "ikuzo/cli"
+
+module Ikuzo
+  def self.random(category = nil)
+    Messages.random(category)
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: ikuzo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dang Quang Minh
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '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'
+description: Ikuzo delivers short, humorous, and motivational commit messages for
+  developers via both CLI and library usage.
+email:
+- ojisanchamchi@gmail.com
+executables:
+- ikuzo
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/ikuzo
+- ikuzo.gemspec
+- lib/ikuzo.rb
+- lib/ikuzo/cli.rb
+- lib/ikuzo/messages.rb
+- lib/ikuzo/version.rb
+homepage: https://github.com/ojisanchamchi/ruby_ikuzo#readme
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ojisanchamchi/ruby_ikuzo#readme
+  source_code_uri: https://github.com/ojisanchamchi/ruby_ikuzo
+  changelog_uri: https://github.com/ojisanchamchi/ruby_ikuzo/releases
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Generate fun, motivational commit messages.
+test_files: []