approvals 0.0.26 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc889240c80c9fb3649ef9b9edfd7b7fa54d2921d678dfe4303c3821ee2a23c8
-  data.tar.gz: 30c4924a8e599a89c9c386892719ebfa9bdc3c6cc0664be606de4dc83c23c217
+  metadata.gz: 43936933022bdcc8965941a6ea97c91cb2f9a60064009ac07885e9dd8ef1c915
+  data.tar.gz: ce35cc1aad887eda3d8fc0ed107a5f9e49c5991c3f5f17ea87e4980815d9feea
 SHA512:
-  metadata.gz: 8cb1489bae6337b513eac1e1cd78a789612357bd43d35bd874b324ee03c4ae8314e5fbf5377853cbe60effea3b2e87b85a1028bb3c62910dab13e1aae912f3a9
-  data.tar.gz: 99756cc25f1c2f3492de6291280b3483d861fe4977d11c19a5eee9c0372541457b05a7704c9fe6eabc909c0bcb6817c89ddf13bc89d0b6b009a0b27607abd2f9
+  metadata.gz: f2bd0c1efa99d1968cc33ecf4163493afd06e14b96aa61a470e872aec556f24eeef536e62a544c235d37916d6d15382192455e230fac86ee1262a96cb8d0ab3e
+  data.tar.gz: 1d0c5c1711f7d6429d4add8e0ce521c39871da24c76793a227831bb1a2807aab6f0fe724b451024ec84983756c4e3922ab621a0ecf2a2c49ed12dc73129d2fcd

data/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: 'bundler'
+    directory: '/'
+    schedule:
+      interval: 'daily'
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/workflows/publish.yml

