snakommit 0.1.1 → 0.1.2

checksums.yaml

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

data/.github/workflows/cd.yml

@@ -0,0 +1,81 @@
+name: CD
+
+on:
+  workflow_run:
+    workflows: ["CI"]
+    types:
+      - completed
+
+permissions:
+  contents: write
+
+jobs:
+  merge-to-main:
+    runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0  # Needed to fetch all history and tags
+          token: ${{ secrets.WORKFLOW_TOKEN || secrets.GITHUB_TOKEN }}
+
+      - name: Setup Git identity
+        run: |
+          git config --global user.name "GitHub Actions"
+          git config --global user.email "actions@github.com"
+
+      - name: Fetch branches
+        run: |
+          git fetch origin test
+          git fetch origin main || echo "Main branch doesn't exist yet"
+
+      - name: Merge test into main
+        run: |
+          # Checkout or create main branch
+          if git show-ref --quiet refs/remotes/origin/main; then
+            git checkout -B main origin/main
+          else
+            git checkout -b main
+          fi
+
+          # Merge test into main
+          if ! git merge origin/test --no-commit; then
+            echo "Merge conflict detected, resolving in favor of test branch changes"
+            git checkout --theirs .
+            git add .
+          fi
+
+          git commit -m "Merge test into main" || echo "No changes to commit"
+          # Check if there are changes to push
+          git diff --quiet origin/main HEAD || git_has_changes=true
+
+      - name: Push to origin/main
+        run: |
+          git remote set-url origin https://x-access-token:${{ secrets.WORKFLOW_TOKEN || secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}
+          git push -f origin main
+
+      - name: Create and push new tag
+        run: |
+          # Get latest tag or default to v0.0.0
+          LATEST_TAG=$(git describe --tags --abbrev=0 2>/dev/null || echo "v0.0.0")
+          echo "Latest tag: $LATEST_TAG"
+
+          # Extract version numbers
+          MAJOR=$(echo "$LATEST_TAG" | cut -d. -f1 | sed 's/v//')
+          MINOR=$(echo "$LATEST_TAG" | cut -d. -f2)
+          PATCH=$(echo "$LATEST_TAG" | cut -d. -f3)
+          
+          echo "Current version: $MAJOR.$MINOR.$PATCH"
+
+          # Increment patch version
+          PATCH=$((PATCH + 1))
+          NEW_TAG="v$MAJOR.$MINOR.$PATCH"
+          echo "Creating new tag: $NEW_TAG"
+
+          # Create tag
+          git tag -a "$NEW_TAG" -m "Release $NEW_TAG"
+
+          # Auth and push
+          git remote set-url origin https://x-access-token:${{ secrets.WORKFLOW_TOKEN || secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}
+          git push origin "$NEW_TAG"

data/.github/workflows/ci.yml

@@ -0,0 +1,73 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - dev
+
+jobs:
+  merge-to-test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Merge dev to test
+        run: |
+            git config --global user.name "GitHub Actions"
+            git config --global user.email "actions@github.com"
+            
+            # Check if test branch exists on remote
+            if git ls-remote --exit-code --heads origin test; then
+              echo "Branch test exists, checking out"
+              git fetch origin test
+              git checkout -B test origin/test
+            else
+              echo "Branch test does not exist, creating it"
+              git checkout -b test
+            fi
+        
+            # Merge dev into test
+            if ! git merge origin/dev --no-commit; then
+              echo "Merge conflict detected, resolving in favor of dev branch changes"
+              git checkout --theirs .
+              git add .
+            fi
+        
+            git commit -m "Merge dev into test" || echo "No changes to commit"
+            git push origin test
+        
+
+  run-tests:
+    runs-on: ubuntu-latest
+    needs: merge-to-test
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          ref: test
+
+      - name: Debug available rake tasks
+        run: |
+          bundle install
+          rake -T
+          
+      - name: Run tests
+        run: |
+          rake testout@v2
+        with:
+          ref: test
+
+      - name: Set up Ruby (auto-detect from .ruby-version or Gemfile)
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.2'
+          bundler-cache: true
+
+      - name: List available Rake tasks
+        run: rake -T
+
+      - name: Run tests
+        run: rake test

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/Gemfile.lock

@@ -3,23 +3,24 @@ GEM
   specs:
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
-    ast (2.4.2)
-    diff-lcs (1.6.0)
+    ast (2.4.3)
+    diff-lcs (1.6.1)
     git (1.19.1)
       addressable (~> 2.8)
       rchardet (~> 1.8)
-    minitest (5.25.4)
-    parallel (1.24.0)
-    parser (3.3.7.1)
+    minitest (5.25.5)
+    parallel (1.26.3)
+    parser (3.3.7.4)
       ast (~> 2.4.1)
       racc
     pastel (0.8.0)
       tty-color (~> 0.5)
-    public_suffix (5.1.1)
+    prism (1.4.0)
+    public_suffix (6.0.1)
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.2.1)
-    rchardet (1.8.0)
+    rchardet (1.9.0)
     regexp_parser (2.10.0)
     rexml (3.4.1)
     rspec (3.13.0)
@@ -44,8 +45,9 @@ GEM
       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)
+    rubocop-ast (1.44.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
     ruby-progressbar (1.13.0)
     tty-color (0.6.0)
     tty-cursor (0.7.1)
@@ -78,4 +80,4 @@ DEPENDENCIES
   tty-spinner (~> 0.9.3)
 
 BUNDLED WITH
-   1.17.2
+   2.6.7

data/README.md

@@ -1,5 +1,8 @@
 # Snakommit
 
+[![Gem Version](https://badge.fury.io/rb/snakommit.svg)](https://badge.fury.io/rb/snakommit)
+[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
 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
@@ -18,7 +21,20 @@ Snakommit is a high-performance, interactive commit manager tool similar to Comm
 - Ruby >= 2.5
 - Git
 
-### Install from source
+### Option 1: Install from RubyGems (Recommended)
+
+```bash
+# Install the gem
+gem install snakommit
+```
+
+Or add to your Gemfile:
+
+```ruby
+gem 'snakommit'
+```
+
+### Option 2: Install from source
 
 You have multiple options to install Snakommit:
 
@@ -70,12 +86,6 @@ bundle install
 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:
@@ -138,8 +148,8 @@ If you encounter a "command not found" error after installation:
 
 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
+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
@@ -148,55 +158,15 @@ 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
+### CI/CD Workflow
 
 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
+- **Automated Testing**: Tests run automatically on multiple Ruby versions (2.7, 3.0, 3.1, 3.2) for all pushes to main and dev branches, as well as pull requests.
+- **Code Quality**: Automatic linting with Rubocop ensures consistent code style.
+- **Automated Releases**: New versions are published to RubyGems automatically when a release is triggered.
+
+#### Release Process
 
 To create a new release:
 
@@ -273,3 +243,10 @@ Snakommit has been optimized to offer the best possible performance, even on lar
 - Command pooling to minimize process creation overhead
 
 These optimizations allow Snakommit to remain fast and responsive even on large repositories with many files.
+
+## Contributing
+
+This project uses GitHub Actions for CI/CD:
+- Automated tests run on all PRs to main
+- Automatic version tagging on merge to main
+- Automatic gem publishing when tagged

data/Rakefile

@@ -4,17 +4,17 @@ require "rake/testtask"
 # Standard test task
 desc "Run tests"
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
+  t.libs << "tests"
   t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.test_files = FileList["tests/**/*_test.rb"]
 end
 
 # Verbose test task 
 desc "Run tests with verbose output"
 Rake::TestTask.new(:test_verbose) do |t|
-  t.libs << "test"
+  t.libs << "tests"
   t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.test_files = FileList["tests/**/*_test.rb"]
   t.verbose = true
   t.warning = true
 end
@@ -22,27 +22,27 @@ end
 # Performance tests only
 desc "Run only performance tests"
 Rake::TestTask.new(:test_performance) do |t|
-  t.libs << "test"
+  t.libs << "tests"
   t.libs << "lib"
-  t.test_files = FileList["test/performance_test.rb"]
+  t.test_files = FileList["tests/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 << "tests"
   t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"] - FileList["test/performance_test.rb"]
+  t.test_files = FileList["tests/**/*_test.rb"] - FileList["tests/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 << "tests"
     t.libs << "lib"
-    t.test_files = FileList["test/#{component}_test.rb"]
+    t.test_files = FileList["tests/#{component}_test.rb"]
   end
 end
 

data/lib/snakommit/cli.rb

@@ -26,16 +26,12 @@ module Snakommit
 
     def run(args)
       command = args.shift || 'commit'
-      
-      # Start monitoring execution time
       trace_start = Time.now
       
-      # Execute the command with performance monitoring
       result = @monitor.measure(:command_execution) do
         execute_command(command, args)
       end
       
-      # Record command execution metrics if in debug mode
       if ENV['SNAKOMMIT_DEBUG']
         trace_end = Time.now
         puts "\nCommand execution completed in #{(trace_end - trace_start).round(3)}s"
@@ -52,28 +48,17 @@ module Snakommit
     
     def execute_command(command, args)
       case command
-      when 'commit'
-        handle_commit
-      when 'version', '-v', '--version'
-        show_version
-      when 'help', '-h', '--help'
-        show_help
-      when 'hooks'
-        handle_hooks(args)
-      when 'templates'
-        handle_templates(args)
-      when 'emoji'
-        handle_emoji_toggle(args)
-      when 'update'
-        check_for_updates(args.include?('--force'))
-      when 'validate-message'
-        validate_commit_message(args.first)
-      when 'prepare-message'
-        prepare_commit_message
-      when 'log-commit'
-        log_commit(args.first)
-      else
-        unknown_command(command)
+      when 'commit'         then handle_commit
+      when 'version', '-v', '--version' then show_version
+      when 'help', '-h', '--help' then show_help
+      when 'hooks'          then handle_hooks(args)
+      when 'templates'      then handle_templates(args)
+      when 'emoji'          then handle_emoji_toggle(args)
+      when 'update'         then check_for_updates(args.include?('--force'))
+      when 'validate-message' then validate_commit_message(args.first)
+      when 'prepare-message'  then prepare_commit_message
+      when 'log-commit'     then log_commit(args.first)
+      else unknown_command(command)
       end
     end
 
@@ -177,9 +162,7 @@ module Snakommit
         puts "#{hook_name}: #{status[hook_name] || 'unknown'}"
       else
         puts "Git hooks status:"
-        status.each do |hook, state|
-          puts "  #{hook}: #{state}"
-        end
+        status.each { |hook, state| puts "  #{hook}: #{state}" }
       end
     end
 
@@ -187,12 +170,9 @@ module Snakommit
       subcommand = args.shift || 'list'
       
       case subcommand
-      when 'list'
-        list_emoji_mappings
-      when 'update'
-        update_emoji_mapping(args)
-      when 'reset'
-        reset_emoji_mappings
+      when 'list'     then list_emoji_mappings
+      when 'update'   then update_emoji_mapping(args)
+      when 'reset'    then reset_emoji_mappings
       else
         puts "Unknown templates subcommand: #{subcommand}"
         show_help
@@ -201,16 +181,14 @@ module Snakommit
     end
 
     def list_emoji_mappings
-      mappings = @templates.list_emoji_mappings
       puts "Emoji mappings for commit types:"
-      mappings.each do |mapping|
+      @templates.list_emoji_mappings.each do |mapping|
         puts "  #{mapping[:type]}: #{mapping[:emoji]}"
       end
     end
 
     def update_emoji_mapping(args)
-      type = args.shift
-      emoji = args.shift
+      type, emoji = args.shift(2)
       
       if type && emoji
         begin
@@ -249,15 +227,13 @@ module Snakommit
 
     def prepare_commit_message
       # This would normally invoke the interactive prompt
-      # For now, just return a simple message for testing
       puts "chore: automated commit message from snakommit"
       exit 0
     end
 
     def log_commit(commit_hash)
       # In the future, this will store commit stats
-      exit 0 if commit_hash
-      exit 1
+      exit commit_hash ? 0 : 1
     end
 
     def check_for_updates(force = false)
@@ -268,16 +244,14 @@ module Snakommit
       
       begin
         # Get the latest version from RubyGems
-        response = nil
-        @monitor.measure(:fetch_rubygems) do
-          response = URI.open("https://rubygems.org/api/v1/gems/snakommit.json").read
+        response = @monitor.measure(:fetch_rubygems) do
+          URI.open("https://rubygems.org/api/v1/gems/snakommit.json").read
         end
         
         data = JSON.parse(response)
         latest_version = data["version"]
         current_version = Snakommit::VERSION
         
-        # Compare versions
         if force || latest_version > current_version
           update_gem(latest_version, current_version)
         else
@@ -289,7 +263,6 @@ module Snakommit
       end
     end
     
-    # Update to the latest gem version
     def update_gem(latest_version, current_version)
       puts "New version available: #{latest_version} (current: #{current_version})"
       
@@ -323,21 +296,17 @@ module Snakommit
 
     # Handle initialization errors in a user-friendly way
     def handle_initialization_error(error)
-      case error
-      when Prompt::PromptError
-        puts "Error initializing prompt: #{error.message}"
-      when Templates::TemplateError
-        puts "Error initializing templates: #{error.message}"
-      when Hooks::HookError
-        puts "Error initializing hooks: #{error.message}"
-      when Config::ConfigError
-        puts "Error loading configuration: #{error.message}"
-      when Git::GitError
-        puts "Git error: #{error.message}"
-      else
-        puts "Initialization error: #{error.message}"
-        puts "Backtrace:\n  #{error.backtrace.join("\n  ")}" if ENV['SNAKOMMIT_DEBUG']
-      end
+      error_msg = case error
+                  when Prompt::PromptError    then "Error initializing prompt: #{error.message}"
+                  when Templates::TemplateError then "Error initializing templates: #{error.message}"
+                  when Hooks::HookError       then "Error initializing hooks: #{error.message}"
+                  when Config::ConfigError    then "Error loading configuration: #{error.message}"
+                  when Git::GitError          then "Git error: #{error.message}"
+                  else "Initialization error: #{error.message}"
+                  end
+      
+      puts error_msg
+      puts "Backtrace:\n  #{error.backtrace.join("\n  ")}" if ENV['SNAKOMMIT_DEBUG']
       
       puts "\nTrying to run snakommit in a non-Git repository? Make sure you're in a valid Git repository."
       puts "For more information, run 'snakommit help'"
@@ -346,23 +315,18 @@ module Snakommit
 
     # Handle runtime errors in a user-friendly way
     def handle_runtime_error(error)
-      case error
-      when Prompt::PromptError
-        puts "Error during prompt: #{error.message}"
-      when Templates::TemplateError
-        puts "Template error: #{error.message}"
-      when Hooks::HookError
-        puts "Hook error: #{error.message}"
-      when Config::ConfigError
-        puts "Configuration error: #{error.message}"
-      when Git::GitError
-        puts "Git error: #{error.message}"
-      when CLIError
-        puts "CLI error: #{error.message}"
-      else
-        puts "Error: #{error.message}"
-        puts "Backtrace:\n  #{error.backtrace.join("\n  ")}" if ENV['SNAKOMMIT_DEBUG']
-      end
+      error_msg = case error
+                  when Prompt::PromptError    then "Error during prompt: #{error.message}"
+                  when Templates::TemplateError then "Template error: #{error.message}"
+                  when Hooks::HookError       then "Hook error: #{error.message}"
+                  when Config::ConfigError    then "Configuration error: #{error.message}"
+                  when Git::GitError          then "Git error: #{error.message}"
+                  when CLIError               then "CLI error: #{error.message}"
+                  else "Error: #{error.message}"
+                  end
+      
+      puts error_msg
+      puts "Backtrace:\n  #{error.backtrace.join("\n  ")}" if ENV['SNAKOMMIT_DEBUG']
       
       puts "\nFor help, run 'snakommit help'"
       exit 1