spree_backend 4.7.2 → 4.8.0

data/lib/generators/spree/backend/install/install_generator.rb

@@ -13,10 +13,8 @@ module Spree
         end
 
         def install
-          template 'app/javascript/spree-dashboard.js'
           template 'vendor/assets/javascripts/spree/backend/all.js'
           template 'vendor/assets/stylesheets/spree/backend/all.css'
-          run 'yarn add @spree/dashboard'
         end
       end
     end

data/lib/spree/backend/configuration.rb

@@ -1,14 +1,12 @@
 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

data/lib/spree/backend/engine.rb

@@ -1,4 +1,5 @@
 require_relative 'configuration'
+require_relative 'runtime_configuration'
 
 module Spree
   module Backend
@@ -9,9 +10,21 @@ module Spree
 
       initializer 'spree.backend.environment', before: :load_config_initializers do |app|
         Spree::Backend::Config = Spree::Backend::Configuration.new
+        Spree::Backend::RuntimeConfig = Spree::Backend::RuntimeConfiguration.new
         app.config.spree_backend = Environment.new
       end
 
+      initializer "spree.backend.assets" do |app|
+        app.config.assets.paths << root.join("app/javascript")
+        app.config.assets.precompile += %w[ spree_backend_manifest ]
+      end
+
+      initializer 'spree.backend.importmap', before: 'importmap' do |app|
+        app.config.importmap.paths << root.join('config/importmap.rb')
+        # https://github.com/rails/importmap-rails?tab=readme-ov-file#sweeping-the-cache-in-development-and-test
+        app.config.importmap.cache_sweepers << root.join('app/javascript')
+      end
+
       # filter sensitive information during logging
       initializer 'spree.params.filter' do |app|
         app.config.filter_parameters += [:password, :password_confirmation, :number]

data/lib/spree/backend/runtime_configuration.rb

@@ -0,0 +1,8 @@
+module Spree
+  module Backend
+    class RuntimeConfiguration < ::Spree::Preferences::RuntimeConfiguration
+      preference :admin_path, :string, default: '/admin'
+      preference :admin_show_version, :boolean, default: true
+    end
+  end
+end

data/lib/spree/backend/version.rb

@@ -1,6 +1,6 @@
 module Spree
   module Backend
-    VERSION = '4.7.2'.freeze
+    VERSION = '4.8.0'.freeze
 
     def self.version
       VERSION

data/lib/spree/backend.rb

@@ -3,6 +3,7 @@ require 'spree_api'
 
 require 'sprockets/railtie'
 
+require 'importmap-rails'
 require 'jquery-rails'
 require 'jquery-ui-rails'
 require 'select2-rails'
@@ -10,10 +11,11 @@ require 'flatpickr'
 require 'flag-icons-rails'
 require 'bootstrap'
 require 'glyphicons'
-require 'hotwire-rails'
+require 'turbo-rails'
+require 'stimulus-rails'
 require 'inline_svg'
-require 'jsbundling-rails'
 require 'responders'
+require 'requestjs-rails'
 require 'tinymce-rails'
 
 require 'spree/backend/action_callbacks'

data/lib/spree_backend.rb

@@ -2,7 +2,7 @@ require 'spree/backend'
 
 module Spree
   def self.admin_path
-    Spree::Backend::Config[:admin_path]
+    Spree::Backend::RuntimeConfig[:admin_path]
   end
 
   # Used to configure admin_path for Spree
@@ -13,6 +13,6 @@ module Spree
   #   Spree.admin_path = '/custom-path'
 
   def self.admin_path=(path)
-    Spree::Backend::Config[:admin_path] = path
+    Spree::Backend::RuntimeConfig[:admin_path] = path
   end
 end

data/license.md

@@ -1,13 +1,18 @@
-Spree License
+BSD 3-Clause License
 =============
 
-Copyright © 2007-2021, Spree Commerce Inc., Spark Solutions Sp. z o.o. and other contributors.
+Copyright © 2015-2024 Spark Solutions Sp. z o.o.
+
+Copyright © 2007-2015, Spree Commerce Inc.
+
 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._
+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/spree_backend.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   s.metadata = {
     "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/",
+    "documentation_uri" => "https://docs.spreecommerce.org/",
     "source_code_uri"   => "https://github.com/spree/spree_backend/tree/v#{s.version}",
   }
 
@@ -32,12 +32,14 @@ Gem::Specification.new do |s|
   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 'turbo-rails'
+  s.add_dependency 'stimulus-rails'
+  s.add_dependency 'importmap-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 'jquery-ui-rails', '>= 6', '< 8'
   s.add_dependency 'responders'
+  s.add_dependency 'requestjs-rails'
   s.add_dependency 'sass-rails',       '>= 5'
   s.add_dependency 'select2-rails',    '~> 4.0.6'
   s.add_dependency 'sprockets',        '~> 4.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spree_backend
 version: !ruby/object:Gem::Version
-  version: 4.7.2
+  version: 4.8.0
 platform: ruby
 authors:
 - Sean Schofield
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-05 00:00:00.000000000 Z
+date: 2024-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spree
@@ -96,7 +96,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: hotwire-rails
+  name: turbo-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: stimulus-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: importmap-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -141,18 +169,24 @@ dependencies:
   name: jquery-ui-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '8'
 - !ruby/object:Gem::Dependency
-  name: jsbundling-rails
+  name: responders
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -166,7 +200,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: responders
+  name: requestjs-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -255,6 +289,7 @@ files:
 - ".github/workflows/spelling_lint.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".solargraph.yml"
 - ".stylelintignore"
 - ".stylelintrc"
@@ -264,7 +299,6 @@ files:
 - Rakefile
 - SECURITY.md
 - app/assets/config/spree_backend_manifest.js
-- app/assets/images/admin/logo.png
 - app/assets/images/backend-123.svg
 - app/assets/images/backend-activity.svg
 - app/assets/images/backend-add.svg
@@ -1835,11 +1869,17 @@ files:
 - app/assets/images/backend-zoom-in.svg
 - app/assets/images/backend-zoom-out.svg
 - app/assets/images/credit_cards/credit_card.gif
+- app/assets/images/favicon.png
+- app/assets/images/favicon_dark_bg.png
+- app/assets/images/logo_dark.png
+- app/assets/images/logo_light.png
 - app/assets/images/noimage/backend-missing-image.svg
 - app/assets/images/noimage/large.png
 - app/assets/images/noimage/mini.png
 - app/assets/images/noimage/product.png
 - app/assets/images/noimage/small.png
+- app/assets/images/spark_solutions_logo.png
+- app/assets/images/vendo_logo.png
 - app/assets/javascripts/spree.js
 - app/assets/javascripts/spree/backend.js
 - app/assets/javascripts/spree/backend/address_states.es6
@@ -1868,6 +1908,7 @@ files:
 - app/assets/javascripts/spree/backend/global/side_scroll_indication.es6
 - app/assets/javascripts/spree/backend/global/sortable.es6
 - app/assets/javascripts/spree/backend/global/tinymce.es6
+- app/assets/javascripts/spree/backend/global/tooltips.es6
 - app/assets/javascripts/spree/backend/handlebar_extensions.js
 - app/assets/javascripts/spree/backend/line_items.js
 - app/assets/javascripts/spree/backend/line_items_on_order_edit.js
@@ -2016,16 +2057,17 @@ files:
 - app/helpers/spree/admin/stores_helper.rb
 - app/helpers/spree/admin/taxons_helper.rb
 - app/helpers/spree/admin/webhooks_subscribers_helper.rb
-- app/javascript/spree/dashboard/controllers/clipboard_controller.js
-- app/javascript/spree/dashboard/controllers/password_toggle_controller.js
-- app/javascript/spree/dashboard/controllers/product_edit_controller.js
-- app/javascript/spree/dashboard/controllers/sortable_tree_controller.js
-- app/javascript/spree/dashboard/controllers/spree_controller.js
-- app/javascript/spree/dashboard/controllers/upload_button_controller.js
-- app/javascript/spree/dashboard/controllers/webhooks_subscriber_events_controller.js
-- app/javascript/spree/dashboard/index.js
-- app/javascript/spree/dashboard/utilities/bootstrap.js
-- app/javascript/spree/dashboard/utilities/request_utility.js
+- app/javascript/spree/backend/application.js
+- app/javascript/spree/backend/controllers/clipboard_controller.js
+- app/javascript/spree/backend/controllers/index.js
+- app/javascript/spree/backend/controllers/password_toggle_controller.js
+- app/javascript/spree/backend/controllers/product_edit_controller.js
+- app/javascript/spree/backend/controllers/sortable_tree_controller.js
+- app/javascript/spree/backend/controllers/spree_controller.js
+- app/javascript/spree/backend/controllers/upload_button_controller.js
+- app/javascript/spree/backend/controllers/webhooks_subscriber_events_controller.js
+- app/javascript/spree/backend/helpers/index.js
+- app/javascript/spree/backend/helpers/request_utility.js
 - app/models/spree/admin/actions/action.rb
 - app/models/spree/admin/actions/action_builder.rb
 - app/models/spree/admin/actions/action_style.rb
@@ -2056,6 +2098,7 @@ files:
 - app/models/spree/admin/tabs/tab.rb
 - app/models/spree/admin/tabs/tab_builder.rb
 - app/models/spree/admin/tabs/user_default_tabs_builder.rb
+- app/models/spree/admin/updater.rb
 - app/views/kaminari/admin-twitter-bootstrap-4/_first_page.html.erb
 - app/views/kaminari/admin-twitter-bootstrap-4/_gap.html.erb
 - app/views/kaminari/admin-twitter-bootstrap-4/_last_page.html.erb
@@ -2275,6 +2318,7 @@ files:
 - app/views/spree/admin/shared/_sidebar.html.erb
 - app/views/spree/admin/shared/_store_switcher.html.erb
 - app/views/spree/admin/shared/_table_filter.html.erb
+- app/views/spree/admin/shared/_tabs.html.erb
 - app/views/spree/admin/shared/_translations.html.erb
 - app/views/spree/admin/shared/_update_order_state.js.erb
 - app/views/spree/admin/shared/_update_store_credit.js.erb
@@ -2403,6 +2447,7 @@ files:
 - app/views/spree/admin/zones/new.html.erb
 - app/views/spree/layouts/admin.html.erb
 - codespell.txt
+- config/importmap.rb
 - config/initializers/assets.rb
 - config/initializers/form_builder.rb
 - config/initializers/ransack.rb
@@ -2410,7 +2455,6 @@ files:
 - config/routes.rb
 - lib/generators/spree/backend/copy_views/copy_views_generator.rb
 - lib/generators/spree/backend/install/install_generator.rb
-- lib/generators/spree/backend/install/templates/app/javascript/spree-dashboard.js
 - lib/generators/spree/backend/install/templates/vendor/assets/javascripts/spree/backend/all.js
 - lib/generators/spree/backend/install/templates/vendor/assets/stylesheets/spree/backend/all.css
 - lib/spree/backend.rb
@@ -2418,14 +2462,13 @@ files:
 - lib/spree/backend/callbacks.rb
 - lib/spree/backend/configuration.rb
 - lib/spree/backend/engine.rb
+- lib/spree/backend/runtime_configuration.rb
 - lib/spree/backend/testing_support/capybara_utils.rb
 - lib/spree/backend/testing_support/flash.rb
 - lib/spree/backend/testing_support/flatpickr_capybara.rb
 - lib/spree/backend/version.rb
 - lib/spree_backend.rb
 - license.md
-- package.json
-- rollup.config.js
 - script/rails
 - spec/fixtures/files/favicon.ico
 - spec/fixtures/files/icon_512x512.png
@@ -2440,15 +2483,14 @@ files:
 - vendor/assets/javascripts/sweetalert2.js
 - vendor/assets/javascripts/underscore-min.js
 - vendor/assets/stylesheets/animate.css
-- yarn.lock
 homepage: https://spreecommerce.org
 licenses:
 - BSD-3-Clause
 metadata:
   bug_tracker_uri: https://github.com/spree/spree_backend/issues
-  changelog_uri: https://github.com/spree/spree_backend/releases/tag/v4.7.2
-  documentation_uri: https://dev-docs.spreecommerce.org/
-  source_code_uri: https://github.com/spree/spree_backend/tree/v4.7.2
+  changelog_uri: https://github.com/spree/spree_backend/releases/tag/v4.8.0
+  documentation_uri: https://docs.spreecommerce.org/
+  source_code_uri: https://github.com/spree/spree_backend/tree/v4.8.0
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -2465,7 +2507,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - none
-rubygems_version: 3.4.1
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Admin Dashboard for Spree eCommerce platform

data/app/javascript/spree/dashboard/index.js

@@ -1,54 +0,0 @@
-//
-// Initialize Dashboard
-class Dashboard {
-  constructor() {
-    console.log("Spree Dashboard Initialized")
-  }
-}
-
-if (!window.Turbo) {
-  console.warn("Please import '@hotwired/turbo-rails' before '@spree/dashboard' to use Rails Turbo within the Spree Dashboard environment.")
-}
-
-//
-// Import JavaScript packages that are required globally.
-import { Application } from "@hotwired/stimulus"
-import flatpickr from "flatpickr"
-
-//
-// Import Utility JavaScript required globally.
-import "./utilities/bootstrap"
-
-//
-// Stimulus - Setup
-const application = Application.start()
-application.debug = false
-window.Stimulus = application
-
-// Stimulus - Spree Controllers
-import UploadButtonController from "./controllers/upload_button_controller"
-application.register("upload-button", UploadButtonController)
-
-import SpreeController from "./controllers/spree_controller"
-application.register("spree", SpreeController)
-
-import SortableTreeController from "./controllers/sortable_tree_controller"
-application.register("sortable-tree", SortableTreeController)
-
-import WebhooksSubscriberEventsController from "./controllers/webhooks_subscriber_events_controller"
-application.register("webhooks_subscriber_events", WebhooksSubscriberEventsController)
-
-import PasswordToggleController from "./controllers/password_toggle_controller"
-application.register("password-toggle", PasswordToggleController)
-
-import ClipboardController from "./controllers/clipboard_controller"
-application.register("clipboard", ClipboardController)
-
-import ProductEditController from "./controllers/product_edit_controller"
-application.register("product-edit", ProductEditController)
-
-import * as RequestUtility from "./utilities/request_utility"
-
-//
-// Export
-export { Dashboard, application, flatpickr, RequestUtility }

data/app/javascript/spree/dashboard/utilities/bootstrap.js

@@ -1,17 +0,0 @@
-import jquery from 'jquery'
-import 'bootstrap'
-import 'popper.js'
-
-const $ = jquery
-
-document.addEventListener("spree:load", function() {
-  $('.with-tip').each(function() {
-    $(this).tooltip({ container: 'body' })
-  })
-
-  $('.with-tip').on('show.bs.tooltip', function(event) {
-    if (('ontouchstart' in window)) {
-      event.preventDefault()
-    }
-  })
-})

data/lib/generators/spree/backend/install/templates/app/javascript/spree-dashboard.js

@@ -1,6 +0,0 @@
-// Entry point for the build script in your package.json
-
-import "./application" // Load the default rails Turbo setup from application.js
-import "@spree/dashboard"
-
-new SpreeDashboard.Dashboard()

data/package.json

@@ -1,46 +0,0 @@
-{
-  "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

@@ -1,43 +0,0 @@
-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)
-    ]
-  }
-]