soulheart 0.0.8 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fca63751060b314d95ce3574b90e80b65ae5f517
-  data.tar.gz: ac427fb1200ece18b30bdcf3903d9e12ba1fb3ce
+  metadata.gz: b7614d5a25688e37c96f1934f0e431048603771d
+  data.tar.gz: 7bede6c0cd14ddb287636f8194d641eb1842625c
 SHA512:
-  metadata.gz: c3f4307acaf580c609e3eec7450a440c75e10fbe0df2a9104d68fcfdb0f3e888ed5675352d286e6540f1ec7906b623dd36485f187404a0d4990058df09ee3d3e
-  data.tar.gz: d7d4a2948a9a87782bf3703ffe41de388a3f0fe160d27c179bbfd027a5120148550da4e5ba52b9bc7050f2ad42897a5645f95070e4ffb52cfc6eb39411f56956
+  metadata.gz: 6380d4fa61e9101397e254afc09b4fe8b765f396728f2b68ad358224bf6ac09f36dad401c0079cf0dc7b28bccd22b4ab0a1c2fa9bc0e7f7868aa47a7d16714eb
+  data.tar.gz: 5c1700b08f56ef30e12fdef6520f1d5b89641b2e6480a2489edb75ba67b8b6e786b15f9ff20f2a63dccca12766db6981253ecc15ba0854fed6f7ea5e5cb13da9

data/README.md

@@ -1,34 +1,71 @@
 # <img src="https://raw.githubusercontent.com/sethherr/soulheart/master/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)
 
-To get started, check out examples and documentation at [sethherr.github.io/soulheart/](https://sethherr.github.io/soulheart/).
+Soulheart is a ready-to-use remote data source for autocomplete. The goal is to provide a solid, flexible tool that's downright simple to set up.
 
-**Soulheart is a ready-to-use remote data source for autocomplete**. It supports:
+- [Demos](https://sethherr.github.io/soulheart/)
+- [Usage documentation](https://sethherr.github.io/soulheart/commands/)
+- [Example data sources](https://github.com/sethherr/soulheart/tree/master/example_data_sources)
+- [Getting started](#getting-started)
+- [Deployment](#deployment)
+- [Testing](#testing)
 
-- pagination
-- categories
-- sorting by priority (not just alphabetically)
-- arbitrary return values/objects
-- loading data via gists (or any url)
-- mounting standalone or inside of a rails app
 
-... and is [instantly deployable to heroku](https://heroku.com/deploy) (for free).
+## Features
 
+- **Pagination**
+  <br>For infinite scrolling of results - wow!
+- **Categories**
+  <br>Match results for specified categories, or not - your choice.
+- **Prioritization**
+  <br>Return results sorted by priority (not just alphabetically).
+- **Arbitrary return objects**
+  <br>Get whatever you want back. IDs, URLs, image links, even pre-formatted HTML :boom:
+- **Load remote data**
+  <br>Makes loading data via gists (or any url) possible.
+- **Runs Standalone or inside a rails app**
 
-This project is in Beta. It's probably appropriate to use in production... but maybe wait? There are a few more changes coming, and some documentation improvements to be made.
+## Getting started
 
-=======
+See the [Soulheart demos 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.
 
-I'm testing with: `ruby 2.1` and `redis 3.0`. 
 
-Run `bundle exec guard` to run the specs when they change as you work.
+## Deployment
 
-This repo includes a `config.ru` and a `Gemfile.lock` so it and any forks of it can be deployed to Heroku. They shouldn't be in the Gem. if you build it separately.
+#### With Heroku [![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)
 
-======
+You can instantly deploy Soulheart to Heroku for free - just click the button - which deploys this repository using `rackup` to start the server. Because of this, there's a `config.ru` and a `Gemfile.lock`&mdash;to make it (and any forks) runnable on Heroku. These files aren't in the Gem.
 
-[There is issue for improving documentation](../../issues/1) because the documentation needs to be improved. Also, for serious, check out [sethherr.github.io/soulheart/](https://sethherr.github.io/soulheart/).
+To update your Heroku deploy of Soulheart, use the [Heroku CLI](https://devcenter.heroku.com/articles/heroku-command) and redeploy the app: 
+  
+    heroku deploy -a NAME_OF_YOUR_APP_ON_HEROKU
+    
 
-=====
+#### In a Rails app
 
+Soulheart is also a gem. Add it to your gemfile:
 
-This is a fork of [Soulmate](https://github.com/seatgeek/soulmate). It isn't backward compatible.
+    gem 'soulheart'
+
+And then put this in your routes.rb -
+
+    require 'sidekiq/web'
+    mount Soulheart::Server => "/soulhearts"
+
+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.
+
+## Testing
+
+Tested with rspec, check out test information at [Code Climate](https://codeclimate.com/github/sethherr/soulheart).
+
+Run `bundle exec guard` to watch for changes and rerun the tests when files are saved.
+
+
+## Requirements
+
+Soulheart is a Redis backed Sinatra server. I test with the latest MRI (2.2, 2.1, 2.0) and JRuby versions (1.7). Other versions/VMs are untested but might work fine.
+
+It requires Redis 3.0
+
+## Additional info
+
+This started as a fork of [Soulmate](https://github.com/seatgeek/soulmate). It's MIT licensed.

data/lib/soulheart/config.rb

@@ -19,12 +19,17 @@ module Soulheart
       redis
     end
 
+    def jruby?
+      RUBY_ENGINE == 'jruby'
+    end
+
     # Returns the current Redis connection. If none has been created, will
     # create a new one.
     def redis
       @redis ||= (
         url = URI(@redis_url || ENV['REDIS_URL'] || 'redis://127.0.0.1:6379/0')
-        ::Redis.new(          # driver: :hiredis,
+        ::Redis.new(          # 
+          driver: (jruby? ? :ruby : :hiredis),
           host: url.host,
           port: url.port,
           db: url.path[1..-1],

data/lib/soulheart/loader.rb

@@ -49,7 +49,7 @@ module Soulheart
       redis.del(results_hashes_id)
     end
 
-    def clear(remove_results: false)
+    def clear(remove_results=false)
       category_combos.each {|cat| delete_data(category_id(cat)) }
       delete_categories
       delete_data
@@ -62,7 +62,7 @@ module Soulheart
       set_category_combos_array.each do |category_combo|
         items.each do |item|
           next unless category_combo.match(item['category']) || category_combo == 'all'
-          add_item(item, category_id(category_combo), cleaned: true) # send it base
+          add_item(item, category_id(category_combo), true) # send it base
         end
       end
     end
@@ -75,7 +75,7 @@ module Soulheart
         .merge item
     end
 
-    def add_item(item, category_base_id = nil, cleaned: false)
+    def add_item(item, category_base_id=nil, cleaned=false)
       unless cleaned
         item = clean(item)
         category_base_id ||= category_id(item['category'])

data/lib/soulheart/version.rb

@@ -1,3 +1,3 @@
 module Soulheart
-  VERSION = '0.0.8'
+  VERSION = '0.0.10'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soulheart
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.10
 platform: ruby
 authors:
 - Seth Herr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-24 00:00:00.000000000 Z
+date: 2015-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hiredis