chimera 0.0.1

data/lib/chimera/persistence.rb

@@ -0,0 +1,70 @@
+module Chimera
+  module Persistence
+    def self.included(base)
+      base.send :extend, ClassMethods
+      base.send :include, InstanceMethods
+    end
+    
+    module ClassMethods
+    end # ClassMethods
+    
+    module InstanceMethods
+      def new?
+        @new == true
+      end
+
+      def save
+        raise(Chimera::Error::SaveWithoutId) unless self.id
+        raise(Chimera::Error::ValidationErrors) unless self.valid?
+        check_index_constraints
+        
+        if new?
+          _run_create_callbacks do
+            _run_save_callbacks do
+              save_without_callbacks
+              create_indexes
+            end
+          end
+        else
+          _run_save_callbacks do
+            destroy_indexes
+            save_without_callbacks
+            create_indexes
+          end
+        end
+        
+        true
+      end
+      
+      alias :create :save
+      
+      def vector_clock
+        if @riak_response and @riak_response.headers_hash
+          return @riak_response.headers_hash["X-Riak-Vclock"]
+        end; nil
+      end
+      
+      def save_without_callbacks
+        @riak_response = self.class.connection(:riak_raw).store(
+          self.class.bucket_key,
+          self.id, 
+          YAML.dump(@attributes),
+          self.vector_clock)
+
+        @orig_attributes = @attributes.clone
+        @new = false
+      end
+
+      def destroy
+        _run_destroy_callbacks do
+          @riak_response = self.class.connection(:riak_raw).delete(self.class.bucket_key, self.id)
+          destroy_indexes
+          association_memberships.destroy
+          destroy_associations
+          destroy_redis_objects
+          freeze
+        end
+      end
+    end # InstanceMethods
+  end
+end

data/lib/chimera/redis_objects.rb

