spree_admin 5.0.0.rc1

data/config/locales/en.yml

@@ -0,0 +1,304 @@
+---
+en:
+  spree:
+    admin:
+      active: Active
+      amount_spent: Amount spent
+      audit_log: Audit Log
+      avg_order_value: Avg. Order Value
+      back_to_dashboard: Back to Dashboard
+      bulk_ops:
+        products:
+          body:
+            add_tags: 'Select tags to add to the products:'
+            add_to_brand: 'Select which brand to add the products to:'
+            add_to_taxons: 'Select which taxons to add the products to:'
+            remove_from_taxons: 'Select which taxons to remove the products from:'
+            remove_tags: 'Select tags to remove from the products:'
+            set_return_rule: Select return rule for products
+            set_status:
+              active: Setting products to active will make those products available on the storefront.
+              archived: Setting products to archived will hide them from storefront.
+              draft: Setting products to draft will hide them from storefront.
+              ready_for_review: We will notify your partners that these products are ready for review. Your partners will be able to review and publish these products.
+          status_updated: Status updated
+          title:
+            add_tags: Add tags
+            add_to_brand: Add to brand
+            add_to_taxons: Add to taxons
+            remove_from_brand: Remove from brand
+            remove_from_taxons: Remove from taxons
+            remove_tags: Remove tags
+            set_return_rule: Set Return Rule
+            set_size_chart: Set Size Chart
+            set_status: Set as %{status}
+        users:
+          body:
+            add_tags: 'Select tags to add to the customers:'
+            remove_tags: 'Select tags to remove from the customers:'
+          title:
+            add_tags: Add tags
+            remove_tags: Remove tags
+      checkout_settings:
+        checkout_message_description: Visible to your customers on the checkout page in the right sidebar.
+        guest_checkout:
+          description: Allow customers to checkout without creating an account.
+          label: Allow guest checkout
+        policy_copy: Checkout footer links are added automatically based on the %{policies_link} content.
+      copied: Copied!
+      copy_payment_link: Copy Payment Link
+      copy_to_clipboard: Copy to clipboard
+      coupon_codes:
+        unused: Unused
+        used: Used
+      created_at: Created At
+      dashboard:
+        getting_started:
+          description: Everything you need to set up to start selling.
+        hi: Hi
+        top_products: Top products
+        view_report: View report
+        whats_happening_on: Here's what's happening on <strong>%{store_name}</strong> today.
+      digital_shipment_fulfillment_note: This shipment will be marked as fulfilled once the user downloads the digital product
+      display_on_options:
+        back_end: Only on admin panel
+        both: On both admin panel & storefront
+        front_end: Only on storefront
+      edit_billing_address: Edit billing address
+      edit_contact_information: Edit contact information
+      edit_profile: Edit Profile
+      edit_shipping_address: Edit shipping address
+      edit_theme: Edit theme
+      errors: Errors
+      execution_time: Execution Time
+      export_all: Export all records (can be slow for large datasets)
+      export_created: Your export was started. You will receive an email with a download link when it is ready!
+      export_only_filtered_records: Export only filtered records, matching the search criteria
+      filters: Filters
+      getting_started: Getting started
+      manage_currencies: Manage Currencies
+      manage_properties: Manage Properties
+      manage_stock_locations: Manage Stock Locations
+      manage_taxons: Manage Taxons
+      manage_zones: Manage Zones
+      member_since: Member since
+      name: Name
+      navigation:
+        nested_under: Nested under
+      not_tracking_inventory: Not tracking inventory
+      notifications: Notifications
+      num_orders: No. of Orders
+      oauth_applications:
+        last_used: Last used
+        list: API keys
+        never: Never
+        new: New API key
+        read_and_write: Read & Write
+        read_only: Read Only
+        scopes: Scopes
+      order:
+        events:
+          approve: Approve
+          cancel: Cancel
+          resend: Resend
+          resume: Resume
+      orders:
+        add_user_to_this_order: Add customer to this order
+        all_orders: All Orders
+        canceled: Canceled
+        fulfilled: Fulfilled
+        no_email_present: Please add an email address to send the payment link
+        orders_to_fulfill: Orders to fulfill
+        partially_refunded: Partially Refunded
+        payment_link_sent: Payment link was sent to the customer
+        refunded: Refunded
+        remove_user_from_this_order: Remove customer from this order
+        unfulfilled: Unfulfilled
+      page_builder:
+        background_color: Background color
+        border_bottom_width: Border bottom width
+        border_color: Border color
+        border_top_width: Border top width
+        bottom_padding: Bottom padding
+        button_alignment: Button alignment
+        button_background_color: Button background color
+        button_style: Button style
+        button_text: Button's text
+        button_text_color: Button text color
+        category: Category
+        description: Description
+        description_alignment: Description alignment
+        desktop_image_alignment: Image alignment for desktop
+        desktop_logo_height: Logo height (desktop)
+        heading: Heading
+        heading_alignment: Heading alignment
+        heading_size: Heading size
+        height: Height
+        left_aligned: Left aligned
+        logo_centered: Logo centered
+        max_video_width_on_desktop: Max video width on desktop
+        maximum_posts_to_show: Maximum posts to show
+        maximum_products_to_show: Maximum products to show
+        nav_centered: Nav centered
+        not_set: Not set
+        posts_to_show: Posts to show
+        separated: Separated
+        show_more_button: Show explore category button
+        show_taxon_image: Show taxon image
+        text_color: Text color
+        title: Title
+        top_padding: Top padding
+        use_description_from_admin: Use description from admin
+        vertical_alignment: Vertical alignment
+        youtube_video_url: Youtube video URL
+      personal_details: Personal Details
+      products:
+        active: Active
+        all_statuses: All statuses
+        any_stock: Any stock
+        archived: Archived
+        by_status: By status
+        by_stock: By stock
+        deleted: Deleted
+        draft: Draft
+        help_bubble: Draft & Ready for Review statuses mean that the product isn't available for purchase. Active means that the product is live. Vendors can move product from draft to ready for review, but only marketplace operators can move product from ready for review to active
+        in_stock: In Stock
+        inventory:
+          barcode: Barcode (ISBN, UPC, GTIN, etc.)
+          sku: SKU (Stock Keeping Unit)
+        out_of_stock: Out of Stock
+        paused: Paused
+        search_results:
+          no_products: We couldn't find any products matching your search :(
+        selected: products selected
+        seo:
+          placeholder: Add a title and description to see how this product might appear in a search engine listing
+        status_form:
+          available_on: Marks when the product will be released, put a future date to indicate that this is a pre-order
+          discontinue_on: Marks when the product should be automatically taken off from your site
+          make_active_at: Marks when the product should be automatically promoted to "active" state
+          status: Draft - initial status. Ready For Review - inform store owner that product can be checked before activation
+        stores:
+          choose_stores: Choose which stores this product should be available in
+        variants:
+          option_types_link: To add more option types please go to <a href="%{link}">Option Types</a>
+      report_created: Your report is being generated. You will receive an email with a download link when it is ready!
+      reset_digital_link_download_limits: Reset download limits
+      response_code: Response Code
+      send_payment_link: Send Payment Link
+      shipment_transfer:
+        wrong_destination: Wrong destination
+      stock_transfers:
+        add_products_tip: You need to select a destination location first
+      store_credit:
+        amount_remaining_of_total: "<strong>%{amount}</strong> remaining (<strong>%{total}</strong> total)"
+      store_form:
+        customer_support_email_help: This email is visible to your Store visitors in the Footer section
+        new_order_notifications_email_help: If you want to receive an email notification every time someone places an Order please provide an email address for that notification to be sent to
+      store_setup_tasks:
+        add_billing_address: Add billing address
+        add_products: Add products
+        payment_methods:
+          copy: In order to collect payments, please setup at least one online payment provider.
+          done: You're all set! You can always manage your Payment Methods on <a href="%{link}" data-turbo-frame="_top">this</a> page.
+          setup: Setup Payment Methods
+          title: Please setup Payment Methods for your store
+        set_customer_support_email: Set customer support email
+        setup_taxes_collection: Setup taxes collection
+        taxes:
+          copy: In order to collect taxes, please setup your tax rates.
+          done: You're all set! You can always manage your taxes on the <a href="%{link}" data-turbo-frame="_top">settings</a> page.
+          setup: Setup Tax Rates
+      storefront: Storefront
+      successful: Successful
+      successfully_reset_digital_links_limit: Download limits have been reset
+      taxon_rules:
+        all_conditions: all conditions
+        any_condition: any condition
+        available_on: Available on
+        match_policies:
+          contains: contains
+          does_not_contain: does not contain
+          is_equal_to: is equal to
+          is_not_equal_to: is not equal to
+        on_sale: On sale
+        products_must_match: 'Products must match:'
+        tag: Product tag
+      taxon_type: Taxon type
+      taxon_types:
+        automatic: Automatic
+        automatic_info: Automatically match products to this taxon based on the conditions you set.
+        manual: Manual
+        manual_info: Curate products manually. You can add or remove them in bulk.
+      upload_new_asset: Upload new asset
+      url: URL
+      user:
+        last_order_placed: Last order placed
+        no_store_credit: Customer has no Store Credit available
+      users:
+        filters:
+          search_placeholder: Search customers by email or name
+      utilities:
+        preview: Preview
+      variants:
+        search_results:
+          no_variants: We couldn't find any variants matching your search :(
+      variants_form:
+        add_option:
+          empty: Add options like size or color
+          not_empty: Add another option
+        compare_at_price_description: This price is used to show marked down price on the product page.
+        stock_locations_link: To add more stock locations please go to <a href="%{link}">Stock Locations</a>
+        total_inventory_html: 'Total inventory at %{stock_location} location: %{count} available'
+      webhooks_subscribers:
+        addresses: Addresses
+        all_events: All Events
+        assets: Assets
+        credit_cards: Credit Cards
+        customer_returns: Customer Returns
+        digital_links: Digital Links
+        digitals: Digitals
+        inventory_units: Inventory Units
+        line_items: Line Items
+        new_webhooks_subscriber: New Webhooks Subscriber
+        no_events: No Events
+        option_types: Option Types
+        option_values: Option Values
+        orders: Orders
+        payment_capture_events: Payment Capture Events
+        payments: Payments
+        prices: Prices
+        products: Products
+        promotions: Promotions
+        properties: Properties
+        prototypes: Prototypes
+        refunds: Refunds
+        reimbursements: Reimbursements
+        return_authorizations: Return Authorizations
+        return_items: Return Items
+        roles: Roles
+        select_events: Select events
+        shipment_transfer:
+          wrong_destination: Selected location is not a valid destination
+        shipments: Shipments
+        shipping_categories: Shipping Categories
+        shipping_methods: Shipping Methods
+        shipping_rates: Shipping Rates
+        stock_items: Stock Items
+        stock_locations: Stock Locations
+        stock_movements: Stock Movements
+        stock_transfers: Stock Transfers
+        store_credits: Store Credits
+        stores: Stores
+        subscribe_to_all_events: Subscribe to all events
+        subscriptions: Subscriptions
+        tax_rates: Tax Rates
+        taxonomies: Taxonomies
+        taxons: Taxons
+        time_of_last_event: Time of Last Event
+        variants: Variants
+        webhooks_events: Webhooks Events
+        webhooks_subscribers: Webhooks Subscribers
+        wished_items: Wished Items
+        wishlists: Wishlists
+        zones: Zones

