spree_backend 4.3.0 → 4.5.0

data/lib/spree/backend/configuration.rb

@@ -0,0 +1,37 @@
+module Spree
+  module Backend
+    class Configuration < Preferences::Configuration
+      preference :admin_path, :string, default: '/admin'
+      preference :admin_products_per_page, :integer, default: Kaminari.config.default_per_page
+      preference :admin_orders_per_page, :integer, default: Kaminari.config.default_per_page
+      preference :admin_properties_per_page, :integer, default: Kaminari.config.default_per_page
+      preference :admin_promotions_per_page, :integer, default: Kaminari.config.default_per_page
+      preference :admin_customer_returns_per_page, :integer, default: Kaminari.config.default_per_page
+      preference :admin_users_per_page, :integer, default: Kaminari.config.default_per_page
+      preference :admin_show_version, :boolean, default: true
+      preference :locale, :string
+      preference :variants_per_page, :integer, default: Kaminari.config.default_per_page
+      preference :menus_per_page, :integer, default: Kaminari.config.default_per_page
+      preference :product_wysiwyg_editor_enabled, :boolean, default: true
+      preference :taxon_wysiwyg_editor_enabled, :boolean, default: true
+      preference :show_only_complete_orders_by_default, :boolean, default: true
+
+      ORDER_TABS         ||= [:orders, :payments, :creditcard_payments,
+                              :shipments, :credit_cards, :return_authorizations,
+                              :customer_returns, :adjustments, :customer_details]
+      PRODUCT_TABS       ||= [:products, :option_types, :properties, :prototypes,
+                              :variants, :product_properties, :taxonomies,
+                              :taxons]
+      REPORT_TABS        ||= [:reports]
+      CONFIGURATION_TABS ||= [:configurations, :general_settings, :tax_categories,
+                              :tax_rates, :zones, :countries, :states,
+                              :payment_methods, :shipping_methods,
+                              :shipping_categories, :stock_transfers,
+                              :stock_locations, :trackers, :refund_reasons,
+                              :reimbursement_types, :return_authorization_reasons,
+                              :stores]
+      PROMOTION_TABS     ||= [:promotions, :promotion_categories]
+      USER_TABS          ||= [:users]
+    end
+  end
+end

data/lib/spree/backend/engine.rb

@@ -1,10 +1,12 @@
+require_relative 'configuration'
+
 module Spree
   module Backend
     class Engine < ::Rails::Engine
       config.middleware.use 'Spree::Backend::Middleware::SeoAssist'
 
       initializer 'spree.backend.environment', before: :load_config_initializers do |_app|
-        Spree::Backend::Config = Spree::BackendConfiguration.new
+        Spree::Backend::Config = Spree::Backend::Configuration.new
       end
 
       # filter sensitive information during logging
@@ -14,7 +16,8 @@ module Spree
 
       initializer 'spree.backend.checking_deprecated_preferences' do
         Spree::Backend::Config.deprecated_preferences.each do |pref|
-          warn "[DEPRECATION] Spree::Backend::Config[:#{pref[:name]}] is deprecated. #{pref[:message]}"
+          # FIXME: we should only notify about deprecated preferences that are in use, not all of them
+          # warn "[DEPRECATION] Spree::Backend::Config[:#{pref[:name]}] is deprecated. #{pref[:message]}"
         end
       end
     end

data/lib/spree/backend/testing_support/capybara_utils.rb

