middleman-google-tag-manager 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 62fc70fc72c231ee1d8fce2b2bd145be471ba9cd
+  data.tar.gz: 210e745a7ce6a02aaa6dbc230e1bf6f6d44d1352
+SHA512:
+  metadata.gz: 368caad7798da61caf81508a9df5865f85925c1c8dd20563e246f0f2a4f58e4236fe08464e2366a116d28174d79a9fa2a8b0acfcd0410844f4cef8fb65a56b3f
+  data.tar.gz: fcad45fa88be20a4bb73e7ae5faa2cddcc43770e0845da145bea4bf0a2b1577a2611777a1af055a58350c70a24e22a7666acb04941aacee934c44149395d6c5d

data/.gitignore

@@ -0,0 +1,7 @@
+# Ignore bundler lock file
+/Gemfile.lock
+
+# Ignore pkg folder
+/pkg
+
+.env

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in middleman-foxycart.gemspec
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rdoc'
+  gem 'yard'
+end
+
+group :test do
+  gem 'cucumber'
+  gem 'aruba'
+  gem 'rspec'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Robert Coleman
+
+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,36 @@
+# middleman-google-tag-manager
+
+A [Middleman](https://middlemanapp.com) extension for use with [Google Tag Manager](https://www.google.com/analytics/tag-manager/).
+
+__Features__
+
+* Automatically places Google Tag Manager code on all configured pages.
+
+
+## Setup and Configuration
+
+In `config.rb`
+
+```ruby
+activate :google_tag_manager do |gtm|
+  gtm.container_id = 'your Google Tag Manager container ID' # required
+  gtm.development = true # Render tag in development environment
+end
+```
+
+## Helper and Usage
+
+Examples for ERB templates:
+
+```ruby
+<%= google_tag_manager %>
+# e.g. use in layout.erb
+```
+
+## See also
+
+* Google Analytics https://github.com/danielbayerlein/middleman-google-analytics - (several ideas taken from here :)
+
+## 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,14 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
+  t.cucumber_opts = '--color --tags ~@wip --strict'
+end
+
+require 'rake/clean'
+
+task test: ['cucumber']
+
+task default: :test

data/features/support/env.rb

@@ -0,0 +1,4 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+require 'middleman-core'
+require 'middleman-core/step_definitions'
+require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-google-tag-manager')

data/lib/middleman-google-tag-manager.rb

@@ -0,0 +1,53 @@
+require 'middleman-core'
+
+class GoogleTagManager < ::Middleman::Extension
+  option :container_id, ENV['GTM_CONTAINER_ID'], 'Google Tag Manager container ID'
+  option :development, true, 'Render tag in development environment'
+
+  def after_configuration
+    unless options.container_id
+      $stderr.puts 'Google Tag Manager: Please specify a container ID'
+      raise ArgumentError, 'No container ID given' if display?
+    end
+  end
+
+  helpers do
+    def google_tag_manager
+      options = extensions[:google_tag_manager].options
+      return unless !legacy_development? && options.development
+
+      @text ||= <<-END.gsub(/^ {8}/, '')
+      <!-- Google Tag Manager -->
+      <noscript><iframe src="//www.googletagmanager.com/ns.html?id=#{options.container_id}"
+      height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
+      <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=
+      '//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
+      })(window,document,'script','dataLayer','#{options.container_id}');</script>
+      <!-- End Google Tag Manager -->
+      END
+    end
+
+    # Support for Middleman >= 3.4
+    def legacy_development?
+      # Middleman 3.4
+      is_development = try(:development?)
+      unless is_development.nil?
+        return is_development
+      end
+
+      # Middleman 4.x
+      app.development?
+    end
+  end
+
+  private
+
+  def display?
+    app.build? || app.development? && options.development
+  end
+
+end
+
+GoogleTagManager.register(:google_tag_manager)

data/lib/middleman_extension.rb

@@ -0,0 +1 @@
+require 'middleman-google-tag-manager'

data/middleman-google-tag-manager.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'middleman-google-tag-manager'
+  s.version     = '0.1.0'
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Robert Coleman']
+  s.email       = ['github@robert.net.nz']
+  s.homepage    = 'https://github.com/rjocoleman/middleman-google-tag-manager'
+  s.summary     = %q{Google Tag Manager for Middleman static sites}
+  s.description = %q{Google Tag Manager for Middleman static sites}
+  s.license     = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'middleman-core', '>= 3.4.0'
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: middleman-google-tag-manager
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robert Coleman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+description: Google Tag Manager for Middleman static sites
+email:
+- github@robert.net.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- features/support/env.rb
+- lib/middleman-google-tag-manager.rb
+- lib/middleman_extension.rb
+- middleman-google-tag-manager.gemspec
+homepage: https://github.com/rjocoleman/middleman-google-tag-manager
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Google Tag Manager for Middleman static sites
+test_files:
+- features/support/env.rb
+has_rdoc: