ba_spree 1.0.0

data/lib/ba_spree/engine.rb

@@ -0,0 +1,41 @@
+module BaSpree
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'ba_spree'
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    initializer 'ba_spree.autoloader' do |app|
+      if Rails.autoloaders.zeitwerk_enabled?
+        Rails.autoloaders.main.ignore("#{root}/app/overrides")
+      end
+    end
+
+    # Spree 5.3 のイベント subscriber 二重登録（注文確認/キャンセルメールの多重送信）対策。
+    # subscriber 登録（after_initialize 内の Spree::Events.activate!）より前に適用する必要があるため
+    # initializer で require する。 @see https://github.com/be-agile/giga-repeat/issues/1230
+    initializer 'ba_spree.spree_events_dedup_patch' do
+      require 'ba_spree/spree_events_dedup_patch'
+    end
+
+    initializer 'ba_spree.importmap', before: 'importmap' do |app|
+      app.config.importmap.paths << root.join('config/importmap.rb')
+      app.config.importmap.cache_sweepers << root.join('app/assets/javascripts')
+      app.config.importmap.cache_sweepers << root.join('app/javascript')
+    end
+
+    initializer 'ba_spree.assets' do |app|
+      app.config.assets.paths << root.join('app/javascript')
+      app.config.assets.precompile += %w( spree/admin/custom.css )
+    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

data/lib/ba_spree/spree_events_dedup_patch.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# Spree 5.3 のイベント subscriber 登録に重複ガードが無い問題への対策。
+#
+# `spree_emails` の Engine#after_initialize は無条件で
+# `Spree.subscribers.concat([Spree::OrderEmailSubscriber, ...])` を行い、
+# `Spree::Events.register_subscribers!` は `Spree.subscribers` を `.uniq` せず反復、
+# さらに `Spree::Events::Registry#register` も重複チェックをしない。
+# このため何らかの理由で subscriber が二重に登録されると subscription も二重化し、
+# 注文確認メール / キャンセルメールが 2 通ずつ送信される。
+#
+# resolve 後の subscriber クラス単位で重複排除し、同一 subscriber を
+# 1 回しか登録しないようにする（環境非依存で堅牢）。
+#
+# @see https://github.com/be-agile/giga-repeat/issues/1230
+module BaSpree
+  # @gem-override spree_core-5.3.6/lib/spree/events.rb#register_subscribers!
+  # @see https://github.com/be-agile/giga-repeat/issues/1230
+  module SpreeEventsDedupPatch
+    def register_subscribers!
+      return unless defined?(Spree) && Spree.respond_to?(:subscribers)
+
+      registered = []
+
+      Spree.subscribers&.each do |subscriber|
+        # Resolve the subscriber constant fresh to handle code reload in development
+        # The array may contain stale class objects after Zeitwerk reload
+        resolved_subscriber = resolve_subscriber(subscriber)
+        next unless resolved_subscriber
+
+        # 同一 subscriber を二重登録しない（subscription 二重化＝メール多重送信の防止）
+        next if registered.include?(resolved_subscriber)
+
+        registered << resolved_subscriber
+
+        resolved_subscriber.subscription_patterns.each do |pattern|
+          subscribe(pattern, resolved_subscriber, resolved_subscriber.subscription_options)
+        end
+      end
+    end
+  end
+end
+
+Spree::Events.singleton_class.prepend(BaSpree::SpreeEventsDedupPatch)

data/lib/ba_spree/version.rb

@@ -0,0 +1,3 @@
+module BaSpree
+  VERSION = "1.0.0"
+end

data/lib/ba_spree.rb

@@ -0,0 +1,20 @@
+require 'spree_core'
+require 'spree_admin'
+require 'spree_storefront'
+require 'spree_i18n'
+require 'spree_emails'
+# gemspec で add_dependency している engine は、ここでも require してロード順を固定する。
+# ba_spree_loyalty_points は Spree::Order / Spree::Store / Spree::PaymentMethod /
+# Spree::CheckoutController を ba_spree と同じく decorate しており、どちらの decorator が外側に
+# prepend されるかが Gemfile の記載順で決まってしまう。依存先を先にロードすることで、土台である
+# 依存先の上に ba_spree が重なる形（ba_spree が外側）に固定する。
+# spree_materials は現時点では ba_spree 側からのコード参照がないが、同じ理由で順序を固定しておく。
+# @see https://github.com/be-agile/giga-repeat/issues/1307
+require 'ba_spree_loyalty_points'
+require 'spree_materials'
+# Spree::BaseHelperDecorator#sort_adjustments_with_flat_percent_last が
+# Spree::Calculator::FlatPercentOrderTotal を参照する。
+# @see https://github.com/be-agile/giga-repeat/issues/1307
+require 'spree_order_total_discount'
+require 'ba_spree/engine'
+require 'ba_spree/version'

data/lib/generators/ba_spree/install/install_generator.rb

@@ -0,0 +1,85 @@
+module BaSpree
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      class_option :auto_run_migrations, type: :boolean, default: false
+
+      def add_javascripts
+        js_directory = BaSpree::Engine.root.join('app', 'assets', 'javascripts')
+        manifest_file = 'app/assets/config/manifest.js'
+        Dir.glob("#{js_directory}/**/*.js").each do |file|
+          relative_path = file.sub("#{js_directory}/", '')
+          append_file manifest_file, "//= link #{relative_path}\n"
+        end
+      end
+
+      def add_stylesheets
+        css_directory = BaSpree::Engine.root.join('app', 'assets', 'stylesheets')
+        manifest_file = 'app/assets/config/manifest.js'
+        Dir.glob("#{css_directory}/**/*.scss").each do |file|
+          relative_path = file.sub("#{css_directory}/", '').sub('.scss', '.css')
+          append_file manifest_file, "//= link #{relative_path}\n"
+        end
+      end
+
+      # ba_spree が束ねる engine の migration をまとめてコピーする。
+      # 利用者が各 engine のジェネレータを 20 個順に叩かなくて済むようにするのが狙い。
+      # @see https://github.com/be-agile/giga-repeat/issues/1317
+      def add_migrations
+        railties = migratable_railtie_names
+
+        if railties.empty?
+          say_status :skip, 'migration を持つ ba_spree の engine が見つかりませんでした', :yellow
+          return
+        end
+
+        # FROM を省略すると spree 本体・spree_api・active_storage 等、
+        # アプリにロードされている全 railtie からコピーしてしまうため必ず列挙する
+        run "bundle exec rake railties:install:migrations FROM=#{railties.join(',')}"
+      end
+
+      def run_migrations
+        if options[:auto_run_migrations] || [ '', 'y', 'Y' ].include?(ask('Would you like to run the migrations now? [Y/n]'))
+          run 'bundle exec rake db:migrate'
+        else
+          say_status :skip, 'db:migrate をスキップしました。あとで実行してください', :yellow
+        end
+      end
+
+      private
+
+      # ba_spree の gemspec が依存に挙げている gem のうち、db/migrate を持つ
+      # engine の railtie 名を返す。
+      # gem 名と railtie 名は一致しないことがある
+      # (例: ba_spree_loyalty_points gem の engine_name は spree_loyalty_points)
+      # ため、gem のインストールパスと railtie の root を突き合わせて対応付ける。
+      def migratable_railtie_names
+        paths = dependency_gem_paths
+        return [] if paths.empty?
+
+        Rails.application.railties.filter_map do |railtie|
+          next unless railtie.respond_to?(:root) && railtie.respond_to?(:railtie_name)
+          next unless paths.include?(realpath(railtie.root))
+          next unless railtie.paths['db/migrate']&.existent&.any?
+
+          railtie.railtie_name
+        end.uniq.sort
+      end
+
+      def dependency_gem_paths
+        Gem::Specification.find_by_name('ba_spree').dependencies.select(&:runtime?).filter_map do |dependency|
+          realpath(Gem::Specification.find_by_name(dependency.name).full_gem_path)
+        rescue Gem::MissingSpecError
+          nil
+        end
+      rescue Gem::MissingSpecError
+        []
+      end
+
+      def realpath(path)
+        File.realpath(path.to_s)
+      rescue Errno::ENOENT
+        nil
+      end
+    end
+  end
+end