minicrest 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: efb95b1362535452ba9a0de78966811bde57ae5e89fb8c0e615613c756db1eca
+  data.tar.gz: 466d9c93d393382fe7d65135bcd38a05eb672c678995fb190b52fb0b452bf89c
+SHA512:
+  metadata.gz: cacd32523d4bfef151600ee954e2838ddb6aa9c216c931e0e74cc907518e25b0b60e723f1526f4ef2b2465d0323aa68ef281f8bfe6253639056426207cc0b5e3
+  data.tar.gz: b8e7cf8b54371bc3965da8140bbae934897c0182d914c4294c1153a5e0cb15527f8754328f0224d6c76d7a9aa4b15b5f14caf4c6e02c8709a8453bbe5b089728

data/.rubocop.yml

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+plugins:
+  - rubocop-minitest
+
+AllCops:
+  TargetRubyVersion: 3.4
+  NewCops: enable
+  SuggestExtensions: false
+
+# Test files naturally have long describe/it blocks
+Metrics/BlockLength:
+  Exclude:
+    - 'test/**/*'
+
+# Gemspec required_ruby_version is intentionally broader than development version
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+# Matcher factory methods intentionally use is_/has_ prefixes for readability
+# e.g., descends_from(), has_size(), is_greater_than() - these are Hamcrest conventions
+Naming/PredicatePrefix:
+  Exclude:
+    - 'lib/minicrest/assertions.rb'
+    - 'lib/minicrest/asserter.rb'
+    - 'lib/minicrest/has_attribute.rb'
+
+# Diff methods are inherently complex but readable as-is
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/minicrest/equals.rb'
+    - 'lib/minicrest/asserter.rb'
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'lib/minicrest/equals.rb'
+    - 'lib/minicrest/includes.rb'
+    - 'lib/minicrest/asserter.rb'
+
+Metrics/PerceivedComplexity:
+  Exclude:
+    - 'lib/minicrest/equals.rb'
+    - 'lib/minicrest/includes.rb'
+    - 'lib/minicrest/asserter.rb'
+
+Metrics/MethodLength:
+  Exclude:
+    - 'lib/minicrest/equals.rb'
+    - 'lib/minicrest/includes.rb'
+    - 'lib/minicrest/asserter.rb'
+    - 'lib/minicrest/contains_exactly.rb'
+    - 'lib/minicrest/has_attribute.rb'
+
+# Module documentation not required for simple matcher modules
+Style/Documentation:
+  Exclude:
+    - 'lib/minicrest/equals.rb'
+    - 'lib/minicrest/is.rb'
+
+# OpenStruct is fine for test fixtures
+Style/OpenStructUse:
+  Exclude:
+    - 'test/**/*'
+
+# Test helper classes defined in describe blocks are acceptable
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - 'test/**/*'
+
+# Test matcher names with numbers are intentional for uniqueness
+Naming/VariableNumber:
+  Exclude:
+    - 'test/**/*'

data/.yardopts

@@ -0,0 +1,8 @@
+--title "Minicrest Documentation"
+--main README.md
+--markup markdown
+lib/**/*.rb
+-
+README.md
+CHANGELOG.md
+LICENSE

data/AGENTS.md

@@ -0,0 +1,128 @@
+# Building Guidelines for AI Assistants
+
+This document provides guidelines for AI assistants (like Claude) when working on this project.
+
+## Development Philosophy
+
+### Test-Driven Development (TDD)
+
+This project follows strict TDD:
+
+1. **Write a failing test first** (Red)
+2. **Write minimal code to pass the test** (Green)
+3. **Refactor while keeping tests green**
+4. **Commit after every green cycle**
+
+**Never write production code without a failing test first.**
+
+### Grey-Box Testing Approach
+
+- **Test observable behavior**, not implementation details
+- **Favor integration tests** over isolated unit tests
+- **Avoid mocking** except when absolutely necessary
+
+### Commit Strategy
+
+- Commit after **every test goes green**
+- Use **small, atomic commits**
+- Commit message format:
+  - `change: <description>` - for changes to the observable behavior
+  - `refactor: <description>` - for refactors
+  - `chore: <description>` - for anything else: documentation, formatting, etc.
+
+## Project Structure
+
+```
+gwt/
+├── .tool-versions           # ASDF config file
+├── Gemfile                  # Bundler config file
+├── AGENTS.md                # This file
+├── lib/                     # Implementation of this library
+├── test/                    # Test files
+```
+
+## TDD Workflow
+
+### 1. Before Writing Any Code
+
+- Read the implementation plan (`docs/implementation-plan.md`)
+- Identify the next TDD cycle to implement
+- Understand the expected behavior
+
+### 2. Red Phase
+
+Create a test file in `tests/` that mirrors the source structure:
+
+- If implementing `lib/minicrest/foo.ts`, create `test/lib/minicrest/foo_test.rb`
+- Write one or more tests that define the expected behavior
+- Tests should **fail** when first run
+- Run `minitest` to confirm failure
+
+### 3. Green Phase
+
+- Create the corresponding source file in `lib/`
+- Write **minimal code** to make the test pass
+- Avoid over-engineering or adding features not tested
+- Run `minitest` until all tests pass
+
+### 4. Commit
+
+```bash
+git add tests/git/repo.test.ts src/git/repo.ts
+git commit -m "Change: <describe the new behavior>"
+```
+
+### 5. Refactor Phase (optional)
+
+- Wait until there's enough repetition to warrant refactoring. Skip this step if not applicable.
+- Clean up code while keeping tests green
+- Extract duplicated logic
+- Improve naming
+- Run `minitest` frequently to ensure tests still pass
+
+### 6. Commit
+
+```bash
+git add tests/git/repo.test.ts src/git/repo.ts
+git commit -m "Refactor: <describe the refactor>"
+```
+
+### 7. Repeat
+
+Move to the next TDD cycle in the implementation plan.
+
+## Testing Guidelines
+
+### Test Observable Behavior
+
+Focus on **what** the code does, not **how** it does it:
+- Outputs
+- Side effects
+- Errors
+
+### Minimize Mocking
+
+Use real implementations whenever possible:
+
+### Test Error Conditions
+
+Test both success and failure paths:
+
+### Integration Tests
+
+Test complete workflows
+
+## Summary: TDD Checklist
+
+For each feature:
+
+- [ ] Write failing test(s) that define expected behavior
+- [ ] Run tests to confirm failure (`minitest`)
+- [ ] Write minimal code to make tests pass
+- [ ] Run tests to confirm success
+- [ ] Commit the changes
+- [ ] Refactor while keeping tests green
+- [ ] Commit the refactor
+- [ ] Move to next TDD cycle
+
+**Remember**: Test first, code second, commit often!

data/CHANGELOG.md

@@ -0,0 +1,96 @@
+# 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.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2026-01-17
+
+### Added
+
+- **Core matchers**
+  - `equals(expected)` - value equality with deep comparison
+  - `is(expected)` - reference equality (now supports matchers as well, e.g., `is(anything)`)
+  - `anything` - placeholder matcher that accepts any value
+  - `never(matcher)` - negation
+
+- **Type and method matchers**
+  - `is_a(type)` (alias of `descends_from`) - type/class checking (including hierarchy)
+  - `descends_from(type)` - type/class checking (including hierarchy)
+  - `instance_of(type)` - exact class checking
+  - `responds_to(*methods)` - method presence checking
+
+- **Value matchers**
+  - `nil_value` - matches `nil`
+  - `truthy` - matches any value that is not `nil` or `false`
+  - `falsy` - matches `nil` or `false`
+
+- **String matchers**
+  - `starts_with(prefix)` - string prefix matching
+  - `ends_with(suffix)` - string suffix matching
+  - `matches_pattern(regex)` - regex pattern matching
+  - `blank` - blank string matching (empty or whitespace-only)
+
+- **Size and emptiness matchers**
+  - `empty` - empty collection matching
+  - `has_size(expected)` - size/length matching (accepts matchers)
+
+- **Numeric comparison matchers**
+  - `is_greater_than(n)`
+  - `is_greater_than_or_equal_to(n)`
+  - `is_less_than(n)`
+  - `is_less_than_or_equal_to(n)`
+  - `between(min, max, exclusive: false)` - range check
+  - `is_close_to(n, delta)` - floating-point tolerance
+
+- **Collection content matchers**
+  - `includes(*items)` - partial containment (strings, arrays, hashes)
+  - `has_key(*keys)` - hash key presence
+  - `has_value(*values)` - hash value presence
+  - `contains(*items)` - exact items in any order
+  - `contains_exactly(*items)` - exact items in exact order
+
+- **Collection item matchers**
+  - `all_items(matcher)` - all items must match
+  - `some_items(matcher)` - at least one item must match
+  - `no_items(matcher)` - no items should match
+  - `all_entries(matcher)` - all hash entries must match
+  - `some_entry(matcher)` - at least one hash entry must match
+  - `no_entry(matcher)` - no hash entries should match
+
+- **Membership matcher**
+  - `is_in(collection)` - value membership in arrays, hashes, strings, ranges
+
+- **Object attribute matcher**
+  - `has_attribute(name, matcher = nil)` - object/hash attribute checking
+
+- **Error assertions**
+  - `raises_error(class = nil, message_matcher = nil)` - block raises error
+  - `raises_nothing` - block does not raise
+
+- **Combinators**
+  - `&` operator - AND combination
+  - `|` operator - OR combination
+  - `all_of(*matchers)` - all matchers must match
+  - `some_of(*matchers)` - at least one matcher must match
+  - `none_of(*matchers)` - no matcher should match
+
+- **Fluent API**
+  - `assert_that(actual).equals(expected)`
+  - `assert_that(actual).is(expected)`
+  - `assert_that(actual).never(matcher)` (aliases: `is_not`, `does_not`)
+  - `assert_that(actual).matches(matcher)`
+  - `assert_that { block }.raises_error`
+  - `assert_that { block }.raises_nothing`
+
+- **Custom matcher API**
+  - `Minicrest.register_matcher(name, &block)` - register custom matchers
+  - Subclass `Minicrest::Matcher` to create custom matchers
+
+- **Detailed failure messages**
+  - Hash diffs showing missing/extra/changed keys
+  - Array diffs showing index-based differences
+  - String diffs showing position of first difference
+
+[1.0.0]: https://github.com/ggalmazor/minicrest/releases/tag/v1.0.0

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'minitest'
+
+group :development, :test do
+  gem 'rake', '~> 13.2'
+  gem 'rdoc', '~> 7.1'
+  gem 'rubocop', '~> 1.82'
+  gem 'rubocop-minitest', '~> 0.38.2'
+  gem 'webrick', '~> 1.9'
+  gem 'yard', '~> 0.9.38'
+end