searchjoy 0.3.1 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e149d7bbe57f78d3d77522a99ebe00c5c9958528
-  data.tar.gz: 0027be7a3d258f50a9897cd64218b0b4a3843506
+SHA256:
+  metadata.gz: 81afb5da71ed5e2714237809e9dfa472b6e5ac2d285bdd391a635c0cf67a1735
+  data.tar.gz: 4cc06c6f1c2379e0196655bf4379fe6a43ccafddf96cfeeb035ecae5d78026a4
 SHA512:
-  metadata.gz: b59164fcca41b33eabcb6eed7e0aa83a738ce818fbb1ac3b9439d04b8847966e2b764d13d328de7a6eead5fe7fbd758521396659e00a9d5e0153d072ae4b4572
-  data.tar.gz: db768b9ce87fcac0d1921a45b89827930e9ff3dd512b6fa4e01b98b0a3611203f9224cbe1881de4b31adab60cf1bc82947c6a2eb9401169256cd208c28affead
+  metadata.gz: a621888af83d4b3e2dc262f82abb0be369bd53c282e06d65b2aa65525f299c6d43a857790170ce03fab55242a2cbc18515e126d776df12f4ab26daa910b17496
+  data.tar.gz: 0e5bb79620de12393815699a577a1b09a59b7c588249b38e6ba02527285ecaaef1df61a9904cb30f8958581e8d31f37e9381ce7e4825125a75c82c4fdecc6a0b

data/CHANGELOG.md

@@ -1,23 +1,51 @@
-## 0.3.1
+## 0.4.3 (2020-03-06)
+
+- Fixed error with Groupdate 5
+
+## 0.4.2 (2019-10-08)
+
+- Added support for Sprockets 4
+- Require latest version of Chartkick
+
+## 0.4.1 (2019-05-26)
+
+- Added support for Rails 6
+
+## 0.4.0 (2019-04-15)
+
+- Added support for `models` option
+- Added tracking for `Searchkick.multi_search`
+- Fixed migration for SQLite (again)
+
+Breaking
+
+- Removed support for Rails < 5
+
+## 0.3.2 (2018-03-26)
+
+- Use `references` in migration
+- Fixed migration for SQLite
+
+## 0.3.1 (2017-05-12)
 
 - Fixed support for Rails 5.1
 
-## 0.3.0
+## 0.3.0 (2017-05-01)
 
 - Added support for Rails 5.1
 - Fixed `belongs_to` issue with Rails 5
 
-## 0.2.1
+## 0.2.1 (2017-03-19)
 
 - Added `query_url` option
 
-## 0.2.0
+## 0.2.0 (2017-01-05)
 
 - Fixed error with Rails 5
 - Fixed `Index name too long` error with SQLite
 - Added `query_name` option
 - Removed support for Rails 3
 
-## 0.1.0
+## 0.1.0 (2016-08-23)
 
 - Fixed Searchkick integration for `execute: false`

data/LICENSE.txt

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

data/README.md

@@ -12,7 +12,9 @@ Works with any search platform, including Elasticsearch, Sphinx, and Solr
 
 :cupid: An amazing companion to [Searchkick](https://github.com/ankane/searchkick)
 
-## Get Started
+[![Build Status](https://travis-ci.org/ankane/searchjoy.svg?branch=master)](https://travis-ci.org/ankane/searchjoy)
+
+## Installation
 
 Add this line to your application’s Gemfile:
 
@@ -24,7 +26,7 @@ And run the generator. This creates a migration to store searches.
 
 ```sh
 rails generate searchjoy:install
-rake db:migrate
+rails db:migrate
 ```
 
 Next, add the dashboard to your `config/routes.rb`.
@@ -35,7 +37,7 @@ mount Searchjoy::Engine, at: "searchjoy"
 
 Be sure to protect the endpoint in production - see the [Authentication](#authentication) section for ways to do this.
 
-### Track Searches
+## Track Searches
 
 Track searches by creating a record in the database.
 
@@ -51,22 +53,27 @@ Searchjoy::Search.create(
 With [Searchkick](https://github.com/ankane/searchkick), you can use the `track` option to do this automatically.
 
 ```ruby
-Item.search "apple", track: {user_id: 1}
+Item.search("apple", track: {user_id: 1})
 ```
 
 If you want to track more attributes, add them to the `searchjoy_searches` table.  Then, pass the values to the `track` option.
 
 ```ruby
-Item.search "apple", track: {user_id: 1, source: "web"}
+Item.search("apple", track: {user_id: 1, source: "web"})
 ```
 
 It’s that easy.
 
-### Track Conversions
+## Track Conversions
 
 First, choose a conversion metric. At Instacart, an item added to the cart from the search results page counts as a conversion.
 
-Next, when a user searches, keep track of the search id. With Searchkick, you can get the id with `@results.search.id`.
+Next, when a user searches, keep track of the search id. With Searchkick, you can get the id with:
+
+```ruby
+results = Item.search("apple", track: true)
+results.search.id
+```
 
 When a user converts, find the record and call `convert`.
 
@@ -78,25 +85,24 @@ search.convert
 Better yet, record the model that converted.
 
 ```ruby
-item = Item.find(params[:item_id])
 search.convert(item)
 ```
 
-### Authentication
+## Authentication
 
 Don’t forget to protect the dashboard in production.
 
-#### Devise
+### Devise
 
 In your `config/routes.rb`:
 
 ```ruby
-authenticate :user, -> (user) { user.admin? } do
+authenticate :user, ->(user) { user.admin? } do
   mount Searchjoy::Engine, at: "searchjoy"
 end
 ```
 
-#### Basic Authentication
+### Basic Authentication
 
 Set the following variables in your environment or an initializer.
 
@@ -105,45 +111,40 @@ ENV["SEARCHJOY_USERNAME"] = "andrew"
 ENV["SEARCHJOY_PASSWORD"] = "secret"
 ```
 
-### Customize
+## Customize
+
+To customize, create an initializer `config/initializers/searchjoy.rb`.
 
-To change the time zone, create an initializer `config/initializers/searchjoy.rb` with:
+Change the time zone
 
 ```ruby
 Searchjoy.time_zone = "Pacific Time (US & Canada)" # defaults to Time.zone
 ```
 
-Change the number of top searches shown with:
+Change the number of top searches shown
 
 ```ruby
 Searchjoy.top_searches = 500 # defaults to 100
 ```
 
-Link to the search results [master]
+Link to the search results
 
 ```ruby
-Searchjoy.query_url = -> (search) { Rails.application.routes.url_helpers.items_path(q: search.query) }
+Searchjoy.query_url = ->(search) { Rails.application.routes.url_helpers.items_path(q: search.query) }
 ```
 
-Add additional info to the query in the live stream.
+Add additional info to the query in the live stream
 
 ```ruby
-Searchjoy.query_name = -> (search) { "#{search.query} #{search.city}" }
+Searchjoy.query_name = ->(search) { "#{search.query} #{search.city}" }
 ```
 
-Show the conversion name in the live stream.
+Show the conversion name in the live stream
 
 ```ruby
-Searchjoy.conversion_name = -> (model) { model.name }
+Searchjoy.conversion_name = ->(model) { model.name }
 ```
 
-## TODO
-
-- customize views
-- analytics for individual queries
-- group similar queries
-- track pagination, facets, sorting, etc
-
 ## Contributing
 
 Everyone is encouraged to help improve this project. Here are a few ways you can help:
@@ -152,3 +153,12 @@ 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/searchjoy/pulls)
 - Write, clarify, or fix documentation
 - Suggest or add new feature
+
+To get started with development and testing:
+
+```sh
+git clone https://github.com/ankane/searchjoy.git
+cd searchjoy
+bundle install
+bundle exec rake test
+```

data/app/assets/javascripts/searchjoy.js

@@ -0,0 +1,2 @@
+//= require chartkick
+//= require Chart.bundle

data/app/controllers/searchjoy/searches_controller.rb

@@ -20,8 +20,8 @@ module Searchjoy
 
     def overview
       relation = Searchjoy::Search.where(search_type: params[:search_type])
-      @searches_by_week = relation.group_by_week(:created_at, Time.zone, @time_range).count
-      @conversions_by_week = relation.where("converted_at is not null").group_by_week(:created_at, Time.zone, @time_range).count
+      @searches_by_week = relation.group_by_week(:created_at, time_zone: Time.zone, range: @time_range).count
+      @conversions_by_week = relation.where("converted_at is not null").group_by_week(: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 = {}

data/app/models/searchjoy/search.rb

@@ -1,15 +1,9 @@
 module Searchjoy
   class Search < ActiveRecord::Base
-    if Rails::VERSION::MAJOR == 5
-      belongs_to :convertable, polymorphic: true, optional: true
-    else
-      belongs_to :convertable, polymorphic: true
-    end
+    self.table_name = "searchjoy_searches"
 
-    # the devise way
-    if (Rails::VERSION::MAJOR == 3 && !defined?(ActionController::StrongParameters)) || defined?(ActiveModel::MassAssignmentSecurity)
-      attr_accessible :search_type, :query, :results_count
-    end
+    belongs_to :convertable, polymorphic: true, optional: true
+    belongs_to :user, optional: true
 
     before_save :set_normalized_query
 

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

@@ -280,7 +280,7 @@
       }
     </style>
 
-    <%= javascript_include_tag "https://ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js", "https://cdnjs.cloudflare.com/ajax/libs/Chart.js/2.4.0/Chart.bundle.min.js", "chartkick" %>
+    <%= javascript_include_tag "searchjoy" %>
   </head>
   <body>
     <div class="container">

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

@@ -3,11 +3,21 @@
 <table id="stream"></table>
 
 <script>
+  function load(element, path) {
+    var request = new XMLHttpRequest();
+    request.open("GET", path, true);
+    request.onload = function() {
+      if (request.status >= 200 && request.status < 400) {
+        var resp = request.responseText;
+        element.innerHTML = resp;
+      }
+    };
+    request.send();
+  }
+
   function fetchRecentSearches() {
-    $("#stream").load("<%= searches_recent_path %>");
+    load(document.getElementById("stream"), "<%= searches_recent_path %>")
     setTimeout(fetchRecentSearches, 5 * 1000);
   }
-  $( function() {
-    fetchRecentSearches();
-  });
+  fetchRecentSearches();
 </script>

data/lib/generators/searchjoy/install_generator.rb

@@ -1,34 +1,17 @@
-# taken from https://github.com/collectiveidea/audited/blob/master/lib/generators/audited/install_generator.rb
-require "rails/generators"
-require "rails/generators/migration"
-require "active_record"
 require "rails/generators/active_record"
 
 module Searchjoy
   module Generators
     class InstallGenerator < Rails::Generators::Base
-      include Rails::Generators::Migration
-
-      source_root File.expand_path("../templates", __FILE__)
-
-      # Implement the required interface for Rails::Generators::Migration.
-      def self.next_migration_number(dirname) #:nodoc:
-        next_migration_number = current_migration_number(dirname) + 1
-        if ActiveRecord::Base.timestamped_migrations
-          [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
-        else
-          "%.3d" % next_migration_number
-        end
-      end
+      include ActiveRecord::Generators::Migration
+      source_root File.join(__dir__, "templates")
 
       def copy_migration
         migration_template "install.rb", "db/migrate/install_searchjoy.rb", migration_version: migration_version
       end
 
       def migration_version
-        if ActiveRecord::VERSION::MAJOR >= 5
-          "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
-        end
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
       end
     end
   end

data/lib/generators/searchjoy/templates/{install.rb → install.rb.tt}

@@ -1,20 +1,18 @@
 class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
   def change
     create_table :searchjoy_searches do |t|
-      t.integer :user_id
+      t.references :user
       t.string :search_type
       t.string :query
       t.string :normalized_query
       t.integer :results_count
       t.timestamp :created_at
-      t.integer :convertable_id
-      t.string :convertable_type
+      t.references :convertable, polymorphic: true, index: {name: "index_searchjoy_searches_on_convertable"}
       t.timestamp :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_normalized_query" # autogenerated name is too long
-    add_index :searchjoy_searches, [:convertable_id, :convertable_type]
+    add_index :searchjoy_searches, [:search_type, :normalized_query, :created_at], name: "index_searchjoy_searches_on_search_type_query" # autogenerated name is too long
   end
 end

data/lib/searchjoy.rb

@@ -1,9 +1,8 @@
-require "active_record"
+require "active_support/core_ext/module/attribute_accessors"
 require "chartkick"
 require "groupdate"
 
 require "searchjoy/track"
-require "searchjoy/engine" if defined?(Rails)
 require "searchjoy/version"
 
 module Searchjoy
@@ -21,24 +20,16 @@ module Searchjoy
   mattr_accessor :conversion_name
   mattr_accessor :query_name
   mattr_accessor :query_url
-end
 
-begin
-  require "searchkick"
-rescue LoadError
-  # do nothing
+  def self.attach_to_searchkick!
+    Searchkick::Query.prepend(Searchjoy::Track::Query)
+    Searchkick::MultiSearch.prepend(Searchjoy::Track::MultiSearch)
+    Searchkick::Results.send(:attr_accessor, :search)
+  end
 end
 
-if defined?(Searchkick)
-  module Searchkick
-    class Query
-      include Searchjoy::Track
-      define_method(:execute_without_track, instance_method(:execute))
-      define_method(:execute, instance_method(:execute_with_track))
-    end
-
-    class Results
-      attr_accessor :search
-    end
-  end
+if defined?(Rails)
+  require "searchjoy/engine"
+else
+  Searchjoy.attach_to_searchkick! if defined?(Searchkick)
 end

data/lib/searchjoy/engine.rb

@@ -1,5 +1,18 @@
 module Searchjoy
   class Engine < ::Rails::Engine
     isolate_namespace Searchjoy
+
+    initializer "searchjoy" do |app|
+      if app.config.respond_to?(:assets)
+        if defined?(Sprockets) && Sprockets::VERSION >= "4"
+          app.config.assets.precompile << "searchjoy.js"
+        else
+          # use a proc instead of a string
+          app.config.assets.precompile << proc { |path| path == "searchjoy.js" }
+        end
+      end
+
+      Searchjoy.attach_to_searchkick! if defined?(Searchkick)
+    end
   end
 end

data/lib/searchjoy/track.rb

@@ -1,24 +1,48 @@
 module Searchjoy
   module Track
-    def execute_with_track
-      results = execute_without_track
-
-      if options[:track]
-        attributes = options[:track] == true ? {} : options[:track]
-
-        search_type =
-          if klass.respond_to?(:name) && klass.name.present?
-            klass.name
-          elsif options[:index_name]
-            Array(options[:index_name]).map(&:to_s).sort.join(" ")
-          else
-            "All Indices"
-          end
-
-        results.search = Searchjoy::Search.create({search_type: search_type, query: term, results_count: results.total_count}.merge(attributes))
+    module Query
+      def track
+        results = @execute
+
+        if options[:track] && !results.search
+          attributes = options[:track] == true ? {} : options[:track]
+
+          search_type =
+            if klass.respond_to?(:name) && klass.name.present?
+              klass.name
+            elsif options[:models]
+              Array(options[:models]).map(&:to_s).sort.join(" ")
+            elsif options[:index_name]
+              Array(options[:index_name]).map(&:to_s).sort.join(" ")
+            else
+              "All Indices"
+            end
+
+          results.search = Searchjoy::Search.create({search_type: search_type, query: term, results_count: results.total_count}.merge(attributes))
+        end
       end
 
-      results
+      def execute
+        results = super
+        track
+        results
+      end
+
+      def search
+        @execute.search if @execute
+      end
+    end
+
+    module MultiSearch
+      def perform
+        result = super
+
+        @queries.each do |query|
+          query.track
+        end
+
+        result
+      end
     end
   end
 end

data/lib/searchjoy/version.rb

@@ -1,3 +1,3 @@
 module Searchjoy
-  VERSION = "0.3.1"
+  VERSION = "0.4.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchjoy
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.3
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-12 00:00:00.000000000 Z
+date: 2020-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chartkick
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: groupdate
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -94,19 +94,44 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Search analytics made easy
-email:
-- andrew@chartkick.com
+- !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
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
+- app/assets/javascripts/searchjoy.js
 - app/controllers/searchjoy/searches_controller.rb
 - app/models/searchjoy/search.rb
 - app/views/layouts/searchjoy/application.html.erb
@@ -116,14 +141,11 @@ files:
 - app/views/searchjoy/searches/stream.html.erb
 - config/routes.rb
 - lib/generators/searchjoy/install_generator.rb
-- lib/generators/searchjoy/templates/install.rb
+- lib/generators/searchjoy/templates/install.rb.tt
 - lib/searchjoy.rb
 - lib/searchjoy/engine.rb
 - lib/searchjoy/track.rb
 - lib/searchjoy/version.rb
-- searchjoy.gemspec
-- test/searchjoy_test.rb
-- test/test_helper.rb
 homepage: https://github.com/ankane/searchjoy
 licenses:
 - MIT
@@ -136,18 +158,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Search analytics made easy
-test_files:
-- test/searchjoy_test.rb
-- test/test_helper.rb
+test_files: []

data/.gitignore

@@ -1,17 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/Gemfile

@@ -1,4 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in searchjoy.gemspec
-gemspec

data/Rakefile

@@ -1,8 +0,0 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-task default: :test
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.pattern = "test/**/*_test.rb"
-end

data/searchjoy.gemspec

@@ -1,28 +0,0 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "searchjoy/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "searchjoy"
-  spec.version       = Searchjoy::VERSION
-  spec.authors       = ["Andrew Kane"]
-  spec.email         = ["andrew@chartkick.com"]
-  spec.description   = "Search analytics made easy"
-  spec.summary       = "Search analytics made easy"
-  spec.homepage      = "https://github.com/ankane/searchjoy"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "chartkick", ">= 2"
-  spec.add_dependency "groupdate", ">= 3"
-  spec.add_dependency "activerecord", ">= 4"
-
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest"
-end

data/test/searchjoy_test.rb

@@ -1,15 +0,0 @@
-require_relative "test_helper"
-
-class SearchjoyTest < Minitest::Test
-  def test_must_respond_to_top_searches
-    assert_respond_to Searchjoy, :top_searches
-  end
-
-  def test_must_respond_to_conversion_name
-    assert_respond_to Searchjoy, :conversion_name
-  end
-
-  def test_must_respond_to_time_zone
-    assert_respond_to Searchjoy, :time_zone
-  end
-end

data/test/test_helper.rb

@@ -1,6 +0,0 @@
-require "bundler/setup"
-Bundler.require(:default)
-require "minitest/autorun"
-require "minitest/pride"
-
-Minitest::Test = Minitest::Unit::TestCase unless defined?(Minitest::Test)