searchjoy 0.5.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a837b7470769cd1d7589023ab3f1ffed51b683ea67016d3f642aa26b9edcab3e
-  data.tar.gz: 54239d751a05741b0b8fbfcedbc6d130af6a6153499ada75e282bfad7acec716
+  metadata.gz: d828271eb123a378fe3491da733c10c097f083dcdc9b6586fd3947c032f064b7
+  data.tar.gz: e907e0cd11b7c68e9431184add27fe79d3f35f573d221318e25e34a33a99847e
 SHA512:
-  metadata.gz: 8f35d980883ded923995f9340867b1685bcb710e66976ce8ce72e18033de94155c49ff1b53b8c4ba2fdb3d4c1f365bd0db8ee8dd0e70de39730e9f8f4124fb36
-  data.tar.gz: 191ee153cd9941773f2c388b38816513e1319ec7f29f5a6d59ad8d5182e310080d7260a9ebfecc7e4dda8801f61dbaab3576426912848787a713c60ef8c92782
+  metadata.gz: fdfc1fd30d7e31156d6891eee806933cead952c6bb0cca8eb1c9579b279b8629809ca08eaa7e01b8035b728ffc3f7c32a769822106c01422577a1c4830d1ab73
+  data.tar.gz: c04d0eb16545d44431e962d7bb1e2fb177bd717a53049f0924c565eccc7fe53966c58e8a1eb10cf7656813c6ca9d265825d010a1a1cad15365acdcd8d1c9f69a

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 1.1.0 (2023-02-07)
+
+- Improved dashboard labels
+- Improved CSP support
+- Dropped support for Ruby < 2.7 and Rails < 6
+
+## 1.0.0 (2022-05-10)
+
+- Added support for multiple conversions per search
+- Added experimental support for Propshaft
+- Dropped support for Ruby < 2.6 and Rails < 5.2
+
 ## 0.5.1 (2020-09-07)
 
 - Use `datetime` type in migration
@@ -57,3 +69,44 @@ Breaking
 ## 0.1.0 (2016-08-23)
 
 - Fixed Searchkick integration for `execute: false`
+
+## 0.0.10 (2016-04-20)
+
+- Fixed error when block passed to `search`
+
+## 0.0.9 (2016-03-12)
+
+- Fixed error with routes
+
+## 0.0.8 (2015-12-12)
+
+- Added `user_id` to searches
+
+## 0.0.7 (2014-08-18)
+
+- Fixed error with Searchkick 0.8
+
+## 0.0.6 (2013-12-19)
+
+- Fixed error with Rails 3
+
+## 0.0.5 (2013-11-01)
+
+- Renamed to Searchjoy
+
+## 0.0.4 (2013-10-31)
+
+- Renamed `converted` to `convert`
+
+## 0.0.3 (2013-10-31)
+
+- Added `conversion_name` option
+- Added `converted` method
+
+## 0.0.2 (2013-10-31)
+
+- Added dashboard
+
+## 0.0.1 (2013-10-24)
+
+- First release

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013-2020 Andrew Kane
+Copyright (c) 2013-2023 Andrew Kane
 
 MIT License
 

data/README.md

@@ -4,17 +4,17 @@ Search analytics made easy
 
 [See it in action](https://searchjoy.dokkuapp.com/)
 
-[![Screenshot](https://searchjoy.dokkuapp.com/assets/searchjoy-a9d4c01356a822bc1dba1eecf7ac76387de009fc9902eb9a880057069212be80.png)](https://searchjoy.dokkuapp.com/)
+[![Screenshot](https://searchjoy.dokkuapp.com/assets/searchjoy-7be12d922ca8b31b7d7440e618b0c666698a4b15752653a0c5c45e3dd2737142.png)](https://searchjoy.dokkuapp.com/)
 
 - view searches in real-time
-- track conversions week over week
+- track conversion rate week over week
 - monitor the performance of top searches
 
-Works with any search platform, including Elasticsearch, Sphinx, and Solr
+Works with any search platform, including Elasticsearch, OpenSearch, Sphinx, and Solr
 
 :cupid: An amazing companion to [Searchkick](https://github.com/ankane/searchkick)
 
-[![Build Status](https://travis-ci.org/ankane/searchjoy.svg?branch=master)](https://travis-ci.org/ankane/searchjoy)
+[![Build Status](https://github.com/ankane/searchjoy/workflows/build/badge.svg?branch=master)](https://github.com/ankane/searchjoy/actions)
 
 ## Installation
 
@@ -70,8 +70,6 @@ Then, pass the values to the `track` option.
 Item.search("apple", track: {user_id: 1, source: "web"})
 ```
 
-It’s that easy.
-
 ## Track Conversions
 
 First, choose a conversion metric. At Instacart, an item added to the cart from the search results page counts as a conversion.
@@ -121,16 +119,29 @@ ENV["SEARCHJOY_PASSWORD"] = "secret"
 
 ## Data Retention
 
-Delete older data with:
+Data should only be retained for as long as it’s needed. Delete older data with:
+
+```ruby
+Searchjoy::Search.where("created_at < ?", 1.year.ago).find_in_batches do |searches|
+  search_ids = searches.map(&:id)
+  Searchjoy::Conversion.where(search_id: search_ids).delete_all
+  Searchjoy::Search.where(id: search_ids).delete_all
+end
+```
+
+You can use [Rollup](https://github.com/ankane/rollup) to aggregate important data before you do.
 
 ```ruby
-Searchjoy::Search.where("created_at < ?", 1.year.ago).in_batches.delete_all
+Searchjoy::Search.rollup("Searches")
 ```
 
 Delete data for a specific user with:
 
 ```ruby
-Searchjoy::Search.where(user_id: 1).delete_all
+user_id = 123
+search_ids = Searchjoy::Search.where(user_id: user_id).pluck(:id)
+Searchjoy::Conversion.where(search_id: search_ids).delete_all
+Searchjoy::Search.where(id: search_ids).delete_all
 ```
 
 ## Customize
@@ -167,6 +178,46 @@ Show the conversion name in the live stream
 Searchjoy.conversion_name = ->(model) { model.name }
 ```
 
+## Upgrading
+
+### 1.0
+
+Searchjoy now supports multiple conversions per search :tada:
+
+Before updating the gem, create a migration with:
+
+```ruby
+create_table :searchjoy_conversions do |t|
+  t.references :search
+  t.references :convertable, polymorphic: true, index: {name: "index_searchjoy_conversions_on_convertable"}
+  t.datetime :created_at
+end
+```
+
+Deploy and run the migration, then update the gem.
+
+You can optionally backfill the conversions table
+
+```ruby
+Searchjoy.backfill_conversions
+```
+
+And optionally remove `convertable` from searches
+
+```ruby
+remove_reference :searchjoy_searches, :convertable, polymorphic: true
+```
+
+You can stay with single conversions (and skip all the previous steps) by creating an initializer with:
+
+```ruby
+Searchjoy.multiple_conversions = false
+```
+
+## History
+
+View the [changelog](https://github.com/ankane/searchjoy/blob/master/CHANGELOG.md)
+
 ## Contributing
 
 Everyone is encouraged to help improve this project. Here are a few ways you can help:

data/app/controllers/searchjoy/searches_controller.rb

@@ -23,23 +23,23 @@ module Searchjoy
       duration = @time_range.last - @time_range.first
       period =
         if duration < 3.days # shows 48-72 data points (ends at current time)
-          "hour"
+          :hour
         elsif duration < 60.days
-          "day"
+          :day
         elsif duration < 60.weeks # to make it easy to compare to same time last year
-          "week"
+          :week
         else
-          "month"
+          :month
         end
 
       relation = Searchjoy::Search.where(search_type: params[:search_type])
       @searches_by_week = relation.group_by_period(period, :created_at, time_zone: @time_zone, range: @time_range).count
-      @conversions_by_week = relation.where("converted_at is not null").group_by_period(period, :created_at, time_zone: @time_zone, range: @time_range).count
+      @converted_by_week = relation.where.not(converted_at: nil).group_by_period(period, :created_at, time_zone: @time_zone, range: @time_range).count
       @top_searches = @searches.first(5)
       @bad_conversion_rate = @searches.sort_by { |s| [s["conversion_rate"].to_f, s["query"]] }.first(5).select { |s| s["conversion_rate"] < 50 }
       @conversion_rate_by_week = {}
       @searches_by_week.each do |week, searches_count|
-        @conversion_rate_by_week[week] = searches_count > 0 ? (100.0 * @conversions_by_week[week] / searches_count).round : 0
+        @conversion_rate_by_week[week] = searches_count > 0 ? (100.0 * @converted_by_week[week] / searches_count).round : 0
       end
     end
 
@@ -47,7 +47,12 @@ module Searchjoy
     end
 
     def recent
-      @searches = Searchjoy::Search.includes(:convertable).order("created_at desc").limit(50)
+      @searches = Searchjoy::Search.order(created_at: :desc).limit(50)
+      if Searchjoy.multiple_conversions
+        @searches.includes!(conversions: :convertable)
+      else
+        @searches.includes!(:convertable)
+      end
       render layout: false
     end
 
@@ -81,9 +86,16 @@ module Searchjoy
 
     def set_searches
       @limit = params[:limit] || Searchjoy.top_searches
-      @searches = Searchjoy::Search.connection.select_all(Searchjoy::Search.select("normalized_query, COUNT(*) as searches_count, COUNT(converted_at) as conversions_count, AVG(results_count) as avg_results_count").where(created_at: @time_range, search_type: @search_type).group("normalized_query").order("searches_count desc, normalized_query asc").limit(@limit).to_sql).to_a
+      relation = Searchjoy::Search
+        .select("normalized_query, COUNT(*) as searches_count, COUNT(converted_at) as converted_count, AVG(results_count) as avg_results_count")
+        .where(created_at: @time_range, search_type: @search_type)
+        .group(:normalized_query)
+        .order(searches_count: :desc, normalized_query: :asc)
+        .limit(@limit)
+      # get array of hashes for performance
+      @searches = Searchjoy::Search.connection.select_all(relation.to_sql).to_a
       @searches.each do |search|
-        search["conversion_rate"] = 100 * search["conversions_count"].to_i / search["searches_count"].to_f
+        search["conversion_rate"] = 100 * search["converted_count"].to_i / search["searches_count"].to_f
       end
     end
   end

data/app/models/searchjoy/conversion.rb

@@ -0,0 +1,8 @@
+module Searchjoy
+  class Conversion < ActiveRecord::Base
+    self.table_name = "searchjoy_conversions"
+
+    belongs_to :search
+    belongs_to :convertable, polymorphic: true, optional: true
+  end
+end

data/app/models/searchjoy/search.rb

@@ -4,14 +4,34 @@ module Searchjoy
 
     belongs_to :convertable, polymorphic: true, optional: true
     belongs_to :user, optional: true
+    has_many :conversions
 
     before_save :set_normalized_query
 
     def convert(convertable = nil)
-      unless converted?
-        self.converted_at = Time.now
-        self.convertable = convertable
-        save(validate: false)
+      return unless Searchjoy.multiple_conversions || !converted?
+
+      # use transaction to keep consistent
+      self.class.transaction do
+        # make time consistent
+        now = Time.now
+
+        if Searchjoy.multiple_conversions
+          conversion =
+            conversions.create!(
+              convertable: convertable,
+              created_at: now
+            )
+        end
+
+        unless converted?
+          self.converted_at = now
+          # check id instead of association
+          self.convertable = convertable if respond_to?(:convertable_id=)
+          save(validate: false)
+        end
+
+        conversion
       end
     end
 

data/app/views/layouts/searchjoy/application.html.erb

@@ -4,6 +4,7 @@
     <title>Searchjoy</title>
 
     <meta charset="utf-8" />
+    <%= csp_meta_tag %>
 
     <style>
       body {
@@ -288,7 +289,11 @@
       }
     </style>
 
-    <%= javascript_include_tag "searchjoy/application" %>
+    <% if defined?(Propshaft::Railtie) %>
+      <%= javascript_include_tag "chartkick", "Chart.bundle", "searchjoy/litepicker", "searchjoy/application", nonce: true %>
+    <% else %>
+      <%= javascript_include_tag "searchjoy/application", nonce: true %>
+    <% end %>
   </head>
   <body>
     <div class="container">
@@ -310,7 +315,7 @@
                 <%= @time_range.first.strftime("%b %-e, %Y") %> to <%= @time_range.last.strftime("%b %-e, %Y") %>
               </span>
               <span class="text-muted"><%= @time_zone.name.sub(" (US & Canada)", "") %></span>
-              <script>
+              <%= javascript_tag nonce: true do %>
                 var startDate = <%= raw json_escape(@time_range.first.to_json) %>;
                 var endDate = <%= raw json_escape(@time_range.last.to_json) %>;
                 new Litepicker({
@@ -333,7 +338,7 @@
                     window.location.href = window.location.pathname + "?" + params.toString();
                   }
                 });
-              </script>
+              <% end %>
             <% end %>
           </div>
         </div>

data/app/views/searchjoy/searches/index.html.erb

@@ -8,7 +8,7 @@
     <tr>
       <th>Query</th>
       <th class="num" style="width: 20%;"><%= link_to "Searches", searches_path(search_type: params[:search_type], **@time_params), class: ("active" if params[:sort] != "conversion_rate") %></th>
-      <th class="num" style="width: 20%;">Conversions</th>
+      <th class="num" style="width: 20%;">Converted</th>
       <th class="num" style="width: 20%;"><%= link_to "%", searches_path(search_type: params[:search_type], sort: "conversion_rate", **@time_params), class: ("active" if params[:sort] == "conversion_rate") %></th>
       <th class="num" style="width: 20%;">Avg Results</th>
     </tr>
@@ -18,7 +18,7 @@
       <tr>
         <td><%= search["normalized_query"] %></td>
         <td class="num"><%= search["searches_count"] %></td>
-        <td class="num"><%= search["conversions_count"] %></td>
+        <td class="num"><%= search["converted_count"] %></td>
         <td class="num"><%= number_to_percentage search["conversion_rate"].to_f, precision: 0 %></td>
         <td class="num"><%= search["avg_results_count"].to_f.round %></td>
       </tr>

data/app/views/searchjoy/searches/overview.html.erb

@@ -23,7 +23,7 @@
     <table>
       <thead>
         <tr>
-          <th>Low Conversions</th>
+          <th>Low Conversion Rate</th>
           <th class="num"><%= link_to "View all", searches_path(search_type: @search_type, sort: "conversion_rate", **@time_params) %></th>
         </tr>
       </thead>
@@ -45,4 +45,4 @@
 
 <h2>Volume</h2>
 
-<%= line_chart [{name: "Searches", data: @searches_by_week}, {name: "Conversions", data: @conversions_by_week}] %>
+<%= line_chart [{name: "Searches", data: @searches_by_week}, {name: "Converted", data: @converted_by_week}] %>

data/app/views/searchjoy/searches/recent.html.erb

@@ -15,7 +15,8 @@
     <td style="width: 35%; color: #5cb85c;">
       <% if search.converted_at %>
         <strong>✓</strong>
-        <%= search.convertable ? (Searchjoy.conversion_name ? Searchjoy.conversion_name.call(search.convertable) : "#{search.convertable_type} #{search.convertable_id}") : "Converted" %>
+        <% convertable = Searchjoy.multiple_conversions ? search.conversions.min_by(&:created_at)&.convertable : search.convertable %>
+        <%= convertable ? (Searchjoy.conversion_name ? Searchjoy.conversion_name.call(convertable) : "#{convertable.model_name.name} #{convertable.id}") : "Converted" %>
       <% end %>
     </td>
     <td style="width: 20%;" class="num">

data/app/views/searchjoy/searches/stream.html.erb

@@ -2,7 +2,7 @@
 
 <table id="stream"></table>
 
-<script>
+<%= javascript_tag nonce: true do %>
   function load(element, path) {
     var request = new XMLHttpRequest();
     request.open("GET", path, true);
@@ -16,8 +16,8 @@
   }
 
   function fetchRecentSearches() {
-    load(document.getElementById("stream"), "<%= searches_recent_path %>")
+    load(document.getElementById("stream"), <%= raw json_escape(searches_recent_path.to_json) %>)
     setTimeout(fetchRecentSearches, 5 * 1000);
   }
   fetchRecentSearches();
-</script>
+<% end %>

data/lib/generators/searchjoy/templates/install.rb.tt

@@ -7,12 +7,17 @@ class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version
       t.string :normalized_query
       t.integer :results_count
       t.datetime :created_at
-      t.references :convertable, polymorphic: true, index: {name: "index_searchjoy_searches_on_convertable"}
       t.datetime :converted_at
     end
 
     add_index :searchjoy_searches, [:created_at]
     add_index :searchjoy_searches, [:search_type, :created_at]
     add_index :searchjoy_searches, [:search_type, :normalized_query, :created_at], name: "index_searchjoy_searches_on_search_type_query" # autogenerated name is too long
+
+    create_table :searchjoy_conversions do |t|
+      t.references :search
+      t.references :convertable, polymorphic: true, index: {name: "index_searchjoy_conversions_on_convertable"}
+      t.datetime :created_at
+    end
   end
 end

data/lib/searchjoy/engine.rb

@@ -4,7 +4,7 @@ module Searchjoy
 
     initializer "searchjoy" do |app|
       if app.config.respond_to?(:assets)
-        if defined?(Sprockets) && Sprockets::VERSION >= "4"
+        if defined?(Sprockets) && Sprockets::VERSION.to_i >= 4
           app.config.assets.precompile << "searchjoy/application.js"
         else
           # use a proc instead of a string

data/lib/searchjoy/version.rb

@@ -1,3 +1,3 @@
 module Searchjoy
-  VERSION = "0.5.1"
+  VERSION = "1.1.0"
 end

data/lib/searchjoy.rb

@@ -4,8 +4,8 @@ require "chartkick"
 require "groupdate"
 
 # modules
-require "searchjoy/track"
-require "searchjoy/version"
+require_relative "searchjoy/track"
+require_relative "searchjoy/version"
 
 module Searchjoy
   # time zone
@@ -23,15 +23,34 @@ module Searchjoy
   mattr_accessor :query_name
   mattr_accessor :query_url
 
+  # multiple conversions
+  mattr_accessor :multiple_conversions
+  self.multiple_conversions = true
+
   def self.attach_to_searchkick!
     Searchkick::Query.prepend(Searchjoy::Track::Query)
     Searchkick::MultiSearch.prepend(Searchjoy::Track::MultiSearch)
     Searchkick::Results.send(:attr_accessor, :search)
   end
+
+  def self.backfill_conversions
+    Searchjoy::Search.where.not(converted_at: nil).left_joins(:conversions).where(searchjoy_conversions: {id: nil}).find_in_batches do |searches|
+      conversions =
+        searches.map do |search|
+          {
+            search_id: search.id,
+            convertable_id: search.convertable_id,
+            convertable_type: search.convertable_type,
+            created_at: search.converted_at
+          }
+        end
+      Searchjoy::Conversion.insert_all(conversions)
+    end
+  end
 end
 
 if defined?(Rails)
-  require "searchjoy/engine"
-else
-  Searchjoy.attach_to_searchkick! if defined?(Searchkick)
+  require_relative "searchjoy/engine"
+elsif defined?(Searchkick)
+  Searchjoy.attach_to_searchkick!
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchjoy
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Andrew Kane
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-08 00:00:00.000000000 Z
+date: 2023-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chartkick
@@ -44,86 +44,16 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  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: rake
-  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: minitest
-  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: sqlite3
-  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: searchkick
-  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
+        version: '6'
+description:
+email: andrew@ankane.org
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -134,6 +64,7 @@ files:
 - app/assets/javascripts/searchjoy/application.js
 - app/assets/javascripts/searchjoy/litepicker.js
 - app/controllers/searchjoy/searches_controller.rb
+- app/models/searchjoy/conversion.rb
 - app/models/searchjoy/search.rb
 - app/views/layouts/searchjoy/application.html.erb
 - app/views/searchjoy/searches/index.html.erb
@@ -152,7 +83,7 @@ homepage: https://github.com/ankane/searchjoy
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -160,15 +91,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.4.6
+signing_key:
 specification_version: 4
 summary: Search analytics made easy
 test_files: []