solidus_admin 0.0.0 → 0.0.1

data/app/components/solidus_admin/ui/toast/component.yml

@@ -0,0 +1,4 @@
+en:
+  default_label: Information
+  error_label: Error
+  close_text: "Close"

data/app/components/solidus_admin/ui/toggletip/component.html.erb

@@ -0,0 +1,53 @@
+<details
+  data-controller="<%= stimulus_id %>"
+  <%= tag.attributes(**@attributes) %>
+>
+  <summary
+    type="button"
+    class="
+      block
+      w-[1rem]
+      h-[1rem]
+      cursor-pointer
+      [&::marker]:hidden
+      [&::-webkit-details-marker]:hidden
+    "
+    data-<%= stimulus_id %>-target="button"
+    data-action="
+      click:prevent-><%= stimulus_id %>#toggle
+      keydown.esc@window-><%= stimulus_id %>#close
+    "
+    aria-label="<%= t('.get_help') %>"
+  >
+    <%= icon_tag("question-fill", class: "w-[1rem] h-[1rem] #{icon_theme_classes}") %>
+  </summary>
+
+  <div
+    class="
+      absolute
+      inline-block
+      w-[9rem]
+      px-[0.75rem]
+      body-tiny-bold
+      rounded
+      z-10
+      <%= bubble_position_classes %>
+      <%= bubble_theme_classes %>
+    "
+    data-<%= stimulus_id %>-target="bubble"
+  >
+    <span
+      role="status"
+      class="
+        relative
+        block
+        bg-inherit
+        py-[0.5rem]
+        <%= bubble_arrow_pseudo_element %>
+      "
+      data-<%= stimulus_id %>-target="content"
+    >
+      <%= @text %>
+    </span>
+  </div>
+</details>

data/app/components/solidus_admin/ui/toggletip/component.js

@@ -0,0 +1,26 @@
+import { Controller } from '@hotwired/stimulus'
+import { useClickOutside } from 'stimulus-use'
+
+export default class extends Controller {
+  static targets = ['button', 'bubble', 'content']
+
+  connect () {
+    useClickOutside(this)
+  }
+
+  clickOutside () {
+    this.close()
+  }
+
+  toggle (e) {
+    this.element.open = !this.element.open
+  }
+
+  open () {
+    this.element.open = true
+  }
+
+  close () {
+    this.element.open = false
+  }
+}

data/app/components/solidus_admin/ui/toggletip/component.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+class SolidusAdmin::UI::Toggletip::Component < SolidusAdmin::BaseComponent
+  # Icon size: 1rem
+  # Arrow size: 0.375rem
+  # Banner padding x: 0.75rem
+  POSITIONS = {
+    up: {
+      arrow: %w[before:top-0 before:left-1/2 before:translate-y-[-50%] before:translate-x-[-50%]],
+      bubble: %w[translate-x-[calc(-50%+(1rem/2))] translate-y-[calc(0.375rem/2)]]
+    },
+    up_right: {
+      arrow: %w[before:top-0 before:right-0 before:translate-y-[-50%]],
+      bubble: %w[translate-x-[calc(-100%+0.75rem+(1rem/2)+(0.375rem/2))] translate-y-[calc(0.375rem/2)]]
+    },
+    right: {
+      arrow: %w[before:top-1/2 before:right-0 before:translate-y-[-50%] before:translate-x-[0.93rem]],
+      bubble: %w[translate-x-[calc(-100%+(-0.375rem/2))] translate-y-[calc(-50%-(1rem/2))]]
+    },
+    down_right: {
+      arrow: %w[before:bottom-0 before:right-0 before:translate-y-[50%]],
+      bubble: %w[translate-x-[calc(-100%+0.75rem+(1rem/2)+(0.376rem/2))] translate-y-[calc(-100%-1rem-(0.375rem/2))]]
+    },
+    down: {
+      arrow: %w[before:bottom-0 before:left-1/2 before:translate-y-[50%] before:translate-x-[-50%]],
+      bubble: %w[translate-x-[calc(-50%+(1rem/2))] translate-y-[calc(-100%-1rem-(0.375rem/2))]]
+    },
+    down_left: {
+      arrow: %w[before:bottom-0 before:left-0 before:translate-y-[50%]],
+      bubble: %w[translate-x-[calc(-1rem/2)] translate-y-[calc(-100%-0.75rem-0.375rem)]]
+    },
+    left: {
+      arrow: %w[before:top-1/2 before:left-0 before:translate-y-[-50%] before:translate-x-[-0.93rem]],
+      bubble: %w[translate-x-[calc(1rem+(0.375rem/2))] translate-y-[calc(-50%-(1rem/2))]]
+    },
+    up_left: {
+      arrow: %w[before:top-0 before:left-0 before:translate-y-[-50%]],
+      bubble: %w[translate-x-[calc(-0.75rem+0.375rem)] translate-y-[calc(0.375rem/2)]]
+    },
+    none: {
+      arrow: %w[before:hidden],
+      bubble: %w[translate-x-[calc(-50%+0.75rem)]]
+    }
+  }.freeze
+
+  THEMES = {
+    light: {
+      icon: %w[fill-gray-500],
+      bubble: %w[text-gray-800 bg-gray-50]
+    },
+    dark: {
+      icon: %w[fill-gray-800],
+      bubble: %w[text-white bg-gray-800]
+    }
+  }.freeze
+
+  # @param text [String] The toggletip text
+  # @param position [Symbol] The position of the arrow in relation to the
+  #   toggletip. The latter will be positioned accordingly in relation to the
+  #   help icon. Defaults to `:up`. See `POSITIONS` for available options.
+  # @param theme [Symbol] The theme of the toggletip. Defaults to `:light`. See
+  #   `THEMES` for available options.
+  def initialize(text:, position: :down, theme: :light, **attributes)
+    @text = text
+    @position = position
+    @theme = theme
+    @attributes = attributes
+    @attributes[:class] = [
+      "relative inline-block",
+      @attributes[:class],
+    ].join(" ")
+  end
+
+  def icon_theme_classes
+    THEMES.fetch(@theme)[:icon].join(" ")
+  end
+
+  def bubble_theme_classes
+    THEMES.fetch(@theme)[:bubble].join(" ")
+  end
+
+  def bubble_position_classes
+    POSITIONS.fetch(@position)[:bubble].join(" ")
+  end
+
+  def bubble_arrow_pseudo_element
+    (
+      [
+        "before:content['']",
+        "before:absolute",
+        "before:w-[0.375rem]",
+        "before:h-[0.375rem]",
+        "before:rotate-45",
+        "before:bg-inherit",
+      ] + POSITIONS.fetch(@position)[:arrow]
+    ).join(" ")
+  end
+end

data/app/components/solidus_admin/ui/toggletip/component.yml

@@ -0,0 +1,2 @@
+en:
+  get_help: "Get help"

data/app/controllers/solidus_admin/accounts_controller.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module SolidusAdmin
+  class AccountsController < SolidusAdmin::BaseController
+    skip_before_action :authorize_solidus_admin_user!
+
+    def show
+      redirect_to spree.edit_admin_user_path(current_solidus_admin_user)
+    end
+  end
+end

data/app/controllers/solidus_admin/authentication_adapters/backend.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module SolidusAdmin::AuthenticationAdapters::Backend
+  extend ActiveSupport::Concern
+
+  included do
+    delegate :admin_logout_path, to: :spree
+    helper_method :admin_logout_path
+  end
+
+  private
+
+  def authenticate_solidus_backend_user!
+    return if spree_current_user
+
+    instance_exec(&Spree::Admin::BaseController.unauthorized_redirect)
+  end
+
+  def store_location
+    Spree::UserLastUrlStorer.new(self).store_location
+  end
+
+  def spree_current_user
+    defined?(super) ? super : nil
+  end
+end

data/app/controllers/solidus_admin/base_controller.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'geared_pagination'
+
+module SolidusAdmin
+  class BaseController < ApplicationController
+    include ActiveStorage::SetCurrent
+    include Spree::Core::ControllerHelpers::Store
+    include GearedPagination::Controller
+
+    include SolidusAdmin::ControllerHelpers::Authentication
+    include SolidusAdmin::ControllerHelpers::Authorization
+    include SolidusAdmin::ControllerHelpers::Locale
+    include SolidusAdmin::ComponentsHelper
+    include SolidusAdmin::AuthenticationAdapters::Backend if defined?(Spree::Backend)
+
+    layout 'solidus_admin/application'
+    helper 'solidus_admin/components'
+    helper 'solidus_admin/layout'
+  end
+end

data/app/controllers/solidus_admin/controller_helpers/authentication.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module SolidusAdmin::ControllerHelpers::Authentication
+  extend ActiveSupport::Concern
+
+  included do
+    before_action :authenticate_solidus_admin_user!
+
+    helper_method :current_solidus_admin_user
+    helper_method :solidus_admin_logout_path
+    helper_method :solidus_admin_logout_method
+  end
+
+  private
+
+  def authenticate_solidus_admin_user!
+    send SolidusAdmin::Config.authentication_method if SolidusAdmin::Config.authentication_method
+  end
+
+  def current_solidus_admin_user
+    send SolidusAdmin::Config.current_user_method if SolidusAdmin::Config.current_user_method
+  end
+
+  def solidus_admin_logout_path
+    SolidusAdmin::Config.logout_link_path
+  end
+
+  def solidus_admin_logout_method
+    SolidusAdmin::Config.logout_link_method
+  end
+end

data/app/controllers/solidus_admin/controller_helpers/authorization.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module SolidusAdmin::ControllerHelpers::Authorization
+  extend ActiveSupport::Concern
+
+  included do
+    before_action :authorize_solidus_admin_user!
+  end
+
+  private
+
+  def current_ability
+    @current_ability ||= Spree::Ability.new(current_solidus_admin_user)
+  end
+
+  def authorize_solidus_admin_user!
+    subject = authorization_subject
+
+    authorize! :admin, subject
+    authorize! action_name, subject
+  end
+
+  def authorization_subject
+    "Spree::#{controller_name.classify}".constantize
+  rescue NameError
+    raise NotImplementedError, "Couldn't infer the model class from the controller name, " \
+      "please implement `#{self.class}#authorization_subject`."
+  end
+end

data/app/controllers/solidus_admin/controller_helpers/locale.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module SolidusAdmin::ControllerHelpers::Locale
+  extend ActiveSupport::Concern
+  include Spree::Admin::SetsUserLanguageLocaleKey
+
+  included do
+    before_action :set_locale
+    before_action :update_user_locale
+  end
+
+  private
+
+  def update_user_locale
+    requested_locale = params[:switch_to_locale] or return
+
+    if requested_locale.to_sym != user_locale
+      session[set_user_language_locale_key] = requested_locale
+
+      flash[:notice] = t('spree.locale_changed')
+      redirect_to url_for(request.params.except(:switch_to_locale))
+    end
+  end
+
+  def user_locale
+    session[set_user_language_locale_key] || I18n.default_locale
+  end
+
+  def set_locale
+    I18n.locale = user_locale
+  end
+end

data/app/controllers/solidus_admin/orders_controller.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module SolidusAdmin
+  class OrdersController < SolidusAdmin::BaseController
+    def index
+      orders = Spree::Order
+        .order(created_at: :desc, id: :desc)
+        .ransack(params[:q])
+        .result(distinct: true)
+
+      set_page_and_extract_portion_from(
+        orders,
+        per_page: SolidusAdmin::Config[:orders_per_page]
+      )
+
+      respond_to do |format|
+        format.html { render component('orders/index').new(page: @page) }
+      end
+    end
+  end
+end

data/app/controllers/solidus_admin/products_controller.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module SolidusAdmin
+  class ProductsController < SolidusAdmin::BaseController
+    def edit
+      redirect_to action: :show
+    end
+
+    def show
+      @product = Spree::Product.friendly.find(params[:id])
+
+      respond_to do |format|
+        format.html { render component('products/show').new(product: @product) }
+      end
+    end
+
+    def update
+      @product = Spree::Product.friendly.find(params[:id])
+
+      if @product.update(params.require(:product).permit!)
+        flash[:success] = t('spree.successfully_updated', resource: [
+          Spree::Product.model_name.human,
+          @product.name.inspect,
+        ].join(' '))
+
+        redirect_to action: :show, status: :see_other
+      else
+        flash.now[:error] = @product.errors.full_messages.join(", ")
+
+        respond_to do |format|
+          format.html { render component('products/show').new(product: @product), status: :unprocessable_entity }
+        end
+      end
+    end
+
+    def index
+      products = Spree::Product
+        .order(created_at: :desc, id: :desc)
+        .ransack(params[:q])
+        .result(distinct: true)
+
+      set_page_and_extract_portion_from(
+        products,
+        per_page: SolidusAdmin::Config[:products_per_page]
+      )
+
+      respond_to do |format|
+        format.html { render component('products/index').new(page: @page) }
+      end
+    end
+
+    def destroy
+      @products = Spree::Product.where(id: params[:id])
+
+      Spree::Product.transaction do
+        @products.discard_all
+      end
+
+      flash[:notice] = t('.success')
+      redirect_to products_path, status: :see_other
+    end
+
+    def discontinue
+      @products = Spree::Product.where(id: params[:id])
+
+      Spree::Product.transaction do
+        @products
+          .update_all(discontinue_on: Time.current)
+      end
+
+      flash[:notice] = t('.success')
+      redirect_to products_path, status: :see_other
+    end
+
+    def activate
+      @products = Spree::Product.where(id: params[:id])
+
+      Spree::Product.transaction do
+        @products
+          .where.not(discontinue_on: nil)
+          .update_all(discontinue_on: nil)
+
+        @products
+          .where("available_on <= ?", Time.current)
+          .or(@products.where(available_on: nil))
+          .update_all(discontinue_on: nil)
+      end
+
+      flash[:notice] = t('.success')
+      redirect_to products_path, status: :see_other
+    end
+  end
+end

data/app/helpers/solidus_admin/components_helper.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module SolidusAdmin
+  module ComponentsHelper
+    def component(name)
+      SolidusAdmin::Config.components[name]
+    end
+  end
+end

data/app/helpers/solidus_admin/layout_helper.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module SolidusAdmin
+  # Helpers for the admin layout
+  module LayoutHelper
+    # @return [Symbol]
+    def current_locale(backend: I18n)
+      backend.locale
+    end
+
+    # @param store_name [String]
+    # @param controller_name [String]
+    # @return [String] HTML title
+    def solidus_admin_title(store_name: current_store.name, controller_name: self.controller_name)
+      "#{store_name} - #{t("solidus_admin.#{controller_name}.title")}"
+    end
+  end
+end

data/app/javascript/solidus_admin/application.js

@@ -0,0 +1,2 @@
+import "@hotwired/turbo-rails"
+import "solidus_admin/controllers"

data/app/javascript/solidus_admin/controllers/application.js

@@ -0,0 +1,9 @@
+import { Application } from "@hotwired/stimulus"
+
+const application = Application.start()
+
+// Configure Stimulus development experience
+application.debug = location.hostname === "localhost"
+window.Stimulus   = application
+
+export { application }

data/app/javascript/solidus_admin/controllers/components.js

@@ -0,0 +1,35 @@
+import "@hotwired/stimulus"
+
+const registeredControllers = {}
+
+// Eager load all controllers registered beneath the `under` path in the import map to the passed application instance.
+export function eagerLoadComponents(application, { under, suffix }) {
+  const paths = Object.keys(parseImportmapJson()).filter((path) => path.match(new RegExp(`^${under}/.*${suffix}$`)))
+  paths.forEach((path) => registerComponent(path, under, application, suffix))
+}
+
+function parseImportmapJson() {
+  return JSON.parse(document.querySelector("script[type=importmap]").text).imports
+}
+
+function registerComponent(path, under, application, suffix) {
+  const name = path
+    .replace(new RegExp(`^${under}/(.*)${suffix}$`), '$1')
+    .replace(/\//g, "--")
+    .replace(/_/g, "-")
+
+  application.logDebugActivity(name, 'registerComponent', { path, under, suffix })
+
+  if (!(name in registeredControllers)) {
+    import(path)
+      .then(module => registerController(name, module, application))
+      .catch(error => console.error(`Failed to register controller: ${name} (${path})`, error))
+  }
+}
+
+function registerController(name, module, application) {
+  if (!(name in registeredControllers)) {
+    application.register(name, module.default)
+    registeredControllers[name] = true
+  }
+};

data/app/javascript/solidus_admin/controllers/hello_controller.js

@@ -0,0 +1,7 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  greet() {
+    console.log(`Hello World! ${new Date()}`)
+  }
+}

