gtm_on_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 14ab2f80c367244061aeffbdc9ddf196e66efd36
+  data.tar.gz: 0312a7c4f439098bfec363eb704c0b052ac39224
+SHA512:
+  metadata.gz: e27af578d0c8688a9b7877f7cad83b0a1902be5a9437b0c4da0065fe9e8458f710dead53f447e72554d57df51079260ee5ec22d8bd65d5d1b0a7582917e8cdca
+  data.tar.gz: 93e5c22b8d86a7627cc390d4641ee29029293d1d3681ed21d5c4d1cb8fc7da52600513785b9821e05890aa1949bbeefc10bca64a043587a1821157394bc840e9

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 ykogure
+
+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,30 @@
+# GTMonRails
+GTMonRails enables you to integrate Google Tag Manager easy.
+
+*Read this in other languages: [日本語](README.ja.md)*
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gtm_on_rails'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install gtm_on_rails
+```
+
+## Configure
+#### container_id
+#### data_layer_limit_byte_size
+#### send_controller_and_action_in_data_layer
+#### rescue_when_error_occurred
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,37 @@
+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    = 'GtmOnRails'
+  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'
+
+
+
+require 'bundler/gem_tasks'
+
+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

data/app/views/gtm_on_rails/layouts/_data_layer_tag.html.erb

@@ -0,0 +1,7 @@
+<% begin %>
+  <%= data_layer.print_on_js %>
+<%-
+  rescue StandardError => e
+    raise e unless GtmOnRails.config.rescue_when_error_occurred
+  end
+-%>

data/app/views/gtm_on_rails/layouts/_google_tag_manager_tag_in_body.html.erb

@@ -0,0 +1,4 @@
+<!-- Google Tag Manager (noscript) -->
+<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=<%= GtmOnRails.config.container_id %>"
+height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
+<!-- End Google Tag Manager (noscript) -->

data/app/views/gtm_on_rails/layouts/_google_tag_manager_tag_in_head.html.erb

@@ -0,0 +1,7 @@
+<!-- Google Tag Manager -->
+<script>(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','<%= GtmOnRails.config.container_id %>');</script>
+<!-- End Google Tag Manager -->

data/lib/generators/gtm_on_rails/install_generator.rb

@@ -0,0 +1,22 @@
+module GtmOnRails
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Creates a GTM on Rails initializer to your application."
+
+      def copy_initializer
+        template "gtm_on_rails.rb", "config/initializers/gtm_on_rails.rb"
+      end
+
+      def insert_javascript_tag
+        inject_into_file "app/views/layouts/application.html.erb", after: /<head[\s]?[^>]*>/ do
+          "\n    <%= render_gtm_on_rails_tag_in_head %>\n"
+        end
+        inject_into_file "app/views/layouts/application.html.erb", after: /<body[\s]?[^>]*>/ do
+          "\n    <%= render_gtm_on_rails_tag_in_body %>\n"
+        end
+      end
+    end
+  end
+end

data/lib/generators/templates/gtm_on_rails.rb

@@ -0,0 +1,16 @@
+GtmOnRails.configure do |config|
+  # Your Google Tag Manager Container ID
+  config.container_id = "Replacing GTM-XXXX with your container ID"
+
+  # DataLayer is limited by size less than 8,192 bytes in once post,
+  # so default limit afford 7,000 bytes with an margin.
+  config.data_layer_limit_byte_size = 7000
+
+  # Settings that send google tag manager controller and action name by dataLayer.
+  # Be careful using this, if you enable this option, controller and action name output in html source code.
+  config.send_controller_and_action_in_data_layer = false
+
+  # If somthing error occurred when output tags, subsequent tag's output is stopped and run subsequent processing. 
+  # The point is, dataLayer error won't affect displaying website, if this option is enable.
+  config.rescue_when_error_occurred = false
+end

data/lib/gtm_on_rails/config.rb

@@ -0,0 +1,9 @@
+module GtmOnRails
+  class Config
+    # Variables detail is writen in lib/generators/templates/gtm_on_rails.rb.
+    attr_accessor :container_id
+    attr_accessor :data_layer_limit_byte_size
+    attr_accessor :send_controller_and_action_in_data_layer
+    attr_accessor :rescue_when_error_occurred
+  end
+end

data/lib/gtm_on_rails/controllers/initialize_data_layer.rb

@@ -0,0 +1,32 @@
+module GtmOnRails
+  module Controllers
+    module InitializeDataLayer
+      extend ActiveSupport::Concern
+
+      included do
+        if Rails::VERSION::MAJOR == 3
+          before_filter :initialize_data_layer
+        else
+          before_action :initialize_data_layer
+        end
+        helper_method :data_layer
+      end
+
+      def data_layer
+        @gtm_on_rails_data_layer
+      end
+      
+      private
+        def initialize_data_layer
+          @gtm_on_rails_data_layer = GtmOnRails::DataLayer.new
+
+          if GtmOnRails.config.send_controller_and_action_in_data_layer
+            @gtm_on_rails_data_layer.push({
+              controller: controller_name,
+              action:     action_name
+            })
+          end
+        end
+    end
+  end
+end

data/lib/gtm_on_rails/engine.rb

@@ -0,0 +1,31 @@
+require 'gtm_on_rails/config'
+require 'gtm_on_rails/controllers/initialize_data_layer'
+require 'gtm_on_rails/models/data_layer'
+require 'gtm_on_rails/models/data_layer_object'
+require 'gtm_on_rails/models/data_layer_event'
+require 'gtm_on_rails/tag_helper'
+
+module GtmOnRails
+  def self.config
+    @config ||= GtmOnRails::Config.new
+  end
+ 
+  def self.configure(&block)
+    yield(config) if block_given?
+  end
+  
+  class Engine < ::Rails::Engine
+    isolate_namespace GtmOnRails
+
+    initializer 'gtm_on_rails.action_controller_extension' do
+      ActiveSupport.on_load :action_controller do
+        include GtmOnRails::Controllers::InitializeDataLayer
+      end
+    end
+    initializer 'gtm_on_rails.action_view_helpers' do
+      ActiveSupport.on_load :action_view do
+        include GtmOnRails::TagHelper
+      end
+    end
+  end
+end

data/lib/gtm_on_rails/models/data_layer.rb

@@ -0,0 +1,42 @@
+# Class to take a roll as dataLayer of javascript's variable
+module GtmOnRails
+  class DataLayer
+    include ActionView::Helpers::TagHelper
+
+    attr_reader :objects
+
+    def initialize(*args)
+      options  = args.extract_options!
+      @objects = args # @objects is instances of GTM::DataLayerObject
+    end
+
+    def push(objects)
+      objects = [objects].flatten
+      objects.each do |object|
+        case object
+        when Hash
+          @objects << GtmOnRails::DataLayerObject.new(object)
+        when GtmOnRails::DataLayerObject
+          @objects << object
+        end 
+      end
+    end
+
+    def print_on_js
+      js_codes = []
+
+      js_codes << "var dataLayer = dataLayer || [];"
+      @objects.each do |data_layer_object|
+        # dataLayer size limit exception
+        size = data_layer_object.to_json.bytesize
+        if size > GtmOnRails.config.data_layer_limit_byte_size
+          raise ArgumentError.new("DataLayer bytesize is over limit #{GtmOnRails.config.data_layer_limit_byte_size} bytes. Size is #{size} bytes.")
+        end
+
+        js_codes << "dataLayer.push(#{data_layer_object.to_json});"
+      end
+
+      return content_tag(:script, js_codes.join.html_safe)
+    end
+  end
+end

data/lib/gtm_on_rails/models/data_layer_event.rb

@@ -0,0 +1,15 @@
+# Class to take a roll as javascript's object in dataLayer for google tag manager event
+module GtmOnRails
+  class DataLayerEvent < GtmOnRails::DataLayerObject
+    def initialize(event_name, **args)
+      @data = args.merge(event: event_name).with_indifferent_access
+    end
+
+    def event_name
+      @data[:event]
+    end
+    def event_name=(arg)
+      @data[:event] = arg
+    end
+  end
+end

data/lib/gtm_on_rails/models/data_layer_object.rb

@@ -0,0 +1,26 @@
+# Class to take a roll as javascript's object in dataLayer
+module GtmOnRails
+  class DataLayerObject
+    attr_accessor :data
+
+    def initialize(**args)
+      @data = args.with_indifferent_access
+    end
+
+    def add(**hash)
+      @data.merge!(hash)
+    end
+
+    def to_json
+      @data.to_json
+    end
+
+    def method_missing(method, *args, &block)
+      if @data.has_key?(method)
+        @data[method]
+      else
+        super
+      end
+    end
+  end
+end

data/lib/gtm_on_rails/tag_helper.rb

@@ -0,0 +1,16 @@
+module GtmOnRails
+  module TagHelper
+    def render_gtm_on_rails_tag_in_head
+      tags = []
+      tags << render(partial: 'gtm_on_rails/layouts/google_tag_manager_tag_in_head')
+      tags.join.html_safe
+    end
+
+    def render_gtm_on_rails_tag_in_body
+      tags = []
+      tags << render(partial: 'gtm_on_rails/layouts/data_layer_tag')
+      tags << render(partial: 'gtm_on_rails/layouts/google_tag_manager_tag_in_body')
+      tags.join.html_safe
+    end
+  end
+end

data/lib/gtm_on_rails/version.rb

@@ -0,0 +1,3 @@
+module GtmOnRails
+  VERSION = '0.1.0'
+end

data/lib/gtm_on_rails.rb

@@ -0,0 +1,4 @@
+require "gtm_on_rails/engine"
+
+module GtmOnRails
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: gtm_on_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ykogure
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.22
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.22
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An plugin that integrate Google Tag Manager easy with Rails
+email:
+- renkin1008@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/views/gtm_on_rails/layouts/_data_layer_tag.html.erb
+- app/views/gtm_on_rails/layouts/_google_tag_manager_tag_in_body.html.erb
+- app/views/gtm_on_rails/layouts/_google_tag_manager_tag_in_head.html.erb
+- lib/generators/gtm_on_rails/install_generator.rb
+- lib/generators/templates/gtm_on_rails.rb
+- lib/gtm_on_rails.rb
+- lib/gtm_on_rails/config.rb
+- lib/gtm_on_rails/controllers/initialize_data_layer.rb
+- lib/gtm_on_rails/engine.rb
+- lib/gtm_on_rails/models/data_layer.rb
+- lib/gtm_on_rails/models/data_layer_event.rb
+- lib/gtm_on_rails/models/data_layer_object.rb
+- lib/gtm_on_rails/tag_helper.rb
+- lib/gtm_on_rails/version.rb
+homepage: https://github.com/ZIGExN/gtm_on_rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: An plugin that integrate Google Tag Manager easy with Rails
+test_files: []