module LightRedisCache

Constants

VERSION

Attributes

socket[RW]

Public Class Methods

clear() click to toggle source

Clear database

@return [void] @see redis.io/commands/flushall FLUSHALL command

# File lib/light_redis_cache.rb, line 129
def clear
  open_socket
  @socket.puts("FLUSHALL")
  close_socket
end

configuration() click to toggle source

# File lib/light_redis_cache.rb, line 15
def configuration
  @configuration ||= LightRedisCache::Configuration.new
end

configure() { |configuration| ... } click to toggle source

# File lib/light_redis_cache.rb, line 11
def configure
  yield(configuration)
end

delete(keys) click to toggle source

Delete keys

@param [Array] keys @return [void] @see redis.io/commands/del DEL command

# File lib/light_redis_cache.rb, line 113
def delete keys
  open_socket
  request = ""
  request_length = 0
  keys.each do |key|
    request.insert(-1, "$#{ key.length }\r\n#{ key }\r\n")
    request_length +=1
  end
  @socket.write("*#{ request_length + 1 }\r\n$3\r\nDEL\r\n#{ request }")
  close_socket
end

delete_matched(matcher) click to toggle source

Remove keys corresponding to matcher

@param [String] matcher @return [void, nil]

# File lib/light_redis_cache.rb, line 69
def delete_matched matcher
  matched_keys = get_matched_keys matcher

  delete matched_keys if matched_keys
end

fetch(key, expires_in: 86400, &block) click to toggle source

Get the value of a key. If the key does not exist, call a block, set the result and return it

@param [String] key @param [Integer] expires_in - default value : 86400 seconds (1 day) @param [Proc] block @return [void]

# File lib/light_redis_cache.rb, line 54
def fetch key, expires_in: 86400, &block
  result = get(key)
  if result == nil
    value = block.call
    set(key, value, expires_in: expires_in)
    value
  else
    result
  end
end

get(key) click to toggle source

Get the value of a key

@param [String] key @return [String, Integer, Array, Hash] value @see redis.io/commands/get GET command

# File lib/light_redis_cache.rb, line 24
def get key
  open_socket
  @socket.write("*2\r\n$3\r\nGET\r\n$#{ key.length }\r\n#{ key }\r\n")
  value = @socket.gets == "$-1\r\n" ? nil : JSON.parse((@socket.gets).gsub("\r\n", "").force_encoding("iso-8859-1").encode!("utf-8"))
  close_socket
  value
end

get_matched_keys(matcher) click to toggle source

Get keys corresponding to matcher

Supported glob-style patterns:

h?llo matches hello, hallo and hxllo h*llo matches hllo and heeeello hllo matches hello and hallo, but not hillo hllo matches hallo, hbllo, … but not hello hllo matches hallo and hbllo

@param [String] matcher @return [Array<String>] @see redis.io/commands/keys KEYS command

# File lib/light_redis_cache.rb, line 88
def get_matched_keys matcher
  open_socket
  @socket.puts("KEYS #{ matcher }")
  first_result = @socket.gets

  if first_result.include?("*")
    matched_keys_number = first_result.gsub("*", "").gsub("\r\n", "").to_i
    keys = []
    (1..(matched_keys_number*2)).collect do |index|
      if index.even?
        keys.push((@socket.gets).gsub("\r\n", ""))
      else
        @socket.gets
      end
    end
  end
  close_socket
  keys
end

set(key, value, expires_in: 86400) click to toggle source

Set key to hold the value

@param [String] key @param [String, Integer, Array, Hash] value @param [Integer] expires_in - default value : 86400 seconds (1 day) @return [nil] @see redis.io/commands/set SET command

# File lib/light_redis_cache.rb, line 39
def set key, value, expires_in: 86400
  open_socket
  value = value.to_json.encode("iso-8859-1").force_encoding("utf-8")
  @socket.write("*3\r\n$3\r\nSET\r\n$#{ key.length }\r\n#{ key }\r\n$#{ value.length }\r\n#{ value }\r\n")
  @socket.write("*3\r\n$6\r\nEXPIRE\r\n$#{ key.length }\r\n#{ key }\r\n$#{ expires_in.to_s.length }\r\n#{ expires_in }\r\n")
  close_socket
end

Private Class Methods

close_socket() click to toggle source

# File lib/light_redis_cache.rb, line 141
def close_socket
  @socket.close
end

open_socket() click to toggle source

# File lib/light_redis_cache.rb, line 137
def open_socket
  @socket = TCPSocket.new(@configuration.hostname, @configuration.port)
end