redis-helper 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9158b2e2f6026d24b0861d6a257f3edb475c1d03
-  data.tar.gz: 2646c37f2ef7d789b4b9714127298d132b78809f
+  metadata.gz: c2ca31e77c5ef65597d7c6a3d85645d01b82bf27
+  data.tar.gz: 24d3c3c8890f4838dacfdbb0136b1e4e4a22fafc
 SHA512:
-  metadata.gz: b8ba219bd493173ff38f407ac4fff7c41b865dbcf5cf3b5b33eaca06b428da05aa68909ecd605245ca1f8a2e4a98270af9a5c9777c8a5041cf2d5f9ab414e098
-  data.tar.gz: 5e8f455b382c4c332c26f64dfa1c7cceafc8b17fdc4d3e5bb26ad4341d2983b06a7e29d90794cd73d610e8a7c2519d42877700766f10aa937ea271e61174ff57
+  metadata.gz: 0af9c99539da831f765713ab402f0c5b7a21623a7cec03703c681f4ae28362f0e9e6ac691aa335918e37f4e816312bdd28a4cf772f0dbb221cc43443af86c1cd
+  data.tar.gz: 0a6a4a5de54c157ab64c9a1aca82ab8b5de5e8dbaa1474d94983b24723f0b6ae8951356848b8a157880459f03cda260fca2243a00df342fb4c2cbb57c16f3946

data/.travis.yml

@@ -1,5 +1,6 @@
-sudo: false
 language: ruby
 rvm:
   - 2.3.1
-before_install: gem install bundler -v 1.12.5
+services:
+  - redis-server
+cache: bundler

data/README.md

@@ -1,5 +1,12 @@
 # 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)
+[![Gemnasium](https://gemnasium.com/Narazaka/redis-helper.svg)](https://gemnasium.com/Narazaka/redis-helper)
+[![Inch CI](http://inch-ci.org/github/Narazaka/redis-helper.svg)](http://inch-ci.org/github/Narazaka/redis-helper)
+[![Travis Build Status](https://travis-ci.org/Narazaka/redis-helper.svg)](https://travis-ci.org/Narazaka/redis-helper)
+[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/Narazaka/redis-helper?svg=true)](https://ci.appveyor.com/project/Narazaka/redis-helper)
+
 Redisを扱うクラスで利用するモジュール
 
 Redis::Objectsがmulti使えないとかアレっていう [@i2bskn](https://github.com/i2bskn) さん等の想いのカケラ。

data/appveyor.yml

@@ -0,0 +1,31 @@
+version: "{build}"
+branches:
+  except:
+    - gh-pages
+install:
+  # redis
+  - nuget install redis-64 -excludeversion
+  - redis-64\tools\redis-server.exe --service-install
+  - redis-64\tools\redis-server.exe --service-start
+    # ruby
+  - set RUBY_HOME=C:\Ruby%ruby_version%
+  - set PATH=%RUBY_HOME%\bin;%PATH%
+  - |
+    %RUBY_HOME%\DevKit\devkitvars.bat
+  - ruby --version
+  - gem --version
+  - gem update --system
+  - gem install bundler --no-document
+  - bundle --version
+  - bundle config --local path vendor/bundle
+  - bundle install
+test_script:
+  - bundle exec rake spec
+build: off
+deploy: off
+environment:
+  matrix:
+    - ruby_version: 23
+    - ruby_version: 23-x64
+cache:
+  - vendor/bundle

data/bin/console

@@ -2,13 +2,6 @@
 
 require "bundler/setup"
 require "redis/helper"
+require "pry"
 
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start
+Pry.start

data/lib/redis/helper.rb

@@ -2,6 +2,7 @@ require "redis"
 require "active_support"
 require "active_support/core_ext/object/blank"
 require "active_support/core_ext/numeric/time"
+require "redis/helper/lock"
 require "redis/helper/version"
 
 # Redisを扱うクラスで利用するモジュール
@@ -30,11 +31,14 @@ class Redis
   module Helper
     # 正しくない固有キー(固有キー値が空?)
     class UnknownUniqueValue < StandardError; end
+    class LockTimeout < StandardError; end
 
     # デフォルトの固有キー名
     DEFAULT_UNIQUE_ATTR_NAME = :id
     # redisキーの区切り文字
     REDIS_KEY_DELIMITER = ":".freeze
+    # ロックを取得に利用する接尾辞
+    LOCK_POSTFIX = "lock".freeze
 
     def self.included(klass)
       klass.extend ClassMethods
@@ -57,6 +61,14 @@ class Redis
           end
         end
       end
+
+      # 特定のkeyをbaseにしたロックをかけてブロック内の処理を実行
+      # @param [String] base_key ロックを取得するリソースのkey
+      # @yield ロック中に実行する処理のブロック
+      def lock(base_key, &block)
+        lock_key = [base_key, LOCK_POSTFIX].compact.join(REDIS_KEY_DELIMITER)
+        ::Redis::Helper::Lock.new(redis, lock_key).lock(&block)
+      end
     end
 
     # instance固有のkeyとattr_nameからkeyを生成する
@@ -100,5 +112,16 @@ class Redis
     def redis
       self.class.redis
     end
+
+    # 特定のkeyをbaseにしたロックをかけてブロック内の処理を実行
+    # @example
+    #   lock(attr_key(:foo)) {
+    #     # some processing
+    #   }
+    # @param [String] base_key ロックを取得するリソースのkey
+    # @yield ロック中に実行する処理のブロック
+    def lock(base_key, &block)
+      self.class.lock(base_key, &block)
+    end
   end
 end

data/lib/redis/helper/lock.rb

@@ -0,0 +1,80 @@
+class Redis
+  module Helper
+    class Lock
+      # ロック取得のタイムアウト(sec)
+      DEFAULT_TIMEOUT = 5
+
+      def initialize(redis, lock_key, options = {})
+        @redis        = redis
+        @lock_key     = lock_key
+        @options      = options
+        @locked_by_self = false
+      end
+
+      # ロックをかけてブロック内の処理を実行
+      # @yield ロック中に実行する処理のブロック
+      def lock
+        raise ArgumentError unless block_given?
+        if Thread.current[@lock_key]
+          yield
+        else
+          begin
+            Thread.current[@lock_key] = true
+            try_lock!(Time.now.to_f)
+            yield
+          ensure
+            unlock
+            Thread.current[@lock_key] = nil
+          end
+        end
+      end
+
+      # ロックを開放
+      # (自身でかけたロックの場合のみ開放する)
+      def unlock
+        if @locked_by_self
+          @redis.del(@lock_key)
+          @locked_by_self = false
+        end
+      end
+
+      private
+        # ロックを取得
+        # @param [Float] start ロック取得開始時間のUNIXタイムスタンプ
+        # @yield ロック中に実行する処理のブロック
+        # @raise [Redis::Helper::LockTimeout] ロックの取得に失敗した
+        def try_lock!(start)
+          loop do
+            if @redis.setnx(@lock_key, expiration)
+              @locked_by_self = true
+              break
+            end
+
+            current = @redis.get(@lock_key).to_f
+            if current < Time.now.to_f
+              old = @redis.getset(@lock_key, expiration).to_f
+              if old < Time.now.to_f
+                @locked_by_self = true
+                break
+              end
+            end
+
+            Kernel.sleep(0.1)
+            raise ::Redis::Helper::LockTimeout if (Time.now.to_f - start) > timeout
+          end
+        end
+
+        # ロックの有効期限
+        # @return [Float] 有効期限(UNIXタイムスタンプ)
+        def expiration
+          (Time.now + timeout).to_f
+        end
+
+        # ロック取得と取得したロックがタイムアウトするまでの時間
+        # @return [Float] タイムアウト時間(sec)
+        def timeout
+          @timeout ||= (@options[:timeout] || DEFAULT_TIMEOUT).to_f
+        end
+    end
+  end
+end

data/lib/redis/helper/version.rb

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

data/redis-helper.gemspec

@@ -30,4 +30,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "yard"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "onkcop"
+  spec.add_development_dependency "pry"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-helper
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Narazaka
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-17 00:00:00.000000000 Z
+date: 2017-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
 description: 
 email:
 - info@narazaka.net
@@ -137,9 +151,11 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- appveyor.yml
 - bin/console
 - bin/setup
 - lib/redis/helper.rb
+- lib/redis/helper/lock.rb
 - lib/redis/helper/version.rb
 - redis-helper.gemspec
 homepage: https://github.com/Narazaka/redis-helper