paper_trail_manager 0.5.0 → 0.7.0

data/lib/paper_trail_manager.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails'
 require 'paper_trail'
 
@@ -7,66 +9,59 @@ rescue LoadError
   begin
     require 'kaminari'
   rescue LoadError
-    raise LoadError.new('will_paginate or kaminari must be in Gemfile or load_path')
+    raise LoadError, '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
+  initializer 'paper_trail_manager.pagination' do
+    ::ActionView::Base.send(:alias_method, :paginate, :will_paginate) if defined?(WillPaginate)
   end
 
   @@whodunnit_name_method = :name
-  cattr_accessor :whodunnit_class, :whodunnit_name_method, :route_helpers, :layout, :base_controller
+  cattr_accessor :whodunnit_class, :whodunnit_name_method, :route_helpers,
+                 :layout, :base_controller, :user_path_method, :item_name_method
 
-  self.base_controller = "ApplicationController"
+  self.base_controller = 'ApplicationController'
+  self.user_path_method = :user_path
 
   (Pathname(__FILE__).dirname + '..').tap do |base|
-    paths["app/controller"] = base + 'app/controllers'
-    paths["app/view"] = base + 'app/views'
-  end
-
-  def self._allow_set(action, block)
-    send(:class_variable_set, "@@allow_#{action}_block", block)
+    paths['app/controller'] = base + 'app/controllers'
+    paths['app/view'] = base + 'app/views'
   end
 
-  def self._allow_check(action, *args)
-    begin
-      block = send(:class_variable_get, "@@allow_#{action}_block")
-    rescue NameError => e
-      return true
-    end
+  cattr_accessor :allow_index_block, :allow_show_block, :allow_revert_block
 
-    return block.call(*args)
-  end
+  block = proc { true }
+  self.allow_index_block = block
+  self.allow_show_block = block
+  self.allow_revert_block = block
 
   def self.allow_index_when(&block)
-    _allow_set(:index, block)
+    self.allow_index_block = block
   end
 
   def self.allow_index?(controller)
-    _allow_check(:index, controller)
+    allow_index_block.call controller
   end
 
   def self.allow_show_when(&block)
-    _allow_set(:show, block)
+    self.allow_show_block = block
   end
 
   def self.allow_show?(controller, version)
-    _allow_check(:index, controller, version)
+    allow_index_block.call 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)
+    self.allow_revert_block = 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)
+    allow_revert_block.call controller, version
   end
 end

data/paper_trail_manager.gemspec

@@ -1,31 +1,32 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
-  spec.name          = "paper_trail_manager"
-  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."
-  spec.description   = "Browse, subscribe, view and revert changes to records when using Ruby on Rails 3 and the `paper_trail` gem."
-  spec.homepage      = "https://github.com/fusion94/paper_trail_manager"
-  spec.license       = "MIT"
+  spec.name          = 'paper_trail_manager'
+  spec.version       = '0.7.0'
+  spec.authors       = ['Igal Koshevoy', 'Reid Beels']
+  spec.authors       = ['mail@reidbeels.com']
+  spec.summary       = 'A user interface for `paper_trail` versioning data in Rails applications.'
+  spec.description   = 'Browse, subscribe, view and revert changes to records when using Rails and the `paper_trail` gem.'
+  spec.homepage      = 'https://github.com/fusion94/paper_trail_manager'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "rails", [">= 3.0", "< 5.0"]
-  spec.add_dependency "paper_trail", "~> 3.0"
+  spec.add_dependency 'paper_trail', ['>= 3.0']
+  spec.add_dependency 'rails', ['>= 3.0', '< 7.0']
 
-  spec.add_development_dependency "rake", "~> 10.4"
-  spec.add_development_dependency "sqlite3", "~> 1.3"
-  spec.add_development_dependency "factory_girl_rails", "~> 4.0"
-  spec.add_development_dependency "rspec-rails", "~> 3.0"
-  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 'appraisal', '~> 1.0'
+  spec.add_development_dependency 'factory_girl_rails', '~> 4.0'
+  spec.add_development_dependency 'rake', '~> 10.4'
+  spec.add_development_dependency 'rspec-activemodel-mocks', '~> 1.0'
+  spec.add_development_dependency 'rspec-html-matchers', '~> 0.9.2'
+  spec.add_development_dependency 'rspec-its', '~> 1.0'
+  spec.add_development_dependency 'rspec-rails', '~> 3.0'
+  spec.add_development_dependency 'sqlite3', '>= 1.3.6'
 end
-

