solidus_papertrail 1.0.0

data/lib/generators/solidus_papertrail/install/install_generator.rb

@@ -0,0 +1,31 @@
+module SolidusPapertrail
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      class_option :auto_run_migrations, :type => :boolean, :default => false
+
+      def add_javascripts
+        # append_file 'app/assets/javascripts/store/all.js', "//= require store/solidus_papertrail\n"
+        # append_file 'app/assets/javascripts/admin/all.js', "//= require admin/solidus_papertrail\n"
+      end
+
+      def add_stylesheets
+        # inject_into_file 'app/assets/stylesheets/store/all.css', " *= require store/solidus_papertrail\n", :before => /\*\//, :verbose => true
+        # inject_into_file 'app/assets/stylesheets/admin/all.css', " *= require admin/solidus_papertrail\n", :before => /\*\//, :verbose => true
+      end
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=solidus_papertrail'
+      end
+
+      def run_migrations
+        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask 'Would you like to run the migrations now? [Y/n]')
+        if run_migrations
+          run 'bundle exec rake db:migrate'
+        else
+          puts 'Skipping rake db:migrate, don\'t forget to run it!'
+        end
+      end
+    end
+  end
+end

data/lib/solidus_papertrail.rb

@@ -0,0 +1,4 @@
+require 'spree_core'
+require 'solidus_papertrail/version'
+require 'solidus_papertrail/engine'
+require 'paper_trail'

data/lib/solidus_papertrail/engine.rb

@@ -0,0 +1,22 @@
+module SolidusPapertrail
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'solidus_papertrail'
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare &method(:activate).to_proc
+  end
+end

data/lib/solidus_papertrail/factories.rb

@@ -0,0 +1,6 @@
+FactoryGirl.define do
+  # Define your Spree extensions Factories within this file to enable applications, and other extensions to use and override them.
+  #
+  # Example adding this to your spec_helper will load these Factories for use:
+  # require 'solidus_papertrail/factories'
+end

data/lib/solidus_papertrail/version.rb

@@ -0,0 +1,3 @@
+module SolidusPapertrail
+  VERSION = '1.0.0'
+end

data/solidus_papertrail.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'solidus_papertrail/version'
+
+ Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'solidus_papertrail'
+  s.version     = SolidusPapertrail::VERSION
+  s.summary     = 'Solidus Papertrail integration'
+  s.description = 'Views to see Order, Payment and Shipment Papertrail versions'
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.author    = 'Acid Labs'
+  s.email     = 'spree@acid.cl'
+  s.homepage  = 'http://acid.cl'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_path = 'lib'
+  s.requirements << 'none'
+
+  s.add_runtime_dependency 'solidus_backend', [">= 1.0", "< 3"]
+  s.add_dependency 'paper_trail', '~> 4.0.0'
+
+  s.add_development_dependency 'capybara', '~> 2.1'
+  s.add_development_dependency 'poltergeist'
+  s.add_development_dependency 'coffee-rails'
+  s.add_development_dependency 'database_cleaner'
+  s.add_development_dependency 'factory_girl', '~> 4.2'
+  s.add_development_dependency 'ffaker'
+  s.add_development_dependency 'sass-rails'
+  s.add_development_dependency 'rspec-rails',  '~> 3'
+  s.add_development_dependency 'sqlite3'
+end

data/spec/features/admin/order_history_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+
+# Each entry has a "click to reveal changes" link to display details in a popup
+# These tables are nested and contain duplicate information, so it's difficult
+# to target cells using anything but row and column numbers
+def expect_hidden_details(details, table: nil, row: 0, column: 0)
+  within(:css, "table#{table}>tbody") do
+    expect(page).to_not have_content(details)
+    find(:css, "tr:nth-child(#{row}) td:nth-child(#{column}) a").click
+    expect(page).to have_content(details)
+  end
+end
+
+RSpec.feature 'Order History', :type => :feature, js: true do
+  let!(:order) { create(:order, number: 'R212345678') }
+
+  before :each do
+    login_as_admin
+  end
+
+  it "tracks order history" do
+    visit spree.versions_admin_order_path(order)
+    expect(page).to have_css("table#order-history>tbody tr", count: 2)
+
+    order.update(email: 'foo@bar.com')
+    visit(current_path)
+
+    expect(page).to have_css("table#order-history>tbody tr", count: 3)
+    expect_hidden_details('R212345678', table: '#order-history', row: 1, column: 5)
+  end
+
+  it "tracks order line item history" do
+    visit spree.versions_admin_order_path(order)
+
+    expect(page).to have_css("table#line-item-history>tbody tr", count: 0)
+
+    order.contents.add(create(:variant, currency: 'USD'))
+    visit(current_path)
+
+    expect(page).to have_css("table#line-item-history>tbody tr", count: 2)
+    expect_hidden_details('USD', table: '#line-item-history', row: 1, column: 7)
+  end
+
+  it "tracks order adjustment history" do
+    visit spree.versions_admin_order_path(order)
+
+    expect(page).to have_css("table#adjustment-history>tbody tr", count: 0)
+
+    create(:tax_adjustment, adjustable: order, order: order)
+    visit(current_path)
+
+    expect(page).to have_css("table#adjustment-history>tbody tr", count: 2)
+    expect_hidden_details('Spree::TaxRate', table: '#adjustment-history', row: 1, column: 6)
+  end
+
+  it "tracks order payment history" do
+    visit spree.versions_admin_order_path(order)
+
+    expect(page).to have_css("table#payment-history>tbody tr", count: 1)
+
+    create(:payment, order: order, response_code: '54321')
+    visit(current_path)
+
+    expect(page).to have_css("table#payment-history>tbody tr", count: 3)
+    expect_hidden_details('54321', table: '#payment-history', row: 1, column: 7)
+  end
+
+  it "tracks order shipment history" do
+    visit spree.versions_admin_order_path(order)
+
+    expect(page).to have_css("table#shipment-history>tbody tr", count: 0)
+
+    create(:shipment, order: order, stock_location: create(:stock_location, id: 9182736))
+    visit(current_path)
+
+    expect(page).to have_css("table#shipment-history>tbody tr", count: 2)
+    expect_hidden_details('9182736', table: '#shipment-history', row: 1, column: 7)
+  end
+
+  context 'with shipped order' do
+    let!(:order) { create(:shipped_order) }
+
+    it "tracks order return authorizations history" do
+      visit spree.versions_admin_order_path(order)
+
+      expect(page).to have_css("table#returns-history>tbody tr", count: 0)
+      create(:return_authorization, order: order, memo: 'All wrong.')
+      visit(current_path)
+
+      expect(page).to have_css("table#returns-history>tbody tr", count: 2)
+      expect_hidden_details('All wrong.', table: '#returns-history', row: 1, column: 6)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+ENV["RAILS_ENV"] = "test"
+
+begin
+  require File.expand_path('../dummy/config/environment', __FILE__)
+rescue LoadError
+  fail 'Could not load dummy application. Please ensure you have run `bundle exec rake test_app`'
+end
+
+require 'rspec/rails'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.join(File.dirname(__FILE__), 'support/**/*.rb')].each { |file| require file }
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # because database cleaner
+  config.use_transactional_fixtures = false
+
+  config.include FeatureHelper, type: :feature
+end

data/spec/support/capybara.rb

@@ -0,0 +1,12 @@
+require 'capybara/rspec'
+require 'capybara/rails'
+require 'capybara/poltergeist'
+
+RSpec.configure do |config|
+  config.include Rack::Test::Methods, type: :requests
+
+  Capybara.javascript_driver = :poltergeist
+  Capybara.register_driver(:poltergeist) do |app|
+    Capybara::Poltergeist::Driver.new app, js_errors: true, timeout: 60
+  end
+end

data/spec/support/database_cleaner.rb

@@ -0,0 +1,24 @@
+require 'database_cleaner'
+
+RSpec.configure do |config|
+
+  config.before(:suite) do
+    DatabaseCleaner.clean_with :truncation
+  end
+
+  config.before do
+    DatabaseCleaner.strategy = :transaction
+  end
+
+  config.before(:each, js: true) do
+    DatabaseCleaner.strategy = :truncation
+  end
+
+  config.before do
+    DatabaseCleaner.start
+  end
+
+  config.after do
+    DatabaseCleaner.clean
+  end
+end

data/spec/support/factory_girl.rb

