demingfactor-paper_trail_manager 0.7.3

data/spec/app_template.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+gem 'demingfactor-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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+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

@@ -0,0 +1,185 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe PaperTrailManager, versioning: true do
+  context 'without changes' do
+    context 'when fetching the index' do
+      it 'has no changes by default' do
+        get '/changes'
+
+        expect(response.body).to include('No changes found')
+      end
+    end
+  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 }
+
+    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
+
+    describe 'index' do
+      context 'when getting all changes' do
+        context 'with authorization' do
+          context 'when getting default index' do
+            before { get changes_path }
+
+            it 'has all changes' do
+              expect(response.body).to have_tag('.change_row', count: 10)
+            end
+
+            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 '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
+
+        # TODO
+        # context "when not authorized" do
+        #   it "should display an error if user is not allowed to list changes"
+        # end
+      end
+
+      context 'when getting changes for a specific type' do
+        context 'when changes exist' do
+          before { get changes_path(type: 'Entity') }
+
+          it 'shows a subset of the changes' do
+            expect(response.body).to have_tag('.change_row', count: 6)
+          end
+
+          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
+
+        # TODO
+        # context "that doesn't exist" do
+        #   it "should display ana error that the type doesn't exist"
+        # end
+      end
+
+      context 'when getting changes for a specific record' do
+        context 'when changes exist' do
+          before { get changes_path(type: 'Entity', id: reimu.id) }
+
+          it 'shows a subset of the changes' do
+            expect(response.body).to have_tag('.change_row', count: 3)
+          end
+
+          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 '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
+
+        # TODO
+        # context "that doesn't exist" do
+        #   it "should display an error that the record doesn't exist"
+        # end
+      end
+    end
+
+    describe 'showing a change' do
+      context 'when the change exists' do
+        context 'when authorized' do
+          let(:version) { reimu.versions.last }
+
+          before do
+            get change_path(version)
+          end
+
+          it 'shows the requested change' do
+            expect(response.body).to have_tag('.change_id', text: "Change ##{version.id}")
+          end
+
+          it 'shows a change with the right event' do
+            expect(response.body).to have_tag('.change_event_update')
+          end
+
+          it 'is associated with the expected record' do
+            expect(response.body).to have_tag('.change_item', text: "Entity #{reimu.id}")
+          end
+        end
+
+        # TODO
+        # context "when not authorized" do
+        #   it "should display an error if user is not allowed to show the change"
+        # end
+      end
+
+      # TODO
+      # context "that doesn't exist" do
+      #   it "should display an error that the change doesn't exist"
+      # end
+    end
+
+    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)
+
+            expect(Entity).not_to exist(reimu.id)
+          end
+
+          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)
+
+            reimu.reload
+            expect(reimu.status).to eq 'Phantasmagoria of Dimensional Dream'
+          end
+
+          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)
+
+            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 "that don't exist" do
+      #   it "should display an error that the change doesn't exist"
+      # end
+    end
+  end
+end

data/spec/rails_helper.rb

@@ -0,0 +1,29 @@
+# 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', __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
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # RSpec Rails can automatically mix in different behaviours to your tests
+  # based on their file location, for example enabling you to call `get` and
+  # `post` in specs under `spec/controllers`.
+  #
+  # You can disable this behaviour by removing the line below, and instead
+  # explicitly tag your specs with their type, e.g.:
+  #
+  #     RSpec.describe UsersController, :type => :controller do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://relishapp.com/rspec/rspec-rails/docs
+  config.infer_spec_type_from_file_location!
+end

data/spec/spec_helper.rb

@@ -0,0 +1,91 @@
+# 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`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, make a
+# separate helper file that requires this one and then use it only in the specs
+# that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# 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) }
+
+RSpec.configure do |config|
+  # config.include(Capybara::Webkit::RspecMatchers, :type => :feature)
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  # config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # 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 = %i[should expect]
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # 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 = %i[should expect]
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    # mocks.verify_partial_doubles = true
+  end
+end

data/spec/support/factories.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'factory_girl_rails'
+
+FactoryGirl.define do
+  factory :entity do
+    sequence(:name)   { |n| "name_#{n}" }
+    sequence(:status) { |n| "status_#{n}" }
+  end
+
+  factory :platform do
+    sequence(:name)   { |n| "name_#{n}" }
+    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

metadata

@@ -0,0 +1,263 @@
+--- !ruby/object:Gem::Specification
+name: demingfactor-paper_trail_manager
+version: !ruby/object:Gem::Version
+  version: 0.7.3
+platform: ruby
+authors:
+- dev@demingfactor.com
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: paper_trail
+  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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: rspec-activemodel-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-html-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 1.5.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 1.5.4
+description: Browse, subscribe, view and revert changes to records when using Rails
+  and the `paper_trail` gem.
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".tool-versions"
+- Appraisals
+- CHANGES.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/paper_trail_manager/changes_controller.rb
+- app/helpers/paper_trail_manager/changes_helper.rb
+- app/views/paper_trail_manager/changes/_version.html.erb
+- 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
+- demingfactor-paper_trail_manager.gemspec
+- gemfiles/rails_4.2.2_paper_trail_3.0_kaminari.gemfile
+- gemfiles/rails_4.2.2_paper_trail_3.0_will_paginate.gemfile
+- gemfiles/rails_4.2.2_paper_trail_4.0_kaminari.gemfile
+- gemfiles/rails_4.2.2_paper_trail_4.0_will_paginate.gemfile
+- gemfiles/rails_4.2.2_paper_trail_5.0_kaminari.gemfile
+- gemfiles/rails_4.2.2_paper_trail_5.0_will_paginate.gemfile
+- gemfiles/rails_4.2.2_paper_trail_6.0_kaminari.gemfile
+- gemfiles/rails_4.2.2_paper_trail_6.0_will_paginate.gemfile
+- gemfiles/rails_4.2.2_paper_trail_7.0_kaminari.gemfile
+- gemfiles/rails_4.2.2_paper_trail_7.0_will_paginate.gemfile
+- gemfiles/rails_4.2.2_paper_trail_8.0_kaminari.gemfile
+- gemfiles/rails_4.2.2_paper_trail_8.0_will_paginate.gemfile
+- gemfiles/rails_5.0.0_paper_trail_5.0_kaminari.gemfile
+- gemfiles/rails_5.0.0_paper_trail_5.0_will_paginate.gemfile
+- gemfiles/rails_5.0.0_paper_trail_6.0_kaminari.gemfile
+- gemfiles/rails_5.0.0_paper_trail_6.0_will_paginate.gemfile
+- gemfiles/rails_5.0.0_paper_trail_7.0_kaminari.gemfile
+- gemfiles/rails_5.0.0_paper_trail_7.0_will_paginate.gemfile
+- gemfiles/rails_5.0.0_paper_trail_8.0_kaminari.gemfile
+- gemfiles/rails_5.0.0_paper_trail_8.0_will_paginate.gemfile
+- gemfiles/rails_5.1.0_paper_trail_10.0_kaminari.gemfile
+- gemfiles/rails_5.1.0_paper_trail_10.0_will_paginate.gemfile
+- gemfiles/rails_5.1.0_paper_trail_7.0_kaminari.gemfile
+- gemfiles/rails_5.1.0_paper_trail_7.0_will_paginate.gemfile
+- gemfiles/rails_5.1.0_paper_trail_8.0_kaminari.gemfile
+- gemfiles/rails_5.1.0_paper_trail_8.0_will_paginate.gemfile
+- gemfiles/rails_5.1.0_paper_trail_9.0_kaminari.gemfile
+- gemfiles/rails_5.1.0_paper_trail_9.0_will_paginate.gemfile
+- gemfiles/rails_5.2.0_paper_trail_10.0_kaminari.gemfile
+- gemfiles/rails_5.2.0_paper_trail_10.0_will_paginate.gemfile
+- gemfiles/rails_5.2.0_paper_trail_9.0_kaminari.gemfile
+- gemfiles/rails_5.2.0_paper_trail_9.0_will_paginate.gemfile
+- gemfiles/rails_6.0.0_paper_trail_10.0_kaminari.gemfile
+- gemfiles/rails_6.0.0_paper_trail_10.0_will_paginate.gemfile
+- gemfiles/rails_6.1.0_paper_trail_11.1_kaminari.gemfile
+- gemfiles/rails_6.1.0_paper_trail_11.1_will_paginate.gemfile
+- lib/paper_trail_manager.rb
+- spec/app_template.rb
+- spec/integration/navigation_spec.rb
+- spec/integration/paper_trail_manager_spec.rb
+- spec/rails_helper.rb
+- spec/spec_helper.rb
+- spec/support/factories.rb
+- spec/support/rspec_html_matchers.rb
+homepage: https://github.com/demingfactor/paper_trail_manager
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key:
+specification_version: 4
+summary: A user interface for `paper_trail` versioning data in Rails applications.
+test_files:
+- spec/app_template.rb
+- spec/integration/navigation_spec.rb
+- spec/integration/paper_trail_manager_spec.rb
+- spec/rails_helper.rb
+- spec/spec_helper.rb
+- spec/support/factories.rb
+- spec/support/rspec_html_matchers.rb