data/config/routes.rb

@@ -0,0 +1,240 @@
+Spree::Core::Engine.add_routes do
+  namespace :admin, path: Spree.admin_path do
+    # product catalog
+    resources :properties, except: :show
+    resources :option_types, except: :show do
+      resources :option_values, only: [:update] do
+        collection do
+          get :select_options
+        end
+      end
+    end
+    resources :products do
+      collection do
+        get :select_options, defaults: { format: :json }
+        post :search
+        get :bulk_modal
+        put :bulk_status_update
+        put :bulk_add_to_taxons
+        put :bulk_remove_from_taxons
+        put :bulk_add_tags
+        put :bulk_remove_tags
+      end
+      member do
+        post :clone
+      end
+      resources :variants, only: [:edit, :update, :destroy]
+      resources :digital_assets, except: [:show]
+    end
+    # variant search
+    post 'variants/search'
+    get 'variants/search', defaults: { format: :json }
+    # stock
+    resources :stock_items, only: [:index, :update, :destroy]
+    resources :stock_transfers, except: [:edit, :update]
+    # taxonomies and taxons
+    resources :taxonomies do
+      resources :taxons do
+        member do
+          put :reposition
+        end
+      end
+    end
+    resources :taxons, except: [:show] do |_taxon|
+      resources :classifications, only: %i[index new create update destroy]
+    end
+    get '/taxons/select_options' => 'taxons#select_options', as: :taxons_select_options, defaults: { format: :json }
+
+    # media library
+    resources :assets, only: [:create, :edit, :update, :destroy] do
+      collection do
+        delete :bulk_destroy
+      end
+    end
+
+    # orders
+    resources :checkouts, only: %i[index]
+    resources :orders, only: [:index, :edit, :create] do
+      member do
+        post :resend
+        put :cancel
+      end
+      resource :shipping_address, except: [:index, :show], controller: 'orders/shipping_address'
+      resource :billing_address, except: [:index, :show], controller: 'orders/billing_address'
+      resource :contact_information, only: [:edit, :update], controller: 'orders/contact_information'
+      resource :user, except: [:edit, :show, :index], controller: 'orders/user'
+      resources :shipments, only: [:edit, :update, :create], controller: 'shipments' do
+        member do
+          post :ship
+          get :split
+          post :transfer
+        end
+      end
+      resources :line_items, except: :show do
+        member do
+          post :reset_digital_links_limit
+        end
+      end
+      resources :customer_returns, except: [:index, :destroy], controller: 'orders/customer_returns'
+      resources :return_authorizations, except: [:index, :destroy], controller: 'orders/return_authorizations'
+      resources :payments, except: [:index, :show] do
+        member do
+          put :capture
+          put :void
+        end
+        resources :refunds, only: [:new, :create, :edit, :update]
+      end
+      resources :payment_links, only: [:create], controller: 'orders/payment_links'
+      resources :reimbursements, except: [:destroy, :index] do
+        member do
+          post :perform
+        end
+      end
+    end
+
+    # customers
+    resources :users do
+      resources :store_credits
+      resources :orders, only: [:index]
+      resources :checkouts, only: [:index]
+
+      collection do
+        get :bulk_modal
+        post :bulk_add_tags
+        post :bulk_remove_tags
+      end
+    end
+
+    resources :addresses, except: [:index, :show]
+
+    # promotions
+    resources :promotions do
+      member do
+        post :clone
+      end
+      resources :promotion_actions, as: :actions, except: [:index, :show]
+      resources :promotion_rules, as: :rules, except: [:index, :show]
+      resources :coupon_codes, only: :index
+    end
+    get 'promotion_rules/option_values_search', defaults: { format: :json }
+
+    # returns
+    resources :return_authorizations, only: [:index, :destroy] do
+      member do
+        patch :cancel
+      end
+    end
+    resources :customer_returns, only: :index
+    resources :return_items, only: [:update]
+
+    # translations
+    resources :translations, only: [:edit, :update], path: '/translations/:resource_type'
+
+    # audit log
+    resources :exports, only: [:index, :new, :create, :show]
+
+    # reporting
+    resources :reports, only: [:index, :new, :create, :show]
+
+    # profile settings
+    resource :profile, controller: 'profile', only: %i[edit update]
+
+    # store settings
+    resource :store, only: [:edit, :update], controller: 'stores' do
+      # needed for the getting started set customer support email step
+      member do
+        get :edit_emails
+      end
+    end
+    # setting up a new store
+    resources :stores, only: [:new, :create]
+    resources :payment_methods, except: :show
+    resources :shipping_methods, except: :show
+    resources :shipping_categories, except: :show
+    resources :store_credit_categories
+    resources :tax_rates, except: :show
+    resources :tax_categories, except: :show
+    resources :reimbursement_types
+    resources :refund_reasons, except: :show
+    resources :return_authorization_reasons, except: :show
+    resources :zones
+    resources :stock_locations, except: :show do
+      member do
+        put :mark_as_default
+      end
+    end
+    resources :custom_domains, except: :show
+
+    # storefront / page builder
+    resource :storefront, only: [:edit, :update], controller: :storefront
+    resources :themes, except: [:new, :show] do
+      member do
+        put :update_with_page
+        put :publish
+        post :clone
+      end
+      resources :sections, controller: 'page_sections', only: %i[new create] do
+        member do
+          patch :move_higher
+          patch :move_lower
+        end
+      end
+    end
+    resources :pages, except: [:show] do
+      resources :sections, controller: 'page_sections', only: %i[new create] do
+        member do
+          patch :move_higher
+          patch :move_lower
+        end
+      end
+    end
+    resources :page_sections, only: %i[edit update destroy] do
+      member do
+        patch :restore_design_settings_to_defaults
+      end
+
+      resources :blocks, controller: 'page_blocks' do
+        member do
+          patch :move_higher
+          patch :move_lower
+        end
+
+        resources :links, controller: 'page_links', only: [:create]
+      end
+      resources :links, controller: 'page_links', only: [:create]
+    end
+    resources :page_links, only: [:edit, :update, :destroy]
+
+    resources :posts do
+      collection do
+        get :select_options, defaults: { format: :json }
+      end
+    end
+    resources :post_categories
+
+    # account management
+    resources :roles, except: :show
+
+    # Action Text
+    namespace :action_text do
+      resources :video_embeds, only: [:create, :destroy]
+    end
+
+    # developer tools
+    resources :oauth_applications
+    resources :webhooks_subscribers
+
+    # errors
+    get '/forbidden', to: 'errors#forbidden', as: :forbidden
+
+    # dashboard
+    resource :dashboard, controller: 'dashboard'
+    get '/dashboard/analytics', to: 'dashboard#analytics', as: :dashboard_analytics
+    get '/getting-started', to: 'dashboard#getting_started', as: :getting_started
+    get '/dismiss_enterprise_edition_notice', to: 'dashboard#dismiss_enterprise_edition_notice', as: :dismiss_enterprise_edition_notice
+
+    root to: 'dashboard#show'
+  end
+
+  get Spree.admin_path, to: 'admin/dashboard#show', as: :admin
+end

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

@@ -0,0 +1,42 @@
+require 'rails/generators'
+
+module Spree
+  module Admin
+    module Generators
+      class InstallGenerator < Rails::Generators::Base
+        desc 'Installs Spree Admin Dashboard'
+
+        def self.source_paths
+          [
+            File.expand_path('templates', __dir__),
+            File.expand_path('../templates', "../#{__FILE__}"),
+            File.expand_path('../templates', "../../#{__FILE__}")
+          ]
+        end
+
+        def install
+          if Rails.root && Rails.root.join("Procfile.dev").exist?
+            append_to_file 'Procfile.dev', "\nadmin_css: bin/rails dartsass:watch" unless File.read('Procfile.dev').include?('admin_css:')
+          else
+            create_file 'Procfile.dev', "admin_css: bin/rails dartsass:watch\n"
+          end
+
+          say "Add bin/dev to start foreman"
+          copy_file "dev", "bin/dev", force: true
+          chmod "bin/dev", 0755, verbose: false
+
+          empty_directory Rails.root.join('app/assets/builds') if Rails.root
+
+          unless File.exist?('app/assets/config/manifest.js')
+            create_file 'app/assets/config/manifest.js', "//= link_tree ../builds\n"
+
+            say "Ensure foreman is installed"
+            run "gem install foreman"
+          else
+            append_to_file 'app/assets/config/manifest.js', "\n//= link_tree ../builds" unless File.read('app/assets/config/manifest.js').include?('//= link_tree ../builds')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/generators/spree/admin/install/templates/dev

@@ -0,0 +1,16 @@
+#!/usr/bin/env sh
+
+if ! gem list foreman -i --silent; then
+  echo "Installing foreman..."
+  gem install foreman
+fi
+
+# Default to port 3000 if not specified
+export PORT="${PORT:-3000}"
+
+# Let the debug gem allow remote connections,
+# but avoid loading until `debugger` is called
+export RUBY_DEBUG_OPEN="true"
+export RUBY_DEBUG_LAZY="true"
+
+exec foreman start -f Procfile.dev "$@"

data/lib/spree/admin/action_callbacks.rb

@@ -0,0 +1,27 @@
+module Spree
+  module Admin
+    class ActionCallbacks
+      attr_reader :before_methods
+      attr_reader :after_methods
+      attr_reader :fails_methods
+
+      def initialize
+        @before_methods = []
+        @after_methods = []
+        @fails_methods = []
+      end
+
+      def before(method)
+        @before_methods << method
+      end
+
+      def after(method)
+        @after_methods << method
+      end
+
+      def fails(method)
+        @fails_methods << method
+      end
+    end
+  end
+end

data/lib/spree/admin/callbacks.rb

@@ -0,0 +1,51 @@
+require_relative 'action_callbacks'
+
+module Spree
+  module Admin
+    module Callbacks
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        attr_accessor :callbacks
+
+        def new_action
+          custom_callback(:new_action)
+        end
+
+        def edit_action
+          custom_callback(:edit_action)
+        end
+
+        def create
+          custom_callback(:create)
+        end
+
+        def update
+          custom_callback(:update)
+        end
+
+        def destroy
+          custom_callback(:destroy)
+        end
+
+        def custom_callback(action)
+          @callbacks ||= {}
+          @callbacks[action] ||= Spree::Admin::ActionCallbacks.new
+        end
+      end
+
+      protected
+
+      def invoke_callbacks(action, callback_type)
+        callbacks = self.class.callbacks || {}
+        return if callbacks[action].nil?
+
+        case callback_type.to_sym
+        when :before then callbacks[action].before_methods.each { |method| send method }
+        when :after  then callbacks[action].after_methods.each  { |method| send method }
+        when :fails  then callbacks[action].fails_methods.each  { |method| send method }
+        end
+      end
+    end
+  end
+end