ahoy_matey 3.0.4 → 3.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 141aeb0d7f78023ecefb04f274637e06c68d6d8af9ece0ac583d8cff701b59f9
-  data.tar.gz: f44945bbdad4be224a57b4e915175ef983c4c24ed28eca4accc8e5fcce171105
+  metadata.gz: 17572400fdaab440040c753cf23084f2a47868e5c1ed12229e85fd1904e9c937
+  data.tar.gz: cc917af046906e308830fa1ffa9543db1bc1fe0f79488ccaddef090e6366433d
 SHA512:
-  metadata.gz: ee9f88551691cc6be92b5adf9bfd0495065e43510679a61377bc12082c44ac7b0cff544ca88b3157ec92d05432ff58e654b491c7e256eb2c6032b5517573e6e3
-  data.tar.gz: 45565919c04c0f7c05cf87d0ef0f35fedd867cbd7569ee72a613770efab6a0c7dac1d884d6d0830c4f28efcf475ece191e7d44cb3712b18454c30b0de1658a4d
+  metadata.gz: 325caa06934a20bf7a58f573fff7359b7058cf63e3e7576c48faf1bd5d08ac2564810a28e5a775c3ac324170754db4de35d46f43c0b421f8c4977760af19d153
+  data.tar.gz: e7af674522e09e3fb472b52546f30d10b743e2b2814efd97162d05cb1d4f9b13615dce211cd83e291da16e370a86cf7d8d384b16ad60d8af07c8ced8fbd17f59

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 3.0.5 (2020-09-09)
+
+- Added `group_prop` method
+- Use `datetime` type in migration
+
 ## 3.0.4 (2020-06-07)
 
 - Updated Ahoy.js to 0.3.6

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2019 Andrew Kane
+Copyright (c) 2014-2020 Andrew Kane
 
 MIT License
 

data/README.md

@@ -435,7 +435,7 @@ Previously set cookies are automatically deleted.
 
 ## Data Retention
 
-Delete older data with:
+Data should only be retained for as long as it’s needed. Delete older data with:
 
 ```ruby
 Ahoy::Visit.where("started_at < ?", 2.years.ago).find_in_batches do |visits|
@@ -445,6 +445,12 @@ Ahoy::Visit.where("started_at < ?", 2.years.ago).find_in_batches do |visits|
 end
 ```
 
+You can use [Rollup](https://github.com/ankane/rollup) to aggregate important data before you do.
+
+```ruby
+Ahoy::Visit.rollup("Visits", interval: "hour")
+```
+
 Delete data for a specific user with:
 
 ```ruby
@@ -580,7 +586,7 @@ Ahoy::Visit.group(:referring_domain).count
 
 ### Querying Events
 
-Ahoy provides two methods on the event model to make querying easier.
+Ahoy provides a few methods on the event model to make querying easier.
 
 To query on both name and properties, you can use:
 
@@ -591,9 +597,17 @@ Ahoy::Event.where_event("Viewed product", product_id: 123).count
 Or just query properties with:
 
 ```ruby
-Ahoy::Event.where_props(product_id: 123).count
+Ahoy::Event.where_props(product_id: 123, category: "Books").count
+```
+
+Group by properties with:
+
+```ruby
+Ahoy::Event.group_prop(:product_id, :category).count
 ```
 
+Note: MySQL and MariaDB always return string keys (include `"null"` for `nil`) for `group_prop`.
+
 ### Funnels
 
 It’s easy to create funnels.
@@ -606,6 +620,29 @@ viewed_checkout_ids = Ahoy::Event.where(user_id: added_item_ids, name: "Viewed c
 
 The same approach also works with visitor tokens.
 
+### Rollups
+
+Improve query performance by pre-aggregating data with [Rollup](https://github.com/ankane/rollup).
+
+```ruby
+Ahoy::Event.where(name: "Viewed store").rollup("Store views")
+```
+
+This is only needed if you have a lot of data.
+
+### Forecasting
+
+To forecast future visits and events, check out [Prophet](https://github.com/ankane/prophet).
+
+```ruby
+daily_visits = Ahoy::Visit.group_by_day(:started_at).count # uses Groupdate
+Prophet.forecast(daily_visits)
+```
+
+### Recommendations
+
+To make recommendations based on events, check out [Disco](https://github.com/ankane/disco#ahoy).
+
 ## Tutorials
 
 - [Tracking Metrics with Ahoy and Blazer](https://gorails.com/episodes/internal-metrics-with-ahoy-and-blazer)
@@ -722,3 +759,20 @@ Everyone is encouraged to help improve this project. Here are a few ways you can
 - Fix bugs and [submit pull requests](https://github.com/ankane/ahoy/pulls)
 - Write, clarify, or fix documentation
 - Suggest or add new features
+
+To get started with development:
+
+```sh
+git clone https://github.com/ankane/ahoy.git
+cd ahoy
+bundle install
+bundle exec rake test
+```
+
+To test query methods, start PostgreSQL, MySQL, and MongoDB and use:
+
+```sh
+createdb ahoy_test
+mysqladmin create ahoy_test
+bundle exec rake test:query_methods
+```

data/lib/ahoy.rb

@@ -119,6 +119,10 @@ ActiveSupport.on_load(:action_view) do
 end
 
 # Mongoid
+# TODO use
+# ActiveSupport.on_load(:mongoid) do
+#   Mongoid::Document::ClassMethods.include(Ahoy::Model)
+# end
 if defined?(ActiveModel)
   ActiveModel::Callbacks.include(Ahoy::Model)
 end

data/lib/ahoy/query_methods.rb

@@ -31,6 +31,7 @@ module Ahoy
             end
           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
           end
@@ -57,6 +58,7 @@ module Ahoy
             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("+", "\\\\+")}[,}]%")
             end
           end
@@ -66,6 +68,49 @@ module Ahoy
         relation
       end
       alias_method :where_properties, :where_props
+
+      def group_prop(*props)
+        # 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
+        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
+          end
+        when /postgres|postgis/
+          # convert to jsonb to fix
+          # could not identify an equality operator for type json
+          # and for text columns
+          cast = [:jsonb, :hstore].include?(column_type) ? "" : "::jsonb"
+
+          props.each do |prop|
+            quoted_prop = connection.quote(prop)
+            relation = relation.group("properties#{cast} -> #{quoted_prop}")
+          end
+        else
+          raise "Adapter not supported: #{adapter_name}"
+        end
+        relation
+      end
     end
   end
 end

data/lib/ahoy/version.rb

@@ -1,3 +1,3 @@
 module Ahoy
-  VERSION = "3.0.4"
+  VERSION = "3.0.5"
 end

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

@@ -41,10 +41,10 @@ class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version
       t.string :os_version
       t.string :platform
 
-      t.timestamp :started_at
+      t.datetime :started_at
     end
 
-    add_index :ahoy_visits, [:visit_token], unique: true
+    add_index :ahoy_visits, :visit_token, unique: true
 
     create_table :ahoy_events do |t|
       t.references :visit
@@ -52,7 +52,7 @@ class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version
 
       t.string :name
       t.<%= properties_type %> :properties
-      t.timestamp :time
+      t.datetime :time
     end
 
     add_index :ahoy_events, [:name, :time]<% if properties_type == "jsonb" %><% if rails52? %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_matey
 version: !ruby/object:Gem::Version
-  version: 3.0.4
+  version: 3.0.5
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-07 00:00:00.000000000 Z
+date: 2020-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -192,6 +192,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: browser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: user_agent_parser
+  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: 
 email: andrew@chartkick.com
 executables: []