snakommit 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0fa7760fe40ddf90aac4e7c28b71eb1935ab5f1b9f704f990cc377a4294b724b
+  data.tar.gz: 2f5835b7d423667bf56fee1c2df02091d7cf9502ac7b80910658c93990d6043f
+SHA512:
+  metadata.gz: 6bf5b5878c2871fa3df4837921387a8fceadd542919c40e2b449d83da83f2aded6ef5b804f7ea32878c23028123e16796bcb4a81c6bff273410a67c92343165c
+  data.tar.gz: 6f32299d57207644a3c9100146e1fa0066c1c82b1bfe2065b7d332d312ba41f1702e1d7d2682aafb6dde141aa1434c6e49ca04afe074bad2b4d0f8e076fd0607

data/.gitignore

@@ -0,0 +1,104 @@
+# File created using '.gitignore Generator' for Visual Studio Code: https://bit.ly/vscode-gig
+# Created by https://www.toptal.com/developers/gitignore/api/visualstudiocode,macos,go
+# Edit at https://www.toptal.com/developers/gitignore?templates=visualstudiocode,macos,go
+
+### Go ###
+# If you prefer the allow list template instead of the deny list, see community template:
+# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
+#
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Dependency directories (remove the comment below to include it)
+# vendor/
+
+# Go workspace file
+go.work
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### macOS Patch ###
+# iCloud generated files
+*.icloud
+
+### VisualStudioCode ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
+.ionide
+
+# End of https://www.toptal.com/developers/gitignore/api/visualstudiocode,macos,go
+
+# Custom rules (everything added below won't be overriden by 'Generate .gitignore File' if you use 'Update' option)
+
+*.gem
+
+# Gem builds
+*.gem
+
+# RubyGems credentials
+/.rubygems
+/.gem/credentials
+
+# Test coverage
+/coverage/
+/.nyc_output/
+
+# IDE files
+.idea/
+.vscode/
+*.sublime-project
+*.sublime-workspace
+
+# Ruby debugger
+.byebug_history

data/CHANGELOG.md

@@ -0,0 +1,55 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+### Added
+- CI/CD pipeline for automated testing and releases
+- Automated RubyGems publishing
+
+## [0.1.1] - 2023-04-01
+### Added
+- Support for emoji in commit messages with toggle capability
+- Performance optimization features including caching and batch processing
+- Enhanced Git hooks integration with automatic install/uninstall
+- Custom emoji configuration with YAML file support
+- Added comprehensive credits and acknowledgements
+- Added `sk` command as a shorter alias for `snakommit`
+- File selection persistence between sessions
+- Quick emoji toggle with `sk emoji on|off` command
+- Self-update functionality with `sk update` command
+
+## [0.1.0] - 2025-03-09
+### Added
+- Initial release
+- Interactive CLI for creating conventional commit messages
+- Automatic Git repository detection
+- File staging assistance (`git add` functionality)
+- Customizable commit types and scopes
+- Breaking change detection
+- Issue reference linking
+
+## 🚀 Roadmap
+
+Future releases will focus on:
+
+### Performance Optimizations
+- [ ] Parallel processing for large repositories
+- [ ] Smart caching of Git operations
+- [ ] Optimized file status detection
+- [ ] Performance profiling and monitoring
+
+### Additional Commit Message Templates
+- [ ] Support for more conventional formats
+- [ ] Custom template creation UI
+- [ ] Import/export of templates
+- [ ] Enhanced validation rules
+
+### Enhanced Git Hooks Integration
+- [ ] Pre-push hook integration
+- [ ] Custom hook scripting
+- [ ] CI/CD system integration
+- [ ] Repository-specific configurations 

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+gem 'tty-prompt', '~> 0.23.1'   # For interactive prompts
+gem 'tty-spinner', '~> 0.9.3'   # For loading spinners
+gem 'tty-color', '~> 0.6.0'     # For colorized output
+gem 'tty-screen', '~> 0.8.1'    # For screen dimensions
+gem 'pastel', '~> 0.8.0'        # For minimal terminal colors
+gem 'git', '~> 1.12'            # For Git integration
+
+group :development, :test do
+  gem 'rake', '~> 13.0'         # For running tasks
+  gem 'minitest', '~> 5.16'     # For testing
+  gem 'rspec', '~> 3.10'        # For testing
+  gem 'rubocop', '~> 1.25.1'    # For code linting
+end 

data/Gemfile.lock

@@ -0,0 +1,81 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    ast (2.4.2)
+    diff-lcs (1.6.0)
+    git (1.19.1)
+      addressable (~> 2.8)
+      rchardet (~> 1.8)
+    minitest (5.25.4)
+    parallel (1.24.0)
+    parser (3.3.7.1)
+      ast (~> 2.4.1)
+      racc
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    public_suffix (5.1.1)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    rchardet (1.8.0)
+    regexp_parser (2.10.0)
+    rexml (3.4.1)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.3)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.2)
+    rubocop (1.25.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.15.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    tty-color (0.6.0)
+    tty-cursor (0.7.1)
+    tty-prompt (0.23.1)
+      pastel (~> 0.8)
+      tty-reader (~> 0.8)
+    tty-reader (0.9.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.2)
+    tty-spinner (0.9.3)
+      tty-cursor (~> 0.7)
+    unicode-display_width (2.6.0)
+    wisper (2.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  git (~> 1.12)
+  minitest (~> 5.16)
+  pastel (~> 0.8.0)
+  rake (~> 13.0)
+  rspec (~> 3.10)
+  rubocop (~> 1.25.1)
+  tty-color (~> 0.6.0)
+  tty-prompt (~> 0.23.1)
+  tty-screen (~> 0.8.1)
+  tty-spinner (~> 0.9.3)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Antonia_LP
+
+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,275 @@
+# Snakommit
+
+Snakommit is a high-performance, interactive commit manager tool similar to Commitizen. It helps teams maintain consistent commit message formats by guiding developers through the process of creating standardized commit messages.
+
+## Features
+
+- Interactive CLI for creating conventional commit messages
+- Automatic Git repository detection
+- File staging assistance (`git add` functionality)
+- Customizable commit types and scopes
+- Breaking change detection
+- Issue reference linking
+
+## Installation
+
+### Prerequisites
+
+- Ruby >= 2.5
+- Git
+
+### Install from source
+
+You have multiple options to install Snakommit:
+
+#### Option 1: Install to /usr/local/bin (requires sudo)
+
+```bash
+# Clone the repository
+git clone git@github.com:antonia-pl/snakommit.git
+cd snakommit
+
+# Install dependencies
+bundle install
+
+# Create a symlink to use the tool globally
+sudo ln -s "$(pwd)/bin/snakommit" /usr/local/bin/snakommit
+```
+
+#### Option 2: Install to your home directory (no sudo required)
+
+```bash
+# Clone the repository
+git clone git@github.com:antonia-pl/snakommit.git
+cd snakommit
+
+# Install dependencies
+bundle install
+
+# Create a bin directory in your home folder (if it doesn't exist)
+mkdir -p ~/bin
+
+# Create a symlink in your home bin directory
+ln -s "$(pwd)/bin/snakommit" ~/bin/snakommit
+
+# Add this line to your ~/.zshrc or ~/.bash_profile and restart your terminal
+# export PATH="$HOME/bin:$PATH"
+```
+
+#### Option 3: Run directly from the repository
+
+```bash
+# Clone the repository
+git clone git@github.com:antonia-pl/snakommit.git
+cd snakommit
+
+# Install dependencies
+bundle install
+
+# Run snakommit directly
+ruby -Ilib bin/snakommit
+```
+
+### Install via Homebrew (Coming soon)
+
+```bash
+/!\ - (coming soon) - TODO
+```
+
+## Usage
+
+Simply run `snakommit` (or its shorter alias `sk`) in your Git repository:
+
+```bash
+snakommit  # or 'sk' for short
+```
+
+This will launch the interactive commit flow that will:
+
+1. Check if you're in a Git repository
+2. Detect changes in your working directory
+3. Help you stage files if needed
+4. Guide you through creating a standardized commit message
+5. Commit your changes
+
+### Commands
+
+- `snakommit` or `sk` - Run the default commit flow
+- `snakommit emoji [on|off]` or `sk emoji [on|off]` - Quick toggle for emoji in commit messages
+- `snakommit update` or `sk update` - Check for and install the latest version
+- `snakommit help` or `sk help` - Show help information
+- `snakommit version` or `sk version` - Show version information
+- `snakommit templates` or `sk templates` - Manage emoji for commit types
+- `snakommit hooks` or `sk hooks` - Manage Git hooks integration
+
+## Configuration
+
+Snakommit uses a YAML configuration file located at `~/.snakommit.yml`. A default configuration is created on first run, which you can customize to fit your project needs.
+
+Example configuration:
+
+```yaml
+types:
+  - name: feat
+    description: A new feature
+  - name: fix
+    description: A bug fix
+  # ... more types
+scopes:
+  - ui
+  - api
+  - database
+  # ... custom scopes for your project
+max_subject_length: 100
+max_body_line_length: 72
+```
+
+## Troubleshooting
+
+### Command not found after installation
+
+If you encounter a "command not found" error after installation:
+
+1. Make sure the symlink was created successfully
+2. If you installed to ~/bin, ensure your PATH includes this directory
+3. Try running with the full path to the executable
+
+### Permission issues
+
+If you encounter permission issues during installation:
+
+1. Try the alternative installation methods that don't require sudo
+2. Ensure your Ruby environment has the correct permissions
+3. Check that the executable bit is set on the bin/snakommit file:
+
+```bash
+chmod +x bin/snakommit
+```
+
+## Development
+
+### Testing
+
+Snakommit has a comprehensive test suite that covers its functionality. The test suite is built using Minitest and includes unit tests, integration tests, and performance tests.
+
+#### Running Tests
+
+Run all the tests:
+
+```bash
+bundle exec rake test
+```
+
+Run specific types of tests:
+
+```bash
+# Run only unit tests (fast)
+bundle exec rake test_unit
+
+# Run only performance tests
+bundle exec rake test_performance
+
+# Run tests for a specific component
+bundle exec rake test_git
+bundle exec rake test_config
+bundle exec rake test_templates
+bundle exec rake test_hooks
+
+# Run tests with verbose output
+bundle exec rake test_verbose
+
+# Run both tests and linting
+bundle exec rake
+```
+
+#### Writing Tests
+
+When adding new features or fixing bugs, please add or update the corresponding tests. The test files are located in the `test/` directory and follow the pattern `test/component_test.rb`.
+
+Each test file contains a class that inherits from `Minitest::Test` and includes test methods that start with `test_`.
+
+For more detailed information about testing Snakommit, see [TESTING.md](TESTING.md).
+
+### CI/CD
+
+Snakommit uses GitHub Actions for continuous integration and deployment:
+
+- **Automated testing** on multiple Ruby versions for all pushes and pull requests
+- **Automated releases** to RubyGems when a new version is tagged
+- **Automated version bumping** via workflow dispatch
+
+To create a new release:
+
+1. Go to the GitHub Actions tab
+2. Select the "Release" workflow
+3. Click "Run workflow"
+4. Choose the type of version bump (patch, minor, or major)
+
+This will automatically:
+- Run all tests
+- Bump the version in the codebase
+- Update the CHANGELOG
+- Create a Git tag and GitHub release
+- Publish to RubyGems.org
+
+## License
+
+MIT
+
+## 📝 Credits & Inspiration
+
+Snakommit was inspired by and builds upon these fantastic projects:
+
+### Similar Tools
+- [Commitizen](https://github.com/commitizen/cz-cli) - The original concept of CLI interface for conventional commits
+- [Conventional Commits](https://www.conventionalcommits.org/) - The specification for commit messages
+- [Gitmoji](https://gitmoji.dev/) - For emoji integration in commit messages
+
+### Other Inspiration
+- [Semantic Release](https://github.com/semantic-release/semantic-release) - For commit message structure and formatting
+- [AngularJS Commit Guidelines](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commits) - The foundation of conventional commits
+
+## Updating
+
+To update Snakommit to the latest version, simply run:
+
+```bash
+sk update
+```
+
+This will check if a newer version is available on RubyGems.org and install it if found. If you want to force a reinstall of the latest version, you can use:
+
+```bash
+sk update --force
+```
+
+System-wide installations may require administrator privileges, which the tool will prompt for if needed.
+
+## Performance
+
+Snakommit has been optimized to offer the best possible performance, even on large projects. Here are the key improvements integrated:
+
+### Intelligent Caching
+
+- Expensive Git operations (like getting staged/unstaged files) are cached with a short TTL to optimize performance
+- Commit type formatting results with emojis are cached to avoid unnecessary recalculations 
+- Configuration is cached with invalidation based on file modification date
+
+### Batch Processing
+
+- Batch processing is used for file operations to reduce system calls
+- Automatic parallelization options for large operations when the `parallel` gem is available
+
+### Performance Monitoring
+
+- An integrated monitoring system measures the performance of critical operations
+- In DEBUG mode (`SNAKOMMIT_DEBUG=1`), detailed performance information is displayed
+- Benchmarking and profiling utilities are available for developers
+
+### Optimized Memory Management
+
+- Efficient use of system resources
+- Proactive cache cleaning to reduce memory footprint
+- Command pooling to minimize process creation overhead
+
+These optimizations allow Snakommit to remain fast and responsive even on large repositories with many files.

data/Rakefile

@@ -0,0 +1,58 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+# Standard test task
+desc "Run tests"
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+# Verbose test task 
+desc "Run tests with verbose output"
+Rake::TestTask.new(:test_verbose) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+  t.warning = true
+end
+
+# Performance tests only
+desc "Run only performance tests"
+Rake::TestTask.new(:test_performance) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/performance_test.rb"]
+  t.verbose = true
+end
+
+# Unit tests only (excluding performance tests)
+desc "Run unit tests (excluding performance tests)"
+Rake::TestTask.new(:test_unit) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"] - FileList["test/performance_test.rb"]
+end
+
+# Individual component tests
+%w[config git templates hooks].each do |component|
+  desc "Run #{component} tests"
+  Rake::TestTask.new("test_#{component}") do |t|
+    t.libs << "test"
+    t.libs << "lib"
+    t.test_files = FileList["test/#{component}_test.rb"]
+  end
+end
+
+begin
+  require "rubocop/rake_task"
+  RuboCop::RakeTask.new
+  task default: %i[test rubocop]
+rescue LoadError
+  task default: %i[test]
+end
+
+desc "Run all tests and checks"
+task :ci => [:test_unit, :test_performance, :rubocop] 

data/bin/sk

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# This is an alias for snakommit
+require 'snakommit'
+
+# Just forward all arguments to the snakommit CLI
+cli = Snakommit::CLI.new
+cli.run(ARGV) 

data/bin/snakommit

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+
+require 'snakommit'
+
+# Parse command line options and run the appropriate command
+Snakommit::CLI.new.run(ARGV)