data/app/javascript/solidus_admin/controllers/index.js

@@ -0,0 +1,14 @@
+// Import and register all your controllers from the importmap under controllers/*
+
+import { application } from "solidus_admin/controllers/application"
+
+// Eager load all controllers defined in the import map under controllers/**/*_controller
+import { eagerLoadControllersFrom } from "@hotwired/stimulus-loading"
+eagerLoadControllersFrom("solidus_admin/controllers", application)
+
+// Lazy load controllers as they appear in the DOM (remember not to preload controllers in import map!)
+// import { lazyLoadControllersFrom } from "@hotwired/stimulus-loading"
+// lazyLoadControllersFrom("controllers", application)
+
+import { eagerLoadComponents } from "solidus_admin/controllers/components"
+eagerLoadComponents(application, { under: "solidus_admin", suffix: "/component" })

data/app/javascript/solidus_admin/utils.js

@@ -0,0 +1,8 @@
+export const debounce = (func, wait) => {
+  let timeout
+
+  return () => {
+    clearTimeout(timeout)
+    timeout = setTimeout(func, wait)
+  }
+}

data/app/views/layouts/solidus_admin/application.html.erb

@@ -0,0 +1,30 @@
+<!DOCTYPE html>
+<html lang="<%= current_locale %>">
+  <head>
+    <%= favicon_link_tag 'solidus_admin/favicon.ico' %>
+    <title><%= solidus_admin_title %></title>
+    <%= stylesheet_link_tag "solidus_admin/application.css", "inter-font", "data-turbo-track": "reload" %>
+    <%= javascript_importmap_tags "solidus_admin/application", shim: false, importmap: SolidusAdmin.importmap %>
+  </head>
+
+  <body class="bg-gray-15">
+    <%= render component("skip_link").new(href: "#main") %>
+    <div class="fixed right-3 bottom-3 flex flex-col gap-3" role="alert">
+      <% flash.each do |key, message| %>
+        <%= render component("ui/toast").new(text: message, scheme: key == :error ? :error : :default) %>
+      <% end %>
+    </div>
+
+    <div class="flex gap-0">
+      <div class="min-w-[240px] border-r border-r-gray-100 relative">
+        <div class="min-h-screen top-0 sticky flex">
+          <%= render component("sidebar").new(store: current_store) %>
+        </div>
+      </div>
+
+      <main id="main" class="flex-grow">
+        <%= yield %>
+      </main>
+    </div>
+  </body>
+</html>

data/app/views/layouts/solidus_admin/preview.html.erb

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <%= stylesheet_link_tag "solidus_admin/application.css", "inter-font", "data-turbo-track": "reload" %>
+    <%= javascript_importmap_tags "solidus_admin/application", shim: false, importmap: SolidusAdmin.importmap %>
+  </head>
+  <body class="p-3">
+    <%= yield %>
+  </body>
+</html>

data/bin/rails

@@ -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_admin/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/config/importmap.rb

@@ -0,0 +1,13 @@
+# Remember to restart your application after editing this file.
+
+# Stimulus & Turbo
+pin "@hotwired/stimulus", to: "stimulus.js"
+pin "@hotwired/stimulus-loading", to: "stimulus-loading.js"
+pin "@hotwired/turbo-rails", to: "turbo.js"
+
+pin "stimulus-use", to: "https://ga.jspm.io/npm:stimulus-use@0.52.0/dist/index.js"
+
+pin "solidus_admin/application", preload: true
+pin "solidus_admin/utils"
+pin_all_from SolidusAdmin::Engine.root.join("app/javascript/solidus_admin/controllers"), under: "solidus_admin/controllers"
+pin_all_from SolidusAdmin::Engine.root.join("app/components")

data/config/locales/main_nav.en.yml

@@ -0,0 +1,13 @@
+en:
+  solidus_admin:
+    main_nav:
+      orders: Orders
+      products: Products
+      option_types: Option Types
+      property_types: Property Types
+      taxonomies: Taxonomies
+      taxons: Display Order
+      promotions: Promotions
+      stock: Stock
+      users: Users
+      settings: Settings

data/config/locales/orders.en.yml

@@ -0,0 +1,4 @@
+en:
+  solidus_admin:
+    orders:
+      title: "Orders"