ahoy_matey 4.0.3 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8291f7d5566895e2973be22a9dd2e4f3cd43449d1289a5d176b38eed17c9a81d
-  data.tar.gz: a2551e19aefafbf339f77dea16b3544ce2d3f6084372523029c5ac2b86a13260
+  metadata.gz: e92b695b80a72d0e60e30f459c8b8e8a72df4d33652aafab25cd6798c3b39b60
+  data.tar.gz: e1654e31ba9add55b36290bd0e8da150abd5bd358662e11a34120bd074ef2ed3
 SHA512:
-  metadata.gz: c29a7d295c896e8191b213f877668910f6ca751d50750e1262ac41b2bedf971ec2342dc73dc9ac27d8f4e25306e83474162687bfbef8f44ea9887287adc89f57
-  data.tar.gz: 901f80e0995a39f63b6d4ae4f36c8a8c1b064f9820b7783d495775152c81d7310aa40efa2286398fbdf2e7108dd80bb9a6415acf44e62e5a414f71c1d0a5975c
+  metadata.gz: 34654baa122484f10b8cb0a169fafae0018aa06d31b341ac43c5d202ef7314f96bb17cb87247f04c47b87173d055d0a61a211792b4a6958266c00e2ed1135799
+  data.tar.gz: 35d424209a166bf189b87b4dc9c37a3106b522ae6ce9614debc8a8ce550a416de7bb78ab055b6e433ca46a0e207357ccd57078dd2ddbcece7ccf3dfe3d43e568

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 4.2.0 (2023-02-07)
+
+- Added primary key type to generated migration
+- Updated Ahoy.js to 0.4.1
+
+## 4.1.0 (2022-06-12)
+
+- Ensure `exclude_method` is only called once per request
+- Fixed error with Mongoid when `Mongoid.raise_not_found_error` is `true`
+- Fixed association for Mongoid
+
 ## 4.0.3 (2022-01-15)
 
 - Support for `importmap-rails` is no longer experimental

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2021 Andrew Kane
+Copyright (c) 2014-2023 Andrew Kane
 
 MIT License
 

data/README.md

@@ -4,8 +4,6 @@
 
 Track visits and events in Ruby, JavaScript, and native apps. Data is stored in your database by default, and you can customize it for any data store as you grow.
 
-**Ahoy 4.0 was recently released** - see [how to upgrade](#upgrading)
-
 :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)
@@ -17,7 +15,7 @@ Track visits and events in Ruby, JavaScript, and native apps. Data is stored in
 Add this line to your application’s Gemfile:
 
 ```ruby
-gem 'ahoy_matey'
+gem "ahoy_matey"
 ```
 
 And run:
@@ -197,9 +195,9 @@ Order.joins(:ahoy_visit).group("device_type").count
 Here’s what the migration to add the `ahoy_visit_id` column should look like:
 
 ```ruby
-class AddVisitIdToOrders < ActiveRecord::Migration[6.1]
+class AddAhoyVisitToOrders < ActiveRecord::Migration[7.0]
   def change
-    add_column :orders, :ahoy_visit_id, :bigint
+    add_reference :orders, :ahoy_visit
   end
 end
 ```
@@ -361,7 +359,7 @@ Ahoy uses [Geocoder](https://github.com/alexreisner/geocoder) for geocoding. We
 To enable geocoding, add this line to your application’s Gemfile:
 
 ```ruby
-gem 'geocoder'
+gem "geocoder"
 ```
 
 And update `config/initializers/ahoy.rb`:
@@ -381,7 +379,7 @@ Ahoy.job_queue = :low_priority
 For privacy and performance, we recommend geocoding locally. Add this line to your application’s Gemfile:
 
 ```ruby
-gem 'maxminddb'
+gem "maxminddb"
 ```
 
 For city-level geocoding, download the [GeoLite2 City database](https://dev.maxmind.com/geoip/geoip2/geolite2/) and create `config/initializers/geocoder.rb` with:
@@ -500,6 +498,8 @@ Previously set cookies are automatically deleted. If you use JavaScript tracking
 ahoy.configure({cookies: false});
 ```
 
+Note: With anonymity sets, visits no longer expire after 4 hours of inactivity. A new visit is only created when the IP mask or user agent changes (for instance, when a user updates their browser). There are plans to address this in the next major version.
+
 ## Data Retention
 
 Data should only be retained for as long as it’s needed. Delete older data with:
@@ -784,7 +784,7 @@ There are two notable changes to geocoding:
 2. The `geocoder` gem is now an optional dependency. To use geocoding, add it to your Gemfile:
 
   ```ruby
-  gem 'geocoder'
+  gem "geocoder"
   ```
 
 Also, check out the [upgrade notes](https://github.com/ankane/ahoy.js#upgrading) for Ahoy.js.
@@ -811,20 +811,10 @@ bundle install
 bundle exec rake test
 ```
 
-To test query methods, use:
+To test different adapters, use:
 
 ```sh
-# Postgres
-createdb ahoy_test
-bundle exec rake test:query_methods:postgresql
-
-# SQLite
-bundle exec rake test:query_methods:sqlite
-
-# MySQL and MariaDB
-mysqladmin create ahoy_test
-bundle exec rake test:query_methods:mysql
-
-# MongoDB
-bundle exec rake test:query_methods:mongoid
+ADAPTER=postgresql bundle exec rake test
+ADAPTER=mysql2 bundle exec rake test
+ADAPTER=mongoid bundle exec rake test
 ```

data/app/jobs/ahoy/geocode_job.rb

@@ -1,4 +1,5 @@
 # for smooth update from Ahoy 1 -> 2
+# TODO remove in 5.0
 module Ahoy
   class GeocodeJob < ActiveJob::Base
     queue_as { Ahoy.job_queue }

data/lib/ahoy/database_store.rb

@@ -53,7 +53,12 @@ module Ahoy
 
     def visit
       unless defined?(@visit)
-        @visit = visit_model.find_by(visit_token: ahoy.visit_token) if ahoy.visit_token
+        if defined?(Mongoid::Document) && visit_model < Mongoid::Document
+          # find_by raises error by default when not found
+          @visit = visit_model.where(visit_token: ahoy.visit_token).first if ahoy.visit_token
+        else
+          @visit = visit_model.find_by(visit_token: ahoy.visit_token) if ahoy.visit_token
+        end
       end
       @visit
     end

data/lib/ahoy/tracker.rb

@@ -185,7 +185,10 @@ module Ahoy
     end
 
     def exclude?
-      @store.exclude?
+      unless defined?(@exclude)
+        @exclude = @store.exclude?
+      end
+      @exclude
     end
 
     def report_exception(e)

data/lib/ahoy/version.rb

@@ -1,3 +1,3 @@
 module Ahoy
-  VERSION = "4.0.3"
+  VERSION = "4.2.0"
 end

data/lib/ahoy.rb

@@ -7,18 +7,18 @@ require "active_support/core_ext"
 require "safely/core"
 
 # modules
-require "ahoy/utils"
-require "ahoy/base_store"
-require "ahoy/controller"
-require "ahoy/database_store"
-require "ahoy/helper"
-require "ahoy/model"
-require "ahoy/query_methods"
-require "ahoy/tracker"
-require "ahoy/version"
-require "ahoy/visit_properties"
-
-require "ahoy/engine" if defined?(Rails)
+require_relative "ahoy/utils"
+require_relative "ahoy/base_store"
+require_relative "ahoy/controller"
+require_relative "ahoy/database_store"
+require_relative "ahoy/helper"
+require_relative "ahoy/model"
+require_relative "ahoy/query_methods"
+require_relative "ahoy/tracker"
+require_relative "ahoy/version"
+require_relative "ahoy/visit_properties"
+
+require_relative "ahoy/engine" if defined?(Rails)
 
 module Ahoy
   mattr_accessor :visit_duration
@@ -126,7 +126,6 @@ ActiveSupport.on_load(:action_view) do
   include Ahoy::Helper
 end
 
-# Mongoid
 ActiveSupport.on_load(:mongoid) do
   Mongoid::Document::ClassMethods.include(Ahoy::Model)
 end

data/lib/ahoy_matey.rb

@@ -1 +1 @@
-require "ahoy"
+require_relative "ahoy"

data/lib/generators/ahoy/activerecord_generator.rb

@@ -1,3 +1,4 @@
+require "rails/generators"
 require "rails/generators/active_record"
 
 module Ahoy
@@ -49,6 +50,18 @@ module Ahoy
       def migration_version
         "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
       end
+
+      def primary_key_type
+        ", id: :#{key_type}" if key_type
+      end
+
+      def foreign_key_type
+        ", type: :#{key_type}" if key_type
+      end
+
+      def key_type
+        Rails.configuration.generators.options.dig(:active_record, :primary_key_type)
+      end
     end
   end
 end

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

@@ -1,6 +1,6 @@
 class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
   def change
-    create_table :ahoy_visits do |t|
+    create_table :ahoy_visits<%= primary_key_type %> do |t|
       t.string :visit_token
       t.string :visitor_token
 
@@ -8,7 +8,7 @@ class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version
       # simply remove any you don't want
 
       # user
-      t.references :user
+      t.references :user<%= foreign_key_type %>
 
       # standard
       t.string :ip
@@ -46,9 +46,9 @@ class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version
 
     add_index :ahoy_visits, :visit_token, unique: true
 
-    create_table :ahoy_events do |t|
-      t.references :visit
-      t.references :user
+    create_table :ahoy_events<%= primary_key_type %> do |t|
+      t.references :visit<%= foreign_key_type %>
+      t.references :user<%= foreign_key_type %>
 
       t.string :name
       t.<%= properties_type %> :properties

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

@@ -2,7 +2,7 @@ class Ahoy::Event
   include Mongoid::Document
 
   # associations
-  belongs_to :visit, index: true
+  belongs_to :visit, class_name: "Ahoy::Visit", index: true
   belongs_to :user, index: true, optional: true
 
   # fields

data/vendor/assets/javascripts/ahoy.js

@@ -1,16 +1,15 @@
 /*!
- * Ahoy.js
+ * Ahoy.js v0.4.1
  * Simple, powerful JavaScript analytics
  * https://github.com/ankane/ahoy.js
- * v0.4.0
  * MIT License
  */
 
 (function (global, factory) {
   typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
   typeof define === 'function' && define.amd ? define(factory) :
-  (global = global || self, global.ahoy = factory());
-}(this, (function () { 'use strict';
+  (global = typeof globalThis !== 'undefined' ? globalThis : global || self, global.ahoy = factory());
+})(this, (function () { 'use strict';
 
   // https://www.quirksmode.org/js/cookies.html
 
@@ -67,7 +66,7 @@
 
   ahoy.configure = function (options) {
     for (var key in options) {
-      if (options.hasOwnProperty(key)) {
+      if (Object.prototype.hasOwnProperty.call(options, key)) {
         config[key] = options[key];
       }
     }
@@ -102,7 +101,7 @@
   function serialize(object) {
     var data = new FormData();
     for (var key in object) {
-      if (object.hasOwnProperty(key)) {
+      if (Object.prototype.hasOwnProperty.call(object, key)) {
         data.append(key, object[key]);
       }
     }
@@ -170,6 +169,9 @@
     document.addEventListener(eventName, function (e) {
       var matchedElement = matchesSelector(e.target, selector);
       if (matchedElement) {
+        var skip = getClosest(matchedElement, "data-ahoy-skip");
+        if (skip !== null && skip !== "false") { return; }
+
         callback.call(matchedElement, e);
       }
     });
@@ -186,8 +188,9 @@
 
   // https://stackoverflow.com/a/2117523/1177228
   function generateId() {
-    return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function(c) {
-      var r = Math.random()*16|0, v = c == 'x' ? r : (r&0x3|0x8);
+    return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
+      var r = Math.random() * 16 | 0;
+      var v = c === 'x' ? r : (r & 0x3 | 0x8);
       return v.toString(16);
     });
   }
@@ -237,11 +240,11 @@
         xhr.withCredentials = config.withCredentials;
         xhr.setRequestHeader("Content-Type", "application/json");
         for (var header in config.headers) {
-          if (config.headers.hasOwnProperty(header)) {
+          if (Object.prototype.hasOwnProperty.call(config.headers, header)) {
             xhr.setRequestHeader(header, config.headers[header]);
           }
         }
-        xhr.onload = function() {
+        xhr.onload = function () {
           if (xhr.status === 200) {
             success();
           }
@@ -266,11 +269,11 @@
   }
 
   function trackEvent(event) {
-    ahoy.ready( function () {
-      sendRequest(eventsUrl(), eventData(event), function() {
+    ahoy.ready(function () {
+      sendRequest(eventsUrl(), eventData(event), function () {
         // remove from queue
         for (var i = 0; i < eventQueue.length; i++) {
-          if (eventQueue[i].id == event.id) {
+          if (eventQueue[i].id === event.id) {
             eventQueue.splice(i, 1);
             break;
           }
@@ -281,7 +284,7 @@
   }
 
   function trackEventNow(event) {
-    ahoy.ready( function () {
+    ahoy.ready(function () {
       var data = eventData(event);
       var param = csrfParam();
       var token = csrfToken();
@@ -303,7 +306,7 @@
 
   function cleanObject(obj) {
     for (var key in obj) {
-      if (obj.hasOwnProperty(key)) {
+      if (Object.prototype.hasOwnProperty.call(obj, key)) {
         if (obj[key] === null) {
           delete obj[key];
         }
@@ -318,14 +321,14 @@
       id: presence(this.id),
       "class": presence(this.className),
       page: page(),
-      section: getClosestSection(this)
+      section: getClosest(this, "data-section")
     });
   }
 
-  function getClosestSection(element) {
-    for ( ; element && element !== document; element = element.parentNode) {
-      if (element.hasAttribute('data-section')) {
-        return element.getAttribute('data-section');
+  function getClosest(element, attribute) {
+    for (; element && element !== document; element = element.parentNode) {
+      if (element.hasAttribute(attribute)) {
+        return element.getAttribute(attribute);
       }
     }
 
@@ -377,7 +380,7 @@
         }
 
         for (var key in config.visitParams) {
-          if (config.visitParams.hasOwnProperty(key)) {
+          if (Object.prototype.hasOwnProperty.call(config.visitParam, key)) {
             data[key] = config.visitParams[key];
           }
         }
@@ -431,12 +434,12 @@
       js: true
     };
 
-    ahoy.ready( function () {
+    ahoy.ready(function () {
       if (config.cookies && !ahoy.getVisitId()) {
         createVisit();
       }
 
-      ahoy.ready( function () {
+      ahoy.ready(function () {
         log(event);
 
         event.visit_token = ahoy.getVisitId();
@@ -449,7 +452,7 @@
           saveEventQueue();
 
           // wait in case navigating to reduce duplicate events
-          setTimeout( function () {
+          setTimeout(function () {
             trackEvent(event);
           }, 1000);
         }
@@ -467,8 +470,8 @@
     };
 
     if (additionalProperties) {
-      for(var propName in additionalProperties) {
-        if (additionalProperties.hasOwnProperty(propName)) {
+      for (var propName in additionalProperties) {
+        if (Object.prototype.hasOwnProperty.call(additionalProperties, propName)) {
           properties[propName] = additionalProperties[propName];
         }
       }
@@ -482,7 +485,7 @@
     }
     onEvent("click", selector, function (e) {
       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.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);
     });
@@ -526,7 +529,7 @@
     ahoy.start = function () {};
   };
 
-  documentReady(function() {
+  documentReady(function () {
     if (config.startOnReady) {
       ahoy.start();
     }
@@ -534,4 +537,4 @@
 
   return ahoy;
 
-})));
+}));

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_matey
 version: !ruby/object:Gem::Version
-  version: 4.0.3
+  version: 4.2.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-15 00:00:00.000000000 Z
+date: 2023-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -113,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Simple, powerful, first-party analytics for Rails