Sha256: ca5716252ccf8b3866a398a642baf6c87a249939f51b4baa13010bd4e60ec1c7

Contents?: true

Size: 1.75 KB

Versions: 1

Compression:

Stored size: 1.75 KB

Contents

# Fingerprints

[![Gem Version](https://badge.fury.io/rb/fingerprints.png)](http://badge.fury.io/rb/fingerprints)

Make it easy to track who created/updated your models.

## Installation

Add this line to your application's Gemfile:

    gem 'fingerprints'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install fingerprints

## Usage


Example
=======

    # Widget Schema...
    create_table :widgets do |t|
      t.string :name
      t.fingerprints # creates integer fields for created_by and updated_by
    end

    # User model...
    class User < ActiveRecord::Base
      has_fingerprints
    end

    # Widget model...
    class Widget < ActiveRecord::Base
      leaves_fingerprints

      # If your 'user' is really a Person you could do this:
      #
      # leaves_fingerprints :class_name => 'Person'
    end

Now, some how, some way you need to set User.fingerprint to either the User instance
or User 'id' of the "currently logged in user".  One way to do this would be to put
this in your controller assuming your controller has a `:current_user` method that will
return the current user.

    before_filter { |c| User.fingerprint = c.send(:current_user) }

At this point if you create/update a Widget it will set the `created_by/updated_by` attributes
automatically.  You can also do this:

    @widget.creator => User instance...
    @widget.updator => User instance...

The default `:class_name` is 'User' and can be overridden like this:

    ActiveRecord::HasFingerprints::OPTIONS.merge!(:class_name => 'Person')

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
fingerprints-0.0.1 README.md