RubyGems - solidus_papertrail - Versions diffs - 1.0.0 - Mend

solidus_papertrail 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (61) hide show

checksums.yaml +7 -0
data/.gitignore +14 -0
data/.rspec +1 -0
data/.travis.yml +21 -0
data/Gemfile +18 -0
data/LICENSE +26 -0
data/README.md +45 -0
data/Rakefile +21 -0
data/app/assets/javascripts/admin/solidus_papertrail.js +1 -0
data/app/assets/javascripts/spree/backend/solidus_papertrail.js +0 -0
data/app/assets/javascripts/spree/frontend/solidus_papertrail.js +0 -0
data/app/assets/javascripts/store/solidus_papertrail.js +1 -0
data/app/assets/stylesheets/admin/solidus_papertrail.css +3 -0
data/app/assets/stylesheets/spree/backend/solidus_papertrail.css +0 -0
data/app/assets/stylesheets/spree/frontend/solidus_papertrail.css +0 -0
data/app/assets/stylesheets/store/solidus_papertrail.css +3 -0
data/app/controllers/spree/admin/base_controller_decorator.rb +5 -0
data/app/controllers/spree/admin/orders_controller_decorator.rb +22 -0
data/app/models/paper_trail/version_decorator.rb +5 -0
data/app/models/spree/adjustment_decorator.rb +15 -0
data/app/models/spree/adjustment_version.rb +5 -0
data/app/models/spree/line_item_decorator.rb +15 -0
data/app/models/spree/line_item_version.rb +5 -0
data/app/models/spree/order_decorator.rb +15 -0
data/app/models/spree/order_version.rb +5 -0
data/app/models/spree/payment_decorator.rb +15 -0
data/app/models/spree/payment_version.rb +5 -0
data/app/models/spree/return_authorization_decorator.rb +15 -0
data/app/models/spree/return_authorization_version.rb +5 -0
data/app/models/spree/shipment_decorator.rb +15 -0
data/app/models/spree/shipment_version.rb +5 -0
data/app/overrides/add_order_history_to_order_menu.rb +8 -0
data/app/services/versions_adapter.rb +24 -0
data/app/services/yaml_adapter.rb +27 -0
data/app/views/spree/admin/orders/_adjustment_versions.html.erb +48 -0
data/app/views/spree/admin/orders/_line_item_versions.html.erb +52 -0
data/app/views/spree/admin/orders/_object_changes.html.erb +41 -0
data/app/views/spree/admin/orders/_order_versions.html.erb +45 -0
data/app/views/spree/admin/orders/_payment_versions.html.erb +51 -0
data/app/views/spree/admin/orders/_return_authorization_versions.html.erb +48 -0
data/app/views/spree/admin/orders/_shipment_versions.html.erb +52 -0
data/app/views/spree/admin/orders/versions.html.erb +25 -0
data/bin/rails +7 -0
data/config/locales/en.yml +21 -0
data/config/locales/es.yml +5 -0
data/config/routes.rb +11 -0
data/db/migrate/20160421221937_create_versions.rb +87 -0
data/lib/generators/solidus_papertrail/install/install_generator.rb +31 -0
data/lib/solidus_papertrail.rb +4 -0
data/lib/solidus_papertrail/engine.rb +22 -0
data/lib/solidus_papertrail/factories.rb +6 -0
data/lib/solidus_papertrail/version.rb +3 -0
data/solidus_papertrail.gemspec +36 -0
data/spec/features/admin/order_history_spec.rb +94 -0
data/spec/spec_helper.rb +32 -0
data/spec/support/capybara.rb +12 -0
data/spec/support/database_cleaner.rb +24 -0
data/spec/support/factory_girl.rb +8 -0
data/spec/support/feature_helper.rb +10 -0
data/spec/support/spree.rb +7 -0
metadata +269 -0

checksums.yaml ADDED

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f76131771daeafcb5091ed3aab30d981a3b6227b
+  data.tar.gz: 7363f77964e6871eae1622111658ec1ce5293ec1
+SHA512:
+  metadata.gz: b484d08640228250b6bd2604fb877d4a9f0fa16e42fe722c2ff687ab93dd57ec19b5eafd4e5934be6717760deecec9ceca753bf2ecd8336e9990f35ff465a941
+  data.tar.gz: 71f64c91bedb14f237f8435a7dfe0cb2baf8ffd510ba0add5b4389c97c0002b8da833e40e748bebd44d33f48fedbc4eedd5b6c42b7bf60b456feaae43d77aee5

data/.gitignore ADDED

@@ -0,0 +1,14 @@
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.project
+.sass-cache
+coverage
+Gemfile.lock
+tmp
+nbproject
+pkg
+*.swp
+spec/dummy

data/.rspec ADDED

	@@ -0,0 +1 @@
1	+ --color

data/.travis.yml ADDED

@@ -0,0 +1,21 @@
+sudo: false
+cache: bundler
+language: ruby
+rvm:
+  - 2.3.1
+env:
+  matrix:
+    - SOLIDUS_BRANCH=v1.0 DB=postgres
+    - SOLIDUS_BRANCH=v1.1 DB=postgres
+    - SOLIDUS_BRANCH=v1.2 DB=postgres
+    - SOLIDUS_BRANCH=v1.3 DB=postgres
+    - SOLIDUS_BRANCH=v1.4 DB=postgres
+    - SOLIDUS_BRANCH=v2.0 DB=postgres
+    - SOLIDUS_BRANCH=master DB=postgres
+    - SOLIDUS_BRANCH=v1.0 DB=mysql
+    - SOLIDUS_BRANCH=v1.1 DB=mysql
+    - SOLIDUS_BRANCH=v1.2 DB=mysql
+    - SOLIDUS_BRANCH=v1.3 DB=mysql
+    - SOLIDUS_BRANCH=v1.4 DB=mysql
+    - SOLIDUS_BRANCH=v2.0 DB=mysql
+    - SOLIDUS_BRANCH=master DB=mysql

data/Gemfile ADDED

@@ -0,0 +1,18 @@
+source "https://rubygems.org"
+branch = ENV.fetch('SOLIDUS_BRANCH', 'master')
+gem "solidus", github: "solidusio/solidus", branch: branch
+gem "solidus_auth_devise"
+if branch == 'master' || branch >= "v2.0"
+  gem "rails-controller-testing", group: :test
+end
+gem 'pg'
+gem 'mysql2'
+group :development, :test do
+  gem "pry-rails"
+end
+gemspec

data/LICENSE ADDED

@@ -0,0 +1,26 @@
+Copyright (c) 2014 [name of plugin creator]
+All rights reserved.
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Spree nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md ADDED

