solidus_volume_pricing 1.0.0 → 1.1.1

data/app/models/spree/volume_price.rb

@@ -1,52 +1,52 @@
 # frozen_string_literal: true
 
-class Spree::VolumePrice < ApplicationRecord
-  belongs_to :variant, touch: true, optional: true
-  belongs_to :volume_price_model, touch: true, optional: true
-  belongs_to :spree_role, class_name: 'Spree::Role', foreign_key: 'role_id', optional: true
-  acts_as_list scope: [:variant_id, :volume_price_model_id]
-
-  validates :amount, presence: true
-  validates :discount_type,
-    presence: true,
-    inclusion: {
-      in: %w(price dollar percent)
-    }
-
-  validate :range_format
-
-  def self.for_variant(variant, user: nil)
-    roles = [nil]
-    if user
-      roles << user.resolve_role&.id
+module Spree
+  class VolumePrice < ApplicationRecord
+    belongs_to :variant, touch: true, optional: true
+    belongs_to :volume_price_model, touch: true, optional: true
+    belongs_to :spree_role, class_name: 'Spree::Role', foreign_key: 'role_id', optional: true
+    acts_as_list scope: [:variant_id, :volume_price_model_id]
+
+    validates :amount, presence: true
+    validates :discount_type,
+      presence: true,
+      inclusion: {
+        in: %w(price dollar percent)
+      }
+
+    validate :range_format
+
+    def self.for_variant(variant, user: nil)
+      roles = [nil]
+      user&.spree_roles&.each { |r| roles << r.id }
+
+      where(
+        arel_table[:variant_id].eq(variant.id).
+        or(
+          arel_table[:volume_price_model_id].in(variant.volume_price_model_ids)
+        )
+      ).
+        where(role_id: roles).
+        order(position: :asc, amount: :asc)
     end
 
-    where(
-      arel_table[:variant_id].eq(variant.id).
-      or(
-        arel_table[:volume_price_model_id].in(variant.volume_price_model_ids)
-      )
-    ).
-      where(role_id: roles).
-      order(position: :asc, amount: :asc)
-  end
-
-  delegate :include?, to: :range_from_string
+    delegate :include?, to: :range_from_string
 
-  def display_range
-    range.gsub(/\.+/, "-").gsub(/\(|\)/, '')
-  end
+    def display_range
+      range.gsub(/\.+/, "-").gsub(/\(|\)/, '')
+    end
 
-  private
+    private
 
-  def range_format
-    if !(SolidusVolumePricing::RangeFromString::RANGE_FORMAT =~ range ||
-         SolidusVolumePricing::RangeFromString::OPEN_ENDED =~ range)
-      errors.add(:range, :must_be_in_format)
+    def range_format
+      if !(SolidusVolumePricing::RangeFromString::RANGE_FORMAT =~ range ||
+           SolidusVolumePricing::RangeFromString::OPEN_ENDED =~ range)
+        errors.add(:range, :must_be_in_format)
+      end
     end
-  end
 
-  def range_from_string
-    SolidusVolumePricing::RangeFromString.new(range).to_range
+    def range_from_string
+      SolidusVolumePricing::RangeFromString.new(range).to_range
+    end
   end
 end

data/app/models/spree/volume_price_model.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
-class Spree::VolumePriceModel < ApplicationRecord
-  has_many :variants
-  has_many :volume_prices, -> { order(position: :asc) }, dependent: :destroy
-  accepts_nested_attributes_for :volume_prices, allow_destroy: true,
-                                                reject_if: proc { |volume_price|
-                                                             volume_price[:amount].blank? && volume_price[:range].blank?
-                                                           }
+module Spree
+  class VolumePriceModel < ApplicationRecord
+    has_many :variants, dependent: :nullify
+    has_many :volume_prices, -> { order(position: :asc) }, dependent: :destroy
+    accepts_nested_attributes_for :volume_prices, allow_destroy: true,
+      reject_if: proc { |volume_price|
+                   volume_price[:amount].blank? && volume_price[:range].blank?
+                 }
+  end
 end

data/app/views/spree/admin/volume_prices/_volume_price_fields.html.erb

@@ -27,7 +27,9 @@
     <%= error_message_on(f.object, :role_id) %>
     <%= f.collection_select(:role_id, Spree::Role.all, :id, :name, { include_blank: t('spree.match_choices.none') }, { class: 'custom-select' }) %>
   </td>
