Skip to content

sebkkom/LogBook

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LogBook

Storing an events log book.

Installation

Add this line to your application's Gemfile:

gem "log_book"

As the Model should be loaded after ActiveReccord has established the connection you have to add this:

# config/application.rb
config.after_initialize do
  require "log_book/event"
end

Create the table

rails generate log_book:migration
rake db:migrate

ActsOnTaggableOn dependency

rails generate acts_as_taggable_on:migration
rake db:migrate

Usage

In any point:

LogBook.event(<who executes the action>, <over which object>, <text>, <list of tags>)

For example:

LogBook.event(current_user, item, "Item canceled", [:purchase, :canceled])

ActiveRecord integration

class MyModel < ActiveRecord::Base
  log_book
end

MyModel.create!   # => LogBook created
my_model.save!    # => LogBook created
my_model.destroy! # => LogBook created

If you want to include who executes the action use the special attribute log_book_historian:

my_model.log_book_historian = current_user
my_model.save!

TODO

Sate of the art

Beta version but already used in production environments

About

Storing an events log book

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Ruby 100.0%