soulheart 0.2.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b940c579f757c257a88e570248db8b58e960c1b2
-  data.tar.gz: f4b963e11a35ee654f71480f12ace35d65b9c213
+SHA256:
+  metadata.gz: cdb795313ac11f814661f05f909345f831b473a8ae77fdef354918820012f13e
+  data.tar.gz: 5cf89e90855b28a0d721fb9feeb359c80fb35243f8f42e90297af5b02c49f3dd
 SHA512:
-  metadata.gz: 5c932ab836432de24dbb7f8d040926a64fb93b57d2dc4dc5fbd7b007703013ddba084092537c7b9895ce14398d12caaea1e82a02bc40518c1e9a6ad204505e11
-  data.tar.gz: a5381685e30a771b118a39ea6c02f1831c078ec964687ddb75c1d372c146c4003cbf0f8288c09e90e223b7a9d5763f985bbc2ff9fb6aa7f9bfe59f6e001dafc0
+  metadata.gz: f8e8b2f350377d635fceb04a0da5247bfafe464240454ccda378831c6323eb3e01e9db059716744f0439eb3a7c2cf0ee99347c1abe2db70ed1de30ff2d9b3406
+  data.tar.gz: bbea122eeaf96cd47222c8d91256760b53a84e696b0e6a638fb146155579942f51643161f4f8e357206e250a03d41f9d6b512d37c513097a3ad241ee992c3cb6

data/README.md

@@ -1,13 +1,14 @@
-# <img src="https://raw.githubusercontent.com/sethherr/soulheart/master/examples/logo.png" alt="Soulheart" width="200"> Soulheart [![Build Status](https://travis-ci.org/sethherr/soulheart.svg)](https://travis-ci.org/sethherr/soulheart) [![Code Climate](https://codeclimate.com/github/sethherr/soulheart/badges/gpa.svg)](https://codeclimate.com/github/sethherr/soulheart) [![Test Coverage](https://codeclimate.com/github/sethherr/soulheart/badges/coverage.svg)](https://codeclimate.com/github/sethherr/soulheart/coverage)
+# <img src="https://raw.githubusercontent.com/sethherr/soulheart/master/examples/logo.png" alt="Soulheart" width="200"> Soulheart [![Build Status](https://travis-ci.org/sethherr/soulheart.svg?branch=master)](https://travis-ci.org/sethherr/soulheart) [![Code Climate](https://codeclimate.com/github/sethherr/soulheart/badges/gpa.svg)](https://codeclimate.com/github/sethherr/soulheart) [![Test Coverage](https://codeclimate.com/github/sethherr/soulheart/badges/coverage.svg)](https://codeclimate.com/github/sethherr/soulheart/coverage)
 
 Soulheart is a ready-to-use remote data source for autocomplete. The goal is to provide a solid, flexible tool that's downright easy to set up and use.
 
-- [Demos](https://sethherr.github.io/soulheart/)
-- [Usage documentation](https://sethherr.github.io/soulheart/commands/)
+- [Intro page](https://sethherr.github.io/soulheart/)
+- [Usage documentation (commands)](https://sethherr.github.io/soulheart/commands/)
 - [Example data sources](https://github.com/sethherr/soulheart/tree/master/examples)
 - [Getting started](#getting-started)
 - [Deployment](#deployment)
 - [Testing](#testing)
+- Example usage [with Selectize](https://sethherr.github.io/soulheart/examples_selectize) & [Select2](https://sethherr.github.io/soulheart/examples_select2)
 
 
 ## Features
@@ -29,7 +30,7 @@ Soulheart is a ready-to-use remote data source for autocomplete. The goal is to
 
 ## Getting started
 
-See the [Soulheart demo page](https://sethherr.github.io/soulheart/) for a step-by-step explanation of creating an instance and setting up a select box that uses it as a remote data source.
+See the [Soulheart intro page](https://sethherr.github.io/soulheart/) for a step-by-step explanation of setting up a select box that uses Soulheart as a remote data source.
 
 
 ## Deployment
@@ -43,21 +44,40 @@ To update your Heroku deploy of Soulheart, use the [Heroku CLI](https://devcente
     heroku deploy -a NAME_OF_YOUR_APP_ON_HEROKU
     
 
-#### In a Rails app
+## In a Rails app
 
-Soulheart is a gem. Add it to your gemfile:
+Soulheart is a gem. It uses [hiredis](https://github.com/redis/hiredis) on Ruby MRI. Add these lines to your gemfile:
 
     gem 'soulheart'
+    gem 'hiredis', '~> 0.6.0' # Skip using JRuby
+    gem 'redis', '>= 3.2.0', require: ['redis', 'redis/connection/hiredis'] # Skip if using JRuby
 
-And then put this in your routes.rb
+
+And add this in your routes.rb:
 
     require 'soulheart/server'
-    mount Soulheart::Server => "/soulhearts"
+
+    Rails.application.routes.draw do
+      # .... your application routes
+
+      mount Soulheart::Server => '/soulhearts'
+    end
 
 You can then access the server when your rails app is running. You can run the [Soulheart commands](https://sethherr.github.io/soulheart/commands/) from that directory.
 
-*note: On Heroku Soulheart uses `rackup` to start the server. Because of this, there's a `config.ru` and a `Gemfile.lock`&mdash;to make it (and any forks) directly deployable. These files aren't in the Gem.*
+*Hote: On Heroku Soulheart uses `rackup` to start the server. Because of this, there's a `config.ru`, a `Gemfile.lock` and a `app.json`&mdash;to make it (and any forks of it) directly deployable. These files aren't in the Gem.*
+
+##### Setting redis url
+
+You can also set the redis url. 
+
+```ruby
+# config/initializers/soulheart.rb
 
+Soulheart.redis = 'redis://127.0.0.1:6379/0'
+# or you can asign an existing instance of Redis, Redis::Namespace, etc.
+# Soulheart.redis = $redis
+```
 ## Testing
 
 Tested with rspec. Check out test information at [Code Climate](https://codeclimate.com/github/sethherr/soulheart).
@@ -73,6 +93,6 @@ It requires Redis >= 3.0
 
 ## Additional info
 
-This is an extended fork of [Soulmate](https://github.com/seatgeek/soulmate), to bring it up to date, make it slicker, and make it deployable to Heroku.
+This initially started as a fork of [Soulmate](https://github.com/seatgeek/soulmate) to support the features listed, provide demos and make it instantly deployable to Heroku.
 
 It's MIT licensed.

data/bin/soulheart

@@ -107,7 +107,7 @@ def load(file)
         lines = []
         @batch_size.times do
           break if f.eof?
-          lines << MultiJson.decode(f.gets)
+          lines << JSON.parse(f.gets)
           count += 1
         end
       end

data/lib/soulheart.rb

@@ -1,5 +1,4 @@
-require 'multi_json'
-
+require 'json'
 require 'soulheart/version'
 require 'soulheart/helpers'
 require 'soulheart/base'

data/lib/soulheart/config.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 require 'uri'
 require 'redis'
 
@@ -28,7 +29,7 @@ module Soulheart
     def redis
       @redis ||= (
         url = URI(@redis_url || ENV['REDIS_URL'] || 'redis://127.0.0.1:6379/0')
-        ::Redis.new(          # 
+        ::Redis.new(
           driver: (jruby? ? :ruby : :hiredis),
           host: url.host,
           port: url.port,

data/lib/soulheart/loader.rb

@@ -55,20 +55,19 @@ module Soulheart
       # everything will work itself out as soon as the cache expires again.
     end
 
-    def remove_results_hash
-      # delete the data store
-      # We don't do this every time we clear because because it breaks the caching feature. 
-      # The option to clear this is only called in testing right now. 
-      # There should be an option to clear it other times though.
+    def clear_cache
+      # Remove the remove_results_hash
+      # has to be called before the cat_ids are cleared
+      category_combos.map { |cat| redis.expire(no_query_id(category_id(cat)), 0) }
       redis.expire results_hashes_id, 0
       redis.del(results_hashes_id)
     end
 
-    def clear(remove_results=false)
+    def clear(should_clear_cache = false)
+      clear_cache if should_clear_cache
       category_combos.each {|cat| delete_data(category_id(cat)) }
       delete_categories
       delete_data
-      remove_results_hash if remove_results
     end
 
     def load(items)
@@ -121,7 +120,7 @@ module Soulheart
       redis.pipelined do
         redis.zadd(no_query_id(category_base_id), priority, item['term'])  # Add to master set for queryless searches
         # store the raw data in a separate key to reduce memory usage, if it's cleaned it's done
-        redis.hset(results_hashes_id, item['term'], MultiJson.encode(item['data'])) unless cleaned
+        redis.hset(results_hashes_id, item['term'], item['data'].to_json) unless cleaned
         phrase = ([item['term']] + (item['aliases'] || [])).join(' ')
         # Store all the prefixes
         prefixes_for_phrase(phrase).each do |p|

data/lib/soulheart/matcher.rb

@@ -65,7 +65,7 @@ module Soulheart
       return [] unless terms.size > 0
       results = redis.hmget(results_hashes_id, *terms)
       results = results.reject(&:nil?) # handle cached results for terms which have since been deleted
-      results.map { |r| MultiJson.decode(r) }
+      results.map { |r| JSON.parse(r) }
     end
 
     def matches

data/lib/soulheart/server.rb

@@ -15,27 +15,27 @@ module Soulheart
 
     get '/' do
       matches = Matcher.new(params).matches
-      MultiJson.encode(matches:  matches)
+      {matches:  matches}.to_json
     end
 
     get '/categories' do
-      MultiJson.encode(categories: Base.new.sorted_category_array)
+      {categories: Base.new.sorted_category_array}.to_json
     end
 
     get '/info' do
       info = Soulheart::Base.new.redis.info
-      MultiJson.encode({
+      {
         soulheart_version: Soulheart::VERSION,
         current_time: Time.now.utc.strftime('%H:%M:%S UTC'),
         redis_used_memory: info['used_memory_human'],
         stop_words: Soulheart.stop_words,
         normalizer: Soulheart.normalizer,
-      })
+      }.to_json
     end
 
     not_found do
       content_type 'application/json', charset: 'utf-8'
-      MultiJson.encode(error: 'not found')
+      {error: 'not found'}.to_json
     end
   end
 end

data/lib/soulheart/version.rb

@@ -1,3 +1,3 @@
 module Soulheart
-  VERSION = '0.2.2'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: soulheart
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Seth Herr
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-07-29 00:00:00.000000000 Z
+date: 2021-04-07 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: hiredis
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.4.5
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.4.5
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.6
+        version: 3.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.6
+        version: 3.0.5
 - !ruby/object:Gem::Dependency
   name: vegas
   requirement: !ruby/object:Gem::Requirement
@@ -52,62 +38,54 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.1.0
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.4'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.14'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.14'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 description: Simple, fast autocomplete server for Ruby and Rails
 email:
 - seth.william.herr@gmail.com
@@ -134,7 +112,7 @@ homepage: https://github.com/sethherr/soulheart
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -149,9 +127,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Simple, fast autocomplete server for Ruby and Rails
 test_files: []