ssdb-attr 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2b52304c9d46396222d910c03ab4a3eb12d0210
-  data.tar.gz: 036af4b696a6ab5b733c71d01de9447303000ba7
+  metadata.gz: c2a68a5814ca537bb67770f14fb335ecb2fd8ab9
+  data.tar.gz: e42026f5032a122f2546d1c3da070203d9e12b97
 SHA512:
-  metadata.gz: bcee95b48f327fac5b65c582c89539c2c45a11e88b136e8084a229d5ed898e93bf4d1c0f472b05a68827acffb9ae25fd4a33f3ff04a4fcaf2972efb83305e2df
-  data.tar.gz: f66d638aead72c1de92caf614bb03d8d07c6358f59967fa9bb1c3b1835982fa26fd04c24d2922422506b15a900c46c3defcfc964983416aaa4b15f28371ee3c7
+  metadata.gz: 43fe05c73f91bd48dbdaf0c16113268561cee70e00e59460ed47d78626bc71637fb5978bbfbad5f0695f9ddf109c6b42d24fa5acebdf1759d30f6cde90cd47c6
+  data.tar.gz: 5470f3d596b29718a97dc3c83b4924ec9a5c238498943be5e8807aafae21f810643f984685e90a4201ec7f1438dfb6efe634c58114a09f7dda1f7b82f96cec1a

data/README.md

@@ -1 +1,3 @@
-# ssdb-attr
+# SSDB Attr
+
+This gem provides an intuitive interface to define attributes on your ActiveModel class and save them in SSDB server.

data/lib/ssdb-attr.rb

@@ -23,6 +23,13 @@ module SSDBAttr
     # `pool`: Pool size of the connection pool. Default to 1.
     # `timeout`: Timeout of the connection pool, in second, Default to 2.
     #
+    #  Examples:
+    #
+    # `SSDBAttr.setup({ :url => "redis://localhost:8888" })`: will setup a single pool to the SSDB instance `url` points to.
+    # `SSDBAttr.setup({ :url => "redis://localhost:8888", :name => :main })`: will setup a named single pool.
+    # `SSDBAttr.setup([ { :url => "redis://localhost:8888", :name => :pool1 }, { :url => "redis://localhost:6379", :name => :pool2 } ])`: will setup two named pools.
+    #
+    #
     # @param [Hash] options
     #
     # @return [void]

data/lib/ssdb-attr/version.rb

@@ -1,3 +1,3 @@
 module SSDBAttr
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/ssdb/attr.rb

@@ -26,6 +26,13 @@ module SSDB
         @ssdb_attr_id_field = field_name
       end
 
+      #
+      # Specify which SSDB ConnectionPool current class should use, by name specified in `SSDBAttr.setup`
+      #
+      # @param [String/Symbol] pool_name
+      #
+      # @return [String/Symbol]
+      #
       def ssdb_attr_pool(pool_name)
         @ssdb_attr_pool_name = pool_name
       end
@@ -86,6 +93,12 @@ module SSDB
 
     private
 
+    #
+    # Return the ConnectionPool used by current Class.
+    #
+    #
+    # @return [ConnectionPool]
+    #
     def ssdb_attr_pool
       SSDBAttr.pool(self.class.ssdb_attr_pool_name)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ssdb-attr
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Larry Zhao
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-03 00:00:00.000000000 Z
+date: 2017-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -192,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Provide simple helpers on persist values in redis for performance. Works