gtm_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 71fcae571ffbb04c94123e71552fea23417f812d
+  data.tar.gz: b6340e272eec3ca50ddfd3d08fdc7e51b2c448bb
+SHA512:
+  metadata.gz: c07325a4baa3a6e3e48cf7206ade905eb58016a8173dc13b667fc7c97feb184b385f7ea8675fffc1ad45ada5fc61e5c2ba0ee5740fdcc1401e983a34938b3ad1
+  data.tar.gz: cefc83f80fc492f2cc0e913020acc120f4b2fb9df5dac4e785a6307ff27931981a0479f22a9e288d0a4e6209b873a27e735acabb725dd35252eec5aaf1e63153

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2017 Koichi ITO
+
+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,60 @@
+# gtm_rails
+
+Simply embed Google Tag Manager container snippet into Rails application.
+
+## Installation
+
+Add these lines to your application's Gemfile:
+
+```
+gem 'gtm_rails'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install gtm_rails
+```
+
+## Configuration
+
+Create `config/google_tag_manager.yml` in your Rails application.
+
+```yaml
+development:
+  - foo: GTM-YourGtmId1
+  - bar: GTM-YourGtmId2
+  - baz: GTM-YourGtmId3
+production:
+  - foo: GTM-YourGtmId4
+  - bar: GTM-YourGtmId5
+  - baz: GTM-YourGtmId6
+```
+
+The above is a sample. `foo`, `bar`, `baz` are arbitrary label names.
+
+In view, use as follows. The argument is a label name specified in `config/google_tag_manager.yml`.
+
+```ruby
+<%= google_tag_manager(:foo) %>
+```
+
+Google Tag Manager container snippet expands to RAILS_ENV and label name. If there is no match, a blank is returned.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+gtm_rails is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/lib/gtm_rails.rb

@@ -0,0 +1,5 @@
+require 'gtm_rails/version'
+require 'gtm_rails/config'
+require 'gtm_rails/helper'
+require 'gtm_rails/hooks'
+require 'gtm_rails/railtie'

data/lib/gtm_rails/config.rb

@@ -0,0 +1,9 @@
+require 'singleton'
+
+module GtmRails
+  class Config
+    include Singleton
+
+    cattr_accessor :gtm
+  end
+end

data/lib/gtm_rails/helper.rb

@@ -0,0 +1,21 @@
+module GtmRails
+  module Helper
+    def google_tag_manager(label)
+      gtm = GtmRails::Config.gtm[label]
+
+      return '' if gtm.blank?
+
+      <<-HTML.html_safe
+<!-- Google Tag Manager -->
+<noscript><iframe src="//www.googletagmanager.com/ns.html?id=#{gtm}"
+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','#{gtm}');</script>
+<!-- End Google Tag Manager -->
+      HTML
+    end
+  end
+end

data/lib/gtm_rails/hooks.rb

@@ -0,0 +1,17 @@
+module GtmRails
+  class Hooks
+    def self.init
+      require 'gtm_rails/yaml_loader'
+
+      loader = ::GtmRails::YamlLoader.new
+
+      gtms = loader.load.fetch(ENV['RAILS_ENV'] || 'development')
+
+      GtmRails::Config.gtm = gtms.each_with_object({}.with_indifferent_access) {|gtm, ret|
+        ret[gtm.keys.first] = gtm.values.first
+      }
+
+      ActionView::Base.send :include, GtmRails::Helper
+    end
+  end
+end

data/lib/gtm_rails/railtie.rb

@@ -0,0 +1,9 @@
+module GtmRails
+  class Railtie < ::Rails::Railtie
+    initializer 'gtm_rails.initialize' do
+      ActiveSupport.on_load(:action_view) do
+        GtmRails::Hooks.init
+      end
+    end
+  end
+end

data/lib/gtm_rails/version.rb

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

data/lib/gtm_rails/yaml_loader.rb

@@ -0,0 +1,23 @@
+module GtmRails
+  class YamlLoader
+    def load
+      yaml = Rails.root.join('config', 'google_tag_manager.yml')
+
+      config = if yaml && yaml.exist?
+        require 'yaml'
+        require 'erb'
+        YAML.load(ERB.new(yaml.read).result) || {}
+      else
+        raise 'Could not load database configuration. No such file - config/google_tag_manager.yml'
+      end
+
+      config
+    rescue Psych::SyntaxError => e
+      raise "YAML syntax error occurred while parsing config/google_tag_manager.yml. " \
+            "Please note that YAML must be consistently indented using spaces. Tabs are not allowed. " \
+            "Error: #{e.message}"
+    rescue => e
+      raise e, "Cannot load `GtmRails:YamlLoader.load`:\n#{e.message}", e.backtrace
+    end
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: gtm_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Koichi ITO
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: Simply embed Google Tag Manager container snippet into Rails application
+email: koic.ito@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/gtm_rails.rb
+- lib/gtm_rails/config.rb
+- lib/gtm_rails/helper.rb
+- lib/gtm_rails/hooks.rb
+- lib/gtm_rails/railtie.rb
+- lib/gtm_rails/version.rb
+- lib/gtm_rails/yaml_loader.rb
+homepage: http://github.com/koic/gtm_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: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Simply embed Google Tag Manager container snippet into Rails application
+test_files: []