goca-spree-core 3.1.14.rails.5.0

data/lib/spree/testing_support/capybara_ext.rb

@@ -0,0 +1,179 @@
+module CapybaraExt
+  def page!
+    save_and_open_page
+  end
+
+  def click_icon(type)
+    find(".icon-#{type}").click
+  end
+
+  def eventually_fill_in(field, options={})
+    expect(page).to have_css('#' + field)
+    fill_in field, options
+  end
+
+  def within_row(num, &block)
+    if RSpec.current_example.metadata[:js]
+      within("table.table tbody tr:nth-child(#{num})", &block)
+    else
+      within(:xpath, all("table.table tbody tr")[num-1].path, &block)
+    end
+  end
+
+  def column_text(num)
+    if RSpec.current_example.metadata[:js]
+      find("td:nth-child(#{num})").text
+    else
+      all("td")[num-1].text
+    end
+  end
+
+  def set_select2_field(field, value)
+    page.execute_script %Q{$('#{field}').select2('val', '#{value}')}
+  end
+
+  def select2_search(value, options)
+    label = find_label_by_text(options[:from])
+    within label.first(:xpath,".//..") do
+      options[:from] = "##{find(".select2-container")["id"]}"
+    end
+    targetted_select2_search(value, options)
+  end
+
+  def targetted_select2_search(value, options)
+    page.execute_script %Q{$('#{options[:from]}').select2('open')}
+    page.execute_script "$('#{options[:dropdown_css]} input.select2-input').val('#{value}').trigger('keyup-change');"
+    select_select2_result(value)
+  end
+
+  def select2(value, options)
+    label = find_label_by_text(options[:from])
+
+    within label.first(:xpath,".//..") do
+      options[:from] = "##{find(".select2-container")["id"]}"
+    end
+    targetted_select2(value, options)
+  end
+
+  def select2_no_label value, options={}
+    raise "Must pass a hash containing 'from'" if not options.is_a?(Hash) or not options.has_key?(:from)
+
+    placeholder = options[:from]
+    minlength = options[:minlength] || 4
+
+    click_link placeholder
+
+    select_select2_result(value)
+  end
+
+  def targetted_select2(value, options)
+    # find select2 element and click it
+    find(options[:from]).find('a').click
+    select_select2_result(value)
+  end
+
+  def select_select2_result(value)
+    # results are in a div appended to the end of the document
+    within(:xpath, '//body') do
+      page.find("div.select2-result-label", text: %r{#{Regexp.escape(value)}}i).click
+    end
+  end
+
+  def find_label_by_text(text)
+    label = find_label(text)
+    counter = 0
+
+    # Because JavaScript testing is prone to errors...
+    while label.nil? && counter < 10
+      sleep(1)
+      counter += 1
+      label = find_label(text)
+    end
+
+    if label.nil?
+      raise "Could not find label by text #{text}"
+    end
+
+    label
+  end
+
+  def find_label(text)
+    first(:xpath, "//label[text()[contains(.,'#{text}')]]")
+  end
+
+  # arg delay in seconds
+  def wait_for_ajax(delay = Capybara.default_max_wait_time)
+    counter = 0
+    delay_threshold = delay * 10
+    while page.evaluate_script("typeof($) === 'undefined' || $.active > 0")
+      counter += 1
+      sleep(0.1)
+      raise "AJAX request took longer than #{delay} seconds." if counter >= delay_threshold
+    end
+  end
+
+  # "Intelligiently" wait on condition
+  #
+  # Much better than a random sleep "here and there"
+  # it will not cause any delay in case the condition is fullfilled on first cycle.
+  def wait_for_condition(delay = Capybara.default_max_wait_time)
+    counter = 0
+    delay_threshold = delay * 10
+    while !yield
+      counter += 1
+      sleep(0.1)
+      raise "Could not achieve condition within #{delay} seconds." if counter >= delay_threshold
+    end
+  end
+
+  def accept_alert
+    page.evaluate_script('window.confirm = function() { return true; }')
+    yield
+  end
+
+  def dismiss_alert
+    page.evaluate_script('window.confirm = function() { return false; }')
+    yield
+    # Restore existing default
+    page.evaluate_script('window.confirm = function() { return true; }')
+  end
+end
+
+Capybara.configure do |config|
+  config.match = :prefer_exact
+  config.ignore_hidden_elements = true
+end
+
+RSpec::Matchers.define :have_meta do |name, expected|
+  match do |actual|
+    has_css?("meta[name='#{name}'][content='#{expected}']", visible: false)
+  end
+
+  failure_message do |actual|
+    actual = first("meta[name='#{name}']")
+    if actual
+      "expected that meta #{name} would have content='#{expected}' but was '#{actual[:content]}'"
+    else
+      "expected that meta #{name} would exist with content='#{expected}'"
+    end
+  end
+end
+
+RSpec::Matchers.define :have_title do |expected|
+  match do |actual|
+    has_css?("title", text: expected, visible: false)
+  end
+
+  failure_message do |actual|
+    actual = first("title")
+    if actual
+      "expected that title would have been '#{expected}' but was '#{actual.text}'"
+    else
+      "expected that title would exist with '#{expected}'"
+    end
+  end
+end
+
+RSpec.configure do |c|
+  c.include CapybaraExt
+end

data/lib/spree/testing_support/common_rake.rb

@@ -0,0 +1,39 @@
+unless defined?(Spree::InstallGenerator)
+  require 'generators/spree/install/install_generator'
+end
+
+require 'generators/spree/dummy/dummy_generator'
+require 'rails'
+
+desc "Generates a dummy app for testing"
+namespace :common do
+  task :test_app, :user_class do |_t, args|
+    args.with_defaults(user_class: "Spree::LegacyUser")
+    require ENV['LIB_NAME'].to_s
+
+    ENV['RAILS_ENV'] = 'test'
+    Rails.env = 'test'
+
+    Spree::DummyGenerator.start ["--lib_name=#{ENV['LIB_NAME']}", "--quiet"]
+    Spree::InstallGenerator.start ["--lib_name=#{ENV['LIB_NAME']}", "--auto-accept", "--migrate=false", "--seed=false", "--sample=false", "--quiet", "--user_class=#{args[:user_class]}"]
+
+    puts "Setting up dummy database..."
+    system("bundle exec rake db:drop db:create db:migrate > #{File::NULL}")
+
+    begin
+      require "generators/#{ENV['LIB_NAME']}/install/install_generator"
+      puts 'Running extension installation generator...'
+      "#{ENV['LIB_NAME'].camelize}::Generators::InstallGenerator".constantize.start(["--auto-run-migrations"])
+    rescue LoadError
+      puts 'Skipping installation no generator to run...'
+    end
+
+    puts "Precompiling assets..."
+    system("bundle exec rake assets:precompile > #{File::NULL}")
+  end
+
+  task :seed do |_t|
+    puts "Seeding ..."
+    system("bundle exec rake db:seed RAILS_ENV=test > #{File::NULL}")
+  end
+end

data/lib/spree/testing_support/controller_requests.rb

@@ -0,0 +1,93 @@
+# Use this module to easily test Spree actions within Spree components
+# or inside your application to test routes for the mounted Spree engine.
+#
+# Inside your spec_helper.rb, include this module inside the RSpec.configure
+# block by doing this:
+#
+#   require 'spree/testing_support/controller_requests'
+#   RSpec.configure do |c|
+#     c.include Spree::TestingSupport::ControllerRequests, :type => :controller
+#   end
+#
+# Then, in your controller tests, you can access spree routes like this:
+#
+#   require 'spec_helper'
+#
+#   describe Spree::ProductsController do
+#     it "can see all the products" do
+#       spree_get :index
+#     end
+#   end
+#
+# Use spree_get, spree_post, spree_put or spree_delete to make requests
+# to the Spree engine, and use regular get, post, put or delete to make
+# requests to your application.
+#
+module Spree
+  module TestingSupport
+    module ControllerRequests
+      extend ActiveSupport::Concern
+
+      included do
+        routes { Spree::Core::Engine.routes }
+      end
+
+      def spree_get(action, parameters = nil, session = nil, flash = nil)
+        process_spree_action(action, parameters, session, flash, "GET")
+      end
+
+      # Executes a request simulating POST HTTP method and set/volley the response
+      def spree_post(action, parameters = nil, session = nil, flash = nil)
+        process_spree_action(action, parameters, session, flash, "POST")
+      end
+
+      # Executes a request simulating PUT HTTP method and set/volley the response
+      def spree_put(action, parameters = nil, session = nil, flash = nil)
+        process_spree_action(action, parameters, session, flash, "PUT")
+      end
+
+      # Executes a request simulating PATCH HTTP method and set/volley the response
+      def spree_patch(action, parameters = nil, session = nil, flash = nil)
+        process_spree_action(action, parameters, session, flash, "PATCH")
+      end
+
+      # Executes a request simulating DELETE HTTP method and set/volley the response
+      def spree_delete(action, parameters = nil, session = nil, flash = nil)
+        process_spree_action(action, parameters, session, flash, "DELETE")
+      end
+
+      def spree_xhr_get(action, parameters = nil, session = nil, flash = nil)
+        process_spree_xhr_action(action, parameters, session, flash, :get)
+      end
+
+      def spree_xhr_post(action, parameters = nil, session = nil, flash = nil)
+        process_spree_xhr_action(action, parameters, session, flash, :post)
+      end
+
+      def spree_xhr_put(action, parameters = nil, session = nil, flash = nil)
+        process_spree_xhr_action(action, parameters, session, flash, :put)
+      end
+
+      def spree_xhr_patch(action, parameters = nil, session = nil, flash = nil)
+        process_spree_xhr_action(action, parameters, session, flash, :patch)
+      end
+
+      def spree_xhr_delete(action, parameters = nil, session = nil, flash = nil)
+        process_spree_xhr_action(action, parameters, session, flash, :delete)
+      end
+
+      private
+
+      def process_spree_action(action, parameters = nil, session = nil, flash = nil, method = "GET")
+        parameters ||= {}
+        process(action, method, parameters, session, flash)
+      end
+
+      def process_spree_xhr_action(action, parameters = nil, session = nil, flash = nil, method = :get)
+        parameters ||= {}
+        parameters.reverse_merge!(:format => :json)
+        xml_http_request(method, action, parameters, session, flash)
+      end
+    end
+  end
+end

data/lib/spree/testing_support/extension_rake.rb

@@ -0,0 +1,10 @@
+require 'spree/testing_support/common_rake'
+
+desc "Generates a dummy app for testing an extension"
+namespace :extension do
+  task :test_app, [:user_class] do |t, args|
+    Spree::DummyGeneratorHelper.inject_extension_requirements = true
+    Rake::Task['common:test_app'].invoke
+  end
+end
+

data/lib/spree/testing_support/factories/address_factory.rb

@@ -0,0 +1,22 @@
+FactoryBot.define do
+  factory :address, aliases: [:bill_address, :ship_address], class: Spree::Address do
+    firstname 'John'
+    lastname 'Doe'
+    company 'Company'
+    address1 '10 Lovely Street'
+    address2 'Northwest'
+    city 'Herndon'
+    zipcode '35005'
+    phone '555-555-0199'
+    alternative_phone '555-555-0199'
+
+    state { |address| address.association(:state) || Spree::State.last }
+    country do |address|
+      if address.state
+        address.state.country
+      else
+        address.association(:country)
+      end
+    end
+  end
+end

data/lib/spree/testing_support/factories/adjustment_factory.rb

@@ -0,0 +1,26 @@
+FactoryBot.define do
+  factory :adjustment, class: Spree::Adjustment do
+    association(:adjustable, factory: :order)
+    amount 100.0
+    label 'Shipping'
+    association(:source, factory: :tax_rate)
+    eligible true
+  end
+
+  factory :tax_adjustment, class: Spree::Adjustment do
+    association(:adjustable, factory: :line_item)
+    amount 10.0
+    label 'VAT 5%'
+    association(:source, factory: :tax_rate)
+    eligible true
+
+    after(:create) do |adjustment|
+      # Set correct tax category, so that adjustment amount is not 0
+      if adjustment.adjustable.is_a?(Spree::LineItem)
+        adjustment.source.tax_category = adjustment.adjustable.tax_category
+        adjustment.source.save
+        adjustment.update!
+      end
+    end
+  end
+end

data/lib/spree/testing_support/factories/calculator_factory.rb

@@ -0,0 +1,20 @@
+FactoryBot.define do
+  factory :calculator, class: Spree::Calculator::FlatRate do
+    after(:create) { |c| c.set_preference(:amount, 10.0) }
+  end
+
+  factory :no_amount_calculator, class: Spree::Calculator::FlatRate do
+    after(:create) { |c| c.set_preference(:amount, 0) }
+  end
+
+  factory :default_tax_calculator, class: Spree::Calculator::DefaultTax do
+  end
+
+  factory :shipping_calculator, class: Spree::Calculator::Shipping::FlatRate do
+    after(:create) { |c| c.set_preference(:amount, 10.0) }
+  end
+
+  factory :shipping_no_amount_calculator, class: Spree::Calculator::Shipping::FlatRate do
+    after(:create) { |c| c.set_preference(:amount, 0) }
+  end
+end

data/lib/spree/testing_support/factories/country_factory.rb

@@ -0,0 +1,9 @@
+FactoryBot.define do
+  factory :country, class: Spree::Country do
+    sequence(:iso_name) { |n| "ISO_NAME_#{n}" }
+    sequence(:name) { |n| "NAME_#{n}" }
+    iso 'US'
+    iso3 'USA'
+    numcode 840
+  end
+end

data/lib/spree/testing_support/factories/credit_card_factory.rb

@@ -0,0 +1,10 @@
+FactoryBot.define do
+  factory :credit_card, class: Spree::CreditCard do
+    verification_value 123
+    month 12
+    year { 1.year.from_now.year }
+    number '4111111111111111'
+    name 'Spree Commerce'
+    association(:payment_method, factory: :credit_card_payment_method)
+  end
+end

data/lib/spree/testing_support/factories/customer_return_factory.rb

@@ -0,0 +1,31 @@
+FactoryBot.define do
+
+  factory :customer_return, class: Spree::CustomerReturn do
+    association(:stock_location, factory: :stock_location)
+
+    transient do
+      line_items_count 1
+      return_items_count { line_items_count }
+    end
+
+    before(:create) do |customer_return, evaluator|
+      shipped_order = create(:shipped_order, line_items_count: evaluator.line_items_count)
+
+      shipped_order.inventory_units.take(evaluator.return_items_count).each do |inventory_unit|
+        customer_return.return_items << build(:return_item, inventory_unit: inventory_unit)
+      end
+    end
+
+    factory :customer_return_with_accepted_items do
+      after(:create) do |customer_return|
+        customer_return.return_items.each(&:accept!)
+      end
+    end
+  end
+
+  # for the case when you want to supply existing return items instead of generating some
+  factory :customer_return_without_return_items, class: Spree::CustomerReturn do
+    association(:stock_location, factory: :stock_location)
+  end
+
+end

data/lib/spree/testing_support/factories/image_factory.rb

@@ -0,0 +1,5 @@
+FactoryBot.define do
+  factory :image, class: Spree::Image do
+    attachment { File.new(Spree::Core::Engine.root + "spec/fixtures" + 'thinking-cat.jpg') }
+  end
+end

data/lib/spree/testing_support/factories/inventory_unit_factory.rb

@@ -0,0 +1,10 @@
+FactoryBot.define do
+  factory :inventory_unit, class: Spree::InventoryUnit do
+    variant
+    order
+    line_item
+    state 'on_hand'
+    association(:shipment, factory: :shipment, state: 'pending')
+    # return_authorization
+  end
+end

data/lib/spree/testing_support/factories/line_item_factory.rb

@@ -0,0 +1,12 @@
+FactoryBot.define do
+  factory :line_item, class: Spree::LineItem do
+    quantity 1
+    price { BigDecimal.new('10.00') }
+    pre_tax_amount { price }
+    order
+    transient do
+      association :product
+    end
+    variant{ product.master }
+  end
+end

data/lib/spree/testing_support/factories/options_factory.rb

@@ -0,0 +1,13 @@
+FactoryBot.define do
+  factory :option_value, class: Spree::OptionValue do
+    sequence(:name) { |n| "Size-#{n}" }
+
+    presentation 'S'
+    option_type
+  end
+
+  factory :option_type, class: Spree::OptionType do
+    sequence(:name) { |n| "foo-size-#{n}" }
+    presentation 'Size'
+  end
+end

data/lib/spree/testing_support/factories/order_factory.rb

@@ -0,0 +1,91 @@
+FactoryBot.define do
+  factory :order, class: Spree::Order do
+    user
+    bill_address
+    completed_at nil
+    email { user.email }
+    store
+
+    transient do
+      line_items_price BigDecimal.new(10)
+    end
+
+    factory :order_with_totals do
+      after(:create) do |order, evaluator|
+        create(:line_item, order: order, price: evaluator.line_items_price)
+        order.line_items.reload # to ensure order.line_items is accessible after
+      end
+    end
+
+    factory :order_with_line_item_quantity do
+      transient do
+        line_items_quantity 1
+      end
+
+      after(:create) do |order, evaluator|
+        create(:line_item, order: order, price: evaluator.line_items_price, quantity: evaluator.line_items_quantity)
+        order.line_items.reload # to ensure order.line_items is accessible after
+      end
+    end
+
+    factory :order_with_line_items do
+      bill_address
+      ship_address
+
+      transient do
+        line_items_count 1
+        shipment_cost 100
+        shipping_method_filter Spree::ShippingMethod::DISPLAY_ON_FRONT_END
+      end
+
+      after(:create) do |order, evaluator|
+        create_list(:line_item, evaluator.line_items_count, order: order, price: evaluator.line_items_price)
+        order.line_items.reload
+
+        create(:shipment, order: order, cost: evaluator.shipment_cost)
+        order.shipments.reload
+
+        order.update_with_updater!
+      end
+
+      factory :completed_order_with_totals do
+        state 'complete'
+
+        after(:create) do |order, evaluator|
+          order.refresh_shipment_rates(evaluator.shipping_method_filter)
+          order.update_column(:completed_at, Time.current)
+        end
+
+        factory :completed_order_with_pending_payment do
+          after(:create) do |order|
+            create(:payment, amount: order.total, order: order)
+          end
+        end
+
+        factory :order_ready_to_ship do
+          payment_state 'paid'
+          shipment_state 'ready'
+
+          after(:create) do |order|
+            create(:payment, amount: order.total, order: order, state: 'completed')
+            order.shipments.each do |shipment|
+              shipment.inventory_units.update_all state: 'on_hand'
+              shipment.update_column('state', 'ready')
+            end
+            order.reload
+          end
+
+          factory :shipped_order do
+            after(:create) do |order|
+              order.shipments.each do |shipment|
+                shipment.inventory_units.update_all state: 'shipped'
+                shipment.update_column('state', 'shipped')
+              end
+              order.reload
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spree/testing_support/factories/payment_factory.rb

@@ -0,0 +1,28 @@
+FactoryBot.define do
+  factory :payment, class: Spree::Payment do
+    amount 45.75
+    association(:payment_method, factory: :credit_card_payment_method)
+    association(:source, factory: :credit_card)
+    order
+    state 'checkout'
+    response_code '12345'
+
+    factory :payment_with_refund do
+      state 'completed'
+      after :create do |payment|
+        create(:refund, amount: 5, payment: payment)
+      end
+    end
+  end
+
+  factory :check_payment, class: Spree::Payment do
+    amount 45.75
+    association(:payment_method, factory: :check_payment_method)
+    order
+  end
+
+  factory :store_credit_payment, class: Spree::Payment, parent: :payment do
+    association(:payment_method, factory: :store_credit_payment_method)
+    association(:source, factory: :store_credit)
+  end
+end

data/lib/spree/testing_support/factories/payment_method_factory.rb

@@ -0,0 +1,23 @@
+FactoryBot.define do
+  factory :check_payment_method, class: Spree::PaymentMethod::Check do
+    name 'Check'
+  end
+
+  factory :credit_card_payment_method, class: Spree::Gateway::Bogus do
+    name 'Credit Card'
+  end
+
+  # authorize.net was moved to spree_gateway.
+  # Leaving this factory in place with bogus in case anyone is using it.
+  factory :simple_credit_card_payment_method, class: Spree::Gateway::BogusSimple do
+    name 'Credit Card'
+  end
+
+  factory :store_credit_payment_method, class: Spree::PaymentMethod::StoreCredit do
+    type          "Spree::PaymentMethod::StoreCredit"
+    name          "Store Credit"
+    description   "Store Credit"
+    active        true
+    auto_capture  true
+  end
+end

data/lib/spree/testing_support/factories/price_factory.rb

@@ -0,0 +1,7 @@
+FactoryBot.define do
+  factory :price, class: Spree::Price do
+    variant
+    amount 19.99
+    currency 'USD'
+  end
+end

data/lib/spree/testing_support/factories/product_factory.rb

@@ -0,0 +1,36 @@
+FactoryBot.define do
+  factory :base_product, class: Spree::Product do
+    sequence(:name) { |n| "Product ##{n} - #{Kernel.rand(9999)}" }
+    description { generate(:random_description) }
+    price 19.99
+    cost_price 17.00
+    sku { generate(:sku) }
+    available_on { 1.year.ago }
+    deleted_at nil
+    shipping_category { |r| Spree::ShippingCategory.first || r.association(:shipping_category) }
+
+    # ensure stock item will be created for this products master
+    before(:create) { create(:stock_location) if Spree::StockLocation.count == 0 }
+
+    factory :custom_product do
+      name 'Custom Product'
+      price 17.99
+
+      tax_category { |r| Spree::TaxCategory.first || r.association(:tax_category) }
+    end
+
+    factory :product do
+      tax_category { |r| Spree::TaxCategory.first || r.association(:tax_category) }
+
+      factory :product_in_stock do
+        after :create do |product|
+          product.master.stock_items.first.adjust_count_on_hand(10)
+        end
+      end
+
+      factory :product_with_option_types do
+        after(:create) { |product| create(:product_option_type, product: product) }
+      end
+    end
+  end
+end