@@ -0,0 +1,345 @@
+module Chimera
+  module RedisObjects
+    def self.included(base)
+      base.send :extend, ClassMethods
+      base.send :include, InstanceMethods
+    end
+    
+    module ClassMethods
+      def defined_redis_objects
+        @defined_redis_objects || {}
+      end
+
+      # available types include:
+      #   string, set, zset, list, counter
+      def redis_object(name, type = :string, extra_opts={})
+        @defined_redis_objects ||= {}
+        @defined_redis_objects[name.to_sym] = [type, extra_opts]
+        define_method("#{name}") do
+          @redis_objects ||= {}
+          case type
+          when :string then
+            @redis_objects[name.to_sym] = Chimera::RedisObjectProxy::String.new(self, name, extra_opts)
+          when :set then
+            @redis_objects[name.to_sym] = Chimera::RedisObjectProxy::Set.new(self, name, extra_opts)
+          when :zset then
+            @redis_objects[name.to_sym] = Chimera::RedisObjectProxy::ZSet.new(self, name, extra_opts)
+          when :list then
+            @redis_objects[name.to_sym] = Chimera::RedisObjectProxy::List.new(self, name, extra_opts)
+          when :counter then
+            @redis_objects[name.to_sym] = Chimera::RedisObjectProxy::Counter.new(self, name, extra_opts)
+          end
+        end
+      end
+    end # ClassMethods
+    
+    module InstanceMethods
+      def destroy_redis_objects
+        (@redis_objects || {}).each do |name, redis_obj|
+          redis_obj.destroy
+        end
+      end
+    end # InstanceMethods
+  end
+  
+  module RedisObjectProxy
+    class Base
+      attr_accessor :owner, :name, :extra_opts
+      def initialize(owner, name, extra_opts)
+        unless owner and owner.id
+          raise(Chimera::Errors::MissingId)
+        end
+        
+        @owner = owner
+        @name = name
+        @extra_opts = extra_opts
+      end
+      
+      def connection
+        self.owner.class.connection(:redis)
+      end
+      
+      def key
+        "#{self.class.to_s}::RedisObjects::#{name}::#{self.owner.id}"
+      end
+      
+      def destroy
+        connection.del(self.key)
+      end
+      
+      def encode(val)
+        YAML.dump(val)
+      end
+      
+      def decode(val)
+        return nil if val.nil?
+        return "" if val == ""
+        YAML.load(val)
+      end
+    end
+    
+    class Collection < Base
+      def sort(opts={})
+        cmd = [self.key]
+        cmd << "BY #{opts[:by_pattern]}" if opts[:by_pattern]
+        if opts[:limit]
+          start, count = opts[:limit]
+          cmd << "LIMIT #{start} #{count}" if start && count
+        end
+        cmd << "GET #{opts[:get_pattern]}" if opts[:get_pattern]
+        cmd << opts[:order] if opts[:order]
+        cmd << "ALPHA" if opts[:alpha] == true
+        cmd << "STORE #{opts[:dest_key]}" if opts[:dest_key]
+        connection.sort(self.key, cmd.join(" "))
+      end
+    end
+    
+    class String < Base
+      def set(val)
+        connection.set(self.key, encode(val))
+      end
+      
+      def get
+        decode(connection.get(self.key))
+      end
+    end
+    
+    class Set < Collection
+      def add(val)
+        connection.sadd(self.key, encode(val))
+      end
+      
+      def <<(val)
+        add(val)
+      end
+      
+      def rem(val)
+        connection.srem(self.key, encode(val))
+      end
+      
+      def pop
+        decode connection.spop(self.key)
+      end
+      
+      def move(val, dest_set_key)
+        connection.smove(self.key, dest_set_key, encode(val))
+      end
+      
+      def card
+        connection.scard(self.key)
+      end
+      
+      alias :size :card
+      alias :count :card
+      
+      def ismember(val)
+        connection.sismember(self.key, encode(val))
+      end
+      
+      alias :is_member? :ismember
+      alias :include? :ismember
+      alias :includes? :ismember
+      alias :contains? :ismember
+      
+      def inter(*set_keys)
+        (connection.sinter(set_keys.join(" ")) || []).collect { |val| decode(val) }
+      end
+      
+      alias :intersect :inter
+      
+      def interstore(dest_key, *set_keys)
+        connection.sinterstore(dest_key, set_keys.join(" "))
+      end
+      
+      alias :intersect_and_store :interstore
+      
+      def union(*set_keys)
+        (connection.sunion(set_keys.join(" ")) || []).collect { |val| decode(val) }
+      end
+      
+      def unionstore(dest_key, *set_keys)
+        connection.sunionstore(dest_key, set_keys.join(" "))
+      end
+      
+      alias :union_and_store :unionstore
+      
+      def diff(*set_keys)
+        (connection.sdiff(set_keys.join(" ")) || []).collect { |val| decode(val) }
+      end
+      
+      def diffstore(dest_key, *set_keys)
+        connection.sdiffstore(dest_key, set_keys.join(" "))
+      end
+      
+      alias :diff_and_store :diffstore
+      
+      def members
+        (connection.smembers(self.key) || []).collect { |val| decode(val) }
+      end
+      
+      alias :all :members
+      
+      def randmember
+        decode connection.srandmember(self.key)
+      end
+      
+      alias :rand_member :randmember
+    end
+    
+    class ZSet < Collection
+      def add(val,score=0)
+        connection.zadd(self.key, score, encode(val))
+      end
+      
+      def rem(val)
+        connection.zrem(self.key, encode(val))
+      end
+      
+      def incrby(val, incr)
+        connection.zincrby(self.key, incr.to_f, encode(val))
+      end
+      
+      alias :incr_by :incrby
+      
+      def range(start_index, end_index, extra_opts={})
+        opts = [self.key, start_index.to_i, end_index.to_i]
+        opts << "WITHSCORES" if extra_opts[:with_scores] == true
+        (connection.zrange(opts) || []).collect { |val| decode(val) }
+      end
+      
+      def revrange(start_index, end_index, extra_opts={})
+        opts = [self.key, start_index.to_i, end_index.to_i]
+        opts << "WITHSCORES" if extra_opts[:with_scores] == true
+        (connection.zrevrange(opts) || []).collect { |val| decode(val) }
+      end
+      
+      alias :rev_range :revrange
+      
+      def rangebyscore(min, max, extra_opts={})
+        opts = [self.key, min.to_f, max.to_f]
+        offset, count = extra_opts[:limit]
+        if offset and count
+          opts << "LIMIT #{offset} #{count}"
+        end
+        opts << "WITHSCORES" if extra_opts[:with_scores] == true
+        (connection.zrangebyscore(opts) || []).collect { |val| decode(val) }
+      end
+      
+      alias :range_by_score :rangebyscore
+      
+      def remrangebyscore(min,max)
+        connection.zremrangebyscore(self.key,min.to_f,max.to_f)
+      end
+      
+      alias :rem_range_by_score :remrangebyscore
+      alias :remove_range_by_score :remrangebyscore
+      
+      def card
+        connection.zcard(self.key).to_i
+      end
+      
+      alias :size :card
+      alias :count :card
+      
+      def score(val)
+        connection.zscore(self.key, val).to_f
+      end
+    end
+    
+    class List < Collection
+      def rpush(val)
+        connection.rpush(self.key, encode(val))
+      end
+      
+      alias :right_push :rpush
+      
+      def <<(val)
+        rpush(val)
+      end
+      
+      def lpush(val)
+        connection.lpush(self.key, encode(val))
+      end
+      
+      alias :left_push :lpush
+      
+      def len
+        connection.len(self.key).to_i
+      end
+      
+      alias :size :len
+      alias :count :len
+      
+      def range(start_index, end_index)
+        (connection.lrange(self.key, start_index.to_i, end_index.to_i) || []).collect { |val| decode(val) }
+      end
+      
+      def trim(start_index, end_index)
+        connection.ltrim(self.key, start_index.to_i, end_index.to_i)
+      end
+      
+      def index(index)
+        decode connection.lindex(self.key, index.to_i)
+      end
+      
+      def [](index)
+        self.index(index)
+      end
+      
+      def set(index, val)
+        connection.lset(self.key, index.to_i, encode(val))
+      end
+      
+      def rem(val, count=0)
+        connection.lrem(self.key, count.to_i, encode(val))
+      end
+      
+      def lpop
+        decode connection.lpop(self.key)
+      end
+      
+      alias :left_pop :lpop
+      alias :pop :lpop
+      
+      def rpop
+        decode connection.rpop(self.key)
+      end
+      
+      alias :right_pop :rpop
+      
+      def rpoplpush(dest_key)
+        decode connection.rpoplpush(self.key, dest_key)
+      end
+      
+      alias :right_pop_left_push :rpoplpush
+    end
+    
+    class Counter < Base      
+      def incr
+        connection.incr(self.key).to_i
+      end
+      
+      def incrby(val)
+        connection.incrby(self.key,val.to_i).to_i
+      end
+      
+      alias :incr_by :incrby
+      
+      def decr
+        connection.decr(self.key).to_i
+      end
+      
+      def decrby(val)
+        connection.decrby(self.key, val.to_i).to_i
+      end
+      
+      def val
+        connection.get(self.key).to_i
+      end
+      
+      alias :count :val
+      
+      alias :decr_by :decrby
+    end
+  end
+end

data/lib/redis.rb

@@ -0,0 +1,373 @@
+require 'socket'
+require File.join(File.dirname(__FILE__),'redis/pipeline')
+
+begin
+  if RUBY_VERSION >= '1.9'
+    require 'timeout'
+    RedisTimer = Timeout
+  else
+    require 'system_timer'
+    RedisTimer = SystemTimer
+  end
+rescue LoadError
+  RedisTimer = nil
+end
+
+class Redis
+  OK      = "OK".freeze
+  MINUS    = "-".freeze
+  PLUS     = "+".freeze
+  COLON    = ":".freeze
+  DOLLAR   = "$".freeze
+  ASTERISK = "*".freeze
+
+  BULK_COMMANDS = {
+    "set"       => true,
+    "setnx"     => true,
+    "rpush"     => true,
+    "lpush"     => true,
+    "lset"      => true,
+    "lrem"      => true,
+    "sadd"      => true,
+    "srem"      => true,
+    "sismember" => true,
+    "echo"      => true,
+    "getset"    => true,
+    "smove"     => true,
+    "zadd"      => true,
+    "zincrby"   => true,
+    "zrem"      => true,
+    "zscore"    => true
+  }
+
+  MULTI_BULK_COMMANDS = {
+    "mset"      => true,
+    "msetnx"    => true
+  }
+
+  BOOLEAN_PROCESSOR = lambda{|r| r == 1 }
+
+  REPLY_PROCESSOR = {
+    "exists"    => BOOLEAN_PROCESSOR,
+    "sismember" => BOOLEAN_PROCESSOR,
+    "sadd"      => BOOLEAN_PROCESSOR,
+    "srem"      => BOOLEAN_PROCESSOR,
+    "smove"     => BOOLEAN_PROCESSOR,
+    "zadd"      => BOOLEAN_PROCESSOR,
+    "zrem"      => BOOLEAN_PROCESSOR,
+    "move"      => BOOLEAN_PROCESSOR,
+    "setnx"     => BOOLEAN_PROCESSOR,
+    "del"       => BOOLEAN_PROCESSOR,
+    "renamenx"  => BOOLEAN_PROCESSOR,
+    "expire"    => BOOLEAN_PROCESSOR,
+    "keys"      => lambda{|r| r.split(" ")},
+    "info"      => lambda{|r|
+      info = {}
+      r.each_line {|kv|
+        k,v = kv.split(":",2).map{|x| x.chomp}
+        info[k.to_sym] = v
+      }
+      info
+    }
+  }
+
+  ALIASES = {
+    "flush_db"             => "flushdb",
+    "flush_all"            => "flushall",
+    "last_save"            => "lastsave",
+    "key?"                 => "exists",
+    "delete"               => "del",
+    "randkey"              => "randomkey",
+    "list_length"          => "llen",
+    "push_tail"            => "rpush",
+    "push_head"            => "lpush",
+    "pop_tail"             => "rpop",
+    "pop_head"             => "lpop",
+    "list_set"             => "lset",
+    "list_range"           => "lrange",
+    "list_trim"            => "ltrim",
+    "list_index"           => "lindex",
+    "list_rm"              => "lrem",
+    "set_add"              => "sadd",
+    "set_delete"           => "srem",
+    "set_count"            => "scard",
+    "set_member?"          => "sismember",
+    "set_members"          => "smembers",
+    "set_intersect"        => "sinter",
+    "set_intersect_store"  => "sinterstore",
+    "set_inter_store"      => "sinterstore",
+    "set_union"            => "sunion",
+    "set_union_store"      => "sunionstore",
+    "set_diff"             => "sdiff",
+    "set_diff_store"       => "sdiffstore",
+    "set_move"             => "smove",
+    "set_unless_exists"    => "setnx",
+    "rename_unless_exists" => "renamenx",
+    "type?"                => "type",
+    "zset_add"             => "zadd",
+    "zset_count"           => "zcard",
+    "zset_range_by_score"  => "zrangebyscore",
+    "zset_reverse_range"   => "zrevrange",
+    "zset_range"           => "zrange",
+    "zset_delete"          => "zrem",
+    "zset_score"           => "zscore",
+    "zset_incr_by"         => "zincrby",
+    "zset_increment_by"    => "zincrby"
+  }
+
+  DISABLED_COMMANDS = {
+    "monitor" => true,
+    "sync"    => true
+  }
+
+  def initialize(options = {})
+    @host    =  options[:host]    || '127.0.0.1'
+    @port    = (options[:port]    || 6379).to_i
+    @db      = (options[:db]      || 0).to_i
+    @timeout = (options[:timeout] || 5).to_i
+    @password = options[:password]
+    @logger  =  options[:logger]
+    @thread_safe = options[:thread_safe]
+    @mutex = Mutex.new if @thread_safe
+    @sock = nil
+
+    @logger.info { self.to_s } if @logger
+  end
+
+  def to_s
+    "Redis Client connected to #{server} against DB #{@db}"
+  end
+
+  def server
+    "#{@host}:#{@port}"
+  end
+
+  def connect_to_server
+    @sock = connect_to(@host, @port, @timeout == 0 ? nil : @timeout)
+    call_command(["auth",@password]) if @password
+    call_command(["select",@db]) unless @db == 0
+  end
+
+  def connect_to(host, port, timeout=nil)
+    # We support connect() timeout only if system_timer is availabe
+    # or if we are running against Ruby >= 1.9
+    # Timeout reading from the socket instead will be supported anyway.
+    if @timeout != 0 and RedisTimer
+      begin
+        sock = TCPSocket.new(host, port)
+      rescue Timeout::Error
+        @sock = nil
+        raise Timeout::Error, "Timeout connecting to the server"
+      end
+    else
+      sock = TCPSocket.new(host, port)
+    end
+    sock.setsockopt Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1
+
+    # If the timeout is set we set the low level socket options in order
+    # to make sure a blocking read will return after the specified number
+    # of seconds. This hack is from memcached ruby client.
+    if timeout
+      secs   = Integer(timeout)
+      usecs  = Integer((timeout - secs) * 1_000_000)
+      optval = [secs, usecs].pack("l_2")
+      begin
+        sock.setsockopt Socket::SOL_SOCKET, Socket::SO_RCVTIMEO, optval
+        sock.setsockopt Socket::SOL_SOCKET, Socket::SO_SNDTIMEO, optval
+      rescue Exception => ex
+        # Solaris, for one, does not like/support socket timeouts.
+        @logger.info "Unable to use raw socket timeouts: #{ex.class.name}: #{ex.message}" if @logger
+      end
+    end
+    sock
+  end
+
+  def method_missing(*argv)
+    call_command(argv)
+  end
+
+  def call_command(argv)
+    @logger.debug { argv.inspect } if @logger
+
+    # this wrapper to raw_call_command handle reconnection on socket
+    # error. We try to reconnect just one time, otherwise let the error
+    # araise.
+    connect_to_server if !@sock
+
+    begin
+      raw_call_command(argv.dup)
+    rescue Errno::ECONNRESET, Errno::EPIPE, Errno::ECONNABORTED
+      @sock.close rescue nil
+      @sock = nil
+      connect_to_server
+      raw_call_command(argv.dup)
+    end
+  end
+
+  def raw_call_command(argvp)
+    pipeline = argvp[0].is_a?(Array)
+
+    unless pipeline
+      argvv = [argvp]
+    else
+      argvv = argvp
+    end
+
+    if MULTI_BULK_COMMANDS[argvv.flatten[0].to_s]
+      # TODO improve this code
+      argvp   = argvv.flatten
+      values  = argvp.pop.to_a.flatten
+      argvp   = values.unshift(argvp[0])
+      command = ["*#{argvp.size}"]
+      argvp.each do |v|
+        v = v.to_s
+        command << "$#{get_size(v)}"
+        command << v
+      end
+      command = command.map {|cmd| "#{cmd}\r\n"}.join
+    else
+      command = ""
+      argvv.each do |argv|
+        bulk = nil
+        argv[0] = argv[0].to_s.downcase
+        argv[0] = ALIASES[argv[0]] if ALIASES[argv[0]]
+        raise "#{argv[0]} command is disabled" if DISABLED_COMMANDS[argv[0]]
+        if BULK_COMMANDS[argv[0]] and argv.length > 1
+          bulk = argv[-1].to_s
+          argv[-1] = get_size(bulk)
+        end
+        command << "#{argv.join(' ')}\r\n"
+        command << "#{bulk}\r\n" if bulk
+      end
+    end
+    results = maybe_lock { process_command(command, argvv) }
+
+    return pipeline ? results : results[0]
+  end
+
+  def process_command(command, argvv)
+    @sock.write(command)
+    argvv.map do |argv|
+      processor = REPLY_PROCESSOR[argv[0]]
+      processor ? processor.call(read_reply) : read_reply
+    end
+  end
+
+  def maybe_lock(&block)
+    if @thread_safe
+      @mutex.synchronize(&block)
+    else
+      block.call
+    end
+  end
+
+  def select(*args)
+    raise "SELECT not allowed, use the :db option when creating the object"
+  end
+
+  def [](key)
+    self.get(key)
+  end
+
+  def []=(key,value)
+    set(key,value)
+  end
+
+  def set(key, value, expiry=nil)
+    s = call_command([:set, key, value]) == OK
+    expire(key, expiry) if s && expiry
+    s
+  end
+
+  def sort(key, options = {})
+    cmd = ["SORT"]
+    cmd << key
+    cmd << "BY #{options[:by]}" if options[:by]
+    cmd << "GET #{[options[:get]].flatten * ' GET '}" if options[:get]
+    cmd << "#{options[:order]}" if options[:order]
+    cmd << "LIMIT #{options[:limit].join(' ')}" if options[:limit]
+    call_command(cmd)
+  end
+
+  def incr(key, increment = nil)
+    call_command(increment ? ["incrby",key,increment] : ["incr",key])
+  end
+
+  def decr(key,decrement = nil)
+    call_command(decrement ? ["decrby",key,decrement] : ["decr",key])
+  end
+
+  # Similar to memcache.rb's #get_multi, returns a hash mapping
+  # keys to values.
+  def mapped_mget(*keys)
+    result = {}
+    mget(*keys).each do |value|
+      key = keys.shift
+      result.merge!(key => value) unless value.nil?
+    end
+    result
+  end
+
+  # Ruby defines a now deprecated type method so we need to override it here
+  # since it will never hit method_missing
+  def type(key)
+    call_command(['type', key])
+  end
+
+  def quit
+    call_command(['quit'])
+  rescue Errno::ECONNRESET
+  end
+
+  def pipelined(&block)
+    pipeline = Pipeline.new self
+    yield pipeline
+    pipeline.execute
+  end
+
+  def read_reply
+    # We read the first byte using read() mainly because gets() is
+    # immune to raw socket timeouts.
+    begin
+      rtype = @sock.read(1)
+    rescue Errno::EAGAIN
+      # We want to make sure it reconnects on the next command after the
+      # timeout. Otherwise the server may reply in the meantime leaving
+      # the protocol in a desync status.
+      @sock = nil
+      raise Errno::EAGAIN, "Timeout reading from the socket"
+    end
+
+    raise Errno::ECONNRESET,"Connection lost" if !rtype
+    line = @sock.gets
+    case rtype
+    when MINUS
+      raise MINUS + line.strip
+    when PLUS
+      line.strip
+    when COLON
+      line.to_i
+    when DOLLAR
+      bulklen = line.to_i
+      return nil if bulklen == -1
+      data = @sock.read(bulklen)
+      @sock.read(2) # CRLF
+      data
+    when ASTERISK
+      objects = line.to_i
+      return nil if bulklen == -1
+      res = []
+      objects.times {
+        res << read_reply
+      }
+      res
+    else
+      raise "Protocol error, got '#{rtype}' as initial reply byte"
+    end
+  end
+
+  private
+    def get_size(string)
+      string.respond_to?(:bytesize) ? string.bytesize : string.size
+    end
+end