paper_trail_manager 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a4751f2d97b26b30c6e032a6abddab435f52ab5
-  data.tar.gz: 304d9a344cbaa635c24ceb5be8ccc84243eff3ea
+  metadata.gz: 237613f3cbd029dce20a9cf59e754551550f712d
+  data.tar.gz: 60b579fcda4d97494c48513714c5290f4f24d1bc
 SHA512:
-  metadata.gz: 728dbc39ed5c46ebfb8203e7da6169f9b071ebe4106dddb280030f8a87acb37c881c68089dac42c5fde82bcc32b89710c6251c9d58b09b294a1279c8b3179955
-  data.tar.gz: c3d7a279aaba421c3a9c883770c59098ae957caab3a98c1711afeca1e0ccba3460eedcb561524b266c0a2124a98c553f79d31a8777bedfaf83736d53476a61c3
+  metadata.gz: da1ad13d7385129624206e5ba3d2083d79ea092523b308ccf26df020add6c3e3f4961b89705433bd9ead44716f940d1786f8ec63352f4e6a389f51c9b215bb48
+  data.tar.gz: 6997cda79358bf04d28edc830fade6f9829da2d99f24896e09581e3cf50687b28c698636df63bf312dc627eeff8af7779e1baf8acc4d9f0b39ac05369fc814d5

data/CHANGES.md

@@ -1,6 +1,9 @@
 Changes to `paper_trail_manager`
 ================================
 
+* 0.4.0
+    * Allow configuration of ChangesController's parent class, route helpers, and layout
+
 * 0.3.0
     * Support Rails 3.2, 4.0, 4.1, and 4.2
     * Drop support for Rails 3.0 and 3.1

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in paper_trail_manager.gemspec
 gemspec
+
+gem "byebug"

data/README.md

@@ -1,16 +1,14 @@
 [![Build Status](https://secure.travis-ci.org/fusion94/paper_trail_manager.png)](http://travis-ci.org/fusion94/paper_trail_manager)
 
-PaperTrailManager
-================
+# PaperTrailManager
 
 Browse, subscribe, view and revert changes to records when using Ruby on Rails 3 and the `paper_trail` gem.
 
 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.
 
-Installation
-------------
+## Installation
 
-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:
+If you have a Ruby on Rails 3 or 4 application where you're using the `paper_trail` gem to track changes to your records, you can make use of this like:
 
 Add the following line to your `Gemfile`:
     gem 'paper_trail_manager'
@@ -27,8 +25,35 @@ Restart the server and go to the `/changes` URI to browse, subscribe, view and r
 
     http://localhost:3000/changes
 
-Development
------------
+### Configuration
+
+Several aspects of PaperTrailManager may be optionally configured
+by creating an initializer in your application 
+(e.g. `config/initializers/paper_trail_manager.rb`).
+
+To specify when reverts are allowed:
+
+    PaperTrailManager.allow_revert_when do |controller, version|
+      controller.current_user and controller.current_user.admin?
+    end
+
+To specify how to look up users/memebers/etc specified in Paper Trail's 'whodunnit' column:
+
+    PaperTrailManager.whodunnit_class = User
+    PaperTrailManager.whodunnit_name_method = :nicename   # defaults to :name
+
+When including PaperTrailManager within another Rails engine, you may need to
+override PaperTrailManager::ChangesController's parent class to reference the
+engine's ApplicationController configure it to use your engine's url helpers:
+
+    PaperTrailManager.base_controller = "MyEngine::ApplicationController"
+    PaperTrailManager.route_helpers = MyEngine::Engine.routes.url_helpers
+
+You can also specify the layout:
+
+    PaperTrailManager.layout = 'my_engine/application'
+
+## Development
 
 Setup:
 
@@ -50,12 +75,10 @@ Adding support for new Rails versions:
 * Fix whatever breaks.
 * Please contribute your fixes with a Github pull request.
 
-License
--------
+## License
 
 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.
 
-To Note:
---------
+## To Note:
 
 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.

data/app/controllers/paper_trail_manager/changes_controller.rb

@@ -1,7 +1,14 @@
-class PaperTrailManager::ChangesController < ApplicationController
+# Allow the parent class of ChangesController to be configured in the host app
+PaperTrailManager::ChangesController = Class.new(PaperTrailManager.base_controller.constantize)
+
+class PaperTrailManager::ChangesController
   # Default number of changes to list on a pagenated index page.
   PER_PAGE = 50
 
+  helper PaperTrailManager.route_helpers if PaperTrailManager.route_helpers
+  helper PaperTrailManager::ChangesHelper
+  layout PaperTrailManager.layout if PaperTrailManager.layout
+
   # List changes
   def index
     unless change_index_allowed?

data/lib/paper_trail_manager.rb

@@ -2,25 +2,11 @@ require 'rails'
 require 'paper_trail'
 require 'will_paginate'
 
-# = PaperTrailManager
-#
-# == Example usage
-#
-# To specify when reverts are allowed, write an initializer similar to this:
-#
-#   # config/initializers/paper_trail_manager.rb
-#   PaperTrailManager.allow_revert_when do |controller, version|
-#     controller.current_user and controller.current_user.admin?
-#   end
-#
-#   To specify how to look up users/memebers/etc specified in Paper Trail's 'whodunnit' column:
-#
-#   PaperTrailManager.whodunnit_class = User
-#   PaperTrailManager.whodunnit_name_method = :nicename   # defaults to :name
-#
 class PaperTrailManager < Rails::Engine
   @@whodunnit_name_method = :name
-  cattr_accessor :whodunnit_class, :whodunnit_name_method
+  cattr_accessor :whodunnit_class, :whodunnit_name_method, :route_helpers, :layout, :base_controller
+
+  self.base_controller = "ApplicationController"
 
   (Pathname(__FILE__).dirname + '..').tap do |base|
     paths["app/controller"] = base + 'app/controllers'

data/paper_trail_manager.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "paper_trail_manager"
-  spec.version       = "0.3.0"
+  spec.version       = "0.4.0"
   spec.authors       = ["Igal Koshevoy", "Reid Beels"]
   spec.authors       = ["mail@reidbeels.com"]
   spec.summary       = "A user interface for `paper_trail` versioning data in Ruby on Rails 3 applications."
@@ -28,6 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec-activemodel-mocks", "~> 1.0"
   spec.add_development_dependency "rspec-its", "~> 1.0"
   spec.add_development_dependency "appraisal", "~> 1.0"
-  spec.add_development_dependency "byebug"
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paper_trail_manager
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - mail@reidbeels.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-22 00:00:00.000000000 Z
+date: 2015-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -156,20 +156,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Browse, subscribe, view and revert changes to records when using Ruby
   on Rails 3 and the `paper_trail` gem.
 email: 
@@ -408,3 +394,4 @@ test_files:
 - spec/views/platforms/index.html.erb_spec.rb
 - spec/views/platforms/new.html.erb_spec.rb
 - spec/views/platforms/show.html.erb_spec.rb
+has_rdoc: