sb-styleguide 0.0.7 → 0.0.8

data/lib/sb-styleguide/version.rb

@@ -1,5 +1,5 @@
 module Sb
   module Styleguide
-    VERSION = "0.0.7"
+    VERSION = "0.0.8"
   end
 end

data/spec/javascripts/fixtures/plugins/tbg-ga-events_fixture.html.haml

@@ -0,0 +1,9 @@
+%a{:href=>"#clickyclick", :class=>"btn", :data=> {:gaevent=>"ping|ding"}}
+
+%a{:href=>"#clickyclick", :class=>"btn2", :data=> {:gaevent=>""}}
+
+%a{:href=>"#clickyclick", :class=>"btn3", :data=> {"gaevent-load" =>'ping|ding'}}
+
+%form{:class=>"GAForm", :data=>{"gaevent-form"=>"ping|ding"}}
+  %input{:type=>"text"}
+  %input{:type=>"submit"}

data/spec/javascripts/plugins/tbg-ga-events_spec.js.coffee

@@ -0,0 +1,83 @@
+#=require styleguide/plugins/tbg-ga-events
+
+root = this
+describe "Google Analytics Events", ->
+  beforeEach ->
+    loadFixtures 'plugins/tbg-ga-events_fixture'
+    window._gaq = []
+
+  describe "a jQuery Plugin", ->
+    it "should be defined on jquery object", ->
+      expect( $('.btn').gaEvent() ).toBeDefined()
+
+    it "should return element", ->
+      expect( $('.btn').gaEvent()[0] ).toBe($('.btn')[0])
+
+  describe "getting Events", ->
+
+    it "can be initated for onload event", ->
+      # This is an ugly way to test the content but as it is fired on load
+      # then we must 'assume' this will be fired and test the internal working
+      # of the plugin.
+      $('[data-gaevent-load]').each ->
+        $(this).gaEvent null, 'gaevent-load'
+
+      $but = $('.btn3')
+      $data = $but.data 'gaeventplugin'
+      expect( $data.eventcontent ).toEqual('ping|ding')
+
+
+    it "can be initated on click", ->
+      $but = $('.btn').click()
+      $data = $but.data 'gaeventplugin'
+      expect( $data.eventcontent ).toEqual('ping|ding')
+
+    it "can be initated via a form submit event", ->
+      $form = $('.GAForm')
+      $('body').trigger 'tbgform-success' , [$form]
+      $data = $form.data 'gaeventplugin'
+      expect( $data.eventcontent ).toEqual('ping|ding')
+
+    it "should remove GAEvent hooks if no event is supplied", ->
+      $but = $('.btn2').click()
+      expect( $but.data('gaevent') ).not.toBeDefined()
+      expect( $but.data('gaeventplugin') ).not.toBeDefined()
+
+
+  describe "send Events", ->
+    beforeEach ->
+      root._gaq = []
+
+    it "should add the event to the google array on click method", ->
+      $('.btn').click()
+      expect(root._gaq.length).toEqual(1)
+
+    it "should add the event to the google array on form method", ->
+      $('body').trigger 'tbgform-success' , [$('.GAForm')]
+      expect(root._gaq.length).toEqual(1)
+
+    it "should add the event to the google array on onLoad method", ->
+      $('[data-gaevent-load]').each ->
+        $(this).gaEvent null, 'gaevent-load'
+      expect(root._gaq.length).toEqual(1)
+
+
+
+  # Must be the last test as we unbind
+  # the plugin to the data api
+  describe "the data API", ->
+    it "should be initated on click", ->
+      $but = $('.btn').click()
+      $data = $but.data('gaeventplugin')
+      expect( $data ).toBeDefined()
+
+    it "should be add the constructor to the data element", ->
+      $but = $('.btn').click()
+      $data = $but.data('gaeventplugin')
+      expect( $data instanceof  $.fn.gaEvent.Constructor ).toBeTruthy()
+
+    it "should not be initated if unattached via data API", ->
+      $('body').off('.gaEvent.data-api')
+      $but = $('.btn').click()
+      $data = $but.data('gaeventplugin')
+      expect( $data ).not.toBeDefined()

data/vendor/assets/javascripts/styleguide/plugins/tbg-ga-events.js.coffee

@@ -0,0 +1,86 @@
+# ============================================================
+# GAEvents v0.0.0
+# http://URL
+# ============================================================
+# Copyright 2012 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.
+#
+
+# Useage:
+# ========================
+# 
+# HAML> %a{:href=>"#clickyclick", :class=>"btn", :data=> {:gaevent=>"category|action|opt_label|opt_value|opt_noninteraction"}}
+# See: https://developers.google.com/analytics/devguides/collection/gajs/eventTrackerGuide
+
+plugin = ($)->
+
+  "use strict"
+
+  # GAEVENT CLASS DEFINITION
+  # ========================= 
+  class GAEvent
+    constructor: ( element, @eventcontent ) ->
+      $el = $(element)
+      @sendEvent (if typeof eventcontent.split('|') isnt "array" then eventcontent.split('|') else [eventcontent])
+
+    _constructor: GAEvent
+
+    sendEvent : (data)->
+      data.unshift('_trackEvent')
+      _gaq?.push data
+
+  # Private method
+  removeData = ( $el, ev )->
+    $el.removeAttr('data-' + ev)
+    $el.removeData(ev)
+
+
+  # GAEVENT PLUGIN DEFINITION
+  # ==========================
+
+  $.fn.gaEvent = ( option , type = "gaevent") ->
+    this.each ->
+      $this = $(@)
+      data = $this.data 'gaeventplugin'
+      if not (eventContent= $this.data type ) then return removeData($this, type)
+      if !data then $this.data 'gaeventplugin', (data = new GAEvent @, eventContent)
+      if typeof option is 'string' then data[option].call $this
+
+  $.fn.gaEvent.Constructor = GAEvent
+
+  # DATA API
+  # ===================================
+
+  $ ->
+
+    $('body').on 'click.gaEvent.data-api', '[data-gaevent]' , ( e ) ->
+      $this = $(e.target)
+      $this.gaEvent()
+
+    $('body').on 'tbgform-success.gaEvent.data-api', (e, $form)->
+      $form.gaEvent null, 'gaevent-form'
+
+    # Can't turn this off via the data API
+    # @todo Enable Data API ga-event-load method
+    $('[data-gaevent-load]').each ->
+      $(this).gaEvent null, 'gaevent-load'
+
+
+do ( plugin ) ->
+  if typeof define is 'function' and define.amd
+    # AMD. Register as an anonymous module.
+    define(['jquery'], plugin)
+  else
+    # Browser globals
+    plugin(jQuery)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sb-styleguide
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -239,9 +239,11 @@ files:
 - script/rails
 - spec/javascripts/fixtures/plugins/tbg-close_fixture.html.haml
 - spec/javascripts/fixtures/plugins/tbg-forms_fixture.html.haml
+- spec/javascripts/fixtures/plugins/tbg-ga-events_fixture.html.haml
 - spec/javascripts/fixtures/plugins/tbg-switch_fixture.html.haml
 - spec/javascripts/plugins/tbg-close_spec.js.coffee
 - spec/javascripts/plugins/tbg-forms_spec.js.coffee
+- spec/javascripts/plugins/tbg-ga-events_spec.js.coffee
 - spec/javascripts/plugins/tbg-switch_spec.js.coffee
 - spec/javascripts/spec.js.coffee
 - vendor/assets/fonts/ss-social-circle.eot
@@ -270,6 +272,7 @@ files:
 - vendor/assets/javascripts/styleguide/lib/ss-standard.js
 - vendor/assets/javascripts/styleguide/plugins/tbg-close.js.coffee
 - vendor/assets/javascripts/styleguide/plugins/tbg-forms.js.coffee
+- vendor/assets/javascripts/styleguide/plugins/tbg-ga-events.js.coffee
 - vendor/assets/javascripts/styleguide/plugins/tbg-respinsiveresize.js.coffee
 - vendor/assets/javascripts/styleguide/plugins/tbg-switch.js.coffee
 - vendor/assets/stylesheets/.gitkeep
@@ -328,9 +331,11 @@ summary: styleguide
 test_files:
 - spec/javascripts/fixtures/plugins/tbg-close_fixture.html.haml
 - spec/javascripts/fixtures/plugins/tbg-forms_fixture.html.haml
+- spec/javascripts/fixtures/plugins/tbg-ga-events_fixture.html.haml
 - spec/javascripts/fixtures/plugins/tbg-switch_fixture.html.haml
 - spec/javascripts/plugins/tbg-close_spec.js.coffee
 - spec/javascripts/plugins/tbg-forms_spec.js.coffee
+- spec/javascripts/plugins/tbg-ga-events_spec.js.coffee
 - spec/javascripts/plugins/tbg-switch_spec.js.coffee
 - spec/javascripts/spec.js.coffee
 has_rdoc: