ahoy_matey 1.4.1 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f3a81162866c03a621491abb0194ebe878a7f48
-  data.tar.gz: 050571dcc31a26851ee56da2b373503507d3547c
+  metadata.gz: 1aebb95363cb98c2b74dadb3b42f9cd04c17c421
+  data.tar.gz: 08785d2aa638fddb3881d4365e74ded3049cfec8
 SHA512:
-  metadata.gz: 7259821c2286af301fcc08ca16fa6b9ef284668740d5d4e7c136adc27c250521458da9a97a859c0ecf724ab2e469a78ff4670459333e08c594af658abb6b4707
-  data.tar.gz: 918d05e4515f41a79991324a93bb240965bb60d685279fcb53893228a87a6954c1dfd1ae4dbe162e5366d8d270fd5625546d2656795f4d51f0f839af0c6d8c85
+  metadata.gz: 16c58280be2b7a51a4f41c837204f701a93897b509330a0ff648d06819e2b944373fcaf5e0b595009270f5b332ec1ef81626537b824deafbd2f89cca5ece4376
+  data.tar.gz: 2aeb6f81dd3f0fdf09d0aee20ba52ed9349903636b9b392e87782ae135161520809aa45549dca292a479d5bae95ba893c4e6f95b29e13f6d32c601a39e204aae

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.4.2
+
+- Fixed issues with `where_properties`
+
 ## 1.4.1
 
 - Added `where_properties` method

data/Gemfile

@@ -2,3 +2,5 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in ahoy.gemspec
 gemspec
+
+gem "rails", "~> 5.0.0.rc1"

data/README.md

@@ -27,7 +27,7 @@ Ahoy supports a number of data stores out of the box.  You can start with one of
 
 - [PostgreSQL, MySQL, or SQLite](#postgresql-mysql-or-sqlite)
 - [MongoDB](#mongodb)
-- [Kafka](#kafka-master) [master]
+- [Kafka](#kafka)
 - [Fluentd](#fluentd)
 - [RabbitMQ](#rabbitmq)
 - [Amazon Kinesis Firehose](#amazon-kinesis-firehose)
@@ -49,7 +49,7 @@ rake db:migrate
 rails generate ahoy:stores:mongoid
 ```
 
-### Kafka [master]
+### Kafka
 
 Add [ruby-kafka](https://github.com/zendesk/ruby-kafka) to your Gemfile.
 
@@ -489,11 +489,13 @@ The same approach also works with visitor tokens.
 
 ### Querying Properties
 
+With ActiveRecord, use:
+
 ```ruby
-Ahoy::Event.where_properties(store_id: 1).count
+Ahoy::Event.where(name: "Viewed product").where_properties(product_id: 123).count
 ```
 
-**Note:** If you get a `NoMethodError`, upgrade Ahoy and add to your model `include Ahoy::Properties`.
+**Note:** If you get a `NoMethodError`, upgrade Ahoy and add `include Ahoy::Properties` to your model.
 
 ## Native Apps
 

data/ahoy_matey.gemspec

@@ -32,4 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest"
+  spec.add_development_dependency "activerecord"
+  spec.add_development_dependency "pg"
+  spec.add_development_dependency "mysql2"
 end

data/lib/ahoy.rb

@@ -1,3 +1,4 @@
+require "active_support"
 require "active_support/core_ext"
 require "addressable/uri"
 require "browser"
@@ -28,7 +29,7 @@ require "ahoy/stores/mongoid_store"
 require "ahoy/stores/kafka_store"
 require "ahoy/stores/kinesis_firehose_store"
 require "ahoy/stores/bunny_store"
-require "ahoy/engine"
+require "ahoy/engine" if defined?(Rails)
 require "ahoy/warden" if defined?(Warden)
 
 # background jobs
@@ -106,19 +107,21 @@ module Ahoy
   self.track_bots = false
 end
 
-ActionController::Base.send :include, Ahoy::Controller
-ActiveRecord::Base.send(:extend, Ahoy::Model) if defined?(ActiveRecord)
-
-# ensure logger silence will not be added by activerecord-session_store
-# otherwise, we get SystemStackError: stack level too deep
-begin
-  require "active_record/session_store/extension/logger_silencer"
-rescue LoadError
-  require "ahoy/logger_silencer"
-  Logger.send :include, Ahoy::LoggerSilencer
+if defined?(Rails)
+  ActionController::Base.send :include, Ahoy::Controller
+  ActiveRecord::Base.send(:extend, Ahoy::Model) if defined?(ActiveRecord)
 
+  # ensure logger silence will not be added by activerecord-session_store
+  # otherwise, we get SystemStackError: stack level too deep
   begin
-    require "syslog/logger"
-    Syslog::Logger.send :include, Ahoy::LoggerSilencer
-  rescue LoadError; end
+    require "active_record/session_store/extension/logger_silencer"
+  rescue LoadError
+    require "ahoy/logger_silencer"
+    Logger.send :include, Ahoy::LoggerSilencer
+
+    begin
+      require "syslog/logger"
+      Syslog::Logger.send :include, Ahoy::LoggerSilencer
+    rescue LoadError; end
+  end
 end

data/lib/ahoy/properties.rb

@@ -6,16 +6,50 @@ module Ahoy
       def where_properties(properties)
         relation = self
         column_type = columns_hash["properties"].type
-        case column_type
-        when :jsonb, :json
-          properties.each do |k, v|
-            relation = relation.where("properties ->> ? = ?", k, v)
+        adapter_name = connection.adapter_name.downcase
+        case adapter_name
+        when /mysql/
+          if column_type == :json
+            properties.each do |k, v|
+              if v.nil?
+                v = "null"
+              elsif v == true
+                v = "true"
+              end
+
+              relation = relation.where("JSON_UNQUOTE(properties -> ?) = ?", "$.#{k.to_s}", v.as_json)
+            end
+          else
+            properties.each do |k, v|
+              relation = relation.where("properties REGEXP ?", "[{,]#{{k.to_s => v}.to_json.sub(/\A\{/, "").sub(/\}\z/, "")}[,}]")
+            end
           end
-        else
-          properties.each do |k, v|
-            # not 100%, but will do
-            relation = relation.where("properties LIKE ?", "%#{{k => v}.to_json.sub(/\A\{/, "").sub(/\}\z/, "")}%")
+        when /postgres/
+          if column_type == :jsonb || 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|
+              relation = relation.where("properties SIMILAR TO ?", "%[{,]#{{k.to_s => v}.to_json.sub(/\A\{/, "").sub(/\}\z/, "")}[,}]%")
+            end
           end
+        else
+          raise "Adapter not supported: #{adapter_name}"
         end
         relation
       end

data/lib/ahoy/version.rb

@@ -1,3 +1,3 @@
 module Ahoy
-  VERSION = "1.4.1"
+  VERSION = "1.4.2"
 end

data/test/properties/mysql_json_test.rb

@@ -0,0 +1,18 @@
+require_relative "../test_helper"
+
+ActiveRecord::Base.establish_connection adapter: "mysql2", username: "root", database: "ahoy_test"
+
+ActiveRecord::Migration.create_table :mysql_json_events, force: true do |t|
+  t.json :properties
+end
+
+class MysqlJsonEvent < MysqlBase
+end
+
+class MysqlJsonTest < Minitest::Test
+  include PropertiesTest
+
+  def model
+    MysqlJsonEvent
+  end
+end

data/test/properties/mysql_text_test.rb

@@ -0,0 +1,19 @@
+require_relative "../test_helper"
+
+ActiveRecord::Base.establish_connection adapter: "mysql2", username: "root", database: "ahoy_test"
+
+ActiveRecord::Migration.create_table :mysql_text_events, force: true do |t|
+  t.text :properties
+end
+
+class MysqlTextEvent < MysqlBase
+  serialize :properties, JSON
+end
+
+class MysqlTextTest < Minitest::Test
+  include PropertiesTest
+
+  def model
+    MysqlTextEvent
+  end
+end

data/test/properties/postgresql_hstore_test.rb

@@ -0,0 +1,18 @@
+require_relative "../test_helper"
+
+ActiveRecord::Base.establish_connection adapter: "postgresql", database: "ahoy_test"
+
+ActiveRecord::Migration.create_table :postgresql_hstore_events, force: true do |t|
+  t.hstore :properties
+end
+
+class PostgresqlHstoreEvent < PostgresqlBase
+end
+
+class PostgresqlHstoreTest < Minitest::Test
+  include PropertiesTest
+
+  def model
+    PostgresqlHstoreEvent
+  end
+end

data/test/properties/postgresql_json_test.rb

@@ -0,0 +1,18 @@
+require_relative "../test_helper"
+
+ActiveRecord::Base.establish_connection adapter: "postgresql", database: "ahoy_test"
+
+ActiveRecord::Migration.create_table :postgresql_json_events, force: true do |t|
+  t.json :properties
+end
+
+class PostgresqlJsonEvent < PostgresqlBase
+end
+
+class PostgresqlJsonTest < Minitest::Test
+  include PropertiesTest
+
+  def model
+    PostgresqlJsonEvent
+  end
+end

data/test/properties/postgresql_jsonb_test.rb

@@ -0,0 +1,18 @@
+require_relative "../test_helper"
+
+ActiveRecord::Base.establish_connection adapter: "postgresql", database: "ahoy_test"
+
+ActiveRecord::Migration.create_table :postgresql_jsonb_events, force: true do |t|
+  t.jsonb :properties
+end
+
+class PostgresqlJsonbEvent < PostgresqlBase
+end
+
+class PostgresqlJsonbTest < Minitest::Test
+  include PropertiesTest
+
+  def model
+    PostgresqlJsonbEvent
+  end
+end

data/test/properties/postgresql_text_test.rb

@@ -0,0 +1,19 @@
+require_relative "../test_helper"
+
+ActiveRecord::Base.establish_connection adapter: "postgresql", database: "ahoy_test"
+
+ActiveRecord::Migration.create_table :postgresql_text_events, force: true do |t|
+  t.text :properties
+end
+
+class PostgresqlTextEvent < PostgresqlBase
+  serialize :properties, JSON
+end
+
+class PostgresqlTextTest < Minitest::Test
+  include PropertiesTest
+
+  def model
+    PostgresqlTextEvent
+  end
+end

data/test/test_helper.rb

@@ -2,3 +2,98 @@ require "bundler/setup"
 Bundler.require(:default)
 require "minitest/autorun"
 require "minitest/pride"
+require "active_record"
+
+ActiveRecord::Base.logger = ActiveSupport::Logger.new(STDOUT) if ENV["VERBOSE"]
+
+class PostgresqlBase < ActiveRecord::Base
+  include Ahoy::Properties
+  establish_connection adapter: "postgresql", database: "ahoy_test"
+  self.abstract_class = true
+end
+
+class MysqlBase < ActiveRecord::Base
+  include Ahoy::Properties
+  establish_connection adapter: "mysql2", username: "root", database: "ahoy_test"
+  self.abstract_class = true
+end
+
+module PropertiesTest
+  def setup
+    model.delete_all
+  end
+
+  def test_empty
+    assert_equal 0, count_events({})
+  end
+
+  def test_string
+    create_event value: "world"
+    assert_equal 1, count_events(value: "world")
+  end
+
+  def test_number
+    create_event value: 1
+    assert_equal 1, count_events(value: 1)
+  end
+
+  def test_date
+    today = Date.today
+    create_event value: today
+    assert_equal 1, count_events(value: today)
+  end
+
+  def test_time
+    now = Time.now
+    create_event value: now
+    assert_equal 1, count_events(value: now)
+  end
+
+  def test_true
+    create_event value: true
+    assert_equal 1, count_events(value: true)
+  end
+
+  def test_false
+    create_event value: false
+    assert_equal 1, count_events(value: false)
+  end
+
+  def test_nil
+    create_event value: nil
+    assert_equal 1, count_events(value: nil)
+  end
+
+  def test_any
+    create_event hello: "world", prop2: "hi"
+    assert_equal 1, count_events(hello: "world")
+  end
+
+  def test_multiple
+    create_event prop1: "hi", prop2: "bye"
+    assert_equal 1, count_events(prop1: "hi", prop2: "bye")
+  end
+
+  def test_multiple_order
+    create_event prop2: "bye", prop1: "hi"
+    assert_equal 1, count_events(prop1: "hi", prop2: "bye")
+  end
+
+  def test_partial
+    create_event hello: "world"
+    assert_equal 0, count_events(hello: "world", prop2: "hi")
+  end
+
+  def test_prefix
+    create_event value: 123
+    assert_equal 0, count_events(value: 1)
+  end
+
+  def create_event(properties)
+    model.create(properties: properties)
+  end
+
+  def count_events(properties)
+    model.where_properties(properties).count
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_matey
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.4.2
 platform: ruby
 authors:
 - Andrew Kane
@@ -192,6 +192,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  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: Simple, powerful visit tracking for Rails
 email:
 - andrew@chartkick.com
@@ -264,6 +306,12 @@ files:
 - lib/generators/ahoy/stores/templates/mongoid_event_model.rb
 - lib/generators/ahoy/stores/templates/mongoid_initializer.rb
 - lib/generators/ahoy/stores/templates/mongoid_visit_model.rb
+- test/properties/mysql_json_test.rb
+- test/properties/mysql_text_test.rb
+- test/properties/postgresql_hstore_test.rb
+- test/properties/postgresql_json_test.rb
+- test/properties/postgresql_jsonb_test.rb
+- test/properties/postgresql_text_test.rb
 - test/test_helper.rb
 - test/visit_properties_test.rb
 - vendor/assets/javascripts/ahoy.js
@@ -292,5 +340,11 @@ signing_key:
 specification_version: 4
 summary: Simple, powerful visit tracking for Rails
 test_files:
+- test/properties/mysql_json_test.rb
+- test/properties/mysql_text_test.rb
+- test/properties/postgresql_hstore_test.rb
+- test/properties/postgresql_json_test.rb
+- test/properties/postgresql_jsonb_test.rb
+- test/properties/postgresql_text_test.rb
 - test/test_helper.rb
 - test/visit_properties_test.rb