analytics-rails 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd3ba70669af4c236ff581a4e5b9df6c61e99294
-  data.tar.gz: 1e43ef66ac86dc5f545e765d756e8a083b40e61a
+  metadata.gz: 080f8fc44db20a350e36c321e1a3356e78680e8d
+  data.tar.gz: 61190bd2756867548d6013d0c78cf9bc5bbd4e1a
 SHA512:
-  metadata.gz: 386df7ea2f9d7b2af60fc41450ddc4be24cd8b070fa62d1e9489a164ee837c702b09d1a4782b584b448ddc74937006d543d62941cb84cd0a05bfe1dcf8da5b3f
-  data.tar.gz: 5f4fe4012d83c6b4ab85f777754baf0b083b9749a37b0e8344242d856d3bf266bc5e903ed6d90e80c5b1497e44a65cc18cb54b44291c5eacca14c662215eb053
+  metadata.gz: 65e11c64e560b197ac9a1e10c3e0d73153fa3d81acc7b4ba7a927781823c2b82a45952aa0ee6c37db8b030b837d8e113f5663b4c2ddf4c41b4ec4477d0699d2a
+  data.tar.gz: 55b42cd6c6c5f58b80aca7cf6f941fbdae8c124f9616747724135f492e6bcee735c32c190a596bc07bbb65da938bee52bc9d35e1e4749f9d272463f24b94ddf6

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2015 Mathías Montossi
+Copyright 2016 Mathías Montossi
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -5,7 +5,13 @@
 
 # Analytics Rails
 
-Adds a simple helper to create the google analytics include tag.
+Adds a helper to create the google analytics script in rails.
+
+## Why
+
+I did this gem to:
+
+- Have a simple but versatile way to include google analytics.
 
 ## Install
 
@@ -21,22 +27,22 @@ $ bundle
 
 ## Usage
 
-In your layout add a line like this in your head:
+In your layout add a line like this in your head or before close body:
 ```erb
 <%= google_analytics_include_tag 'your-id' %>
 ```
 
-You can add custom events:
+You can add variables:
 ```erb
-<%= google_analytics_include_tag 'your-id', events: [['Popup', 'Click']] %>
+<%= google_analytics_include_tag 'your-id', user: 1 %>
 ```
 
-And custom variables:
+And custom events after the include tag:
 ```erb
-<%= google_analytics_include_tag 'your-id', variables: [[1, 'Member', 'Yes', 1]] %>
+<%= google_analytics_event_tag 'popup', 'click' %>
 ```
 
-NOTE: Will only show the include tag in production environment.
+NOTE: Will only show the tags in production environment.
 
 ## Credits
 

data/Rakefile

@@ -4,19 +4,6 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'AnalyticsRails'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-
-
-
 Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
@@ -26,7 +13,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'
   t.verbose = false
+  t.warning = false
 end
 
-
 task default: :test

data/lib/analytics/rails.rb

@@ -1,5 +1,6 @@
-require 'analytics/rails/action_view/base'
+require 'analytics/rails/extensions/action_view/base'
 require 'analytics/rails/railtie'
+require 'analytics/rails/version'
 
 module Analytics
   module Rails

data/lib/analytics/rails/extensions/action_view/base.rb

@@ -0,0 +1,38 @@
+module Analytics
+  module Rails
+    module Extensions
+      module ActionView
+        module Base
+
+          def google_analytics_include_tag(*args)
+            if ::Rails.env.production?
+              options = args.extract_options!
+              id = args.first
+              variables = options.to_json
+              content_tag :script, <<-SCRIPT.strip_heredoc.html_safe, type: 'text/javascript'
+                (function(i,s,o,g,r,a,m){i["GoogleAnalyticsObject"]=r;i[r]=i[r]||function(){
+                (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+                m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+                })(window,document,"script","https://www.google-analytics.com/analytics.js","ga");
+                ga("create", "#{id}", "auto");
+                ga("send", "pageview", #{variables});
+              SCRIPT
+            end
+          end
+
+          def google_analytics_event_tag(*args)
+            if ::Rails.env.production?
+              options = args.extract_options!
+              args = args.map(&:to_json).join(', ')
+              variables = options.to_json
+              content_tag :script, <<-SCRIPT.strip_heredoc.html_safe, type: 'text/javascript'
+                ga("send", "event", #{args}, #{variables});
+              SCRIPT
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/analytics/rails/railtie.rb

@@ -2,8 +2,10 @@ module Analytics
   module Rails
     class Railtie < ::Rails::Railtie
 
-      initializer 'analytics.rails' do
-        ::ActionView::Base.send :include, Analytics::Rails::ActionView::Base
+      initializer :analytics do
+        ::ActionView::Base.include(
+          Analytics::Rails::Extensions::ActionView::Base
+        )
       end
 
     end

data/lib/analytics/rails/version.rb

@@ -1,7 +1,7 @@
 module Analytics
   module Rails
 
-    VERSION = '0.2.1'
+    VERSION = '0.3.0'
 
   end
 end

data/test/dummy/Rakefile

@@ -2,5 +2,4 @@
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 
 require File.expand_path('../config/application', __FILE__)
-
-Dummy::Application.load_tasks
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -2,12 +2,12 @@
 // listed below.
 //
 // Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
-// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
 //
 // It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
 // compiled file.
 //
-// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
 // about supported directives.
 //
 //= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -3,11 +3,13 @@
  * listed below.
  *
  * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
  *
- * You're free to add application-wide styles to this file and they'll appear at the top of the
- * compiled file, but it's generally better to create a new file per style scope.
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
  *
- *= require_self
  *= require_tree .
+ *= require_self
  */

data/test/dummy/app/views/layouts/application.html.erb

@@ -1,15 +1,12 @@
 <!DOCTYPE html>
 <html>
-<head>
-  <title>Dummy</title>
-  <%= stylesheet_link_tag 'application', media: 'all' %>
-  <%= javascript_include_tag 'application' %>
-  <%= google_analytics_include_tag 'your-id' %>
-  <%= csrf_meta_tags %>
-</head>
-<body>
-
-<%= yield %>
-
-</body>
+  <head>
+    <title>Dummy</title>
+    <%= stylesheet_link_tag 'application', media: 'all', 'data-turbolinks-track' => true %>
+    <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+    <%= csrf_meta_tags %>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
 </html>

data/test/dummy/bin/bundle

@@ -1,3 +1,4 @@
 #!/usr/bin/env ruby
+
 ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
 load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
-APP_PATH = File.expand_path('../../config/application',  __FILE__)
+
+APP_PATH = File.expand_path('../../config/application', __FILE__)
 require_relative '../config/boot'
 require 'rails/commands'

data/test/dummy/bin/rake

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+
 require_relative '../config/boot'
 require 'rake'
 Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts '== Installing dependencies =='
+  system 'gem install bundler --conservative'
+  system 'bundle check || bundle install'
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   system 'cp config/database.yml.sample config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system 'bin/rake db:setup'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system 'rm -f log/*'
+  system 'rm -rf tmp/cache'
+
+  puts "\n== Restarting application server =="
+  system 'touch tmp/restart.txt'
+end

data/test/dummy/config.ru

@@ -1,4 +1,4 @@
 # This file is used by Rack-based servers to start the application.
 
-require ::File.expand_path('../config/environment',  __FILE__)
+require ::File.expand_path('../config/environment', __FILE__)
 run Rails.application

data/test/dummy/config/application.rb

@@ -1,6 +1,11 @@
 require File.expand_path('../boot', __FILE__)
 
-require 'rails/all'
+require 'active_model/railtie'
+require 'action_controller/railtie'
+require 'action_mailer/railtie'
+require 'action_view/railtie'
+require 'sprockets/railtie'
+require 'rails/test_unit/railtie'
 
 Bundler.require(*Rails.groups)
 require 'analytics-rails'
@@ -20,4 +25,3 @@ module Dummy
     # config.i18n.default_locale = :de
   end
 end
-

data/test/dummy/config/boot.rb

@@ -1,5 +1,5 @@
 # Set up gems listed in the Gemfile.
 ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
 
-require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
 $LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/environment.rb

@@ -2,4 +2,4 @@
 require File.expand_path('../application', __FILE__)
 
 # Initialize the Rails application.
-Dummy::Application.initialize!
+Rails.application.initialize!

data/test/dummy/config/environments/development.rb

@@ -1,4 +1,4 @@
-Dummy::Application.configure do
+Rails.application.configure do
   # Settings specified here will take precedence over those in config/application.rb.
 
   # In the development environment your application's code is reloaded on
@@ -10,7 +10,7 @@ Dummy::Application.configure do
   config.eager_load = false
 
   # Show full error reports and disable caching.
-  config.consider_all_requests_local       = true
+  config.consider_all_requests_local = true
   config.action_controller.perform_caching = false
 
   # Don't care if the mailer can't send.
@@ -19,11 +19,20 @@ Dummy::Application.configure do
   # Print deprecation notices to the Rails logger.
   config.active_support.deprecation = :log
 
-  # Raise an error on page load if there are pending migrations
-  config.active_record.migration_error = :page_load
-
   # Debug mode disables concatenation and preprocessing of assets.
   # This option may cause significant delays in view rendering with a large
   # number of complex assets.
   config.assets.debug = true
+
+  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+  # yet still be able to expire them through the digest params.
+  config.assets.digest = true
+
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  config.assets.raise_runtime_errors = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
 end

data/test/dummy/config/environments/production.rb

@@ -1,30 +1,28 @@
-Dummy::Application.configure do
+Rails.application.configure do
   # Settings specified here will take precedence over those in config/application.rb.
 
   # Code is not reloaded between requests.
   config.cache_classes = true
 
   # Eager load code on boot. This eager loads most of Rails and
-  # your application in memory, allowing both thread web servers
+  # your application in memory, allowing both threaded web servers
   # and those relying on copy on write to perform better.
   # Rake tasks automatically ignore this option for performance.
   config.eager_load = true
 
   # Full error reports are disabled and caching is turned on.
-  config.consider_all_requests_local       = false
+  config.consider_all_requests_local = false
   config.action_controller.perform_caching = true
 
   # Enable Rack::Cache to put a simple HTTP cache in front of your application
   # Add `rack-cache` to your Gemfile before enabling this.
-  # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
+  # For large-scale production use, consider using a caching reverse proxy like
+  # NGINX, varnish or squid.
   # config.action_dispatch.rack_cache = true
 
-  # Disable Rails's static asset server (Apache or nginx will already do this).
-  if Rails::VERSION::MAJOR == 4 && Rails::VERSION::MINOR >= 2
-    config.serve_static_files = false
-  else
-    config.serve_static_assets = false
-  end
+  # Disable serving static files from the `/public` folder by default since
+  # Apache or NGINX already handles this.
+  config.serve_static_files = ENV['RAILS_SERVE_STATIC_FILES'].present?
 
   # Compress JavaScripts and CSS.
   config.assets.js_compressor = :uglifier
@@ -33,21 +31,22 @@ Dummy::Application.configure do
   # Do not fallback to assets pipeline if a precompiled asset is missed.
   config.assets.compile = false
 
-  # Generate digests for assets URLs.
+  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+  # yet still be able to expire them through the digest params.
   config.assets.digest = true
 
-  # Version of your assets, change this if you want to expire all your assets.
-  config.assets.version = '1.0'
+  # `config.assets.precompile` and `config.assets.version` have moved to config/initializers/assets.rb
 
   # Specifies the header that your server uses for sending files.
-  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
-  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+  # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
 
   # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
   # config.force_ssl = true
 
-  # Set to :debug to see everything in the log.
-  config.log_level = :info
+  # Use the lowest log level to ensure availability of diagnostic information
+  # when problems arise.
+  config.log_level = :debug
 
   # Prepend all log lines with the following tags.
   # config.log_tags = [ :subdomain, :uuid ]
@@ -59,26 +58,19 @@ Dummy::Application.configure do
   # config.cache_store = :mem_cache_store
 
   # Enable serving of images, stylesheets, and JavaScripts from an asset server.
-  # config.action_controller.asset_host = "http://assets.example.com"
-
-  # Precompile additional assets.
-  # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
-  # config.assets.precompile += %w( search.js )
+  # config.action_controller.asset_host = 'http://assets.example.com'
 
   # Ignore bad email addresses and do not raise email delivery errors.
   # Set this to true and configure the email server for immediate delivery to raise delivery errors.
   # config.action_mailer.raise_delivery_errors = false
 
   # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
-  # the I18n.default_locale when a translation can not be found).
+  # the I18n.default_locale when a translation cannot be found).
   config.i18n.fallbacks = true
 
   # Send deprecation notices to registered listeners.
   config.active_support.deprecation = :notify
 
-  # Disable automatic flushing of the log to improve performance.
-  # config.autoflush_log = false
-
   # Use default logging formatter so that PID and timestamp are not suppressed.
   config.log_formatter = ::Logger::Formatter.new
 end