json-schema-diff 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1aea7e4fe80d247f0391631e587a149d622839d7b78b99443e334eea7c422df1
+  data.tar.gz: 4a9aeceeb2c7d356306cb237c03f8710eb4bd8291d010f583e2d1bb433110046
+SHA512:
+  metadata.gz: 86c942503b94f7ab01c896fabefa07e9def0701daabff6bf17725dbf9e148c49282293a95e52ebb06a9ee941905c767124134a38243533591bab35b1a59a06c0
+  data.tar.gz: 5ef4bbfcf3fc8957ec04800a8ea3ea3c3696553dec7f746050194ef6e241c8b55170cfbc87b0505c6238f0af4c5bccef205fe571b451d22cf9f27dcae0727e79

data/CHANGELOG.md

@@ -0,0 +1,33 @@
+# 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]
+
+## [0.1.0] - 2025-01-26
+
+### Added
+
+- Initial release of json-schema-diff gem
+- Schema-guided JSON diffing with metadata extraction from JSON Schema
+- Support for JSON Schema properties: type, title, description, format, enum, readOnly
+- Multiple output formats: pretty colorized output and machine-readable JSON
+- Smart noisy field detection (timestamps, UUIDs, readOnly fields)
+- Custom field filtering with --ignore-fields option for excluding specific paths
+- Recursive comparison of nested objects and arrays with full path tracking
+- Lightweight CLI using Ruby's built-in OptionParser (no external dependencies)
+- Support for all standard JSON Schema formats (date-time, uuid, email, etc.)
+- Comprehensive test suite with 100% core functionality coverage (13 tests, 58 assertions)
+- Professional documentation including README, CONTRIBUTING, SECURITY, and examples
+- Organized examples directory with tool-specific subdirectories and version-based naming
+- Official schema support for security tools:
+  - Zizmor (GitHub Actions security auditor) - official v1 schema
+  - Capslock (Google's Go capability analysis) - official schema
+  - Generic security report template for other tools
+- Real-world sample data demonstrating security finding detection and severity escalation
+- CI/CD integration examples with structured JSON output for automation
+- SchemaStore.org integration documentation for 600+ existing schemas
+- Example outputs in README showing practical use cases and expected results

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/CONTRIBUTING.md

@@ -0,0 +1,215 @@
+# Contributing to json-schema-diff
+
+Thank you for your interest in contributing to json-schema-diff! This document provides guidelines and information for contributors.
+
+## Code of Conduct
+
+This project adheres to the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
+
+## How to Contribute
+
+### Reporting Bugs
+
+Before creating bug reports, please check existing issues to avoid duplicates. When creating a bug report, include:
+
+- **Clear title** describing the issue
+- **Detailed description** of the problem
+- **Steps to reproduce** the bug
+- **Expected vs actual behavior**
+- **Environment details** (Ruby version, OS, gem version)
+- **Sample files** if relevant (JSON schema, test files)
+
+### Suggesting Features
+
+Feature requests are welcome! Please:
+
+- **Check existing issues** to avoid duplicates
+- **Describe the use case** that motivates the feature
+- **Provide examples** of how the feature would work
+- **Consider implementation complexity** and maintenance burden
+
+### Pull Requests
+
+1. **Fork** the repository
+2. **Create a feature branch** (`git checkout -b feature/amazing-feature`)
+3. **Make your changes** following the coding standards
+4. **Add tests** for new functionality
+5. **Update documentation** if needed
+6. **Ensure all tests pass** (`rake test`)
+7. **Commit your changes** (`git commit -m 'Add amazing feature'`)
+8. **Push to your branch** (`git push origin feature/amazing-feature`)
+9. **Open a Pull Request**
+
+## Development Setup
+
+### Prerequisites
+
+- Ruby 3.2.0 or higher
+- Bundler
+
+### Getting Started
+
+```bash
+# Clone your fork
+git clone https://github.com/YOUR_USERNAME/json-schema-diff.git
+cd json-schema-diff
+
+# Install dependencies
+bundle install
+
+# Run tests
+rake test
+
+# Run linting (if available)
+rake lint
+```
+
+### Running Tests
+
+```bash
+# Run all tests
+rake test
+
+# Run specific test file
+ruby test/json/schema/test_diff.rb
+
+# Run specific test method
+ruby test/json/schema/test_diff.rb -n test_comparer_detects_additions
+```
+
+## Coding Standards
+
+### Ruby Style
+
+- Follow standard Ruby conventions
+- Use 2 spaces for indentation
+- Keep line length under 120 characters
+- Use descriptive variable and method names
+- Add comments for complex logic
+
+### Code Organization
+
+- Keep classes focused and single-purpose
+- Use modules for shared functionality
+- Follow existing file structure and naming conventions
+- Place new features in appropriate modules
+
+### Testing
+
+- Write tests for all new functionality
+- Use descriptive test method names
+- Test both success and error cases
+- Include edge cases and boundary conditions
+- Use helper methods to reduce test duplication
+
+Example test structure:
+```ruby
+def test_descriptive_test_name
+  # Arrange
+  schema = create_test_schema
+  
+  # Act
+  result = schema.parse_field("field.path")
+  
+  # Assert
+  assert_equal expected_value, result
+end
+```
+
+### Documentation
+
+- Update README.md for new features
+- Add inline documentation for public methods
+- Include usage examples for new functionality
+- Update CHANGELOG.md with notable changes
+
+## Architecture Overview
+
+### Core Components
+
+- **SchemaParser**: Parses JSON Schema files and extracts field metadata
+- **Comparer**: Performs recursive comparison of JSON objects using schema guidance
+- **Formatter**: Formats diff results for human-readable or machine-readable output
+- **CLI**: Command-line interface using Thor
+
+### Key Design Principles
+
+- **Schema-driven**: Use JSON Schema metadata to enhance diff output
+- **Configurable**: Support various output formats and filtering options
+- **Extensible**: Easy to add new output formats or schema features
+- **Defensive**: Handle malformed inputs gracefully with clear error messages
+
+## Testing Guidelines
+
+### Test Categories
+
+1. **Unit tests**: Test individual components in isolation
+2. **Integration tests**: Test component interactions
+3. **CLI tests**: Test command-line interface functionality
+4. **Example tests**: Validate example files work correctly
+
+### Test Data
+
+- Use temporary files for test schemas and JSON files
+- Include realistic examples that reflect real-world usage
+- Test edge cases like empty objects, deeply nested structures
+- Validate error handling with invalid inputs
+
+### Performance Considerations
+
+- Test with reasonably large JSON files
+- Ensure tests complete in reasonable time
+- Avoid tests that consume excessive memory
+
+## Release Process
+
+### Version Numbers
+
+We follow [Semantic Versioning](https://semver.org/):
+
+- **MAJOR**: Incompatible API changes
+- **MINOR**: New functionality (backward compatible)
+- **PATCH**: Bug fixes (backward compatible)
+
+### Release Checklist
+
+1. Update version in `lib/json/schema/diff/version.rb`
+2. Update CHANGELOG.md with release notes
+3. Ensure all tests pass
+4. Tag the release (`git tag v1.2.3`)
+5. Push tags (`git push --tags`)
+6. Build and publish gem (`gem build && gem push`)
+
+## Documentation
+
+### README Updates
+
+When adding features, update the README with:
+
+- Installation instructions (if changed)
+- Usage examples for new features
+- Command-line options
+- Configuration details
+
+### Code Documentation
+
+- Document public methods with YARD comments
+- Include parameter types and return values
+- Provide usage examples for complex methods
+- Document error conditions and exceptions
+
+## Getting Help
+
+- **GitHub Issues**: For bugs and feature requests
+- **Discussions**: For questions and general discussion
+- **Email**: andrew@ecosyste.ms for security issues
+
+## Recognition
+
+Contributors will be recognized in:
+
+- Release notes
+- Contributors section (if we add one)
+- Special thanks for significant contributions
+
+Thank you for contributing to json-schema-diff!