audited-hp 4.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8180c7e9719f2de9261fb2b2353532a231c9883f
+  data.tar.gz: 10f2dd4a7f48f5527ee85ccd724c7fda9203fd27
+SHA512:
+  metadata.gz: 2aacfc198a4243092803d9e3fdcffb4da68c5fa66508bb765a5b0cf4be84b8f6fed4243743221ba8b07b2821879cac3bd08044f3566f446027e2e3fc429c83ea
+  data.tar.gz: 79729ec7e575eadc4c8855d4b64e636176d453559569908832431708a3d3832321af96feba91c23fe5c3f7a6b627635d050204ddba1aa2533acc80435f6a99ef

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,32 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.1
+  - 2.2.4
+  - 2.3.1
+  - ruby-head
+env:
+  - DB=SQLITE
+  - DB=POSTGRES
+  - DB=MYSQL
+gemfile:
+  - gemfiles/rails40.gemfile
+  - gemfiles/rails41.gemfile
+  - gemfiles/rails42.gemfile
+  - gemfiles/rails50.gemfile
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+  exclude:
+    - rvm: 2.1
+      gemfile: gemfiles/rails50.gemfile
+  fast_finish: true
+branches:
+  only:
+  - master
+sudo: false
+notifications:
+  webhooks:
+    urls:
+    - http://buildlight.collectiveidea.com/
+    on_start: always

data/.yardopts

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

data/Appraisals

@@ -0,0 +1,22 @@
+appraise 'rails40' do
+  gem 'rails', '~> 4.0.0'
+  gem 'protected_attributes'
+  gem 'test-unit'
+end
+
+appraise 'rails41' do
+  gem 'rails', '~> 4.1.0'
+  gem 'protected_attributes'
+end
+
+appraise 'rails42' do
+  gem 'rails', '~> 4.2.0'
+  gem 'protected_attributes'
+end
+
+appraise 'rails50' do
+  gem 'rails', '~> 5.0.0'
+
+  # The following needs to point to Github until the release of 0.1.3
+  gem 'rails-observers', github: 'rails/rails-observers', branch: 'master'
+end

data/CHANGELOG

@@ -0,0 +1,153 @@
+# Audited ChangeLog
+
+## Unreleased
+
+Breaking changes
+
+- None
+
+Added
+
+- None
+
+Fixed
+
+- None
+
+## 4.3.0 (2016-09-17)
+
+Breaking changes
+
+- None
+
+Added
+
+- Support singular arguments for options: `on` and `only`
+
+Fixed
+
+- Fix auditing instance attributes if "only" option specified
+- Allow private / protected callback declarations
+- Do not eagerly connect to database
+
+## 4.2.2 (2016-08-01)
+
+- Correct auditing_enabled for STI models
+- Properly set table name for mongomapper
+
+## 4.2.1 (2016-07-29)
+
+- Fix bug when only: is a single field.
+- update gemspec to use mongomapper 0.13
+- sweeper need not run observer for mongomapper
+- Make temporary disabling of auditing threadsafe
+- Centralize `Audited.store` as thread safe variable store
+
+## 4.2.0 (2015-03-31)
+
+Not yet documented.
+
+## 4.0.0 (2014-09-04)
+
+Not yet documented.
+
+## 4.0.0.rc1 (2014-07-30)
+
+Not yet documented.
+
+## 3.0.0 (2012-09-25)
+
+Not yet documented.
+
+## 3.0.0.rc2 (2012-07-09)
+
+Not yet documented.
+
+## 3.0.0.rc1 (2012-04-25)
+
+Not yet documented.
+
+## 2012-04-10
+
+- Add Audit scopes for creates, updates and destroys [chriswfx]
+
+## 2011-10-25
+
+- Made ignored_attributes configurable [senny]
+
+## 2011-09-09
+
+- Rails 3.x support
+- Support for associated audits
+- Support for remote IP address storage
+- Plenty of bug fixes and refactoring
+- [kennethkalmer, ineu, PatrickMa, jrozner, dwarburton, bsiggelkow, dgm]
+
+## 2009-01-27
+
+- Store old and new values for updates, and store all attributes on destroy.
+- Refactored revisioning methods to work as expected
+
+## 2008-10-10
+
+- changed to make it work in development mode
+
+## 2008-09-24
+
+- Add ability to record parent record of the record being audited [Kenneth Kalmer]
+
+## 2008-04-19
+
+- refactored to make compatible with dirty tracking in edge rails
+  and to stop storing both old and new values in a single audit
+
+## 2008-04-18
+
+- Fix NoMethodError when trying to access the :previous revision
+  on a model that doesn't have previous revisions [Alex Soto]
+
+## 2008-03-21
+
+- added #changed_attributes to get access to the changes before a
+  save [Chris Parker]
+
+## 2007-12-16
+
+- Added #revision_at for retrieving a revision from a specific
+  time [Jacob Atzen]
+
+## 2007-12-16
+
+- Fix error when getting revision from audit with no changes
+  [Geoffrey Wiseman]
+
+## 2007-12-16
+
+- Remove dependency on acts_as_list
+
+## 2007-06-17
+
+- Added support getting previous revisions
+
+## 2006-11-17
+
+- Replaced use of singleton User.current_user with cache sweeper
+  implementation for auditing the user that made the change
+
+## 2006-11-17
+
+- added migration generator
+
+## 2006-08-14
+
+- incorporated changes from Michael Schuerig to write_attribute
+  that saves the new value after every change and not just the
+  first, and performs proper type-casting before doing comparisons
+
+## 2006-08-14
+
+- The "changes" are now saved as a serialized hash
+
+## 2006-07-21
+
+- initial version

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec name: "audited"

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright © 2010 Brandon Keepers - Collective Idea
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,299 @@
+Audited [![Build Status](https://secure.travis-ci.org/collectiveidea/audited.svg)](http://travis-ci.org/collectiveidea/audited) [![Dependency Status](https://gemnasium.com/collectiveidea/audited.svg)](https://gemnasium.com/collectiveidea/audited)[![Code Climate](https://codeclimate.com/github/collectiveidea/audited.svg)](https://codeclimate.com/github/collectiveidea/audited) [![Security](https://hakiri.io/github/collectiveidea/audited/master.svg)](https://hakiri.io/github/collectiveidea/audited/master)
+=======
+
+**Audited** (previously acts_as_audited) is an ORM extension that logs all changes to your models. Audited can also record who made those changes, save comments and associate models related to the changes.
+
+Audited currently (4.x) works with Rails 5.0 and 4.2. It may work with 4.1 and 4.0, but this is not guaranteed.
+
+For Rails 3, use gem version 3.0 or see the [3.0-stable branch](https://github.com/collectiveidea/audited/tree/3.0-stable).
+
+## Supported Rubies
+
+Audited supports and is [tested against](http://travis-ci.org/collectiveidea/audited) the following Ruby versions:
+
+* 2.1.5
+* 2.2.4
+* 2.3.1
+
+Audited may work just fine with a Ruby version not listed above, but we can't guarantee that it will. If you'd like to maintain a Ruby that isn't listed, please let us know with a [pull request](https://github.com/collectiveidea/audited/pulls).
+
+## Supported ORMs
+
+Audited is currently ActiveRecord-only. In a previous life, Audited worked with MongoMapper. Use the [4.2-stable branch](https://github.com/collectiveidea/audited/tree/4.2-stable) if you need MongoMapper.
+
+## Installation
+
+Add the gem to your Gemfile:
+
+```ruby
+gem "audited", "~> 4.3"
+```
+
+If you are using rails 5.0, you would also need the following line in your Gemfile.
+```ruby
+gem "rails-observers", github: 'rails/rails-observers'
+```
+
+Then, from your Rails app directory, create the `audits` table:
+
+```bash
+$ rails generate audited:install
+$ rake db:migrate
+```
+
+#### Upgrading
+
+If you're already using Audited (or acts_as_audited), your `audits` table may require additional columns. After every upgrade, please run:
+
+```bash
+$ rails generate audited:upgrade
+$ rake db:migrate
+```
+
+Upgrading will only make changes if changes are needed.
+
+
+## Usage
+
+Simply call `audited` on your models:
+
+```ruby
+class User < ActiveRecord::Base
+  audited
+end
+```
+
+By default, whenever a user is created, updated or destroyed, a new audit is created.
+
+```ruby
+user = User.create!(name: "Steve")
+user.audits.count # => 1
+user.update_attributes!(name: "Ryan")
+user.audits.count # => 2
+user.destroy
+user.audits.count # => 3
+```
+
+Audits contain information regarding what action was taken on the model and what changes were made.
+
+```ruby
+user.update_attributes!(name: "Ryan")
+audit = user.audits.last
+audit.action # => "update"
+audit.audited_changes # => {"name"=>["Steve", "Ryan"]}
+```
+
+You can get previous versions of a record by index or date, or list all
+revisions.
+
+```ruby
+user.revisions
+user.revision(1)
+user.revision_at(Date.parse("2016-01-01"))
+```
+
+### Specifying columns
+
+By default, a new audit is created for any attribute changes. You can, however, limit the columns to be considered.
+
+```ruby
+class User < ActiveRecord::Base
+  # All fields
+  # audited
+
+  # Single field
+  # audited only: :name
+
+  # Multiple fields
+  # audited only: [:name, :address]
+
+  # All except certain fields
+  # audited except: :password
+end
+```
+
+### Specifying callbacks
+
+By default, a new audit is created for any Create, Update or Destroy action. You can, however, limit the actions audited.
+
+```ruby
+class User < ActiveRecord::Base
+  # All fields and actions
+  # audited
+
+  # Single field, only audit Update and Destroy (not Create)
+  # audited only: :name, on: [:update, :destroy]
+end
+```
+
+### Comments
+
+You can attach comments to each audit using an `audit_comment` attribute on your model.
+
+```ruby
+user.update_attributes!(name: "Ryan", audit_comment: "Changing name, just because")
+user.audits.last.comment # => "Changing name, just because"
+```
+
+You can optionally add the `:comment_required` option to your `audited` call to require comments for all audits.
+
+```ruby
+class User < ActiveRecord::Base
+  audited :comment_required => true
+end
+```
+
+### Current User Tracking
+
+If you're using Audited in a Rails application, all audited changes made within a request will automatically be attributed to the current user. By default, Audited uses the `current_user` method in your controller.
+
+```ruby
+class PostsController < ApplicationController
+  def create
+    current_user # => #<User name: "Steve">
+    @post = Post.create(params[:post])
+    @post.audits.last.user # => #<User name: "Steve">
+  end
+end
+```
+
+To use a method other than `current_user`, put the following in an initializer:
+
+```ruby
+Audited.current_user_method = :authenticated_user
+```
+
+Outside of a request, Audited can still record the user with the `as_user` method:
+
+```ruby
+Audited::Audit.as_user(User.find(1)) do
+  post.update_attribute!(title: "Hello, world!")
+end
+post.audits.last.user # => #<User id: 1>
+```
+
+#### Custom Auditor
+
+You might need to use a custom auditor from time to time. It can be done by simply passing in a string:
+
+```ruby
+class ApplicationController < ActionController::Base
+  def authenticated_user
+    if current_user
+      current_user
+    else
+      'Elon Musk'
+    end
+  end
+end
+```
+
+### Associated Audits
+
+Sometimes it's useful to associate an audit with a model other than the one being changed. For instance, given the following models:
+
+```ruby
+class User < ActiveRecord::Base
+  belongs_to :company
+  audited
+end
+
+class Company < ActiveRecord::Base
+  has_many :users
+end
+```
+
+Every change to a user is audited, but what if you want to grab all of the audits of users belonging to a particular company? You can add the `:associated_with` option to your `audited` call:
+
+```ruby
+class User < ActiveRecord::Base
+  belongs_to :company
+  audited associated_with: :company
+end
+
+class Company < ActiveRecord::Base
+  has_many :users
+  has_associated_audits
+end
+```
+
+Now, when an audit is created for a user, that user's company is also saved alongside the audit. This makes it much easier (and faster) to access audits indirectly related to a company.
+
+```ruby
+company = Company.create!(name: "Collective Idea")
+user = company.users.create!(name: "Steve")
+user.update_attribute!(name: "Steve Richert")
+user.audits.last.associated # => #<Company name: "Collective Idea">
+company.associated_audits.last.auditable # => #<User name: "Steve Richert">
+```
+
+### Disabling auditing
+
+If you want to disable auditing temporarily doing certain tasks, there are a few
+methods available.
+
+To disable auditing on a save:
+
+```ruby
+@user.save_without_auditing
+```
+
+or:
+
+```ruby
+@user.without_auditing do
+  @user.save
+end
+```
+
+To disable auditing on a column:
+
+```ruby
+User.non_audited_columns = [:first_name, :last_name]
+```
+
+To disable auditing on an entire model:
+
+```ruby
+User.auditing_enabled = false
+```
+
+## Gotchas
+
+### Using attr_protected with Rails 4.x
+
+If you're using the `protected_attributes` gem with Rails 4.0, 4.1 or 4.2 (the gem isn't supported in Rails 5.0 or higher), you'll have to take an extra couple of steps to get `audited` working.
+
+First be sure to add `allow_mass_assignment: true` to your `audited` call; otherwise Audited will
+interfere with `protected_attributes` and none of your `save` calls will work.
+
+```ruby
+class User < ActiveRecord::Base
+  audited allow_mass_assignment: true
+end
+```
+
+Second, be sure to add `audit_ids` to the list of protected attributes to prevent data loss.
+
+```ruby
+class User < ActiveRecord::Base
+  audited allow_mass_assignment: true
+  attr_protected :logins, :audit_ids
+end
+```
+
+## Support
+
+You can find documentation at: http://rdoc.info/github/collectiveidea/audited
+
+Or join the [mailing list](http://groups.google.com/group/audited) to get help or offer suggestions.
+
+## Contributing
+
+In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project. Here are a few ways _you_ can pitch in:
+
+* Use prerelease versions of Audited.
+* [Report bugs](https://github.com/collectiveidea/audited/issues).
+* Fix bugs and submit [pull requests](http://github.com/collectiveidea/audited/pulls).
+* Write, clarify or fix documentation.
+* Refactor code.