ahoy_matey 4.0.2 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06e00a470a12c20b510cc9f1476e39c2cfd8ec24115b29d5d09489d091465b74
-  data.tar.gz: e19501a6019c94bafc32121122e2832152adb0fe8475cb3b91ed4d50c791ff6e
+  metadata.gz: 021c0b07d7cddf6a22125683bb5b1d18a078f1ff1f504cca066d4069c6014357
+  data.tar.gz: d49b52ce94f4c7436df4d054324639f9e5cd951fe459a11ca28aaab36231bd19
 SHA512:
-  metadata.gz: b0fe7c188d2165aae96a6a5d2def6658bcf41158477d5d9aa79448b889f87c3b88ef3f6aee19309c56af3587110fff71bfcd60fae0a46562e87e1a22ae070073
-  data.tar.gz: 285deb63fb81a4cc423c3eab394e324d5ebe8572c5500750cefe88d615bbd869228d04a725f62cde2868730d7dbd345d3d3787bbaf0acb75f04aa2e231669a81
+  metadata.gz: 6082fea0363bb2f25b7309876a36a1982894d3dcc2dc905da2278ab0ca41257f1c322001c86deb36168dbd1649c87199ec65990c9e7307b407b3f96fdb7a2bac
+  data.tar.gz: d833375e6cdb800b51072ed3d3c269e55c21c06287cde4a351022c331b36dd4b9aa812afa7b33156ee7a7b745d08a53b0d726000a919fd616300c0f6149a51b4

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 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
+- Fixed asset precompilation error with `importmap-rails`
+
 ## 4.0.2 (2021-11-06)
 
 - Added experimental support for `importmap-rails`

data/LICENSE.txt

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

data/README.md

@@ -17,7 +17,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:
@@ -48,6 +48,18 @@ And restart your web server.
 
 ### JavaScript
 
+For Rails 7 / Importmap, add to `config/importmap.rb`:
+
+```ruby
+pin "ahoy", to: "ahoy.js"
+```
+
+And add to `app/javascript/application.js`:
+
+```javascript
+import "ahoy"
+```
+
 For Rails 6 / Webpacker, run:
 
 ```sh
@@ -66,18 +78,6 @@ For Rails 5 / Sprockets, add to `app/assets/javascripts/application.js`:
 //= require ahoy
 ```
 
-For Rails 7 / Importmap (experimental), add to `config/importmap.rb`:
-
-```ruby
-pin "ahoy", to: "ahoy.js"
-```
-
-And add to `app/javascript/application.js`:
-
-```javascript
-import "ahoy"
-```
-
 Track an event with:
 
 ```javascript
@@ -197,9 +197,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 +361,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 +381,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 +500,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 +786,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,6 +813,12 @@ bundle install
 bundle exec rake test
 ```
 
+To test Mongoid, use:
+
+```sh
+ADAPTER=mongoid bundle exec rake test
+```
+
 To test query methods, use:
 
 ```sh

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/engine.rb

@@ -28,8 +28,8 @@ module Ahoy
     end
 
     # for importmap
-    if defined?(Importmap)
-      initializer "ahoy.importmap", after: "importmap" do |app|
+    initializer "ahoy.importmap" do |app|
+      if defined?(Importmap)
         app.config.assets.precompile << "ahoy.js"
       end
     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.2"
+  VERSION = "4.1.0"
 end

data/lib/ahoy.rb

@@ -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/generators/ahoy/activerecord_generator.rb

@@ -1,3 +1,4 @@
+require "rails/generators"
 require "rails/generators/active_record"
 
 module Ahoy

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_matey
 version: !ruby/object:Gem::Version
-  version: 4.0.2
+  version: 4.1.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-06 00:00:00.000000000 Z
+date: 2022-06-12 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.2.22
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Simple, powerful, first-party analytics for Rails