searchjoy 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 807861a09661dcbcf5a2f4c580e189e3df4d7f67e3a1dbb863408ce7fc1091c3
-  data.tar.gz: b901df59229c2a6daa3781a44b66b89d87d171aeede2acbd17f9ef135e78c7fd
+  metadata.gz: c6e0ac0fd71243df3a3395c6ab793fe20d523ed435634b3adf73c44ac58aa167
+  data.tar.gz: 83708806572742373d3531750d867bdf9c4338df15546f4361e8d0b927330099
 SHA512:
-  metadata.gz: 4c7d96778f812145a132f8f756ac2ca1bb88429758db180402f47b0f56d68b9dfe63e461668b28a51162018f7f97f49c6f94100e3430a79bf54056cd2b4fcdbb
-  data.tar.gz: 744e8fff8679dfc197d4439c7cda43cc21b23f38e12aec883a1b095481ae4f3db597b3f26bc2c409c51c07928a4f68a4a5114b387905b5c0c6f119611dbac7b1
+  metadata.gz: 94f1c69497cb80375308e6694c7b43731f75baf93073c26baf16b446fb65fc6b335d252882f42e1391dd0f242b1a7b7e42587e3908cbf6db36a603fdf78a4477
+  data.tar.gz: b1eb7619d49602c90ca34dcae225c89d095c4357ee57970f61ac73d5b4ba336feccabb28eb4db2a9974215fe5c8d988441b2390e43bfac7936dd54ef91433869

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 1.2.0 (2024-06-24)
+
+- Dropped support for Ruby < 3.1 and Rails < 6.1
+
+## 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

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013-2022 Andrew Kane
+Copyright (c) 2013-2024 Andrew Kane
 
 MIT License
 

data/README.md

@@ -7,14 +7,14 @@ Search analytics made easy
 [![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://github.com/ankane/searchjoy/workflows/build/badge.svg?branch=master)](https://github.com/ankane/searchjoy/actions)
+[![Build Status](https://github.com/ankane/searchjoy/actions/workflows/build.yml/badge.svg)](https://github.com/ankane/searchjoy/actions)
 
 ## Installation
 
@@ -122,7 +122,11 @@ ENV["SEARCHJOY_PASSWORD"] = "secret"
 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).in_batches.delete_all
+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.
@@ -134,7 +138,10 @@ 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

data/app/controllers/searchjoy/searches_controller.rb

@@ -34,12 +34,12 @@ module Searchjoy
 
       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.not(converted_at: nil).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
 
@@ -87,7 +87,7 @@ module Searchjoy
     def set_searches
       @limit = params[:limit] || Searchjoy.top_searches
       relation = Searchjoy::Search
-        .select("normalized_query, COUNT(*) as searches_count, COUNT(converted_at) as conversions_count, AVG(results_count) as avg_results_count")
+        .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)
@@ -95,7 +95,7 @@ module Searchjoy
       # 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/views/layouts/searchjoy/application.html.erb

@@ -4,6 +4,7 @@
     <title>Searchjoy</title>
 
     <meta charset="utf-8" />
+    <%= csp_meta_tag %>
 
     <style>
       body {
@@ -289,9 +290,9 @@
     </style>
 
     <% if defined?(Propshaft::Railtie) %>
-      <%= javascript_include_tag "chartkick", "Chart.bundle", "searchjoy/litepicker", "searchjoy/application" %>
+      <%= javascript_include_tag "chartkick", "Chart.bundle", "searchjoy/litepicker", "searchjoy/application", nonce: true %>
     <% else %>
-      <%= javascript_include_tag "searchjoy/application" %>
+      <%= javascript_include_tag "searchjoy/application", nonce: true %>
     <% end %>
   </head>
   <body>
@@ -314,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({
@@ -337,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/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);
@@ -20,4 +20,4 @@
     setTimeout(fetchRecentSearches, 5 * 1000);
   }
   fetchRecentSearches();
-</script>
+<% 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 = "1.0.0"
+  VERSION = "1.2.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
@@ -44,19 +44,13 @@ module Searchjoy
             created_at: search.converted_at
           }
         end
-      if ActiveRecord::VERSION::MAJOR >= 6
-        Searchjoy::Conversion.insert_all(conversions)
-      else
-        Searchjoy::Conversion.transaction do
-          Searchjoy::Conversion.create!(conversions)
-        end
-      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: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-10 00:00:00.000000000 Z
+date: 2024-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chartkick
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: groupdate
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
 description:
 email: andrew@ankane.org
 executables: []
@@ -91,14 +91,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Search analytics made easy