minitest-smartdiff 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: abc313dca9e7330ddc1104fb2ae691b5cb7725fe02b36291b1a83ad9e69b2b33
+  data.tar.gz: 5d5bc8a66463630af71e9f7ecfd33a0c69f84adb479ddc5df04abf06873f2d80
+SHA512:
+  metadata.gz: a401a5d70f5ad5388aaf9c02cacb1b909341b28e7ab6e66cefff0756c8e53dba9b35f6ce702cc75b435e43a874cd537a7b700b2b73ae2c697a9b70fe5074a03b
+  data.tar.gz: c0d7f89296dcd2d32cbcd0cf248764e776cd519fca5cd5b29b5b84eaa3bd37de676eb9a800d47419eb6dac41a39b949879373394cd77e1aff09547b694bf27c5

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.10
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in minitest-smartdiff.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    minitest-smartdiff (0.1.0)
+      ruby-openai (~> 7.0)
+      xxhash (~> 0.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    debug (1.9.2)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
+    event_stream_parser (1.0.0)
+    faraday (2.9.0)
+      faraday-net_http (>= 2.0, < 3.2)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (3.1.0)
+      net-http
+    io-console (0.7.2)
+    irb (1.13.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    minitest (5.22.3)
+    multipart-post (2.4.0)
+    net-http (0.4.1)
+      uri
+    psych (5.1.2)
+      stringio
+    rake (13.2.1)
+    rdoc (6.6.3.1)
+      psych (>= 4.0.0)
+    reline (0.5.4)
+      io-console (~> 0.5)
+    ruby-openai (7.0.1)
+      event_stream_parser (>= 0.3.0, < 2.0.0)
+      faraday (>= 1)
+      faraday-multipart (>= 1)
+    stringio (3.1.0)
+    uri (0.13.0)
+    xxhash (0.5.0)
+
+PLATFORMS
+  arm64-darwin-23
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.5)
+  debug (~> 1.9)
+  minitest (~> 5.0)
+  minitest-smartdiff!
+  rake (~> 13.2)
+
+BUNDLED WITH
+   2.5.3

data/README.md

@@ -0,0 +1,90 @@
+# Minitest::Smartdiff
+
+Have you ever found yourself staring cross-eyed and bewildered at walls of diffs that are **absolutely the same damn it**.
+
+Well, it's the future, and you don't have to do that anymore.  Let the endlessly patient Robot go looking for the needle in the needle stack.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'minitest-smartdiff'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install minitest-smartdiff
+
+## Usage
+
+In your `test_helper.rb` file:
+
+```ruby
+require 'minitest-smartdiff'
+```
+
+And in your test file:
+
+```ruby
+class MyTestThatProducesAnAnnoyingDiff < Minitest::Test
+  include Minitest::Smartdiff
+
+  def test_that_produces_an_annoying_obscure_diff
+    some_result = my_method()
+
+    smart_diff do
+      assert_equal "Mayonnaise is delicious", "Mayonnaise is delicioous"
+    end
+  end
+end
+```
+
+Alternatively - you can call `smart_diff_on` and `smart_diff_off` to turn the functionality on/off without using a block.
+
+Smartdiff is smart enough not to ask the LLM for the difference if the assertion passes, so you don't accrue OpenAI costs for passing tests. However - you should consider this primarily a debugging tool - use at high volume at your own risk.
+
+You can configure the OpenAI client like so:
+
+```ruby
+class MyTestThatProducesAnAnnoyingDiff < Minitest::Test
+  include Minitest::Smartdiff
+
+  openai({
+    access_token: ENV['OPENAI_KEY']
+  })
+
+  model('gpt-3.5-turbo')
+
+  prompt(<<~ERB
+    You are a differ - you diff things.  Diff this:
+    <%= expected %>
+    <%= actual %>
+    <%= mode %> is either `:json`, `:object` or `:text`
+    ERB
+  )
+
+
+  def test_that_produces_an_annoying_obscure_diff
+    some_result = my_method()
+
+    smart_diff do
+      assert_equal "Mayonnaise is delicious", "Mayonnaise is delicioous"
+    end
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/stephenprater/minitest-smartdiff.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "minitest/smartdiff"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/minitest/smartdiff/version.rb

@@ -0,0 +1,5 @@
+module Minitest
+  module Smartdiff
+    VERSION = "0.1.0"
+  end
+end

data/lib/minitest/smartdiff.rb

@@ -0,0 +1,177 @@
+require "minitest/smartdiff/version"
+require "minitest/assertions"
+require "xxhash"
+require "openai"
+require "forwardable"
+require "erb"
+
+module Minitest
+  module Smartdiff
+    class Error < StandardError; end
+
+    extend Forwardable
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    def smart_diff_off
+      @smart_diff = false
+    end
+
+    def smart_diff_on
+      @smart_diff = true
+    end
+
+    def smart_diff
+      raise ArgumentError, "Expected a block but none was given" unless block_given?
+      smart_diff_on
+      yield
+    ensure
+      smart_diff_off
+    end
+
+    def_delegators :"self.class", :openai, :prompt, :model, :valid_json?, :smart_diffable?
+
+    module ClassMethods
+      def openai(config = {})
+        @openai ||= OpenAI::Client.new(
+          {
+            organization_id: "",
+            log_errors: true,
+            access_token: ENV['OPENAI_KEY'],
+            uri_base: ENV['OPENAI_URI_BASE'],
+          }.merge(config)
+        )
+      end
+
+      def prompt(string = nil)
+        @prompt ||= string
+        @prompt ||= ERB.new <<~DEFAULT
+          You are Minitest::Smartdiff - the smartest differ that ever existed.
+          Your task is to find subtle but important differences in two pieces of data,
+          the expected, and the actual.  When you find the difference describe the
+          difference as precisely as possible, and provide samples from the provided
+          input.
+
+          Be as succinct as possible, only point out the differences in the two strings.
+
+          Example Output
+          <% if mode == :json || mode == :object %>
+            Make sure to provide JSONPath to the location of the differences.
+
+            Expected:
+              {
+                usage: {
+                  prompt_tokens: 9
+                }
+              }
+
+            Actual:
+              {
+                usage: {
+                  prompt_tokens: 11
+                }
+              }
+
+            1. In the usage object, the number of tokens used is different:
+              - JSONPath: $.usage.prompt_tokens
+              - Expected: 9
+              - Actual: 11
+          <% else %>
+            Make sure to provide a concise description of the surrounding context for the differences.
+
+            Expected:
+              The quick brown dog jumped over the lazy red fox.
+
+            Actual:
+              The quick red dog jumped over the lazy brown fox.
+
+            1. The word "brown" in the expected text describes the dog, but in the actual text the word "red" is used.
+            2. The word "red" in the expected text describes the fox,  is in the actual text the word "brown" is used.
+          <% end %>
+
+          This is very important to my career, I've got children to feed and a
+          mortgage to pay - so be very careful to only show differences.
+
+          Expected:
+            <%= expected %>
+
+          Actual
+            <%= actual %>
+        DEFAULT
+      end
+
+      def model(model = nil)
+        @model ||= model
+        @model ||= "gpt-3.5-turbo"
+      end
+
+      def valid_json?(str)
+        rep = JSON.parse(str)
+        rep.is_a?(Hash) || rep.is_a?(Array)
+      rescue => e
+        false
+      end
+
+      def smart_diffable?(exp, act)
+        return false if exp.class != act.class
+        return false unless [Hash, String, Array].include?(exp.class)
+
+        if exp.is_a?(String)
+          if valid_json?(exp) && valid_json?(act)
+            :json
+          else
+            :text
+          end
+        else
+          :object
+        end
+      end
+    end
+  end
+
+  module Assertions
+    alias_method :old_diff, :diff
+
+    def smart_diff(exp, act)
+      return old_diff(exp,act) unless @smart_diff
+
+      mode = smart_diffable?(exp, act)
+
+      return old_diff(exp, act) unless mode
+
+      expected, actual = if mode == :object
+        [exp.to_json, act.to_json]
+      else
+        [exp, act]
+      end
+
+      params = {
+        parameters: {
+          messages: [
+            {
+              role: "user",
+              content: prompt.result_with_hash({
+                expected:,
+                actual:,
+                mode:
+              }),
+            },
+          ],
+          model: model,
+          temperature: 0.00000000000001,
+          seed: XXhash.xxh32(expected, actual)
+        }
+      }
+
+      completion = openai.chat(**params)
+      completion.dig("choices",0,"message","content") + "\n"
+    rescue => e
+      warn "Error talking to OpenAI: #{e.message} will fallback to basic diff"
+      old_diff(exp,act)
+    end
+
+    alias_method :diff, :smart_diff
+  end
+end

data/minitest-smartdiff.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "minitest/smartdiff/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "minitest-smartdiff"
+  spec.version       = Minitest::Smartdiff::VERSION
+  spec.authors       = ["Stephen Prater", "Jeremy Cobb"]
+  spec.email         = ["me@stephenprater.com"]
+
+  spec.summary       = %q{Diffs are hard, make the robot do it.}
+  spec.description   = %q{Diff between expected and actual with GPT}
+  spec.homepage      = "https://github.com/stephenprater/minitest-smartdiff"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "ruby-openai", "~> 7.0"
+  spec.add_dependency "xxhash", "~> 0.5"
+
+  spec.add_development_dependency "bundler", "~> 2.5"
+  spec.add_development_dependency "rake", "~> 13.2"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "debug", "~> 1.9"
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: minitest-smartdiff
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stephen Prater
+- Jeremy Cobb
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-openai
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: xxhash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+description: Diff between expected and actual with GPT
+email:
+- me@stephenprater.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/minitest/smartdiff.rb
+- lib/minitest/smartdiff/version.rb
+- minitest-smartdiff.gemspec
+homepage: https://github.com/stephenprater/minitest-smartdiff
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Diffs are hard, make the robot do it.
+test_files: []