cache_store_redis 0.4.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd69f7d92e6f813f3481e3282c27920ebb8e5ac8
-  data.tar.gz: 564d1e71c9e8979269eca486eb07505efafdea5d
+  metadata.gz: 5f09f961f03ff2ebfa552c67f2cd8e68ca90d4d7
+  data.tar.gz: edbcce0a3fb317ae7a1e3659d6edd5c524141cf4
 SHA512:
-  metadata.gz: d33040844b967f87fc44914634b22fffd00682745bbcd664c4d71c3ecdc99c7723203075e86265418b6ae6b4dc3e67ed653b28a9bae2da789c2f1c0a96fe621f
-  data.tar.gz: 1b4a1fea76014580a58b6889c2ba7b721319142ec1364da8bccc336b20e8c1cab942d88d6829524d16499d3326ec8d6652f6359d067cedb5c01b5923ae388120
+  metadata.gz: 84bd996123e42b669a1c2851d8cc4e83e8181b285e10217ce15a560ac8cc65a5c015a40b58b2a63161e8b6e98c27ff499043f3943c5bcb49b1e3d30d769d6096
+  data.tar.gz: 1a5ddbd79f7da39d5249b1a298414ee5d0330b0e8110400d4b4d65f3d52b5b0576c67226c8b4c80c3f9a360ea83e869e4d59cedf102caf5cf85ab4ed3f9fa5f9

data/lib/cache_store_redis/version.rb

@@ -1,3 +1,3 @@
 module CacheStoreRedis
-  VERSION = '0.4.4'
+  VERSION = '0.5.0'
 end

data/lib/cache_store_redis.rb

@@ -1,117 +1,159 @@
+# frozen_string_literal: true
+
+require 'thread'
 require 'cache_store_redis/version'
 require 'redis'
 require 'securerandom'
-require 'connection_pool'
 
-#This class is used to implement a redis cache store.
-#This class is used for interacting with a redis based cache store.
+# This class is used to implement a redis cache store.
 class RedisCacheStore
-
-  def self.pool(config)
-    @pool ||= ConnectionPool.new(size: pool_size, timeout: pool_timeout) do
-      if config == nil
-        Redis.new
-      else
-        Redis.new(config)
-      end
+  def initialize(namespace = nil, config = nil)
+    unless RUBY_PLATFORM == 'java'
+      require 'oj'
     end
-  end
 
-  def self.pool_size
-    @pool_size ||= Integer(ENV['CACHE_STORE_POOL_SIZE'] || 20)
-  end
+    @namespace = namespace
+    @config = config
+    @queue = Queue.new
 
-  def self.pool_timeout
-    @pool_size ||= Integer(ENV['CACHE_STORE_POOL_TIMEOUT'] || 1)
+    @connections_created = 0
+    @connections_in_use = 0
+    @mutex = Mutex.new
+    @enable_stats = false
   end
 
-  def initialize(namespace = nil, config = nil)
+  def enable_stats=(value)
+    @enable_stats = value
+  end
 
-    if RUBY_PLATFORM != 'java'
-      require 'oj'
+  def increment_created_stat
+    @mutex.synchronize do
+      @connections_created += 1
     end
+  end
 
-    @namespace = namespace
-    @config = config
+  def increment_using_stat
+    @mutex.synchronize do
+      @connections_in_use += 1
+    end
   end
 
-  def with_client
-    if self.class.pool_size > 0
-      self.class.pool(@config).with(timeout: self.class.pool_timeout) do |client|
-        raise 'nil redis client returned from pool' if client.nil?
-        yield client
-      end
-    else
-      # allow single client to be used when pool size is zero
-      @client ||= Redis.new(@config)
-      yield @client
+  def decrement_using_stat
+    @mutex.synchronize do
+      @connections_in_use -= 1
     end
   end
 
-  #This method is called to configure the connection to the cache store.
-  def configure(host = 'localhost', port = 6379, db = 'default', password = nil, driver: nil, url: nil)
-    if url != nil
+  # This method is called to configure the connection to the cache store.
+  def configure(host = 'localhost',
+                port = 6379,
+                db = 'default',
+                password = nil,
+                driver: nil,
+                url: nil,
+                connect_timeout: 0.5,
+                read_timeout: 1,
+                write_timeout: 0.5)
+    if !url.nil?
       @config = {}
       @config[:url] = url
       @config[:db] = db
     else
-      @config = { :host => host, :port => port, :db => db }
+      @config = { host: host, port: port, db: db }
     end
-    if password != nil
-      @config[:password] = password
+
+    @config[:password] = password unless password .nil?
+    @config[:driver] = driver unless driver.nil?
+
+    @config[:connect_timeout] = connect_timeout
+    @config[:read_timeout] = read_timeout
+    @config[:write_timeout] = write_timeout
+  end
+
+  def fetch_client
+    begin
+      @queue.pop(true)
+    rescue
+      increment_created_stat
+      Redis.new(@config)
+    end
+  end
+
+  def clean
+    while @queue.length.positive?
+      client = @queue.pop(true)
+      client.close
     end
-    if driver != nil
-      @config[:driver] = driver
+  end
+
+  def log_stats
+    return unless @enable_stats == true
+    S1Logging.logger.debug do
+      "[#{self.class}] - REDIS Connection Stats. Process: #{Process.pid} | " \
+"Created: #{@connections_created} | Pending: #{@queue.length} | In use: #{@connections_in_use}"
+    end
+  end
+
+  def with_client
+    log_stats
+    begin
+      client = fetch_client
+      increment_using_stat
+      log_stats
+      yield client
+    ensure
+      @queue.push(client)
+      decrement_using_stat
+      log_stats
     end
   end
 
-  #This method is called to set a value within this cache store by it's key.
+  # This method is called to set a value within this cache store by it's key.
   #
   # @param key [String] This is the unique key to reference the value being set within this cache store.
   # @param value [Object] This is the value to set within this cache store.
   # @param expires_in [Integer] This is the number of seconds from the current time that this value should expire.
   def set(key, value, expires_in = 0)
-    v = nil
     k = build_key(key)
 
-    if value != nil
-      v = serialize(value)
-    end
+    v = if value.nil?
+          nil
+        else
+          serialize(value)
+        end
 
     with_client do |client|
       client.multi do
         client.set(k, v)
 
-        if expires_in > 0
-          client.expire(k, expires_in)
-        end
+        client.expire(k, expires_in) if expires_in.positive?
       end
     end
-
   end
 
-  #This method is called to get a value from this cache store by it's unique key.
+  # This method is called to get a value from this cache store by it's unique key.
   #
   # @param key [String] This is the unique key to reference the value to fetch from within this cache store.
-  # @param expires_in [Integer] This is the number of seconds from the current time that this value should expire. (This is used in conjunction with the block to hydrate the cache key if it is empty.)
-  # @param &block [Block] This block is provided to hydrate this cache store with the value for the request key when it is not found.
+  # @param expires_in [Integer] This is the number of seconds from the current time that this value should expire.
+  # (This is used in conjunction with the block to hydrate the cache key if it is empty.)
+  # @param &block [Block] This block is provided to hydrate this cache store with the value for the request key
+  # when it is not found.
   # @return [Object] The value for the specified unique key within the cache store.
   def get(key, expires_in = 0, &block)
-
     k = build_key(key)
 
     value = with_client do |client|
       client.get(k)
     end
 
-    value = deserialize(value) unless value == nil
+    value = deserialize(value) unless value.nil?
 
     if value.nil? && block_given?
       value = yield
       set(k, value, expires_in)
     end
 
-    return value
+    value
   end
 
   # This method is called to remove a value from this cache store by it's unique key.
@@ -142,7 +184,6 @@ class RedisCacheStore
     end
   end
 
-
   private
 
   def serialize(object)
@@ -162,13 +203,10 @@ class RedisCacheStore
   end
 
   def build_key(key)
-    k = ''
-    if @namespace != nil
-      k = @namespace + ':' + key.to_s
-    elsif
-      k = key.to_s
+    if !@namespace.nil?
+      @namespace + ':' + key.to_s
+    else
+      key.to_s
     end
-    k
   end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cache_store_redis
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.0
 platform: ruby
 authors:
 - vaughanbrittonsage
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-04 00:00:00.000000000 Z
+date: 2018-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,20 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: connection_pool
-  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'
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement