bindi 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3919585e02b21afbf784dad9ddcc951a3e507576
-  data.tar.gz: 9d8cf3d10124d0c637cc212d52813f7c31ac1142
+  metadata.gz: 95a53ade2cb5e9748468fe43c4b23023202b6012
+  data.tar.gz: 1a2d77ff97563e5880fec8c4b0f0aafe191150b5
 SHA512:
-  metadata.gz: 21f5e5a41a62d5f1f42cb09aeb98b628fd761267b911b91314707c31710c3db23626b72f47064023c7ed30818e41f899968e114e1a44e6dbb0492afbd9bef27a
-  data.tar.gz: 40ac89024e1f56582bdaf9f27f278654b544889aa881ecbf0fc5857051e24183fe2c1cb834cf5e73ca80187bb1b39663b515c9e2df4db131d824974e5cf66a18
+  metadata.gz: 0db0612def5b52f23883933ece7c1875fd4af6f1198f199bfb3004ac16e94fa9013b34a5abdbb70971f8e2a5557d338940c611d5a856b73061c22e50fe8b887f
+  data.tar.gz: f34831006245cb6b17348a7e6418f22a9871e1e45b02ee31a80e5a915a2f2a5b4615d646fa3e38a1a369a2883f629d648279dc29e7ae49d2bffc3e037e729b4a

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Havenwood
+Copyright (c) 2014 Shannon Skipper
 
 MIT License
 

data/README.md

@@ -1,104 +1,102 @@
 # Bindi
+Persist your Ruby objects to [Redis](http://redis.io/)!
 
-[Bindi](https://github.com/havenwood/bindi#readme) makes it very, very simple to store native Ruby object in Redis!
+Bindi provides a simple Hash-like syntax for serializing and storing Ruby objects using the [redis](https://github.com/redis/redis-rb#readme) gem. Serialize with Marshal, YAML, JSON or your serializer of choice (as long as it supports #dump and #load methods).
 
-Bindi provides an easy to use Hash-like syntax for serializing Ruby objects with Marshal, YAML or JSON, and then persisting to [Redis](http://redis.io/) with the [redis gem](https://github.com/redis/redis-rb#readme).
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'bindi'
-
-Or install it yourself:
-
-    $ gem install bindi
-
-Then install Redis:
-
-    $ brew install redis
-	
-And start Redis:
- 
-    $ redis-server
-	
 ## Usage
-
-### The Basics
-
 ```ruby
 require 'bindi'
-require 'yaml'
 
-bindi = Bindi.new YAML # Choose between Marshal, YAML, JSON, etcetera for serializing.
+bindi = Bindi.new # Marshal is the default serializer.
 #=> #<Redis client v3.0.2 for redis://127.0.0.1:6379/0>
  
-bindi[:state_gemstones] = { alabama: 'Star Blue Quartz',
-                            alaska: 'Nephrite Jade', 
-                            arizona: 'Turquoise', 
-                            arkansas: 'Diamond' }
-							  
- #=> {:alabama=>"Star Blue Quartz", ...
-
+bindi[:state_gemstones] = {alabama: 'Star Blue Quartz',
+                           alaska: 'Nephrite Jade'}
 exit
 ```
 
-Your Ruby Object is now stored in Redis.
-
+Your Ruby Object is now stored in Redis:
 ```ruby
 require 'bindi'
 
-bindi = Bindi.new YAML
+bindi = Bindi.new
 #=> #<Redis client v3.0.2 for redis://127.0.0.1:6379/0>
 
-bindi.keys
- #=> "state_gemstones"
- 
 bindi[:state_gemstones]
- #=> #=> {:alabama=>"Star Blue Quartz", ...
+  #=> {:alabama=>"Star Blue Quartz", :alaska=>"Nephrite Jade"}
 ```
 
-### Ruby Hash Methods
-
+### Additional Hash-like methods:
 ```ruby
-bindi[:key] = 'value'
- #=> "value"
-
-bindi[:key]
- #=> "value"
+bindi.keys
+ #=> [:state_gemstones]
 
 bindi.key? :nope
  #=> false
 
-bindi.keys
- #=> [:key]
-
-bindi.delete :key
- #=> "value"
-
-bindi.clear # Flushes entire DB
- #=> []
+bindi.delete :state_gemstones
+ #=> {:alabama=>"Star Blue Quartz", :alaska=>"Nephrite Jade"}
 
 bindi.empty?
  #=> true
 ```
 
-### Redis Info
+### Alternative Serializers
+The default serializer is Marshal but you an alternative serializer can be specified when creating a new Bindi instance:
+```ruby
+require 'bindi'
+require 'json'
+
+bindi = Bindi.new JSON
+#=> #<Redis client v3.0.2 for redis://127.0.0.1:6379/0>
+```
 
+A serializer without #dump and #load methods, like [Message Pack](http://msgpack.org), can be used by implementing those methods:
 ```ruby
-bindi
- #=> #<Redis client v3.0.4 for redis://127.0.0.1:6379/0>
-
-bindi.info
- #=> {"redis_version"=>"2.6.14",
- "redis_git_sha1"=>"00000000",
- "redis_git_dirty"=>"0",
- "redis_mode"=>"standalone",
- ...}
+require 'bindi'
+require 'msgpack'
+
+module MessagePack
+  def self.dump(data)
+    pack(data)
+  end
+
+  def self.load(data)
+    unpack(data)
+  end
+end
+
+bindi = Bindi.new MessagePack
+#=> #<Redis client v3.0.4 for redis://127.0.0.1:6379/0>
 ```
+## Installation
+#### Install Bindi
 
-## Contributing
+    $ gem install bindi
+
+#### Install Redis
+Brew package:
+
+    `brew install redis`
 
+Apt-get package:
+
+    `sudo apt-get install redis-server`
+
+Or build from source:
+```bash
+wget http://download.redis.io/redis-stable.tar.gz
+tar xvzf redis-stable.tar.gz
+cd redis-stable
+make
+```
+
+Start Redis if it isn't running:
+
+    $ redis-server
+
+## Contributing
 1. Fork it
 2. Commit your changes
 3. Pull request
+4.  :cake: 

data/bindi.gemspec

@@ -14,7 +14,6 @@ Gem::Specification.new do |gem|
   gem.name          = 'bindi'
   gem.require_paths = ['lib']
   gem.version       = Bindi::VERSION
-  
-  gem.add_development_dependency 'redis'
+
   gem.add_runtime_dependency 'redis'
 end

data/lib/bindi.rb

@@ -45,6 +45,6 @@ class Bindi
   alias has_key key?
 
   def keys
-    @redis.keys.map &:to_sym
+    @redis.keys
   end
 end

data/lib/bindi/version.rb

@@ -1,3 +1,3 @@
 class Bindi
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,41 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: bindi
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Shannon Skipper
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-06 00:00:00.000000000 Z
+date: 2014-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
   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: redis
-  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'
 description: Persist your Ruby objects in Redis.
@@ -45,7 +31,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE
 - README.md
@@ -65,17 +51,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: Serialize and store Ruby object in Redis.