solidus_seo 1.0.7 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91977b19b9d261263477d03108cbcbd5062b6b1a0e19f56f02da4f1d9e3d6d89
-  data.tar.gz: 7293522b84d2c7780bbc12b753b39af45ed2acfcc86e2d411fa01446de0e9690
+  metadata.gz: 3626084993746b4fd03d1ac122e5e5fd15e2c425e24c09ff66e48c85a8f58fd8
+  data.tar.gz: dc2e82b2dae8291d44ef540c3085b5ccc85682819acb3c405308e33e879f987b
 SHA512:
-  metadata.gz: 3143fa46338c323818466c31af1a3531512d1976d84562f61ef61aa7e24838252a413f26f16300ed9c0fc147d2e7b261f29625b298162a46b319e41daba8f103
-  data.tar.gz: ea778900d7f14049f4234a36849e3731ec1c6a4a60b33303203e024fb1bbfb54c0ce8052e617f62a2f0bc56bcfee9a3de27dfd606a99ac92bde56db6b43d774b
+  metadata.gz: 5523b7a476f2e1f0fb42ea23ca16c926ecbff1f6c32f65438d431bfcb55c4ad84bdb3a4599356235f949b1c7dbafdfb1289d7edd98222851bd2d9d8aa6309471
+  data.tar.gz: 8b63780e4f7d9619c0c48dfda3f026a39e0b193fcda651df108d3ef5f60cbcc873d21155f1355ead1eeb8d60ec5249c536b469ec88ee69c51835e67a1183ad62

data/app/decorators/controllers/spree/orders_controller_decorator.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Spree
+  module OrdersControllerDecorator
+    def self.prepended(base)
+      base.class_eval do
+        around_action :calculate_cart_diff, only: :populate
+      end
+    end
+
+    private
+
+    def calculate_cart_diff
+      previous_cart_items = order_contents_hash
+
+      yield
+
+      current_cart_items = order_contents_hash
+
+      cart_diff = current_cart_items.map do |variant_sku, quantity|
+        added_quantity = quantity - (previous_cart_items[variant_sku] || 0)
+
+        [variant_sku, added_quantity.positive? ? added_quantity : nil]
+      end.to_h.compact
+
+      cart_diff = cart_diff.map do |variant_sku, quantity|
+        variant = Spree::Variant.find_by(sku: variant_sku)
+
+        [
+          variant_sku,
+          {
+            id: variant.product.master.sku,
+            name: variant.product.name,
+            variant: variant.options_text,
+            price: variant.price,
+            quantity: quantity
+          }
+        ]
+      end.to_h
+
+      flash[:added_to_cart] = cart_diff if cart_diff.present?
+    end
+
+    def order_contents_hash
+      return {} if current_order.blank?
+
+      current_order.line_items.each_with_object({}) do |li, acc|
+        acc[li.variant.sku] ||= 0
+        acc[li.variant.sku] += li.quantity
+      end
+    end
+
+    ::Spree::StoreController.prepend(self)
+  end
+end

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

@@ -40,14 +40,8 @@ module Spree
       master.default_price.amount
     end
 
-    def any_in_stock?
-      return variants_including_master.any? unless Spree::Config.track_inventory_levels
-      arel_conditions = [
-        variants_including_master.arel_table[:track_inventory].eq(false),
-        Spree::StockItem.arel_table[:count_on_hand].gt(0)
-      ]
-      in_stock_variants = variants_including_master.joins(:stock_items).where(arel_conditions.inject(:or))
-      in_stock_variants.any?
+    def in_stock?
+      available? && variants_including_master.suppliable.any?
     end
 
     def seo_data
@@ -98,7 +92,7 @@ module Spree
           "priceCurrency": seo_currency,
           "price": seo_price,
           "itemCondition": "http://schema.org/NewCondition",
-          "availability": "http://schema.org/#{ any_in_stock? ? 'InStock' : 'OutOfStock'}",
+          "availability": "http://schema.org/#{ in_stock? ? 'InStock' : 'OutOfStock'}",
         }
       }
     end

data/app/views/solidus_seo/_analytics.html.erb

@@ -1,159 +1,10 @@
-<%
-just_purchased = @order && order_just_completed?(@order)
-if ENV.values_at('GOOGLE_TAG_MANAGER_ID', 'GOOGLE_ANALYTICS_ID', 'FACEBOOK_PIXEL_ID', 'PINTEREST_TAG_ID').any? \
-   && just_purchased
-
-  shared_order_data = {
-    affiliation: current_store.name,
-    currency: @order.currency,
-    tax: @order.tax_total,
-    shipping: @order.ship_total
-  }
-
-  purchased_items = @order.line_items.map do |line_item|
-    variant = line_item.variant
-
-    next unless variant
-
-    {
-      id: variant.sku,
-      name: variant.name,
-      price: line_item.total,
-      variant: variant.options_text,
-      quantity: line_item.quantity
-    }
-  end.compact
-
-end %>
-
 <script>
