spree_custom_domains 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 906736f5a9fa445e809467df13ff1c880db136e4934c77427cb85a1825471ffa
+  data.tar.gz: 57606025e58cc523e63f1491dd237806c7be7ba085d6880f8f0cbd90da57d9c1
+SHA512:
+  metadata.gz: df72cfba3c89faf6ac53191e0bea9ba00b766f9a1cdd35f9636a4d412f28dedd523debf63e5f3a64ea0a813d752369500f2db8af92fedc21d78038c3dc0ecff8
+  data.tar.gz: 6ec8dc795a203ffd1e0d6de8fbc46c5e02e8ae37ac8cb79f5fe15018b9734441cdb3ff3ea3b63c8b398d309f8fcf94f459c599627d3dc4d5ddb5069b21ba00ca

data/LICENSE.md

@@ -0,0 +1,14 @@
+Copyright (c) 2026 Vendo Connect Inc. Vendo Sp. z o.o.
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.

data/README.md

@@ -0,0 +1,44 @@
+# Spree Custom Domains
+
+Serve a [Spree Commerce](https://spreecommerce.org) store on its own custom domain.
+
+This extension adds:
+
+- A `Spree::CustomDomain` model and admin management UI (Settings → Domains).
+- Host-based current-store resolution, so a request to `shop.example.com` is served by the store that owns that domain.
+- `Spree::Store#url_or_custom_domain` / `#formatted_url_or_custom_domain` that prefer the store's default custom domain when one is configured.
+
+Without this extension installed, Spree core serves every request from the default store and `url_or_custom_domain` falls back to the store's internal URL.
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'spree_custom_domains'
+```
+
+Then run:
+
+```bash
+bundle install
+bin/rails spree:install:migrations
+bin/rails db:migrate
+```
+
+The `spree_custom_domains` table ships with Spree core, so `spree:install:migrations`
+copies it into your app if it isn't already present.
+
+## Multi-store and multi-tenant
+
+Custom domains are independent of multi-store catalog sharing. Install this gem
+on its own for single-store / multi-tenant setups that just need per-store
+domains, or alongside
+[`spree_multi_store`](https://github.com/spree/spree_multi_store) for legacy
+catalog sharing across stores.
+
+## License
+
+Spree Custom Domains is released under the
+[AGPL-3.0-or-later](LICENSE.md) license. A commercial license is available
+through [Spree Enterprise](https://spreecommerce.org/enterprise/).

data/Rakefile

@@ -0,0 +1,23 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/extension_rake'
+
+RSpec::Core::RakeTask.new
+
+task :default do
+  if Dir['spec/dummy'].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir('../../')
+  end
+  Rake::Task[:spec].invoke
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'spree_custom_domains'
+  Rake::Task['extension:test_app'].execute(
+    install_admin: true
+  )
+end

data/app/controllers/spree/admin/custom_domains_controller.rb

@@ -0,0 +1,21 @@
+module Spree
+  module Admin
+    class CustomDomainsController < ResourceController
+      include Spree::Admin::SettingsConcern
+
+      protected
+
+      def collection_url
+        spree.admin_custom_domains_path
+      end
+
+      def location_after_save
+        spree.admin_custom_domains_path
+      end
+
+      def permitted_resource_params
+        params.require(:custom_domain).permit(Spree::PermittedAttributes.custom_domain_attributes)
+      end
+    end
+  end
+end

data/app/finders/spree/stores/find_current.rb

@@ -0,0 +1,28 @@
+module Spree
+  module Stores
+    class FindCurrent
+      def initialize(scope: nil, url: nil)
+        @scope = scope || Spree::Store
+        @url = url
+      end
+
+      def execute
+        store = by_url(scope) || scope.default
+        return if store.nil?
+
+        Spree::Current.store = store
+        store
+      end
+
+      protected
+
+      attr_reader :scope, :url
+
+      def by_url(scope)
+        return if url.blank?
+
+        scope.by_custom_domain(url).or(scope.by_url(url)).first
+      end
+    end
+  end
+end

data/app/models/spree/custom_domain.rb

@@ -0,0 +1,61 @@
+module Spree
+  class CustomDomain < Spree::Base
+    has_prefix_id :domain
+
+    include Spree::SingleStoreResource
+    include Spree::Metafields
+    include Spree::Metadata
+
+    normalizes :url, with: ->(value) { value&.to_s&.squish&.presence }
+
+    #
+    # Associations
+    #
+    belongs_to :store, class_name: 'Spree::Store', inverse_of: :custom_domains, touch: true
+
+    #
+    # Validations
+    #
+    validates :url, presence: true, uniqueness: true, format: {
+      with: %r{\A(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\z}i
+    }, length: { in: 1..63 }
+    validate :url_is_valid
+
+    #
+    # Callbacks
+    #
+    before_validation :sanitize_url
+    after_save :ensure_has_one_default
+    after_validation :ensure_default, on: :create
+
+    def url_is_valid
+      return if url.blank?
+      parts = url.split('.')
+
+      errors.add(:url, 'use domain or subdomain') if parts.size > 4 || parts.size < 2
+    end
+
+    def ensure_default
+      self.default = store.custom_domains.count.zero?
+    end
+
+    def ensure_has_one_default
+      store.custom_domains.where.not(id: id).update_all(default: false) if default?
+    end
+
+    def active?
+      true
+    end
+
+    def name
+      url
+    end
+
+    private
+
+    # remove https:// and http:// from the url
+    def sanitize_url
+      self.url = url&.gsub(%r{https?://}, '')
+    end
+  end
+end

data/app/models/spree/custom_domains/store_decorator.rb

@@ -0,0 +1,58 @@
+module Spree
+  module CustomDomains
+    module StoreDecorator
+      def self.prepended(base)
+        base.has_many :custom_domains, class_name: 'Spree::CustomDomain', dependent: :destroy
+        base.has_one :default_custom_domain, -> { where(default: true) }, class_name: 'Spree::CustomDomain'
+
+        # Host-based resolution: +by_custom_domain+ matches an attached custom
+        # domain, +by_url+ matches the store's internal URL. Both are consumed
+        # by +Spree::Stores::FindCurrent+.
+        base.scope :by_custom_domain, ->(url) { left_joins(:custom_domains).where("#{Spree::CustomDomain.table_name}.url" => url) }
+        base.scope :by_url, ->(url) { where(url: url).or(where("#{base.table_name}.url like ?", "%#{url}%")) }
+
+        base.singleton_class.prepend(ClassMethods)
+      end
+
+      module ClassMethods
+        # Resolve a store from a request host. Core's +Store.current+ ignores
+        # the URL and returns +Spree::Current.store+; with custom domains a
+        # host can map to a specific store.
+        def current(url = nil)
+          return Spree::Current.store if url.blank?
+
+          Spree.current_store_finder.new(url: url).execute
+        end
+      end
+
+      # Prefer the store's default custom domain over its internal URL.
+      def url_or_custom_domain
+        default_custom_domain&.url || super
+      end
+
+      def formatted_url_or_custom_domain
+        formatted_custom_domain || super
+      end
+
+      def storefront_url
+        formatted_custom_domain || super
+      end
+
+      def formatted_custom_domain
+        return unless default_custom_domain
+
+        @formatted_custom_domain ||= if Rails.env.development? || Rails.env.test?
+          URI::Generic.build(
+            scheme: Rails.application.routes.default_url_options[:protocol] || 'http',
+            host: default_custom_domain.url,
+            port: Rails.application.routes.default_url_options[:port]
+          ).to_s
+        else
+          URI::HTTPS.build(host: default_custom_domain.url).to_s
+        end
+      end
+    end
+  end
+
+  Store.prepend(CustomDomains::StoreDecorator)
+end

data/app/views/spree/admin/custom_domains/_custom_domain.html.erb

@@ -0,0 +1,11 @@
+<tr id="<%= spree_dom_id custom_domain %>">
+  <td><%= custom_domain.url %></td>
+  <td>
+    <%= active_badge(custom_domain.active?) %>
+  </td>
+
+  <td><%= active_badge(custom_domain.default?) %></td>
+  <td class="actions">
+    <%= link_to_edit(custom_domain, no_text: true, url: spree.edit_admin_custom_domain_path(custom_domain), data: { turbo: false }) %>
+  </td>
+</tr>

data/app/views/spree/admin/custom_domains/_custom_domains.html.erb

@@ -0,0 +1,19 @@
+<% if current_store.custom_domains.any? %>
+  <div class="table-responsive rounded-lg  mt-4 border">
+    <table class="table">
+      <thead>
+        <tr>
+          <th scope="col"><%= sort_link @search, :name, Spree.t(:name) %></th>
+          <th scope="col"><%= Spree.t(:active) %>?</th>
+          <th scope="col"><%= Spree.t(:default) %>?</th>
+          <th scope="col"></th>
+        </tr>
+      </thead>
+      <tbody>
+        <%= render collection: current_store.custom_domains, partial: 'spree/admin/custom_domains/custom_domain', cached: spree_base_cache_scope %>
+      </tbody>
+    </table>
+  </div>
+<% else %>
+  <%= render 'spree/admin/shared/no_resource_found' %>
+<% end %>

data/app/views/spree/admin/custom_domains/_form.html.erb

@@ -0,0 +1,7 @@
+<div class="card mb-6">
+  <div class="card-body">
+    <%= f.spree_text_field :url, label: Spree.t(:domain), prepend: 'https://', autofocus: f.object.new_record?, required: true %>
+
+    <%= f.spree_check_box :default, help: 'We will use this domain in emails to customers.' %>
+  </div>
+</div>

data/app/views/spree/admin/custom_domains/edit.html.erb

@@ -0,0 +1 @@
+<%= render 'spree/admin/shared/edit_resource' %>

data/app/views/spree/admin/custom_domains/index.html.erb

@@ -0,0 +1,65 @@
+<%= content_for(:page_title) do %>
+  <%= Spree.t(:domains) %>
+<% end %>
+
+<% content_for :page_actions do %>
+  <%= render_admin_partials(:custom_domains_actions_partials) %>
+<% end %>
+
+<%= render_admin_partials(:custom_domains_header_partials) %>
+
+<div class="card-lg p-6">
+  <h5 class="mb-2">Internal URL</h5>
+  <div class="grid grid-cols-12 gap-6 mb-6">
+    <div class="col-span-12 lg:col-span-4">
+      <p class="text-gray-600">
+        This is your internal Admin URL.
+      </p>
+    </div>
+    <div class="col-span-12 lg:col-span-7 lg:col-start-6">
+      <%= form_for current_store, url: spree.admin_store_path, data: { turbo: false, controller: 'enable-button', 'enable-button-disable-when-not-changed-value': true } do |f| %>
+        <% if Spree.root_domain.present? %>
+          <div class="flex items-center gap-6">
+            <div class="input-group pr-2 grow <% if current_store.custom_domains.any? %>disabled<% end %>">
+              <span class="text-gray-400 pl-3 pr-0">https://</span>
+              <%= f.text_field :code, class: 'border-0 focus:ring-0 focus:outline-none grow rounded-lg text-base pl-0', data: { enable_button_target: 'input' }, required: true, disabled: current_store.custom_domains.any? %>
+              <span>.<%= Spree.root_domain %></span>
+
+              <%= clipboard_component(current_store.formatted_url) %>
+            </div>
+            <% unless current_store.custom_domains.any? %>
+              <%= turbo_save_button_tag %>
+            <% end %>
+          </div>
+        <% else %>
+          <div class="flex items-center gap-6">
+            <div class="input-group pr-2 grow">
+              <span class="text-gray-400 pl-3 pr-0">https://</span>
+              <%= f.text_field :url, class: 'border-0 focus:ring-0 focus:outline-none grow rounded-lg text-base pl-0', required: true, data: { enable_button_target: 'input' } %>
+              <%= clipboard_component(current_store.formatted_url) %>
+            </div>
+            <%= turbo_save_button_tag %>
+          </div>
+        <% end %>
+      <% end %>
+    </div>
+  </div>
+  <hr class="my-12" />
+  <h5 class="mb-2"><%= Spree.t(:custom_domains) %></h5>
+  <div class="grid grid-cols-12 gap-6">
+    <div class="col-span-12 lg:col-span-4">
+      <p class="text-gray-600">
+        Connect your domain or subdomain to your storefront.
+      </p>
+    </div>
+    <div class="col-span-12 lg:col-span-7 lg:col-start-6">
+      <div class="text-right">
+        <%= link_to Spree.t(:new_domain), spree.new_admin_custom_domain_path, class: "btn btn-primary" %>
+      </div>
+
+      <%= turbo_frame_tag 'admin_custom_domains_index' do %>
+        <%= render 'custom_domains' %>
+      <% end %>
+    </div>
+  </div>
+</div>

data/app/views/spree/admin/custom_domains/new.html.erb

@@ -0,0 +1 @@
+<%= render 'spree/admin/shared/new_resource' %>

data/config/initializers/spree_custom_domains.rb

@@ -0,0 +1,3 @@
+Rails.application.config.after_initialize do
+  Spree.metafields.enabled_resources << Spree::CustomDomain
+end

data/config/initializers/spree_custom_domains_navigation.rb

@@ -0,0 +1,14 @@
+Rails.application.config.after_initialize do
+  next unless defined?(Spree::Admin)
+
+  settings_nav = Spree.admin.navigation.settings
+
+  # Domains
+  settings_nav.add :domains,
+          label: :domains,
+          url: :admin_custom_domains_path,
+          icon: 'world-www',
+          position: 60,
+          active: -> { controller_name == 'custom_domains' },
+          if: -> { can?(:manage, Spree::CustomDomain) }
+end

data/config/routes.rb

@@ -0,0 +1,5 @@
+Spree::Core::Engine.add_routes do
+  namespace :admin, path: Spree.admin_path do
+    resources :custom_domains, except: :show
+  end
+end

data/lib/spree/custom_domains/engine.rb

@@ -0,0 +1,29 @@
+module Spree
+  module CustomDomains
+    class Engine < ::Rails::Engine
+      isolate_namespace Spree
+      engine_name 'spree_custom_domains'
+
+      # Rails 7.1 introduced a new feature that raises an error if a callback action is missing.
+      # We need to disable it as we use a lot of concerns that add callback actions.
+      initializer 'spree.custom_domains.disable_raise_on_missing_callback_actions' do |app|
+        app.config.action_controller.raise_on_missing_callback_actions = false
+      end
+
+      # Resolve the current store from the request host (custom domain or
+      # internal URL). Replaces core's default +Spree::Stores::FindDefault+,
+      # which ignores the host and always returns the default store.
+      initializer 'spree.custom_domains.dependencies', after: 'spree.environment' do
+        Spree::Dependencies.current_store_finder = 'Spree::Stores::FindCurrent'
+      end
+
+      def self.activate
+        Dir.glob(File.join(File.dirname(__FILE__), '../../../app/**/*_decorator*.rb')) do |c|
+          Rails.configuration.cache_classes ? require(c) : load(c)
+        end
+      end
+
+      config.to_prepare(&method(:activate).to_proc)
+    end
+  end
+end

data/lib/spree/custom_domains/version.rb

@@ -0,0 +1,9 @@
+module Spree
+  module CustomDomains
+    VERSION = '0.1.0'.freeze
+
+    def gem_version
+      Gem::Version.new(VERSION)
+    end
+  end
+end

data/lib/spree_custom_domains.rb

@@ -0,0 +1,4 @@
+require 'spree_core'
+
+require 'spree/custom_domains/version'
+require 'spree/custom_domains/engine'

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: spree_custom_domains
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vendo Connect Inc.
+- Vendo Sp. z o.o.
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spree
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.4.0.beta
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.4.0.beta
+- !ruby/object:Gem::Dependency
+  name: spree_admin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.4.0.beta
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.4.0.beta
+- !ruby/object:Gem::Dependency
+  name: spree_dev_tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Lets a Spree store be served on its own custom domain, with admin management
+  and host-based store resolution.
+email: hello@spreecommerce.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- Rakefile
+- app/controllers/spree/admin/custom_domains_controller.rb
+- app/finders/spree/stores/find_current.rb
+- app/models/spree/custom_domain.rb
+- app/models/spree/custom_domains/store_decorator.rb
+- app/views/spree/admin/custom_domains/_custom_domain.html.erb
+- app/views/spree/admin/custom_domains/_custom_domains.html.erb
+- app/views/spree/admin/custom_domains/_form.html.erb
+- app/views/spree/admin/custom_domains/edit.html.erb
+- app/views/spree/admin/custom_domains/index.html.erb
+- app/views/spree/admin/custom_domains/new.html.erb
+- config/initializers/spree_custom_domains.rb
+- config/initializers/spree_custom_domains_navigation.rb
+- config/routes.rb
+- lib/spree/custom_domains/engine.rb
+- lib/spree/custom_domains/version.rb
+- lib/spree_custom_domains.rb
+homepage: https://github.com/spree/spree_custom_domains
+licenses:
+- AGPL-3.0-or-later
+metadata:
+  bug_tracker_uri: https://github.com/spree/spree_custom_domains/issues
+  changelog_uri: https://github.com/spree/spree_custom_domains/releases/tag/v0.1.0
+  documentation_uri: https://docs.spreecommerce.org/
+  source_code_uri: https://github.com/spree/spree_custom_domains/tree/v0.1.0
+post_install_message: |
+  --------------------------------------------------------------
+  Thank you for installing Spree Custom Domains!
+
+  This gem is licensed under AGPL-3.0-or-later.
+  To obtain a commercial license for your project,
+  check out Spree Enterprise:
+
+    https://spreecommerce.org/enterprise/
+
+  --------------------------------------------------------------
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- none
+rubygems_version: 4.0.2
+specification_version: 4
+summary: Custom domains for Spree Commerce stores
+test_files: []