solidus_core_devise_token_auth 2.8.0.alpha.0

data/lib/spree/testing_support/ability_helpers.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples_for 'access granted' do
+  it 'should allow read' do
+    expect(ability).to be_able_to(:read, resource, token) if token
+    expect(ability).to be_able_to(:read, resource) unless token
+  end
+
+  it 'should allow create' do
+    expect(ability).to be_able_to(:create, resource, token) if token
+    expect(ability).to be_able_to(:create, resource) unless token
+  end
+
+  it 'should allow update' do
+    expect(ability).to be_able_to(:update, resource, token) if token
+    expect(ability).to be_able_to(:update, resource) unless token
+  end
+end
+
+RSpec.shared_examples_for 'access denied' do
+  it 'should not allow read' do
+    expect(ability).to_not be_able_to(:read, resource)
+  end
+
+  it 'should not allow create' do
+    expect(ability).to_not be_able_to(:create, resource)
+  end
+
+  it 'should not allow update' do
+    expect(ability).to_not be_able_to(:update, resource)
+  end
+end
+
+RSpec.shared_examples_for 'admin granted' do
+  it 'should allow admin' do
+    expect(ability).to be_able_to(:admin, resource, token) if token
+    expect(ability).to be_able_to(:admin, resource) unless token
+  end
+end
+
+RSpec.shared_examples_for 'admin denied' do
+  it 'should not allow admin' do
+    expect(ability).to_not be_able_to(:admin, resource)
+  end
+end
+
+RSpec.shared_examples_for 'index allowed' do
+  it 'should allow index' do
+    expect(ability).to be_able_to(:index, resource)
+  end
+end
+
+RSpec.shared_examples_for 'no index allowed' do
+  it 'should not allow index' do
+    expect(ability).to_not be_able_to(:index, resource)
+  end
+end
+
+RSpec.shared_examples_for 'create only' do
+  it 'should allow create' do
+    expect(ability).to be_able_to(:create, resource)
+  end
+
+  it 'should not allow read' do
+    expect(ability).to_not be_able_to(:read, resource)
+  end
+
+  it 'should not allow update' do
+    expect(ability).to_not be_able_to(:update, resource)
+  end
+
+  it 'should not allow index' do
+    expect(ability).to_not be_able_to(:index, resource)
+  end
+end
+
+RSpec.shared_examples_for 'read only' do
+  it 'should not allow create' do
+    expect(ability).to_not be_able_to(:create, resource)
+  end
+
+  it 'should not allow update' do
+    expect(ability).to_not be_able_to(:update, resource)
+  end
+
+  it 'should allow index' do
+    expect(ability).to be_able_to(:index, resource)
+  end
+end
+
+RSpec.shared_examples_for 'update only' do
+  it 'should not allow create' do
+    expect(ability).to_not be_able_to(:create, resource)
+  end
+
+  it 'should not allow read' do
+    expect(ability).to_not be_able_to(:read, resource)
+  end
+
+  it 'should allow update' do
+    expect(ability).to be_able_to(:update, resource)
+  end
+
+  it 'should not allow index' do
+    expect(ability).to_not be_able_to(:index, resource)
+  end
+end

data/lib/spree/testing_support/authorization_helpers.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'cancan'
+
+module Spree
+  module TestingSupport
+    module AuthorizationHelpers
+      module CustomAbility
+        def build_ability(&block)
+          block ||= proc{ |_u| can :manage, :all }
+          Class.new do
+            include CanCan::Ability
+            define_method(:initialize, block)
+          end
+        end
+      end
+
+      module Controller
+        include CustomAbility
+
+        def stub_authorization!(&block)
+          ability_class = build_ability(&block)
+          before do
+            allow(controller).to receive(:current_ability).and_return(ability_class.new(nil))
+          end
+        end
+      end
+
+      module Request
+        include CustomAbility
+
+        def stub_authorization!
+          ability = build_ability
+
+          after(:all) do
+            Spree::Ability.remove_ability(ability)
+          end
+
+          before(:all) do
+            Spree::Ability.register_ability(ability)
+          end
+
+          before do
+            allow(Spree.user_class).to receive(:find_by).
+                                         and_return(Spree.user_class.new(email: 'lubie@placki.com', password: 'lubieplacki123'))
+            allow_any_instance_of(Spree.user_class).to receive(:valid_token?).
+                                         and_return(true)
+          end
+        end
+
+        def custom_authorization!(&block)
+          ability = build_ability(&block)
+          after(:all) do
+            Spree::Ability.remove_ability(ability)
+          end
+          before(:all) do
+            Spree::Ability.register_ability(ability)
+          end
+        end
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.extend Spree::TestingSupport::AuthorizationHelpers::Controller, type: :controller
+  config.extend Spree::TestingSupport::AuthorizationHelpers::Request, type: :feature
+  config.extend Spree::TestingSupport::AuthorizationHelpers::Request, type: :request
+end

data/lib/spree/testing_support/bar_ability.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+Spree::Deprecation.warn "BarAbility is deprecated. Use stub_authorization! instead"
+
+# Fake ability for testing administration
+# @private
+class BarAbility
+  include CanCan::Ability
+
+  def initialize(user)
+    user ||= Spree::User.new
+    if user.has_spree_role? 'bar'
+      # allow dispatch to :admin, :index, and :show on Spree::Order
+      can [:admin, :index, :show], Spree::Order
+      # allow dispatch to :index, :show, :create and :update shipments on the admin
+      can [:admin, :manage], Spree::Shipment
+    end
+  end
+end

data/lib/spree/testing_support/caching.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Spree
+  module TestingSupport
+    module Caching
+      def cache_writes
+        @cache_write_events
+      end
+
+      def clear_cache_events
+        @cache_write_events = []
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include Spree::TestingSupport::Caching, caching: true
+
+  config.before(:each, caching: true) do
+    ActionController::Base.perform_caching = true
+
+    ActiveSupport::Notifications.subscribe("write_fragment.action_controller") do |_event, _start_time, _finish_time, _, details|
+      @cache_write_events ||= []
+      @cache_write_events << details
+    end
+  end
+
+  config.after(:each, caching: true) do
+    ActionController::Base.perform_caching = false
+    Rails.cache.clear
+  end
+end

data/lib/spree/testing_support/capybara_ext.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+module Spree
+  module TestingSupport
+    module CapybaraExt
+      def click_icon(type)
+        find(".fa-#{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)
+        within("table.index tbody tr:nth-of-type(#{num})", &block)
+      end
+
+      def column_text(num)
+        find("td:nth-of-type(#{num})").text
+      end
+
+      def fill_in_quantity(table_column, selector, quantity)
+        Spree::Deprecation.warn <<-WARN.strip_heredoc
+          fill_in_quantity is deprecated. Instead use:
+            within(#{table_column.inspect}) do
+              fill_in #{selector.inspect}, with: #{quantity.inspect}
+            end
+        WARN
+        within(table_column) do
+          fill_in selector, with: quantity
+        end
+      end
+
+      def select2_search(value, options)
+        options = {
+          search: value, # by default search for the value
+          select: true
+        }.merge(options)
+        label = find_label_by_text(options[:from])
+        within label.first(:xpath, ".//..") do
+          options[:from] = "##{find('.select2-container')['id']}"
+        end
+        select2_search_without_selection(options[:search], from: options[:from])
+        select_select2_result(value) if options[:select]
+      end
+
+      def select2_search_without_selection(value, options)
+        find("#{options[:from]}:not(.select2-container-disabled):not(.select2-offscreen)").click
+
+        within_entire_page do
+          find("input.select2-input.select2-focused").set(value)
+        end
+      end
+
+      def targetted_select2_search(value, options)
+        select2_search_without_selection(value, from: options[:from])
+        select_select2_result(value)
+      end
+
+      # Executes the given block within the context of the entire capybara
+      # document. Can be used to 'escape' from within the context of another within
+      # block.
+      def within_entire_page(&block)
+        within(:xpath, '//body', &block)
+      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 !options.is_a?(Hash) || !options.key?(:from)
+
+        placeholder = options[:from]
+
+        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_entire_page do
+          page.find("div.select2-result-label", text: /#{Regexp.escape(value)}/i, match: :prefer_exact).click
+        end
+      end
+
+      def find_label_by_text(text)
+        # This used to find the label by it's text using an xpath query, so we use
+        # a case insensitive search to avoid breakage with existing usage.
+        # We need to select labels which are not .select2-offscreen, as select2
+        # makes a duplicate label with the same text, and we want to be sure to
+        # find the original.
+        find('label:not(.select2-offscreen)', text: /#{Regexp.escape(text)}/i, match: :one)
+      end
+
+      def wait_for_ajax
+        Spree::Deprecation.warn <<-WARN.squish, caller
+          wait_for_ajax has been deprecated.
+          Please refer to the capybara documentation on how to properly wait for asyncronous behavior:
+          https://github.com/teamcapybara/capybara#asynchronous-javascript-ajax-and-friends
+        WARN
+
+        counter = 0
+        while page.evaluate_script("typeof($) === 'undefined' || $.active > 0")
+          counter += 1
+          sleep(0.1)
+          raise "AJAX request took longer than 5 seconds." if counter >= 50
+        end
+      end
+    end
+  end
+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 = 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
+
+# @private
+CapybaraExt = ActiveSupport::Deprecation::DeprecatedConstantProxy.new('CapybaraExt', 'Spree::TestingSupport::CapybaraExt')
+
+RSpec.configure do |c|
+  c.include Spree::TestingSupport::CapybaraExt
+end

data/lib/spree/testing_support/common_rake.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+unless defined?(Spree::InstallGenerator)
+  require 'generators/spree/install/install_generator'
+end
+
+require 'generators/spree/dummy/dummy_generator'
+
+namespace :common do
+  task :test_app, :user_class do |_t, args|
+    args.with_defaults(user_class: "Spree::LegacyUser")
+    require ENV['LIB_NAME']
+
+    ENV["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..."
+
+    sh "bin/rails db:environment:set RAILS_ENV=test"
+    sh "bin/rails db:drop db:create db:migrate VERBOSE=false RAILS_ENV=test"
+
+    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
+      # No extension generator to run
+    end
+  end
+
+  task :seed do |_t, _args|
+    puts "Seeding ..."
+
+    sh "bundle exec rake db:seed RAILS_ENV=test"
+  end
+end

data/lib/spree/testing_support/controller_requests.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module Spree
+  module TestingSupport
+    # A module providing convenience methods to test Solidus controllers
+    # in Rails controller/functional tests. Possibly from inside an
+    # application with a mounted Solidus engine.
+    #
+    # *There is generaly no need* to use this module. Instead, in
+    # a functional/controller test against a Spree controller, just
+    # use standard Rails functionality by including:
+    #
+    #   routes { Spree::Core::Engine.routes }
+    #
+    # And then use standard Rails test `get`, `post` etc methods.
+    #
+    # But some legacy code uses this ControllerRequests helper. It must
+    # be included only in tests against Spree controllers, it will interfere
+    # with tests against local app or other engine controllers, resulting
+    # in ActionController::UrlGenerationError.
+    #
+    # To use this module, inside your spec_helper.rb, include this module inside
+    # the RSpec.configure block by:
+    #
+    #   require 'spree/testing_support/controller_requests'
+    #   RSpec.configure do |c|
+    #     c.include Spree::TestingSupport::ControllerRequests, spree_controller: true
+    #   end
+    #
+    # Then, in your controller tests against spree controllers, you can access
+    # tag to use this module, and access spree routes like this:
+    #
+    #   require 'spec_helper'
+    #
+    #   describe Spree::ProductsController, :spree_controller 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 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
+      deprecate spree_get: :get, deprecator: Spree::Deprecation
+
+      # 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
+      deprecate spree_post: :post, deprecator: Spree::Deprecation
+
+      # 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
+      deprecate spree_put: :put, deprecator: Spree::Deprecation
+
+      # 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
+      deprecate spree_delete: :delete, deprecator: Spree::Deprecation
+
+      def spree_xhr_get(action, parameters = nil, session = nil, flash = nil)
+        process_spree_xhr_action(action, parameters, session, flash, :get)
+      end
+      deprecate spree_xhr_get: :get, deprecator: Spree::Deprecation
+
+      def spree_xhr_post(action, parameters = nil, session = nil, flash = nil)
+        process_spree_xhr_action(action, parameters, session, flash, :post)
+      end
+      deprecate spree_xhr_post: :post, deprecator: Spree::Deprecation
+
+      def spree_xhr_put(action, parameters = nil, session = nil, flash = nil)
+        process_spree_xhr_action(action, parameters, session, flash, :put)
+      end
+      deprecate spree_xhr_put: :put, deprecator: Spree::Deprecation
+
+      def spree_xhr_delete(action, parameters = nil, session = nil, flash = nil)
+        process_spree_xhr_action(action, parameters, session, flash, :delete)
+      end
+      deprecate spree_xhr_delete: :delete, deprecator: Spree::Deprecation
+
+      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/dummy_app/assets/javascripts/spree/backend/all.js

@@ -0,0 +1,10 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require jquery
+//= require jquery_ujs
+//= require spree/backend
+//= require_tree .

data/lib/spree/testing_support/dummy_app/assets/javascripts/spree/frontend/all.js

@@ -0,0 +1,10 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require jquery
+//= require jquery_ujs
+//= require spree/frontend
+//= require_tree .

data/lib/spree/testing_support/dummy_app/assets/stylesheets/spree/backend/all.css

@@ -0,0 +1,9 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require spree/backend
+ *= require_self
+ *= require_tree .
+*/

data/lib/spree/testing_support/dummy_app/assets/stylesheets/spree/frontend/all.css

@@ -0,0 +1,9 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require spree/frontend
+ *= require_self
+ *= require_tree .
+*/

data/lib/spree/testing_support/dummy_app/database.yml

@@ -0,0 +1,33 @@
+<%
+database_prefix = ENV['LIB_NAME'].presence || "solidus"
+%>
+<% case ENV['DB']
+when 'mysql' %>
+test:
+  adapter: mysql2
+  <% if ENV['CI'] %>
+  username: root
+  password:
+  <% end %>
+  database: <%= database_prefix %>_test
+  encoding: utf8
+  <% unless ENV['DB_HOST'].blank? %>
+  host: <%= ENV['DB_HOST'] %>
+  <% end %>
+<% when 'postgres', 'postgresql' %>
+<% db_host = ENV['DB_HOST'] %>
+test:
+  adapter: postgresql
+  database: <%= database_prefix %>_test
+  min_messages: warning
+<% unless db_host.blank? %>
+  host: <%= db_host %>
+<% end %>
+<% when 'sqlite', '', nil %>
+test:
+  adapter: sqlite3
+  database: db/<%= database_prefix %>_test.sqlite3
+  timeout: 10000
+<% else %>
+  <% raise "Invalid DB specified: #{ENV['DB']}" %>
+<% end %>

data/lib/spree/testing_support/dummy_app/migrations.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module DummyApp
+  module Migrations
+    extend self
+
+    # Ensure database exists
+    def database_exists?
+      ActiveRecord::Base.connection
+    rescue ActiveRecord::NoDatabaseError
+      false
+    else
+      true
+    end
+
+    def needs_migration?
+      return true if !database_exists?
+      if ActiveRecord::Base.connection.respond_to?(:migration_context)
+        # Rails >= 5.2
+        ActiveRecord::Base.connection.migration_context.needs_migration?
+      else
+        ActiveRecord::Migrator.needs_migration?
+      end
+    end
+
+    def auto_migrate
+      if needs_migration?
+        puts "Configuration changed. Re-running migrations"
+
+        # Disconnect to avoid "database is being accessed by other users" on postgres
+        ActiveRecord::Base.remove_connection
+
+        sh 'rake db:reset VERBOSE=false'
+
+        # We have a brand new database, so we must re-establish our connection
+        ActiveRecord::Base.establish_connection
+      end
+    end
+
+    private
+
+    def sh(cmd)
+      puts cmd
+      system cmd
+    end
+  end
+end