@@ -0,0 +1,59 @@
+module Spree
+  module Backend
+    module TestingSupport
+      module CapybaraUtils
+        def click_icon(type)
+          first(".icon-#{type}").click
+        end
+
+        def within_row(num, &block)
+          if RSpec.current_example.metadata[:js]
+            within("table.table tbody tr:nth-child(#{num})", match: :first, &block)
+          else
+            within(all('table.table tbody tr')[num - 1], &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
+
+        # delay in seconds
+        def wait_for_ajax(delay = Capybara.default_max_wait_time)
+          Timeout.timeout(delay) do
+            active = page.evaluate_script('typeof jQuery !== "undefined" && jQuery.active')
+            active = page.evaluate_script('typeof jQuery !== "undefined" && jQuery.active') until active.nil? || active.zero?
+          end
+        end
+
+        def wait_for_turbo(timeout = nil)
+          if has_css?('.turbo-progress-bar', visible: true, wait: 1.seconds)
+            has_no_css?('.turbo-progress-bar', wait: timeout.presence || 5.seconds)
+          end
+        end
+
+        def wait_for_turbo_frame(selector = 'turbo-frame', timeout = nil)
+          if has_selector?("#{selector}[busy]", visible: true, wait: 1.seconds)
+            has_no_selector?("#{selector}[busy]", wait: timeout.presence || 5.seconds)
+          end
+        end
+
+        def disable_html5_validation
+          page.execute_script('for(var f=document.forms,i=f.length;i--;)f[i].setAttribute("novalidate",i)')
+        end
+
+        def wait_for(options = {}, &block)
+          default_options = { error: nil, seconds: 5 }.merge(options)
+
+          Selenium::WebDriver::Wait.new(timeout: default_options[:seconds]).until(&block)
+        rescue Selenium::WebDriver::Error::TimeoutError
+          default_options[:error].nil? ? false : raise(default_options[:error])
+        end
+      end
+    end
+  end
+end

data/lib/spree/backend/testing_support/flash.rb

@@ -0,0 +1,38 @@
+module Spree
+  module Backend
+    module TestingSupport
+      module Flash
+        def assert_admin_flash_alert_success(message)
+          message_content = convert_flash(message)
+
+          within('#FlashAlertsContainer', visible: :all) do
+            expect(page).to have_css('span[data-alert-type="success"]', text: message_content, visible: :all)
+          end
+        end
+
+        def assert_admin_flash_alert_error(message)
+          message_content = convert_flash(message)
+
+          within('#FlashAlertsContainer', visible: :all) do
+            expect(page).to have_css('span[data-alert-type="error"]', text: message_content, visible: :all)
+          end
+        end
+
+        def assert_admin_flash_alert_notice(message)
+          message_content = convert_flash(message)
+
+          within('#FlashAlertsContainer', visible: :all) do
+            expect(page).to have_css('span[data-alert-type="notice"]', text: message_content, visible: :all)
+          end
+        end
+
+        private
+
+        def convert_flash(flash)
+          flash = Spree.t(flash) if flash.is_a?(Symbol)
+          flash
+        end
+      end
+    end
+  end
+end

data/lib/spree/backend/testing_support/flatpickr_capybara.rb

@@ -0,0 +1,126 @@
+module Spree
+  module Backend
+    module TestingSupport
+      module FlatpickrCapybara
+        def fill_in_date_manually(label_text, options = {})
+          with_open_flatpickr(label_text) do |field|
+            fill_in field[:id], with: string_date(options)
+          end
+        end
+
+        def fill_in_date_picker(label_text, options = {})
+          if options[:hour].blank? && options[:minute].blank?
+            flatpickr_date_only(label_text, options)
+          else
+            flatpickr_date_time(label_text, options)
+          end
+        end
+
+        def fill_in_date_with_js(label_text, options = {})
+          date_field = find("input[id='#{label_text}']")
+          script = "document.querySelector('#{date_field}').flatpickr().setDate('#{string_date(options)}');"
+
+          page.execute_script(script)
+        end
+
+        private
+
+        def flatpickr_date_only(label_text, options = {})
+          within_open_flatpickr(label_text) do
+            within_flatpickr_months do
+              fill_in_flatpickr_year(options[:year].to_i)
+              sleep(0.25) # Pause to let JavaScript adjust the month selector in the flatpickr cal in relation to any related FROM...TO cal.
+
+              select_flatpickr_month(options[:month].to_i)
+              sleep(0.25) # Pause to let JavaScript adjust the day selection area in the flatpickr cal in relation to any related FROM...TO cal.
+
+              click_on_flatpickr_day(options[:day].to_i)
+            end
+          end
+        end
+
+        def flatpickr_date_time(label_text, options = {})
+          within_open_flatpickr(label_text) do
+            within_flatpickr_months do
+              fill_in_flatpickr_year(options[:year].to_i)
+              sleep(0.25) # Pause to let JavaScript adjust the month selector in the flatpickr cal in relation to any related FROM...TO cal.
+
+              select_flatpickr_month(options[:month].to_i)
+              sleep(0.25) # Pause to let JavaScript adjust the day selection area in the flatpickr cal in relation to any related FROM...TO cal.
+
+              click_on_flatpickr_day(options[:day].to_i)
+            end
+
+            within_flatpickr_time do
+              select_flatpickr_hour(options[:hour].to_i)
+              select_flatpickr_min(options[:minute].to_i)
+            end
+          end
+        end
+
+        def with_open_flatpickr(label_text)
+          field_label = find_field(id: label_text, type: :hidden)
+
+          date_field = field_label.sibling('.flatpickr-alt-input')
+          date_field.click # Open the flatpickr cal.
+          sleep(0.25) # Pause to let JavaScript populate DOM with an open flatpickr cal.
+
+          yield(date_field) # Complete required action within the open flatpickr cal.
+
+          date_field.send_keys :tab # Close the date flatpickr cal.
+          sleep(0.25) # Pause to let JavaScript adjust any DOM values in relation to any related FROM...TO cal.
+        end
+
+        def within_open_flatpickr(label_text, &block)
+          with_open_flatpickr(label_text) do
+            within find('.flatpickr-calendar.open', &block)
+          end
+        end
+
+        def within_flatpickr_months(&block)
+          within find('.flatpickr-months > .flatpickr-month > .flatpickr-current-month', &block)
+        end
+
+        def within_flatpickr_time(&block)
+          within find('.flatpickr-time', &block)
+        end
+
+        def select_flatpickr_month(month)
+          accurate_month = (month.to_i - 1)
+
+          find("select.flatpickr-monthDropdown-months > option[value='#{accurate_month}']").select_option
+        end
+
+        def fill_in_flatpickr_year(year)
+          find('input.cur-year').set(year)
+        end
+
+        def click_on_flatpickr_day(day)
+          within_flatpickr_days do
+            find('.flatpickr-day:not(.prevMonthDay):not(.nextMonthDay)', text: day, exact_text: true).click
+          end
+        end
+
+        def within_flatpickr_days(&block)
+          within find('.flatpickr-innerContainer > .flatpickr-rContainer > .flatpickr-days > .dayContainer', &block)
+        end
+
+        def select_flatpickr_hour(hour)
+          find('input.flatpickr-hour').set(hour)
+        end
+
+        def select_flatpickr_min(min)
+          find('input.flatpickr-minute').set(min)
+        end
+
+        def string_date(options)
+          if options[:hour].present? && options[:minute].present?
+            "#{options[:year]}-#{options[:month]}-#{options[:day]}-#{options[:hour]}-#{options[:minute]}"
+          else
+            "#{options[:year]}-#{options[:month]}-#{options[:day]}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spree/backend/version.rb

@@ -0,0 +1,9 @@
+module Spree
+  module Backend
+    VERSION = '4.5.0'.freeze
+
+    def self.version
+      VERSION
+    end
+  end
+end

data/lib/spree/backend.rb

@@ -7,10 +7,12 @@ require 'jquery-rails'
 require 'jquery-ui-rails'
 require 'select2-rails'
 require 'flatpickr'
+require 'flag-icons-rails'
 require 'bootstrap'
 require 'glyphicons'
-require 'popper_js'
+require 'hotwire-rails'
 require 'inline_svg'
+require 'jsbundling-rails'
 require 'responders'
 require 'tinymce-rails'
 

data/lib/spree_backend.rb

@@ -1 +1,18 @@
 require 'spree/backend'
+
+module Spree
+  def self.admin_path
+    Spree::Backend::Config[:admin_path]
+  end
+
+  # Used to configure admin_path for Spree
+  #
+  # Example:
+  #
+  # write the following line in `config/initializers/spree.rb`
+  #   Spree.admin_path = '/custom-path'
+
+  def self.admin_path=(path)
+    Spree::Backend::Config[:admin_path] = path
+  end
+end

data/license.md

@@ -0,0 +1,13 @@
+Spree License
+=============
+
+Copyright © 2007-2021, Spree Commerce Inc., Spark Solutions Sp. z o.o. and other contributors.
+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 of Spree Commerce Inc. 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/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@spree/dashboard",
+  "version": "0.2.1",
+  "description": "Spree Dashboard",
+  "main": "app/assets/javascripts/spree-dashboard.js",
+  "type": "module",
+  "files": [
+    "app/assets/javascripts/*.js",
+    "src/*.js"
+  ],
+  "homepage": "https://spreecommerce.org/",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/spree/spree_backend.git"
+  },
+  "bugs": {
+    "url": "https://github.com/spree/spree_backend/issues"
+  },
+  "author": "Spark Solutions <hi@sparksolutions.co>",
+  "license": "MIT",
+  "dependencies": {
+    "@hotwired/stimulus": "^3.0.1",
+    "@hotwired/turbo-rails": "^7.1.3",
+    "@rails/request.js": "^0.0.6",
+    "@spree/dashboard": "^0.2.0",
+    "bootstrap": "4.6.1",
+    "flatpickr": "4.6.9",
+    "jquery": "3.5.1",
+    "popper.js": "1.16.1",
+    "sortablejs": "^1.14.0",
+    "stimulus-sortable": "^3.1.0"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^19.0.1",
+    "@rollup/plugin-node-resolve": "^11.0.1",
+    "eslint": "^8.2.0",
+    "rollup": "^2.35.1",
+    "rollup-plugin-terser": "^7.0.2"
+  },
+  "scripts": {
+    "build": "rollup --config rollup.config.js",
+    "watch": "rollup --config rollup.config.js -w",
+    "lint": "eslint app/javascript",
+    "prepublishOnly": "rm -rf src && cp -R app/javascript/spree/dashboard src"
+  }
+}

data/rollup.config.js

@@ -0,0 +1,43 @@
+import resolve from "@rollup/plugin-node-resolve"
+import commonjs from "@rollup/plugin-commonjs"
+import { terser } from "rollup-plugin-terser"
+
+const terserOptions = {
+  mangle: false,
+  compress: false,
+  format: {
+    beautify: true,
+    indent_level: 2
+  }
+}
+
+export default [
+  {
+    input: "app/javascript/spree/dashboard/index.js",
+    output: {
+      file: "app/assets/javascripts/spree-dashboard.js",
+      format: "umd",
+      inlineDynamicImports: true,
+      name: "SpreeDashboard"
+    },
+    plugins: [
+      resolve(),
+      commonjs(),
+      terser(terserOptions)
+    ]
+  },
+
+  {
+    input: "app/javascript/spree/dashboard/index.js",
+    output: {
+      file: "app/assets/javascripts/spree-dashboard.esm.js",
+      format: "es",
+      inlineDynamicImports: true
+    },
+    plugins: [
+      resolve(),
+      commonjs(),
+      terser(terserOptions)
+    ]
+  }
+]

data/spree_backend.gemspec

@@ -1,10 +1,10 @@
 # encoding: UTF-8
-require_relative '../core/lib/spree/core/version.rb'
+require_relative 'lib/spree/backend/version.rb'
 
 Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.name        = 'spree_backend'
-  s.version     = Spree.version
+  s.version     = Spree::Backend.version
   s.authors     = ['Sean Schofield', 'Spark Solutions']
   s.email       = 'hello@spreecommerce.org'
   s.summary     = 'Admin Dashboard for Spree eCommerce platform'
@@ -13,10 +13,10 @@ Gem::Specification.new do |s|
   s.license     = 'BSD-3-Clause'
 
   s.metadata = {
-    "bug_tracker_uri"   => "https://github.com/spree/spree/issues",
-    "changelog_uri"     => "https://github.com/spree/spree/releases/tag/v#{s.version}",
+    "bug_tracker_uri"   => "https://github.com/spree/spree_backend/issues",
+    "changelog_uri"     => "https://github.com/spree/spree_backend/releases/tag/v#{s.version}",
     "documentation_uri" => "https://dev-docs.spreecommerce.org/",
-    "source_code_uri"   => "https://github.com/spree/spree/tree/v#{s.version}",
+    "source_code_uri"   => "https://github.com/spree/spree_backend/tree/v#{s.version}",
   }
 
   s.required_ruby_version = '>= 2.5'
@@ -25,19 +25,21 @@ Gem::Specification.new do |s|
   s.require_path = 'lib'
   s.requirements << 'none'
 
-  s.add_dependency 'spree_api', ">= #{s.version}"
-  s.add_dependency 'spree_core', ">= #{s.version}"
+  s.add_dependency 'spree', ">= 4.4.0"
 
   s.add_dependency 'babel-transpiler', '~> 0.7'
-  s.add_dependency 'bootstrap',       '~> 4.0'
-  s.add_dependency 'glyphicons',      '~> 1.0'
-  s.add_dependency 'flatpickr',       '~> 4.6'
-  s.add_dependency 'inline_svg',      '~> 1.5'
-  s.add_dependency 'jquery-rails',    '~> 4.3'
+  s.add_dependency 'bootstrap',        '~> 4.0'
+  s.add_dependency 'flag-icons-rails', '~> 3.4'
+  s.add_dependency 'flatpickr', '~> 4.6'
+  s.add_dependency 'glyphicons', '~> 1.0'
+  s.add_dependency 'hotwire-rails'
+  s.add_dependency 'inline_svg', '~> 1.5'
+  s.add_dependency 'jquery-rails', '~> 4.3'
   s.add_dependency 'jquery-ui-rails', '~> 6.0'
+  s.add_dependency 'jsbundling-rails'
   s.add_dependency 'responders'
-  s.add_dependency 'sass-rails', '>= 5'
-  s.add_dependency 'select2-rails',   '~> 4.0'
-  s.add_dependency 'sprockets', '~> 4.0'
-  s.add_dependency 'tinymce-rails'
+  s.add_dependency 'sass-rails',       '>= 5'
+  s.add_dependency 'select2-rails',    '~> 4.0.6'
+  s.add_dependency 'sprockets',        '~> 4.0'
+  s.add_dependency 'tinymce-rails',    '~> 5.0'
 end

data/vendor/assets/javascripts/purify.js

@@ -347,7 +347,7 @@
      * DOMPurify. */
     var RETURN_DOM_IMPORT = false;
 
-    /* Try to return a Trusted Type object instead of a string, retrun a string in
+    /* Try to return a Trusted Type object instead of a string, return a string in
      * case Trusted Types are not supported  */
     var RETURN_TRUSTED_TYPE = false;
 

data/vendor/assets/stylesheets/animate.css

@@ -1,8 +1,6 @@
-
-@charset "UTF-8";
-/*!
+@charset "UTF-8";/*!
  * animate.css - https://animate.style/
- * Version - 4.0.0
+ * Version - 4.1.1
  * Licensed under the MIT license - http://opensource.org/licenses/MIT
  *
  * Copyright (c) 2020 Animate.css