soulheart 0.2.6 → 0.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +17 -8
  3. data/lib/soulheart/config.rb +1 -1
  4. data/lib/soulheart/version.rb +1 -1
  5. metadata +2 -34
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: df407f0c3c5f2585652ae42da30e5cbf7ad54827
4
- data.tar.gz: 35b7e98e2772fa4b5674fa95fec7489df9ef87e2
3
+ metadata.gz: 88b097f6348d3eda9dd77ed0088dabed84b29ca8
4
+ data.tar.gz: ecd740d965972c75fedd07c32dbd7bb80ba2ab44
5
5
  SHA512:
6
- metadata.gz: 562d4597850ae2b2e9c83228427dffaaf9333db21a8923522826466eaac838d008fe08434382e804e0b0f1a7f5883234a29b84dff07ae1d47e1465a38f37c249
7
- data.tar.gz: 45d6a5cec1d5feb44b666230905f068370f365dfdeca7f6a88d00eeb55548c3ba808b2bdfd1691ff2b74ec6ef38ede6955b6353a40d0e369798faafa5759c6b6
6
+ metadata.gz: e5513754551b3012ca2670bc565cbdbc266a26fb7227ee7b1c5d92fabc9bceff321a91f0d4e2edfd8ecc665507deb07e09b071d08d0b54cabebc2044c15a8d3e
7
+ data.tar.gz: 5c7e9b4e16ed48baab14a40067809eafe19662ef9e0229e734dcaee7e75f6b7f9ecf6436f2ad2088d6bc9e12327fefe96661830d83d562eba34d8261387204cd
data/README.md CHANGED
@@ -1,13 +1,14 @@
1
- # <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)
1
+ # <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)
2
2
 
3
3
  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.
4
4
 
5
- - [Demos](https://sethherr.github.io/soulheart/)
5
+ - [Intro page](https://sethherr.github.io/soulheart/)
6
6
  - [Usage documentation (commands)](https://sethherr.github.io/soulheart/commands/)
7
7
  - [Example data sources](https://github.com/sethherr/soulheart/tree/master/examples)
8
8
  - [Getting started](#getting-started)
9
9
  - [Deployment](#deployment)
10
10
  - [Testing](#testing)
11
+ - Example usage [with Selectize](https://sethherr.github.io/soulheart/examples_selectize) & [Select2](https://sethherr.github.io/soulheart/examples_select2)
11
12
 
12
13
 
13
14
  ## Features
@@ -29,7 +30,7 @@ Soulheart is a ready-to-use remote data source for autocomplete. The goal is to
29
30
 
30
31
  ## Getting started
31
32
 
32
- 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.
33
+ 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.
33
34
 
34
35
 
35
36
  ## Deployment
@@ -43,20 +44,28 @@ To update your Heroku deploy of Soulheart, use the [Heroku CLI](https://devcente
43
44
  heroku deploy -a NAME_OF_YOUR_APP_ON_HEROKU
44
45
 
45
46
 
46
- #### In a Rails app
47
+ ## In a Rails app
47
48
 
48
- Soulheart is a gem. Add it to your gemfile:
49
+ Soulheart is a gem. It uses [hiredis](https://github.com/redis/hiredis) on Ruby MRI. Add these lines to your gemfile:
49
50
 
50
51
  gem 'soulheart'
52
+ gem 'hiredis', '~> 0.6.0' # Skip using JRuby
53
+ gem 'redis', '>= 3.2.0', require: ['redis', 'redis/connection/hiredis'] # Skip if using JRuby
51
54
 
52
- And then put this in your routes.rb
55
+
56
+ And add this in your routes.rb:
53
57
 
54
58
  require 'soulheart/server'
55
- mount Soulheart::Server => "/soulhearts"
59
+
60
+ Rails.application.routes.draw do
61
+ # .... your application routes
62
+
63
+ mount Soulheart::Server => '/soulhearts'
64
+ end
56
65
 
57
66
  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.
58
67
 
59
- *note: 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.*
68
+ *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.*
60
69
 
61
70
  ##### Setting redis url
62
71
 
data/lib/soulheart/config.rb CHANGED
@@ -29,7 +29,7 @@ module Soulheart
29
29
  def redis
30
30
  @redis ||= (
31
31
  url = URI(@redis_url || ENV['REDIS_URL'] || 'redis://127.0.0.1:6379/0')
32
- ::Redis.new( #
32
+ ::Redis.new(
33
33
  driver: (jruby? ? :ruby : :hiredis),
34
34
  host: url.host,
35
35
  port: url.port,
data/lib/soulheart/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module Soulheart
2
- VERSION = '0.2.6'
2
+ VERSION = '0.3.0'
3
3
  end
metadata CHANGED
@@ -1,35 +1,15 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: soulheart
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.6
4
+ version: 0.3.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Seth Herr
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2016-03-23 00:00:00.000000000 Z
11
+ date: 2016-10-17 00:00:00.000000000 Z
12
12
  dependencies:
13
- - !ruby/object:Gem::Dependency
14
- name: hiredis
15
- requirement: !ruby/object:Gem::Requirement
16
- requirements:
17
- - - "~>"
18
- - !ruby/object:Gem::Version
19
- version: '0.4'
20
- - - ">="
21
- - !ruby/object:Gem::Version
22
- version: 0.4.5
23
- type: :runtime
24
- prerelease: false
25
- version_requirements: !ruby/object:Gem::Requirement
26
- requirements:
27
- - - "~>"
28
- - !ruby/object:Gem::Version
29
- version: '0.4'
30
- - - ">="
31
- - !ruby/object:Gem::Version
32
- version: 0.4.5
33
13
  - !ruby/object:Gem::Dependency
34
14
  name: redis
35
15
  requirement: !ruby/object:Gem::Requirement
@@ -54,9 +34,6 @@ dependencies:
54
34
  name: vegas
55
35
  requirement: !ruby/object:Gem::Requirement
56
36
  requirements:
57
- - - "~>"
58
- - !ruby/object:Gem::Version
59
- version: '0.1'
60
37
  - - ">="
61
38
  - !ruby/object:Gem::Version
62
39
  version: 0.1.0
@@ -64,9 +41,6 @@ dependencies:
64
41
  prerelease: false
65
42
  version_requirements: !ruby/object:Gem::Requirement
66
43
  requirements:
67
- - - "~>"
68
- - !ruby/object:Gem::Version
69
- version: '0.1'
70
44
  - - ">="
71
45
  - !ruby/object:Gem::Version
72
46
  version: 0.1.0
@@ -94,9 +68,6 @@ dependencies:
94
68
  name: sinatra
95
69
  requirement: !ruby/object:Gem::Requirement
96
70
  requirements:
97
- - - "~>"
98
- - !ruby/object:Gem::Version
99
- version: '1.4'
100
71
  - - ">="
101
72
  - !ruby/object:Gem::Version
102
73
  version: 1.4.4
@@ -104,9 +75,6 @@ dependencies:
104
75
  prerelease: false
105
76
  version_requirements: !ruby/object:Gem::Requirement
106
77
  requirements:
107
- - - "~>"
108
- - !ruby/object:Gem::Version
109
- version: '1.4'
110
78
  - - ">="
111
79
  - !ruby/object:Gem::Version
112
80
  version: 1.4.4