-  <td class="actions">
-    <%= link_to_remove_fields t('spree.remove'), f, no_text: true %>
-  </td>
+  <% if f.object.persisted? %>
+    <td class="actions">
+      <%= link_to_delete f.object, url: admin_volume_price_url(f.object.id), no_text: true %>
+    </td>
+  <% end %>
 </tr>

data/bin/console

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "solidus_volume_pricing"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+$LOAD_PATH.unshift(*Dir["#{__dir__}/../app/*"])
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rails

@@ -1,8 +1,7 @@
 #!/usr/bin/env ruby
-# frozen_string_literal: true
 
-ENGINE_ROOT = File.expand_path('..', __dir__)
-ENGINE_PATH = File.expand_path('../lib/solidus_volume_pricing/engine', __dir__)
-
-require 'rails/all'
-require 'rails/engine/commands'
+if %w[g generate].include? ARGV.first
+  exec "#{__dir__}/rails-engine", *ARGV
+else
+  exec "#{__dir__}/rails-sandbox", *ARGV
+end

data/bin/rails-engine

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/solidus_volume_pricing/engine', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/bin/rails-sandbox

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+app_root = 'sandbox'
+
+unless File.exist? "#{app_root}/bin/rails"
+  warn 'Creating the sandbox app...'
+  Dir.chdir "#{__dir__}/.." do
+    system "#{__dir__}/sandbox" or begin
+      warn 'Automatic creation of the sandbox app failed'
+      exit 1
+    end
+  end
+end
+
+Dir.chdir app_root
+exec 'bin/rails', *ARGV

data/bin/rake

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/sandbox

@@ -0,0 +1,78 @@
+#!/usr/bin/env bash
+
+set -e
+test -z "${DEBUG+empty_string}" || set -x
+
+test "$DB" = "sqlite" && export DB="sqlite3"
+
+if [ -z "$SOLIDUS_BRANCH" ]
+then
+  echo "~~> Use 'export SOLIDUS_BRANCH=[master|v3.2|...]' to control the Solidus branch"
+  SOLIDUS_BRANCH="master"
+fi
+echo "~~> Using branch $SOLIDUS_BRANCH of solidus"
+
+if [ -z "$SOLIDUS_FRONTEND" ]
+then
+  echo "~~> Use 'export SOLIDUS_FRONTEND=[solidus_frontend|solidus_starter_frontend]' to control the Solidus frontend"
+  SOLIDUS_FRONTEND="solidus_frontend"
+fi
+echo "~~> Using branch $SOLIDUS_FRONTEND as the solidus frontend"
+
+extension_name="solidus_volume_pricing"
+
+# Stay away from the bundler env of the containing extension.
+function unbundled {
+  ruby -rbundler -e'b = proc {system *ARGV}; Bundler.respond_to?(:with_unbundled_env) ? Bundler.with_unbundled_env(&b) : Bundler.with_clean_env(&b)' -- $@
+}
+
+rm -rf ./sandbox
+unbundled bundle exec rails new sandbox \
+  --database="${DB:-sqlite3}" \
+  --skip-bundle \
+  --skip-git \
+  --skip-keeps \
+  --skip-rc \
+  --skip-spring \
+  --skip-test \
+  --skip-javascript
+
+if [ ! -d "sandbox" ]; then
+  echo 'sandbox rails application failed'
+  exit 1
+fi
+
+cd ./sandbox
+cat <<RUBY >> Gemfile
+gem 'solidus', github: 'solidusio/solidus', branch: '$SOLIDUS_BRANCH'
+gem 'rails-i18n'
+gem 'solidus_i18n'
+
+gem '$extension_name', path: '..'
+
+group :test, :development do
+  platforms :mri do
+    gem 'pry-byebug'
+  end
+end
+RUBY
+
+unbundled bundle install --gemfile Gemfile
+
+unbundled bundle exec rake db:drop db:create
+
+unbundled bundle exec rails generate solidus:install \
+  --auto-accept \
+  --user_class=Spree::User \
+  --enforce_available_locales=true \
+  --with-authentication=true \
+  --payment-method=none \
+  --frontend=${SOLIDUS_FRONTEND} \
+  $@
+
+unbundled bundle exec rails generate solidus:auth:install --auto-run-migrations
+unbundled bundle exec rails generate ${extension_name}:install --auto-run-migrations
+
+echo
+echo "🚀 Sandbox app successfully created for $extension_name!"
+echo "🧪 This app is intended for test purposes."

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+gem install bundler --conservative
+bundle update
+bin/rake clobber

