spree_multi_store 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e04a1b3c2537beca45a3f71d694ab398b4beb627a8b1a7df529d2219720053fd
-  data.tar.gz: 3faad6a5bf518fa4a3939bee2475ee0799a5d545fed6dedd0b72521ef9c0ffae
+  metadata.gz: 3882b1e05504ca432beedbb694edca5b1fdb8707a0d74d5850bb47fa43364594
+  data.tar.gz: de6285d81d742beea6db47cc1e9be857c8359dc6014230c53964c52f24a1735b
 SHA512:
-  metadata.gz: '0508c322500915fcd34e1c8f1d004020d2075c7abd27615b5b607a08374ced3eb074a64ab4fe1fbe4a764f4d46ebd64d65be80dc0b08c2147115a7c7f601eda5'
-  data.tar.gz: 4746391eeae2143b67e1fca2d70fac6853b00db0c8acc172f66fba4e7d84b94a2d1dd48cabbe8f6f723e63231f3d1ea4f04b46fd0217c3b8b151f648bfc4fdba
+  metadata.gz: 5fa6297b18bb5b43bc90f36c21fb915a23e032bb5c8d795883c2b8fcd1100edb707fa4dd108ac0add5000c7c2342bba02f643125b0acfe57640ea81ed4c8f24d
+  data.tar.gz: 32ac3d46363ced71dca2b76fc24ea78b87475febb65d3408b1daa792d464b3532d88bfd3a4ba3756c30ceb7d3c8ec30bbe89e374095898f46fadf253328881ad

data/app/models/concerns/spree/multi_store_resource.rb

@@ -13,21 +13,38 @@ module Spree
     protected
 
     def must_have_one_store
-      return if stores.any?
+      return if associated_with_store?
 
       errors.add(:stores, Spree.t(:must_have_one_store))
     end
 
     def set_default_store
       return if disable_store_presence_validation?
-      return if stores.any?
+      return if associated_with_store?
 
-      stores << Spree::Store.default
+      # Build the join by +store_id+ instead of pushing the +Spree::Store.default+
+      # instance through the autosaving +has_many :stores, through:+.
+      send(store_join_association_name).build(store_id: Spree::Store.default.id)
     end
 
     # this can be overridden on model basis
     def disable_store_presence_validation?
       Spree::Config[:disable_store_presence_validation]
     end
+
+    private
+
+    # records built through a store's association (`store.payment_methods.build`)
+    # carry their link on the join association — `stores` can't see it until save
+    # (mirrors Spree::StoreScopedResource, spree/spree#14185)
+    def associated_with_store?
+      stores.any? || send(store_join_association_name).any?
+    end
+
+    # Name of the join association backing +has_many :stores, through:+
+    # (e.g. +:store_products+, +:store_payment_methods+, +:store_promotions+).
+    def store_join_association_name
+      self.class.reflect_on_association(:stores).through_reflection.name
+    end
   end
 end

data/app/models/concerns/spree/store/multi_store_methods.rb

@@ -10,6 +10,13 @@ module Spree
       has_many :custom_domains, class_name: 'Spree::CustomDomain', dependent: :destroy
       has_one :default_custom_domain, -> { where(default: true) }, class_name: 'Spree::CustomDomain'
 
+      # Replace core's singular +has_many :products, dependent: :nullify+ (FK
+      # +spree_products.store_id+) with the legacy join-table association.
+      # Same association name overrides the core declaration in Rails.
+      has_many :store_products, class_name: 'Spree::StoreProduct', dependent: :destroy
+      has_many :products, through: :store_products, class_name: 'Spree::Product'
+      has_many :variants, through: :products, class_name: 'Spree::Variant', source: :variants_including_master
+
       attribute :import_products_from_store_id, :string, default: nil
       attribute :import_payment_methods_from_store_id, :string, default: nil
 

data/app/models/concerns/spree/store/multi_store_overrides.rb

@@ -8,6 +8,10 @@ module Spree
       formatted_custom_domain || formatted_url
     end
 
+    def storefront_url
+      formatted_custom_domain || super
+    end
+
     def can_be_deleted?
       self.class.where.not(id: id).any?
     end

data/app/models/spree/multi_store/product_decorator.rb

@@ -2,6 +2,19 @@ module Spree
   module MultiStore
     module ProductDecorator
       def self.prepended(base)
+        # Spree 5.5 core sets +belongs_to :store+ via +Spree::Product::Channels+;
+        # this gem layers +has_many :stores+ on top through the legacy join.
+        # Keep both: +store+ stays as the "home" store used by core for
+        # publication/channel scoping; +stores+ is the multi-store catalog set.
+        base.has_many :store_products, class_name: 'Spree::StoreProduct'
+        base.has_many :stores, through: :store_products, class_name: 'Spree::Store'
+
+        base.scope :for_store, ->(store) { joins(:store_products).where(StoreProduct.table_name => { store_id: store.id }) }
+
+        # Ransack: re-expose +stores+ alongside the core associations.
+        base.whitelisted_ransackable_associations =
+          (base.whitelisted_ransackable_associations.to_a + %w[stores store_products]).uniq
+
         base.include Spree::MultiStoreResource
       end
     end

data/app/models/spree/store_product.rb

@@ -0,0 +1,29 @@
+module Spree
+  class StoreProduct < Spree.base_class
+    has_prefix_id :sp
+
+    self.table_name = 'spree_products_stores'
+
+    belongs_to :store, class_name: 'Spree::Store', touch: true
+    belongs_to :product, class_name: 'Spree::Product', touch: true
+
+    validates :store, :product, presence: true
+    validates :store_id, uniqueness: { scope: :product_id }
+
+    def refresh_metrics!
+      return if product.nil?
+
+      completed_order_ids = product.completed_orders.where(store_id: store_id).select(:id)
+      variant_ids = product.variants_including_master.ids
+
+      line_items = Spree::LineItem.joins(:order)
+        .where(spree_orders: { id: completed_order_ids })
+        .where(variant_id: variant_ids)
+
+      update!(
+        units_sold_count: line_items.sum(:quantity),
+        revenue: line_items.sum(:pre_tax_amount)
+      )
+    end
+  end
+end

data/config/initializers/spree_multi_store.rb

@@ -1,3 +1,8 @@
+# Multi-store setup
+# You need to set a wildcard `root_domain` on the store to enable multi-store setup
+# all new stores will be created in a subdomain of the root domain, eg. store1.localhost, store2.localhost, etc.
+Spree.root_domain = ENV.fetch('SPREE_ROOT_DOMAIN', 'localhost')
+
 Rails.application.config.after_initialize do
   Spree::Dependencies.current_store_finder = 'Spree::Stores::FindCurrent'
 
@@ -8,12 +13,12 @@ Rails.application.config.after_initialize do
     :import_payment_methods_from_store_id
   )
 
+  # Re-add +store_ids+ to permitted product attributes — core dropped it when
+  # Product went single-store; this gem restores +has_many :stores+ and the
+  # legacy +_stores.html.erb+ partial submits a +store_ids[]+ checkbox list.
+  Spree::PermittedAttributes.product_attributes.push(store_ids: [])
+
   if defined?(Spree::Admin)
     Spree.admin.partials.product_form_sidebar << 'spree/admin/products/form/stores'
   end
-
-  # Multi-store setup
-  # You need to set a wildcard `root_domain` on the store to enable multi-store setup
-  # all new stores will be created in a subdomain of the root domain, eg. store1.localhost, store2.localhost, etc.
-  Spree.root_domain = ENV.fetch('SPREE_ROOT_DOMAIN', 'localhost')
 end

data/lib/spree/multi_store/factories/store_product_factory.rb

@@ -0,0 +1,6 @@
+FactoryBot.define do
+  factory :store_product, class: 'Spree::StoreProduct' do
+    store
+    product
+  end
+end

data/lib/spree/multi_store/version.rb

@@ -1,5 +1,9 @@
 module Spree
   module MultiStore
-    VERSION = '1.0.0'
+    VERSION = '1.0.2'.freeze
+
+    def gem_version
+      Gem::Version.new(VERSION)
+    end
   end
 end

data/lib/spree_multi_store/factories.rb

@@ -0,0 +1,3 @@
+require 'factory_bot'
+
+Dir["#{__dir__}/../spree/multi_store/factories/**/*.rb"].each { |f| load f }

data/lib/spree_multi_store.rb

@@ -1 +1,8 @@
+# Top-level marker constant. Spree core checks +defined?(SpreeMultiStore)+ before
+# including +Spree::Product::LegacyMultiStoreSupport+ — defining it here ensures
+# core skips the deprecation-only fallback so this gem's ProductDecorator can
+# install the real +has_many :stores+ association.
+module SpreeMultiStore
+end
+
 require 'spree/multi_store'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spree_multi_store
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Vendo Connect Inc.
@@ -76,6 +76,7 @@ files:
 - app/models/spree/multi_store/product_decorator.rb
 - app/models/spree/multi_store/promotion_decorator.rb
 - app/models/spree/multi_store/store_decorator.rb
+- app/models/spree/store_product.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
@@ -92,16 +93,18 @@ files:
 - config/routes.rb
 - lib/spree/multi_store.rb
 - lib/spree/multi_store/engine.rb
+- lib/spree/multi_store/factories/store_product_factory.rb
 - lib/spree/multi_store/version.rb
 - lib/spree_multi_store.rb
+- lib/spree_multi_store/factories.rb
 homepage: https://github.com/spree/spree_multi_store
 licenses:
 - AGPL-3.0-or-later
 metadata:
   bug_tracker_uri: https://github.com/spree/spree_multi_store/issues
-  changelog_uri: https://github.com/spree/spree_multi_store/releases/tag/v1.0.0
+  changelog_uri: https://github.com/spree/spree_multi_store/releases/tag/v1.0.2
   documentation_uri: https://docs.spreecommerce.org/
-  source_code_uri: https://github.com/spree/spree_multi_store/tree/v1.0.0
+  source_code_uri: https://github.com/spree/spree_multi_store/tree/v1.0.2
 post_install_message: |
   --------------------------------------------------------------
   Thank you for installing Spree Multi-Store!