ndr_error 1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1473293877a02707de297dd4bf2bb9d4e6677c83
-  data.tar.gz: 5017fe856872644b397ce6b217b6fed2a16215ca
+  metadata.gz: 877ec19317a0ae9be64006c96a55d9b332bbacd5
+  data.tar.gz: 5b6fb96d9f558490b82643e93f6b3f20ab07f1d7
 SHA512:
-  metadata.gz: 7b6842c12f597933f241a5f064ff6f605693a2b87b69deb01c1c8921af388f6954a13c2801588235b0b49fb3112a9683d059cbb6a7144f7202c4eb4cd447e1bd
-  data.tar.gz: efe89ecde782650ba58a3bac3c7084281bda525d49e1f2157b0a9664691e88159ad3a88cdfa5be64a355992e934d71a41f7f4831c500b830598c52f4e9620afe
+  metadata.gz: ec6f0b2ea818b8f65def48e762419bc8cc6861ee84ebcb830987db1663e2d4e712c0ef3ccbf706d5f55f6ac133b70a751905a7e5a7cc3298cc3ce0a281481667
+  data.tar.gz: 73d1917679c69d59f809828fb7552899a2c3339c969cd16695fca4ceff04195514ba8b243c4175e0971c0b70169a014010096a39788796b9367bc25eab614a15

data/README.md

@@ -1,4 +1,4 @@
-# NdrError [![Build Status](https://travis-ci.org/PublicHealthEngland/ndr_error.svg?branch=master)](https://travis-ci.org/PublicHealthEngland/ndr_error)
+# NdrError [![Build Status](https://travis-ci.org/PublicHealthEngland/ndr_error.svg?branch=master)](https://travis-ci.org/PublicHealthEngland/ndr_error) [![Gem Version](https://badge.fury.io/rb/ndr_error.svg)](https://badge.fury.io/rb/ndr_error)
 
 This is the Public Health England (PHE) National Disease Registers (NDR) Error ruby gem. It is a 
 Rails engine that provides error logging, viewing, and grouping capabilities.
@@ -12,7 +12,7 @@ The grouping used can be customised by the host application (see below).
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'ndr_error', git: 'https://github.com/PublicHealthEngland/ndr_error.git'
+gem 'ndr_error'
 ```
 
 And then execute:
@@ -59,6 +59,7 @@ Other configuration:
 
 Configuration | Default | Description
 --- | --- | ---
+`abstract_model_class` | `ActiveRecord::Base` | An abstract model class to be used as the parent for Fingerprints and Logs.
 `exception_app_callback` | `-> { true }` | A callback that is fired when an exception is being logged. Can be used for e.g. sending email notifications. Returning false will abort the logging.
 `check_current_user_permissions` | `-> { true }` | A callable object that should return whether or not the current user should be able to tag / delete logged exceptions.
 `filtered_parameters` | derived from host app | The context logging tries to capture request parameters. Use this to list sensitive parameters which should not be logged.

data/Rakefile

@@ -33,6 +33,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'
   t.verbose = false
+  t.warning = false
 end
 
 task default: :test

data/app/controllers/ndr_error/application_controller.rb

@@ -1,7 +1,7 @@
 module NdrError
   # Global controller logic
   class ApplicationController < ActionController::Base
-    before_filter :authenticate
+    before_action :authenticate
 
     # Ensure Rails doesn't find any host layouts first:
     layout 'ndr_error/ndr_error'

data/app/controllers/ndr_error/errors_controller.rb

@@ -1,8 +1,8 @@
 module NdrError
   # Controller for viewing and managing errors
   class ErrorsController < ApplicationController
-    before_filter :find_fingerprint,  only: [:show, :edit, :update, :destroy]
-    before_filter :check_permissions, only: [:edit, :update, :destroy]
+    before_action :find_fingerprint,  only: [:show, :edit, :update, :destroy]
+    before_action :check_permissions, only: [:edit, :update, :destroy]
 
     def index
       if NdrError::Log.perform_cleanup!

data/app/models/ndr_error/fingerprint.rb

@@ -1,6 +1,6 @@
 module NdrError
   # Fingerprints group together similar error occurences.
-  class Fingerprint < ActiveRecord::Base
+  class Fingerprint < NdrError.abstract_model_class
     # Pagination:
     self.per_page = 10
 
@@ -73,7 +73,7 @@ module NdrError
     # have been loaded by rails internally
     # and won't have default scoping applied.
     def first_occurrence
-      @_first ||= error_logs(true).last
+      @_first ||= error_logs.reload.last
     end
 
     # Returns the record corresponding to the
@@ -82,7 +82,7 @@ module NdrError
     # have been loaded by rails internally
     # and won't have default scoping applied.
     def latest_occurrence
-      @_latest ||= error_logs(true).first
+      @_latest ||= error_logs.reload.first
     end
   end
 end

data/app/models/ndr_error/log.rb

@@ -4,7 +4,7 @@ module NdrError
   # Log records may be purged, whereas fingerprints are
   # designed to be eternally persisted.
   #
-  class Log < ActiveRecord::Base
+  class Log < NdrError.abstract_model_class
     include NdrError::BacktraceCompression
     include NdrError::Fuzzing
     include NdrError::UuidBuilder
@@ -81,7 +81,7 @@ module NdrError
 
     # Gets similar errors.
     def similar_errors(include_self = false)
-      unless @_similar
+      unless defined?(@_similar)
         @_similar = {}
         @_similar[true]  = self.class.similar_to(self)
         @_similar[false] = @_similar[true] - [self]
@@ -101,7 +101,7 @@ module NdrError
     # Returns the next historical occurence,
     # or nil if there hasn't been one.
     def next
-      lookup = similar_errors(true)
+      lookup = similar_errors(true).to_a
       index  = lookup.index(self)
       lookup[0...index].last
     end

data/lib/ndr_error/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 # Contains the version of NdrError. Sourced by the gemspec.
 module NdrError
-  VERSION = '1.0.1'.freeze
+  VERSION = '1.1.1'.freeze
 end

data/lib/ndr_error.rb

@@ -11,6 +11,11 @@ module NdrError
   extend Finder
   extend Logging
 
+  # Allows the host to define a parent model for the Log and
+  # Fingerprint classes. Defaults to ActiveRecord::Base.
+  mattr_accessor :abstract_model_class
+  self.abstract_model_class = ActiveRecord::Base
+
   # Callable object, that by default is called by the NdrError::Middleware::PublicExceptions
   # middleware (with the request and exception objects) when an exception is handled.
   # Returning a "falsey" value will prevent the exception from being logged.