paper_trail_manager 0.1.0

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+
+gem "rails", "~> 3.0"
+gem "haml", "~> 3.0"
+gem "paper_trail", "~> 2.0"
+gem "will_paginate", "~> 3.0.pre2"
+
+group *[:development, :test] do
+  gem "capybara", ">= 0.4.0"
+  gem "factory_girl_rails", "~> 1.1.beta1"
+  gem "jeweler", "~> 1.5.2"
+  gem "rdoc"
+  gem "rspec-rails", "~> 2.5.0"
+  gem "ruby-debug"
+  gem "spork", "~> 0.9.0.rc"
+  gem "sqlite3-ruby", :require => "sqlite3"
+end

data/Gemfile.lock

@@ -0,0 +1,147 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.9)
+      actionpack (= 3.0.9)
+      mail (~> 2.2.19)
+    actionpack (3.0.9)
+      activemodel (= 3.0.9)
+      activesupport (= 3.0.9)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.5.0)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.14)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.9)
+      activesupport (= 3.0.9)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.9)
+      activemodel (= 3.0.9)
+      activesupport (= 3.0.9)
+      arel (~> 2.0.10)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.9)
+      activemodel (= 3.0.9)
+      activesupport (= 3.0.9)
+    activesupport (3.0.9)
+    arel (2.0.10)
+    builder (2.1.2)
+    capybara (0.4.1.2)
+      celerity (>= 0.7.9)
+      culerity (>= 0.2.4)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (>= 0.0.27)
+      xpath (~> 0.1.3)
+    celerity (0.8.8)
+    childprocess (0.1.8)
+      ffi (~> 1.0.6)
+    columnize (0.3.2)
+    culerity (0.2.15)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    factory_girl (2.0.0.beta2)
+    factory_girl_rails (1.1.beta1)
+      factory_girl (~> 2.0.0.beta)
+      rails (>= 3.0.0)
+    ffi (1.0.7)
+      rake (>= 0.8.7)
+    git (1.2.5)
+    haml (3.1.2)
+    i18n (0.5.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    json_pure (1.5.1)
+    linecache (0.43)
+    mail (2.2.19)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    nokogiri (1.4.4)
+    paper_trail (2.0.2)
+      rails (~> 3)
+    polyglot (0.3.1)
+    rack (1.2.2)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.9)
+      actionmailer (= 3.0.9)
+      actionpack (= 3.0.9)
+      activerecord (= 3.0.9)
+      activeresource (= 3.0.9)
+      activesupport (= 3.0.9)
+      bundler (~> 1.0)
+      railties (= 3.0.9)
+    railties (3.0.9)
+      actionpack (= 3.0.9)
+      activesupport (= 3.0.9)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.4)
+    rake (0.9.2)
+    rdoc (3.7)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    rspec-rails (2.5.0)
+      actionpack (~> 3.0)
+      activesupport (~> 3.0)
+      railties (~> 3.0)
+      rspec (~> 2.5.0)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+    rubyzip (0.9.4)
+    selenium-webdriver (0.1.4)
+      childprocess (>= 0.1.7)
+      ffi (>= 1.0.7)
+      json_pure
+      rubyzip
+    spork (0.9.0.rc4)
+    sqlite3 (1.3.3)
+    sqlite3-ruby (1.3.3)
+      sqlite3 (>= 1.3.3)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.29)
+    will_paginate (3.0.pre2)
+    xpath (0.1.3)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capybara (>= 0.4.0)
+  factory_girl_rails (~> 1.1.beta1)
+  haml (~> 3.0)
+  jeweler (~> 1.5.2)
+  paper_trail (~> 2.0)
+  rails (~> 3.0)
+  rdoc
+  rspec-rails (~> 2.5.0)
+  ruby-debug
+  spork (~> 0.9.0.rc)
+  sqlite3-ruby
+  will_paginate (~> 3.0.pre2)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright 2011 Igal Koshevoy
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,32 @@
+PaperTrailManager
+================
+
+Browse, subscribe, view and revert changes to records when using Ruby on Rails 3 and the `paper_trail` gem.
+
+**WARNING**: This is alpha-quality software. There are tests, it's useful, but it could use more work.
+
+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:
+
+Add the following line to your `Gemfile`:
+
+    gem 'paper_trail_manager', :git => 'https://github.com/igal/paper_trail_manager.git'
+
+Install the libary:
+
+    bundle install
+
+Add the following line to your `config/routes.rb`:
+
+    resources :changes, :controller => 'paper_trail_manager/changes'
+
+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:
+
+    http://localhost:3000/changes
+
+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.

data/Rakefile

@@ -0,0 +1,52 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+require 'rdoc/task'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PaperTrailManager'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require "jeweler"
+Jeweler::Tasks.new do |gem|
+  gem.name = "paper_trail_manager"
+  gem.summary = gem.description = "A user interface for `paper_trail` versioning data in Ruby on Rails 3 applications."
+  gem.files = Dir["{app,lib,spec}/**/*"] + ["LICENSE.txt", "Rakefile", "README.md", "VERSION", "paper_trail_manager.gemspec", "Gemfile", "Gemfile.lock"] - Dir["spec/dummy/{log,tmp}/**/*"] - Dir["spec/dummy/db/*.sqlite3"]
+
+  gem.authors = ["Igal Koshevoy"]
+  gem.email = "igal@pragmaticraft.com"
+  gem.homepage = "http://github.com/igal/paper_trail_manager"
+end
+
+namespace :spork do
+  task :spec do
+    exec "rspec --drb spec"
+  end
+
+  task :serve do
+    exec "spork"
+  end
+end
+
+desc "Freshen files like Gemfile.lock and .gemspec"
+task :freshen do
+  sh "bundle check || bundle --local || bundle update --local || bundle update"
+  Rake::Task['gemspec'].invoke
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/app/controllers/paper_trail_manager/changes_controller.rb

@@ -0,0 +1,109 @@
+class PaperTrailManager::ChangesController < ApplicationController
+  # List changes
+  def index
+    unless change_index_allowed?
+      flash[:error] = "You do not have permission to list changes."
+      return(redirect_to root_url)
+    end
+
+    @versions = Version.order('created_at DESC, id DESC')
+    if params[:type]
+      @versions = @versions.where(:item_type => params[:type])
+    end
+    if params[:id]
+      @versions = @versions.where(:item_id => params[:id])
+    end
+
+    @versions = @versions.paginate(:page => params[:page], :per_page => 50)
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.atom # index.atom.builder
+      format.json { render :json => @versions }
+    end
+  end
+
+  # Show a change
+  def show
+    begin
+      @version = Version.find(params[:id])
+    rescue ActiveRecord::RecordNotFound
+      flash[:error] = "No such version."
+      return(redirect_to :action => :index)
+    end
+
+    unless change_show_allowed?(@version)
+      flash[:error] = "You do not have permission to show that change."
+      return(redirect_to :action => :index)
+    end
+
+    respond_to do |format|
+      format.html # show.html.erb
+      format.json { render :json => @version }
+    end
+  end
+
+  # Rollback a change
+  def update
+    begin
+      @version = Version.find(params[:id])
+    rescue ActiveRecord::RecordNotFound
+      flash[:error] = "No such version."
+      return(redirect_to(:action => :index))
+    end
+
+    unless change_revert_allowed?(@version)
+      flash[:error] = "You do not have permission to revert this change."
+      return(redirect_to :action => :index)
+    end
+
+    if @version.event == "create"
+      @record = @version.item_type.constantize.find(@version.item_id)
+      @result = @record.destroy
+    else
+      @record = @version.reify
+      @result = @record.save
+    end
+
+    if @result
+      if @version.event == "create"
+        flash[:notice] = "Rolled back newly-created record by destroying it."
+        redirect_to :action => :index
+      else
+        flash[:notice] = "Rolled back changes to this record."
+        redirect_to change_item_url(@version)
+      end
+    else
+      flash[:error] = "Couldn't rollback. Sorry."
+      redirect_to :action => :index
+    end
+  end
+
+protected
+
+  # Return the URL for the item represented by the +version+, e.g. a Company record instance referenced by a version.
+  def change_item_url(version)
+    return send("#{version.item_type.downcase}_url", version.item_id)
+  rescue NoMethodError
+    return nil
+  end
+  helper_method :change_item_url
+
+  # Allow index?
+  def change_index_allowed?
+    return PaperTrailManager.allow_index?(self)
+  end
+  helper_method :change_index_allowed?
+
+  # Allow show?
+  def change_show_allowed?(version)
+    return PaperTrailManager.allow_show?(self, version)
+  end
+  helper_method :change_show_allowed?
+
+  # Allow revert?
+  def change_revert_allowed?(version)
+    return PaperTrailManager.allow_revert?(self, version)
+  end
+  helper_method :change_revert_allowed?
+end

data/app/helpers/paper_trail_manager/changes_helper.rb

@@ -0,0 +1,99 @@
+class PaperTrailManager
+  module ChangesHelper
+    # Return HTML representing the +object+, which is either its text or a stylized "nil".
+    def text_or_nil(object)
+      if object.nil?
+        return content_tag("em", "nil")
+      else
+        return h(object)
+      end
+    end
+
+    # Return an hash of changes for the given +Version+ record. The resulting
+    # data structure is a hash whose keys are the names of changed columns and
+    # values containing a hash with current and previous value. E.g.,:
+    #
+    #   {
+    #     "my_column_name" => {
+    #       :previous => "past value",
+    #       :current  => "current_value",
+    #     },
+    #     "title" => {
+    #       :previous => "puppies",
+    #       :current  => "kittens",
+    #     },
+    #     ...
+    #   }
+    def changes_for(version)
+      changes = {}
+      current = version.next.try(:reify)
+      # FIXME #reify randomly throws "ArgumentError Exception: syntax error on line 13, col 30:" -- why?
+      previous = version.reify rescue nil
+      record = \
+        begin
+          version.item_type.constantize.find(version.item_id)
+        rescue ActiveRecord::RecordNotFound
+          previous || current
+        end
+
+      # Bail out if no changes are available
+      return changes unless record
+
+      case version.event
+      when "create", "update"
+        current ||= record
+      when "destroy"
+        previous ||= record
+      else
+        raise ArgumentError, "Unknown event: #{version.event}"
+      end
+
+      (current or previous).attribute_names.each do |name|
+        next if name == "updated_at"
+        next if name == "created_at"
+        current_value = current.read_attribute(name) if current
+        previous_value = previous.read_attribute(name) if previous
+        unless current_value == previous_value || (version.event == "create" && current_value.blank?)
+          changes[name] = {
+            :previous => previous_value,
+            :current => current_value,
+          }
+        end
+      end
+
+      return changes
+    end
+
+    # Returns string title for the versioned record.
+    def change_title_for(version)
+      current = version.next.try(:reify)
+      previous = version.reify rescue nil
+      record = version.item_type.constantize.find(version.item_id) rescue nil
+
+      name = nil
+      [:name, :title, :to_s].each do |name_method|
+        [previous, current, record].each do |obj|
+          name = obj.send(name_method) if obj.respond_to?(name_method)
+          break if name
+        end
+        break if name
+      end
+
+      return h(name)
+    end
+
+    # Returns sorted array of types of items that there are changes for.
+    def change_item_types
+      return ActiveRecord::Base.connection.select_values('SELECT DISTINCT(item_type) FROM versions ORDER BY item_type')
+    end
+
+    # Returns HTML link for the item stored in the version, e.g. a link to a Company record stored in the version.
+    def change_item_link(version)
+      if url = change_item_url(version)
+        return link_to(change_title_for(version), url, :class => 'change_item')
+      else
+        return content_tag(:span, change_title_for(version), :class => 'change_item')
+      end
+    end
+  end
+end