RubyGems - solidus_seo - Versions diffs - 1.0.2 → 1.0.12 - Mend

solidus_seo 1.0.2 → 1.0.12

Files changed (1630) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f2ed047bb60c0ad1b64c7c1823ca96cd485f88a5
-  data.tar.gz: a0a767ea9d5072c2d469a5ac20bf914f2b6acbf0
+SHA256:
+  metadata.gz: 51670eddac384997661e9012323cd72a8d53f93d49798c125a0cdf6090b209de
+  data.tar.gz: 0672d2f46cf997f24e6b9c9ded5943af3bf86fc7b2c50c30f4c79a363052b870
 SHA512:
-  metadata.gz: 389195c4f82a45f69297f370c9578e741be82c61b00f9de0d2e22a1185260bfa4355574c270cf48788d474b162b358d5074a6b9a728cd13f5f5628a70682409f
-  data.tar.gz: 8d5a5af86124d941881747451af2453a30635951f697479a96090ec687cd1496b27c76785ed1ab7d567adbae1acb9d308289d905fcac01f452d3ff100b69c8b3
+  metadata.gz: 74fc866d03e824e4d02a0cf9f6ea398934b8f718ff07da6e8da08d6b124f46f1c1167d611f2f0c9dd31f5d03a23dd1db16965d1bc4e209dd612e67fad543be5b
+  data.tar.gz: 4f3b5e18a483447b87cd2cfe4771033e0d02e99fc873973760faeec526369b4dca0f1d2e97faabb2a4e5884eba31b0bc718b8f95ddedb3f6d094267cfba62099

data/README.md CHANGED Viewed

@@ -43,32 +43,34 @@ Here are the changes we make, via deface, in the default Solidus views as part o
   - Replace the `<%== meta_data_tags %>` line for `<%= display_meta_tags %>`.
   - Remove the `<title>` tag (`display_meta_tags` generates a new title tag).
 - In `spree/layouts/spree_application.html.erb`
+  - Insert `<%= render 'solidus_seo/analytics' %>` just before `</head>`.
+  - Insert `<%= render 'solidus_seo/noscript_tags' %>` immediately after the `<body>` opening tag.
   - Insert `<%= dump_jsonld %>` just before the `</body>` closing tag.
+  - Replace `<%= taxon_breadcrumbs(@taxon) %>` with (`<%= taxon_breadcrumbs_jsonld(@taxon) %>`) which does the same as the original plus prints a JSON-LD tag.
+  - Replace `<%= flash_messages %>` with (`<%= flash_messages(ignore_types: 'added_to_cart') %>`) which does the same as the original plus prints a JSON-LD tag.
 - In `spree/products/show.html.erb`:
   - Insert `<%= jsonld @product %>` anywhere inside the `cache` block.
 - In `spree/shared/_products.html.erb`:
-  - Insert `<% jsonld_list(products) %>` at the bottom of the file. (Notice this helper doesn't generate any output, as instead it simply adds to the data that's later outputted by dump_jsonld)
+  - Insert `<% jsonld_list(products) %>` at the bottom of the file. (Notice this helper doesn't generate any output, as instead it simply adds to the data that's later outputted by `dump_jsonld`)
 At this point, assuming you're using the default Solidus views and this extension's deface overrides, the features you've gained are:
   - Default meta tags including open graph tags, describing a product on the PDP pages, and describing the store/site in all other pages.
-  - Store jsonld markup on all your pages.
-  - Product jsonld markup in your PDP pages.
-  - Breadcrumb jsonld markup in your taxon pages.
-  - ItemList jsonld markup in your paginated product pages.
+  - Store JSON-LD markup on all your pages.
+  - Product JSON-LD markup in your PDP pages.
+  - Breadcrumb JSON-LD markup in your taxon pages.
+  - ItemList JSON-LD markup in your paginated product pages.
   - Site-wide default paperclip image optimization (through image_optim)
+  - Page view and eCommerce conversion tracking (completed checkouts) enabled via presence of `GOOGLE_TAG_MANAGER_ID`, `GOOGLE_ANALYTICS_ID`, `FACEBOOK_PIXEL_ID`, `PINTEREST_TAG_ID` environment variables (only one Google integration should be enabled at a time).
 ### Models
 This gem is intended to provide a progressive implementation approach. To begin with, it defines some methods in your models to be used as an interface/source of your meta data. Moreover, it already provides some useful defaults that can be easily extended and customized, all inside your Spree models, via decorators.
-Practically speaking, what this means is that simply by setting your store's metadata from the admin and calling the display_meta_tags helper in your layout, you'll get basic jsonld data included for your store. The output would be similar to the following:
+Practically speaking, what this means is that simply by setting your store's metadata from the admin and calling the display_meta_tags helper in your layout, you'll get basic JSON-LD data included for your store. The output would be similar to the following:
 ```json
 {
@@ -112,9 +114,9 @@ The basic requirements for the return values of your methods are straight-forwar
       and
-  - `jsonld_data` must return a hash, holding a [jsonld definition](https://en.wikipedia.org/wiki/JSON-LD).
+  - `jsonld_data` must return a hash, holding a [JSON-LD definition](https://en.wikipedia.org/wiki/JSON-LD).
-For the purpose of illustration, a simple example could be adding a new file to your Solidus app, `app/models/spree/order_decorator.rb`, to implement the jsonld_data interface for `Spree::Order`; the override for the seo_data interface would be placed and implemented similarly. [NOTE: To be clear, this extension provides no default implementation for `Spree::Order.jsonld_data` - the code below is meant solely as an example override for those new to Solidus and who, accordingly, might be unfamiliar with its override mechanics (decorators).]
+For the purpose of illustration, a simple example could be adding a new file to your Solidus app, `app/models/spree/order_decorator.rb`, to implement the `jsonld_data` interface for `Spree::Order`; the override for the seo_data interface would be placed and implemented similarly. NOTE: To be clear, this extension provides no default implementation for `Spree::Order.jsonld_data` - the code below is meant solely as an example override for those new to Solidus and who, accordingly, might be unfamiliar with its override mechanics (decorators).
 ```ruby
 # app/models/spree/order_decorator.rb
@@ -150,19 +152,19 @@ Spree::Order.class_eval do
 end
 ```
-After adding the new decorator, all that's left would be adding a call to jsonld on the object within your view, such as:
+After adding the new decorator, all that's left would be adding a call to `jsonld` helper on the object, such as:
 ```erb
 <%= jsonld(@order) %>
 ```
-[In short, `jsonld` is a helper that parses any object that implements the `to_jsonld` method (added by `SolidusSeo::Model` module), which in turn makes use of the `jsonld_data` method, and returns a script tag.]
+In short, `jsonld` parses any object that implements the `to_jsonld` method (added by `SolidusSeo::Model` module), which in turn makes use of the `jsonld_data` method, and returns a script tag.
-Besides these base methods, there are some model-specific ones for Spree::Store and Spree::Product which are explained in the following sections. These are intended to provide you with some additional common and useful data.
+Besides these base methods, there are some model-specific ones for `Spree::Store` and `Spree::Product` which are explained in the following sections. These are intended to provide you with some additional common and useful data.
 #### Spree::Store
-Again, even without any additional work beyond the initial installation, you get a solid/basic jsonld definition for your Spree::Store model. By default:
+Again, even without any additional work beyond the initial installation, you get a solid/basic JSON-LD definition for your `Spree::Store` model. By default:
 ```json
 {

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

@@ -0,0 +1,58 @@
+# 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_hash = cart_diff_variant_payload(variant_sku)
+        variant_hash[:quantity] = quantity
+        [variant_sku, variant_hash]
+      end.to_h
+      flash[:added_to_cart] = cart_diff if cart_diff.present?
+    end
+    def cart_diff_variant_payload(sku)
+      variant = Spree::Variant.find_by(sku: sku)
+      {
+        id: variant.product.master.sku,
+        name: variant.product.name,
+        variant: variant.options_text,
+        price: variant.price
+      }
+    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/controllers/spree/store_controller_decorator.rb ADDED Viewed

@@ -0,0 +1,13 @@
+require_dependency 'solidus_seo/meta_data_builder'
+module Spree
+  module StoreControllerDecorator
+    def self.prepended(base)
+      base.class_eval do
+        include ::SolidusSeo::MetaDataBuilder
+      end
+    end
+    ::Spree::StoreController.prepend(self)
+  end
+end

data/app/decorators/helpers/spree/core/controller_helpers/common_decorator.rb ADDED Viewed

@@ -0,0 +1,31 @@
+module Spree
+  module Core
+    module ControllerHelpers
+      module CommonDecorator
+        def self.prepended(base)
+          base.module_eval do
+            attr_reader :custom_title
+            def title
+              custom_title || current_store.seo_tagline
+            end
+            def custom_title
+              @title.presence || accurate_title.presence
+            end
+            def accurate_title
+              # No default accurate_title (controller-level SEO title)
+              # so we can detect when there's no seo title defined,
+              # make it fallback to Spree::Store#seo_tagline
+              # field and then reverse the title output in
+              # SolidusSeo::MetaDataBuilder#set_meta_data
+            end
+          end
+        end
+        ::Spree::Core::ControllerHelpers::Common.prepend(self)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,102 @@
+require_dependency 'solidus_seo/model'
+module Spree
+  module ProductDecorator
+    def self.prepended(base)
+      base.class_eval do
+        include SolidusSeo::Model
+      end
+    end
+    def seo_name
+      plain_text(try(:meta_title).presence) || name
+    end
+    def seo_url
+      spree_route_helper.product_url(self, host: store_host)
+    end
+    def seo_images
+      return [] unless gallery.images.any? && gallery.images.first.attachment.file?
+      [
+        url_helper.image_url(gallery.images.first.attachment.url(:large), host: store_host),
+      ].compact
+    end
+    def seo_description
+      plain_text(try(:meta_description).presence || try(:description))
+    end
+    def seo_brand
+      @brand ||= taxons.detect { |it| it.root.name =~ /^brands?$/i }.try(:name)
+    end
+    def seo_currency
+      master.default_price.currency
+    end
+    def seo_price
+      master.default_price.amount
+    end
+    def in_stock?
+      available? && variants_including_master.suppliable.any?
+    end
+    def seo_data
+      {
+        title: seo_name,
+        description: seo_description,
+        name: seo_name,
+        image_src: seo_images.first,
+        og: {
+          type: 'product',
+          url: seo_url,
+          brand: seo_brand,
+          image: {
+            _: :image_src,
+            alt: seo_name,
+          }
+        },
+        product: {
+          price: {
+            amount: seo_price,
+            currency: seo_currency,
+          }
+        },
+        twitter: {
+          card: 'summary_large_image',
+        }
+      }
+    end
+    def jsonld_data
+      {
+        "@context": "http://schema.org/",
+        "@type": "Product",
+        "name": name,
+        "url": seo_url,
+        "image": seo_images,
+        "description": seo_name,
+        "sku": sku,
+        "brand": seo_brand,
+        # TODO: ratings/reviews
+        # "aggregateRating": {
+        #   "@type": "AggregateRating",
+        #   "ratingValue": "4.4",
+        #   "reviewCount": "89"
+        # },
+        "offers": {
+          "@type": "Offer",
+          "priceCurrency": seo_currency,
+          "price": seo_price,
+          "itemCondition": "http://schema.org/NewCondition",
+          "availability": "http://schema.org/#{ in_stock? ? 'InStock' : 'OutOfStock'}",
+        }
+      }
+    end
+    ::Spree::Product.prepend(self)
+  end
+end

data/app/decorators/models/spree/store_decorator.rb ADDED Viewed

@@ -0,0 +1,69 @@
+require_dependency 'solidus_seo/model'
+module Spree
+  module StoreDecorator
+    def self.prepended(base)
+      base.class_eval do
+        include SolidusSeo::Model
+      end
+    end
+    # following conventions of other models
+    def seo_name
+      seo_title.presence || name
+    end
+    def seo_image
+      url_helper.image_url(Spree::Config.logo, host: store_host)
+    end
+    def seo_description
+      plain_text(meta_description)
+    end
+    def seo_tagline
+      # TODO: Retrieve from DB
+      'This is the default store tagline'
+    end
+    def seo_data
+      {
+        site: seo_name,
+        description: seo_description,
+        image_src: seo_image,
+        og: {
+          site_name: :site,
+          type: 'website',
+          image: {
+            '_': :image_src,
+            alt: :site
+          }
+        },
+        twitter: {
+          card: 'summary',
+          # site: '@yourcompany'
+        }
+      }
+    end
+    def jsonld_data
+      base = {
+        "@context": "http://schema.org",
+        "@type": "Store",
+        "name": name,
+        "logo": seo_image,
+        "image": seo_image,
+        "url": store_host,
+        "@id": store_host
+      }
+      build_jsonld_with base, :contact_points,
+                              :address,
+                              :geo,
+                              :same_as,
+                              :opening_hours_specification
+    end
+    ::Spree::Store.prepend(self)
+  end
+end

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

@@ -0,0 +1,10 @@
+<script>
+    window.solidusSeoDataLayer = function (tagName, eventName) {
+        var tag = document.querySelector('script[data-tag=' + tagName + ']');
+        tag.dataset.firedEvents = eventName;
+    }
+</script>
+<% %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 ADDED Viewed

@@ -0,0 +1,69 @@
+<%
+return if ENV['FACEBOOK_PIXEL_ID'].blank?
+product_data = {}
+add_to_cart_data = {}
+order_data = {}
+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
+if flash[:added_to_cart].present?
+    add_to_cart_data = {
+        currency: order.currency,
+        content_type: 'product',
+        contents: flash[:added_to_cart].map do |variant_sku, variant|
+            { id: variant_sku, quantity: variant['quantity'] }
+        end
+    }
+end
+if @product
+    product_data = {
+        content_type: 'product',
+        content_name: @product.name,
+        content_ids: [@product.master.sku]
+    }
+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 order_data.present? %>
+        fbq('track', 'Purchase', <%== order_data.to_json %>);
+        window.solidusSeoDataLayer('facebook', 'purchase');
+    <% end %>
+    <% if add_to_cart_data.present? %>
+        fbq('track', 'AddToCart', <%== add_to_cart_data.to_json %>);
+        window.solidusSeoDataLayer('facebook', 'addtocart');
+    <% end %>
+    <% if product_data.present? %>
+        fbq('track', 'ViewContent', <%== product_data.to_json %>);
+        window.solidusSeoDataLayer('facebook', 'productview');
+    <% end %>
+</script>
+<noscript>
+    <img height="1" width="1" src="https://www.facebook.com/tr?id=<%= ENV['FACEBOOK_PIXEL_ID'] %>&ev=PageView&noscript=1" />
+</noscript>