ruby-maat 1.2.0 → 1.3.4

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-maat
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.4
 platform: ruby
 authors:
 - Adam Tornhill
@@ -9,7 +9,7 @@ authors:
 - Bart Agapinan
 bindir: exe
 cert_chain: []
-date: 2025-08-17 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: csv
@@ -43,16 +43,22 @@ dependencies:
   name: rover-df
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: Ruby Maat is a command line tool used to mine and analyze data from version-control
   systems (VCS). This is a Ruby port of the original Clojure Code Maat.
 email:
@@ -63,19 +69,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".commitlintrc.json"
-- ".mailmap"
 - ".overcommit.yml"
 - ".release-please-manifest.json"
 - ".rspec"
 - ".rubocop.yml"
 - ".standard.yml"
 - CHANGELOG.md
-- CI_CD_SETUP.md
 - CLAUDE.md
 - Dockerfile
 - README.md
-- README_RUBY.md
-- RUBY_MAAT.md
 - Rakefile
 - doc/imgs/abs_churn_sample.png
 - doc/imgs/code_age_sample.png
@@ -106,6 +108,7 @@ files:
 - lib/ruby_maat/generators/git_generator.rb
 - lib/ruby_maat/generators/svn_generator.rb
 - lib/ruby_maat/groupers/layer_grouper.rb
+- lib/ruby_maat/groupers/merge_commit_grouper.rb
 - lib/ruby_maat/groupers/team_mapper.rb
 - lib/ruby_maat/groupers/time_grouper.rb
 - lib/ruby_maat/output/csv_output.rb
@@ -142,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A command line tool used to mine and analyze data from version-control systems
 test_files: []

data/.mailmap

@@ -1,3 +0,0 @@
-Adam Tornhill <adam@adamtornhill.com> Adam Petersen <adam@adampetersen.se>
-robertc <robert@logicalchaos.org> LogicalChaos <robert@logicalchaos.org>
-Adam Tornhill <adam@adamtornhill.com> Adam Petersen Tornhill <adam@adampetersen.se>

data/CI_CD_SETUP.md

@@ -1,180 +0,0 @@
-# CI/CD Setup Documentation
-
-This document describes the GitHub Actions CI/CD pipeline for the Ruby Maat project.
-
-## Workflows
-
-### 1. CI Workflow (`.github/workflows/ci.yml`)
-
-Runs on every push and pull request to main/master branches.
-
-#### Jobs
-
-- **Test**: Runs RSpec tests across multiple Ruby versions (3.2, 3.3, 3.4) and operating systems (Ubuntu, macOS, Windows)
-- **Lint**: Runs RuboCop and StandardRB linting
-- **Security**: Runs Bundler Audit for security vulnerabilities
-- **Integration**: Tests CLI functionality with sample data
-- **Build**: Builds the gem and uploads it as an artifact
-
-#### Matrix Testing
-
-- Ruby versions: 3.2, 3.3, 3.4
-- Operating systems: Ubuntu (all versions), macOS (all versions), Windows (Ruby 3.3 only)
-
-### 2. Release Please Workflow (`.github/workflows/publish.yml`)
-
-Runs on every push to main/master branches and uses conventional commits to automate releases.
-
-#### How it works
-
-1. **Release Please** analyzes conventional commits since the last release
-2. **Creates Release PRs** when releasable changes are detected
-3. **Merging a Release PR** triggers the actual release:
-   - Updates version in `lib/ruby_maat/version.rb` and `ruby-maat.gemspec`
-   - Generates/updates `CHANGELOG.md` automatically
-   - Creates a GitHub release with the changelog
-   - Runs full test suite and linting
-   - Publishes gem to RubyGems.org
-   - Uploads gem artifact to the release
-
-## Required Secrets
-
-To enable automatic publishing to RubyGems, add these secrets to your GitHub repository:
-
-### RubyGems API Key
-
-1. Get your API key from [RubyGems.org](https://rubygems.org/profile/edit)
-2. Add it as a repository secret named `RUBYGEMS_API_KEY`
-
-### GitHub Token
-
-- `GITHUB_TOKEN` is automatically provided by GitHub Actions
-
-## Environment Setup
-
-The publish workflow uses a GitHub Environment named `rubygems` for additional security. To set this up:
-
-1. Go to your repository Settings → Environments
-2. Create an environment named `rubygems`
-3. Add protection rules (recommended):
-   - Required reviewers
-   - Deployment branches (limit to main/master)
-
-## Dependabot
-
-Dependabot is configured to:
-
-- Check for Ruby gem updates weekly (Sundays at 09:00)
-- Check for GitHub Actions updates weekly
-- Create PRs with appropriate labels and assignees
-
-## Coverage Reporting
-
-SimpleCov is configured to:
-
-- Generate coverage reports for all test runs
-- Group coverage by component (Analyses, Parsers, Output)
-- Require minimum 50% coverage (adjustable in `spec/spec_helper.rb`)
-- Upload coverage to Codecov (when CODECOV_TOKEN is set)
-
-## Security Scanning
-
-The CI pipeline includes:
-
-- Bundler Audit for dependency vulnerabilities
-- RuboCop security cops
-- Dependabot security updates
-
-## Local Development
-
-To run the same checks locally:
-
-```bash
-# Install dependencies
-bundle install
-
-# Run tests with coverage
-bundle exec rspec
-
-# Run linting
-bundle exec rubocop
-bundle exec standardrb
-
-# Run security audit
-bundle exec bundler-audit
-
-# Build gem
-gem build ruby-maat.gemspec
-```
-
-## Triggering a Release
-
-Release Please uses **conventional commits** to automatically determine version bumps and generate changelogs:
-
-### Conventional Commit Format
-
-```
-<type>(<scope>): <description>
-
-[optional body]
-
-[optional footer(s)]
-```
-
-### Commit Types
-
-- `feat:` - New features (triggers minor version bump)
-- `fix:` - Bug fixes (triggers patch version bump)
-- `feat!:` or `BREAKING CHANGE:` - Breaking changes (triggers major version bump)
-- `docs:`, `style:`, `refactor:`, `test:`, `chore:`, `ci:`, `deps:` - No version bump
-
-### Release Process
-
-1. **Make commits** using conventional commit format
-2. **Push to main/master** - Release Please analyzes commits
-3. **Review Release PR** - Automatically created when releasable changes exist
-4. **Merge Release PR** - Triggers automatic release and publication
-
-### Example Commits
-
-```bash
-git commit -m "feat(analysis): add new coupling algorithm"
-git commit -m "fix(parser): handle empty git logs correctly"
-git commit -m "docs: update CLI usage examples"
-git commit -m "feat!: change CLI argument format" # breaking change
-```
-
-### Set up commit message template
-
-```bash
-git config commit.template .gitmessage
-```
-
-## Troubleshooting
-
-### Gem Push Fails
-
-- Verify `RUBYGEMS_API_KEY` secret is set correctly
-- Ensure you have push permissions to the gem on RubyGems.org
-- Check that the gem version hasn't been published already
-
-### Test Failures
-
-- Check the CI logs for specific failure reasons
-- Ensure all dependencies are properly specified
-- Test matrix may reveal OS or Ruby version specific issues
-
-### Coverage Too Low
-
-- Add tests for uncovered code
-- Adjust minimum coverage threshold in `spec/spec_helper.rb` if needed
-- Check coverage report in the `coverage/` directory after running tests
-
-## Badge Status
-
-Add these badges to your README to show CI status:
-
-```markdown
-![CI](https://github.com/viamin/ruby-maat/workflows/CI/badge.svg)
-![Gem Version](https://badge.fury.io/rb/ruby-maat.svg)
-```

data/README_RUBY.md

@@ -1,300 +0,0 @@
-# Ruby Maat
-
-[![Gem Version](https://badge.fury.io/rb/ruby-maat.svg)](https://badge.fury.io/rb/ruby-maat)
-[![Build Status](https://github.com/viamin/ruby-maat/workflows/CI/badge.svg)](https://github.com/viamin/ruby-maat/actions)
-
-Ruby Maat is a command line tool used to mine and analyze data from version-control systems (VCS). It's a Ruby port of the original [Code Maat](https://github.com/adamtornhill/code-maat) by Adam Tornhill.
-
-Ruby Maat was developed to accompany the discussions in the books [Your Code as a Crime Scene](https://pragprog.com/titles/atcrime/your-code-as-a-crime-scene) and [Software Design X-Rays](https://pragprog.com/titles/atevol/software-design-x-rays).
-
-**Note:** The analyses have evolved into [CodeScene](https://codescene.io/), which automates all the analyses found in Ruby Maat and several new ones.
-
-## Drop-in Replacement
-
-Ruby Maat is designed as a **drop-in replacement** for Code Maat. It supports:
-
-- ✅ Identical command-line arguments
-- ✅ Same VCS log file formats  
-- ✅ Compatible CSV output format
-- ✅ All original analysis types
-
-Simply replace `java -jar code-maat.jar` with `ruby-maat` in your existing scripts!
-
-## Installation
-
-### Via RubyGems (Recommended)
-
-```bash
-gem install ruby-maat
-```
-
-### From Source
-
-```bash
-git clone https://github.com/viamin/ruby-maat.git
-cd ruby-maat
-bundle install
-rake install
-```
-
-### Requirements
-
-- Ruby 3.2 or later
-- No external dependencies beyond the gem requirements
-
-## Usage
-
-### Basic Usage
-
-```bash
-# Analyze Git repository
-ruby-maat -l logfile.log -c git2 -a summary
-
-# With specific analysis
-ruby-maat -l logfile.log -c git2 -a coupling
-
-# Write to file
-ruby-maat -l logfile.log -c git2 -a authors -o results.csv
-```
-
-### Command Line Options
-
-```
-Usage: ruby-maat -l log-file -c vcs-type [options]
-
-Required:
-  -l, --log LOG                    Log file with input data
-  -c, --version-control VCS        Input vcs module type: supports svn, git, git2, hg, p4, or tfs
-
-Analysis:
-  -a, --analysis ANALYSIS          The analysis to run (default: authors)
-                                   Available: abs-churn, age, author-churn, authors, communication, 
-                                   coupling, entity-churn, entity-effort, entity-ownership, 
-                                   fragmentation, identity, main-dev, main-dev-by-revs, messages, 
-                                   refactoring-main-dev, revisions, soc, summary
-
-Output:
-  -r, --rows ROWS                  Max rows in output
-  -o, --outfile OUTFILE            Write the result to the given file name
-      --input-encoding ENCODING    Specify an encoding other than UTF-8 for the log file
-
-Grouping:
-  -g, --group GROUP                A file with a pre-defined set of layers
-  -p, --team-map-file TEAM_MAP     A CSV file with author,team mappings
-  -t, --temporal-period PERIOD     Group commits by temporal period
-
-Filtering:
-  -n, --min-revs MIN_REVS          Minimum number of revisions (default: 5)
-  -m, --min-shared-revs MIN_SHARED Minimum shared revisions (default: 5)
-  -i, --min-coupling MIN_COUPLING  Minimum coupling percentage (default: 30)
-  -x, --max-coupling MAX_COUPLING  Maximum coupling percentage (default: 100)
-  -s, --max-changeset-size SIZE    Maximum changeset size (default: 30)
-
-Analysis-specific:
-  -e, --expression-to-match REGEX  Regex for commit message analysis
-  -d, --age-time-now DATE          Reference date for age analysis (YYYY-MM-dd)
-      --verbose-results            Include additional analysis details
-
-Other:
-  -h, --help                       Show this help message
-      --version                    Show version information
-```
-
-## Generating Input Data
-
-Ruby Maat operates on log files from version-control systems. **Use the exact same commands as Code Maat:**
-
-### Git (Recommended: git2 format)
-
-```bash
-git log --all --numstat --date=short --pretty=format:'--%h--%ad--%aN' --no-renames --after=YYYY-MM-DD > logfile.log
-```
-
-Then use `-c git2` when running Ruby Maat.
-
-### Git (Legacy format)
-
-```bash
-git log --pretty=format:'[%h] %aN %ad %s' --date=short --numstat --after=YYYY-MM-DD > logfile.log
-```
-
-Then use `-c git` when running Ruby Maat.
-
-### Subversion
-
-```bash
-svn log -v --xml > logfile.log -r {YYYYmmDD}:HEAD
-```
-
-### Other VCS Systems
-
-Ruby Maat supports the same log formats as Code Maat for:
-
-- Mercurial (`hg`)
-- Perforce (`p4`)
-- Team Foundation Server (`tfs`)
-
-See the [original documentation](https://github.com/adamtornhill/code-maat#generating-input-data) for specific commands.
-
-## Available Analyses
-
-| Analysis | Description |
-|----------|-------------|
-| `authors` | Number of authors per module (default) |
-| `revisions` | Number of revisions per entity |
-| `coupling` | Logical coupling between modules |
-| `soc` | Sum of coupling per entity |
-| `summary` | High-level project statistics |
-| `abs-churn` | Absolute code churn over time |
-| `author-churn` | Code churn per author |
-| `entity-churn` | Code churn per entity |
-| `entity-ownership` | Code ownership per author per entity |
-| `main-dev` | Main developer per entity (by lines) |
-| `main-dev-by-revs` | Main developer per entity (by commits) |
-| `entity-effort` | Development effort per author per entity |
-| `fragmentation` | Ownership fragmentation (fractal value) |
-| `communication` | Developer communication patterns |
-| `age` | Code age analysis |
-| `messages` | Commit message word frequency |
-| `identity` | Raw data dump (debugging) |
-
-## Examples
-
-### Authors Analysis
-
-```bash
-ruby-maat -l git.log -c git2 -a authors
-```
-
-Output:
-
-```csv
-entity,n-authors,n-revs
-InfoUtils.java,12,60
-BarChart.java,7,30
-Page.java,4,27
-```
-
-### Logical Coupling
-
-```bash
-ruby-maat -l git.log -c git2 -a coupling
-```
-
-Output:
-
-```csv
-entity,coupled,degree,average-revs
-InfoUtils.java,Page.java,78,44
-InfoUtils.java,BarChart.java,62,45
-```
-
-### Summary Statistics
-
-```bash
-ruby-maat -l git.log -c git2 -a summary
-```
-
-Output:
-
-```csv
-statistic,value
-number-of-commits,919
-number-of-entities,730
-number-of-entities-changed,3397
-number-of-authors,79
-```
-
-## Advanced Features
-
-### Architectural Grouping
-
-Group files into architectural layers:
-
-```
-# layers.txt
-src/Features/Core      => Core
-^src\/.*\/.*Tests\.cs$ => CS Tests
-```
-
-```bash
-ruby-maat -l git.log -c git2 -a coupling -g layers.txt
-```
-
-### Team Analysis
-
-Map individual authors to teams:
-
-```csv
-# teams.csv
-author,team
-john.doe,Backend Team
-jane.smith,Frontend Team
-```
-
-```bash
-ruby-maat -l git.log -c git2 -a authors -p teams.csv
-```
-
-### Temporal Analysis
-
-Group commits by time period:
-
-```bash
-ruby-maat -l git.log -c git2 -a coupling -t day
-```
-
-## Differences from Code Maat
-
-While Ruby Maat is a drop-in replacement, there are some minor differences:
-
-### Advantages
-
-- **Faster startup**: No JVM startup time
-- **Better memory efficiency**: Ruby's garbage collection
-- **Easier installation**: No Java dependencies
-- **Native Ruby integration**: Use as a library in Ruby projects
-
-### Performance
-
-- Ruby Maat may be slightly slower on very large datasets
-- For most repositories, performance is comparable
-- Memory usage is typically lower than the JVM version
-
-## Development
-
-### Running Tests
-
-```bash
-bundle install
-bundle exec rspec
-```
-
-### Code Quality
-
-```bash
-bundle exec rubocop
-```
-
-### Building the Gem
-
-```bash
-bundle exec rake build
-```
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at <https://github.com/viamin/ruby-maat>.
-
-## License
-
-Ruby Maat is distributed under the [GNU General Public License v3.0](http://www.gnu.org/licenses/gpl.html), the same license as the original Code Maat.
-
-## Acknowledgments
-
-- **Adam Tornhill** - Original Code Maat author and creator of the analysis algorithms
-- **Code Maat contributors** - For the foundational work this port is based on
-
-## About the Name
-
-Like the original Code Maat, this tool is named after Maat, the ancient Egyptian goddess of truth, justice, and order. Ruby Maat continues Maat's work of bringing order to chaotic codebases, now in Ruby.