ba_spree_google_analytics 1.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6dd44703666ee47d616fe61162caabf687875a327db212846a1e76a4ab678660
+  data.tar.gz: 01b4fd620157874f6f26e859fde56bc871c279f951168b6339900625c8550a84
+SHA512:
+  metadata.gz: 92561ca79edd0e6621bf1576d1689f0521d5fb0b9a0f4244b54bca5c7bf5e28968824933fa9bf795963df982a9246c9fb42a645ef67294e2ed9d7cd48966b21a
+  data.tar.gz: 9fa63bbb89a021037680225f1340c66484f197e409eee4b396f6e5f6650b9ccefeeb17a3fa58d668a333072061039e92e711ebbc6f8d6a676a25c279005c6948

data/LICENSE

@@ -0,0 +1,10 @@
+MIT License
+
+Copyright (c) 2026 Vendo Connect Inc.
+Copyright (c) 2026 be agile Co., Ltd.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,105 @@
+> [!NOTE]
+> For users using our default headless [storefront](https://github.com/spree/storefront), you don't need to install this extension, follow [Storefront README](https://github.com/spree/storefront) to setup GA/GTM via ENV variables.
+
+
+# Google Analytics 4 integration for Spree Commerce
+
+This is a Google Analytics 4 extension for [Spree Rails Storefront](https://github.com/spree/spree-rails-storefront).
+
+This [Google Analytics 4 integration for Spree Commerce](https://spreecommerce.org/docs/integrations/analytics/google-analytics) allows you to track user behavior, sales performance, and marketing effectiveness across your store. 
+
+With minimal setup required, you can gain valuable insights into how visitors interact with your site, which can help you make informed decisions to improve conversions, user experience, and overall business strategy.
+
+> [!NOTE]
+> To set up the Google Analytics integration, you must have a Google Analytics account and an associated property.
+
+## Event Tracking
+
+By default, the following events will be tracked in Google Analytics 4:
+- page_view
+- first_visit
+- session_start
+- user_engagement
+- search
+- add_payment_info
+- add_shipping_info
+- add_to_cart
+- add_to_wishlist
+- begin_checkout
+- purchase
+- remove_from_cart
+- view_cart
+- view_item
+
+## Installation
+
+1. Add this extension to your Gemfile with this line:
+
+    ```ruby
+    bundle add spree_google_analytics
+    ```
+
+2. Run the install generator
+
+    ```ruby
+    bundle exec rails g spree_google_analytics:install
+    ```
+
+3. Restart your server
+
+  If your server was running, restart it so that it can find the assets properly.
+
+## Setup
+
+Please follow [our setup guide](https://spreecommerce.org/docs/integrations/analytics/google-analytics) to start tracking all events in Google Analytics dashboard.
+
+## Developing
+
+1. Create a dummy app
+
+    ```bash
+    bundle update
+    bundle exec rake test_app
+    ```
+
+2. Add your new code
+3. Run tests
+
+    ```bash
+    bundle exec rspec
+    ```
+
+When testing your applications integration with this extension you may use it's factories.
+Simply add this require statement to your spec_helper:
+
+```ruby
+require 'spree_google_analytics/factories'
+```
+
+## Releasing a new version
+
+```shell
+bundle exec gem bump -p -t
+bundle exec gem release
+```
+
+For more options please see [gem-release README](https://github.com/svenfuchs/gem-release)
+
+## Contributing
+
+If you'd like to contribute, please take a look at the
+[instructions](CONTRIBUTING.md) for installing dependencies and crafting a good
+pull request.
+
+Copyright (c) 2025 Vendo Connect Inc., Vendo Sp. z o.o., released under the MIT License
+
+## Join the Community 
+
+[Join our Slack](https://slack.spreecommerce.org) to meet other 6k+ community members and get some support.
+
+## Need more support?
+
+[Contact us](https://spreecommerce.org/contact/) for enterprise support and custom development services. We offer:
+  * migrations and upgrades,
+  * delivering your Spree application,
+  * optimizing your Spree stack.

data/Rakefile

@@ -0,0 +1,25 @@
+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_google_analytics'
+  Rake::Task['extension:test_app'].execute(
+    install_storefront: true,
+    install_admin: true
+  )
+  system({ 'BUNDLE_GEMFILE' => File.expand_path('Gemfile', __dir__) }, 'bundle exec rails g spree_posts:install')
+end

data/app/assets/config/spree_google_analytics_manifest.js

@@ -0,0 +1,5 @@
+//= link_tree ../images
+//= link spree_google_analytics/application.js
+//= link_tree ../../javascript/spree_google_analytics/controllers .js
+//= link_tree ../../../vendor/javascript .js
+//= link_tree ../../../vendor/stylesheets .css

data/app/controllers/spree_google_analytics/store_controller_decorator.rb

@@ -0,0 +1,20 @@
+module SpreeGoogleAnalytics
+  module StoreControllerDecorator
+    def self.prepended(base)
+      base.helper SpreeGoogleAnalytics::BaseHelper
+    end
+  end
+end
+
+Spree::StoreController.prepend(SpreeGoogleAnalytics::StoreControllerDecorator) if defined?(Spree::StoreController)
+
+# include in Devise controllers
+if defined?(Spree::UserSessionsController)
+  Spree::UserSessionsController.prepend(SpreeGoogleAnalytics::StoreControllerDecorator)
+end
+if defined?(Spree::UserRegistrationsController)
+  Spree::UserRegistrationsController.prepend(SpreeGoogleAnalytics::StoreControllerDecorator)
+end
+if defined?(Spree::UserPasswordsController)
+  Spree::UserPasswordsController.prepend(SpreeGoogleAnalytics::StoreControllerDecorator)
+end

data/app/helpers/spree_google_analytics/base_helper.rb

@@ -0,0 +1,229 @@
+module SpreeGoogleAnalytics
+  module BaseHelper
+    def google_analytics_client_type
+      @google_analytics_client_type ||= store_integration('google_analytics')&.preferred_client
+    end
+
+    def use_gtm?
+      google_analytics_client_type == 'gtm'
+    end
+
+    def google_analytics_add_shipping_info_json(shipment)
+      SpreeGoogleAnalytics::CheckoutPresenter.new(order: shipment.order).call.merge({ shipping_tier: shipment.shipping_method&.name }).to_json.html_safe
+    end
+
+    def google_analytics_user_properties_json(user)
+      return unless user.present?
+
+      {
+        sign_in_count: user.sign_in_count,
+        created_at: user.created_at&.iso8601.to_s,
+        completed_orders_count: user.orders.complete.count,
+        completed_orders_total: user.orders.complete.sum(:total).to_f
+      }.to_json.html_safe
+    end
+
+
+
+    def google_analytics_view_item_json(variant = nil)
+      variant ||= @selected_variant || @variant_from_options || @product&.default_variant
+      return unless variant.present?
+
+      if use_gtm?
+        google_analytics_gtm_view_item_json(variant)
+      else
+        {
+          currency: current_currency,
+          value: variant.amount_in(current_currency).to_f,
+          items: [
+            SpreeGoogleAnalytics::ProductPresenter.new(
+              store_name: current_store.name,
+              resource: variant,
+              quantity: 1
+            ).call
+          ]
+        }.to_json.html_safe
+      end
+    end
+
+    def google_analytics_gtm_view_item_json(variant)
+      {
+        event: 'view_item',
+        ecommerce: {
+          currency: current_currency,
+          value: variant.amount_in(current_currency).to_f,
+          items: [
+            SpreeGoogleAnalytics::ProductPresenter.new(
+              store_name: current_store.name,
+              resource: variant,
+              quantity: 1
+            ).call
+          ]
+        }
+      }.to_json.html_safe
+    end
+
+    def google_analytics_cart_event_json(line_item, quantity, position)
+      if use_gtm?
+        google_analytics_gtm_cart_event_json(line_item, quantity, position)
+      else
+        {
+          currency: line_item.currency,
+          value: line_item.amount.to_f,
+          items: [
+            SpreeGoogleAnalytics::ProductPresenter.new(
+              resource: line_item,
+              quantity: quantity,
+              position: position
+            ).call
+          ]
+        }.to_json.html_safe
+      end
+    end
+
+    def google_analytics_gtm_cart_event_json(line_item, quantity, position)
+      {
+        event: 'add_to_cart',
+        ecommerce: {
+          currency: line_item.currency,
+          value: line_item.amount.to_f,
+          items: [
+            SpreeGoogleAnalytics::ProductPresenter.new(
+              resource: line_item,
+              quantity: quantity,
+              position: position
+            ).call
+          ]
+        }
+      }.to_json.html_safe
+    end
+
+    def google_analytics_remove_from_cart_event_json(line_item, quantity, position)
+      if use_gtm?
+        google_analytics_gtm_remove_from_cart_event_json(line_item, quantity, position)
+      else
+        google_analytics_cart_event_json(line_item, quantity, position)
+      end
+    end
+
+    def google_analytics_gtm_remove_from_cart_event_json(line_item, quantity, position)
+      {
+        event: 'remove_from_cart',
+        ecommerce: {
+          currency: line_item.currency,
+          value: line_item.amount.to_f,
+          items: [
+            SpreeGoogleAnalytics::ProductPresenter.new(
+              resource: line_item,
+              quantity: quantity,
+              position: position
+            ).call
+          ]
+        }
+      }.to_json.html_safe
+    end
+
+    def google_analytics_add_to_wishlist_event_json(variant)
+      if use_gtm?
+        google_analytics_gtm_add_to_wishlist_event_json(variant)
+      else
+        {
+          currency: current_currency,
+          value: variant.amount_in(current_currency),
+          items: [
+            SpreeGoogleAnalytics::ProductPresenter.new(
+              store_name: current_store.name,
+              resource: variant,
+              quantity: 1
+            ).call
+          ]
+        }.to_json.html_safe
+      end
+    end
+
+    def google_analytics_gtm_add_to_wishlist_event_json(variant)
+      {
+        event: 'add_to_wishlist',
+        ecommerce: {
+          currency: current_currency,
+          value: variant.amount_in(current_currency),
+          items: [
+            SpreeGoogleAnalytics::ProductPresenter.new(
+              store_name: current_store.name,
+              resource: variant,
+              quantity: 1
+            ).call
+          ]
+        }
+      }.to_json.html_safe
+    end
+
+    def google_analytics_checkout_json
+      return unless @order.present?
+
+      if use_gtm?
+        google_analytics_gtm_checkout_json
+      else
+        @google_analytics_checkout_json ||= SpreeGoogleAnalytics::CheckoutPresenter.new(order: @order).call.to_json.html_safe
+      end
+    end
+
+    def google_analytics_gtm_checkout_json
+      @google_analytics_gtm_checkout_json ||= {
+        event: 'begin_checkout',
+        ecommerce: SpreeGoogleAnalytics::CheckoutPresenter.new(order: @order).call
+      }.to_json.html_safe
+    end
+
+    def google_analytics_purchase_json
+      return unless @order.present?
+
+      if use_gtm?
+        google_analytics_gtm_purchase_json
+      else
+        @google_analytics_purchase_json ||= SpreeGoogleAnalytics::OrderPresenter.new(order: @order).call.to_json.html_safe
+      end
+    end
+
+    def google_analytics_gtm_purchase_json
+      @google_analytics_gtm_purchase_json ||= {
+        event: 'purchase',
+        ecommerce: SpreeGoogleAnalytics::OrderPresenter.new(order: @order).call
+      }.to_json.html_safe
+    end
+
+    def google_analytics_payment_json
+      return unless @order.present?
+
+      if use_gtm?
+        google_analytics_gtm_payment_json
+      else
+        @google_analytics_payment_json ||= SpreeGoogleAnalytics::PaymentPresenter.new(order: @order).call.to_json.html_safe
+      end
+    end
+
+    def google_analytics_gtm_payment_json
+      @google_analytics_gtm_payment_json ||= {
+        event: 'add_payment_info',
+        ecommerce: SpreeGoogleAnalytics::PaymentPresenter.new(order: @order).call
+      }.to_json.html_safe
+    end
+
+    def google_analytics_view_cart_json
+      return unless @order.present?
+
+      if use_gtm?
+        google_analytics_gtm_view_cart_json
+      else
+        @google_analytics_view_cart_json ||= SpreeGoogleAnalytics::CheckoutPresenter.new(order: @order).call.to_json.html_safe
+      end
+    end
+
+    def google_analytics_gtm_view_cart_json
+      @google_analytics_gtm_view_cart_json ||= {
+        event: 'view_cart',
+        ecommerce: SpreeGoogleAnalytics::CheckoutPresenter.new(order: @order).call
+      }.to_json.html_safe
+    end
+  end
+end

data/app/javascript/spree_google_analytics/application.js

@@ -0,0 +1,16 @@
+import '@hotwired/turbo-rails'
+import { Application } from '@hotwired/stimulus'
+
+let application
+
+if (typeof window.Stimulus === "undefined") {
+  application = Application.start()
+  application.debug = false
+  window.Stimulus = application
+} else {
+  application = window.Stimulus
+}
+
+import SpreeGoogleAnalyticsController from 'spree_google_analytics/controllers/spree_google_analytics_controller'
+
+application.register('spree_google_analytics', SpreeGoogleAnalyticsController)

data/app/javascript/spree_google_analytics/controllers/spree_google_analytics_controller.js

@@ -0,0 +1,41 @@
+import { Controller } from "@hotwired/stimulus";
+
+// [#1063] Turbo Drive 遷移での page_view 計測。
+//
+// Spree のストアフロントは Turbo Drive でページ遷移するため、_head 内の
+// gtag('config', ID) は初回ロード時に一度実行されるだけで、リンククリックによる
+// 遷移では再実行されない。そのため標準の自動 page_view では初回ページしか
+// 計測できない。
+//
+// このコントローラは turbo:load を購読し、遷移のたびに page_view を手動送信する。
+// _head 側で send_page_view: false にしてあるので、初回ロードも含めてここから
+// 一元的に送る(初回の二重送信は起きない)。
+export default class extends Controller {
+  connect() {
+    // body 差し替えで connect が複数回呼ばれても多重購読しないようガード。
+    if (window.__spreeGAPageviewBound) return;
+    window.__spreeGAPageviewBound = true;
+
+    this.sendPageView = this.sendPageView.bind(this);
+    document.addEventListener("turbo:load", this.sendPageView);
+  }
+
+  sendPageView() {
+    const payload = {
+      page_location: window.location.href,
+      page_path: window.location.pathname + window.location.search,
+      page_title: document.title,
+    };
+
+    // GA4 (gtag.js)
+    if (typeof window.gtag === "function") {
+      window.gtag("event", "page_view", payload);
+      return;
+    }
+
+    // Google Tag Manager (dataLayer)
+    if (window.dataLayer && typeof window.dataLayer.push === "function") {
+      window.dataLayer.push({ event: "page_view", ...payload });
+    }
+  }
+}

data/app/models/spree/integrations/google_analytics.rb

@@ -0,0 +1,21 @@
+module Spree
+  module Integrations
+    class GoogleAnalytics < Spree::Integration
+      preference :measurement_id, :string
+      preference :google_tag_manager_id, :string
+      preference :client, :string, default: 'ga4'
+
+      validates :preferred_measurement_id, presence: true, if: -> { preferred_client == 'ga4' }
+      validates :preferred_google_tag_manager_id, presence: true, if: -> { preferred_client == 'gtm' }
+      validates :preferred_client, inclusion: { in: %w[ga4 gtm] }
+
+      def self.integration_group
+        'analytics'
+      end
+
+      def self.icon_path
+        'integration_icons/google-analytics-logo.png'
+      end
+    end
+  end
+end

data/app/presenters/spree_google_analytics/checkout_presenter.rb

@@ -0,0 +1,12 @@
+module SpreeGoogleAnalytics
+  class CheckoutPresenter < OrderPresenter
+    def call
+      {
+        currency: @order.currency,
+        value: @order.analytics_subtotal,
+        coupon: try_coupon_code,
+        items: products(@order)
+      }.merge(try_debug_mode)
+    end
+  end
+end

data/app/presenters/spree_google_analytics/order_presenter.rb

@@ -0,0 +1,59 @@
+module SpreeGoogleAnalytics
+  class OrderPresenter
+    include Spree::BaseHelper
+
+    def initialize(order:)
+      @order = order
+    end
+
+    def call
+      {
+        currency: @order.currency,
+        transaction_id: @order.number,
+        value: @order.analytics_subtotal,
+        coupon: try_coupon_code,
+        shipping: @order.shipment_total.to_f,
+        tax: @order.additional_tax_total.to_f,
+        items: products(@order)
+      }.merge(try_debug_mode)
+        .merge(gift_card_attributes)
+    end
+
+    private
+
+    def products(order)
+      return [] if order.line_items.empty?
+
+      product_includes = %i[taxons]
+      product_includes << :vendor if defined?(Spree::Vendor)
+
+      @products ||= order.line_items.includes(variant: { product: product_includes }).map.with_index do |line_item, index|
+        ProductPresenter.new(
+          resource: line_item,
+          quantity: line_item.quantity,
+          position: index + 1
+        ).call
+      end
+    end
+
+    def try_debug_mode
+      ENV['GA_DEBUG_MODE'].present? ? { debug_mode: 1 } : {}
+    end
+
+    def try_coupon_code
+      (@order.coupon_code || @order.try(:gift_card).try(:code)).to_s
+    end
+
+    def gift_card_attributes
+      return {} unless defined?(Spree::GiftCard)
+      return {} unless @order.gift_card.present?
+
+      {
+        gift_card_code: @order.gift_card&.code.to_s.upcase,
+        gift_card_amount: @order.gift_card_total.to_f,
+        gift_card_balance: @order.gift_card&.amount_remaining.to_f,
+        total_minus_store_credits: @order.total_minus_store_credits.to_f
+      }
+    end
+  end
+end

data/app/presenters/spree_google_analytics/payment_presenter.rb

@@ -0,0 +1,7 @@
+module SpreeGoogleAnalytics
+  class PaymentPresenter < CheckoutPresenter
+    def call
+      super.merge({ payment_type: @order.payments&.last&.payment_method&.name })
+    end
+  end
+end

data/app/presenters/spree_google_analytics/product_presenter.rb

@@ -0,0 +1,54 @@
+module SpreeGoogleAnalytics
+  class ProductPresenter
+    include Spree::BaseHelper
+    include Spree::ProductsHelper
+
+    # @param resource [Spree::LineItem, Spree::Variant]
+    # @param quantity [Integer]
+    # @param position [Integer]
+    # @param store_name [String]
+    def initialize(resource:, quantity:, position: nil, store_name: nil)
+      @resource = resource
+      @quantity = quantity
+      @position = position
+      @store_name = store_name
+    end
+
+    # @return [Hash]
+    def call
+      {
+        item_id: @resource.sku.presence || @resource.product_id,
+        item_name: @resource.name,
+        affiliation: @resource.respond_to?(:order) && @resource.order&.store.present? ? @resource.order.store.name : @store_name,
+        discount: 0.00,
+        index: @position.to_s,
+        item_brand: @resource.product.present? ? @resource.product.brand_name.to_s : '',
+        item_category: taxons[0].to_s,
+        item_category2: taxons[1].to_s,
+        item_category3: taxons[2].to_s,
+        item_category4: taxons[3].to_s,
+        item_category5: taxons[4].to_s,
+        item_list_id: '',
+        item_list_name: '',
+        item_variant: @resource.try(:options_text),
+        location_id: '',
+        price: @resource.price.to_f,
+        quantity: @quantity
+      }.merge(try_promotion_codes_applied_to_line_item)
+    end
+
+    private
+
+    def try_promotion_codes_applied_to_line_item
+      return {} if @resource.class != Spree::LineItem
+
+      { coupon: @resource.adjustments.promotion.map do |adjustment|
+        adjustment.source.promotion.code
+      end.compact.uniq.join(',') }
+    end
+
+    def taxons
+      @taxons ||= @resource.product.main_taxon&.pretty_name.to_s.split('->').map(&:strip)
+    end
+  end
+end

data/app/views/spree/admin/integrations/forms/_google_analytics.html.erb

@@ -0,0 +1,22 @@
+<div class="card mb-4">
+  <div class="card-body" data-controller="reveal">
+    <% if @integration.persisted? %>
+      <div class="alert alert-warning">
+        <%= Spree.t('admin.integrations.google_analytics.reports_warning') %>
+      </div>
+    <% end %>
+
+    <%= form.spree_collection_select "preferred_client", [['Google Analytics 4', 'ga4'], ['Google Tag Manager', 'gtm']], :last, :first, { selected: @integration.preferred_client, label: Spree.t('admin.integrations.google_analytics.client'), help: Spree.t('admin.integrations.google_analytics.client_help') }, { data: { action: 'change->reveal#toggle' } } %>
+
+    <div class="<%= class_names(hidden: @integration.preferred_client == 'gtm') %>" data-reveal-target="item">
+      <%= preference_field(@integration, form, 'measurement_id', i18n_scope: 'admin.integrations.google_analytics') %>
+      <%= external_link_to 'Where to find my Measurement ID?', 'https://support.google.com/analytics/answer/12270356' %>
+    </div>
+
+    <div class="<%= class_names(hidden: @integration.preferred_client == 'ga4') %>" data-reveal-target="item">
+      <%= preference_field(@integration, form, 'google_tag_manager_id', i18n_scope: 'admin.integrations.google_analytics') %>
+      <%= external_link_to 'Where to find my Google Tag Manager ID?', 'https://support.google.com/tagmanager/answer/6107028' %>
+      </div>
+  </div>
+</div>
+

data/app/views/spree_google_analytics/_add_to_cart.html.erb

@@ -0,0 +1,15 @@
+<% if store_integration('google_analytics').present? %>
+  <script>
+    <% safely do %>
+      <% if use_gtm? %>
+        if (window.dataLayer) {
+          dataLayer.push(<%= google_analytics_cart_event_json(@line_item, @line_item.quantity, @order.line_items.pluck(:id).index(@line_item.id) + 1) %>);
+        }
+      <% else %>
+        if (window.gtag) {
+          gtag('event', 'add_to_cart', <%= google_analytics_cart_event_json(@line_item, @line_item.quantity, @order.line_items.pluck(:id).index(@line_item.id) + 1) %>);
+        }
+      <% end %>
+    <% end %>
+  </script>
+<% end %>