data/db/migrate/20150603143015_create_spree_volume_price_models.rb

@@ -10,6 +10,7 @@ class CreateSpreeVolumePriceModels < ActiveRecord::Migration[4.2]
     create_table :spree_variants_volume_price_models do |t|
       t.belongs_to :volume_price_model
       t.belongs_to :variant
+      t.timestamps
     end
 
     add_reference :spree_volume_prices, :volume_price_model

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

@@ -5,16 +5,20 @@ module SolidusVolumePricing
     class InstallGenerator < Rails::Generators::Base
       class_option :auto_run_migrations, type: :boolean, default: false
 
+      def self.exit_on_failure?
+        true
+      end
+
       def add_migrations
-        run 'bundle exec rake railties:install:migrations FROM=solidus_volume_pricing'
+        run 'bin/rails railties:install:migrations FROM=solidus_volume_pricing'
       end
 
       def run_migrations
-        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]'))
+        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]')) # rubocop:disable Layout/LineLength
         if run_migrations
-          run 'bundle exec rake db:migrate'
+          run 'bin/rails db:migrate'
         else
-          puts 'Skipping rake db:migrate, don\'t forget to run it!'
+          puts 'Skipping bin/rails db:migrate, don\'t forget to run it!' # rubocop:disable Rails/Output
         end
       end
     end

data/lib/solidus_volume_pricing/engine.rb

@@ -1,25 +1,35 @@
 # frozen_string_literal: true
 
+require 'spree/core'
+require 'solidus_support'
+
 module SolidusVolumePricing
   class Engine < Rails::Engine
+    include SolidusSupport::EngineExtensions
+
     isolate_namespace ::Spree
+
     engine_name 'solidus_volume_pricing'
 
     initializer 'solidus_volume_pricing.preferences', before: 'spree.environment' do
       ::Spree::AppConfiguration.class_eval do
         preference :use_master_variant_volume_pricing, :boolean, default: false
-        preference :volume_pricing_role, :string, default: 'wholesale'
       end
     end
 
     def self.activate
-      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')).sort.each do |c|
         Rails.configuration.cache_classes ? require(c) : load(c)
+        Rails.autoloaders.main.ignore(c) if Rails.autoloaders.zeitwerk_enabled?
       end
       ::Spree::BackendConfiguration::CONFIGURATION_TABS << :volume_price_models
     end
 