data/spec/app_template.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+gem 'paper_trail_manager', path: __FILE__ + '/../../../'
+
+unless File.exist?('app/assets/config/manifest.js')
+  create_file 'app/assets/config/manifest.js'
+  append_to_file 'app/assets/config/manifest.js', "//= link application.css\n"
+  append_to_file 'app/assets/config/manifest.js', "//= link application.js\n"
+end
+
+generate 'paper_trail:install'
+generate 'resource', 'entity name:string status:string --no-controller-specs --no-helper-specs'
+generate 'resource', 'platform name:string status:string --no-controller-specs --no-helper-specs'
+
+remove_file 'spec/models/entity_spec.rb'
+remove_file 'spec/models/platform_spec.rb'
+
+model_body = <<-MODEL
+  has_paper_trail
+
+  validates_presence_of :name
+  validates_presence_of :status
+MODEL
+
+inject_into_class 'app/models/entity.rb', 'Entity', model_body
+inject_into_class 'app/models/platform.rb', 'Platform', model_body
+
+route "resources :changes, :controller => 'paper_trail_manager/changes'"
+
+rake 'db:migrate db:test:prepare'

data/spec/integration/navigation_spec.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
-describe "Navigation" do
-  it "should be a valid app" do
+describe 'Navigation' do
+  it 'is a valid app' do
     ::Rails.application.should be_a_kind_of(Rails::Application)
   end
 end

data/spec/integration/paper_trail_manager_spec.rb

@@ -1,72 +1,55 @@
-require 'spec_helper'
-
-describe PaperTrailManager, :versioning => true do
-  def version
-    return assigns[:version]
-  end
-
-  def versions
-    return assigns[:versions]
-  end
-
-  def item_types
-    return versions.map(&:item_type).uniq.sort
-  end
-
-  def populate
-      @reimu = FactoryGirl.create(:entity, :name => "Miko Hakurei Reimu", :status => "Highly Responsive to Prayers")
-      @reimu.update_attributes(:name => "Hakurei Reimu", :status => "Phantasmagoria of Dimensional Dream")
-      @reimu.update_attributes(:status => "Perfect Cherry Blossom")
+# frozen_string_literal: true
 
-      @sakuya = FactoryGirl.create(:entity, :name => "Sakuya Izayoi", :status => "Flowering Night")
-
-      @flanchan = FactoryGirl.create(:entity, :name => "Flandre Scarlet", :status => "The Embodiment of Scarlet Devil")
-      @flanchan.destroy
-
-      @kyuu_hachi = FactoryGirl.create(:platform, :name => "PC-9801", :status => "SUGOI!!1!")
-      @kyuu_hachi.update_attributes(:status => "Kimochi warui.")
-      @kyuu_hachi.destroy
-
-      @uinodouzu = FactoryGirl.create(:platform, :name => "Mikorusofto Uinodouzu", :status => 'o-O')
-  end
+require 'spec_helper'
 
-  context "without changes" do
-    context "index" do
-      it "should have no changes by default" do
-        get "/changes"
+describe PaperTrailManager, versioning: true do
+  context 'without changes' do
+    context 'when fetching the index' do
+      it 'has no changes by default' do
+        get '/changes'
 
-        assigns[:versions].should be_empty
+        expect(response.body).to include('No changes found')
       end
     end
   end
 
-  context "with changes" do
-    before do
-      populate
-    end
+  context 'with changes' do
+    let(:reimu) { FactoryGirl.create(:entity, name: 'Miko Hakurei Reimu', status: 'Highly Responsive to Prayers') }
+    let(:flanchan) { FactoryGirl.create(:entity, name: 'Flandre Scarlet', status: 'The Embodiment of Scarlet Devil') }
+    let(:sakuya) { FactoryGirl.create(:entity, name: 'Sakuya Izayoi', status: 'Flowering Night') }
+    let(:kyuu_hachi) { FactoryGirl.create(:platform, name: 'PC-9801', status: 'SUGOI!!1!') }
+    let!(:uinodouzu) { FactoryGirl.create(:platform, name: 'Mikorusofto Uinodouzu', status: 'o-O') }
+
+    let!(:flanchan_id) { flanchan.id }
 
-    after do
-      Entity.destroy_all
-      Platform.destroy_all
-      PaperTrail::Version.destroy_all
+    before do
+      sakuya
+      reimu.update(name: 'Hakurei Reimu', status: 'Phantasmagoria of Dimensional Dream')
+      reimu.update(status: 'Perfect Cherry Blossom')
+      flanchan.destroy
+      kyuu_hachi.update(status: 'Kimochi warui.')
+      kyuu_hachi.destroy
+      uinodouzu
     end
 
