spree_analytics_trackers 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0b6411079e555367f446b09fa1a87c6d65ae92a91492864063597fda033d168
-  data.tar.gz: 817b4c0ad4564596b3e38813557d58f3eb68359d9fb388a8e4f65c6f9c6a4f10
+  metadata.gz: 502cf1fa8e70cb9ceb4e1b24ec08c257cb5314249e5ab3403aa61ae463fb69fc
+  data.tar.gz: 4c44fd4f1c8172a51499a1e4bcef65538e185ad2c8ace20728a05c28e8347542
 SHA512:
-  metadata.gz: 5cb572bed798cf004072d91cd33892302fec6a622fabaa03b0b30bbed97af66215450abfd9f99bb41147ad499656611070e9aa475961f931c5fa16dad00782b4
-  data.tar.gz: b8366a5461585d8f75ff2e6256b9f1b1ea6d5e2f22ae7940aafb9a3d147d63958ecbd8332e8f5ab1728840558d6eb4b2b16f829cf7e93c50f4749047234cc98e
+  metadata.gz: 7824a5e18c3a7d0cd5afdb714f5ef4f727acfbc13e542ad7d33451b5478db03a530ae17dacb48a2dfc799084b3fd4a266417a6c6dfa2dd58d6d98a01c4625c2e
+  data.tar.gz: 54f3aeb09eb35e8c0a285778b5e2c91a57dcdd5971b618343a006fcc8a5dbaf7073fbcf902d540c52788d630848992f8e83ff4ec5511dde26295ea64a9ffa959

data/app/assets/javascripts/spree/frontend/remove_from_cart_analytics.js

@@ -0,0 +1,34 @@
+//= require spree/frontend
+
+function gaRemoveFromCart(variant) {
+  clearGAplugins();
+  gtag(
+    'event',
+    'remove_from_cart',
+    {
+      items: [{
+        id: variant.sku,
+        name: variant.name,
+        price: variant.price,
+        variant: variant.options,
+        quantity: variant.quantity
+      }]
+    }
+  );
+}
+
+Spree.ready(function(){
+  $('body').on('product_remove_from_cart', function(event) {
+    var variant = {
+      sku: event.variant_sku,
+      name: event.variant_name,
+      price: event.variant_price,
+      options: event.variant_options,
+      quantity: event.variant_quantity
+    }
+
+    if (typeof gtag !== 'undefined') {
+      gaRemoveFromCart(variant)
+    }
+  })
+})

data/app/helpers/spree/trackers_helper.rb

@@ -66,5 +66,21 @@ module Spree
       end
       params_with_values
     end
+
+    def segment_tracker
+      @segment_tracker ||= Spree::Tracker.current(:segment, current_store)
+    end
+
+    def segment_enabled?
+      segment_tracker.present?
+    end
+
+    def ga_tracker
+      @ga_tracker ||= Spree::Tracker.current(:google_analytics, current_store)
+    end
+
+    def ga_enabled?
+      ga_tracker.present?
+    end
   end
 end

data/app/overrides/add_google_analytics_to_spree_application.rb

@@ -2,7 +2,7 @@ if Gem.loaded_specs['spree_core'].version >= Gem::Version.create('3.5.0.alpha')
   Deface::Override.new(
     virtual_path: 'spree/shared/_head',
     name: 'add_google_analytics_initializer_to_spree_application',
-    insert_before: 'meta',
+    insert_after: 'title',
     partial: 'spree/shared/trackers/google_analytics/initializer.js',
     original: 'cfa30a2831d9a41394c03229cd28b3c7eee69585'
   )

data/app/overrides/add_segment_initializer_to_layout.rb

@@ -3,7 +3,7 @@ unless spree_version >= Gem::Version.create('3.3.0') && spree_version < Gem::Ver
   Deface::Override.new(
     virtual_path: 'spree/shared/_head',
     name: 'add_segment_initializer_to_layout',
-    insert_before: 'meta',
+    insert_after: 'title',
     partial: 'spree/shared/trackers/segment/initializer.js',
     original: '6841b819babbe4df1f03d0bc8e05dc81bf0d45ad'
   )

data/app/views/spree/shared/trackers/google_analytics/_checkout_step_viewed.js.erb

@@ -1,18 +1,19 @@
-<% if @order.present? && !@order.completed? && Spree::Tracker.current(:google_analytics, current_store) %>
+<% if ga_enabled? && @order.present? && !@order.completed? %>
   <script>
-    if (typeof gtag !== 'undefined') {
-      clearGAplugins();
-      gtag('event', 'checkout_progress', {
-        checkout_step: '<%= (@order.checkout_steps.index(@order.state) + 1) %>',
-        items: [
-          <% @order.line_items.each do |line_item| %>
-            <%= ga_line_item(line_item) %>,
-          <% end %>
-        ],
-
-        coupon: '<%= @order.promo_code %>',
-        checkout_option: '<%= @order.state %>'
-      });
-    };
+    window.addEventListener('turbolinks:load', function() {
+      if (typeof gtag !== 'undefined') {
+        clearGAplugins();
+        gtag('event', 'checkout_progress', {
+          checkout_step: '<%= (@order.checkout_steps.index(@order.state) + 1) %>',
+          items: [
+            <% @order.line_items.each do |line_item| %>
+              <%= ga_line_item(line_item) %>,
+            <% end %>
+          ],
+          coupon: '<%= @order.promo_code %>',
+          checkout_option: '<%= @order.state %>'
+        });
+      };
+    });
   </script>
 <% end %>

data/app/views/spree/shared/trackers/google_analytics/_initializer.js.erb

@@ -1,12 +1,12 @@
-<% if tracker = Spree::Tracker.current(:google_analytics, current_store) %>
+<% if ga_enabled? %>
   <!-- Global site tag (gtag.js) - Google Analytics -->
-  <script async src="https://www.googletagmanager.com/gtag/js?id=<%= tracker.analytics_id %>"></script>
+  <script async src="https://www.googletagmanager.com/gtag/js?id=<%= ga_tracker.analytics_id %>"></script>
   <script>
     window.dataLayer = window.dataLayer || [];
     function gtag(){dataLayer.push(arguments);}
     gtag('js', new Date());
 
-    gtag('config', '<%= tracker.analytics_id %>', { 'send_page_view': false });
+    gtag('config', '<%= ga_tracker.analytics_id %>', { 'send_page_view': false });
     gtag('set', 'allow_google_signals', true )
     gtag('set', 'allow_ad_personalization_signals', true );
 

data/app/views/spree/shared/trackers/google_analytics/_page_viewed.js.erb

@@ -1,12 +1,12 @@
-<% if tracker = Spree::Tracker.current(:google_analytics, current_store) %>
+<% if ga_enabled? %>
   <script>
     if (typeof gtag !== 'undefined') {
       <% if user_id = try_spree_current_user.try(:id) %>
-        gtag('config', '<%= tracker.analytics_id %>', {
+        gtag('config', '<%= ga_tracker.analytics_id %>', {
           'user_id': '<%= user_id %>'
         });
       <% else %>
-        gtag('config', '<%= tracker.analytics_id %>');
+        gtag('config', '<%= ga_tracker.analytics_id %>');
       <% end %>
     }
   </script>

data/app/views/spree/shared/trackers/google_analytics/_purchase.js.erb

@@ -1,20 +1,22 @@
-<% if @order.present? && order_just_completed?(@order) && Spree::Tracker.current(:google_analytics, current_store) %>
+<% if ga_enabled? && @order.present? && order_just_completed?(@order) %>
   <script>
-    if (typeof gtag !== 'undefined') {
-      clearGAplugins();
-      gtag('event', 'purchase', {
-        transaction_id: '<%= @order.number %>',
-        value: <%= @order.total&.to_f %>,
-        currency: '<%= @order.currency %>',
-        tax: <%= @order.tax_total&.to_f %>,
-        shipping: <%= @order.shipment_total&.to_f %>,
-        coupon: '<%= @order.promo_code %>',
-        items: [
-          <% @order.line_items.each do |line_item| %>
-            <%= ga_line_item(line_item) %>,
-          <% end %>
-        ]
-      });
-    }
+    window.addEventListener('turbolinks:load', function() {
+      if (typeof gtag !== 'undefined') {
+        clearGAplugins();
+        gtag('event', 'purchase', {
+          transaction_id: '<%= @order.number %>',
+          value: <%= @order.total&.to_f %>,
+          currency: '<%= @order.currency %>',
+          tax: <%= @order.tax_total&.to_f %>,
+          shipping: <%= @order.shipment_total&.to_f %>,
+          coupon: '<%= @order.promo_code %>',
+          items: [
+            <% @order.line_items.each do |line_item| %>
+              <%= ga_line_item(line_item) %>,
+            <% end %>
+          ]
+        });
+      }
+    });
   </script>
 <% end %>

data/app/views/spree/shared/trackers/segment/_cart_viewed.js.erb

@@ -1,22 +1,27 @@
-<% if @order.present? && !@order.complete? && Spree::Tracker.current(:segment, current_store) %>
+<% if segment_enabled? && @order.present? && !@order.complete? %>
   <script>
-    if (typeof analytics !== 'undefined') {
-      var segmentCartJson = {
-        cart_id: '<%= @order.number %>',
-        products: [
-        <% @order.line_items.each_with_index do |line_item, index| %>
-          <%= product_for_segment(
-            line_item.product, 
-            position: index+1, 
-            quantity: line_item.quantity, 
-            image: default_image_for_product_or_variant(line_item.variant)
-          ) %>,
-        <% end %>
-        ]
-      }
+    window.addEventListener('turbolinks:load', function() {
+      if (typeof analytics !== 'undefined') {
+        var segmentCartJson = {
+          cart_id: '<%= @order.number %>',
+          products: [
+            <% @order.line_items.each_with_index do |line_item, index| %>
+              <%=
+                product_for_segment(
+                  line_item.product,
+                  position: index+1,
+                  quantity: line_item.quantity,
+                  image: default_image_for_product_or_variant(line_item.variant)
+                )
+              %>,
+            <% end %>
+          ]
+        }
 
-      analytics.track('Cart Viewed', segmentCartJson);
-      analytics.page('Cart Viewed', segmentCartJson);
-    }
+        analytics.track('Cart Viewed', segmentCartJson);
+        analytics.page('Cart Viewed', segmentCartJson);
+      }
+    });
   </script>
 <% end %>
+

data/app/views/spree/shared/trackers/segment/_checkout_step_viewed.js.erb

@@ -1,14 +1,21 @@
-<% if @order.present? && !@order.completed? && Spree::Tracker.current(:segment, current_store) %>
+<% if segment_enabled? && @order.present? && !@order.completed? %>
   <script>
-    if (typeof analytics !== 'undefined') {
-      analytics.track('Checkout Step Viewed', {
-        checkout_id: '<%= @order.number %>',
-        step: '<%= (@order.checkout_steps.index(@order.state) + 1) %>'
-      });
-      analytics.page('Checkout Step Viewed', {
-        checkout_id: '<%= @order.number %>',
-        step: '<%= (@order.checkout_steps.index(@order.state) + 1) %>'
-      });
-    }
+    window.addEventListener('turbolinks:load', function() {
+      if (typeof analytics !== 'undefined') {
+        analytics.track('Checkout Step Viewed',
+          {
+            checkout_id: '<%= @order.number %>',
+            step: '<%= (@order.checkout_steps.index(@order.state) + 1) %>'
+          }
+        );
+
+        analytics.page('Checkout Step Viewed',
+          {
+            checkout_id: '<%= @order.number %>',
+            step: '<%= (@order.checkout_steps.index(@order.state) + 1) %>'
+          }
+        );
+      }
+    });
   </script>
 <% end %>  

data/app/views/spree/shared/trackers/segment/_initializer.js.erb

@@ -1,7 +1,7 @@
-<% if tracker = Spree::Tracker.current(:segment, current_store) %>
+<% if segment_enabled? %>
   <script>
     !function(){var analytics=window.analytics=window.analytics||[];if(!analytics.initialize)if(analytics.invoked)window.console&&console.error&&console.error("Segment snippet included twice.");else{analytics.invoked=!0;analytics.methods=["trackSubmit","trackClick","trackLink","trackForm","pageview","identify","reset","group","track","ready","alias","debug","page","once","off","on"];analytics.factory=function(t){return function(){var e=Array.prototype.slice.call(arguments);e.unshift(t);analytics.push(e);return analytics}};for(var t=0;t<analytics.methods.length;t++){var e=analytics.methods[t];analytics[e]=analytics.factory(e)}analytics.load=function(t,e){var n=document.createElement("script");n.type="text/javascript";n.async=!0;n.src="https://cdn.segment.com/analytics.js/v1/"+t+"/analytics.min.js";var a=document.getElementsByTagName("script")[0];a.parentNode.insertBefore(n,a);analytics._loadOptions=e};analytics.SNIPPET_VERSION="4.1.0";
-      analytics.load('<%=tracker.analytics_id%>'.replace(/^\s+|\s+$/g, ''));
+      analytics.load('<%=segment_tracker.analytics_id%>'.replace(/^\s+|\s+$/g, ''));
     }}();
   </script>
 <% end %>

data/app/views/spree/shared/trackers/segment/_order_complete.js.erb

@@ -1,8 +1,11 @@
-<% if @order.present? && order_just_completed?(@order) && Spree::Tracker.current(:segment, current_store) %>
+<% if segment_enabled? && @order.present? && order_just_completed?(@order) %>
   <% order_json = SpreeAnalyticsTrackers::Segment::OrderPresenter.new(@order).to_json %>
   <script>
-    if (typeof analytics !== 'undefined') {
-      analytics.page('Order Completed', <%= order_json.html_safe %>);
-    }
+    window.addEventListener('turbolinks:load', function() {
+      if (typeof analytics !== 'undefined') {
+        analytics.page('Order Completed', <%= order_json.html_safe %>);
+        analytics.track('Order Completed', <%= order_json.html_safe %>);
+      }
+    });
   </script>
 <% end %>

data/app/views/spree/shared/trackers/segment/_page_viewed.js.erb

@@ -1,4 +1,4 @@
-<% if tracker = Spree::Tracker.current(:segment, current_store) %>
+<% if segment_enabled? %>
   <script>
     if (typeof analytics !== 'undefined') {
       analytics.page();

data/app/views/spree/shared/trackers/segment/_product_list_filtered.js.erb

@@ -1,21 +1,23 @@
-<% if any_filtering_params? && Spree::Tracker.current(:segment, current_store) %>
+<% if segment_enabled? && any_filtering_params? %>
   <script>
-    if (typeof analytics !== 'undefined') {
-      var segmentProductListFilteredJson = {
-        filters: [
-          <% filtering_params_with_values.each do |type, value| %>
-            <%= { type: type, value: value } .to_json.html_safe %>,
-          <% end %>
-        ],
-        products: [
-        <% @products.each_with_index do |product, index| %>
-          <%= product_for_segment(product, position: index+1) %>,
-        <% end %>
-        ]
-      }
+    window.addEventListener('turbolinks:load', function() {
+      if (typeof analytics !== 'undefined') {
+        var segmentProductListFilteredJson = {
+          filters: [
+            <% filtering_params_with_values.each do |type, value| %>
+              <%= { type: type, value: value } .to_json.html_safe %>,
+            <% end %>
+          ],
+          products: [
+            <% @products.each_with_index do |product, index| %>
+              <%= product_for_segment(product, position: index + 1) %>,
+            <% end %>
+          ]
+        }
 
-      analytics.track('Product List Filtered', segmentProductListFilteredJson);
-      analytics.page('Product List Filtered', segmentProductListFilteredJson);
-    }
+        analytics.track('Product List Filtered', segmentProductListFilteredJson);
+        analytics.page('Product List Filtered', segmentProductListFilteredJson);
+      }
+    });
   </script>
 <% end %>

data/app/views/spree/shared/trackers/segment/_product_list_viewed.js.erb

@@ -1,17 +1,19 @@
-<% if defined?(products) && products.present? && Spree::Tracker.current(:segment, current_store) %>
+<% if segment_enabled? && defined?(products) && products.present? %>
   <script>
-    if (typeof analytics !== 'undefined') {
-      var segmentProductListViewedJson = {
-        category: '<%= @taxon&.name %>',
-        products: [
-        <% products.each_with_index do |product, index| %>
-          <%= product_for_segment(product, position: index+1, image: default_image_for_product_or_variant(product)) %>,
-        <% end %>
-        ]
-      }
+    window.addEventListener('turbolinks:load', function() {
+      if (typeof analytics !== 'undefined') {
+        var segmentProductListViewedJson = {
+          category: '<%= @taxon&.name %>',
+          products: [
+            <% products.each_with_index do |product, index| %>
+              <%= product_for_segment(product, position: index+1, image: default_image_for_product_or_variant(product)) %>,
+            <% end %>
+          ]
+        }
 
-      analytics.track('Product List Viewed', segmentProductListViewedJson);
-      analytics.page('Product List Viewed', segmentProductListViewedJson);
-    }
+        analytics.track('Product List Viewed', segmentProductListViewedJson);
+        analytics.page('Product List Viewed', segmentProductListViewedJson);
+      }
+    });
   </script>
 <% end %>

data/app/views/spree/shared/trackers/segment/_product_viewed.js.erb

@@ -1,10 +1,12 @@
-<% if @product.present? && Spree::Tracker.current(:segment, current_store) %>
+<% if segment_enabled? && @product.present? %>
   <script>
-    if (typeof analytics !== 'undefined') {
-      var segmentProductViewed = <%= product_for_segment(@product, image: default_image_for_product_or_variant(@product)) %>;
+    window.addEventListener('turbolinks:load', function() {
+      if (typeof analytics !== 'undefined') {
+        var segmentProductViewed = <%= product_for_segment(@product, image: default_image_for_product_or_variant(@product)) %>;
 
-      analytics.page('Product Viewed', segmentProductViewed);
-      analytics.track('Product Viewed', segmentProductViewed);
-    }
+        analytics.page('Product Viewed', segmentProductViewed);
+        analytics.track('Product Viewed', segmentProductViewed);
+      }
+    });
   </script>
 <% end %>

data/app/views/spree/shared/trackers/segment/_products_searched.js.erb

@@ -1,12 +1,10 @@
-<% if params.key?(:keywords) && params[:keywords].present? && Spree::Tracker.current(:segment, current_store) %>
+<% if segment_enabled? && params.key?(:keywords) && params[:keywords].present? %>
   <script>
-    if (typeof analytics !== 'undefined') {
-      analytics.track('Products Searched', {
-        query: '<%= params[:keywords] %>',
-      });
-      analytics.page('Products Searched', {
-        query: '<%= params[:keywords] %>',
-      });
-    }
+    window.addEventListener('turbolinks:load', function() {
+      if (typeof analytics !== 'undefined') {
+        analytics.track('Products Searched', { query: '<%= params[:keywords] %>' });
+        analytics.page('Products Searched', { query: '<%= params[:keywords] %>' });
+      }
+    });
   </script>
 <% end %>

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

@@ -8,6 +8,7 @@ module SpreeAnalyticsTrackers
         return unless File.file?(javascripts_path)
 
         append_file 'vendor/assets/javascripts/spree/frontend/all.js', "//= require spree/frontend/add_to_cart_analytics\n"
+        append_file 'vendor/assets/javascripts/spree/frontend/all.js', "//= require spree/frontend/remove_from_cart_analytics\n"
       end
 
       def add_migrations

data/lib/spree_analytics_trackers/version.rb

@@ -9,7 +9,7 @@ module SpreeAnalyticsTrackers
 
   module VERSION
     MAJOR = 2
-    MINOR = 0
+    MINOR = 1
     TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].compact.join('.')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spree_analytics_trackers
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Spark Solutions
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-11 00:00:00.000000000 Z
+date: 2021-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spree_core
@@ -109,6 +109,7 @@ files:
 - README.md
 - Rakefile
 - app/assets/javascripts/spree/frontend/add_to_cart_analytics.js
+- app/assets/javascripts/spree/frontend/remove_from_cart_analytics.js
 - app/controllers/spree/admin/trackers_controller.rb
 - app/controllers/spree_analytics_trackers/store_controller_decorator.rb
 - app/helpers/spree/trackers_helper.rb
@@ -174,7 +175,7 @@ homepage: https://github.com/spree-contrib/spree_analytics_trackers
 licenses:
 - BSD-3-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -190,8 +191,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - none
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Adds analytics trackers functionality to Spree
 test_files: