ahoy_matey 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d90d64ae8641aa0bae1bc44acf29379a585ebbad0bbb87325380508d5a8ffcc7
-  data.tar.gz: 7c01ce8cbd2e92e3555479b251889d171b54be9d5c369fca51f413fdc912ab01
+  metadata.gz: c98a3beef3f7d137de52572c02e410709d603028021a25b5e325e47fd6b2fe8c
+  data.tar.gz: c9304029a1f3828baac05af4397083243113019e52add5da3439fac9c111f2ac
 SHA512:
-  metadata.gz: fe62cce407d17f736b616f11a742fefe338cdedd2457665cb3e578bafe0bd6fbb889dd315382dcb70d563a35dd5c5e05de908c069e12d21ab92e0cee637e42d7
-  data.tar.gz: f399c7708f6c1071c72db3d9164ab77bd3377fdc0eab7064707fb1202b240156be03669070763bf2f13bcf0bfcac134286eb9e9f9fb988d78267c71da9603386
+  metadata.gz: 2b4d2504fda7d21993196093617a55b31bf38b58b33a744b64db6f187f9e6da5b570858ecb67aeb550b76ce623742adebbb5369b2edd2f501166dd539682b14c
+  data.tar.gz: e8ecbc02ed485f8856f34527351b2c293fe77afb07d4b6011c050e246c50ed92d8262639109696feadd386145633778620d3159b023a0ca27d963a2ffb83aef3

data/CHANGELOG.md

@@ -1,11 +1,35 @@
-## 3.0.1
+## 3.1.0 (2020-12-04)
+
+- Added `instance` method
+- Added `request` argument to `user_method`
+- Updated Ahoy.js to 0.3.8
+- Removed `exclude_method` call when geocoding
+
+## 3.0.5 (2020-09-09)
+
+- Added `group_prop` method
+- Use `datetime` type in migration
+
+## 3.0.4 (2020-06-07)
+
+- Updated Ahoy.js to 0.3.6
+
+## 3.0.3 (2020-04-17)
+
+- Updated Ahoy.js to 0.3.5
+
+## 3.0.2 (2020-04-03)
+
+- Added `cookie_options`
+
+## 3.0.1 (2019-09-21)
 
 - Made `Ahoy::Tracker` work outside of requests
 - Fixed storage of `false` values with customized store
 - Fixed error with `user_method` and `Rails::InfoController`
 - Gracefully handle `ActionDispatch::RemoteIp::IpSpoofAttackError`
 
-## 3.0.0
+## 3.0.0 (2019-05-29)
 
 - Made Device Detector the default user agent parser
 - Made v2 the default bot detection version
@@ -13,18 +37,18 @@
 - Removed search keyword detection (most search engines today prevent this)
 - Removed support for Rails < 5
 
-## 2.2.1
+## 2.2.1 (2019-05-26)
 
 - Updated Ahoy.js to 0.3.4
 - Fixed v2 bot detection
 - Added latitude and longitude to installation
 
-## 2.2.0
+## 2.2.0 (2019-01-04)
 
 - Added `amp_event` helper
 - Improved bot detection for Device Detector
 
-## 2.1.0
+## 2.1.0 (2018-05-18)
 
 - Added option for IP masking
 - Added option to use anonymity sets instead of cookies
@@ -32,19 +56,19 @@
 - Fixed `visitable` for Rails 4.2
 - Removed `search_keyword` from new installs
 
-## 2.0.2
+## 2.0.2 (2018-03-14)
 
 - Fixed error on duplicate records
 - Fixed message when visit not found for geocoding
 - Better compatibility with GeoLite2
 - Better browser compatibility for Ahoy.js
 
-## 2.0.1
+## 2.0.1 (2018-02-26)
 
 - Added `Ahoy.server_side_visits = :when_needed` to automatically create visits server-side when needed for events and `visitable`
 - Better handling of visit duration and expiration in JavaScript
 
-## 2.0.0
+## 2.0.0 (2018-02-25)
 
 - Removed dependency on jQuery
 - Use `navigator.sendBeacon` by default in supported browsers
@@ -66,58 +90,58 @@ Breaking changes
 - Removed most built-in stores
 - Removed support for Rails < 4.2
 
-## 1.6.1
+## 1.6.1 (2018-02-02)
 
 - Added `gin` index on properties for events
 - Fixed `visitable` options when name not provided
 
-## 1.6.0
+## 1.6.0 (2017-05-01)
 
 - Added support for Rails 5.1
 
-## 1.5.5
+## 1.5.5 (2017-03-23)
 
 - Added support for Rails API
 - Added NATS and NSQ stores
 
-## 1.5.4
+## 1.5.4 (2017-01-22)
 
 - Fixed issue with duplicate events
 - Added support for PostGIS for `where_properties`
 
-## 1.5.3
+## 1.5.3 (2016-10-31)
 
 - Fixed error with Rails 5 and Mongoid 6
 - Fixed regression with server not generating visit and visitor tokens
 - Accept UTM parameters as request parameters (for native apps)
 
-## 1.5.2
+## 1.5.2 (2016-08-26)
 
 - Better support for Rails 5
 
-## 1.5.1
+## 1.5.1 (2016-08-19)
 
 - Restored throttling after removing side effects
 
-## 1.5.0
+## 1.5.0 (2016-08-19)
 
 - Removed throttling due to unintended side effects with its implementation
 - Ensure basic token requirements
 - Fixed visit recreation on cookie expiration
 - Fixed issue where `/ahoy/visits` is called indefinitely when `Ahoy.cookie_domain = :all`
 
-## 1.4.2
+## 1.4.2 (2016-06-21)
 
 - Fixed issues with `where_properties`
 
-## 1.4.1
+## 1.4.1 (2016-06-20)
 
 - Added `where_properties` method
 - Added Kafka store
 - Added `mount` option
 - Use less intrusive version of `safely`
 
-## 1.4.0
+## 1.4.0 (2016-03-23)
 
 - Use `ActiveRecordTokenStore` by default (integer instead of uuid for id)
 - Detect database for `rails g ahoy:stores:active_record` for easier installation
@@ -125,55 +149,55 @@ Breaking changes
 - Fixed issue with log silencer
 - Use multi-column indexes on `ahoy_events` table creation
 
-## 1.3.1
+## 1.3.1 (2016-03-22)
 
 - Raise errors in test environment
 
-## 1.3.0
+## 1.3.0 (2016-03-06)
 
 - Added throttling
 - Added `max_content_length` and `max_events_per_request`
 
-## 1.2.2
+## 1.2.2 (2016-03-05)
 
 - Fixed issue with latest version of `browser` gem
 - Added support for RabbitMQ
 - Added support for Amazon Kinesis Firehose
 - Fixed deprecation warnings in Rails 5
 
-## 1.2.1
+## 1.2.1 (2015-08-14)
 
 - Fixed `SystemStackError: stack level too deep` when used with `activerecord-session_store`
 
-## 1.2.0
+## 1.2.0 (2015-06-07)
 
 - Added support for PostgreSQL `jsonb` column type
 - Added Fluentd store
 - Added latitude, longitude, and postal_code to visits
 - Log exclusions
 
-## 1.1.1
+## 1.1.1 (2015-01-05)
 
 - Better support for Authlogic
 - Added `screen_height` and `screen_width`
 
-## 1.1.0
+## 1.1.0 (2014-11-02)
 
 - Added `geocode` option
 - Report errors to service by default
 - Fixed association mismatch
 
-## 1.0.2
+## 1.0.2 (2014-07-10)
 
 - Fixed BSON for Mongoid 3
 - Fixed Doorkeeper integration
 - Fixed user tracking in overridden authenticate method
 
-## 1.0.1
+## 1.0.1 (2014-06-27)
 
 - Fixed `visitable` outside of requests
 
-## 1.0.0
+## 1.0.0 (2014-06-18)
 
 - Added support for any data store, and Mongoid out of the box
 - Added `track_visits_immediately` option
@@ -181,17 +205,17 @@ Breaking changes
 - Visits expire after inactivity, not fixed interval
 - Added `visit_duration` and `visitor_duration` options
 
-## 0.3.2
+## 0.3.2 (2014-06-15)
 
 - Fixed bot exclusion for visits
 - Fixed user method
 
-## 0.3.1
+## 0.3.1 (2014-06-12)
 
 - Fixed visitor cookies when set on server
 - Added `domain` option for server cookies
 
-## 0.3.0
+## 0.3.0 (2014-06-11)
 
 - Added `current_visit_token` and `current_visitor_token` method
 - Switched to UUIDs
@@ -199,47 +223,47 @@ Breaking changes
 - Skip server-side bot events
 - Added `request` argument to `exclude_method`
 
-## 0.2.2
+## 0.2.2 (2014-05-26)
 
 - Added `exclude_method` option
 - Added support for batch events
 - Fixed cookie encoding
 - Fixed `options` variable from being modified
 
-## 0.2.1
+## 0.2.1 (2014-05-16)
 
 - Fixed IE 8 error
 - Added `track_bots` option
 - Added `$authenticate` event
 
-## 0.2.0
+## 0.2.0 (2014-05-13)
 
 - Added event tracking (merged ahoy_events)
 - Added ahoy.js
 
-## 0.1.8
+## 0.1.8 (2014-05-11)
 
 - Fixed bug with `user_type` set to `false` instead of `nil`
 
-## 0.1.7
+## 0.1.7 (2014-05-11)
 
 - Made cookie functions public for ahoy_events
 
-## 0.1.6
+## 0.1.6 (2014-05-07)
 
 - Better user agent parser
 
-## 0.1.5
+## 0.1.5 (2014-05-01)
 
 - Added support for Doorkeeper
 - Added options to `visitable`
 - Added `landing_params` method
 
-## 0.1.4
+## 0.1.4 (2014-04-27)
 
 - Added `ahoy.ready()` and `ahoy.log()` for events
 
-## 0.1.3
+## 0.1.3 (2014-04-24)
 
 - Supports `current_user` from `ApplicationController`
 - Added `ahoy.reset()`
@@ -247,16 +271,16 @@ Breaking changes
 - Added experimental support for native apps
 - Prefer `ahoy` over `Ahoy`
 
-## 0.1.2
+## 0.1.2 (2014-04-15)
 
 - Attach user on Devise sign up
 - Ability to specify visit model
 
-## 0.1.1
+## 0.1.1 (2014-03-20)
 
 - Made most database columns optional
 - Performance hack for referer-parser
 
-## 0.1.0
+## 0.1.0 (2014-03-19)
 
 - First major release

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2019 Andrew Kane
+Copyright (c) 2014-2020 Andrew Kane
 
 MIT License
 

data/README.md

@@ -1,14 +1,14 @@
 # Ahoy
 
-:fire: Simple, powerful analytics for Rails
+:fire: Simple, powerful, first-party analytics for Rails
 
 Track visits and events in Ruby, JavaScript, and native apps. Data is stored in your database by default so you can easily combine it with other data.
 
-:postbox: To track emails, check out [Ahoy Email](https://github.com/ankane/ahoy_email), and for A/B testing, check out [Field Test](https://github.com/ankane/field_test)
+:postbox: Check out [Ahoy Email](https://github.com/ankane/ahoy_email) for emails and [Field Test](https://github.com/ankane/field_test) for A/B testing
 
 :tangerine: Battle-tested at [Instacart](https://www.instacart.com/opensource)
 
-[![Build Status](https://travis-ci.org/ankane/ahoy.svg?branch=master)](https://travis-ci.org/ankane/ahoy)
+[![Build Status](https://github.com/ankane/ahoy/workflows/build/badge.svg?branch=master)](https://github.com/ankane/ahoy/actions)
 
 ## Installation
 
@@ -70,6 +70,10 @@ Track an event with:
 ahoy.track("My second event", {language: "JavaScript"});
 ```
 
+### Native Apps
+
+Check out [Ahoy iOS](https://github.com/namolnad/ahoy-ios) and [Ahoy Android](https://github.com/instacart/ahoy-android).
+
 ### GDPR Compliance
 
 Ahoy provides a number of options to help with GDPR compliance. See the [GDPR section](#gdpr-compliance-1) for more info.
@@ -145,7 +149,7 @@ See [Ahoy.js](https://github.com/ankane/ahoy.js) for a complete list of features
 
 #### Native Apps
 
-For Android, check out [Ahoy Android](https://github.com/instacart/ahoy-android). For other platforms, see the [API spec](#api-spec).
+See the docs for [Ahoy iOS](https://github.com/namolnad/ahoy-ios) and [Ahoy Android](https://github.com/instacart/ahoy-android).
 
 #### AMP
 
@@ -292,7 +296,7 @@ By default, a new visit is created after 4 hours of inactivity. Change this with
 Ahoy.visit_duration = 30.minutes
 ```
 
-### Multiple Subdomains
+### Cookies
 
 To track visits across multiple subdomains, use:
 
@@ -300,6 +304,12 @@ To track visits across multiple subdomains, use:
 Ahoy.cookie_domain = :all
 ```
 
+Set other [cookie options](https://api.rubyonrails.org/classes/ActionDispatch/Cookies.html) with:
+
+```ruby
+Ahoy.cookie_options = {same_site: :lax}
+```
+
 ### Geocoding
 
 Disable geocoding with:
@@ -308,7 +318,7 @@ Disable geocoding with:
 Ahoy.geocode = false
 ```
 
-Change the job queue with:
+The default job queue is `:ahoy`. Change this with:
 
 ```ruby
 Ahoy.job_queue = :low_priority
@@ -427,6 +437,34 @@ Ahoy.cookies = false
 
 Previously set cookies are automatically deleted.
 
+## Data Retention
+
+Data should only be retained for as long as it’s needed. Delete older data with:
+
+```ruby
+Ahoy::Visit.where("started_at < ?", 2.years.ago).find_in_batches do |visits|
+  visit_ids = visits.map(&:id)
+  Ahoy::Event.where(visit_id: visit_ids).delete_all
+  Ahoy::Visit.where(id: visit_ids).delete_all
+end
+```
+
+You can use [Rollup](https://github.com/ankane/rollup) to aggregate important data before you do.
+
+```ruby
+Ahoy::Visit.rollup("Visits", interval: "hour")
+```
+
+Delete data for a specific user with:
+
+```ruby
+user_id = 123
+visit_ids = Ahoy::Visit.where(user_id: user_id).pluck(:id)
+Ahoy::Event.where(visit_id: visit_ids).delete_all
+Ahoy::Visit.where(id: visit_ids).delete_all
+Ahoy::Event.where(user_id: user_id).delete_all
+```
+
 ## Development
 
 Ahoy is built with developers in mind. You can run the following code in your browser’s console.
@@ -552,7 +590,7 @@ Ahoy::Visit.group(:referring_domain).count
 
 ### Querying Events
 
-Ahoy provides two methods on the event model to make querying easier.
+Ahoy provides a few methods on the event model to make querying easier.
 
 To query on both name and properties, you can use:
 
@@ -563,9 +601,17 @@ Ahoy::Event.where_event("Viewed product", product_id: 123).count
 Or just query properties with:
 
 ```ruby
-Ahoy::Event.where_props(product_id: 123).count
+Ahoy::Event.where_props(product_id: 123, category: "Books").count
+```
+
+Group by properties with:
+
+```ruby
+Ahoy::Event.group_prop(:product_id, :category).count
 ```
 
+Note: MySQL and MariaDB always return string keys (include `"null"` for `nil`) for `group_prop`.
+
 ### Funnels
 
 It’s easy to create funnels.
@@ -578,6 +624,29 @@ viewed_checkout_ids = Ahoy::Event.where(user_id: added_item_ids, name: "Viewed c
 
 The same approach also works with visitor tokens.
 
+### Rollups
+
+Improve query performance by pre-aggregating data with [Rollup](https://github.com/ankane/rollup).
+
+```ruby
+Ahoy::Event.where(name: "Viewed store").rollup("Store views")
+```
+
+This is only needed if you have a lot of data.
+
+### Forecasting
+
+To forecast future visits and events, check out [Prophet](https://github.com/ankane/prophet).
+
+```ruby
+daily_visits = Ahoy::Visit.group_by_day(:started_at).count # uses Groupdate
+Prophet.forecast(daily_visits)
+```
+
+### Recommendations
+
+To make recommendations based on events, check out [Disco](https://github.com/ankane/disco#ahoy).
+
 ## Tutorials
 
 - [Tracking Metrics with Ahoy and Blazer](https://gorails.com/episodes/internal-metrics-with-ahoy-and-blazer)
@@ -694,3 +763,20 @@ Everyone is encouraged to help improve this project. Here are a few ways you can
 - Fix bugs and [submit pull requests](https://github.com/ankane/ahoy/pulls)
 - Write, clarify, or fix documentation
 - Suggest or add new features
+
+To get started with development:
+
+```sh
+git clone https://github.com/ankane/ahoy.git
+cd ahoy
+bundle install
+bundle exec rake test
+```
+
+To test query methods, start PostgreSQL, MySQL, and MongoDB and use:
+
+```sh
+createdb ahoy_test
+mysqladmin create ahoy_test
+bundle exec rake test:query_methods
+```

data/lib/ahoy.rb

@@ -30,8 +30,12 @@ module Ahoy
   mattr_accessor :cookies
   self.cookies = true
 
+  # TODO deprecate in favor of cookie_options
   mattr_accessor :cookie_domain
 
+  mattr_accessor :cookie_options
+  self.cookie_options = {}
+
   mattr_accessor :server_side_visits
   self.server_side_visits = true
 
@@ -100,6 +104,14 @@ module Ahoy
       addr.mask(48).to_s
     end
   end
+
+  def self.instance
+    Thread.current[:ahoy]
+  end
+
+  def self.instance=(value)
+    Thread.current[:ahoy] = value
+  end
 end
 
 ActiveSupport.on_load(:action_controller) do
@@ -115,6 +127,10 @@ ActiveSupport.on_load(:action_view) do
 end
 
 # Mongoid
+# TODO use
+# ActiveSupport.on_load(:mongoid) do
+#   Mongoid::Document::ClassMethods.include(Ahoy::Model)
+# end
 if defined?(ActiveModel)
   ActiveModel::Callbacks.include(Ahoy::Model)
 end

data/lib/ahoy/base_store.rb

@@ -24,7 +24,11 @@ module Ahoy
     def user
       @user ||= begin
         if Ahoy.user_method.respond_to?(:call)
-          Ahoy.user_method.call(controller)
+          if Ahoy.user_method.arity == 1
+            Ahoy.user_method.call(controller)
+          else
+            Ahoy.user_method.call(controller, request)
+          end
         else
           controller.send(Ahoy.user_method) if controller.respond_to?(Ahoy.user_method, true)
         end

data/lib/ahoy/controller.rb

@@ -39,12 +39,12 @@ module Ahoy
     end
 
     def set_ahoy_request_store
-      previous_value = Thread.current[:ahoy]
+      previous_value = Ahoy.instance
       begin
-        Thread.current[:ahoy] = ahoy
+        Ahoy.instance = ahoy
         yield
       ensure
-        Thread.current[:ahoy] = previous_value
+        Ahoy.instance = previous_value
       end
     end
   end

data/lib/ahoy/model.rb

@@ -7,7 +7,7 @@ module Ahoy
       end
       class_eval %{
         def set_ahoy_visit
-          self.#{name} ||= Thread.current[:ahoy].try(:visit_or_create)
+          self.#{name} ||= Ahoy.instance.try(:visit_or_create)
         end
       }
     end

data/lib/ahoy/query_methods.rb

@@ -31,6 +31,7 @@ module Ahoy
             end
           else
             properties.each do |k, v|
+              # TODO cast to json instead
               relation = relation.where("properties REGEXP ?", "[{,]#{{k.to_s => v}.to_json.sub(/\A\{/, "").sub(/\}\z/, "").gsub("+", "\\\\+")}[,}]")
             end
           end
@@ -57,6 +58,7 @@ module Ahoy
             end
           else
             properties.each do |k, v|
+              # TODO cast to jsonb instead
               relation = relation.where("properties SIMILAR TO ?", "%[{,]#{{k.to_s => v}.to_json.sub(/\A\{/, "").sub(/\}\z/, "").gsub("+", "\\\\+")}[,}]%")
             end
           end
@@ -66,6 +68,49 @@ module Ahoy
         relation
       end
       alias_method :where_properties, :where_props
+
+      def group_prop(*props)
+        # like with group
+        props.flatten!
+
+        relation = self
+        if respond_to?(:columns_hash)
+          column_type = columns_hash["properties"].type
+          adapter_name = connection.adapter_name.downcase
+        else
+          adapter_name = "mongoid"
+        end
+        case adapter_name
+        when "mongoid"
+          raise "Adapter not supported: #{adapter_name}"
+        when /mysql/
+          if connection.try(:mariadb?)
+            props.each do |prop|
+              quoted_prop = connection.quote("$.#{prop}")
+              relation = relation.group("JSON_UNQUOTE(JSON_EXTRACT(properties, #{quoted_prop}))")
+            end
+          else
+            column = column_type == :json ? "properties" : "CAST(properties AS JSON)"
+            props.each do |prop|
+              quoted_prop = connection.quote("$.#{prop}")
+              relation = relation.group("JSON_UNQUOTE(JSON_EXTRACT(#{column}, #{quoted_prop}))")
+            end
+          end
+        when /postgres|postgis/
+          # convert to jsonb to fix
+          # could not identify an equality operator for type json
+          # and for text columns
+          cast = [:jsonb, :hstore].include?(column_type) ? "" : "::jsonb"
+
+          props.each do |prop|
+            quoted_prop = connection.quote(prop)
+            relation = relation.group("properties#{cast} -> #{quoted_prop}")
+          end
+        else
+          raise "Adapter not supported: #{adapter_name}"
+        end
+        relation
+      end
     end
   end
 end

data/lib/ahoy/tracker.rb

@@ -67,16 +67,12 @@ module Ahoy
     end
 
     def geocode(data)
-      if exclude?
-        debug "Geocode excluded"
-      else
-        data = {
-          visit_token: visit_token
-          }.merge(data).select { |_, v| v }
+      data = {
+        visit_token: visit_token
+      }.merge(data).select { |_, v| v }
 
-        @store.geocode(data)
-        true
-      end
+      @store.geocode(data)
+      true
     rescue => e
       report_exception(e)
     end
@@ -171,12 +167,11 @@ module Ahoy
       # safety net
       return unless Ahoy.cookies && request
 
-      cookie = {
-        value: value
-      }
+      cookie = Ahoy.cookie_options.merge(value: value)
       cookie[:expires] = duration.from_now if duration
-      domain = Ahoy.cookie_domain
-      cookie[:domain] = domain if domain && use_domain
+      # prefer cookie_options[:domain] over cookie_domain
+      cookie[:domain] ||= Ahoy.cookie_domain if Ahoy.cookie_domain
+      cookie.delete(:domain) unless use_domain
       request.cookie_jar[name] = cookie
     end
 

data/lib/ahoy/version.rb

@@ -1,3 +1,3 @@
 module Ahoy
-  VERSION = "3.0.1"
+  VERSION = "3.1.0"
 end

data/lib/generators/ahoy/templates/active_record_migration.rb.tt

@@ -41,10 +41,10 @@ class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version
       t.string :os_version
       t.string :platform
 
-      t.timestamp :started_at
+      t.datetime :started_at
     end
 
-    add_index :ahoy_visits, [:visit_token], unique: true
+    add_index :ahoy_visits, :visit_token, unique: true
 
     create_table :ahoy_events do |t|
       t.references :visit
@@ -52,7 +52,7 @@ class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version
 
       t.string :name
       t.<%= properties_type %> :properties
-      t.timestamp :time
+      t.datetime :time
     end
 
     add_index :ahoy_events, [:name, :time]<% if properties_type == "jsonb" %><% if rails52? %>

data/vendor/assets/javascripts/ahoy.js

@@ -2,92 +2,83 @@
  * Ahoy.js
  * Simple, powerful JavaScript analytics
  * https://github.com/ankane/ahoy.js
- * v0.3.4
+ * v0.3.8
  * MIT License
  */
 
 (function (global, factory) {
   typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
   typeof define === 'function' && define.amd ? define(factory) :
-  (global.ahoy = factory());
+  (global = global || self, global.ahoy = factory());
 }(this, (function () { 'use strict';
 
-  function isUndefined(value) {
-    return value === undefined;
-  }
+  var isUndefined = function (value) { return value === undefined; };
 
-  function isNull(value) {
-    return value === null;
-  }
+  var isNull = function (value) { return value === null; };
 
-  function isObject(value) {
-    return value === Object(value);
-  }
+  var isBoolean = function (value) { return typeof value === 'boolean'; };
 
-  function isArray(value) {
-    return Array.isArray(value);
-  }
+  var isObject = function (value) { return value === Object(value); };
 
-  function isDate(value) {
-    return value instanceof Date;
-  }
+  var isArray = function (value) { return Array.isArray(value); };
 
-  function isBlob(value) {
-    return (
-      value &&
-      typeof value.size === 'number' &&
-      typeof value.type === 'string' &&
-      typeof value.slice === 'function'
-    );
-  }
+  var isDate = function (value) { return value instanceof Date; };
 
-  function isFile(value) {
-    return (
-      isBlob(value) &&
-      (typeof value.lastModifiedDate === 'object' ||
-        typeof value.lastModified === 'number') &&
-      typeof value.name === 'string'
-    );
-  }
+  var isBlob = function (value) { return value &&
+    typeof value.size === 'number' &&
+    typeof value.type === 'string' &&
+    typeof value.slice === 'function'; };
 
-  function isFormData(value) {
-    return value instanceof FormData;
-  }
-
-  function objectToFormData(obj, cfg, fd, pre) {
-    if (isFormData(cfg)) {
-      pre = fd;
-      fd = cfg;
-      cfg = null;
-    }
+  var isFile = function (value) { return isBlob(value) &&
+    typeof value.name === 'string' &&
+    (typeof value.lastModifiedDate === 'object' ||
+      typeof value.lastModified === 'number'); };
 
+  var serialize = function (obj, cfg, fd, pre) {
     cfg = cfg || {};
+
     cfg.indices = isUndefined(cfg.indices) ? false : cfg.indices;
-    cfg.nulls = isUndefined(cfg.nulls) ? true : cfg.nulls;
+
+    cfg.nullsAsUndefineds = isUndefined(cfg.nullsAsUndefineds)
+      ? false
+      : cfg.nullsAsUndefineds;
+
+    cfg.booleansAsIntegers = isUndefined(cfg.booleansAsIntegers)
+      ? false
+      : cfg.booleansAsIntegers;
+
+    cfg.allowEmptyArrays = isUndefined(cfg.allowEmptyArrays)
+      ? false
+      : cfg.allowEmptyArrays;
+
     fd = fd || new FormData();
 
     if (isUndefined(obj)) {
       return fd;
     } else if (isNull(obj)) {
-      if (cfg.nulls) {
+      if (!cfg.nullsAsUndefineds) {
         fd.append(pre, '');
       }
-    } else if (isArray(obj)) {
-      if (!obj.length) {
-        var key = pre + '[]';
-
-        fd.append(key, '');
+    } else if (isBoolean(obj)) {
+      if (cfg.booleansAsIntegers) {
+        fd.append(pre, obj ? 1 : 0);
       } else {
-        obj.forEach(function(value, index) {
+        fd.append(pre, obj);
+      }
+    } else if (isArray(obj)) {
+      if (obj.length) {
+        obj.forEach(function (value, index) {
           var key = pre + '[' + (cfg.indices ? index : '') + ']';
 
-          objectToFormData(value, cfg, fd, key);
+          serialize(value, cfg, fd, key);
         });
+      } else if (cfg.allowEmptyArrays) {
+        fd.append(pre + '[]', '');
       }
     } else if (isDate(obj)) {
       fd.append(pre, obj.toISOString());
     } else if (isObject(obj) && !isFile(obj) && !isBlob(obj)) {
-      Object.keys(obj).forEach(function(prop) {
+      Object.keys(obj).forEach(function (prop) {
         var value = obj[prop];
 
         if (isArray(value)) {
@@ -98,16 +89,19 @@
 
         var key = pre ? pre + '[' + prop + ']' : prop;
 
-        objectToFormData(value, cfg, fd, key);
+        serialize(value, cfg, fd, key);
       });
     } else {
       fd.append(pre, obj);
     }
 
     return fd;
-  }
+  };
 
-  var objectToFormdata = objectToFormData;
+  var index_module = {
+    serialize: serialize,
+  };
+  var index_module_1 = index_module.serialize;
 
   // https://www.quirksmode.org/js/cookies.html
 
@@ -155,7 +149,9 @@
     cookieDomain: null,
     headers: {},
     visitParams: {},
-    withCredentials: false
+    withCredentials: false,
+    visitDuration: 4 * 60, // default 4 hours
+    visitorDuration: 2 * 365 * 24 * 60 // default 2 years
   };
 
   var ahoy = window.ahoy || window.Ahoy || {};
@@ -173,8 +169,6 @@
 
   var $ = window.jQuery || window.Zepto || window.$;
   var visitId, visitorId, track;
-  var visitTtl = 4 * 60; // 4 hours
-  var visitorTtl = 2 * 365 * 24 * 60; // 2 years
   var isReady = false;
   var queue = [];
   var canStringify = typeof(JSON) !== "undefined" && typeof(JSON.stringify) !== "undefined";
@@ -224,13 +218,13 @@
     isReady = true;
   }
 
-  function ready(callback) {
+  ahoy.ready = function (callback) {
     if (isReady) {
       callback();
     } else {
       queue.push(callback);
     }
-  }
+  };
 
   function matchesSelector(element, selector) {
     var matches = element.matches ||
@@ -241,24 +235,34 @@
       element.webkitMatchesSelector;
 
     if (matches) {
-      return matches.apply(element, [selector]);
+      if (matches.apply(element, [selector])) {
+        return element;
+      } else if (element.parentElement) {
+        return matchesSelector(element.parentElement, selector)
+      }
+      return null;
     } else {
       log("Unable to match");
-      return false;
+      return null;
     }
   }
 
   function onEvent(eventName, selector, callback) {
     document.addEventListener(eventName, function (e) {
-      if (matchesSelector(e.target, selector)) {
-        callback(e);
+      var matchedElement = matchesSelector(e.target, selector);
+      if (matchedElement) {
+        callback.call(matchedElement, e);
       }
     });
   }
 
   // http://beeker.io/jquery-document-ready-equivalent-vanilla-javascript
   function documentReady(callback) {
-    document.readyState === "interactive" || document.readyState === "complete" ? callback() : document.addEventListener("DOMContentLoaded", callback);
+    if (document.readyState === "interactive" || document.readyState === "complete") {
+      setTimeout(callback, 0);
+    } else {
+      document.addEventListener("DOMContentLoaded", callback);
+    }
   }
 
   // https://stackoverflow.com/a/2117523/1177228
@@ -294,7 +298,7 @@
 
   function sendRequest(url, data, success) {
     if (canStringify) {
-      if ($) {
+      if ($ && $.ajax) {
         $.ajax({
           type: "POST",
           url: url,
@@ -343,7 +347,7 @@
   }
 
   function trackEvent(event) {
-    ready( function () {
+    ahoy.ready( function () {
       sendRequest(eventsUrl(), eventData(event), function() {
         // remove from queue
         for (var i = 0; i < eventQueue.length; i++) {
@@ -358,7 +362,7 @@
   }
 
   function trackEventNow(event) {
-    ready( function () {
+    ahoy.ready( function () {
       var data = eventData(event);
       var param = csrfParam();
       var token = csrfToken();
@@ -366,7 +370,7 @@
       // stringify so we keep the type
       data.events_json = JSON.stringify(data.events);
       delete data.events;
-      window.navigator.sendBeacon(eventsUrl(), objectToFormdata(data));
+      window.navigator.sendBeacon(eventsUrl(), index_module_1(data));
     });
   }
 
@@ -390,13 +394,12 @@
   }
 
   function eventProperties(e) {
-    var target = e.target;
     return cleanObject({
-      tag: target.tagName.toLowerCase(),
-      id: presence(target.id),
-      "class": presence(target.className),
+      tag: this.tagName.toLowerCase(),
+      id: presence(this.id),
+      "class": presence(this.className),
       page: page(),
-      section: getClosestSection(target)
+      section: getClosestSection(this)
     });
   }
 
@@ -427,7 +430,7 @@
     } else {
       if (!visitId) {
         visitId = generateId();
-        setCookie("ahoy_visit", visitId, visitTtl);
+        setCookie("ahoy_visit", visitId, config.visitDuration);
       }
 
       // make sure cookies are enabled
@@ -436,7 +439,7 @@
 
         if (!visitorId) {
           visitorId = generateId();
-          setCookie("ahoy_visitor", visitorId, visitorTtl);
+          setCookie("ahoy_visitor", visitorId, config.visitorDuration);
         }
 
         var data = {
@@ -509,12 +512,12 @@
       js: true
     };
 
-    ready( function () {
+    ahoy.ready( function () {
       if (config.cookies && !ahoy.getVisitId()) {
         createVisit();
       }
 
-      ready( function () {
+      ahoy.ready( function () {
         log(event);
 
         event.visit_token = ahoy.getVisitId();
@@ -556,24 +559,23 @@
 
   ahoy.trackClicks = function () {
     onEvent("click", "a, button, input[type=submit]", function (e) {
-      var target = e.target;
-      var properties = eventProperties(e);
-      properties.text = properties.tag == "input" ? target.value : (target.textContent || target.innerText || target.innerHTML).replace(/[\s\r\n]+/g, " ").trim();
-      properties.href = target.href;
+      var properties = eventProperties.call(this, e);
+      properties.text = properties.tag == "input" ? this.value : (this.textContent || this.innerText || this.innerHTML).replace(/[\s\r\n]+/g, " ").trim();
+      properties.href = this.href;
       ahoy.track("$click", properties);
     });
   };
 
   ahoy.trackSubmits = function () {
     onEvent("submit", "form", function (e) {
-      var properties = eventProperties(e);
+      var properties = eventProperties.call(this, e);
       ahoy.track("$submit", properties);
     });
   };
 
   ahoy.trackChanges = function () {
     onEvent("change", "input, textarea, select", function (e) {
-      var properties = eventProperties(e);
+      var properties = eventProperties.call(this, e);
       ahoy.track("$change", properties);
     });
   };

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_matey
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Andrew Kane
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-09-22 00:00:00.000000000 Z
+date: 2020-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -192,7 +192,35 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+- !ruby/object:Gem::Dependency
+  name: browser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: user_agent_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
 email: andrew@chartkick.com
 executables: []
 extensions: []
@@ -238,7 +266,7 @@ homepage: https://github.com/ankane/ahoy
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -253,8 +281,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
-summary: Simple, powerful analytics for Rails
+summary: Simple, powerful, first-party analytics for Rails
 test_files: []