@@ -0,0 +1,58 @@
+name: Publish
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  publish-rubygems:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup Ruby, JRuby and TruffleRuby
+        uses: ruby/setup-ruby@v1.215.0
+        with:
+          ruby-version : 2.7.6
+      - uses: actions/checkout@v4   
+      - name: Install dependecies
+        run: bundle install
+      - name: Run Tests
+        run: ./run_tests.sh
+      - name: Determine version from git tag
+        id: version
+        run: |
+          echo ::set-output name=tag::${GITHUB_REF#refs/*/}
+
+
+      - name: set version
+        run: |
+          rm ./lib/approvals/version.rb
+          echo "module Approvals;  VERSION = \"${{ steps.version.outputs.tag }}\"; end"  > ./lib/approvals/version.rb
+  
+      - name: Push changes
+        run: |
+            git config --local user.email "action@github.com"
+            git config --local user.name "GitHub Action"
+            git commit -m "v${{ steps.version.outputs.tag }}" -a  || echo "nothing to commit"
+            git checkout -b temp
+            git fetch
+            git checkout main
+            git merge temp
+            remote="https://${GITHUB_ACTOR}:${{secrets.GITHUB_TOKEN}}@github.com/${GITHUB_REPOSITORY}.git"
+            branch="main"
+            git push "${remote}" ${branch} || echo "nothing to push"
+        shell: bash
+      - name: Generate gem credentials
+        run: |
+          mkdir -p ~/.gem
+          cat << EOF > ~/.gem/credentials
+          ---
+          :rubygems_api_key: ${{ secrets.RUBY_GEMS_KEY }}
+          EOF
+      - name: Chmod file
+        run: chmod 0600 ~/.gem/credentials
+      - name: Publish
+        run: |
+          git status
+          bundle exec rake release --trace
+
+ 

data/.github/workflows/test.yml

@@ -0,0 +1,41 @@
+name: Build
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  run-tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.7.6', '3.0.4', '3.1.2' ] #, 'jruby-head' ]
+    steps:
+      - name: Setup Ruby, JRuby and TruffleRuby
+        uses: ruby/setup-ruby@v1.215.0
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - uses: actions/checkout@v4   
+      - name: Install dependecies
+        run: bundle install
+      - name: Run Tests
+        run: ./run_tests.sh
+     
+  auto-merge:
+    needs: run-tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repo
+        uses: actions/checkout@v4
+      - name: auto-merge
+        if: |
+          github.actor == 'dependabot[bot]' &&
+          github.event_name == 'pull_request'
+        run: |
+          gh pr merge --auto --rebase "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          # this secret needs to be in the settings.secrets.dependabot
+          GITHUB_TOKEN: ${{secrets.GH_ACTION_TOKEN}} 

data/.github/workflows/updateMarkdown.yml

@@ -0,0 +1,22 @@
+name: Update markdown snippets
+on:
+  push:
+jobs:
+  update-markdown-snippets:
+    runs-on: windows-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Run MarkdownSnippets
+      run: |
+        dotnet tool install --global MarkdownSnippets.Tool
+        mdsnippets ${GITHUB_WORKSPACE}
+      shell: bash
+    - name: Push changes
+      run: |
+        git config --local user.email "action@github.com"
+        git config --local user.name "GitHub Action"
+        git commit -m "d updated markdown snippets" -a  || echo "nothing to commit"
+        remote="https://${GITHUB_ACTOR}:${{secrets.GITHUB_TOKEN}}@github.com/${GITHUB_REPOSITORY}.git"
+        branch="${GITHUB_REF:11}"
+        git push "${remote}" ${branch} || echo "nothing to push"
+      shell: bash

data/.gitignore

@@ -1,11 +1,12 @@
 *.gem
+.gem/
 .bundle
-Gemfile.lock
 pkg/*
-*.received.txt
+*.received.*
 .approvals
 tmp/
 vendor/
 
 ext/Rakefile
-.ruby-version
+.ruby-version
+.gitpod.yml

data/Gemfile

@@ -2,5 +2,3 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in rspec-approvals.gemspec
 gemspec
-
-gem 'rubysl', '~> 2.0', :platform => :rbx

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    approvals (0.1.7)
+      json (~> 2.0)
+      nokogiri (~> 1.8)
+      thor (~> 1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.5.1)
+    json (2.9.1)
+    mini_portile2 (2.8.8)
+    nokogiri (1.18.2)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
+    racc (1.8.1)
+    rake (13.2.1)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.0)
+    thor (1.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  approvals!
+  rake (~> 13.0)
+  rspec (~> 3.1)
+
+BUNDLED WITH
+   2.3.23

data/README.md

@@ -1,10 +1,28 @@
 # Approvals
 
-[![Build Status](https://secure.travis-ci.org/kytrinyx/approvals.svg?branch=master)](http://travis-ci.org/kytrinyx/approvals)
-[![Gem Version](https://badge.fury.io/rb/approvals.svg)](http://badge.fury.io/rb/approvals)
+[![Build](https://github.com/approvals/ApprovalTests.Ruby/actions/workflows/test.yml/badge.svg)](https://github.com/approvals/ApprovalTests.Ruby/actions/workflows/test.yml)[![Gem Version](https://badge.fury.io/rb/approvals.svg)](http://badge.fury.io/rb/approvals)
 [![Code Climate](https://codeclimate.com/github/kytrinyx/approvals.svg)](https://codeclimate.com/github/kytrinyx/approvals)
 [![Gemnasium](https://gemnasium.com/kytrinyx/approvals.svg)](https://gemnasium.com/kytrinyx/approvals)
 
+<!-- toc -->
+## Contents
+
+  * [Getting Started](#getting-started)
+    * [New Projects](#new-projects)
+  * [Configuration](#configuration)
+  * [Usage](#usage)
+    * [Customizing formatted output](#customizing-formatted-output)
+  * [CLI](#cli)
+    * [Workflow Using VimDiff](#workflow-using-vimdiff)
+    * [RSpec](#rspec)
+    * [Naming](#naming)
+    * [Formatting](#formatting)
+    * [Exclude dynamically changed values from json](#exclude-dynamically-changed-values-from-json)
+    * [Approving a spec](#approving-a-spec)
+    * [Expensive computations](#expensive-computations)
+    * [RSpec executable](#rspec-executable)
+  * [Example use cases](#example-use-cases)
+    * [Verifying complex SQL in Rails](#verifying-complex-sql-in-rails)<!-- endToc -->
 
 Approvals are based on the idea of the *_golden master_*.
 
@@ -19,14 +37,22 @@ See [ApprovalTests](http://www.approvaltests.com) for videos and additional docu
 
 Also, check out  Herding Code's [podcast #117](http://t.co/GLn88R5) in
 which Llewellyn Falco is interviewed about approvals.
+## Getting Started
 
+### New Projects
+
+The easiest way to get started with a new project is to clone the [Starter Project](https://github.com/approvals/ApprovalTests.Ruby.starterproject)
 ## Configuration
 
-```ruby
+<!-- snippet: config-example -->
+<a id='snippet-config-example'></a>
+```rb
 Approvals.configure do |config|
-  config.approvals_path = 'output/goes/here/'
+  config.approvals_path = 'output/dir/'
 end
 ```
+<sup><a href='/spec/configuration_spec.rb#L12-L16' title='Snippet source file'>snippet source</a> | <a href='#snippet-config-example' title='Start of snippet'>anchor</a></sup>
+<!-- endSnippet -->
 
 The default location for the output files is
 
@@ -260,4 +286,48 @@ verify do
 end
 ```
 
+## Example use cases
+
+### Verifying complex SQL in Rails
+
+If you're using Rails and want to avoid accidentally introducing N+1 database queries, you can define a `verify_sql` helper like so:
+
+```ruby
+# spec/spec_helper.rb
+
+require "./spec/support/approvals_helper"
+
+RSpec.configure do |config|
+  config.include ApprovalsHelper
+end
+
+# spec/support/approvals_helper.rb
+
+module ApprovalsHelper
+  def verify_sql(&block)
+    sql = []
+
+    subscriber = ->(_name, _start, _finish, _id, payload) do
+      sql << payload[:sql].split("/*").first.gsub(/\d+/, "?")
+    end
+
+    ActiveSupport::Notifications.subscribed(subscriber, "sql.active_record", &block)
+
+    verify :format => :txt do
+      sql.join("\n") + "\n"
+    end
+  end
+end
+
+# spec/models/example_spec.rb
+
+it "is an example spec" do
+   verify_sql do
+     expect(Thing.complex_query).to eq(expected_things)
+   end
+ end
+```
+
+This `verify_sql` can be useful in model or integration tests; anywhere you're worried about the SQL being generated by complex queries, API endpoints, GraphQL fields, etc.
+
 Copyright (c) 2011 Katrina Owen, released under the MIT license

data/approvals.gemspec

@@ -7,9 +7,9 @@ Gem::Specification.new do |s|
   s.name        = "approvals"
   s.version     = Approvals::VERSION
   s.licenses    = ['MIT']
-  s.authors     = ["Katrina Owen"]
-  s.email       = ["katrina.owen@gmail.com"]
-  s.homepage    = "https://github.com/kytrinyx/approvals"
+  s.authors     = ["Llewellyn Falco", "Sam Livingston-Gray"]
+  s.email       = ["llewellyn.falco@gmail.com", "geeksam@gmail.com"]
+  s.homepage    = "https://github.com/approvals/ApprovalTests.Ruby"
   s.summary     = %q{Approval Tests for Ruby}
   s.description = %q{A library to make it easier to do golden-master style testing in Ruby}
 
@@ -23,11 +23,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'thor', '~> 1.0'
   s.add_dependency 'json', '~> 2.0'
 
-  if RUBY_VERSION < "2.1"
-    s.add_dependency 'nokogiri', '~> 1.6.8'
-  else
-    s.add_dependency 'nokogiri', '~> 1.8'
-  end
+  s.add_dependency 'nokogiri', '~> 1.8'
   # We also depend on the json gem, but the version we need is
   # Ruby-version-specific. See `ext/mkrf_conf.rb`.
 

data/lib/approvals/combination_approvals.rb

@@ -0,0 +1,29 @@
+class CombinationApprovals
+  def self.verify_all_combinations(*arg_variations, namer:)
+    combo = new()
+    arg_variations.each do |list|
+      combo.arg(list)
+    end
+
+    output = ""
+    combo.all_combinations.each do |args|
+      begin
+        result = yield *args
+      rescue StandardError => exception
+        result = "#{exception.inspect}"
+      end
+      output << "#{args} => #{result}\n"
+    end
+    Approvals.verify(output, namer: namer)
+  end
+
+  def arg(values)
+    @args ||= []
+    @args << values
+  end
+
+  def all_combinations()
+    first, *rest = *@args
+    first.product(*rest)
+  end
+end

data/lib/approvals/version.rb

@@ -1,3 +1 @@
-module Approvals
-  VERSION = '0.0.26'
-end
+module Approvals;  VERSION = "0.1.7"; end

data/lib/approvals.rb

@@ -2,6 +2,7 @@ require 'json'
 require 'fileutils'
 require 'nokogiri'
 require 'approvals/version'
+require 'approvals/combination_approvals'
 require 'approvals/configuration'
 require 'approvals/approval'
 require 'approvals/dsl'

data/mdsnippets.json

@@ -0,0 +1,5 @@
+{
+  "ExcludeDirectories": [ "pkg", "vendor" ],
+  "Convention": "InPlaceOverwrite",
+  "TocLevel": 5
+}

data/notes/how_to_publish.md

@@ -0,0 +1,13 @@
+# Publish
+## Prereqs
+- [ ] `brew install rbenv ruby-build`
+     This installs [rbenv](https://github.com/rbenv/rbenv)
+- [ ] `brew install openssl`
+- [ ] `eval "$(rbenv init - zsh)"`
+    **note:** this command will diff based on the shell. run `rbenv init` to find
+ - [ ] `RUBY_CONFIGURE_OPTS=--with-openssl-dir=/usr/local/Cellar/openssl@3/3.0.3 rbenv install 3.1.2`
+    **note:** this path comes from
+    `brew info openssl`
+    ruby version comes from
+    `rbenv install -l`
+## Build

data/run_tests.sh

@@ -0,0 +1 @@
+bundle exec rspec

data/spec/combination_approvals_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'approvals/namers/rspec_namer'
+
+describe Approvals do
+
+  def some_function(a1,b1,c1)
+    "#{b1+c1} #{a1}s"
+  end
+
+  let(:namer) { |example| Approvals::Namers::RSpecNamer.new(example) }
+
+  specify "2 combos" do
+    a = ["foo", "bar"]
+    b = [1,3,5]
+    c = [2,4]
+    CombinationApprovals.verify_all_combinations(a,b, c, namer:namer) do |a1,b1, c1|
+      "#{b1+c1} #{a1}s"
+    end
+    CombinationApprovals.verify_all_combinations(a,b, c,namer:namer, &method(:some_function))
+  end
+
+  specify "errors" do
+    a = ["foo", "bar"]
+    b = [0,1,2]
+    CombinationApprovals.verify_all_combinations(a,b, namer:namer) do |a1,b1|
+      if b1 == 2
+        raise "There is no 2"
+      end
+      "#{b1} #{a1}s"
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -9,9 +9,11 @@ describe Approvals::Configuration do
 
   describe "when set" do
     before(:each) do
-      Approvals.configure do |c|
-        c.approvals_path = 'output/dir/'
+      # begin-snippet: config-example
+      Approvals.configure do |config|
+        config.approvals_path = 'output/dir/'
       end
+      # end-snippet
     end
 
     after(:each) do

data/spec/fixtures/approvals/approvals_2_combos.approved.txt

@@ -0,0 +1,12 @@
+["foo", 1, 2] => 3 foos
+["foo", 1, 4] => 5 foos
+["foo", 3, 2] => 5 foos
+["foo", 3, 4] => 7 foos
+["foo", 5, 2] => 7 foos
+["foo", 5, 4] => 9 foos
+["bar", 1, 2] => 3 bars
+["bar", 1, 4] => 5 bars
+["bar", 3, 2] => 5 bars
+["bar", 3, 4] => 7 bars
+["bar", 5, 2] => 7 bars
+["bar", 5, 4] => 9 bars

data/spec/fixtures/approvals/approvals_errors.approved.txt

@@ -0,0 +1,6 @@
+["foo", 0] => 0 foos
+["foo", 1] => 1 foos
+["foo", 2] => #<RuntimeError: There is no 2>
+["bar", 0] => 0 bars
+["bar", 1] => 1 bars
+["bar", 2] => #<RuntimeError: There is no 2>

data/todo.md

@@ -0,0 +1,10 @@
+1. handle namer
+1. use mdsnippets
+
+
+
+
+2. check pending tests
+3. check issues & pull requests
+4. Update dependencies
+5.

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: approvals
 version: !ruby/object:Gem::Version
-  version: 0.0.26
+  version: 0.1.7
 platform: ruby
 authors:
-- Katrina Owen
-autorequire: 
+- Llewellyn Falco
+- Sam Livingston-Gray
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-12 00:00:00.000000000 Z
+date: 2025-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -82,16 +83,21 @@ dependencies:
         version: '3.1'
 description: A library to make it easier to do golden-master style testing in Ruby
 email:
-- katrina.owen@gmail.com
+- llewellyn.falco@gmail.com
+- geeksam@gmail.com
 executables:
 - approvals
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/publish.yml"
+- ".github/workflows/test.yml"
+- ".github/workflows/updateMarkdown.yml"
 - ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - License.txt
 - README.md
 - Rakefile
@@ -100,6 +106,7 @@ files:
 - lib/approvals.rb
 - lib/approvals/approval.rb
 - lib/approvals/cli.rb
+- lib/approvals/combination_approvals.rb
 - lib/approvals/configuration.rb
 - lib/approvals/dotfile.rb
 - lib/approvals/dsl.rb
@@ -137,13 +144,19 @@ files:
 - lib/approvals/writers/json_writer.rb
 - lib/approvals/writers/text_writer.rb
 - lib/approvals/writers/xml_writer.rb
+- mdsnippets.json
+- notes/how_to_publish.md
+- run_tests.sh
 - spec/approvals_spec.rb
+- spec/combination_approvals_spec.rb
 - spec/configuration_spec.rb
 - spec/dotfile_spec.rb
 - spec/executable_spec.rb
 - spec/extensions/rspec_approvals_spec.rb
 - spec/filter_spec.rb
+- spec/fixtures/approvals/approvals_2_combos.approved.txt
 - spec/fixtures/approvals/approvals_custom_writer_verifies_a_complex_object.approved.txt
+- spec/fixtures/approvals/approvals_errors.approved.txt
 - spec/fixtures/approvals/approvals_ignores_whitespace_differences_in_json.approved.json
 - spec/fixtures/approvals/approvals_passes_approved_files_through_erb.approved.txt
 - spec/fixtures/approvals/approvals_passes_the_received_files_through_erb.approved.txt
@@ -203,11 +216,12 @@ files:
 - spec/spec_helper.rb
 - spec/system_command_spec.rb
 - spec/verifiers/json_verifier_spec.rb
-homepage: https://github.com/kytrinyx/approvals
+- todo.md
+homepage: https://github.com/approvals/ApprovalTests.Ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -222,8 +236,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Approval Tests for Ruby
 test_files: []

data/.travis.yml

@@ -1,27 +0,0 @@
-language: ruby
-rvm:
-  - 2.0.0
-  - 2.1.10
-  - 2.2.10
-  - 2.3.8
-  - 2.4.8
-  - 2.5.7
-  - 2.6.5
-  - 2.7.0
-  - ruby-head
-  - rbx-3
-matrix:
-  allow_failures:
-    - rvm: rbx-3
-before_install:
-  - |
-    r_eng="$(ruby -e 'STDOUT.write RUBY_ENGINE')";
-    rv="$(ruby -e 'STDOUT.write RUBY_VERSION')";
-    if [ "$r_eng" == "ruby" ]; then
-      if   [ "$rv" \< "2.3" ]; then gem update --system 2.7.10 --no-document
-      elif [ "$rv" \< "2.6" ]; then gem update --system --no-document --conservative
-      fi
-    fi
-  - gem update bundler
-script: bundle exec rspec spec
-cache: bundler