redis-helper 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2ca31e77c5ef65597d7c6a3d85645d01b82bf27
-  data.tar.gz: 24d3c3c8890f4838dacfdbb0136b1e4e4a22fafc
+  metadata.gz: 8a25173829de39977fc53a7cbce6d410ff4b0188
+  data.tar.gz: f76102b37decddc2368fc6b692947992f0084fc2
 SHA512:
-  metadata.gz: 0af9c99539da831f765713ab402f0c5b7a21623a7cec03703c681f4ae28362f0e9e6ac691aa335918e37f4e816312bdd28a4cf772f0dbb221cc43443af86c1cd
-  data.tar.gz: 0a6a4a5de54c157ab64c9a1aca82ab8b5de5e8dbaa1474d94983b24723f0b6ae8951356848b8a157880459f03cda260fca2243a00df342fb4c2cbb57c16f3946
+  metadata.gz: 10c3eb2925050978170f1e0c907b5f1e0f36a0139761ed6d176a46f10fde4afd3844bf900f8b74ca00a5616c9671e73387fd826f949cb4ca3342ac040633046a
+  data.tar.gz: 2c06e7904f645bc008725c1df941edc9855414c5d520f02e1ec96cdbed04cbf40224a6db397f6d4a1bc1e9cd3003963896bd299698f56ad22bf6f5c24c809411

data/README.md

@@ -1,4 +1,4 @@
-# Redis::Helper
+# [Redis::Helper](https://github.com/Narazaka/redis-helper)
 
 [![Gem](https://img.shields.io/gem/v/redis-helper.svg)](https://rubygems.org/gems/redis-helper)
 [![Gem](https://img.shields.io/gem/dtv/redis-helper.svg)](https://rubygems.org/gems/redis-helper)
@@ -29,6 +29,8 @@ Or install it yourself as:
 
 ## Usage
 
+[API Documents](http://www.rubydoc.info/gems/redis-helper/)
+
 ```ruby
 class Foo < ActiveRecord::Base
   include Redis::Helper

data/lib/redis/helper.rb

@@ -28,6 +28,7 @@ require "redis/helper/version"
 #   foo.bar_count => 10
 #
 class Redis
+  # redisのヘルパー
   module Helper
     # 正しくない固有キー(固有キー値が空?)
     class UnknownUniqueValue < StandardError; end

data/lib/redis/helper/lock.rb

@@ -1,9 +1,14 @@
 class Redis
   module Helper
+    # ロックの管理クラス
     class Lock
       # ロック取得のタイムアウト(sec)
       DEFAULT_TIMEOUT = 5
 
+      # @param [Redis] redis redisのインスタンス
+      # @param [String] lock_key ロックを保持するキー
+      # @param [Hash] options オプション
+      # @option options [Integer] timeout タイムアウト時間(sec)
       def initialize(redis, lock_key, options = {})
         @redis        = redis
         @lock_key     = lock_key

data/lib/redis/helper/version.rb

@@ -1,6 +1,6 @@
 class Redis
   module Helper
     # バージョン
-    VERSION = "1.2.0".freeze
+    VERSION = "1.2.1".freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis-helper
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Narazaka