workarea-google_tag_manager 4.3.1

data/Rakefile

@@ -0,0 +1,65 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Tasker'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+load 'workarea/changelog.rake'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'workarea/google_tag_manager/version'
+
+desc "Release version #{Workarea::GoogleTagManager::VERSION} of the gem"
+task :release do
+  host = "https://#{ENV['BUNDLE_GEMS__WEBLINC__COM']}@gems.weblinc.com"
+
+  #Rake::Task['workarea:changelog'].execute
+  #system 'git add CHANGELOG.md'
+  #system 'git commit -m "Update CHANGELOG"'
+  #system 'git push origin HEAD'
+
+  system "git tag -a v#{Workarea::GoogleTagManager::VERSION} -m 'Tagging #{Workarea::GoogleTagManager::VERSION}'"
+  system 'git push --tags'
+
+  system "gem build workarea-google_tag_manager.gemspec"
+  system "gem push workarea-google_tag_manager-#{Workarea::GoogleTagManager::VERSION}.gem"
+  system "gem push workarea-google_tag_manager-#{Workarea::GoogleTagManager::VERSION}.gem --host #{host}"
+  system "rm workarea-google_tag_manager-#{Workarea::GoogleTagManager::VERSION}.gem"
+end
+
+
+desc 'Run the JavaScript tests'
+ENV['TEASPOON_RAILS_ENV'] = File.expand_path('../test/dummy/config/environment', __FILE__)
+task teaspoon: 'app:teaspoon'
+
+desc 'Start a server at http://localhost:3000/teaspoon for JavaScript tests'
+task :teaspoon_server do
+  Dir.chdir("test/dummy")
+  teaspoon_env = File.expand_path('../test/teaspoon_env.rb', __FILE__)
+  system "RAILS_ENV=test TEASPOON_ENV=#{teaspoon_env} rails s"
+end

data/app/assets/javascripts/workarea/storefront/google_tag_manager/modules/adapter.js

@@ -0,0 +1,233 @@
+WORKAREA.analytics.registerAdapter('googleTagManager', function () {
+    'use strict';
+
+    var products,
+
+        checkoutStep = function (payload, step) {
+            products = [];
+
+            _.each(payload.items, function (impression) {
+                products.push({
+                    'id': impression.product_id,
+                    'name': impression.product_name,
+                    'category': impression.category,
+                    'variant': impression.sku,
+                    'price': impression.price,
+                    'quantity': impression.quantity
+                });
+            });
+
+            window.dataLayer.push({
+                'event': 'checkout',
+                'ecommerce': {
+                    'checkout': {
+                        'actionField': { 'step': step },
+                        'products': products
+                    }
+                }
+            });
+        };
+
+    window.dataLayer = window.dataLayer || [];
+
+    return {
+        'categoryView': function (payload) {
+            window.dataLayer.push({
+                'event': 'categoryView',
+                'name': payload.name,
+                'sort': payload.sort,
+                'page': payload.page
+            });
+        },
+
+        'searchResultsView': function (payload) {
+            window.dataLayer.push({
+                'event': 'searchResultsView',
+                'terms': payload.terms,
+                'sort': payload.sort,
+                'page': payload.page
+            });
+        },
+
+        'productList': function (payload) {
+            var impressions = [];
+
+            _.each(payload.impressions, function (impression) {
+                impressions.push({
+                    'id': impression.id,
+                    'price': impression.price,
+                    'name': impression.name,
+                    'category': impression.category,
+                    'variant': impression.sku,
+                    'list': payload.name,
+                    'position': impression.position
+                });
+            });
+
+            window.dataLayer.push({
+                'ecommerce': {
+                    'impressions': impressions
+                }
+            });
+        },
+
+        'productClick': function (payload) {
+            window.dataLayer.push({
+                'event': 'productClick',
+                'ecommerce': {
+                    'click': {
+                        'actionField': {'list': payload.list},
+                        'products': [{
+                            'name': payload.name,
+                            'id': payload.id,
+                            'price': payload.price,
+                            'category': payload.category,
+                            'variant': payload.sku,
+                            'position': payload.position
+                        }]
+                    }
+                }
+              });
+        },
+
+        'productQuickview': function (payload) {
+            window.dataLayer.push({
+                'event': 'quickview',
+                'ecommerce': {
+                    'detail': {
+                        'actionField': '',
+                        'products': [{
+                            'name': payload.name,
+                            'id': payload.id,
+                            'price': payload.price,
+                            'category': payload.category,
+                            'variant': payload.sku
+                        }]
+                    }
+                }
+              });
+        },
+
+        'productView': function (payload) {
+            window.dataLayer.push({
+                'ecommerce': {
+                    'detail': {
+                        'actionField': '',
+                        'products': [{
+                            'name': payload.name,
+                            'id': payload.id,
+                            'price': payload.price,
+                            'category': payload.category,
+                            'variant': payload.sku
+                        }]
+                    }
+                }
+              });
+        },
+
+        'addToCart': function (payload) {
+            window.dataLayer.push({
+                'event': 'addToCart',
+                'ecommerce': {
+                    'add': {
+                        'products': [{
+                            'id': payload.id,
+                            'name': payload.name,
+                            'category': payload.category,
+                            'variant': payload.sku,
+                            'price': payload.price,
+                            'quantity': payload.quantity
+                        }]
+                    }
+                }
+            });
+        },
+
+        'removeFromCart': function (payload) {
+            window.dataLayer.push({
+                'event': 'removeFromCart',
+                'ecommerce': {
+                    'remove': {
+                        'products': [{
+                            'id': payload.id,
+                            'name': payload.name,
+                            'category': payload.category,
+                            'variant': payload.sku,
+                            'price': payload.price,
+                            'quantity': payload.quantity
+                        }]
+                    }
+                }
+            });
+        },
+
+        'cartView': function (payload) {
+            checkoutStep(payload, 1);
+        },
+
+        'checkoutAddressesView': function (payload) {
+            checkoutStep(payload, 2);
+        },
+
+        'checkoutShippingView': function (payload) {
+            checkoutStep(payload, 3);
+        },
+
+        'checkoutShippingServiceSelected': function (payload) {
+            window.dataLayer.push({
+                'event': 'checkoutOption',
+                'ecommerce': {
+                    'checkout_option': {
+                        'actionField': {'step': 3, 'option': payload.name}
+                    }
+                }
+            });
+        },
+
+        'checkoutPaymentView': function (payload) {
+            checkoutStep(payload, 4);
+        },
+
+        'checkoutPaymentSelected': function (payload) {
+            window.dataLayer.push({
+                'event': 'checkoutOption',
+                'ecommerce': {
+                    'checkout_option': {
+                        'actionField': {'step': 4, 'option': payload.type}
+                    }
+                }
+            });
+        },
+
+        'checkoutOrderPlaced': function (payload) {
+            products = [];
+
+            _.each(payload.items, function (impression) {
+                products.push({
+                    'name': impression.product_name,
+                    'id': impression.product_id,
+                    'price': impression.price,
+                    'category': impression.category,
+                    'variant': impression.sku,
+                    'quantity': impression.quantity
+                });
+            });
+
+            window.dataLayer.push({
+                'ecommerce': {
+                    'purchase': {
+                        'actionField': {
+                            'id': payload.id,
+                            'affiliation': payload.site_name,
+                            'revenue': payload.total_price,
+                            'tax': payload.tax_total,
+                            'shipping': payload.shipping_total,
+                            'coupon': payload.promo_codes.join(',')
+                        },
+                        'products': products
+                    }
+                }
+            });
+        }
+    };
+});

data/app/views/workarea/storefront/google_tag_manager/_no_script.html.haml

@@ -0,0 +1,3 @@
+- if Workarea::GoogleTagManager.container_id.present?
+  %noscript
+    %iframe{ src: "//www.googletagmanager.com/ns.html?id=#{Workarea::GoogleTagManager.container_id}", height: 0, width: 0, style: 'display:none;visibility:hidden'}

data/app/views/workarea/storefront/google_tag_manager/_script.html.haml

@@ -0,0 +1,3 @@
+- if Workarea::GoogleTagManager.container_id.present?
+  :javascript
+    (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='//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);})(window,document,'script','dataLayer', "#{Workarea::GoogleTagManager.container_id}");

data/bin/rails

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/google_tag_manager/engine', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'action_controller/railtie'
+require 'action_view/railtie'
+require 'action_mailer/railtie'
+require 'rails/test_unit/railtie'
+require 'sprockets/railtie'
+
+require 'rails/engine/commands'

data/config/initializers/appends.rb

@@ -0,0 +1,16 @@
+module Workarea
+  Plugin.append_javascripts(
+    'storefront.modules',
+    'workarea/storefront/google_tag_manager/modules/adapter'
+  )
+
+  Plugin.append_partials(
+    'storefront.document_head',
+    'workarea/storefront/google_tag_manager/script'
+  )
+
+  Plugin.append_partials(
+    'storefront.javascript',
+    'workarea/storefront/google_tag_manager/no_script'
+  )
+end

data/config/initializers/workarea.rb

@@ -0,0 +1,3 @@
+Workarea.configure do |config|
+  config.google_tag_manager = ActiveSupport::Configurable::Configuration.new
+end

data/lib/workarea/google_tag_manager.rb

@@ -0,0 +1,60 @@
+require 'workarea'
+require 'workarea/storefront'
+require 'workarea/admin'
+
+require 'workarea/google_tag_manager/engine'
+require 'workarea/google_tag_manager/version'
+
+module Workarea
+  module GoogleTagManager
+    # TODO: Remove this method and fallback to secrets configuration in the next
+    # major, config via rails configuration is preferable and can be referenced
+    # directly in the view
+    def self.configure_container
+      if Workarea.config.google_tag_manager_container_id.present?
+        self.container_id = Workarea.config.google_tag_manager_container_id
+      elsif Rails.application.secrets.google_tag_manager.present?
+        secrets = Rails.application.secrets.google_tag_manager.deep_symbolize_keys
+
+        self.container_id = secrets[:container_id]
+      end
+    end
+
+    def self.container_id
+      if Workarea.config.google_tag_manager.container_id.present?
+        Workarea.config.google_tag_manager.container_id
+      elsif Rails.application.secrets.google_tag_manager.present?
+        message = <<~WARN
+          Setting Google Tag Manager containter id via secrets is deprecated.
+          Set your container_id via Workarea.config
+
+          Workarea.configure do |config|
+            config.google_tag_manager.container_id = YOUR_CONTAINER_ID
+          end
+        WARN
+        ActiveSupport::Deprecation.warn(message)
+
+        Rails.application.secrets.google_tag_manager[:container_id]
+      else
+        @container_id
+      end
+    end
+
+    def self.container_id=(container_id)
+      message = <<~WARN
+        Workarea::GoogleTagManager.container_id= is deprecated.  Set your container_id
+        via Workarea.config
+
+        Workarea.configure do |config|
+          config.google_tag_manager.container_id = YOUR_CONTAINER_ID
+        end
+      WARN
+      ActiveSupport::Deprecation.warn(message)
+      @container_id = container_id
+    end
+
+    def self.config
+      Workarea.config.google_tag_manager
+    end
+  end
+end

data/lib/workarea/google_tag_manager/engine.rb

@@ -0,0 +1,8 @@
+module Workarea
+  module GoogleTagManager
+    class Engine < ::Rails::Engine
+      include Workarea::Plugin
+      isolate_namespace Workarea::GoogleTagManager
+    end
+  end
+end

data/lib/workarea/google_tag_manager/version.rb

@@ -0,0 +1,5 @@
+module Workarea
+  module GoogleTagManager
+    VERSION = "4.3.1"
+  end
+end

data/script/admin_ci

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+gem install bundler
+bundle update
+
+CI_GEM_PATH="$(bundle show workarea-ci)"
+. ${CI_GEM_PATH}/exe/workarea-set-ci-env
+
+bin/rails app:workarea:test:admin

data/script/ci

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+gem install bundler
+bundle update
+
+CI_GEM_PATH="$(bundle show workarea-ci)"
+. ${CI_GEM_PATH}/exe/workarea-set-ci-env
+
+bundle exec workarea-lint
+bundle exec workarea-audit
+bin/rails test test/**/*_test.rb