paper_trail_manager 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 237613f3cbd029dce20a9cf59e754551550f712d
-  data.tar.gz: 60b579fcda4d97494c48513714c5290f4f24d1bc
+  metadata.gz: 2549171549b22c9328db417189798ea21871029c
+  data.tar.gz: 150cc4d55fbf5db0818687c333c6df8d463226af
 SHA512:
-  metadata.gz: da1ad13d7385129624206e5ba3d2083d79ea092523b308ccf26df020add6c3e3f4961b89705433bd9ead44716f940d1786f8ec63352f4e6a389f51c9b215bb48
-  data.tar.gz: 6997cda79358bf04d28edc830fade6f9829da2d99f24896e09581e3cf50687b28c698636df63bf312dc627eeff8af7779e1baf8acc4d9f0b39ac05369fc814d5
+  metadata.gz: fea549305c1d60b72b0ee0cb7638967f5618789b8ee4fe709c200706a118ed4e5d6a7a63dfb30228313008ac41e61cbbd083fd663f03610108b73b409c257775
+  data.tar.gz: 2b3e7b426fd66283adabdfee001ce2415eec56537fdbc8c249509fb3428c893f2b736db4a3ad5e10e1739c70094aba8e0678b9042026fa13f00cdb2dd863a5d8

data/.travis.yml

@@ -4,8 +4,12 @@ rvm:
   - 2.0
   - 2.1
 gemfile:
-  - gemfiles/rails_3.2.gemfile
-  - gemfiles/rails_4.0.gemfile
-  - gemfiles/rails_4.1.gemfile
-  - gemfiles/rails_4.2.gemfile
+  - gemfiles/rails_3.2_will_paginate.gemfile
+  - gemfiles/rails_4.0_will_paginate.gemfile
+  - gemfiles/rails_4.1_will_paginate.gemfile
+  - gemfiles/rails_4.2_will_paginate.gemfile
+  - gemfiles/rails_3.2_kaminari.gemfile
+  - gemfiles/rails_4.0_kaminari.gemfile
+  - gemfiles/rails_4.1_kaminari.gemfile
+  - gemfiles/rails_4.2_kaminari.gemfile
 cache: bundler

data/Appraisals

@@ -1,15 +1,39 @@
-appraise "rails-3.2" do
-  gem "rails", "3.2.21"
+appraise "rails-3.2-will-paginate" do
+  gem "rails", "~> 3.2.21"
+  gem "will_paginate", "~> 3.0"
 end
 
-appraise "rails-4.0" do
-  gem "rails", "4.0.9"
+appraise "rails-4.0-will-paginate" do
+  gem "rails", "~> 4.0.13"
+  gem "will_paginate", "~> 3.0"
 end
 
-appraise "rails-4.1" do
-  gem "rails", "4.1.9"
+appraise "rails-4.1-will-paginate" do
+  gem "rails", "~> 4.1.11"
+  gem "will_paginate", "~> 3.0"
 end
 
-appraise "rails-4.2" do
-  gem "rails", "4.2.0"
+appraise "rails-4.2-will-paginate" do
+  gem "rails", "~> 4.2.2"
+  gem "will_paginate", "~> 3.0"
+end
+
+appraise "rails-3.2-kaminari" do
+  gem "rails", "~> 3.2.21"
+  gem "kaminari", "~> 0.16"
+end
+
+appraise "rails-4.0-kaminari" do
+  gem "rails", "~> 4.0.13"
+  gem "kaminari", "~> 0.16"
+end
+
+appraise "rails-4.1-kaminari" do
+  gem "rails", "~> 4.1.11"
+  gem "kaminari", "~> 0.16"
+end
+
+appraise "rails-4.2-kaminari" do
+  gem "rails", "~> 4.2.2"
+  gem "kaminari", "~> 0.16"
 end

data/CHANGES.md

@@ -1,6 +1,11 @@
 Changes to `paper_trail_manager`
 ================================
 
+* 0.5.0
+    * Added support for pagination with [Kaminari](https://github.com/amatsuda/kaminari) in addition to [will_paginate](https://github.com/mislav/will_paginate).
+    * **[!]** Removed direct dependency on will_paginate. You must now include either `will_paginate` or `kaminari` in your Gemfile.
+    * Fixed a bug with route generation when paper_trail_manager is used within another Rails engine.
+
 * 0.4.0
     * Allow configuration of ChangesController's parent class, route helpers, and layout
 

data/Gemfile

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

data/README.md

@@ -11,8 +11,15 @@ This software has been in use for a year at http://calagator.org and http://epdx
 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'
 
+PaperTrailManager will use your existing paging library ([will_paginate](https://github.com/mislav/will_paginate) or [Kaminari](https://github.com/amatsuda/kaminari)).  If you don't currently use one in your app, add one of the following lines to your `Gemfile`:
+
+    gem 'kaminari'
+    #or
+    gem 'will_paginate'
+
 Install the libary:
 
     bundle install
@@ -63,15 +70,24 @@ Setup:
 
 Running tests:
 
-* 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.
+* Run `appraisal rake` to run the tests against all supported gem combinations. 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.
 
 Adding support for new Rails versions:
 
-* 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`
-* Run `rake test:rails-VERSION`, e.g. `rake test:rails-3.2.8` to install dependencies and run the tests.
-* Rerun the previous command to run tests for that specific version.
-* 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`.
-* Edit the `./rails_test/generate_test_directory` file to modify files, e.g. setup routes.
+* This repo uses the [Appraisal](https://github.com/thoughtbot/appraisal) gem, to add a new rails version modify the Appraisals file
+  - Add both a 'will_paginate' and a 'kaminari' version like so:
+  ```
+  appraise "rails-5.0-will-paginate" do
+    gem "rails", "5.0.0"
+    gem "will_paginate", "~> 3.0"
+  end
+  appraise "rails-5.0-will-kaminari" do
+    gem "rails", "5.0.0"
+    gem "kaminari", "~> 0.16"
+  end
+  ```
+* Run `appraisal generate`
+* Run `appraisal install`
 * Fix whatever breaks.
 * Please contribute your fixes with a Github pull request.
 

data/app/controllers/paper_trail_manager/changes_controller.rb

@@ -28,7 +28,11 @@ class PaperTrailManager::ChangesController
     @page = (v = params[:page].to_i; v == 0 ? nil : v)
     @per_page = (v = params[:per_page].to_i; v == 0 ? PER_PAGE : v)
 
-    @versions = @versions.paginate(:page => @page, :per_page => @per_page)
+    if defined?(WillPaginate)
+      @versions = @versions.paginate(:page => @page, :per_page => @per_page)
+    else
+      @versions = @versions.page(@page).per(@per_page)
+    end
 
     respond_to do |format|
       format.html # index.html.erb
@@ -63,12 +67,12 @@ class PaperTrailManager::ChangesController
       @version = PaperTrail::Version.find(params[:id])
     rescue ActiveRecord::RecordNotFound
       flash[:error] = "No such version."
-      return(redirect_to(:action => :index))
+      return(redirect_to(changes_path))
     end
 
     unless change_revert_allowed?(@version)
       flash[:error] = "You do not have permission to revert this change."
-      return(redirect_to :action => :index)
+      return(redirect_to changes_path)
     end
 
     if @version.event == "create"
@@ -82,14 +86,14 @@ class PaperTrailManager::ChangesController
     if @result
       if @version.event == "create"
         flash[:notice] = "Rolled back newly-created record by destroying it."
-        redirect_to :action => :index
+        redirect_to changes_path
       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
+      redirect_to changes_path
     end
   end
 
@@ -97,7 +101,8 @@ 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)
+    version_type = version.item_type.underscore.split('/').last
+    return send("#{version_type}_url", version.item_id)
   rescue NoMethodError
     return nil
   end

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

@@ -11,7 +11,7 @@
   <tfoot>
     <tr>
       <td colspan='2'>
-        <%= will_paginate @versions %>
+        <%= paginate @versions %>
       </td>
     </tr>
   </tfoot>

data/gemfiles/{rails_4.0.gemfile → rails_3.2_kaminari.gemfile}

@@ -2,6 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "rails", "4.0.9"
+gem "rails", "~> 3.2.21"
+gem "kaminari", "~> 0.16"
 
 gemspec :path => "../"

data/gemfiles/rails_3.2_will_paginate.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 3.2.21"
+gem "will_paginate", "~> 3.0"
+
+gemspec :path => "../"

data/gemfiles/{rails_4.1.gemfile → rails_4.0_kaminari.gemfile}

@@ -2,6 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "rails", "4.1.9"
+gem "rails", "~> 4.0.13"
+gem "kaminari", "~> 0.16"
 
 gemspec :path => "../"

data/gemfiles/rails_4.0_will_paginate.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.0.13"
+gem "will_paginate", "~> 3.0"
+
+gemspec :path => "../"

data/gemfiles/{rails_4.2.gemfile → rails_4.1_kaminari.gemfile}

@@ -2,6 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "rails", "4.2.0"
+gem "rails", "~> 4.1.11"
+gem "kaminari", "~> 0.16"
 
 gemspec :path => "../"

data/gemfiles/rails_4.1_will_paginate.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.1.11"
+gem "will_paginate", "~> 3.0"
+
+gemspec :path => "../"

data/gemfiles/{rails_3.2.gemfile → rails_4.2_kaminari.gemfile}

@@ -2,6 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "rails", "3.2.21"
+gem "rails", "~> 4.2.2"
+gem "kaminari", "~> 0.16"
 
 gemspec :path => "../"

data/gemfiles/rails_4.2_will_paginate.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.2.2"
+gem "will_paginate", "~> 3.0"
+
+gemspec :path => "../"

data/lib/paper_trail_manager.rb

@@ -1,8 +1,23 @@
 require 'rails'
 require 'paper_trail'
-require 'will_paginate'
+
+begin
+  require 'will_paginate'
+rescue LoadError
+  begin
+    require 'kaminari'
+  rescue LoadError
+    raise LoadError.new('will_paginate or kaminari must be in Gemfile or load_path')
+  end
+end
 
 class PaperTrailManager < Rails::Engine
+  initializer "paper_trail_manager.pagination" do
+    if defined?(WillPaginate)
+      ::ActionView::Base.send(:alias_method, :paginate, :will_paginate)
+    end
+  end
+
   @@whodunnit_name_method = :name
   cattr_accessor :whodunnit_class, :whodunnit_name_method, :route_helpers, :layout, :base_controller
 

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.4.0"
+  spec.version       = "0.5.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."
@@ -19,7 +19,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "rails", [">= 3.0", "< 5.0"]
   spec.add_dependency "paper_trail", "~> 3.0"
-  spec.add_dependency "will_paginate", "~> 3.0"
 
   spec.add_development_dependency "rake", "~> 10.4"
   spec.add_development_dependency "sqlite3", "~> 1.3"

data/spec/integration/paper_trail_manager_spec.rb

@@ -69,37 +69,6 @@ describe PaperTrailManager, :versioning => true do
               versions.map(&:id).should == versions.sort_by { |o| [o.created_at, o.id] }.reverse.map(&:id)
             end
           end
-
-          context "and getting paginated page" do
-            let(:page) { 2 }
-            let(:per_page) { 3 }
-
-            before { get changes_path(:page => page, :per_page => per_page) }
-
-            it "should set :page parameter" do
-              assigns[:page].should == page
-            end
-
-            it "should set :per_page parameter" do
-              assigns[:per_page].should == per_page
-            end
-
-            it "should retrieve only items for page" do
-              versions.size.should == per_page
-            end
-          end
-
-          context "and getting invalid pagination" do
-            before { get changes_path(:page => "Shanghai", :per_page => "Alice") }
-
-            it "should set default :page parameter" do
-              assigns[:page].should be_nil
-            end
-
-            it "should set default :per_page parameter" do
-              assigns[:per_page].should == PaperTrailManager::ChangesController::PER_PAGE
-            end
-          end
         end
 
         # TODO

data/spec/spec_helper.rb

@@ -1,6 +1,5 @@
 require "rails_helper"
 require "rspec/its"
-require "byebug"
 
 # This file was generated by the `rails generate rspec:install` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paper_trail_manager
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - mail@reidbeels.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-14 00:00:00.000000000 Z
+date: 2015-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -44,20 +44,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: will_paginate
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -177,10 +163,14 @@ files:
 - app/views/paper_trail_manager/changes/index.atom.builder
 - app/views/paper_trail_manager/changes/index.html.erb
 - app/views/paper_trail_manager/changes/show.html.erb
-- gemfiles/rails_3.2.gemfile
-- gemfiles/rails_4.0.gemfile
-- gemfiles/rails_4.1.gemfile
-- gemfiles/rails_4.2.gemfile
+- gemfiles/rails_3.2_kaminari.gemfile
+- gemfiles/rails_3.2_will_paginate.gemfile
+- gemfiles/rails_4.0_kaminari.gemfile
+- gemfiles/rails_4.0_will_paginate.gemfile
+- gemfiles/rails_4.1_kaminari.gemfile
+- gemfiles/rails_4.1_will_paginate.gemfile
+- gemfiles/rails_4.2_kaminari.gemfile
+- gemfiles/rails_4.2_will_paginate.gemfile
 - lib/paper_trail_manager.rb
 - paper_trail_manager.gemspec
 - spec/controllers/entities_controller_spec.rb