regresso 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7df7c1a0aba2f0a6b526c8bad5e1732aea99a43db264c550603ff8dcd9535587
+  data.tar.gz: 822d789eb0d6f80ed0c412a3c367790eea686ae3345c0d58e3737441b3d59ea1
+SHA512:
+  metadata.gz: 932ee045cd248b9a8de21960569265f03bbacd13c303c2782a80dd35dadfa2a2d2bfc2ffcbb6f59cfc2234a2791212cec51fc46b4531613d580100ae381e4e20
+  data.tar.gz: eabe7f3d69c7b7df776f61f98288de3c8656ca112bd233921e37123b162caf8f06c2e40da87ad2bfa1b1903458bf245a57bf1e2ea7d92f2205da33295438f89d

data/.yardopts

@@ -0,0 +1,3 @@
+- README.md
+- lib/**/*.rb
+- --markup markdown

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [0.1.0] - 2025-01-18
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Yudai Takada
+
+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,258 @@
+<p align="center">
+  <img src="assets/logo-header.svg" alt="regresso header logo">
+  <b>Regression testing for Ruby APIs, files, and data snapshots.</b>
+  <br>
+  Compare outputs across environments with tolerances and ignore rules.
+</p>
+
+<p align="center">
+  <img src="https://img.shields.io/badge/ruby-%3E%3D%203.2-ruby.svg" alt="Ruby Version">
+  <img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License">
+  <a href="https://badge.fury.io/rb/regresso"><img src="https://badge.fury.io/rb/regresso.svg" alt="Gem Version" height="18"></a>
+  <a href="https://github.com/ydah/regresso/actions/workflows/main.yml">
+    <img src="https://github.com/ydah/regresso/actions/workflows/main.yml/badge.svg" alt="CI Status">
+  </a>
+</p>
+
+<p align="center">
+  <a href="#features">Features</a> •
+  <a href="#quick-start">Quick Start</a> •
+  <a href="#how-it-works">How It Works</a> •
+  <a href="#installation">Installation</a> •
+  <a href="#configuration">Configuration</a> •
+  <a href="#documentation">Documentation</a> •
+  <a href="#web-ui">Web UI</a>
+</p>
+
+## Features
+
+- Compare API responses, CSV exports, JSON files, or custom data sources
+- Tolerances and per-path overrides for numeric differences
+- Ignore paths by JSONPath or regex to avoid noisy fields
+- Snapshot testing for stable outputs
+- RSpec and Minitest integrations
+- GraphQL, database, and batch comparisons
+- Parallel execution with CI-ready reports
+- Optional Web UI for browsing results
+
+## Quick Start
+
+```ruby
+require "regresso/rspec"
+
+old_api = { base_url: "https://old.example.com", endpoint: "/reports/sales" }
+new_api = { base_url: "https://new.example.com", endpoint: "/reports/sales" }
+
+RSpec.describe "Sales report" do
+  it "has no regression" do
+    expect(new_api).to have_no_regression_from(old_api)
+      .with_tolerance(0.01)
+      .ignoring("$.timestamp")
+  end
+end
+```
+
+## How It Works
+
+1. Build two data sources (old and new)
+2. Normalize and compare outputs
+3. Apply tolerances and ignore rules
+4. Report a diff summary and pass/fail result
+
+## Usage Examples
+
+### API comparison
+
+```ruby
+old_source = Regresso::Adapters::Http.new(
+  base_url: "https://old.example.com",
+  endpoint: "/api/v1/reports",
+  params: { year: 2024 }
+)
+
+new_source = Regresso::Adapters::Http.new(
+  base_url: "https://new.example.com",
+  endpoint: "/api/v1/reports",
+  params: { year: 2024 }
+)
+
+result = Regresso::Comparator.new(source_a: old_source, source_b: new_source).compare
+puts result.summary
+```
+
+### CSV comparison
+
+```ruby
+old_csv = Regresso::Adapters::Csv.new(path: "tmp/old.csv")
+new_csv = Regresso::Adapters::Csv.new(path: "tmp/new.csv")
+
+result = Regresso::Comparator.new(source_a: old_csv, source_b: new_csv).compare
+puts result.passed?
+```
+
+### Snapshot testing
+
+```ruby
+require "regresso/rspec"
+
+RSpec.describe "Snapshot" do
+  it "matches snapshot" do
+    payload = { "total" => 120 }
+    expect(payload).to match_snapshot("report_total")
+  end
+end
+```
+
+### Tolerance and ignore paths
+
+```ruby
+expect(new_api).to have_no_regression_from(old_api)
+  .with_tolerance(0.01)
+  .with_path_tolerance("$.amount", 0.1)
+  .ignoring("$.updated_at")
+```
+
+### Shared examples
+
+```ruby
+require "regresso/rspec/shared_examples"
+
+include_examples "regresso:api_regression", {
+  old_base_url: ENV["OLD_API"],
+  new_base_url: ENV["NEW_API"],
+  patterns: [{ endpoint: "/api/v1/reports" }]
+}
+```
+
+### Database query comparison
+
+```ruby
+old_db = Regresso::Adapters::Database.new(
+  connection_config: { adapter: "sqlite3", database: "tmp/old.db" },
+  query: "SELECT * FROM users WHERE active = :active",
+  params: { active: true },
+  row_identifier: :id
+)
+
+new_db = Regresso::Adapters::Database.new(
+  connection_config: { adapter: "sqlite3", database: "tmp/new.db" },
+  query: "SELECT * FROM users WHERE active = :active",
+  params: { active: true },
+  row_identifier: :id
+)
+
+result = Regresso::Comparator.new(source_a: old_db, source_b: new_db).compare
+puts result.summary
+```
+
+### GraphQL batch comparison
+
+```ruby
+source_a = Regresso::Adapters::GraphQLBatch.new(
+  endpoint: "https://old.example.com/graphql",
+  queries: [
+    { name: "users", query: "{ users { id name } }" },
+    { name: "stats", query: "{ stats { total } }" }
+  ]
+)
+
+source_b = Regresso::Adapters::GraphQLBatch.new(
+  endpoint: "https://new.example.com/graphql",
+  queries: [
+    { name: "users", query: "{ users { id name } }" },
+    { name: "stats", query: "{ stats { total } }" }
+  ]
+)
+
+result = Regresso::Comparator.new(source_a: source_a, source_b: source_b).compare
+puts result.passed?
+```
+
+### Parallel comparisons
+
+```ruby
+comparisons = [
+  {
+    name: "sales",
+    source_a: Regresso::Adapters::Proc.new { { total: 120 } },
+    source_b: Regresso::Adapters::Proc.new { { total: 121 } }
+  }
+]
+
+runner = Regresso::Parallel::Runner.new(comparisons: comparisons, workers: 4)
+parallel_result = runner.run
+puts parallel_result.summary
+```
+
+## Installation
+
+Add to your Gemfile:
+
+```bash
+bundle add regresso
+```
+
+Or install directly:
+
+```bash
+gem install regresso
+```
+
+## Configuration
+
+```ruby
+Regresso.configure do |config|
+  config.default_tolerance = 0.01
+  config.ignore_paths = [/\.id$/, /\.updated_at$/]
+  config.tolerance_overrides = { "$.amount" => 0.1 }
+  config.array_order_sensitive = true
+  config.type_coercion = true
+end
+```
+
+## Adapters
+
+- HTTP: `Regresso::Adapters::Http`
+- CSV: `Regresso::Adapters::Csv`
+- JSON file: `Regresso::Adapters::JsonFile`
+- Proc: `Regresso::Adapters::Proc`
+- Database query: `Regresso::Adapters::Database`
+- Database snapshot: `Regresso::Adapters::DatabaseSnapshot`
+- GraphQL: `Regresso::Adapters::GraphQL`
+- GraphQL batch: `Regresso::Adapters::GraphQLBatch`
+
+## Test framework integration
+
+- RSpec: `require "regresso/rspec"`
+- Minitest: `require "regresso/minitest"`
+
+## Documentation
+
+```bash
+bundle exec rake yard
+```
+
+## CI reporting
+
+```ruby
+reporter = Regresso::CI::Reporter.new(parallel_result)
+File.write("tmp/regresso.xml", reporter.to_junit_xml)
+```
+
+## Web UI
+
+```ruby
+require "regresso/web_ui"
+
+store = Regresso::WebUI::ResultStore.new(storage_path: "tmp/regresso_results")
+Regresso::WebUI::Server.set :result_store, store
+Regresso::WebUI::Server.run!
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome. Please run tests before submitting changes.
+
+## License
+
+MIT License. See `LICENSE.txt` for details.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "yard"
+
+RSpec::Core::RakeTask.new(:spec)
+YARD::Rake::YardocTask.new(:yard)
+
+task default: :spec
+
+Dir.glob(File.join(__dir__, "lib/regresso/tasks/**/*.rake")).each { |path| load path }