Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 62 lines (38 sloc) 2.512 kb
926e3ed @reidab Update Travis build badge URL
reidab authored
1 [![Build Status](https://secure.travis-ci.org/fusion94/paper_trail_manager.png)](http://travis-ci.org/fusion94/paper_trail_manager)
839e592 @igal Add "travis-ci" support.
igal authored
2
708d86b @igal Add README documentation and LICENSE information.
igal authored
3 PaperTrailManager
4 ================
664109d @igal Add files created by: enginex paper_trail_manager -t rspec
igal authored
5
708d86b @igal Add README documentation and LICENSE information.
igal authored
6 Browse, subscribe, view and revert changes to records when using Ruby on Rails 3 and the `paper_trail` gem.
7
d83491b @igal README: Replace warning with current status. Bundle the rubygems release...
igal authored
8 This software has been in use for a year at http://calagator.org and http://epdx.org. It works well. It has reasonable tests. However, it could definitely use more work.
708d86b @igal Add README documentation and LICENSE information.
igal authored
9
10 Installation
11 ------------
12
13 If you have a Ruby on Rails 3 application where you're using the `paper_trail` gem to track changes to your records, you can make use of this like:
14
15 Add the following line to your `Gemfile`:
d83491b @igal README: Replace warning with current status. Bundle the rubygems release...
igal authored
16 gem 'paper_trail_manager'
708d86b @igal Add README documentation and LICENSE information.
igal authored
17
18 Install the libary:
19
20 bundle install
21
22 Add the following line to your `config/routes.rb`:
23
24 resources :changes, :controller => 'paper_trail_manager/changes'
25
26 Restart the server and go to the `/changes` URI to browse, subscribe, view and revert your changes. The top-level URL will look something like this:
27
28 http://localhost:3000/changes
29
8aeb3e7 @igal README: Describe how to develop and test the engine.
igal authored
30 Development
31 -----------
32
33 Setup:
34
35 * Clone the repository
36 * Go into the directory
37 * Run `bundle` to install the development dependencies
38
39 Running tests:
40
41 * Run `rake` to run the tests. Note that the first time tests are run, gems will need to be downloaded for each individual version of Rails this app is tested against, which may take a while.
42
43 Adding support for new Rails versions:
44
45 * Run `./rails_test/generate_test_directory VERSION` where `VERSION` is the Rails version you want to add support for, e.g.: `./rails_test/generate_test_directory 3.2.8`
46 * Run `rake test:rails-VERSION`, e.g. `rake test:rails-3.2.8` to install dependencies and run the tests.
47 * Rerun the previous command to run tests for that specific version.
48 * Edit the files in `rails_test/common` which will be copied into the individual Rails apps, e.g. the tests run against individual Rails versions are stored in `rails_test/common/spec`.
49 * Edit the `./rails_test/generate_test_directory` file to modify files, e.g. setup routes.
50 * Fix whatever breaks.
51 * Please contribute your fixes with a Github pull request.
52
708d86b @igal Add README documentation and LICENSE information.
igal authored
53 License
54 -------
55
56 This program is provided under an MIT open source license, read the [LICENSE.txt](http://github.com/igal/paper_trail_manager/blob/master/LICENSE.txt) file for details.
0ecbe41 @fusion94 Update README.md
authored
57
58 To Note:
59 --------
60
61 This project was originally devloped by [Igal Koshevoy](http://github.com/igal). Unfortunately @igal passed away on April 9th, 2013 and I took over the project afterwords.
Something went wrong with that request. Please try again.