audited 5.3.3 → 5.8.0

data/.github/workflows/ci.yml

@@ -1,134 +0,0 @@
-name: CI
-
-on:
-  - pull_request
-  - push
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: [2.3, 2.4, 2.5, 2.6, 2.7, 3.0, 3.1, 3.2]
-        appraisal:
-          - rails50
-          - rails51
-          - rails52
-          - rails60
-          - rails61
-          - rails70
-        db: [POSTGRES, MYSQL, SQLITE]
-        exclude:
-          # MySQL has issues on Ruby 2.3
-          # https://github.com/ruby/setup-ruby/issues/150
-          - ruby: 2.3
-            db: MYSQL
-
-          # PostgreSQL is segfaulting on 2.3
-          # Doesn't seem worth solving.
-          - ruby: 2.3
-            db: POSTGRES
-
-          # Rails 5.0 supports Ruby 2.2-2.4
-          - appraisal: rails50
-            ruby: 2.5
-          - appraisal: rails50
-            ruby: 2.6
-          - appraisal: rails50
-            ruby: 2.7
-          - appraisal: rails50
-            ruby: 3.0
-          - appraisal: rails50
-            ruby: 3.1
-          - appraisal: rails50
-            ruby: 3.2
-
-          # Rails 5.1 supports Ruby 2.2-2.5
-          - appraisal: rails51
-            ruby: 2.6
-          - appraisal: rails51
-            ruby: 2.7
-          - appraisal: rails51
-            ruby: 3.0
-          - appraisal: rails51
-            ruby: 3.1
-          - appraisal: rails51
-            ruby: 3.2
-
-          # Rails 5.2 supports Ruby 2.2-2.5
-          - appraisal: rails52
-            ruby: 2.6
-          - appraisal: rails52
-            ruby: 2.7
-          - appraisal: rails52
-            ruby: 3.0
-          - appraisal: rails52
-            ruby: 3.1
-          - appraisal: rails52
-            ruby: 3.2
-
-          # Rails 6.0 supports Ruby 2.5-2.7
-          - appraisal: rails60
-            ruby: 2.3
-          - appraisal: rails60
-            ruby: 2.4
-          - appraisal: rails60
-            ruby: 3.0
-          - appraisal: rails60
-            ruby: 3.1
-          - appraisal: rails60
-            ruby: 3.2
-
-          # Rails 6.1 supports Ruby 2.5+
-          - appraisal: rails61
-            ruby: 2.3
-          - appraisal: rails61
-            ruby: 2.4
-
-          # Rails 7 supports Ruby 2.7+
-          - appraisal: rails70
-            ruby: 2.3
-          - appraisal: rails70
-            ruby: 2.4
-          - appraisal: rails70
-            ruby: 2.5
-          - appraisal: rails70
-            ruby: 2.6
-
-    services:
-      postgres:
-        image: postgres
-        env:
-          POSTGRES_USER: postgres
-          POSTGRES_PASSWORD: postgres
-          POSTGRES_DB: audited_test
-        ports:
-          - 5432:5432
-        # needed because the postgres container does not provide a healthcheck
-        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
-
-    env:
-      DB_DATABASE: audited_test
-      DB_USER: root
-      DB_PASSWORD: 'root'
-      DB_HOST: localhost
-
-    steps:
-    - name: Setup MySQL
-      run: |
-        sudo /etc/init.d/mysql start
-        mysql -e 'CREATE DATABASE audited_test;' -uroot -proot
-        mysql -e 'SHOW DATABASES;' -uroot -proot
-    - uses: actions/checkout@v3
-    - name: Copy Gemfile
-      run: sed 's/\.\././' gemfiles/${{ matrix.appraisal }}.gemfile > Gemfile
-    - name: Set up Ruby ${{ matrix.ruby }}
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-        bundler-cache: true
-    - name: Run tests
-      env:
-        DB: ${{ matrix.db }}
-      run: bundle exec rake

data/.gitignore

@@ -1,17 +0,0 @@
-*.iml
-*.ipr
-*.iws
-*.log
-*.swp
-.bundle
-.rakeTasks
-.ruby-gemset
-.ruby-version
-.rvmrc
-.yardoc
-doc/
-Gemfile.lock
-gemfiles/*.lock
-pkg
-tmp/*
-audited_test.sqlite3.db

data/.standard.yml

@@ -1,5 +0,0 @@
-ruby_version: 2.3
-ignore:
-  - lib/generators/audited/templates/**/*
-  - vendor/bundle/**/*
-  - gemfiles/vendor/bundle/**/*

data/.yardopts

@@ -1,3 +0,0 @@
---no-private
---title acts_as_audited
---exclude lib/generators

data/gemfiles/rails50.gemfile

@@ -1,11 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "rails", "~> 5.0.0"
-gem "mysql2", ">= 0.3.18", "< 0.6.0"
-gem "pg", ">= 0.18", "< 2.0"
-gem "sqlite3", "~> 1.3.6"
-gem "psych", "~> 3.1"
-
-gemspec name: "audited", path: "../"

data/gemfiles/rails51.gemfile

@@ -1,11 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "rails", "~> 5.1.4"
-gem "mysql2", ">= 0.3.18", "< 0.6.0"
-gem "pg", ">= 0.18", "< 2.0"
-gem "sqlite3", "~> 1.3.6"
-gem "psych", "~> 3.1"
-
-gemspec name: "audited", path: "../"

data/gemfiles/rails52.gemfile

@@ -1,11 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "rails", ">= 5.2.8.1", "< 5.3"
-gem "mysql2", ">= 0.4.4", "< 0.6.0"
-gem "pg", ">= 0.18", "< 2.0"
-gem "sqlite3", "~> 1.3.6"
-gem "psych", "~> 3.1"
-
-gemspec name: "audited", path: "../"

data/gemfiles/rails60.gemfile

@@ -1,10 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "rails", ">= 6.0.0", "< 6.1"
-gem "mysql2", ">= 0.4.4"
-gem "pg", ">= 0.18", "< 2.0"
-gem "sqlite3", "~> 1.4"
-
-gemspec name: "audited", path: "../"

data/gemfiles/rails61.gemfile

@@ -1,10 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "rails", ">= 6.1.0", "< 6.2"
-gem "mysql2", ">= 0.4.4"
-gem "pg", ">= 1.1", "< 2.0"
-gem "sqlite3", "~> 1.4"
-
-gemspec name: "audited", path: "../"

data/gemfiles/rails70.gemfile

@@ -1,10 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "rails", ">= 7.0.0", "< 7.1"
-gem "mysql2", ">= 0.4.4"
-gem "pg", ">= 1.1"
-gem "sqlite3", ">= 1.4"
-
-gemspec name: "audited", path: "../"

data/spec/audited/audit_spec.rb

@@ -1,357 +0,0 @@
-require "spec_helper"
-
-SingleCov.covered! uncovered: 1 # Rails version check
-
-class CustomAudit < Audited::Audit
-  def custom_method
-    "I'm custom!"
-  end
-end
-
-class TempModel1 < ::ActiveRecord::Base
-  self.table_name = :companies
-end
-
-class TempModel2 < ::ActiveRecord::Base
-  self.table_name = :companies
-end
-
-class Models::ActiveRecord::CustomUser < ::ActiveRecord::Base
-end
-
-class Models::ActiveRecord::CustomUserSubclass < Models::ActiveRecord::CustomUser
-  audited
-end
-
-describe Audited::Audit do
-  let(:user) { Models::ActiveRecord::User.new name: "Testing" }
-
-  describe "audit class" do
-    around(:example) do |example|
-      original_audit_class = Audited.audit_class
-
-      example.run
-
-      Audited.config { |config| config.audit_class = original_audit_class }
-    end
-
-    context "when a custom audit class is configured" do
-      it "should be used in place of #{described_class}" do
-        Audited.config { |config| config.audit_class = "CustomAudit" }
-        TempModel1.audited
-
-        record = TempModel1.create
-
-        audit = record.audits.first
-        expect(audit).to be_a CustomAudit
-        expect(audit.custom_method).to eq "I'm custom!"
-      end
-    end
-
-    context "when a custom audit class is not configured" do
-      it "should default to #{described_class}" do
-        TempModel2.audited
-
-        record = TempModel2.create
-
-        audit = record.audits.first
-        expect(audit).to be_a Audited::Audit
-        expect(audit.respond_to?(:custom_method)).to be false
-      end
-    end
-  end
-
-  describe "#audited_changes" do
-    let(:audit) { Audited.audit_class.new }
-
-    it "can unserialize yaml from text columns" do
-      audit.audited_changes = {foo: "bar"}
-      expect(audit.audited_changes).to eq foo: "bar"
-    end
-
-    it "does not unserialize from binary columns" do
-      allow(Audited::YAMLIfTextColumnType).to receive(:text_column?).and_return(false)
-      audit.audited_changes = {foo: "bar"}
-      expect(audit.audited_changes).to eq "{:foo=>\"bar\"}"
-    end
-  end
-
-  describe "#undo" do
-    let(:user) { Models::ActiveRecord::User.create(name: "John") }
-
-    it "undos changes" do
-      user.update_attribute(:name, "Joe")
-      user.audits.last.undo
-      user.reload
-      expect(user.name).to eq("John")
-    end
-
-    it "undos destroy" do
-      user.destroy
-      user.audits.last.undo
-      user = Models::ActiveRecord::User.find_by(name: "John")
-      expect(user.name).to eq("John")
-    end
-
-    it "undos creation" do
-      user # trigger create
-      expect { user.audits.last.undo }.to change(Models::ActiveRecord::User, :count).by(-1)
-    end
-
-    it "fails when trying to undo unknown" do
-      audit = user.audits.last
-      audit.action = "oops"
-      expect { audit.undo }.to raise_error("invalid action given oops")
-    end
-  end
-
-  describe "user=" do
-    it "should be able to set the user to a model object" do
-      subject.user = user
-      expect(subject.user).to eq(user)
-    end
-
-    it "should be able to set the user to nil" do
-      subject.user_id = 1
-      subject.user_type = "Models::ActiveRecord::User"
-      subject.username = "joe"
-
-      subject.user = nil
-
-      expect(subject.user).to be_nil
-      expect(subject.user_id).to be_nil
-      expect(subject.user_type).to be_nil
-      expect(subject.username).to be_nil
-    end
-
-    it "should be able to set the user to a string" do
-      subject.user = "test"
-      expect(subject.user).to eq("test")
-    end
-
-    it "should clear model when setting to a string" do
-      subject.user = user
-      subject.user = "testing"
-      expect(subject.user_id).to be_nil
-      expect(subject.user_type).to be_nil
-    end
-
-    it "should clear the username when setting to a model" do
-      subject.username = "test"
-      subject.user = user
-      expect(subject.username).to be_nil
-    end
-  end
-
-  describe "revision" do
-    it "should recreate attributes" do
-      user = Models::ActiveRecord::User.create name: "1"
-      5.times { |i| user.update_attribute :name, (i + 2).to_s }
-
-      user.audits.each do |audit|
-        expect(audit.revision.name).to eq(audit.version.to_s)
-      end
-    end
-
-    it "should set protected attributes" do
-      u = Models::ActiveRecord::User.create(name: "Brandon")
-      u.update_attribute :logins, 1
-      u.update_attribute :logins, 2
-
-      expect(u.audits[2].revision.logins).to eq(2)
-      expect(u.audits[1].revision.logins).to eq(1)
-      expect(u.audits[0].revision.logins).to eq(0)
-    end
-
-    it "should bypass attribute assignment wrappers" do
-      u = Models::ActiveRecord::User.create(name: "<Joe>")
-      expect(u.audits.first.revision.name).to eq("&lt;Joe&gt;")
-    end
-
-    it "should work for deleted records" do
-      user = Models::ActiveRecord::User.create name: "1"
-      user.destroy
-      revision = user.audits.last.revision
-      expect(revision.name).to eq(user.name)
-      expect(revision).to be_a_new_record
-    end
-  end
-
-  describe ".collection_cache_key" do
-    if ActiveRecord::VERSION::MAJOR >= 5
-      it "uses created at" do
-        Audited::Audit.delete_all
-        audit = Models::ActiveRecord::User.create(name: "John").audits.last
-        audit.update_columns(created_at: Time.zone.parse("2018-01-01"))
-        expect(Audited::Audit.collection_cache_key).to match(/-20180101\d+$/)
-      end
-    else
-      it "is not defined" do
-        expect { Audited::Audit.collection_cache_key }.to raise_error(NoMethodError)
-      end
-    end
-  end
-
-  describe ".assign_revision_attributes" do
-    it "dups when frozen" do
-      user.freeze
-      assigned = Audited::Audit.assign_revision_attributes(user, name: "Bar")
-      expect(assigned.name).to eq "Bar"
-    end
-
-    it "ignores unassignable attributes" do
-      assigned = Audited::Audit.assign_revision_attributes(user, oops: "Bar")
-      expect(assigned.name).to eq "Testing"
-    end
-  end
-
-  it "should set the version number on create" do
-    user = Models::ActiveRecord::User.create! name: "Set Version Number"
-    expect(user.audits.first.version).to eq(1)
-    user.update_attribute :name, "Set to 2"
-    expect(user.audits.reload.first.version).to eq(1)
-    expect(user.audits.reload.last.version).to eq(2)
-    user.destroy
-    expect(Audited::Audit.where(auditable_type: "Models::ActiveRecord::User", auditable_id: user.id).last.version).to eq(3)
-  end
-
-  it "should set the request uuid on create" do
-    user = Models::ActiveRecord::User.create! name: "Set Request UUID"
-    expect(user.audits.reload.first.request_uuid).not_to be_blank
-  end
-
-  describe "reconstruct_attributes" do
-    it "should work with the old way of storing just the new value" do
-      audits = Audited::Audit.reconstruct_attributes([Audited::Audit.new(audited_changes: {"attribute" => "value"})])
-      expect(audits["attribute"]).to eq("value")
-    end
-  end
-
-  describe "audited_classes" do
-    it "should include audited classes" do
-      expect(Audited::Audit.audited_classes).to include(Models::ActiveRecord::User)
-    end
-
-    it "should include subclasses" do
-      expect(Audited::Audit.audited_classes).to include(Models::ActiveRecord::CustomUserSubclass)
-    end
-  end
-
-  describe "new_attributes" do
-    it "should return the audited_changes without modification for create" do
-      new_attributes = Audited::Audit.new(audited_changes: {int: 1, array: [1]}, action: :create).new_attributes
-      expect(new_attributes).to eq({"int" => 1, "array" => [1]})
-    end
-
-    it "should return a hash that contains the after values of each attribute" do
-      new_attributes = Audited::Audit.new(audited_changes: {a: [1, 2], b: [3, 4]}, action: :update).new_attributes
-      expect(new_attributes).to eq({"a" => 2, "b" => 4})
-    end
-
-    it "should return the audited_changes without modification for destroy" do
-      new_attributes = Audited::Audit.new(audited_changes: {int: 1, array: [1]}, action: :destroy).new_attributes
-      expect(new_attributes).to eq({"int" => 1, "array" => [1]})
-    end
-  end
-
-  describe "old_attributes" do
-    it "should return the audited_changes without modification for create" do
-      old_attributes = Audited::Audit.new(audited_changes: {int: 1, array: [1]}, action: :create).new_attributes
-      expect(old_attributes).to eq({"int" => 1, "array" => [1]})
-    end
-
-    it "should return a hash that contains the before values of each attribute" do
-      old_attributes = Audited::Audit.new(audited_changes: {a: [1, 2], b: [3, 4]}, action: :update).old_attributes
-      expect(old_attributes).to eq({"a" => 1, "b" => 3})
-    end
-
-    it "should return the audited_changes without modification for destroy" do
-      old_attributes = Audited::Audit.new(audited_changes: {int: 1, array: [1]}, action: :destroy).old_attributes
-      expect(old_attributes).to eq({"int" => 1, "array" => [1]})
-    end
-  end
-
-  describe "as_user" do
-    it "should record user objects" do
-      Audited::Audit.as_user(user) do
-        company = Models::ActiveRecord::Company.create name: "The auditors"
-        company.name = "The Auditors, Inc"
-        company.save
-
-        company.audits.each do |audit|
-          expect(audit.user).to eq(user)
-        end
-      end
-    end
-
-    it "should support nested as_user" do
-      Audited::Audit.as_user("sidekiq") do
-        company = Models::ActiveRecord::Company.create name: "The auditors"
-        company.name = "The Auditors, Inc"
-        company.save
-        expect(company.audits[-1].user).to eq("sidekiq")
-
-        Audited::Audit.as_user(user) do
-          company.name = "NEW Auditors, Inc"
-          company.save
-          expect(company.audits[-1].user).to eq(user)
-        end
-
-        company.name = "LAST Auditors, Inc"
-        company.save
-        expect(company.audits[-1].user).to eq("sidekiq")
-      end
-    end
-
-    it "should record usernames" do
-      Audited::Audit.as_user(user.name) do
-        company = Models::ActiveRecord::Company.create name: "The auditors"
-        company.name = "The Auditors, Inc"
-        company.save
-
-        company.audits.each do |audit|
-          expect(audit.username).to eq(user.name)
-        end
-      end
-    end
-
-    if ActiveRecord::Base.connection.adapter_name != "SQLite"
-      it "should be thread safe" do
-        expect(user.save).to eq(true)
-
-        t1 = Thread.new do
-          Audited::Audit.as_user(user) do
-            sleep 1
-            expect(Models::ActiveRecord::Company.create(name: "The Auditors, Inc").audits.first.user).to eq(user)
-          end
-        end
-
-        t2 = Thread.new do
-          Audited::Audit.as_user(user.name) do
-            expect(Models::ActiveRecord::Company.create(name: "The Competing Auditors, LLC").audits.first.username).to eq(user.name)
-            sleep 0.5
-          end
-        end
-
-        t1.join
-        t2.join
-      end
-    end
-
-    it "should return the value from the yield block" do
-      result = Audited::Audit.as_user("foo") do
-        42
-      end
-      expect(result).to eq(42)
-    end
-
-    it "should reset audited_user when the yield block raises an exception" do
-      expect {
-        Audited::Audit.as_user("foo") do
-          raise StandardError.new("expected")
-        end
-      }.to raise_exception("expected")
-      expect(Audited.store[:audited_user]).to be_nil
-    end
-  end
-end