-    config.autoload_paths += %W(#{config.root}/lib)
     config.to_prepare(&method(:activate).to_proc)
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
   end
 end

data/{spec/factories/volume_price_factory.rb → lib/solidus_volume_pricing/testing_support/factories.rb}

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 FactoryBot.define do
-  factory :volume_price, class: Spree::VolumePrice do
+  factory :volume_price, class: 'Spree::VolumePrice' do
     amount { 10 }
     discount_type { 'price' }
     range { '(1..5)' }
     association :variant
   end
 
-  factory :volume_price_model, class: Spree::VolumePriceModel do
+  factory :volume_price_model, class: 'Spree::VolumePriceModel' do
     name { 'name' }
   end
 end

data/lib/solidus_volume_pricing/version.rb

@@ -1,20 +1,5 @@
 # frozen_string_literal: true
 
 module SolidusVolumePricing
-  module_function
-
-  # Returns the version of the currently loaded SolidusVolumePricing as a
-  # <tt>Gem::Version</tt>.
-  def version
-    Gem::Version.new VERSION::STRING
-  end
-
-  module VERSION
-    MAJOR = 1
-    MINOR = 0
-    TINY  = 0
-    PRE   = nil
-
-    STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
-  end
+  VERSION = '1.1.1'
 end

data/lib/solidus_volume_pricing.rb

@@ -4,6 +4,7 @@ require 'active_support/deprecation'
 require 'sassc/rails'
 require 'deface'
 require 'solidus_core'
+require 'solidus_support'
 require 'solidus_volume_pricing/engine'
 require 'solidus_volume_pricing/version'
 require 'solidus_volume_pricing/range_from_string'

data/solidus_volume_pricing.gemspec

@@ -1,32 +1,41 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
-
-require 'solidus_volume_pricing/version'
-
-Gem::Specification.new do |s|
-  s.platform    = Gem::Platform::RUBY
-  s.name        = 'solidus_volume_pricing'
-  s.version     = SolidusVolumePricing.version
-  s.summary     = 'Allow prices to be configured in quantity ranges for each variant'
-  s.description = s.summary
-  s.required_ruby_version = '>= 2.2.3'
-
-  s.author       = 'Sean Schofield'
-  s.email        = 'sean@railsdog.com'
-  s.homepage     = 'https://github.com/solidusio-contrib/solidus_volume_pricing'
-  s.license      = 'BSD-3'
-
-  s.files        = `git ls-files`.split("\n")
-  s.test_files   = `git ls-files -- spec/*`.split("\n")
-  s.require_path = 'lib'
-  s.requirements << 'none'
-
-  s.add_runtime_dependency 'deface', '~> 1.0'
-  s.add_runtime_dependency 'solidus_backend', '>= 2.0'
-  s.add_runtime_dependency 'solidus_core', '>= 2.0'
-
-  s.add_development_dependency 'shoulda-matchers'
-  s.add_development_dependency 'solidus_extension_dev_tools'
+require_relative 'lib/solidus_volume_pricing/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'solidus_volume_pricing'
+  spec.version = SolidusVolumePricing::VERSION
+  spec.authors = ['Sean Schofield']
+  spec.email = 'sean@railsdog.com'
+
+  spec.summary = 'Allow prices to be configured in quantity ranges for each variant'
+  spec.description = 'Allow prices to be configured in quantity ranges for each variant'
+  spec.homepage = 'https://github.com/solidusio-contrib/solidus_volume_pricing'
+  spec.license = 'BSD-3-Clause'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/solidusio-contrib/solidus_volume_pricing'
+  spec.metadata['changelog_uri'] = 'https://github.com/solidusio-contrib/solidus_volume_pricing/releases'
+
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5', '< 4')
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  files = Dir.chdir(__dir__) { `git ls-files -z`.split("\x0") }
+
+  spec.files = files.grep_v(%r{^(test|spec|features)/})
+  spec.test_files = files.grep(%r{^(test|spec|features)/})
+  spec.bindir = "exe"
+  spec.executables = files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'solidus_backend', ['>= 2.4.0', '< 5']
+  spec.add_dependency 'coffee-rails'
+  spec.add_dependency 'deface'
+  spec.add_dependency 'sassc-rails'
+  spec.add_dependency 'solidus_core', ['>= 2.0.0', '< 5']
+  spec.add_dependency 'solidus_support', '~> 0.8'
+
+  spec.add_development_dependency 'shoulda-matchers'
+  spec.add_development_dependency 'solidus_dev_support', '~> 2.6'
 end

data/spec/controllers/spree/admin/variants_controller_spec.rb

@@ -3,7 +3,7 @@
 RSpec.describe Spree::Admin::VariantsController, type: :controller do
   stub_authorization!
 
-  context 'PUT #update' do
+  describe 'PUT #update' do
     it 'creates a volume price' do
       variant = create :variant
 

data/spec/features/manage_volume_price_models_feature_spec.rb

@@ -2,10 +2,10 @@
 
 require 'spec_helper'
 
-RSpec.describe 'Managing volume price models' do
+RSpec.describe 'Managing volume price models', type: :system do
   stub_authorization!
 
-  it 'a admin can create and remove volume price models', :js do
+  it 'an admin can create and remove volume price models', :js do
     visit spree.admin_volume_price_models_path
     expect(page).to have_content('Volume Price Models')
 
@@ -19,10 +19,6 @@ RSpec.describe 'Managing volume price models' do
     end
     click_on 'Create'
 
-    within 'tr.volume_price.fields' do
-      expect(page).to have_field('volume_price_model_volume_prices_attributes_0_name', with: '5 pieces discount')
-      page.find('a[data-action="remove"]').click
-      expect(page).not_to have_field('volume_price_model_volume_prices_attributes_0_name', with: '5 pieces discount')
-    end
+    expect(page).to have_content('Discount')
   end
 end

data/spec/features/manage_volume_prices_feature_spec.rb

@@ -7,7 +7,7 @@ RSpec.describe 'Managing volume prices' do
 
   let(:variant) { create(:variant) }
 
-  it 'a admin can create and remove volume prices', :js do
+  it 'an admin can create and remove volume prices', :js do
     visit spree.edit_admin_product_path(variant.product)
     click_on 'Volume Pricing'
     expect(page).to have_content('Volume Prices')
@@ -18,14 +18,13 @@ RSpec.describe 'Managing volume prices' do
     fill_in 'variant_volume_prices_attributes_0_amount', with: '1'
     click_on 'Update'
 
-    within 'tr.volume_price.fields' do
-      expect(page).to have_field('variant_volume_prices_attributes_0_name', with: '5 pieces discount')
-      page.find('a[data-action="remove"]').click
-      expect(page).not_to have_field('variant_volume_prices_attributes_0_name', with: '5 pieces discount')
-    end
+    expect(page).to have_field('variant_volume_prices_attributes_0_name', with: '5 pieces discount')
+    accept_confirm { page.find('a[data-action="remove"]').click }
+
+    expect(page).not_to have_field('variant_volume_prices_attributes_0_name', with: '5 pieces discount')
   end
 
-  it 'a admin editing a variant has a new volume price already built for her' do
+  it 'an admin editing a variant has a new volume price already built for her' do
     visit spree.edit_admin_product_variant_path(product_id: variant.product, id: variant)
     within '#volume_prices' do
       expect(page).to have_field('variant_volume_prices_attributes_0_name')

data/spec/lib/solidus_volume_pricing/range_from_string_spec.rb

@@ -30,13 +30,13 @@ RSpec.describe SolidusVolumePricing::RangeFromString do
       it { is_expected.to eq(1...2) }
     end
 
-    context 'with an open-ended string like #{x}+' do
+    context 'with an open-ended string like x+' do
       let(:argument) { '10+' }
 
       it { is_expected.to eq(10..Float::INFINITY) }
     end
 
-    context 'with an open-ended string like #{x}+ and parens' do
+    context 'with an open-ended string like x+" and parens' do
       let(:argument) { '(10+)' }
 
       it { is_expected.to eq(10..Float::INFINITY) }

data/spec/models/solidus_volume_pricing/pricer_spec.rb

@@ -14,10 +14,6 @@ RSpec.describe SolidusVolumePricing::Pricer do
   let(:user) { create(:user) }
   let(:variant) { create(:variant, price: 10) }
 
-  before do
-    stub_spree_preferences(volume_pricing_role: role.name)
-  end
-
   it 'inherits from default variant pricer' do
     expect(described_class < Spree::Variant::PriceSelector).to be(true)
   end

data/spec/models/spree/line_item_spec.rb

@@ -19,7 +19,6 @@ RSpec.describe Spree::LineItem, type: :model do
 
   it 'updates the line item price when the quantity changes to match a range and role matches' do
     order.user.spree_roles << role
-    stub_spree_preferences(volume_pricing_role: role.name)
     expect(order.user.has_spree_role?(role.name.to_sym)).to be(true)
     variant.volume_prices.first.update(role_id: role.id)
     expect(line_item.price.to_f).to be(10.00)

data/spec/models/spree/volume_price_spec.rb

@@ -11,12 +11,7 @@ RSpec.describe Spree::VolumePrice, type: :model do
   it { is_expected.to validate_presence_of(:discount_type) }
   it { is_expected.to validate_presence_of(:amount) }
 
-  it do
-    expect(subject).to \
-      validate_inclusion_of(:discount_type).
-      in_array(%w(price dollar percent)).
-      with_message('shoulda-matchers test string is not a valid Volume Price Type')
-  end
+  it { is_expected.to validate_inclusion_of(:discount_type).in_array(%w[price dollar percent]) }
 
   describe '.for_variant' do
     subject { described_class.for_variant(variant, user: user) }
@@ -44,10 +39,6 @@ RSpec.describe Spree::VolumePrice, type: :model do
         create_list(:volume_price, 2, variant: variant, role_id: role.id)
       end
 
-      before do
-        stub_spree_preferences(volume_pricing_role: role.name)
-      end
-
       context 'whose role matches' do
         before do
           user.spree_roles = [role]