searchjoy 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 251310fe718b7f513e69055ad21cff3c6b172941
-  data.tar.gz: 6c9b95367fb7cf245e797d329f545c25fa3b4190
+SHA256:
+  metadata.gz: 64e99ae7ad3156c550ad14bd0c6b8bea1771749a10136329dae8bf6493612125
+  data.tar.gz: c8270664778714b46af93a4914c43539f69b73704d32e74f37bbbcc93352fca3
 SHA512:
-  metadata.gz: 4b9c9a88f6b774e9854dd5762e96ad13b0e4ddab0d374552fe43f054a923c0ac3d9896636196b2d0d3cc0c24c2698ffc4dadd7fe7b7fb376c9e7c75cdbc5ae2a
-  data.tar.gz: cdeab36645b69149e4807428e59e9d2d04de44616eec9c6740846d42ff874fcd45788c72d8ac47309a4339c901b744810f5c606dcfffae25a0ead18f11f65293
+  metadata.gz: '0528355d4e0ae8259a06ef1f669c250dda444202f10de264594f1c338742a7400b95c0e60dd0d8458df114a560cc10139c405543840cf093cee155606706e437'
+  data.tar.gz: deed698f626106cba1e4dff53983b978c01176b5e42c9a80a7cdc49a399282983b94e52ab826b9533603799c6af75d0866b16ed5c039ac27098904b8e2f04915

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 0.4.0
+
+- 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
 
 - Use `references` in migration

data/LICENSE.txt

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

data/README.md

@@ -12,7 +12,7 @@ Works with any search platform, including Elasticsearch, Sphinx, and Solr
 
 :cupid: An amazing companion to [Searchkick](https://github.com/ankane/searchkick)
 
-## Get Started
+## Installation
 
 Add this line to your application’s Gemfile:
 
@@ -35,7 +35,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 +51,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,15 +83,14 @@ 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`:
 
@@ -96,7 +100,7 @@ authenticate :user, ->(user) { user.admin? } do
 end
 ```
 
-#### Basic Authentication
+### Basic Authentication
 
 Set the following variables in your environment or an initializer.
 
@@ -105,45 +109,40 @@ ENV["SEARCHJOY_USERNAME"] = "andrew"
 ENV["SEARCHJOY_PASSWORD"] = "secret"
 ```
 
-### Customize
+## Customize
 
-To change the time zone, create an initializer `config/initializers/searchjoy.rb` with:
+To customize, create an initializer `config/initializers/searchjoy.rb`.
+
+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) }
 ```
 
-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}" }
 ```
 
-Show the conversion name in the live stream.
+Show the conversion name in the live stream
 
 ```ruby
 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:

data/app/models/searchjoy/search.rb

@@ -1,15 +1,10 @@
 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
+    options = ActiveRecord::VERSION::MAJOR == 5 ? {optional: true} : {}
+    belongs_to :convertable, polymorphic: true, **options
+    belongs_to :user, **options
 
     before_save :set_normalized_query
 

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

@@ -7,7 +7,7 @@ class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version
       t.string :normalized_query
       t.integer :results_count
       t.timestamp :created_at
-      t.references :convertable, polymorphic: true
+      t.references :convertable, polymorphic: true, index: {name: "index_searchjoy_searches_on_convertable"}
       t.timestamp :converted_at
     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,17 +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)
-  Searchkick::Query.prepend(Searchjoy::Track)
-  class Searchkick::Results
-    attr_accessor :search
-  end
+if defined?(Rails)
+  require "searchjoy/engine"
+else
+  Searchjoy.attach_to_searchkick! if defined?(Searchkick)
 end

data/lib/searchjoy/engine.rb

@@ -1,5 +1,9 @@
 module Searchjoy
   class Engine < ::Rails::Engine
     isolate_namespace Searchjoy
+
+    initializer "searchjoy" do
+      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
-      results = super
-
-      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.2"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchjoy
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-27 00:00:00.000000000 Z
+date: 2019-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chartkick
@@ -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,20 +94,43 @@ 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: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.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:
-- ".gitattributes"
-- ".gitignore"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - app/controllers/searchjoy/searches_controller.rb
 - app/models/searchjoy/search.rb
 - app/views/layouts/searchjoy/application.html.erb
@@ -117,14 +140,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
@@ -137,18 +157,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.13
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Search analytics made easy
-test_files:
-- test/searchjoy_test.rb
-- test/test_helper.rb
+test_files: []

data/.gitattributes

@@ -1 +0,0 @@
-app/views/* linguist-vendored

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)