sb-styleguide 1.1.0 → 1.2.0

data/CHANGELOG.md

@@ -1 +1,2 @@
-# Changelog
+## 1.2.0
+- Adding Snowplow events JS plugin

data/Gemfile.lock

@@ -8,7 +8,7 @@ GIT
 PATH
   remote: .
   specs:
-    sb-styleguide (1.0.1)
+    sb-styleguide (1.2.0)
       actionpack (>= 3.1, < 4.1)
       activesupport (>= 3.1, < 4.1)
       compass-rails (>= 1.0, < 2.0)

data/lib/sb-styleguide/version.rb

@@ -1,5 +1,5 @@
 module Sb
   module Styleguide
-    VERSION = "1.1.0"
+    VERSION = "1.2.0"
   end
 end

data/vendor/assets/javascripts/plinth/plugins/tbg-snowplow.js.coffee

@@ -0,0 +1,89 @@
+# ============================================================
+# SnowplowEvents v0.0.1
+# http://URL
+# ============================================================
+# Copyright 2013 The Beans Group
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+plugin = ($) ->
+
+  "use strict"
+
+  # Class definition
+  #
+  # @example How to use with HAML
+  # %a{href: 'path/to/link', data: { spevent: 'category|action|label|prop|value' }}
+  # @see https://github.com/snowplow/snowplow/wiki/2-Specific-event-tracking-with-the-Javascript-tracker#371-trackstructevent
+  #
+  # @example Ensure plugin self-initialises
+  # <form data-spevent-load="true">...</form>
+  #
+  class SPEvent
+
+    # SPEvent constructor
+    #
+    # @param el [DOMElement] 
+    # @param content [String] Pipe-delimited string of event data
+    # 
+    constructor: (el, @content) ->
+      $el = $(el)
+      @sendEvent (if !(content.split('|') instanceof Array) then content.split('|') else [content]
+
+    _constructor: SPEvent
+
+    # Send event to Snowplow
+    #
+    # sendEvent :: [String] -> [String]
+    #
+    # @param evData [Array]
+    #
+    sendEvent: (data) ->
+      evData = ['trackStructEvent'].concat data
+      _snaq?.push evData
+
+  # Remove data and assoc attributes from DOM element
+  #
+  # @param $el [DOMElement] jQuery-wrapped DOM el
+  # @param ev [String] Data to be removed
+  # 
+  removeData = ($el, ev) ->
+    $el.removeAttr('data-' + ev)
+    $el.removeData(ev)
+    
+  # SPEvent plugin
+  # 
+  $.fn.spEvent = (option, type = "spevent") ->
+    this.each ->
+      $this = $(@)
+      $this = if ($t = $(this)).is("[data-#{type}]") then $t else $t.closest("[data-#{type}]")
+      data = $this.data 'speventplugin'
+      if not (eventContent = $this.data(type)) then return removeData($this, type)
+      if !data then $this.data 'speventplugin', (data = new SPEvent @, eventContent)
+      if typeof option is 'string' then data[option].call $this
+
+  $.fn.spEvent.Constructor = SPEvent
+
+  # Data API
+  # 
+  $ ->
+    $('body').on 'click.spEvent.data-api', '[data-spevent]' , ( e ) ->
+      $this = $(e.target)
+      $this.spEvent()
+
+    $('body').on 'tbgform-success.spEvent.data-api', (e, $form)->
+      $form.spEvent null, 'spevent-form'
+
+    $('[data-spevent-load]').each ->
+      $(this).spEvent null, 'spevent-load'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sb-styleguide
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-29 00:00:00.000000000 Z
+date: 2014-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
@@ -442,6 +442,7 @@ files:
 - vendor/assets/images/middleman.png
 - vendor/assets/index.html.haml
 - vendor/assets/javascripts/.gitkeep
+- vendor/assets/javascripts/plinth/plugins/tbg-snowplow.js.coffee
 - vendor/assets/javascripts/styleguide/lib/handlebars.js
 - vendor/assets/javascripts/styleguide/lib/jquery.fitvids.js
 - vendor/assets/javascripts/styleguide/lib/ss-social.js
@@ -510,12 +511,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1342012928098939340
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1342012928098939340
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -532,4 +539,3 @@ test_files:
 - spec/javascripts/plugins/tbg-ga-events_spec.js.coffee
 - spec/javascripts/plugins/tbg-switch_spec.js.coffee
 - spec/javascripts/spec.js.coffee
-has_rdoc: