validation_auditor 0.2.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df3fdbc82541c85c7c13bddebe3a18a4a7b8d50e
-  data.tar.gz: 698944970c971bf99d30eeec61782f75496e6c3d
+  metadata.gz: c2e09a496b0f32341947809d1ab6f87d2216472f
+  data.tar.gz: 8631c7538cde8a75ebc52520b00616e75d9c1805
 SHA512:
-  metadata.gz: bf9fd4135a3a550911658e1670a1bfa16080503dbca7a683c0da183da04553149cb4a0d65267430dd2267b2e1a3e525ff659b88eeea7328e42dbdba7e5cae96a
-  data.tar.gz: 0b93eba5ec3321b8fb09cf5b9e31ea695312a9daf08a31ceb637a083649c770a618b17f555d6adf4a299cbf18185154ca3c7ee63a543eda015de669724417352
+  metadata.gz: f41005ee1a54818d95c261d04f3531d36ab3011b89914d935e47bb19c3499120108e6618cb03fe2cf63db929914e50ea0f03c154e36c84b6ea178016dd627dd6
+  data.tar.gz: 35c20fbf0e1d8d00b86c8190107e0cbc7b6dd9bf605479bc60df49ec539b6cf4c781500b058644820ebb2c8f9ce68a2c666c879a13be9b4e5d5925e1e7bc263c

data/.travis.yml

@@ -3,7 +3,13 @@ rvm:
   - "1.9.3"
   - "2.0.0"
   - "2.1.2"
+  - "2.1.3"
+  - "2.1.4"
 gemfile:
-  - gemfiles/rails_3_2.Gemfile
-  - gemfiles/rails_4_0.Gemfile
-  - gemfiles/rails_4_1.Gemfile
+  - gemfiles/rails_3_2.gemfile
+  - gemfiles/rails_4_0.gemfile
+  - gemfiles/rails_4_1.gemfile
+addons:
+  code_climate:
+    repo_token:
+      secure: "JmFIrG06+Df5MZoksMx/H/g1Z/oe8cZaJMP6zYSiZ5uz122t6NF6Rs1JPDJeXP2+YMwsuSp7Ge45arFytGwysSSvY2iGGlA+om2IDekMsqqhsVYbo1rFzbM+H/RfrPUU2mY6MYkAmHzIBQvYUAWQ4s3qbHaCXXsdEyoilc99uaU="

data/Appraisals

@@ -0,0 +1,19 @@
+# Copyright © 2014, Watu
+
+appraise "rails-3_2" do
+  gem "activerecord", "~> 3.2.0"
+  gem "actionpack", "~> 3.2.0"
+  gem "railties", "~> 3.2.0"
+end
+
+appraise "rails-4_0" do
+  gem "activerecord", "~> 4.0.0"
+  gem "actionpack", "~> 4.0.0"
+  gem "railties", "~> 4.0.0"
+end
+
+appraise "rails-4_1" do
+  gem "activerecord", "~> 4.1.0"
+  gem "actionpack", "~> 4.1.0"
+  gem "railties", "~> 4.1.0"
+end

data/CHANGELOG.md

@@ -1,15 +1,19 @@
-## validation_auditor 0.2.1 (Sep 5, 2014) ##
+Authoritative changelog in README.md.
 
-* When cleaning params to save them as yaml, also clean each element of arrays.
+## validation_auditor 1.0.0 (Nov 17, 2014)
+- Started testing Ruby 2.1.3 and 2.1.4.
+- Refactoring to make code more readable (increased code climate to 4.0).
+- Marked internal methods as private.
+- Improved documentation.
 
-## validation_auditor 0.2.0 (Jul 23, 2014) ##
+## validation_auditor 0.2.1 (Sep 5, 2014) ##
+- When cleaning params to save them as yaml, also clean each element of arrays.
 
-* Respect the filter_parameters configuration from Rails.
+## validation_auditor 0.2.0 (Jul 23, 2014) ##
+- Respect the filter_parameters configuration from Rails.
 
 ## validation_auditor 0.1.1 (Jul 23, 2014) ##
-
-* Don't crash in the presence of file uploads when reporting validation errors.
+- Don't crash in the presence of file uploads when reporting validation errors.
 
 ## validation_auditor 0.1.0 (January 8, 2014) ##
-
-* Everything
+- Everything.

data/Gemfile

@@ -3,16 +3,4 @@
 
 source "https://rubygems.org"
 
-gem "assert_difference"
-gem "bundler", "~> 1.3"
-gem "coveralls", require: false
-gem "minitest"
-gem "minitest-reporters"
-gem "minitest-rails"
-gem "rake"
-gem "simplecov"
-gem "shoulda"
-gem "sqlite3"
-gem "activerecord", "~> 3.2.0"
-gem "actionpack", "~> 3.2.0"
-gem "railties", "~> 3.2.0"
+gemspec

data/README.md

@@ -3,7 +3,9 @@
 [![Build Status](https://travis-ci.org/watu/validation_auditor.png?branch=master)](https://travis-ci.org/watu/validation_auditor)
 [![Coverage Status](https://coveralls.io/repos/watu/validation_auditor/badge.png?branch=master)](https://coveralls.io/r/watu/validation_auditor?branch=master)
 [![Code Climate](https://codeclimate.com/github/watu/validation_auditor.png)](https://codeclimate.com/github/watu/validation_auditor)
+[![Inline docs](http://inch-ci.org/github/watu/validation_auditor.png?branch=master)](http://inch-ci.org/github/watu/validation_auditor)
 [![Gem Version](https://badge.fury.io/rb/validation_auditor.png)](http://badge.fury.io/rb/validation_auditor)
+[![Dependency Status](https://gemnasium.com/watu/validation_auditor.svg)](https://gemnasium.com/watu/validation_auditor)
 
 A user visits your web app, tries to do something with it but it fails due to a validation error. Generally, the
 validation is stopping a user from doing something bad, but every now and then it's the validation that is bad. Don't
@@ -52,6 +54,43 @@ If you enable validation audit on the controller, by calling `audit_validation_e
 then you'll also get params, url and user agent in the validation audit. This breaks the model-controller separation, so
 it's optional.
 
+If for some reason saving a validation audit fails, the exception will be left to propagate into your application so
+that no exception is silently swallowed. You may want to not let a secondary system, like auditing, to stop your
+application for working (depending on how critical auditing is for you). If that's the case, you can define an
+exception handler that can report in whatever fashion you normally report exceptions to your dev team or silently
+swallow the exception. This may or may not work in Rails < 4.
+
+    ValidationAuditor.exception_handler = lambda do |e, va|
+        puts "When trying to save validation audit #{va}, exception #{e} was encountered."
+    end
+
+## Users
+
+This gem is being used by:
+
+- [Watu](https://watuapp.com)
+- You? please, let us know if you are using this gem.
+
+## Changelog
+
+### validation_auditor 1.0.0 (Nov 17, 2014)
+- Started testing Ruby 2.1.3 and 2.1.4.
+- Refactoring to make code more readable (increased code climate to 4.0).
+- Marked internal methods as private.
+- Improved documentation.
+
+### validation_auditor 0.2.1 (Sep 5, 2014)
+- When cleaning params to save them as yaml, also clean each element of arrays.
+
+### validation_auditor 0.2.0 (Jul 23, 2014)
+- Respect the filter_parameters configuration from Rails.
+
+### validation_auditor 0.1.1 (Jul 23, 2014)
+- Don't crash in the presence of file uploads when reporting validation errors.
+
+### validation_auditor 0.1.0 (January 8, 2014)
+- Everything.
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1,6 +1,8 @@
 # encoding: UTF-8
 # Copyright © 2014, Watu
 
+require "rubygems"
+require "bundler/setup"
 require "bundler/gem_tasks"
 
 require "rake/testtask"

data/gemfiles/rails_3_2.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 3.2.0"
+gem "actionpack", "~> 3.2.0"
+gem "railties", "~> 3.2.0"
+
+gemspec :path => "../"

data/gemfiles/rails_3_2.gemfile.lock

@@ -0,0 +1,141 @@
+PATH
+  remote: ../
+  specs:
+    validation_auditor (1.0.0)
+      actionpack (>= 3.0.0)
+      activerecord (>= 3.0.0)
+      railties (>= 3.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (3.2.19)
+      activemodel (= 3.2.19)
+      activesupport (= 3.2.19)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.19)
+      activesupport (= 3.2.19)
+      builder (~> 3.0.0)
+    activerecord (3.2.19)
+      activemodel (= 3.2.19)
+      activesupport (= 3.2.19)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.19)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    ansi (1.4.3)
+    appraisal (1.0.2)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (3.0.3)
+    assert_difference (0.5.0)
+    builder (3.0.4)
+    codeclimate-test-reporter (0.4.1)
+      simplecov (>= 0.7.1, < 1.0.0)
+    coveralls (0.7.1)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    docile (1.1.5)
+    erubis (2.7.0)
+    hashie (3.3.1)
+    hike (1.2.3)
+    i18n (0.6.11)
+    journey (1.0.4)
+    json (1.8.1)
+    metaclass (0.0.4)
+    mime-types (1.25.1)
+    minitest (4.7.5)
+    minitest-rails (1.0.1)
+      minitest (~> 4.7)
+      minitest-test (~> 1.0)
+      railties (>= 3.0, < 4.1)
+    minitest-reporters (0.14.24)
+      ansi
+      builder
+      minitest (>= 2.12, < 5.0)
+      powerbar
+    minitest-test (1.1.0)
+      minitest (~> 4.0)
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.10.1)
+    netrc (0.7.7)
+    powerbar (1.0.11)
+      ansi (~> 1.4.0)
+      hashie (>= 1.1.0)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.4)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    railties (3.2.19)
+      actionpack (= 3.2.19)
+      activesupport (= 3.2.19)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.3.2)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rest-client (1.7.2)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.2.1)
+    shoulda-matchers (2.7.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.9.0)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.9)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.19.1)
+    tilt (1.4.1)
+    tins (1.3.2)
+    tzinfo (0.3.41)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack (~> 3.2.0)
+  activerecord (~> 3.2.0)
+  appraisal
+  assert_difference
+  bundler
+  codeclimate-test-reporter
+  coveralls
+  minitest
+  minitest-rails
+  minitest-reporters
+  mocha
+  railties (~> 3.2.0)
+  rake
+  shoulda
+  simplecov
+  sqlite3
+  validation_auditor!

data/gemfiles/rails_4_0.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.0.0"
+gem "actionpack", "~> 4.0.0"
+gem "railties", "~> 4.0.0"
+
+gemspec :path => "../"

data/gemfiles/rails_4_0.gemfile.lock

@@ -0,0 +1,125 @@
+PATH
+  remote: ../
+  specs:
+    validation_auditor (1.0.0)
+      actionpack (>= 3.0.0)
+      activerecord (>= 3.0.0)
+      railties (>= 3.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (4.0.9)
+      activesupport (= 4.0.9)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activemodel (4.0.9)
+      activesupport (= 4.0.9)
+      builder (~> 3.1.0)
+    activerecord (4.0.9)
+      activemodel (= 4.0.9)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.9)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.9)
+      i18n (~> 0.6, >= 0.6.9)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    ansi (1.4.3)
+    appraisal (1.0.2)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (4.0.2)
+    assert_difference (0.5.0)
+    builder (3.1.4)
+    codeclimate-test-reporter (0.4.1)
+      simplecov (>= 0.7.1, < 1.0.0)
+    coveralls (0.7.1)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    docile (1.1.5)
+    erubis (2.7.0)
+    hashie (3.3.1)
+    i18n (0.6.11)
+    metaclass (0.0.4)
+    mime-types (1.25.1)
+    minitest (4.7.5)
+    minitest-rails (1.0.1)
+      minitest (~> 4.7)
+      minitest-test (~> 1.0)
+      railties (>= 3.0, < 4.1)
+    minitest-reporters (0.14.24)
+      ansi
+      builder
+      minitest (>= 2.12, < 5.0)
+      powerbar
+    minitest-test (1.1.0)
+      minitest (~> 4.0)
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.10.1)
+    netrc (0.7.7)
+    powerbar (1.0.11)
+      ansi (~> 1.4.0)
+      hashie (>= 1.1.0)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    railties (4.0.9)
+      actionpack (= 4.0.9)
+      activesupport (= 4.0.9)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.3.2)
+    rest-client (1.7.2)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.2.1)
+    shoulda-matchers (2.7.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.9.0)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    sqlite3 (1.3.9)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tins (1.3.2)
+    tzinfo (0.3.41)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack (~> 4.0.0)
+  activerecord (~> 4.0.0)
+  appraisal
+  assert_difference
+  bundler
+  codeclimate-test-reporter
+  coveralls
+  minitest
+  minitest-rails
+  minitest-reporters
+  mocha
+  railties (~> 4.0.0)
+  rake
+  shoulda
+  simplecov
+  sqlite3
+  validation_auditor!

data/gemfiles/rails_4_1.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.1.0"
+gem "actionpack", "~> 4.1.0"
+gem "railties", "~> 4.1.0"
+
+gemspec :path => "../"

data/gemfiles/rails_4_1.gemfile.lock

@@ -0,0 +1,122 @@
+PATH
+  remote: ../
+  specs:
+    validation_auditor (1.0.0)
+      actionpack (>= 3.0.0)
+      activerecord (>= 3.0.0)
+      railties (>= 3.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (4.1.5)
+      actionview (= 4.1.5)
+      activesupport (= 4.1.5)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.5)
+      activesupport (= 4.1.5)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activemodel (4.1.5)
+      activesupport (= 4.1.5)
+      builder (~> 3.1)
+    activerecord (4.1.5)
+      activemodel (= 4.1.5)
+      activesupport (= 4.1.5)
+      arel (~> 5.0.0)
+    activesupport (4.1.5)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    ansi (1.4.3)
+    appraisal (1.0.2)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (5.0.1.20140414130214)
+    assert_difference (0.5.0)
+    builder (3.2.2)
+    codeclimate-test-reporter (0.4.1)
+      simplecov (>= 0.7.1, < 1.0.0)
+    coveralls (0.7.1)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    docile (1.1.5)
+    erubis (2.7.0)
+    i18n (0.6.11)
+    json (1.8.1)
+    metaclass (0.0.4)
+    mime-types (1.25.1)
+    minitest (5.4.1)
+    minitest-rails (2.1.0)
+      minitest (~> 5.4)
+      railties (~> 4.1)
+    minitest-reporters (1.0.5)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.10.1)
+    netrc (0.7.7)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    railties (4.1.5)
+      actionpack (= 4.1.5)
+      activesupport (= 4.1.5)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.3.2)
+    rest-client (1.7.2)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    ruby-progressbar (1.5.1)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.2.1)
+    shoulda-matchers (2.7.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.9.0)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    sqlite3 (1.3.9)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tins (1.3.2)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack (~> 4.1.0)
+  activerecord (~> 4.1.0)
+  appraisal
+  assert_difference
+  bundler
+  codeclimate-test-reporter
+  coveralls
+  minitest
+  minitest-rails
+  minitest-reporters
+  mocha
+  railties (~> 4.1.0)
+  rake
+  shoulda
+  simplecov
+  sqlite3
+  validation_auditor!

data/lib/generators/validation_auditor/install_generator.rb

@@ -5,13 +5,14 @@ require "rails/generators"
 require "rails/generators/migration"
 require "rails/generators/active_record"
 
-# Extend the DelayedJobGenerator so that it creates an AR migration
 module ValidationAuditor
+  # Generator to be able to run `rails generate validation_auditor:install`
   class InstallGenerator < Rails::Generators::Base
     include Rails::Generators::Migration
 
     self.source_paths << File.join(File.dirname(__FILE__), "templates")
 
+    # Create migration files.
     def create_migration_file
       migration_template "migration.rb", "db/migrate/create_validation_audits.rb"
     end

data/lib/generators/validation_auditor/templates/migration.rb

@@ -1,4 +1,6 @@
+# Create table to store validation errors.
 class CreateValidationAudits < ActiveRecord::Migration
+  # Create table to store validation errors.
   def up
     create_table :validation_audits do |t|
       t.integer :record_id

data/lib/validation_auditor.rb

@@ -6,6 +6,9 @@ require "active_record"
 require "action_controller"
 
 module ValidationAuditor
+  mattr_accessor :exception_handler
+
+  # Validation audit model.
   class ValidationAudit < ActiveRecord::Base
     belongs_to :record, :polymorphic => true
 
@@ -14,33 +17,77 @@ module ValidationAuditor
     serialize :data, Hash
     serialize :params, Hash
 
-
     if respond_to? :attr_accessible # For Rails < 4 or Rails >= 4 with attr_accessible added by a third party library.
       begin
         attr_accessible
       rescue RuntimeError # Rails 4 raises a RuntimeError when you call attr_accessible, but we still want to call it in case you added attr_accessible gem.
       end
     end
+
+    # If available, add controller data to this validation audit. This will include:
+    # - params
+    # - url
+    # - user_agent
+    #
+    # @see ValidationAuditor::Controller::ClassMethods#audit_validation_errors
+    def add_controller
+      if ValidationAuditor::Controller.request.present?
+        request = ValidationAuditor::Controller.request
+        self.params = ValidationAuditor::Controller.clean_params(request.filtered_parameters)
+        self.url = request.url
+        self.user_agent = request.env["HTTP_USER_AGENT"]
+      end
+    end
   end
 
+  # Controller side of audit validations.
+  #
+  # @see ValidationAuditor::Controller::ClassMethods#audit_validation_errors
   module Controller
     extend ActiveSupport::Concern
 
+    # Class methods accessible in controllers (classes inheriting from ActionController::Base).
     module ClassMethods
+      # Enable validation audits for this controller. This is not essential to be able to audit validations, but it
+      # enhances the reports with:
+      # - params
+      # - url
+      # - user_agent
+      #
+      # For example:
+      #
+      #   class BlogsController < ApplicationController
+      #     audit_validation_errors
+      #   end
+      #
+      # @see ValidationAuditor::Model::ClassMethods#audit_validation_errors
       def audit_validation_errors
         before_filter :make_request_auditable
       end
     end
 
+    private
+
+    # Make the request available for later adding some of its details to the validation audit. This method is
+    # automatically called as before_filter when you enable validation audits for a controller.
+    #
+    # @see ValidationAuditor::Controller::ClassMethods#audit_validation_errors
     def make_request_auditable
       Thread.current[:validation_auditor_request] = self.request
     end
 
+    # Getter for the request for the audit.
+    #
+    # @see ValidationAuditor::Controller::ClassMethods#audit_validation_errors
     def self.request
       Thread.current[:validation_auditor_request]
     end
 
     # Clean parameters before storing them in the database.
+    #
+    # This method gets sure we don't have unserializable values, like UploadedFiles.
+    # @param param [Hash] Hash of params as created by Rails
+    # @return [Hash] A hash without those problematic values.
     def self.clean_params(param)
       if param.is_a? Hash
         cleaned_params = {}
@@ -58,33 +105,50 @@ module ValidationAuditor
     end
   end
 
+  # Model side of audit validations.
+  #
+  # @see ValidationAuditor::Model::ClassMethods#audit_validation_errors
   module Model
     extend ActiveSupport::Concern
 
+    # Class methods accessible in models (classes inheriting from ActiveRecord::Base).
     module ClassMethods
+      # Enable validation audits for a model. For example:
+      #
+      #   class Blog < ActiveRecord::Base
+      #     audit_validation_errors
+      #   end
+      #
+      # @see ValidationAuditor::Controller::ClassMethods#audit_validation_errors
       def audit_validation_errors
         after_rollback :audit_validation
       end
     end
 
+    private
+
+    # Perform the actual audit validation. This method is automatically called on rollback when you enable validation on
+    # a model.
+    #
+    # @see ValidationAuditor::Model::ClassMethods#audit_validation_errors
     def audit_validation
-      if !errors.empty? # We don't use :valid? to avoid re-running validations
-        va = ValidationAudit.new
-        va.failures = self.errors.to_hash
-        va.failure_messages = self.errors.full_messages.to_a
-        va.data = self.attributes
-        if self.new_record? # For new records
-          va.record_type = self.class.name # we only store the class's name.
-        else
-          va.record = self
-        end
-        if ValidationAuditor::Controller.request.present?
-          request = ValidationAuditor::Controller.request
-          va.params = ValidationAuditor::Controller.clean_params(request.filtered_parameters)
-          va.url = request.url
-          va.user_agent = request.env["HTTP_USER_AGENT"]
-        end
-        va.save
+      return if errors.empty? # We don't use :valid? to avoid re-running validations
+      validatio_audit = ValidationAudit.new
+      validatio_audit.failures = self.errors.to_hash
+      validatio_audit.failure_messages = self.errors.full_messages.to_a
+      validatio_audit.data = self.attributes
+      if self.new_record? # For new records
+        validatio_audit.record_type = self.class.name # we only store the class's name.
+      else
+        validatio_audit.record = self
+      end
+      validatio_audit.add_controller
+      validatio_audit.save!
+    rescue Exception => e
+      if ValidationAuditor.exception_handler.nil?
+        raise # If there's no exception handler, just re-raise the exception.
+      else
+        ValidationAuditor.exception_handler.call(e, validatio_audit)
       end
     end
   end

data/lib/validation_auditor/version.rb

@@ -2,5 +2,5 @@
 # Copyright © 2014, Watu
 
 module ValidationAuditor
-  VERSION = "0.2.1"
+  VERSION = "1.0.0"
 end

data/test/model_test.rb

@@ -2,6 +2,7 @@
 # Copyright © 2014, Watu
 
 require_relative "test_helper"
+require "rails/version" # Required to access Rails::VERSION::MAJOR
 
 class ModelTest < ActiveSupport::TestCase
   should "not create a validation audit when no errors occurs" do
@@ -45,10 +46,52 @@ class ModelTest < ActiveSupport::TestCase
     end
   end
 
-  should "not create a validation audit for non audited models" do
-    assert_difference "ValidationAuditor::ValidationAudit.count" => 0 do
-      NonAuditedRecord.create(name: "John Doe") # Missing email.
+  if Rails::VERSION::MAJOR >= 4 # Prior to Rails 4, it seems exceptions in after_rollback were silently swallowed: https://rails.lighthouseapp.com/projects/8994-ruby-on-rails/tickets/6064-exceptions-from-after_commit-and-after_rollback-from-observers-are-quietly-swallowed
+    should "let exceptions propagate if no handler has been set up" do
+      ValidationAuditor::ValidationAudit.any_instance.expects(:save!).raises(Exception, "Something went wrong saving the audit")
+      assert_raises Exception do
+        AuditedRecord.create(name: "John Doe")
+      end
+    end
+  end
+
+  should "not let exceptions propagate when a handler has been set up" do
+    exception_message = "Something went wrong saving the audit"
+    exception_handler_called = false
+    ValidationAuditor.exception_handler = lambda do |e, va|
+      assert e.is_a?(Exception)
+      assert_equal e.message, exception_message
+      assert va.is_a?(ValidationAuditor::ValidationAudit)
+      exception_handler_called = true
+    end
+    ValidationAuditor::ValidationAudit.any_instance.stubs(:save!).raises(Exception, exception_message)
+
+    AuditedRecord.create(name: "John Doe")
+
+    assert exception_handler_called
+
+    # teardown
+    ValidationAuditor.exception_handler = nil
+  end
+
+  should "add controller information if possible" do
+    params = {"hello" => "world", "universe" => "42"}
+    url = "https://example.com/hello/world"
+    env = {"HTTP_USER_AGENT" => "NCSA_Mosaic/2.0"}
+    request = mock("request") do
+      stubs(:present?).returns(true)
+      stubs(:filtered_parameters).returns(params)
+      stubs(:url).returns(url)
+      stubs(:env).returns(env)
     end
+    ValidationAuditor::Controller.stubs(:request).returns(request)
+    assert_difference "ValidationAuditor::ValidationAudit.count" => +1 do
+      AuditedRecord.create(name: "John Doe") # Missing email.
+    end
+    audit = ValidationAuditor::ValidationAudit.order(:id).last
+    assert_equal params, audit.params
+    assert_equal url, audit.url
+    assert_equal env["HTTP_USER_AGENT"], audit.user_agent
   end
 end
 

data/test/test_helper.rb

@@ -10,15 +10,15 @@ SimpleCov.start do
   add_filter "/test/"
 end
 Coveralls.wear! # Comment out this line to have the local coverage generated.
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
 
 require "minitest/autorun"
 require "minitest/reporters"
 MiniTest::Reporters.use!
-
 require "active_support/test_case"
 require "action_controller"
 require "action_controller/test_case"
-
 require "shoulda"
 require "shoulda-context"
 require "shoulda-matchers"
@@ -33,7 +33,7 @@ require "logger"
 ActiveRecord::Base.logger = Logger.new(STDERR)
 ActiveRecord::Base.logger.level = Logger::WARN
 ActiveRecord::Base.configurations = {"sqlite3" => {adapter: "sqlite3", database: ":memory:"}}
-ActiveRecord::Base.establish_connection("sqlite3")
+ActiveRecord::Base.establish_connection(:sqlite3)
 
 # Models setup.
 require "validation_auditor"

data/validation_auditor.gemspec

@@ -21,7 +21,21 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.required_ruby_version = ">= 1.9.3"
-  spec.add_dependency "activerecord", "> 3.2.0"
-  spec.add_dependency "actionpack", "> 3.2.0"
-  spec.add_dependency "railties", "> 3.2.0"
+  spec.add_dependency "activerecord", ">= 3.0.0"
+  spec.add_dependency "actionpack", ">= 3.0.0"
+  spec.add_dependency "railties", ">= 3.0.0"
+
+  spec.add_development_dependency "appraisal"
+  spec.add_development_dependency "assert_difference"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency "coveralls" #, require: false
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-reporters"
+  spec.add_development_dependency "minitest-rails"
+  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "shoulda"
+  spec.add_development_dependency "sqlite3"
 end

metadata

@@ -1,57 +1,239 @@
 --- !ruby/object:Gem::Specification
 name: validation_auditor
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.0.0
 platform: ruby
 authors:
 - J. Pablo Fernández
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-05 00:00:00.000000000 Z
+date: 2014-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: assert_difference
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Log validation errors to the database for later inspection.
 email:
 - pupeno@watuapp.com
@@ -61,14 +243,18 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- Appraisals
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- gemfiles/rails_3_2.Gemfile
-- gemfiles/rails_4_0.Gemfile
-- gemfiles/rails_4_1.Gemfile
+- gemfiles/rails_3_2.gemfile
+- gemfiles/rails_3_2.gemfile.lock
+- gemfiles/rails_4_0.gemfile
+- gemfiles/rails_4_0.gemfile.lock
+- gemfiles/rails_4_1.gemfile
+- gemfiles/rails_4_1.gemfile.lock
 - lib/generators/validation_auditor/install_generator.rb
 - lib/generators/validation_auditor/templates/migration.rb
 - lib/validation_auditor.rb
@@ -98,7 +284,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Log validation errors to the database for later inspection.

data/gemfiles/rails_3_2.Gemfile

@@ -1,18 +0,0 @@
-# encoding: UTF-8
-# Copyright © 2013, 2014, Watu
-
-source "https://rubygems.org"
-
-gem "assert_difference"
-gem "bundler", "~> 1.3"
-gem "coveralls", require: false
-gem "minitest"
-gem "minitest-reporters"
-gem "minitest-rails"
-gem "rake"
-gem "simplecov"
-gem "shoulda"
-gem "sqlite3"
-gem "activerecord", "~> 3.2.0"
-gem "actionpack", "~> 3.2.0"
-gem "railties", "~> 3.2.0"

data/gemfiles/rails_4_0.Gemfile

@@ -1,18 +0,0 @@
-# encoding: UTF-8
-# Copyright © 2014, Watu
-
-source "https://rubygems.org"
-
-gem "assert_difference"
-gem "bundler", "~> 1.3"
-gem "coveralls", require: false
-gem "minitest"
-gem "minitest-reporters"
-gem "minitest-rails"
-gem "rake"
-gem "simplecov"
-gem "shoulda"
-gem "sqlite3"
-gem "activerecord", "~> 4.0.0"
-gem "actionpack", "~> 4.0.0"
-gem "railties", "~> 4.0.0"

data/gemfiles/rails_4_1.Gemfile

@@ -1,18 +0,0 @@
-# encoding: UTF-8
-# Copyright © 2014, Watu
-
-source "https://rubygems.org"
-
-gem "assert_difference"
-gem "bundler", "~> 1.3"
-gem "coveralls", require: false
-gem "minitest"
-gem "minitest-reporters"
-gem "minitest-rails"
-gem "rake"
-gem "simplecov"
-gem "shoulda"
-gem "sqlite3"
-gem "activerecord", "~> 4.1.0"
-gem "actionpack", "~> 4.1.0"
-gem "railties", "~> 4.1.0"