@@ -0,0 +1,8 @@
+require 'ffaker'
+require 'factory_girl'
+
+FactoryGirl.find_definitions
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+end

data/spec/support/feature_helper.rb

@@ -0,0 +1,10 @@
+module FeatureHelper
+  def login_as_admin
+    admin = create(:admin_user, password: 'test123', password_confirmation: 'test123')
+    visit spree.admin_path
+    fill_in 'Email', with: admin.email
+    fill_in 'Password', with: 'test123'
+    click_button 'Login'
+    admin
+  end
+end

data/spec/support/spree.rb

@@ -0,0 +1,7 @@
+require 'spree/testing_support/factories'
+require 'spree/testing_support/url_helpers'
+require 'spree/testing_support/capybara_ext'
+
+RSpec.configure do |config|
+  config.include Spree::TestingSupport::UrlHelpers
+end

metadata

@@ -0,0 +1,269 @@
+--- !ruby/object:Gem::Specification
+name: solidus_papertrail
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Acid Labs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: solidus_backend
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: paper_trail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: poltergeist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: ffaker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sass-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Views to see Order, Payment and Shipment Papertrail versions
+email: spree@acid.cl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/admin/solidus_papertrail.js
+- app/assets/javascripts/spree/backend/solidus_papertrail.js
+- app/assets/javascripts/spree/frontend/solidus_papertrail.js
+- app/assets/javascripts/store/solidus_papertrail.js
+- app/assets/stylesheets/admin/solidus_papertrail.css
+- app/assets/stylesheets/spree/backend/solidus_papertrail.css
+- app/assets/stylesheets/spree/frontend/solidus_papertrail.css
+- app/assets/stylesheets/store/solidus_papertrail.css
+- app/controllers/spree/admin/base_controller_decorator.rb
+- app/controllers/spree/admin/orders_controller_decorator.rb
+- app/models/paper_trail/version_decorator.rb
+- app/models/spree/adjustment_decorator.rb
+- app/models/spree/adjustment_version.rb
+- app/models/spree/line_item_decorator.rb
+- app/models/spree/line_item_version.rb
+- app/models/spree/order_decorator.rb
+- app/models/spree/order_version.rb
+- app/models/spree/payment_decorator.rb
+- app/models/spree/payment_version.rb
+- app/models/spree/return_authorization_decorator.rb
+- app/models/spree/return_authorization_version.rb
+- app/models/spree/shipment_decorator.rb
+- app/models/spree/shipment_version.rb
+- app/overrides/add_order_history_to_order_menu.rb
+- app/services/versions_adapter.rb
+- app/services/yaml_adapter.rb
+- app/views/spree/admin/orders/_adjustment_versions.html.erb
+- app/views/spree/admin/orders/_line_item_versions.html.erb
+- app/views/spree/admin/orders/_object_changes.html.erb
+- app/views/spree/admin/orders/_order_versions.html.erb
+- app/views/spree/admin/orders/_payment_versions.html.erb
+- app/views/spree/admin/orders/_return_authorization_versions.html.erb
+- app/views/spree/admin/orders/_shipment_versions.html.erb
+- app/views/spree/admin/orders/versions.html.erb
+- bin/rails
+- config/locales/en.yml
+- config/locales/es.yml
+- config/routes.rb
+- db/migrate/20160421221937_create_versions.rb
+- lib/generators/solidus_papertrail/install/install_generator.rb
+- lib/solidus_papertrail.rb
+- lib/solidus_papertrail/engine.rb
+- lib/solidus_papertrail/factories.rb
+- lib/solidus_papertrail/version.rb
+- solidus_papertrail.gemspec
+- spec/features/admin/order_history_spec.rb
+- spec/spec_helper.rb
+- spec/support/capybara.rb
+- spec/support/database_cleaner.rb
+- spec/support/factory_girl.rb
+- spec/support/feature_helper.rb
+- spec/support/spree.rb
+homepage: http://acid.cl
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- none
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Solidus Papertrail integration
+test_files:
+- spec/features/admin/order_history_spec.rb
+- spec/spec_helper.rb
+- spec/support/capybara.rb
+- spec/support/database_cleaner.rb
+- spec/support/factory_girl.rb
+- spec/support/feature_helper.rb
+- spec/support/spree.rb