-    window.solidusSeoListener = function (tagName, eventName) {
+    window.solidusSeoDataLayer = function (tagName, eventName) {
         var tag = document.querySelector('script[data-tag=' + tagName + ']');
-        if(!tag) return;
         tag.dataset.firedEvents = eventName;
     }
 </script>
 
-<% if ENV['GOOGLE_TAG_MANAGER_ID'].present? %>
-
-<script type="text/javascript" data-tag="google-tag-manager">
-    window.dataLayer = window.dataLayer || [];
-
-    <% if just_purchased %>
-        let orderData = Object.assign({}, <%= raw shared_order_data.to_json %>, {
-            'id': '<%= j @order.number %>', // Transaction ID. Required for purchases and refunds.
-            'revenue': '<%= @order.total %>', // Total transaction value (incl. tax and shipping)
-            'coupon': '' // TODO: Add coupon code if present
-        });
-
-        window.dataLayer.push({
-            'ecommerce': {
-                'purchase': {
-                    'actionField': orderData,
-                    'products': <%= raw purchased_items.to_json %>
-                }
-            }
-        });
-        window.solidusSeoListener('google-tag-manager', 'purchase');
-    <% end %>
-
-    (function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
-    new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
-    j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
-    'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
-    })(window,document,'script','dataLayer','<%= ENV['GOOGLE_TAG_MANAGER_ID'] %>');
-</script>
-
-<% elsif ENV['GOOGLE_ANALYTICS_ID'].present? %>
-
-<script async src="https://www.googletagmanager.com/gtag/js?id=<%= ENV['GOOGLE_ANALYTICS_ID'] %>"></script>
-<script type="text/javascript" data-tag="google-analytics">
-    window.dataLayer = window.dataLayer || [];
-    function gtag(){ dataLayer.push(arguments); }
-    gtag('js', new Date());
-    gtag('config', '<%= ENV['GOOGLE_ANALYTICS_ID'] %>');
-
-    <% if just_purchased %>
-        let purchaseData = Object.assign({}, <%= raw shared_order_data.to_json %>, {
-            'transaction_id': '<%= @order.number %>',
-            'value': '<%= @order.total %>',
-            'items': <%= raw purchased_items.to_json %>
-        });
-
-        gtag('event', 'purchase', purchaseData);
-        window.solidusSeoListener('google-analytics', 'purchase');
-    <% end %>
-</script>
-<% end %>
-
-<% if ENV['FACEBOOK_PIXEL_ID'].present? %>
-<script type="text/javascript" data-tag="facebook">
-    !function(f,b,e,v,n,t,s) {
-        if (f.fbq) return;
-        n = f.fbq = function() { n.callMethod ? n.callMethod.apply(n, arguments) : n.queue.push(arguments) };
-        if (!f._fbq) f._fbq=n;
-        n.push = n; n.loaded = !0; n.version = '2.0'; n.queue=[]; t = b.createElement(e); t.async = !0; t.src = v;
-        s = b.getElementsByTagName(e)[0]; s.parentNode.insertBefore(t, s);
-    }(window, document,'script', 'https://connect.facebook.net/en_US/fbevents.js');
-
-    fbq('init', '<%= ENV['FACEBOOK_PIXEL_ID'] %>');
-    fbq('track', 'PageView');
-
-    <% if just_purchased %>
-        <% items = purchased_items.map { |li| li.slice(:id, :quantity) } %>
-
-        fbq('track', 'Purchase', {
-            value: <%= @order.total %>,
-            currency: 'USD',
-            contents: <%= raw items.to_json %>,
-            content_type: 'product',
-
-            // custom properties
-            order_number: '<%= @order.number %>',
-            item_total: <%= @order.item_total %>,
-            tax_total: <%= @order.tax_total %>,
-            ship_total: <%= @order.ship_total %>,
-            promo_total: <%= @order.promo_total %>,
-        });
-        window.solidusSeoListener('facebook', 'purchase');
-    <% end %>
-</script>
-<noscript>
-    <img height="1" width="1" src="https://www.facebook.com/tr?id=<%= ENV['FACEBOOK_PIXEL_ID'] %>&ev=PageView&noscript=1" />
-</noscript>
-<% end %>
-
-<% if ENV['PINTEREST_TAG_ID'].present? %>
-<script type="text/javascript" data-tag="pinterest">
-    !function(e){if(!window.pintrk){window.pintrk=function(){window.pintrk.queue.push(
-    Array.prototype.slice.call(arguments))};var
-    n=window.pintrk;n.queue=[],n.version="3.0";var
-    t=document.createElement("script");t.async=!0,t.src=e;var
-    r=document.getElementsByTagName("script")[0];r.parentNode.insertBefore(t,r)}}("https://s.pinimg.com/ct/core.js");
-    pintrk('load', '<%= ENV['PINTEREST_TAG_ID'] %>');
-    pintrk('page');
-
-    <% if just_purchased %>
-        <% items = purchased_items.map do |li|
-            {
-              product_id: li[:id],
-              product_name: li[:name],
-              product_quantity: li[:quantity],
-              product_price: li[:price],
-            }
-          end %>
-
-        pintrk('track', 'checkout', {
-            value: <%= @order.total %>,
-            order_quantity: <%= @order.line_items.sum(&:quantity) %>,
-            currency: 'USD',
-            line_items: <%= raw items.to_json %>
-        });
-
-        window.solidusSeoListener('pinterest', 'purchase');
-    <% end %>
- </script>
- <noscript>
-   <img height="1" width="1" style="display:none;" alt="" src="https://ct.pinterest.com/v3/?tid=<%= ENV['PINTEREST_TAG_ID'] %>&event=init&noscript=1" />
- </noscript>
+<% %w[google-tag-manager google-analytics facebook pinterest].each do |tag_name| %>
+    <%= render "solidus_seo/#{tag_name}", just_purchased: (@order && order_just_completed?(@order)), order: @order %>
 <% end %>

data/app/views/solidus_seo/_facebook.html.erb

@@ -0,0 +1,37 @@
+<%
+return if ENV['FACEBOOK_PIXEL_ID'].blank?
+
+if just_purchased
+    order_data = {
+        value: order.total,
+        currency: order.currency,
+        content_type: 'product',
+        contents: order.line_items.map do |line_item|
+            next unless line_item.variant
+
+            { id: line_item.variant.sku, quantity: line_item.quantity }
+        end.compact,
+
+        # custom properties
+        order_number: order.number,
+        item_total: order.item_total,
+        tax_total: order.tax_total,
+        ship_total: order.ship_total,
+        promo_total: order.promo_total
+    }
+end
+%>
+<script type="text/javascript" data-tag="facebook">
+    !function(f,b,e,v,n,t,s) {if (f.fbq) return;n = f.fbq = function() { n.callMethod ? n.callMethod.apply(n, arguments) : n.queue.push(arguments) };if (!f._fbq) f._fbq=n;n.push = n; n.loaded = !0; n.version = '2.0'; n.queue=[]; t = b.createElement(e); t.async = !0; t.src = v;s = b.getElementsByTagName(e)[0]; s.parentNode.insertBefore(t, s);}(window, document,'script', 'https://connect.facebook.net/en_US/fbevents.js');
+
+    fbq('init', '<%= ENV['FACEBOOK_PIXEL_ID'] %>');
+    fbq('track', 'PageView');
+
+    <% if just_purchased %>
+        fbq('track', 'Purchase', <%== order_data.to_json %>);
+        window.solidusSeoDataLayer('facebook', 'purchase');
+    <% end %>
+</script>
+<noscript>
+    <img height="1" width="1" src="https://www.facebook.com/tr?id=<%= ENV['FACEBOOK_PIXEL_ID'] %>&ev=PageView&noscript=1" />
+</noscript>

data/app/views/solidus_seo/_google-analytics.html.erb

@@ -0,0 +1,40 @@
+<%
+return if ENV['GOOGLE_TAG_MANAGER_ID'].present? || ENV['GOOGLE_ANALYTICS_ID'].blank?
+
+if just_purchased
+    order_data = {
+        transaction_id: order.number,
+        value: order.total,
+        items: order.line_items.map do |line_item|
+            next unless line_item.variant
+
+            {
+              id: line_item.variant.sku,
+              name: line_item.variant.name,
+              price: line_item.price,
+              variant: line_item.variant.options_text,
+              quantity: line_item.quantity
+            }
+        end.compact,
+
+        affiliation: current_store.name,
+        currency: order.currency,
+        tax: order.tax_total,
+        shipping: order.ship_total
+    }
+end
+%>
+<script async src="https://www.googletagmanager.com/gtag/js?id=<%= ENV['GOOGLE_ANALYTICS_ID'] %>"></script>
+<script type="text/javascript" data-tag="google-analytics">
+    window.dataLayer = window.dataLayer || [];
+
+    function gtag(){ dataLayer.push(arguments); }
+
+    gtag('js', new Date());
+    gtag('config', '<%= ENV['GOOGLE_ANALYTICS_ID'] %>');
+
+    <% if just_purchased %>
+        gtag('event', 'purchase', <%== order_data.to_json %>);
+        window.solidusSeoDataLayer('google-analytics', 'purchase');
+    <% end %>
+</script>

data/app/views/solidus_seo/_google-tag-manager.html.erb

@@ -0,0 +1,50 @@
+<%
+return if ENV['GOOGLE_ANALYTICS_ID'].present? || ENV['GOOGLE_TAG_MANAGER_ID'].blank?
+
+if just_purchased
+    order_data = {
+        id: order.number,
+        revenue: order.total,
+        coupon: '', # TODO: Add coupon code if present
+
+        affiliation: current_store.name,
+        currency: order.currency,
+        tax: order.tax_total,
+        shipping: order.ship_total
+    }
+
+    purchased_items = order.line_items.map do |line_item|
+        next unless line_item.variant
+
+        {
+          id: line_item.variant.sku,
+          name: line_item.variant.name,
+          price: line_item.total,
+          variant: line_item.variant.options_text,
+          quantity: line_item.quantity
+        }
+    end.compact
+end
+%>
+<script type="text/javascript" data-tag="google-tag-manager">
+    window.dataLayer = window.dataLayer || [];
+
+    <% if just_purchased %>
+        window.dataLayer.push({
+            'ecommerce': {
+                'purchase': {
+                    'actionField': <%== order_data.to_json %>,
+                    'products': <%== purchased_items.to_json %>
+                }
+            }
+        });
+
+        window.solidusSeoDataLayer('google-tag-manager', 'purchase');
+    <% end %>
+
+    (function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
+    new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
+    j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
+    'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
+    })(window,document,'script','dataLayer','<%= ENV['GOOGLE_TAG_MANAGER_ID'] %>');
+</script>

data/app/views/solidus_seo/_pinterest.html.erb

@@ -0,0 +1,84 @@
+<%
+return if ENV['PINTEREST_TAG_ID'].blank?
+
+product_data = {}
+add_to_cart_data = {}
+order_data = {}
+em_data = {}
+
+user_email = current_order&.email || try_spree_current_user&.email
+if user_email.present?
+    em_data = { em: user_email }
+end
+
+if just_purchased
+    order_data = {
+        value: order.total,
+        currency: order.currency,
+        order_quantity: order.line_items.sum(&:quantity),
+        line_items: order.line_items.map do |line_item|
+            next unless line_item.variant
+
+            {
+                product_id: line_item.variant.product.master.sku,
+                product_name: line_item.variant.name,
+                product_variant_id: line_item.variant.sku,
+                product_variant: line_item.variant.options_text,
+                product_quantity: line_item.quantity,
+                product_price: line_item.price
+            }
+        end.compact
+    }
+end
+
+if @product
+    product_data = {
+        line_items: [
+            {
+                product_name: @product.name,
+                product_id: @product.master.sku
+            }
+        ]
+    }
+end
+
+if flash[:added_to_cart].present?
+    add_to_cart_data = {
+        value: order.total,
+        currency: order.currency,
+        order_id: order.number,
+        line_items: flash[:added_to_cart].map do |variant_sku, variant|
+            {
+                product_id: variant['id'],
+                product_name: variant['name'],
+                product_variant_id: variant_sku,
+                product_variant: variant['variant'],
+                product_price: variant['price'],
+                product_quantity: variant['quantity']
+            }
+        end
+    }
+end
+%>
+<script type="text/javascript" data-tag="pinterest">
+    !function(e){if(!window.pintrk){window.pintrk=function(){window.pintrk.queue.push(Array.prototype.slice.call(arguments))};var n=window.pintrk;n.queue=[],n.version="3.0";var t=document.createElement("script");t.async=!0,t.src=e;var r=document.getElementsByTagName("script")[0];r.parentNode.insertBefore(t,r)}}("https://s.pinimg.com/ct/core.js");
+
+    pintrk('load', '<%= ENV['PINTEREST_TAG_ID'] %>' <%== em_data.present? ? ", #{em_data.to_json}" : '' %>);
+    pintrk('page');
+
+    pintrk('track', 'pagevisit'<%== product_data.present? ? ", #{product_data.to_json}" : '' %>);
+    window.solidusSeoDataLayer('pinterest', 'pagevisit');
+
+    <% if add_to_cart_data.present? %>
+        pintrk('track', 'addtocart', <%== add_to_cart_data.to_json %>);
+        window.solidusSeoDataLayer('pinterest', 'addtocart');
+    <% end %>
+
+    <% if order_data.present? %>
+        pintrk('track', 'checkout', <%== order_data.to_json %>);
+        window.solidusSeoDataLayer('pinterest', 'purchase');
+    <% end %>
+ </script>
+ <noscript>
+   <img height="1" width="1" style="display:none;" alt="" src="https://ct.pinterest.com/v3/?tid=<%= ENV['PINTEREST_TAG_ID'] %>&event=init&noscript=1" />
+ </noscript>

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

@@ -34,6 +34,7 @@ module SolidusSeo
           copy_file 'remove_original_title_tag.deface', 'app/overrides/spree/shared/_head/remove_original_title_tag.deface'
           copy_file 'insert_product_list_helper.html.erb.deface', 'app/overrides/spree/shared/_products/insert_product_list_helper.html.erb.deface'
           copy_file 'insert_analytics_in_layout.html.erb.deface', 'app/overrides/spree/layouts/spree_application/insert_analytics_in_layout.html.erb.deface'
+          copy_file 'replace_taxon_breadcrumbs_helper.html.erb.deface', 'app/overrides/spree/layouts/spree_application/replace_taxon_breadcrumbs_helper.html.erb.deface'
         end
       end
     end

data/lib/generators/solidus_seo/install/templates/replace_taxon_breadcrumbs_helper.html.erb.deface

@@ -0,0 +1,5 @@
+<!--
+replace %{erb[loud]:contains("taxon_breadcrumbs")}
+original "<%= taxon_breadcrumbs(@taxon) %>"
+-->
+<%= taxon_breadcrumbs_jsonld(@taxon) %>

data/lib/solidus_seo/engine.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 require_dependency 'solidus_seo/jsonld/tag_helper'
+require_dependency 'solidus_seo/helpers/base_helper'
 
 module SolidusSeo
   class Engine < Rails::Engine
@@ -21,6 +22,7 @@ module SolidusSeo
     initializer "solidus_seo.view_helpers" do
       ActiveSupport.on_load(:action_view) do
         ActionView::Base.send :include, ::SolidusSeo::Jsonld::TagHelper
+        ActionView::Base.send :include, ::SolidusSeo::Helpers::BaseHelper
       end
     end
 

data/lib/solidus_seo/helpers/base_helper.rb

@@ -4,6 +4,32 @@ module SolidusSeo
       def plain_text(text)
         ActionController::Base.helpers.strip_tags(text.to_s).gsub(/\s+/, ' ')
       end
+
+      def breadcrumb_pairs(taxon)
+        crumbs = []
+
+        if taxon
+          crumbs << [Spree.t(:products), products_url]
+          crumbs += taxon.ancestors.collect { |a| [a.name, spree.nested_taxons_url(a.permalink)] } unless taxon.ancestors.empty?
+          crumbs << [taxon.name, spree.nested_taxons_url(taxon.permalink)]
+        else
+          crumbs << [Spree.t(:products), products_url]
+        end
+
+        crumbs
+      end
+
+      def taxon_breadcrumbs_jsonld(taxon, separator = '&nbsp;&raquo;&nbsp;', list_class = 'list-inline', list_item_class = 'list-inline-item')
+        return '' if current_page?('/') || taxon.nil?
+
+        separator = tag.span(separator.html_safe, class: 'breadcrumb-separator')
+        original_output = Nokogiri::HTML::DocumentFragment.parse(taxon_breadcrumbs(taxon, separator, list_class).to_s)
+        original_output.xpath('@itemscope|@itemtype|@itemprop|.//@itemscope|.//@itemtype|.//@itemprop').remove
+        original_output.search('.columns').first['class'] = ''
+        original_output.search('li').attr('class', list_item_class)
+
+        jsonld_breadcrumbs(breadcrumb_pairs(taxon)) + original_output.to_s.html_safe
+      end
     end
   end
 end

data/lib/solidus_seo/jsonld/breadcrumbs.rb

@@ -2,7 +2,7 @@ require_dependency 'solidus_seo/jsonld/list'
 
 module SolidusSeo
   module Jsonld
-    class Breadcrumbs < List
+    class Breadcrumbs < SolidusSeo::Jsonld::List
       private
 
       def list_type
@@ -15,7 +15,7 @@ module SolidusSeo
 
       def as_list_item(item)
         # `item` in the form of [text, url]
-        breadcrumb_text, breadcrumb_url = *item
+        breadcrumb_text, breadcrumb_url = item
 
         {
           '@type': 'ListItem',

data/lib/solidus_seo/jsonld/list.rb

@@ -2,7 +2,7 @@ require_dependency 'solidus_seo/jsonld/base'
 
 module SolidusSeo
   module Jsonld
-    class List < Base
+    class List < SolidusSeo::Jsonld::Base
       attr_accessor :data, :list_items
 
       def initialize(data)

data/lib/solidus_seo/meta_data_builder.rb

@@ -1,4 +1,3 @@
-require_dependency 'spree/base_helper_decorator'
 require_dependency 'solidus_seo/helpers/base_helper'
 
 module SolidusSeo

data/lib/solidus_seo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SolidusSeo
-  VERSION = '1.0.7'
+  VERSION = '1.0.8'
 end

data/spec/examples.txt

@@ -1,30 +1,32 @@
 example_id                                       | status | run_time        |
 ------------------------------------------------ | ------ | --------------- |
-./spec/features/checkout_complete_spec.rb[1:1:1] | passed | 1.92 seconds    |
-./spec/features/checkout_complete_spec.rb[1:2:1] | passed | 0.89422 seconds |
-./spec/features/checkout_complete_spec.rb[1:3:1] | passed | 0.79879 seconds |
-./spec/features/checkout_complete_spec.rb[1:4:1] | passed | 0.86202 seconds |
-./spec/features/homepage_spec.rb[1:1:1]          | passed | 0.55572 seconds |
-./spec/features/homepage_spec.rb[1:1:2]          | passed | 1.12 seconds    |
-./spec/features/homepage_spec.rb[1:2:1]          | passed | 0.50916 seconds |
-./spec/features/homepage_spec.rb[1:2:2]          | passed | 0.61185 seconds |
-./spec/features/homepage_spec.rb[1:3:1]          | passed | 0.73532 seconds |
-./spec/features/homepage_spec.rb[1:3:2]          | passed | 0.66687 seconds |
-./spec/features/product_page_spec.rb[1:1:1]      | passed | 0.57637 seconds |
-./spec/features/product_page_spec.rb[1:1:2]      | passed | 0.70075 seconds |
-./spec/features/product_page_spec.rb[1:1:3]      | passed | 0.76786 seconds |
-./spec/features/product_page_spec.rb[1:2:1]      | passed | 0.8813 seconds  |
-./spec/features/product_page_spec.rb[1:2:2:1]    | passed | 0.67679 seconds |
-./spec/features/product_page_spec.rb[1:2:3:1]    | passed | 0.69868 seconds |
-./spec/features/product_page_spec.rb[1:3:1]      | passed | 0.65377 seconds |
-./spec/features/product_page_spec.rb[1:3:2]      | passed | 0.7571 seconds  |
-./spec/features/product_page_spec.rb[1:3:3]      | passed | 0.66879 seconds |
-./spec/features/taxon_page_spec.rb[1:1:1]        | passed | 1.34 seconds    |
-./spec/features/taxon_page_spec.rb[1:1:2]        | passed | 0.7829 seconds  |
-./spec/features/taxon_page_spec.rb[1:1:3]        | passed | 0.81693 seconds |
-./spec/features/taxon_page_spec.rb[1:2:1]        | passed | 7.61 seconds    |
-./spec/features/taxon_page_spec.rb[1:2:2:1]      | passed | 0.94849 seconds |
-./spec/features/taxon_page_spec.rb[1:2:3:1]      | passed | 0.95931 seconds |
-./spec/features/taxon_page_spec.rb[1:3:1]        | passed | 0.76726 seconds |
-./spec/features/taxon_page_spec.rb[1:3:2]        | passed | 1.01 seconds    |
-./spec/features/taxon_page_spec.rb[1:4:1]        | passed | 2.08 seconds    |
+./spec/features/add_to_cart_spec.rb[1:1:1]       | passed | 1.6 seconds     |
+./spec/features/checkout_complete_spec.rb[1:1:1] | passed | 0.65012 seconds |
+./spec/features/checkout_complete_spec.rb[1:2:1] | passed | 0.56665 seconds |
+./spec/features/checkout_complete_spec.rb[1:3:1] | passed | 0.66929 seconds |
+./spec/features/checkout_complete_spec.rb[1:4:1] | passed | 0.44838 seconds |
+./spec/features/homepage_spec.rb[1:1:1]          | passed | 2.3 seconds     |
+./spec/features/homepage_spec.rb[1:1:2]          | passed | 0.22388 seconds |
+./spec/features/homepage_spec.rb[1:2:1]          | passed | 0.2209 seconds  |
+./spec/features/homepage_spec.rb[1:2:2]          | passed | 0.18137 seconds |
+./spec/features/homepage_spec.rb[1:3:1]          | passed | 0.20727 seconds |
+./spec/features/homepage_spec.rb[1:3:2]          | passed | 0.20346 seconds |
+./spec/features/product_page_spec.rb[1:1:1]      | passed | 0.29118 seconds |
+./spec/features/product_page_spec.rb[1:1:2]      | passed | 0.30857 seconds |
+./spec/features/product_page_spec.rb[1:1:3]      | passed | 0.28452 seconds |
+./spec/features/product_page_spec.rb[1:2:1]      | passed | 0.47017 seconds |
+./spec/features/product_page_spec.rb[1:2:2:1]    | passed | 0.3369 seconds  |
+./spec/features/product_page_spec.rb[1:2:3:1]    | passed | 0.37361 seconds |
+./spec/features/product_page_spec.rb[1:3:1]      | passed | 0.33857 seconds |
+./spec/features/product_page_spec.rb[1:3:2]      | passed | 0.29488 seconds |
+./spec/features/product_page_spec.rb[1:3:3]      | passed | 0.26324 seconds |
+./spec/features/product_page_spec.rb[1:4:1:1]    | passed | 0.4502 seconds  |
+./spec/features/taxon_page_spec.rb[1:1:1]        | passed | 1.04 seconds    |
+./spec/features/taxon_page_spec.rb[1:1:2]        | passed | 0.31403 seconds |
+./spec/features/taxon_page_spec.rb[1:1:3]        | passed | 0.30921 seconds |
+./spec/features/taxon_page_spec.rb[1:2:1]        | passed | 0.32058 seconds |
+./spec/features/taxon_page_spec.rb[1:2:2:1]      | passed | 0.30031 seconds |
+./spec/features/taxon_page_spec.rb[1:2:3:1]      | passed | 0.31003 seconds |
+./spec/features/taxon_page_spec.rb[1:3:1]        | passed | 0.30324 seconds |
+./spec/features/taxon_page_spec.rb[1:3:2]        | passed | 0.3043 seconds  |
+./spec/features/taxon_page_spec.rb[1:4:1]        | passed | 0.5174 seconds  |

data/spec/features/add_to_cart_spec.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+describe 'Add to cart', type: :system do
+  let!(:store) { Spree::Store.default }
+  let!(:order) { create :completed_order_with_totals }
+  let!(:line_item) { order.line_items.first }
+
+  stub_authorization!
+
+  before do
+    current_order_stubs(order)
+    stub_const 'ENV', ENV.to_h.merge(env_variable => 'XXX-YYYYY')
+
+    visit spree.product_path(line_item.product)
+    find('#add-to-cart-button').click
+  end
+
+  context 'when PINTEREST_TAG_ID environment variable is present' do
+    let(:env_variable) { 'PINTEREST_TAG_ID' }
+
+    it 'tracks "add to cart" event' do
+      expect(page).to track_analytics_event :pinterest, 'addtocart', [
+        'track', 'addtocart', order.total, order.number, line_item.variant.product.master.sku,
+        line_item.name, line_item.variant.sku, line_item.variant.price
+      ]
+    end
+  end
+end
+

data/spec/features/checkout_complete_spec.rb

@@ -1,14 +1,17 @@
-describe "Checkout complete", type: :system do
+# frozen_string_literal: true
+
+describe 'Checkout complete', type: :system do
   let!(:store) { Spree::Store.default }
   let!(:taxon) { create :taxon, name: 'MyTaxon' }
   let!(:order) { create :completed_order_with_totals }
   let!(:line_item) { order.line_items.first }
-  let(:user) { Spree::User.first }
+
+  stub_authorization!
 
   subject { visit spree.order_path(order) }
 
   before do
-    checkout_stubs(order)
+    current_order_stubs(order)
     stub_const 'ENV', ENV.to_h.merge(env_variable => 'XXX-YYYYY')
     allow_any_instance_of(Spree::OrdersHelper).to receive(:order_just_completed?).with(order) { true }
   end
@@ -18,8 +21,7 @@ describe "Checkout complete", type: :system do
 
     it 'includes and executes a purchase event script' do
       subject
-
-      expect(page).to matcher_for 'google-tag-manager', [order.number, order.total, 'ecommerce', 'purchase', line_item.sku, line_item.total]
+      expect(page).to track_analytics_event 'google-tag-manager', 'purchase', ['ecommerce', 'purchase', order.number, order.total, line_item.sku]
     end
   end
 
@@ -28,7 +30,11 @@ describe "Checkout complete", type: :system do
 
     it 'includes and executes a purchase event script' do
       subject
-      expect(page).to matcher_for 'google-analytics', ['transaction_id', order.number, order.total, line_item.sku, line_item.total, 'event', 'purchase']
+      expect(page).to track_analytics_event 'google-analytics', 'purchase', [
+        'event', 'purchase', 'transaction_id', order.number,
+        order.total, line_item.sku, line_item.variant.name,
+        line_item.price, line_item.variant.options_text
+      ]
     end
   end
 
@@ -37,7 +43,7 @@ describe "Checkout complete", type: :system do
 
     it 'includes and executes a purchase event script' do
       subject
-      expect(page).to matcher_for :facebook, ['track', 'Purchase', order.total, line_item.sku, line_item.quantity, order.number]
+      expect(page).to track_analytics_event :facebook, 'purchase', ['track', 'Purchase', order.total, line_item.sku, line_item.quantity, order.number]
     end
   end
 
@@ -46,16 +52,7 @@ describe "Checkout complete", type: :system do
 
     it 'includes and executes a purchase event script' do
       subject
-      expect(page).to matcher_for :pinterest, ['track', 'checkout', order.total, line_item.sku, line_item.name, line_item.price]
+      expect(page).to track_analytics_event :pinterest, 'purchase', ['track', 'checkout', order.total, line_item.sku, line_item.name, line_item.price]
     end
   end
 end
-
-# Builds a regex matcher for script tag contents
-# @param tag_name [String] Value of script's data-tag attribute
-# @param matches [Array] Keywords that must appear in script contents (order matters!)
-# @return [Object] Returns a capybara matcher for a script tag with specific attributes and contents
-def matcher_for(tag_name, matches)
-  matches = matches.flatten.map {|v| Regexp.escape(v.to_s) }.join('.+')
-  have_selector :css, "script[data-tag=#{tag_name}][data-fired-events=purchase]", visible: false, text: /#{matches}/i
-end

data/spec/features/product_page_spec.rb

@@ -26,7 +26,6 @@ describe "Product page", type: :system do
 
   subject { visit spree.product_path(product) }
 
-
   context 'jsonld markup output' do
     it "contains 'Store' entity type" do
       subject
@@ -92,4 +91,21 @@ describe "Product page", type: :system do
       expect(page).to have_css "meta[property='product:price:amount'][content='#{seo_price}']", visible: false
     end
   end
+
+  context 'analytics event tracking' do
+    before do
+      stub_const 'ENV', ENV.to_h.merge(env_variable => 'XXX-YYYYY')
+    end
+
+    context 'when PINTEREST_TAG_ID environment variable is present' do
+      let(:env_variable) { 'PINTEREST_TAG_ID' }
+
+      it 'tracks "pagevisit" event with product data' do
+        subject
+        expect(page).to track_analytics_event :pinterest, 'pagevisit', [
+          'track', 'pagevisit', product.name, product.master.sku
+        ]
+      end
+    end
+  end
 end

data/spec/support/testing_helpers.rb

@@ -10,13 +10,17 @@ module TestingHelpers
     end
   end
 
-  def checkout_stubs(order, user = nil)
-    user ||= order.user
+  def current_order_stubs(order)
     allow_any_instance_of(Spree::CheckoutController).to receive_messages(current_order: order)
+    allow_any_instance_of(Spree::OrdersController).to receive_messages(current_order: order)
+  end
 
-    if user
-      allow_any_instance_of(Spree::CheckoutController).to receive_messages(try_spree_current_user: user)
-      allow_any_instance_of(Spree::OrdersController).to receive_messages(try_spree_current_user: user)
-    end
+  # Builds a regex matcher for script tag contents
+  # @param tag_name [String] Value of script's data-tag attribute
+  # @param matches [Array] Keywords that must appear in script contents (order matters!)
+  # @return [Object] Returns a capybara matcher for a script tag with specific attributes and contents
+  def track_analytics_event(tag_name, event_name, matches)
+    matches = matches.flatten.map {|v| Regexp.escape(v.to_s) }.join('.+')
+    have_selector :css, "script[data-tag=#{tag_name}][data-fired-events=#{event_name}]", visible: false, text: /#{matches}/i
   end
 end

data/spec/system_helper.rb

@@ -1,15 +1,17 @@
 # frozen_string_literal: true
-RSpec.configure do |config|
-  config.when_first_matching_example_defined(type: :system) do
-    config.before :suite do
+RSpec.configure do |c|
+  Capybara.disable_animation = true
+
+  c.before(:example, type: :system) do
+    driven_by ENV['DEBUG_CAPYBARA'] ? :selenium_chrome : :selenium_chrome_headless
+  end
+
+  c.when_first_matching_example_defined(type: :system) do
+    c.before :suite do
       # Preload assets
       if Rails.application.respond_to?(:precompiled_assets)
         Rails.application.precompiled_assets
       end
     end
-
-    config.before(:example, type: :system) do
-      driven_by :apparition
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solidus_seo
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.8
 platform: ruby
 authors:
 - Karma Creative
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-05 00:00:00.000000000 Z
+date: 2021-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: solidus_core
@@ -337,12 +337,16 @@ files:
 - app/assets/javascripts/spree/frontend/solidus_seo.js
 - app/assets/stylesheets/spree/backend/solidus_seo.css
 - app/assets/stylesheets/spree/frontend/solidus_seo.css
+- app/decorators/controllers/spree/orders_controller_decorator.rb
 - app/decorators/controllers/spree/store_controller_decorator.rb
-- app/decorators/helpers/spree/base_helper_decorator.rb
 - app/decorators/helpers/spree/core/controller_helpers/common_decorator.rb
 - app/decorators/models/spree/product_decorator.rb
 - app/decorators/models/spree/store_decorator.rb
 - app/views/solidus_seo/_analytics.html.erb
+- app/views/solidus_seo/_facebook.html.erb
+- app/views/solidus_seo/_google-analytics.html.erb
+- app/views/solidus_seo/_google-tag-manager.html.erb
+- app/views/solidus_seo/_pinterest.html.erb
 - config/locales/en.yml
 - config/routes.rb
 - lib/generators/solidus_seo/install/install_generator.rb
@@ -354,6 +358,7 @@ files:
 - lib/generators/solidus_seo/install/templates/insert_product_list_helper.html.erb.deface
 - lib/generators/solidus_seo/install/templates/paperclip_optimizer.rb
 - lib/generators/solidus_seo/install/templates/remove_original_title_tag.deface
+- lib/generators/solidus_seo/install/templates/replace_taxon_breadcrumbs_helper.html.erb.deface
 - lib/solidus_seo.rb
 - lib/solidus_seo/engine.rb
 - lib/solidus_seo/factories.rb
@@ -373,6 +378,7 @@ files:
 - lib/solidus_seo/model.rb
 - lib/solidus_seo/version.rb
 - spec/examples.txt
+- spec/features/add_to_cart_spec.rb
 - spec/features/checkout_complete_spec.rb
 - spec/features/homepage_spec.rb
 - spec/features/product_page_spec.rb
@@ -410,6 +416,7 @@ test_files:
 - spec/features/checkout_complete_spec.rb
 - spec/features/homepage_spec.rb
 - spec/features/taxon_page_spec.rb
+- spec/features/add_to_cart_spec.rb
 - spec/features/product_page_spec.rb
 - spec/support/testing_helpers.rb
 - spec/system_helper.rb

data/app/decorators/helpers/spree/base_helper_decorator.rb

@@ -1,39 +0,0 @@
-module Spree
-  module BaseHelperDecorator
-    extend ActiveSupport::Concern
-
-    def self.prepended(base)
-      base.class_eval do
-        def breadcrumb_pairs(taxon)
-          crumbs = []
-
-          if taxon
-            crumbs << [Spree.t(:products), products_url]
-            crumbs += taxon.ancestors.collect { |a| [a.name, spree.nested_taxons_url(a.permalink)] } unless taxon.ancestors.empty?
-            crumbs << [taxon.name, spree.nested_taxons_url(taxon.permalink)]
-          else
-            crumbs << [Spree.t(:products), products_url]
-          end
-
-          crumbs
-        end
-
-        # TODO: Make this method replace original `taxon_breadcrumbs` so we can use super;
-        # prepending a module with anothe doesn't seem to be working as intended.
-        def taxon_breadcrumbs_jsonld(taxon, separator = '&nbsp;&raquo;&nbsp;', list_class = 'list-inline', list_item_class = 'list-inline-item')
-          return '' if current_page?('/') || taxon.nil?
-
-          separator = tag.span(separator.html_safe, class: 'breadcrumb-separator')
-          original_output = Nokogiri::HTML::DocumentFragment.parse(taxon_breadcrumbs(taxon, separator, list_class).to_s)
-          original_output.xpath('@itemscope|@itemtype|@itemprop|.//@itemscope|.//@itemtype|.//@itemprop').remove
-          original_output.search('.columns').first['class'] = ''
-          original_output.search('li').attr('class', list_item_class)
-
-          jsonld_breadcrumbs(breadcrumb_pairs(taxon)) + original_output.to_s.html_safe
-        end
-      end
-    end
-
-    ::Spree::BaseHelper.prepend(self)
-  end
-end