ahoy_matey 4.0.1 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cea71919e25f8f3b9ce9f3ccea43f8d11ec29d1995b3c5078428a8d4a7948457
-  data.tar.gz: 81316ad1b9fc956bf0ece8c23c63570d5f333e0f7c781406e1b2214e965feebb
+  metadata.gz: 021c0b07d7cddf6a22125683bb5b1d18a078f1ff1f504cca066d4069c6014357
+  data.tar.gz: d49b52ce94f4c7436df4d054324639f9e5cd951fe459a11ca28aaab36231bd19
 SHA512:
-  metadata.gz: c52e5f32c8fd7f9d070867e8d53868a58365430ed6d7bfa3baa1dd826f042875d42fadddc7991bf5c1c0b836021dd1b2634e8c2e43fa88a055dff9b8aeae70e5
-  data.tar.gz: e3cdb04028a3277f678f65bf713d3a93339be369d4ed8af73a87bddd549b2ffd7983abd91443858e4411459442b8e292612381ea3ff731ce53d8f0b50f995857
+  metadata.gz: 6082fea0363bb2f25b7309876a36a1982894d3dcc2dc905da2278ab0ca41257f1c322001c86deb36168dbd1649c87199ec65990c9e7307b407b3f96fdb7a2bac
+  data.tar.gz: d833375e6cdb800b51072ed3d3c269e55c21c06287cde4a351022c331b36dd4b9aa812afa7b33156ee7a7b745d08a53b0d726000a919fd616300c0f6149a51b4

data/CHANGELOG.md

@@ -1,8 +1,23 @@
+## 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`
+
 ## 4.0.1 (2021-08-18)
 
 - Added support for `where_event`, `where_props`, and `where_group` for SQLite
-- Fixed results with `where_event`
-- Fixed results with `where_props` and `where_group` when used with other scopes
+- Fixed results with `where_event` for MySQL, MariaDB, and Postgres `hstore`
+- Fixed results with `where_props` and `where_group` when used with other scopes for MySQL, MariaDB, and Postgres `hstore`
 
 ## 4.0.0 (2021-08-14)
 

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
@@ -57,7 +69,7 @@ yarn add ahoy.js
 And add to `app/javascript/packs/application.js`:
 
 ```javascript
-import ahoy from "ahoy.js";
+import ahoy from "ahoy.js"
 ```
 
 For Rails 5 / Sprockets, add to `app/assets/javascripts/application.js`:
@@ -185,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
 ```
@@ -349,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`:
@@ -369,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:
@@ -488,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:
@@ -661,7 +675,7 @@ Group by properties with:
 Ahoy::Event.group_prop(:product_id, :category).count
 ```
 
-Note: MySQL and MariaDB always return string keys (include `"null"` for `nil`) for `group_prop`.
+Note: MySQL and MariaDB always return string keys (including `"null"` for `nil`) for `group_prop`.
 
 ### Funnels
 
@@ -694,6 +708,24 @@ daily_visits = Ahoy::Visit.group_by_day(:started_at).count # uses Groupdate
 Prophet.forecast(daily_visits)
 ```
 
+### Anomaly Detection
+
+To detect anomalies in visits and events, check out [AnomalyDetection.rb](https://github.com/ankane/AnomalyDetection.rb).
+
+```ruby
+daily_visits = Ahoy::Visit.group_by_day(:started_at).count # uses Groupdate
+AnomalyDetection.detect(daily_visits, period: 7)
+```
+
+### Breakout Detection
+
+To detect breakouts in visits and events, check out [Breakout](https://github.com/ankane/breakout).
+
+```ruby
+daily_visits = Ahoy::Visit.group_by_day(:started_at).count # uses Groupdate
+Breakout.detect(daily_visits)
+```
+
 ### Recommendations
 
 To make recommendations based on events, check out [Disco](https://github.com/ankane/disco#ahoy).
@@ -754,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.
@@ -781,10 +813,26 @@ bundle install
 bundle exec rake test
 ```
 
-To test query methods, start PostgreSQL, MySQL, and MongoDB and use:
+To test Mongoid, use:
 
 ```sh
+ADAPTER=mongoid bundle exec rake test
+```
+
+To test query methods, 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
+bundle exec rake test:query_methods:mysql
+
+# MongoDB
+bundle exec rake test:query_methods:mongoid
 ```

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

@@ -26,5 +26,12 @@ module Ahoy
         alias_method :call, :call_with_quiet_ahoy
       end
     end
+
+    # for importmap
+    initializer "ahoy.importmap" do |app|
+      if defined?(Importmap)
+        app.config.assets.precompile << "ahoy.js"
+      end
+    end
   end
 end

data/lib/ahoy/query_methods.rb

@@ -10,47 +10,38 @@ module Ahoy
       def where_props(properties)
         return all if properties.empty?
 
-        relation = all
-        if respond_to?(:columns_hash)
-          column_type = columns_hash["properties"].type
-          adapter_name = connection.adapter_name.downcase
-        else
-          adapter_name = "mongoid"
-        end
+        adapter_name = respond_to?(:connection) ? connection.adapter_name.downcase : "mongoid"
         case adapter_name
         when "mongoid"
-          relation = where(properties.to_h { |k, v| ["properties.#{k}", v] })
+          where(properties.to_h { |k, v| ["properties.#{k}", v] })
         when /mysql/
-          relation = relation.where("JSON_CONTAINS(properties, ?, '$') = 1", properties.to_json)
+          where("JSON_CONTAINS(properties, ?, '$') = 1", properties.to_json)
         when /postgres|postgis/
-          case column_type
-          when :jsonb
-            relation = relation.where("properties @> ?", properties.to_json)
+          case columns_hash["properties"].type
           when :hstore
-            properties.each do |k, v|
-              relation =
-                if v.nil?
-                  relation.where("properties -> ? IS NULL", k.to_s)
-                else
-                  relation.where("properties -> ? = ?", k.to_s, v.to_s)
-                end
+            properties.inject(all) do |relation, (k, v)|
+              if v.nil?
+                relation.where("properties -> ? IS NULL", k.to_s)
+              else
+                relation.where("properties -> ? = ?", k.to_s, v.to_s)
+              end
             end
+          when :jsonb
+            where("properties @> ?", properties.to_json)
           else
-            relation = relation.where("properties::jsonb @> ?", properties.to_json)
+            where("properties::jsonb @> ?", properties.to_json)
           end
         when /sqlite/
-          properties.each do |k, v|
-            relation =
-              if v.nil?
-                relation.where("JSON_EXTRACT(properties, ?) IS NULL", "$.#{k}")
-              else
-                relation.where("JSON_EXTRACT(properties, ?) = ?", "$.#{k}", v.as_json)
-              end
+          properties.inject(all) do |relation, (k, v)|
+            if v.nil?
+              relation.where("JSON_EXTRACT(properties, ?) IS NULL", "$.#{k}")
+            else
+              relation.where("JSON_EXTRACT(properties, ?) = ?", "$.#{k}", v.as_json)
+            end
           end
         else
           raise "Adapter not supported: #{adapter_name}"
         end
-        relation
       end
       alias_method :where_properties, :where_props
 
@@ -59,12 +50,7 @@ module Ahoy
         props.flatten!
 
         relation = all
-        if respond_to?(:columns_hash)
-          column_type = columns_hash["properties"].type
-          adapter_name = connection.adapter_name.downcase
-        else
-          adapter_name = "mongoid"
-        end
+        adapter_name = respond_to?(:connection) ? connection.adapter_name.downcase : "mongoid"
         case adapter_name
         when "mongoid"
           raise "Adapter not supported: #{adapter_name}"
@@ -77,6 +63,7 @@ module Ahoy
           # convert to jsonb to fix
           # could not identify an equality operator for type json
           # and for text columns
+          column_type = columns_hash["properties"].type
           cast = [:jsonb, :hstore].include?(column_type) ? "" : "::jsonb"
 
           props.each do |prop|

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.1"
+  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.1
+  version: 4.1.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-18 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