redlock_for_collection 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f133882c52150f7dba3d271668ba56b88bedc970
+  data.tar.gz: 4830986378d7e3e8bb15805dc229f62012f92056
+SHA512:
+  metadata.gz: 5212c1c6fa3079d54cc3c6ea9d4c39d9efcf8b63a4c1715146078f47ff02aa8e94fe35971a0a57c81b9934f09019e72da52af97c98c3c3d33943eb4f40ee7c39
+  data.tar.gz: 1d42a75e9c9dbd42d80665849c513e8e5c799ee26f64f6f15a3e46820f98e28caf3371cf819a5be4fd9c5a6740e9d38415c484c037fd2028a831392d313b318d

data/.codeclimate.yml

@@ -0,0 +1,17 @@
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+  reek:
+    enabled: true
+ratings:
+  paths:
+  - "**.rb"
+exclude_paths:
+- test/

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/

data/.reek

@@ -0,0 +1,12 @@
+---
+IrresponsibleModule:
+  enabled: false
+
+TooManyStatements:
+  max_statements: 15
+
+### Excluding directories
+
+# Directories below will not be scanned at all
+exclude_paths:
+  - test

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+cache: bundler
+services:
+  - redis-server
+addons:
+  code_climate:
+    repo_token: b035b032138b99f091cb122d4e7c75c045f40e9aca3a338399712156e51f2f9b

data/Gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in redlock_manager.gemspec
+gemspec
+
+
+gem 'connection_pool'
+gem 'redlock'
+
+group :development do
+  gem 'reek'
+  gem 'rubocop'
+end
+
+group :test do
+  gem 'minitest'
+  gem 'codeclimate-test-reporter'
+end

data/README.md

@@ -0,0 +1,78 @@
+[![Build Status](https://travis-ci.org/CoolElvis/redlock_for_collection.svg?branch=master)](https://travis-ci.org/CoolElvis/redlock_for_collection)
+[![Code Climate](https://codeclimate.com/github/CoolElvis/redlock_for_collection/badges/gpa.svg)](https://codeclimate.com/github/CoolElvis/redlock_for_collection)
+[![Test Coverage](https://codeclimate.com/github/CoolElvis/redlock_for_collection/badges/coverage.svg)](https://codeclimate.com/github/CoolElvis/redlock_for_collection/coverage)
+[![Issue Count](https://codeclimate.com/github/CoolElvis/redlock_for_collection/badges/issue_count.svg)](https://codeclimate.com/github/CoolElvis/redlock_for_collection)
+# RedlockForCollection
+
+This is just a [Redlock](http://redis.io/topics/distlock) wrapper for collection of objects. 
+
+Also it used a connection pool for restrict the redis connections. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redlock_for_collection'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redlock_for_collection
+
+## Usage
+
+```ruby
+collection_manager = RedlockForCollection::Manager.new
+options = { key_method: :to_s, , key_prefix: 'pref', ttl: 20_000, min_validity: 10_00}
+
+collection_manager.with_lock(objects, options: options) do |locked_objects, unlocked_objects|
+    ... do some things with locked_objects
+    ... do some things with unlocked_objects
+end
+```
+#### options
++ `:ttl` time to live of lock.
++ `:key_method` invoked on `object` of `objects_collection` to generate shared key.
++ `:key_prefix` prepended to the shared key 
++ if lock validity < `:min_validity` then lock is treated as expired 
++ `locked_objects` is successfully locked objects of collections
++ `unlocked_objects` is unsuccessfully locked objects of collections for any reasons
+
+### Configuration 
+ 
+```ruby
+collection_manager = RedlockForCollection::Manager.new
+
+collection_manager.configure do |configuration|
+   config.pool_size = 2
+   config.redis_urls = ['redis://localhost:6379']
+   config.retry_delay = 2
+   config.retry_count = 2
+end
+```
+
+Also you can provide a pool 
+  
+```ruby  
+manager = RedlockForCollection::Manager.new
+redlock_pool = ConnectionPool.new { Redlock::Client.new([redis_urls]) }
+
+manager.configure do |configuration|
+  config.pool = redlock_pool
+end
+```
+ 
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/CoolElvis/redlock_for_collection.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/*.rb']
+  t.verbose = true
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "redlock_for_collection"
+
+# 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

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/redlock_for_collection/collection.rb

@@ -0,0 +1,72 @@
+module RedlockForCollection
+  class Collection
+    DEFAULT_TTL = 10_000
+    DEFAULT_MIN_VALIDITY = 5_000
+    DEFAULT_KEY_METHOD = 'key'.freeze
+    DEFAULT_KEY_PREFIX = 'prefix'.freeze
+
+    attr_reader :objects, :options, :pool
+
+    def initialize(objects, options, pool)
+      @objects = objects
+      @options = options
+      @pool    = pool
+
+      init_options
+    end
+
+
+    def lock(&block)
+      locked_objects   = []
+      unlocked_objects = []
+
+      locks_info         = []
+      expired_locks_info = []
+
+      @objects.each do |object|
+        @pool.with do |redlock|
+          lock_info = redlock.lock(build_key_for(object), @options[:ttl])
+
+          # Check if ttl is enough
+          if lock_info && (lock_info[:validity] > (@options[:min_validity]))
+            locked_objects << object
+            locks_info     << lock_info
+          else
+            expired_locks_info << lock_info if lock_info
+            unlocked_objects   << object
+          end
+        end
+      end
+
+      begin
+        block.yield(locked_objects, unlocked_objects)
+      ensure
+        # Release the all acquired locks
+        unlock(expired_locks_info)
+        unlock(locks_info)
+      end
+    end
+
+
+    protected
+
+    def unlock(locks_info)
+      @pool.with do |redlock|
+        locks_info.each { |lock_info| redlock.unlock(lock_info) }
+      end
+    end
+
+    def init_options
+      @options[:key_prefix]   ||= DEFAULT_KEY_PREFIX
+      @options[:key_method]   ||= DEFAULT_KEY_METHOD
+      @options[:min_validity] ||= DEFAULT_MIN_VALIDITY
+      @options[:ttl]          ||= DEFAULT_TTL
+    end
+
+    def build_key_for(object)
+      (@options[:key_prefix]) + object.send(@options[:key_method]).to_s
+    end
+
+  end
+end
+

data/lib/redlock_for_collection/configuration.rb

@@ -0,0 +1,33 @@
+require 'connection_pool'
+require 'redlock'
+
+module RedlockForCollection
+  class Configuration
+    attr_accessor :pool_size,
+                  :pool_timeout,
+                  :redis_urls,
+                  :retry_delay,
+                  :retry_count,
+                  :pool
+
+    def initialize
+      @pool_size    = 5
+      @pool_timeout = 5
+      @redis_urls   = ['redis://localhost:6379']
+      @retry_delay  = 5
+      @retry_count  = 5
+      @pool         = nil
+    end
+
+
+    def pool
+      @pool|| begin
+        @pool = ConnectionPool.new(size: @pool_size, timeout: @pool_timeout) do
+          Redlock::Client.new(@redis_urls, retry_delay: @retry_delay, retry_count: @retry_count)
+        end
+      end
+    end
+
+  end
+end
+

data/lib/redlock_for_collection/version.rb

@@ -0,0 +1,3 @@
+module RedlockForCollection
+  VERSION = '0.1.0'.freeze
+end

data/lib/redlock_for_collection.rb

@@ -0,0 +1,50 @@
+require_relative 'redlock_for_collection/version'
+require_relative 'redlock_for_collection/configuration'
+require_relative 'redlock_for_collection/collection'
+
+module RedlockForCollection
+  class Manager
+    attr_reader :configuration
+
+    def initialize
+      @configuration = Configuration.new
+
+      yield @configuration if block_given?
+    end
+
+    # @example
+    #  configure do |configuration|
+    #      config.pool_size = 2
+    #      config.redis_urls = ['redis://localhost:6379']
+    #      config.retry_delay = 2
+    #      config.retry_count = 2
+    #  end
+    #
+    # redlock_pool = ConnectionPool.new { Redlock::Client.new([redis_urls]) }
+    #
+    # configure do |configuration|
+    #   config.pool = redlock_pool
+    # end
+    #
+    # @yield [Configuration]
+    def configure(&block)
+      block.yield @configuration
+    end
+
+
+    # @param objects_collection [#each]
+    # @param options [Hash], consist of `:key_prefix`, `:key_method`, `:min_validity`, `:ttl`
+    # `:key_method` invoked on `object` of `objects_collection` to generate shared key.
+    # `:key_prefix` prepended to the shared key
+    # if lock validity < `:min_validity` then lock is treated as expired
+    # @yield [locked_objects, unlocked_objects]
+    # `locked_objects` is successfully locked objects of collections
+    # `unlocked_objects` is unsuccessfully locked objects of collections for any reasons
+    def with_lock(objects_collection, options: {}, &block)
+      collection = Collection.new(objects_collection, options, @configuration.pool)
+
+      collection.lock(&block)
+    end
+  end
+end
+

data/redlock_for_collection.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redlock_for_collection/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'redlock_for_collection'
+  spec.version       = RedlockForCollection::VERSION
+  spec.authors       = ['CoolElvis']
+  spec.email         = ['elvisplus2@gmail.com']
+
+  spec.summary       = %q{This is just a Redlock wrapper for collection of objects.}
+  spec.description   = %q{This is just a Redlock wrapper for collection of objects. Also it used a connection pool for restrict the redis connections.}
+  spec.homepage      = 'https://github.com/CoolElvis/redlock_for_collection'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'connection_pool', '~> 2.2.0'
+  spec.add_development_dependency 'redlock', '~> 0.1.1'
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: redlock_for_collection
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- CoolElvis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: redlock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+description: This is just a Redlock wrapper for collection of objects. Also it used
+  a connection pool for restrict the redis connections.
+email:
+- elvisplus2@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".reek"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/redlock_for_collection.rb
+- lib/redlock_for_collection/collection.rb
+- lib/redlock_for_collection/configuration.rb
+- lib/redlock_for_collection/version.rb
+- redlock_for_collection.gemspec
+homepage: https://github.com/CoolElvis/redlock_for_collection
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: This is just a Redlock wrapper for collection of objects.
+test_files: []
+has_rdoc: