gtm_on_rails 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0ec1eedc243a6747548039fa1914fe3689e8f92
-  data.tar.gz: 4f553724eb9db2f7de5e0729d7a3e6b8c8c27890
+  metadata.gz: 161f6aefbee25eb72bbde39f556a1d31922c9e85
+  data.tar.gz: 02ed437da032b4b921858401559a5acfcebe84cd
 SHA512:
-  metadata.gz: b4f8294fa648b984aedcffdf894ee871ccc3d7f50f6eff9b149caef12c7987665ec922048dcc098878e987fdce336aaa488d5e75c2c9b54fa16ac47ae60ed576
-  data.tar.gz: 04ddd328a2bcf278133befb6fa039f15f7f7be2fd98f2bbe382ba36aeae66895ef133e2f2d9e3a2dfc9ad8ad194baecf234ce1b06deaaedc033f59d22a81f6f6
+  metadata.gz: 04f69bbb0adffce5e6994147dee884009ec61a5c8ba90c7c09ce932177c433518cd8ae47ef5e3fcd2be4fd71ba330be826c8c043ab9d1d241fe92063d068c255
+  data.tar.gz: 0cce859b62d1a8f8c3fb8487f9515546be86c9fce823755d2af346ddecfe9c33b314919ae015861888adde7495035bc40a25813dcdfeebca4e4216c513638e6d

data/README.ja.md

@@ -37,6 +37,41 @@ controller名とaction名はJavaScriptのコードとしてHTMLのソースコ
 この設定を有効にすることによって、JavaScriptのコードとして出力される際に、dataLayerに設定した値などの問題でエラーが発生場合にエラーを握りつぶします。
 つまり、計測周りのエラーによってサイトの表示に影響が出ないようにします。
 
+## Usage
+#### 基本
+`data_layer`という変数(正確にはhelperが呼び出す変数@gtm_on_rails_data_layer)にdataLayerで送信したい内容をHash型で追加するだけでdataLayerで好きな値を送信できます。
+controller内等で以下のように記述する感じになると思います。
+
+```ruby
+data_layer.push({
+  name: 'name'
+})
+```
+
+送信したdataLayerの内容は、GoogleTagManager側で変数に設定する等して使用して下さい。
+
+#### `GtmOnRails::DataLayerObject`
+```ruby
+object = GtmOnRails::DataLayerObject.new({name: 'name'})
+data_layer.push(object)
+```
+Hash形式ではなく、上記のように`GtmOnRails::DataLayerObject`クラスを用いることもできます。
+
+```ruby
+object = GtmOnRails::DataLayerObject.new({name: 'name'})
+puts object.name
+```
+`GtmOnRails::DataLayerObject`クラスでは、上記のように値にアクセスできます。
+
+
+#### `GtmOnRails::DataLayerEvent`
+```ruby
+event = GtmOnRails::DataLayerEvent.new('イベント名', {name: 'name'})
+data_layer.push(event)
+```
+上記のように記述することで、イベント名を設定して送信できます。
+
+
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 

data/README.md

@@ -1,5 +1,9 @@
 # GTMonRails
-GTMonRails enables you to integrate Google Tag Manager easy.
+GTMonRails enables you to integrate Google Tag Manager easy with Rails application.
+
+GTMonRails not only embed Google Tag Manager snippet, but simply operate and send JavaScript's variable 'dataLayer' for GTM in Ruby code.
+
+GTMonRails basically can't be used only this, you have to set up Tag and Trigger on Google Tag Manager.
 
 *Read this in other languages: [日本語](README.ja.md)*
 
@@ -15,21 +19,58 @@ And then execute:
 $ bundle
 ```
 
-And then execute and initial settings:
+And then run initial settings:
 ```bash
 $ rails g gtm_on_rails:install
 ```
 
-Or install it yourself as:
-```bash
-$ gem install gtm_on_rails
-```
-
 ## Configure
+Edit the `/config/initializers/gtm_on_rails.rb` file and customize following settings.
 #### container_id
+Set your Google Tag Manager container ID.
 #### data_layer_limit_byte_size
+DataLayer is limited by bytesize at once post. If post size is over this bytesize, exception occured.
 #### send_controller_and_action_in_data_layer
+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.
 #### rescue_when_error_occurred
+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 you enable this option.
+
+## Usage
+#### Basic
+You only push Hash object in `data_layer` variable, can send values what you want by dataLayer.
+Usually I’d say you write like the following code in contoller.
+
+```ruby
+data_layer.push({
+  name: 'name'
+})
+```
+Configure the variable and so on Google Tag Manager when use sended values.
+
+#### `GtmOnRails::DataLayerObject`
+```ruby
+object = GtmOnRails::DataLayerObject.new({name: 'name'})
+data_layer.push(object)
+```
+You also can use `GtmOnRails::DataLayerObject` object rather than Hash as the above.
+
+```ruby
+object = GtmOnRails::DataLayerObject.new({name: 'name'})
+puts object.name
+```
+You can access values with `GtmOnRails::DataLayerObject` object as the above.
+
+#### `GtmOnRails::DataLayerEvent`
+```ruby
+event = GtmOnRails::DataLayerEvent.new('イベント名', {name: 'name'})
+data_layer.push(event)
+```
+You can send dataLayer with Google Tag Manager's event name, when write like the above code.
 
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Author
+[ykogure](https://github.com/ykogure)

data/lib/generators/templates/gtm_on_rails.rb

@@ -11,6 +11,6 @@ GtmOnRails.configure do |config|
   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.
+  # The point is, dataLayer error won't affect displaying website, if you enable this option.
   config.rescue_when_error_occurred = false
 end

data/lib/gtm_on_rails/models/data_layer.rb

@@ -7,7 +7,7 @@ module GtmOnRails
 
     def initialize(*args)
       options  = args.extract_options!
-      @objects = args # @objects is instances of GTM::DataLayerObject
+      @objects = args # @objects are instances of GTM::DataLayerObject
     end
 
     def push(objects)
@@ -33,7 +33,7 @@ module GtmOnRails
           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});"
+        js_codes << data_layer_object.to_js
       end
 
       return content_tag(:script, js_codes.join.html_safe)

data/lib/gtm_on_rails/models/data_layer_object.rb

@@ -15,9 +15,23 @@ module GtmOnRails
       @data.to_json
     end
 
+    def to_js
+      "dataLayer.push(#{self.to_json});"
+    end
+
     def method_missing(method, *args, &block)
-      if @data.has_key?(method)
-        @data[method]
+      if method.to_s.end_with?('=')
+        key     = method.to_s.chop.to_sym
+        _method = :[]=
+        _args   = [key] + args
+      else
+        key     = method
+        _method = :[]
+        _args   = [key]
+      end
+
+      if @data.has_key?(key)
+        @data.send(_method, *_args)
       else
         super
       end

data/lib/gtm_on_rails/version.rb

@@ -1,3 +1,3 @@
 module GtmOnRails
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gtm_on_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - ykogure
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-02 00:00:00.000000000 Z
+date: 2017-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails