snogmetrics 0.1.9 → 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3ef4ac9b437f568586dd8931fb452375dd6555d2
+  data.tar.gz: 91281360881e4dc56e41818fb818f5906d227642
+SHA512:
+  metadata.gz: 5fb7598115f385aac4cb2955605dda79f634975fc2545722ea767207d6cee0672483625f1ecc9d81a97d30abac901938a3436824f10003d52666a9ad9036645e
+  data.tar.gz: 83b23d805726d468b34c087050338d629bf9ba45b8d2cad0e5fe7a34f8dd5af32939da6a0e71d4e3718ff967cc3a243b61e0dbc734a9366718e938685246935a

data/.gitignore

@@ -22,3 +22,26 @@ tmtags
 /.yardoc
 
 ## PROJECT::SPECIFIC
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,203 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-06-29 16:33:13 -0400 using RuboCop version 0.49.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/EmptyLinesAroundAccessModifier:
+  Exclude:
+    - 'example/snoggy/config/boot.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines
+Layout/EmptyLinesAroundClassBody:
+  Exclude:
+    - 'example/snoggy/app/controllers/snogs_controller.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/EmptyLinesAroundExceptionHandlingKeywords:
+  Exclude:
+    - 'example/snoggy/config/boot.rb'
+
+# Offense count: 10
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment, ForceEqualSignAlignment.
+Layout/ExtraSpacing:
+  Exclude:
+    - 'example/snoggy/script/about'
+    - 'example/snoggy/script/console'
+    - 'example/snoggy/script/dbconsole'
+    - 'example/snoggy/script/destroy'
+    - 'example/snoggy/script/generate'
+    - 'example/snoggy/script/performance/benchmarker'
+    - 'example/snoggy/script/performance/profiler'
+    - 'example/snoggy/script/plugin'
+    - 'example/snoggy/script/runner'
+    - 'example/snoggy/script/server'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: normal, rails
+Layout/IndentationConsistency:
+  Exclude:
+    - 'example/snoggy/config/boot.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+Layout/LeadingCommentSpace:
+  Exclude:
+    - 'example/snoggy/config/environment.rb'
+    - 'example/snoggy/config/initializers/snogmetrics.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, EnforcedStyleForEmptyBraces, SupportedStylesForEmptyBraces.
+# SupportedStyles: space, no_space, compact
+# SupportedStylesForEmptyBraces: space, no_space
+Layout/SpaceInsideHashLiteralBraces:
+  Exclude:
+    - 'example/snoggy/config/environment.rb'
+    - 'example/snoggy/config/routes.rb'
+
+# Offense count: 5
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: final_newline, final_blank_line
+Layout/TrailingBlankLines:
+  Exclude:
+    - 'example/snoggy/app/controllers/snogs_controller.rb'
+    - 'example/snoggy/config/environment.rb'
+    - 'example/snoggy/config/environments/development.rb'
+    - 'example/snoggy/config/environments/test.rb'
+    - 'example/snoggy/config/initializers/snogmetrics.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Layout/TrailingWhitespace:
+  Exclude:
+    - 'example/snoggy/app/controllers/snogs_controller.rb'
+    - 'example/snoggy/config/environment.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowSafeAssignment.
+Lint/AssignmentInCondition:
+  Exclude:
+    - 'example/snoggy/config/boot.rb'
+
+# Offense count: 1
+Lint/UselessAssignment:
+  Exclude:
+    - 'example/snoggy/config/boot.rb'
+
+# Offense count: 3
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 176
+
+# Offense count: 45
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 294
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 22
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: percent_q, bare_percent
+Style/BarePercentLiterals:
+  Exclude:
+    - 'example/snoggy/config/boot.rb'
+
+# Offense count: 7
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'example/snoggy/app/controllers/snogs_controller.rb'
+    - 'example/snoggy/config/boot.rb'
+    - 'lib/snogmetrics/kissmetrics_api.rb'
+    - 'lib/snogmetrics/railtie.rb'
+
+# Offense count: 2
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Exclude:
+    - 'example/snoggy/config/boot.rb'
+    - 'lib/snogmetrics/kissmetrics_api.rb'
+
+# Offense count: 8
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
+# SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
+Style/HashSyntax:
+  Exclude:
+    - 'example/snoggy/app/controllers/snogs_controller.rb'
+    - 'example/snoggy/config/environment.rb'
+    - 'example/snoggy/config/routes.rb'
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: snake_case, camelCase
+Style/MethodName:
+  Exclude:
+    - 'lib/snogmetrics/kissmetrics_api.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/MutableConstant:
+  Exclude:
+    - 'example/snoggy/config/boot.rb'
+    - 'example/snoggy/config/environment.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: PreferredDelimiters.
+Style/PercentLiteralDelimiters:
+  Exclude:
+    - 'example/snoggy/config/routes.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/PerlBackrefs:
+  Exclude:
+    - 'example/snoggy/config/boot.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
+# SupportedStyles: slashes, percent_r, mixed
+Style/RegexpLiteral:
+  Exclude:
+    - 'snogmetrics.gemspec'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/RescueModifier:
+  Exclude:
+    - 'example/snoggy/config/boot.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: MinSize, SupportedStyles.
+# SupportedStyles: percent, brackets
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/UnneededPercentQ:
+  Exclude:
+    - 'example/snoggy/config/boot.rb'

data/Gemfile.lock

@@ -1,33 +1,133 @@
 PATH
   remote: .
   specs:
-    snogmetrics (0.1.4)
+    snogmetrics (0.1.9)
 
 GEM
   remote: http://rubygems.org/
   specs:
     BlueCloth (1.0.1)
-    actionmailer (2.3.5)
-      actionpack (= 2.3.5)
-    actionpack (2.3.5)
-      activesupport (= 2.3.5)
-      rack (~> 1.0.0)
-    activerecord (2.3.5)
-      activesupport (= 2.3.5)
-    activeresource (2.3.5)
-      activesupport (= 2.3.5)
-    activesupport (2.3.5)
-    rack (1.0.1)
-    rails (2.3.5)
-      actionmailer (= 2.3.5)
-      actionpack (= 2.3.5)
-      activerecord (= 2.3.5)
-      activeresource (= 2.3.5)
-      activesupport (= 2.3.5)
-      rake (>= 0.8.3)
+    actionmailer (4.2.8)
+      actionpack (= 4.2.8)
+      actionview (= 4.2.8)
+      activejob (= 4.2.8)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.8)
+      actionview (= 4.2.8)
+      activesupport (= 4.2.8)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.8)
+      activesupport (= 4.2.8)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (4.2.8)
+      activesupport (= 4.2.8)
+      globalid (>= 0.3.0)
+    activemodel (4.2.8)
+      activesupport (= 4.2.8)
+      builder (~> 3.1)
+    activerecord (4.2.8)
+      activemodel (= 4.2.8)
+      activesupport (= 4.2.8)
+      arel (~> 6.0)
+    activesupport (4.2.8)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.4)
+    ast (2.3.0)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    erubis (2.7.0)
+    globalid (0.4.0)
+      activesupport (>= 4.2.0)
+    i18n (0.8.4)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.5)
+      mime-types (>= 1.16, < 4)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.2.0)
+    minitest (5.10.2)
+    nokogiri (1.8.0)
+      mini_portile2 (~> 2.2.0)
+    parallel (1.11.2)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rack (1.6.8)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.8)
+      actionmailer (= 4.2.8)
+      actionpack (= 4.2.8)
+      actionview (= 4.2.8)
+      activejob (= 4.2.8)
+      activemodel (= 4.2.8)
+      activerecord (= 4.2.8)
+      activesupport (= 4.2.8)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.8)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.8)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (4.2.8)
+      actionpack (= 4.2.8)
+      activesupport (= 4.2.8)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rainbow (2.2.2)
+      rake
     rake (0.8.7)
-    rcov (0.9.8)
-    rspec (1.3.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    rubocop (0.49.1)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.0)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.3.0)
     yard (0.6.0)
 
 PLATFORMS
@@ -35,10 +135,13 @@ PLATFORMS
 
 DEPENDENCIES
   BlueCloth
-  bundler (~> 1.0.0)
-  rails
-  rake (~> 0.8.7)
-  rcov
+  bundler
+  rails (~> 4.2)
+  rake
   rspec
+  rubocop
   snogmetrics!
   yard
+
+BUNDLED WITH
+   1.14.6

data/README.mdown

@@ -12,11 +12,14 @@ It's true, but why settle for either or?
 
 SNOGmetrics works similarly to flash messages. Events are recorded and saved to the session, and are then sent when the next page is rendered. This way you get all of the benefits of the JavaScript API, but you can record events in your controllers. All you have to do is install this gem, configure it, and add a snipplet of code to your layout.
 
-## How do I use it?
+## Rails 3+ How do I use it?
 
-1. `gem install snogmetrics`
-2. Edit `config/environment.rb` and add `config.gem 'snogmetrics'`
-3. Edit your layout(s) and add `<%= km.js! %>` where you keep your JavaScript includes.
+1. Add `snogmetrics` in your gemfile and run the bundle command to install it
+2. Add an initializer file like the following under your config/initializers folder
+
+        Snogmetrics.kissmetrics_api_key = "your-api-key-here"
+
+3. Edit your layout(s) and add `<%= km.js! %>` in the body tag (this makes it work nicely with Turbolinks)
 4. Replace all your `KM.record(...)` and `KM.identify(...)` calls in JavaScript with calls to `km.record(...)` and `km.identify(...)`
 
 Have a look at the included example application to see it in action.
@@ -35,9 +38,11 @@ SNOGmetrics implements #set, which is equivalent to `_kmq.push(["set", ...])`, t
 
 ## Anything else I should know?
 
-Yes, SNOGmetrics will _not_ output the KISSmetrics API code unless `RAILS_ENV` is `production`. Instead it will output code that logs all calls to the console (if `console` is defined).
+Yes, SNOGmetrics will _not_ output the KISSmetrics API code unless `RAILS_ENV` is `production` by default. Instead it will output code that logs all calls to the console (if `console` is defined).
+
+If you'd like to change this behaviour, add the following to your initializer:
 
-In a future version this behaviour might be overrideable.
+        Snogmetrics.output_strategy = :live
 
 ## Note on Patches/Pull Requests
  

data/Rakefile

@@ -1,21 +1,14 @@
 require 'bundler'
 require 'yard'
 require 'spec/rake/spectask'
-
-
-task :default => :spec
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
+task default: [:spec, :rubocop]
 
 Bundler::GemHelper.install_tasks
 
 YARD::Rake::YardocTask.new
 
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
-end
+RSpec::Core::RakeTask.new(:spec)
 
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
+RuboCop::RakeTask.new(:rubocop)