Simple Analytics Rails

Simple Analytics is a privacy friendly analytics. No consent required from your visitors!

This gem adds the JavaScript Tracking Script to the <head> & <body> tag of your Ruby on Rails applications.

🚀 Installation

Add this line to your application's Gemfile:

gem 'simple_analytics_rails'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install simple_analytics_rails

✨ Usage

After the gem is installed, it will automatically append the Simple Analytics JavaScript snippet before the </head> tag on your HTML pages.

However you can also configure it via an initializer:

# config/initializers/simple_analytics.rb
SimpleAnalyticsRails.configure do |configuration|
  # ==> Overwrite domain name
  # https://docs.simpleanalytics.com/overwrite-domain-name
  #
  # Default is ""
  configuration.hostname = "example.com"

  # ==> Hash mode
  # https://docs.simpleanalytics.com/hash-mode
  #
  # Default is ""
  configuration.mode = "hash"

  # ==> Do not track
  # https://docs.simpleanalytics.com/dnt
  #
  # Default is false
  configuration.collect_dnt = false

  # ==> Ignore pages
  # https://docs.simpleanalytics.com/ignore-pages
  #
  # Default is ""
  configuration.ignore_pages = "/search/*,/account/*,/vouchers"

  # ==> Override variable used for JavaScript Events
  # https://docs.simpleanalytics.com/events#the-variable-sa_event-is-already-used
  #
  # Default is "sa_event"
  configuration.sa_global = "sa_event"

  # ==> Trigger custom page views
  # https://docs.simpleanalytics.com/trigger-custom-page-views#use-custom-collection-anyway
  #
  # Default is true
  configuration.auto_collect = true

  # ==> Onload Callback
  # https://docs.simpleanalytics.com/trigger-custom-page-views#use-custom-collection-anyway
  #
  # Default is ""
  configuration.onload_callback = "onloadCallback()"

  # ==> Custom Domain
  # https://docs.simpleanalytics.com/bypass-ad-blockers
  #
  # Default is ""
  configuration.custom_domain = "custom.domain.com"

  # ==> Inject JavaScript To Head
  # You can disable the automatic JavaScript injection if you'd like.
  #
  # Default is true
  configuration.enabled = Rails.env.production?
end

🙏 Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/simpleanalytics/rubyonrails-plugin .

Code of Conduct

Everyone interacting in the SimpleAnalyticsRails project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

Coding Standards

This project uses Standard for Ruby code to minimize bike shedding related to source formatting.

Please run bundle exec standardrb --fix prior to submitting pull requests.

📦 Releasing

Bump version number at lib/simple_analytics_rails/version.rb
Commit and push changes
Publish a new release on GitHub https://github.com/simpleanalytics/rubyonrails-plugin/releases/new
A GitHub Action will then publish the latest version to https://rubygems.org/

📝 License

The gem is available as open source under the terms of the MIT License.