-    context "index" do
-      context "when getting all changes" do
-        context "and authorized" do
-          context "and getting default index" do
+    describe 'index' do
+      context 'when getting all changes' do
+        context 'with authorization' do
+          context 'when getting default index' do
             before { get changes_path }
 
-            it "should have all changes" do
-              versions.size.should == 10
+            it 'has all changes' do
+              expect(response.body).to have_tag('.change_row', count: 10)
             end
 
-            it "should have changes for all changed item types" do
-              item_types.should == ["Entity", "Platform"]
+            it 'has changes for all changed item types' do
+              expect(response.body).to have_tag('.change_item', text: /Entity/)
+              expect(response.body).to have_tag('.change_item', text: /Platform/)
             end
 
-            it "should order changes with newest and highest id at the top" do
-              versions.map(&:id).should == versions.sort_by { |o| [o.created_at, o.id] }.reverse.map(&:id)
+            it 'orders changes with newest and highest id at the top' do
+              ids = response.body.scan(/Change #(\d+)/).flatten.map(&:to_i)
+              expect(ids).to eq ids.sort.reverse
             end
           end
         end
@@ -77,16 +60,17 @@ describe PaperTrailManager, :versioning => true do
         # end
       end
 
-      context "when getting changes for a specific type" do
-        context "that exists" do
-          before { get changes_path(:type => "Entity") }
+      context 'when getting changes for a specific type' do
+        context 'when changes exist' do
+          before { get changes_path(type: 'Entity') }
 
-          it "should show a subset of the changes" do
-            versions.size.should == 6
+          it 'shows a subset of the changes' do
+            expect(response.body).to have_tag('.change_row', count: 6)
           end
 
-          it "should have changes only for that type" do
-            item_types.should == ["Entity"]
+          it 'has changes only for that type' do
+            expect(response.body).to have_tag('.change_item', text: /Entity/)
+            expect(response.body).not_to have_tag('.change_item', text: /Platform/)
           end
         end
 
@@ -96,20 +80,21 @@ describe PaperTrailManager, :versioning => true do
         # end
       end
 
-      context "when getting changes for a specific record" do
-        context "that exists" do
-          before { get changes_path(:type => "Entity", :id => @reimu.id) }
+      context 'when getting changes for a specific record' do
+        context 'when changes exist' do
+          before { get changes_path(type: 'Entity', id: reimu.id) }
 
-          it "should show a subset of the changes" do
-            versions.size.should == 3
+          it 'shows a subset of the changes' do
+            expect(response.body).to have_tag('.change_row', count: 3)
           end
 
-          it "should have changes only for that type" do
-            item_types.should == ["Entity"]
+          it 'has changes only for that type' do
+            expect(response.body).to have_tag('.change_item', text: /Entity/)
+            expect(response.body).not_to have_tag('.change_item', text: /Platform/)
           end
 
-          it "should have changes only for that record" do
-            versions.map(&:item_id).uniq.should == [@reimu.id]
+          it 'has changes only for that record' do
+            expect(response.body.scan(%r{/entities/(#{reimu.id})}).flatten.uniq).to eq [reimu.id.to_s]
           end
         end
 
@@ -120,24 +105,25 @@ describe PaperTrailManager, :versioning => true do
       end
     end
 
-    context "show a change" do
-      context "that exists" do
-        context "when authorized" do
+    describe 'showing a change' do
+      context 'when the change exists' do
+        context 'when authorized' do
+          let(:version) { reimu.versions.last }
+
           before do
-            @version = @reimu.versions.last
-            get change_path(@version)
+            get change_path(version)
           end
 
-          it "should show the requested change" do
-            version.should == @version
+          it 'shows the requested change' do
+            expect(response.body).to have_tag('.change_id', text: "Change ##{version.id}")
           end
 
-          it "should show a change with the right event" do
-            version.event.should == "update"
+          it 'shows a change with the right event' do
+            expect(response.body).to have_tag('.change_event_update')
           end
 
-          it "should be associated with the expected record" do
-            version.item.should == @reimu
+          it 'is associated with the expected record' do
+            expect(response.body).to have_tag('.change_item', text: "Entity #{reimu.id}")
           end
         end
 
@@ -152,50 +138,48 @@ describe PaperTrailManager, :versioning => true do
       #   it "should display an error that the change doesn't exist"
       # end
     end
-  end
-
-  context "when rolling back changes" do
-    context "that that exist" do
-      before(:each) { populate }
 
-      context "when authorized" do
-        it "should rollback a newly-created record by deleting it" do
-          Entity.exists?(@reimu.id).should be_truthy
+    describe 'rolling back changes' do
+      context 'when changes exist' do
+        context 'when authorized' do
+          it 'rollbacks a newly-created record by deleting it' do
+            expect(Entity).to exist(reimu.id)
 
-          put change_path(@reimu.versions.first)
+            put change_path(reimu.versions.first)
 
-          Entity.exists?(@reimu.id).should be_falsey
-        end
+            expect(Entity).not_to exist(reimu.id)
+          end
 
-        it "should rollback an edit by reverting to the previous state" do
-          @reimu.reload
-          @reimu.status.should == "Perfect Cherry Blossom"
+          it 'rollbacks an edit by reverting to the previous state' do
+            reimu.reload
+            expect(reimu.status).to eq 'Perfect Cherry Blossom'
 
-          put change_path(@reimu.versions.last)
+            put change_path(reimu.versions.last)
 
-          @reimu.reload
-          @reimu.status.should == "Phantasmagoria of Dimensional Dream"
-        end
+            reimu.reload
+            expect(reimu.status).to eq 'Phantasmagoria of Dimensional Dream'
+          end
 
-        it "should rollback a delete by restoring the record" do
-          Entity.exists?(@flanchan.id).should be_falsey
+          it 'rollbacks a delete by restoring the record' do
+            Entity.exists?(flanchan_id).should be_falsey
 
-          put change_path(PaperTrail::Version.where(:item_id => @flanchan.id, :item_type => "Entity").last)
+            put change_path(PaperTrail::Version.where(item_id: flanchan_id, item_type: 'Entity').last)
 
-          flanchan = Entity.find(@flanchan.id)
-          flanchan.status.should == "The Embodiment of Scarlet Devil"
+            found = Entity.find(flanchan_id)
+            expect(found.status).to eq 'The Embodiment of Scarlet Devil'
+          end
         end
+
+        # TODO
+        # context "when not authorized" do
+        #   it "should display an error if user is not allowed to revert that change"
+        # end
       end
 
       # TODO
-      # context "when not authorized" do
-      #   it "should display an error if user is not allowed to revert that change"
+      # context "that don't exist" do
+      #   it "should display an error that the change doesn't exist"
       # end
     end
-
-    # TODO
-    # context "that don't exist" do
-    #   it "should display an error that the change doesn't exist"
-    # end
   end
 end

data/spec/rails_helper.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 # This file is copied to spec/ when you run 'rails generate rspec:install'
-ENV["RAILS_ENV"] ||= 'test'
-require File.expand_path("../dummy/config/environment", __FILE__)
-require "rspec/rails"
-require "rspec/active_model/mocks"
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path('dummy/config/environment', __dir__)
+require 'rspec/rails'
+require 'rspec/active_model/mocks'
 
 RSpec.configure do |config|
   # If you're not using ActiveRecord, or you'd prefer not to run each of your

data/spec/spec_helper.rb

@@ -1,5 +1,7 @@
-require "rails_helper"
-require "rspec/its"
+# frozen_string_literal: true
+
+require 'rails_helper'
+require 'rspec/its'
 
 # 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`.
@@ -25,7 +27,7 @@ require "rspec/its"
 # run twice. It is recommended that you do not name files matching this glob to
 # end with _spec.rb. You can configure this pattern with with the --pattern
 # option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
-Dir["spec/support/**/*.rb"].each { |f| require File.expand_path(f) }
+Dir['spec/support/**/*.rb'].each { |f| require File.expand_path(f) }
 
 RSpec.configure do |config|
   # config.include(Capybara::Webkit::RspecMatchers, :type => :feature)
@@ -71,7 +73,7 @@ RSpec.configure do |config|
     # Enable only the newer, non-monkey-patching expect syntax.
     # For more details, see:
     #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
-    expectations.syntax = [:should, :expect]
+    expectations.syntax = %i[should expect]
   end
 
   # rspec-mocks config goes here. You can use an alternate test double
@@ -80,7 +82,7 @@ RSpec.configure do |config|
     # Enable only the newer, non-monkey-patching expect syntax.
     # For more details, see:
     #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
-    mocks.syntax = [:should, :expect]
+    mocks.syntax = %i[should expect]
 
     # Prevents you from mocking or stubbing a method that does not exist on
     # a real object. This is generally recommended.

data/spec/support/factories.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'factory_girl_rails'
 
 FactoryGirl.define do
@@ -11,4 +13,3 @@ FactoryGirl.define do
     sequence(:status) { |n| "status_#{n}" }
   end
 end
-

data/spec/support/rspec_html_matchers.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'rspec-html-matchers'
+
+RSpec.configure do |config|
+  config.include RSpecHtmlMatchers
+end