ahoy_matey 3.0.5 → 4.2.1

data/lib/ahoy/query_methods.rb

@@ -8,64 +8,40 @@ module Ahoy
       end
 
       def where_props(properties)
-        relation = self
-        if respond_to?(:columns_hash)
-          column_type = columns_hash["properties"].type
-          adapter_name = connection.adapter_name.downcase
-        else
-          adapter_name = "mongoid"
-        end
+        return all if properties.empty?
+
+        adapter_name = respond_to?(:connection) ? connection.adapter_name.downcase : "mongoid"
         case adapter_name
         when "mongoid"
-          relation = where(Hash[properties.map { |k, v| ["properties.#{k}", v] }])
+          where(properties.to_h { |k, v| ["properties.#{k}", v] })
         when /mysql/
-          if column_type == :json
-            properties.each do |k, v|
+          where("JSON_CONTAINS(properties, ?, '$') = 1", properties.to_json)
+        when /postgres|postgis/
+          case columns_hash["properties"].type
+          when :hstore
+            properties.inject(all) do |relation, (k, v)|
               if v.nil?
-                v = "null"
-              elsif v == true
-                v = "true"
+                relation.where("properties -> ? IS NULL", k.to_s)
+              else
+                relation.where("properties -> ? = ?", k.to_s, v.to_s)
               end
-
-              relation = relation.where("JSON_UNQUOTE(properties -> ?) = ?", "$.#{k}", v.as_json)
             end
+          when :jsonb
+            where("properties @> ?", properties.to_json)
           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
+            where("properties::jsonb @> ?", properties.to_json)
           end
-        when /postgres|postgis/
-          if column_type == :jsonb
-            relation = relation.where("properties @> ?", properties.to_json)
-          elsif column_type == :json
-            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.as_json.to_s)
-                end
-            end
-          elsif column_type == :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
-            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("+", "\\\\+")}[,}]%")
+        when /sqlite/
+          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
 
@@ -73,39 +49,32 @@ module Ahoy
         # 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
+        relation = all
+        adapter_name = respond_to?(:connection) ? connection.adapter_name.downcase : "mongoid"
         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
+          props.each do |prop|
+            quoted_prop = connection.quote("$.#{prop}")
+            relation = relation.group("JSON_UNQUOTE(JSON_EXTRACT(properties, #{quoted_prop}))")
           end
         when /postgres|postgis/
           # 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|
             quoted_prop = connection.quote(prop)
             relation = relation.group("properties#{cast} -> #{quoted_prop}")
           end
+        when /sqlite/
+          props.each do |prop|
+            quoted_prop = connection.quote("$.#{prop}")
+            relation = relation.group("JSON_EXTRACT(properties, #{quoted_prop})")
+          end
         else
           raise "Adapter not supported: #{adapter_name}"
         end

data/lib/ahoy/tracker.rb

@@ -19,8 +19,6 @@ module Ahoy
     def track(name, properties = {}, options = {})
       if exclude?
         debug "Event excluded"
-      elsif missing_params?
-        debug "Missing required parameters"
       else
         data = {
           visit_token: visit_token,
@@ -41,8 +39,6 @@ module Ahoy
     def track_visit(defer: false, started_at: nil)
       if exclude?
         debug "Visit excluded"
-      elsif missing_params?
-        debug "Missing required parameters"
       else
         if defer
           set_cookie("ahoy_track", true, nil, false)
@@ -67,16 +63,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
@@ -159,6 +151,7 @@ module Ahoy
       @options[:api]
     end
 
+    # private, but used by API
     def missing_params?
       if Ahoy.cookies && api? && Ahoy.protect_from_forgery
         !(existing_visit_token && existing_visitor_token)
@@ -192,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 = "3.0.5"
+  VERSION = "4.2.1"
 end

data/lib/ahoy.rb

@@ -1,24 +1,24 @@
+# stdlib
 require "ipaddr"
 
 # dependencies
 require "active_support"
 require "active_support/core_ext"
-require "geocoder"
 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
@@ -43,7 +43,7 @@ module Ahoy
   self.quiet = true
 
   mattr_accessor :geocode
-  self.geocode = true
+  self.geocode = false
 
   mattr_accessor :max_content_length
   self.max_content_length = 8192
@@ -104,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
@@ -118,11 +126,6 @@ ActiveSupport.on_load(:action_view) do
   include Ahoy::Helper
 end
 
-# Mongoid
-# TODO use
-# ActiveSupport.on_load(:mongoid) do
-#   Mongoid::Document::ClassMethods.include(Ahoy::Model)
-# end
-if defined?(ActiveModel)
-  ActiveModel::Callbacks.include(Ahoy::Model)
+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
@@ -17,9 +18,7 @@ module Ahoy
       end
 
       def properties_type
-        # use connection_config instead of connection.adapter
-        # so database connection isn't needed
-        case ActiveRecord::Base.connection_config[:adapter].to_s
+        case adapter
         when /postg/i # postgres, postgis
           "jsonb"
         when /mysql/i
@@ -29,13 +28,40 @@ module Ahoy
         end
       end
 
+      # requires database connection to check for MariaDB
+      def serialize_properties?
+        properties_type == "text" || (properties_type == "json" && ActiveRecord::Base.connection.try(:mariadb?))
+      end
+
+      # use connection_config instead of connection.adapter
+      # so database connection isn't needed
+      def adapter
+        if ActiveRecord::VERSION::STRING.to_f >= 6.1
+          ActiveRecord::Base.connection_db_config.adapter.to_s
+        else
+          ActiveRecord::Base.connection_config[:adapter].to_s
+        end
+      end
+
       def rails52?
-        ActiveRecord::VERSION::STRING >= "5.2"
+        ActiveRecord::VERSION::STRING.to_f >= 5.2
       end
 
       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_event_model.rb.tt

@@ -4,7 +4,7 @@ class Ahoy::Event < ApplicationRecord
   self.table_name = "ahoy_events"
 
   belongs_to :visit
-  belongs_to :user, optional: true<% if properties_type == "text" %>
+  belongs_to :user, optional: true<% if serialize_properties? %>
 
   serialize :properties, JSON<% 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/base_store_initializer.rb.tt

@@ -18,3 +18,8 @@ end
 
 # set to true for JavaScript tracking
 Ahoy.api = false
+
+# set to true for geocoding (and add the geocoder gem to your Gemfile)
+# we recommend configuring local geocoding as well
+# see https://github.com/ankane/ahoy#geocoding
+Ahoy.geocode = false

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

@@ -3,3 +3,8 @@ end
 
 # set to true for JavaScript tracking
 Ahoy.api = false
+
+# set to true for geocoding (and add the geocoder gem to your Gemfile)
+# we recommend configuring local geocoding as well
+# see https://github.com/ankane/ahoy#geocoding
+Ahoy.geocode = false

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