paper_trail_manager 0.1.0

data/app/views/paper_trail_manager/changes/_version.html.haml

@@ -0,0 +1,32 @@
+%tr.change_row{:class => [version.event, version.item_type.downcase]}
+  %td.change_time
+    %span.change_id== Change ##{version.id}
+    .date
+      = version.created_at.strftime('%Y-%m-%d')
+    .time
+      = version.created_at.strftime('%H:%M:%S')
+  %td.change_details
+    %p.change_details_description
+      %strong.event= version.event
+      %span.item_type= version.item_type
+      %span.item_id== ##{version.item_id}
+      = change_item_link(version)
+      - if PaperTrailManager.whodunnit_class
+        - if version.whodunnit
+          - if user = PaperTrailManager.whodunnit_class.find(version.whodunnit) rescue nil
+            by
+            = link_to(h(user.send(PaperTrailManager.whodunnit_name_method)), user_path(user))
+      - if change_revert_allowed?(version)
+        = link_to 'Roll back', change_path(version), :method => 'put', :confirm => 'Are you sure?', :class => 'rollback'
+
+
+    - if version.event == 'update' or version.event == 'create'
+      - changes = changes_for(version)
+      %table.change_details_table
+        - changes.keys.sort.each do |key|
+          %tr{:class => cycle('odd', 'even')}
+            %td.change_detail_key.previous= key
+            %td.change_detail_value.previous= text_or_nil(changes[key][:previous])
+            %td.change_detail_spacer →
+            %td.change_detail_value.current= text_or_nil(changes[key][:current])
+        - reset_cycle('change_detail')

data/app/views/paper_trail_manager/changes/index.atom.builder

@@ -0,0 +1,44 @@
+atom_feed do |feed|
+  feed.title("Changes")
+  date = @versions.first.try(:created_at) || Time.at(0)
+  feed.updated(date)
+
+  @versions.each do |version|
+    next unless change_show_allowed?(version)
+
+    feed.entry(version, :url => change_url(version)) do |entry|
+      changes = changes_for(version)
+
+      if PaperTrailManager.whodunnit_class && version.whodunnit
+        user = PaperTrailManager.whodunnit_class.find(version.whodunnit) rescue nil
+      else
+        user = nil
+      end
+
+      entry.title "#{version.event.upcase} #{version.item_type} «#{change_title_for(version)}» #{user ? 'by '+user.send(PaperTrailManager.whodunnit_name_method) : ''}"
+      entry.updated version.created_at.utc.xmlschema
+
+      xm = ::Builder::XmlMarkup.new
+      xm.div {
+        xm.p {
+          xm.span << 'Go to: '
+          xm.span << link_to('Change', change_url(version))
+          xm.span << ' | '
+          xm.span << link_to('Record', change_item_url(version))
+        }
+        xm.table {
+          changes.keys.sort.each do |key|
+            xm.tr {
+              xm.td { xm.b key }
+              xm.td changes[key][:previous].inspect
+              xm.td { xm.span << "&rarr;" }
+              xm.td changes[key][:current].inspect
+            }
+          end
+        }
+      }
+
+      entry.content(xm.to_s, :type => 'html')
+    end
+  end
+end

data/app/views/paper_trail_manager/changes/index.html.haml

@@ -0,0 +1,26 @@
+%h1 Changes
+
+%p.changes_feed
+  = link_to 'Changes feed', changes_path(:format => 'atom')
+
+%p
+  Show:
+  != ([link_to('All', changes_path)] + change_item_types.map { |type| link_to(type.pluralize, changes_path(:type => type)) }).join(' | ')
+
+%table.changes_table
+  %tfoot
+    %tr
+      %td{:colspan => 2}
+        = will_paginate @versions
+  %thead
+    %tr.changes_header
+      %th.change_time Time
+      %th.change_details Attribute with previous and current values
+  %tbody
+    - if @versions.any?
+      - @versions.each do |version|
+        - next unless change_show_allowed?(version)
+        = render :partial => 'version', :object => version
+    - else
+      %td{:rowspan => 2}
+        — No changes found —

data/app/views/paper_trail_manager/changes/show.html.haml

@@ -0,0 +1,8 @@
+%h1 
+  == Change ##{@version.id}
+
+%table.changes_table
+  %tr.changes_header
+    %th.change_time Time
+    %th.change_details Attribute with previous and current values
+    = render :partial => 'version', :object => @version

data/lib/paper_trail_manager.rb

@@ -0,0 +1,70 @@
+require 'rails'
+require 'paper_trail'
+
+# = 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
+
+  (Pathname(__FILE__).dirname + '..').tap do |base|
+    paths.app.controllers = base + 'app/controllers'
+    paths.app.views = base + 'app/views'
+  end
+
+  def self._allow_set(action, block)
+    send(:class_variable_set, "@@allow_#{action}_block", block)
+  end
+
+  def self._allow_check(action, *args)
+    begin
+      block = send(:class_variable_get, "@@allow_#{action}_block")
+    rescue NameError => e
+      return true
+    end
+
+    return block.call(*args)
+  end
+
+  def self.allow_index_when(&block)
+    _allow_set(:index, block)
+  end
+
+  def self.allow_index?(controller)
+    _allow_check(:index, controller)
+  end
+
+  def self.allow_show_when(&block)
+    _allow_set(:show, block)
+  end
+
+  def self.allow_show?(controller, version)
+    _allow_check(:index, controller, version)
+  end
+
+  # Describe when to allow reverts. Call this with a block that accepts
+  # arguments for +controller+ and +version+.
+  def self.allow_revert_when(&block)
+    _allow_set(:revert, block)
+  end
+
+  # Allow revert given the +controller+ and +version+? If no
+  # ::allow_revert_when was specified, always return +true+.
+  def self.allow_revert?(controller, version)
+    _allow_check(:revert, controller, version)
+  end
+end

data/paper_trail_manager.gemspec

@@ -0,0 +1,209 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{paper_trail_manager}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Igal Koshevoy"]
+  s.date = %q{2011-07-13}
+  s.description = %q{A user interface for `paper_trail` versioning data in Ruby on Rails 3 applications.}
+  s.email = %q{igal@pragmaticraft.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "app/controllers/paper_trail_manager/changes_controller.rb",
+    "app/helpers/paper_trail_manager/changes_helper.rb",
+    "app/views/paper_trail_manager/changes/_version.html.haml",
+    "app/views/paper_trail_manager/changes/index.atom.builder",
+    "app/views/paper_trail_manager/changes/index.html.haml",
+    "app/views/paper_trail_manager/changes/show.html.haml",
+    "lib/paper_trail_manager.rb",
+    "paper_trail_manager.gemspec",
+    "spec/controllers/paper_trail_manager/changes_controller_spec.rb",
+    "spec/dummy/Rakefile",
+    "spec/dummy/app/controllers/application_controller.rb",
+    "spec/dummy/app/controllers/entities_controller.rb",
+    "spec/dummy/app/controllers/platforms_controller.rb",
+    "spec/dummy/app/helpers/application_helper.rb",
+    "spec/dummy/app/helpers/entities_helper.rb",
+    "spec/dummy/app/helpers/platforms_helper.rb",
+    "spec/dummy/app/models/entity.rb",
+    "spec/dummy/app/models/platform.rb",
+    "spec/dummy/app/views/entities/_form.html.erb",
+    "spec/dummy/app/views/entities/edit.html.erb",
+    "spec/dummy/app/views/entities/index.html.erb",
+    "spec/dummy/app/views/entities/new.html.erb",
+    "spec/dummy/app/views/entities/show.html.erb",
+    "spec/dummy/app/views/layouts/application.html.erb",
+    "spec/dummy/app/views/platforms/_form.html.erb",
+    "spec/dummy/app/views/platforms/edit.html.erb",
+    "spec/dummy/app/views/platforms/index.html.erb",
+    "spec/dummy/app/views/platforms/new.html.erb",
+    "spec/dummy/app/views/platforms/show.html.erb",
+    "spec/dummy/config.ru",
+    "spec/dummy/config/application.rb",
+    "spec/dummy/config/boot.rb",
+    "spec/dummy/config/database.yml",
+    "spec/dummy/config/environment.rb",
+    "spec/dummy/config/environments/development.rb",
+    "spec/dummy/config/environments/production.rb",
+    "spec/dummy/config/environments/test.rb",
+    "spec/dummy/config/initializers/backtrace_silencers.rb",
+    "spec/dummy/config/initializers/inflections.rb",
+    "spec/dummy/config/initializers/mime_types.rb",
+    "spec/dummy/config/initializers/secret_token.rb",
+    "spec/dummy/config/initializers/session_store.rb",
+    "spec/dummy/config/locales/en.yml",
+    "spec/dummy/config/routes.rb",
+    "spec/dummy/db/migrate/20110228091428_create_entities.rb",
+    "spec/dummy/db/migrate/20110228093241_create_platforms.rb",
+    "spec/dummy/db/migrate/20110228094444_create_versions.rb",
+    "spec/dummy/db/schema.rb",
+    "spec/dummy/public/404.html",
+    "spec/dummy/public/422.html",
+    "spec/dummy/public/500.html",
+    "spec/dummy/public/favicon.ico",
+    "spec/dummy/public/javascripts/application.js",
+    "spec/dummy/public/javascripts/controls.js",
+    "spec/dummy/public/javascripts/dragdrop.js",
+    "spec/dummy/public/javascripts/effects.js",
+    "spec/dummy/public/javascripts/prototype.js",
+    "spec/dummy/public/javascripts/rails.js",
+    "spec/dummy/script/rails",
+    "spec/dummy/spec/controllers/entities_controller_spec.rb",
+    "spec/dummy/spec/controllers/platforms_controller_spec.rb",
+    "spec/dummy/spec/helpers/entities_helper_spec.rb",
+    "spec/dummy/spec/helpers/platforms_helper_spec.rb",
+    "spec/dummy/spec/integration/navigation_spec.rb",
+    "spec/dummy/spec/integration/paper_trail_manager_spec.rb",
+    "spec/dummy/spec/models/entity_spec.rb",
+    "spec/dummy/spec/models/platform_spec.rb",
+    "spec/dummy/spec/requests/entities_spec.rb",
+    "spec/dummy/spec/requests/platforms_spec.rb",
+    "spec/dummy/spec/routing/entities_routing_spec.rb",
+    "spec/dummy/spec/routing/platforms_routing_spec.rb",
+    "spec/dummy/spec/views/entities/edit.html.erb_spec.rb",
+    "spec/dummy/spec/views/entities/index.html.erb_spec.rb",
+    "spec/dummy/spec/views/entities/new.html.erb_spec.rb",
+    "spec/dummy/spec/views/entities/show.html.erb_spec.rb",
+    "spec/dummy/spec/views/platforms/edit.html.erb_spec.rb",
+    "spec/dummy/spec/views/platforms/index.html.erb_spec.rb",
+    "spec/dummy/spec/views/platforms/new.html.erb_spec.rb",
+    "spec/dummy/spec/views/platforms/show.html.erb_spec.rb",
+    "spec/paper_trail_manager_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/factories.rb"
+  ]
+  s.homepage = %q{http://github.com/igal/paper_trail_manager}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{A user interface for `paper_trail` versioning data in Ruby on Rails 3 applications.}
+  s.test_files = [
+    "spec/controllers/paper_trail_manager/changes_controller_spec.rb",
+    "spec/dummy/app/controllers/application_controller.rb",
+    "spec/dummy/app/controllers/entities_controller.rb",
+    "spec/dummy/app/controllers/platforms_controller.rb",
+    "spec/dummy/app/helpers/application_helper.rb",
+    "spec/dummy/app/helpers/entities_helper.rb",
+    "spec/dummy/app/helpers/platforms_helper.rb",
+    "spec/dummy/app/models/entity.rb",
+    "spec/dummy/app/models/platform.rb",
+    "spec/dummy/config/application.rb",
+    "spec/dummy/config/boot.rb",
+    "spec/dummy/config/environment.rb",
+    "spec/dummy/config/environments/development.rb",
+    "spec/dummy/config/environments/production.rb",
+    "spec/dummy/config/environments/test.rb",
+    "spec/dummy/config/initializers/backtrace_silencers.rb",
+    "spec/dummy/config/initializers/inflections.rb",
+    "spec/dummy/config/initializers/mime_types.rb",
+    "spec/dummy/config/initializers/secret_token.rb",
+    "spec/dummy/config/initializers/session_store.rb",
+    "spec/dummy/config/routes.rb",
+    "spec/dummy/db/migrate/20110228091428_create_entities.rb",
+    "spec/dummy/db/migrate/20110228093241_create_platforms.rb",
+    "spec/dummy/db/migrate/20110228094444_create_versions.rb",
+    "spec/dummy/db/schema.rb",
+    "spec/dummy/spec/controllers/entities_controller_spec.rb",
+    "spec/dummy/spec/controllers/platforms_controller_spec.rb",
+    "spec/dummy/spec/helpers/entities_helper_spec.rb",
+    "spec/dummy/spec/helpers/platforms_helper_spec.rb",
+    "spec/dummy/spec/integration/navigation_spec.rb",
+    "spec/dummy/spec/integration/paper_trail_manager_spec.rb",
+    "spec/dummy/spec/models/entity_spec.rb",
+    "spec/dummy/spec/models/platform_spec.rb",
+    "spec/dummy/spec/requests/entities_spec.rb",
+    "spec/dummy/spec/requests/platforms_spec.rb",
+    "spec/dummy/spec/routing/entities_routing_spec.rb",
+    "spec/dummy/spec/routing/platforms_routing_spec.rb",
+    "spec/dummy/spec/views/entities/edit.html.erb_spec.rb",
+    "spec/dummy/spec/views/entities/index.html.erb_spec.rb",
+    "spec/dummy/spec/views/entities/new.html.erb_spec.rb",
+    "spec/dummy/spec/views/entities/show.html.erb_spec.rb",
+    "spec/dummy/spec/views/platforms/edit.html.erb_spec.rb",
+    "spec/dummy/spec/views/platforms/index.html.erb_spec.rb",
+    "spec/dummy/spec/views/platforms/new.html.erb_spec.rb",
+    "spec/dummy/spec/views/platforms/show.html.erb_spec.rb",
+    "spec/paper_trail_manager_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/factories.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rails>, ["~> 3.0"])
+      s.add_runtime_dependency(%q<haml>, ["~> 3.0"])
+      s.add_runtime_dependency(%q<paper_trail>, ["~> 2.0"])
+      s.add_runtime_dependency(%q<will_paginate>, ["~> 3.0.pre2"])
+      s.add_development_dependency(%q<capybara>, [">= 0.4.0"])
+      s.add_development_dependency(%q<factory_girl_rails>, ["~> 1.1.beta1"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<rspec-rails>, ["~> 2.5.0"])
+      s.add_development_dependency(%q<ruby-debug>, [">= 0"])
+      s.add_development_dependency(%q<spork>, ["~> 0.9.0.rc"])
+      s.add_development_dependency(%q<sqlite3-ruby>, [">= 0"])
+    else
+      s.add_dependency(%q<rails>, ["~> 3.0"])
+      s.add_dependency(%q<haml>, ["~> 3.0"])
+      s.add_dependency(%q<paper_trail>, ["~> 2.0"])
+      s.add_dependency(%q<will_paginate>, ["~> 3.0.pre2"])
+      s.add_dependency(%q<capybara>, [">= 0.4.0"])
+      s.add_dependency(%q<factory_girl_rails>, ["~> 1.1.beta1"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<rspec-rails>, ["~> 2.5.0"])
+      s.add_dependency(%q<ruby-debug>, [">= 0"])
+      s.add_dependency(%q<spork>, ["~> 0.9.0.rc"])
+      s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rails>, ["~> 3.0"])
+    s.add_dependency(%q<haml>, ["~> 3.0"])
+    s.add_dependency(%q<paper_trail>, ["~> 2.0"])
+    s.add_dependency(%q<will_paginate>, ["~> 3.0.pre2"])
+    s.add_dependency(%q<capybara>, [">= 0.4.0"])
+    s.add_dependency(%q<factory_girl_rails>, ["~> 1.1.beta1"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<rspec-rails>, ["~> 2.5.0"])
+    s.add_dependency(%q<ruby-debug>, [">= 0"])
+    s.add_dependency(%q<spork>, ["~> 0.9.0.rc"])
+    s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+  end
+end
+

data/spec/controllers/paper_trail_manager/changes_controller_spec.rb

@@ -0,0 +1,8 @@
+require  'spec_helper'
+
+describe PaperTrailManager::ChangesController do
+  it "should load" do
+    true.should be_true
+  end
+end
+

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+Dummy::Application.load_tasks

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,7 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+
+  def index
+    render :text => "Hello."
+  end
+end

data/spec/dummy/app/controllers/entities_controller.rb

@@ -0,0 +1,83 @@
+class EntitiesController < ApplicationController
+  # GET /entities
+  # GET /entities.xml
+  def index
+    @entities = Entity.all
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.xml  { render :xml => @entities }
+    end
+  end
+
+  # GET /entities/1
+  # GET /entities/1.xml
+  def show
+    @entity = Entity.find(params[:id])
+
+    respond_to do |format|
+      format.html # show.html.erb
+      format.xml  { render :xml => @entity }
+    end
+  end
+
+  # GET /entities/new
+  # GET /entities/new.xml
+  def new
+    @entity = Entity.new
+
+    respond_to do |format|
+      format.html # new.html.erb
+      format.xml  { render :xml => @entity }
+    end
+  end
+
+  # GET /entities/1/edit
+  def edit
+    @entity = Entity.find(params[:id])
+  end
+
+  # POST /entities
+  # POST /entities.xml
+  def create
+    @entity = Entity.new(params[:entity])
+
+    respond_to do |format|
+      if @entity.save
+        format.html { redirect_to(@entity, :notice => 'Entity was successfully created.') }
+        format.xml  { render :xml => @entity, :status => :created, :location => @entity }
+      else
+        format.html { render :action => "new" }
+        format.xml  { render :xml => @entity.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # PUT /entities/1
+  # PUT /entities/1.xml
+  def update
+    @entity = Entity.find(params[:id])
+
+    respond_to do |format|
+      if @entity.update_attributes(params[:entity])
+        format.html { redirect_to(@entity, :notice => 'Entity was successfully updated.') }
+        format.xml  { head :ok }
+      else
+        format.html { render :action => "edit" }
+        format.xml  { render :xml => @entity.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE /entities/1
+  # DELETE /entities/1.xml
+  def destroy
+    @entity = Entity.find(params[:id])
+    @entity.destroy
+
+    respond_to do |format|
+      format.html { redirect_to(entities_url) }
+      format.xml  { head :ok }
+    end
+  end
+end