@@ -0,0 +1,45 @@
+SolidusPapertrail
+===============
+[![Build Status](https://travis-ci.org/solidusio-contrib/solidus_papertrail.svg?branch=master)](https://travis-ci.org/solidusio-contrib/solidus_papertrail)
+Introduction goes here.
+Installation
+------------
+Add solidus_papertrail to your Gemfile:
+```ruby
+gem 'solidus_papertrail'
+```
+Bundle your dependencies and run the installation generator:
+```shell
+bundle
+bundle exec rails g solidus_papertrail:install
+```
+Testing
+-------
+Be sure to bundle your dependencies and then create a dummy test app for the specs to run against.
+```shell
+bundle
+bundle exec rake test_app
+bundle exec rspec spec
+```
+When testing your applications integration with this extension you may use it's factories.
+Simply add this require statement to your spec_helper:
+```ruby
+require 'solidus_papertrail/factories'
+```
+Copyright (c) 2014 [Acid Labs][acidlabs], released under the New BSD License
+[acidlabs]: https://github.com/acidlabs

data/Rakefile ADDED

@@ -0,0 +1,21 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+require 'rspec/core/rake_task'
+require 'spree/testing_support/common_rake'
+RSpec::Core::RakeTask.new
+task :default do
+  if Dir["spec/dummy"].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir("../../")
+  end
+  Rake::Task[:spec].invoke
+end
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'solidus_papertrail'
+  Rake::Task['common:test_app'].invoke("Spree::User")
+end

data/app/assets/javascripts/admin/solidus_papertrail.js ADDED

	@@ -0,0 +1 @@
1	+ //= require admin/spree_backend

data/app/assets/javascripts/spree/backend/solidus_papertrail.js ADDED

File without changes

data/app/assets/javascripts/spree/frontend/solidus_papertrail.js ADDED

File without changes

data/app/assets/javascripts/store/solidus_papertrail.js ADDED

	@@ -0,0 +1 @@
1	+ //= require store/spree_frontend

data/app/assets/stylesheets/admin/solidus_papertrail.css ADDED

@@ -0,0 +1,3 @@
+/*
+ *= require admin/spree_backend
+*/

data/app/assets/stylesheets/spree/backend/solidus_papertrail.css ADDED

File without changes

data/app/assets/stylesheets/spree/frontend/solidus_papertrail.css ADDED

File without changes

data/app/assets/stylesheets/store/solidus_papertrail.css ADDED

@@ -0,0 +1,3 @@
+/*
+ *= require store/spree_frontend
+*/

data/app/controllers/spree/admin/base_controller_decorator.rb ADDED

@@ -0,0 +1,5 @@
+Spree::BaseController.class_eval do
+  def user_for_paper_trail
+    spree_current_user.nil? ? 'Public User' : spree_current_user.id
+  end
+end

data/app/controllers/spree/admin/orders_controller_decorator.rb ADDED

@@ -0,0 +1,22 @@
+Spree::Admin::OrdersController.class_eval do
+  def versions
+    @order = Spree::Order.find_by_number params[:id]
+    @versions = VersionsAdapter.create([@order])
+    payments = @order.payments.order(updated_at: :asc)
+    @payment_versions = VersionsAdapter.create(payments)
+    shipments = @order.shipments.order(updated_at: :desc)
+    @shipment_versions = VersionsAdapter.create(shipments)
+    line_items = @order.line_items.order(updated_at: :desc)
+    @line_item_versions = VersionsAdapter.create(line_items)
+    adjustments = @order.all_adjustments.order(updated_at: :desc)
+    @adjustment_versions = VersionsAdapter.create(adjustments)
+    return_authorizations = @order.return_authorizations.order(updated_at: :desc)
+    @return_authorization_versions = VersionsAdapter.create(return_authorizations)
+  end
+end

data/app/models/paper_trail/version_decorator.rb ADDED

@@ -0,0 +1,5 @@
+module PaperTrail
+  Version.class_eval do
+    self.abstract_class = true
+  end
+end

data/app/models/spree/adjustment_decorator.rb ADDED

@@ -0,0 +1,15 @@
+module Spree
+  Adjustment.class_eval do
+    has_paper_trail class_name: 'Spree::AdjustmentVersion'
+    attr_accessor :who, :version_changes, :version_id, :version_event, :version_date
+    def who=(user_id)
+      begin
+        @who = Spree::User.find(user_id).full_name
+      rescue
+        @who = 'Unknown'
+      end
+    end
+  end
+end

data/app/models/spree/adjustment_version.rb ADDED

@@ -0,0 +1,5 @@
+module Spree
+  class AdjustmentVersion < PaperTrail::Version
+    self.table_name = :spree_adjustment_versions
+  end
+end

data/app/models/spree/line_item_decorator.rb ADDED

@@ -0,0 +1,15 @@
+module Spree
+  LineItem.class_eval do
+    has_paper_trail class_name: 'Spree::LineItemVersion'
+    attr_accessor :who, :version_changes, :version_id, :version_event, :version_date
+    def who=(user_id)
+      begin
+        @who = Spree::User.find(user_id).full_name
+      rescue
+        @who = 'Unknown'
+      end
+    end
+  end
+end

data/app/models/spree/line_item_version.rb ADDED

@@ -0,0 +1,5 @@
+module Spree
+  class LineItemVersion < PaperTrail::Version
+    self.table_name = :spree_line_item_versions
+  end
+end

data/app/models/spree/order_decorator.rb ADDED

@@ -0,0 +1,15 @@
+module Spree
+  Order.class_eval do
+    has_paper_trail class_name: 'Spree::OrderVersion'
+    attr_accessor :who, :version_changes, :version_id, :version_event, :version_date
+    def who=(user_id)
+      begin
+        @who = Spree::User.find(user_id).full_name
+      rescue
+        @who = 'Unknown'
+      end
+    end
+  end
+end

data/app/models/spree/order_version.rb ADDED

@@ -0,0 +1,5 @@
+module Spree
+  class OrderVersion < PaperTrail::Version
+    self.table_name = :spree_order_versions
+  end
+end

data/app/models/spree/payment_decorator.rb ADDED

@@ -0,0 +1,15 @@
+module Spree
+  Payment.class_eval do
+    has_paper_trail class_name: 'Spree::PaymentVersion'
+    attr_accessor :who, :version_changes, :version_id, :version_event, :version_date
+    def who=(user_id)
+      begin
+        @who = Spree::User.find(user_id).full_name
+      rescue
+        @who = ""
+      end
+    end
+  end
+end

data/app/models/spree/payment_version.rb ADDED

@@ -0,0 +1,5 @@
+module Spree
+  class PaymentVersion < PaperTrail::Version
+    self.table_name = :spree_payment_versions
+  end
+end

data/app/models/spree/return_authorization_decorator.rb ADDED

@@ -0,0 +1,15 @@
+module Spree
+  ReturnAuthorization.class_eval do
+    has_paper_trail class_name: 'Spree::ReturnAuthorizationVersion'
+    attr_accessor :who, :version_changes, :version_id, :version_event, :version_date
+    def who=(user_id)
+      begin
+        @who = Spree::User.find(user_id).full_name
+      rescue
+        @who = ""
+      end
+    end
+  end
+end

data/app/models/spree/return_authorization_version.rb ADDED

@@ -0,0 +1,5 @@
+module Spree
+  class ReturnAuthorizationVersion < PaperTrail::Version
+    self.table_name = :spree_return_authorization_versions
+  end
+end

data/app/models/spree/shipment_decorator.rb ADDED

@@ -0,0 +1,15 @@
+module Spree
+  Shipment.class_eval do
+    has_paper_trail class_name: 'Spree::ShipmentVersion'
+    attr_accessor :who, :version_changes, :version_id, :version_event, :version_date
+    def who=(user_id)
+      begin
+        @who = Spree::User.find(user_id).full_name
+      rescue
+        @who = ""
+      end
+    end
+  end
+end

data/app/models/spree/shipment_version.rb ADDED

@@ -0,0 +1,5 @@
+module Spree
+  class ShipmentVersion < PaperTrail::Version
+    self.table_name = :spree_shipment_versions
+  end
+end

data/app/overrides/add_order_history_to_order_menu.rb ADDED

@@ -0,0 +1,8 @@
+Deface::Override.new( virtual_path: 'spree/admin/shared/_order_submenu',
+                      name: 'order_history_menu',
+                      insert_bottom: "[data-hook='admin_order_tabs']",
+                      text: "
+                        <li <%== 'class=\"active\"' if current == 'Order History' %>><%= link_to_with_icon 'icon-shopping-cart', Spree.t(:order_history), versions_admin_order_path(@order) %></li>
+                      "
+  )

data/app/services/versions_adapter.rb ADDED

@@ -0,0 +1,24 @@
+class VersionsAdapter
+  def self.create(elements)
+    collection = []
+    elements.each do |element|
+      if element.respond_to?(:versions)
+        versions = element.versions.order(:object, created_at: :asc)
+        versions.each do |version|
+          prototype = version.object.nil? ?
+            element.class.new :
+            YamlAdapter.new(version.object, element.class).deserialize
+          prototype.who = version.whodunnit
+          prototype.version_id = version.id
+          prototype.version_event = version.event
+          prototype.version_changes = version.object_changes
+          prototype.version_date    = version.created_at
+          collection << prototype
+        end
+        collection << element
+      end
+    end
+    collection
+  end
+end

data/app/services/yaml_adapter.rb ADDED

@@ -0,0 +1,27 @@
+class YamlAdapter
+  attr_reader :payload, :klass
+  def initialize text, klass
+    @data = YAML.load(text)
+    @klass = klass
+  end
+  def deserialize
+    @klass.new(permitted_data)
+  end
+  private
+  # The below two methods prevent papertrail from
+  # attempting to instantiate models with attributes
+  # they do not have definitions for or do not have
+  # the corresponding columns in the database.
+  #
+  # Both cases are exceptional, so we filter this here.
+  def permitted_data
+    keys = @klass.column_names.to_set
+    @data.keep_if do |key, _|
+      keys.include?(key)
+    end
+  end
+end

data/app/views/spree/admin/orders/_adjustment_versions.html.erb ADDED

@@ -0,0 +1,48 @@
+<fieldset class="no-border-bottom">
+  <legend align="center" class="" data-hook="">
+    <%= Spree::AdjustmentVersion.model_name.human %>
+  </legend>
+</fieldset>
+<table id="adjustment-history">
+  <thead>
+    <tr>
+      <th><%= Spree::AdjustmentVersion.human_attribute_name("version_id") %></th>
+      <th><%= Spree::AdjustmentVersion.human_attribute_name("id") %></th>
+      <th><%= Spree::AdjustmentVersion.human_attribute_name("amount") %></th>
+      <th><%= Spree::AdjustmentVersion.human_attribute_name("label") %></th>
+      <th><%= Spree::AdjustmentVersion.human_attribute_name("event") %></th>
+      <th><%= Spree::AdjustmentVersion.human_attribute_name("changes") %></th>
+      <th><%= Spree::AdjustmentVersion.human_attribute_name("user") %></th>
+      <th><%= Spree::AdjustmentVersion.human_attribute_name("created") %></th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @adjustment_versions.each do |adjustment| %>
+      <% if adjustment.version_id %>
+        <tr>
+          <td><%= adjustment.version_id %></td>
+          <td><%= adjustment.id %></td>
+          <td><%= number_to_currency adjustment.amount %></td>
+          <td><%= adjustment.label %></td>
+          <td><%= adjustment.version_event %></td>
+          <td class="align-center"><%= render partial: 'object_changes', locals: { object: adjustment } %></td>
+          <td><%= adjustment.who %></td>
+          <td><%= pretty_time(adjustment.version_date) %></td>
+        </tr>
+      <% else %>
+        <tr>
+          <td></td>
+          <td><%= adjustment.id %></td>
+          <td><%= number_to_currency adjustment.amount %></td>
+          <td><%= adjustment.label %></td>
+          <td></td>
+          <td></td>
+          <td></td>
+          <td><%= pretty_time(adjustment.updated_at) %></td>
+        </tr>
+      <% end %>
+    <% end %>
+  </tbody>
+</table>