split-analytics

Split extension to push test data to Google Analytics


License
MIT
Install
gem install split-analytics -v 1.1.0

Documentation

📊 An extension to Split to push test data to Google Analytics

Build Status Gem Version Dependency Status

Install

Requirements

The split gem and its dependencies.

Setup

If you are using bundler add split to your Gemfile:

gem 'split-analytics', require: 'split/analytics'

Then run:

bundle install

Otherwise install the gem:

gem install split-analytics

and require it in your project:

require 'split/analytics'

Usage

Use in your application layout template

erb example:

<%= tracking_code(account: 'UA-12345-6') %>

haml example:

= tracking_code(account: 'UA-12345-6')

With Tracking Methods

See Google Analytics Tracking Methods for available options.

tracker_methods = {
  setDomainName: "example.com", # String argument
  setAllowLinker: true, # Boolean argument
  require: ['inpage_linkid', '//www.google-analytics.com/plugins/ga/inpage_linkid.js'] # Array argument (will be splattered)
  clearOrganic: "" # No argument
}

erb example:

<%= tracking_code(account: 'UA-12345-6', tracker_methods: tracker_methods) %>

haml example:

= tracking_code(account: 'UA-12345-6', tracker_methods: tracker_methods)

Other Tracking URLs

You can use other Tracking URLs with the option tracker_url and ssl_tracker_url.

erb example:

<%= tracking_code(account: 'UA-12345-6', tracker_url: 'stats.g.doubleclick.net/dc.js', ssl_tracker_url: 'stats.g.doubleclick.net/dc.js') %>

haml example:

= tracking_code(account: 'UA-12345-6', tracker_url: 'stats.g.doubleclick.net/dc.js', ssl_tracker_url: 'stats.g.doubleclick.net/dc.js')

Contributing

Source hosted at GitHub. Report Issues/Feature requests on GitHub Issues.

Please follow the Code of Conduct.

Note on Patches/Pull Requests

  • Fork the project.
  • Make your feature addition or bug fix.
  • Add tests for it. This is important so I don't break it in a future version unintentionally.
  • Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
  • Send me a pull request. Bonus points for topic branches.

Testing

Tests can be ran with rake spec.

License

Copyright (c) 2015-2018 Andrew Nesbitt. See LICENSE for details.