redpear 0.4.3 → 0.5.0

data/lib/redpear/column.rb

@@ -2,9 +2,12 @@ class Redpear::Column < String
   attr_reader :type, :model
 
   # Creates a new column.
-  # @param [Redpear::Model] model the model the column is associated with
-  # @param [String] name the column name
-  # @param [Symbol] type the column type (:string (default), :counter, :integer, :timestamp)
+  # @param [Redpear::Model] model
+  #   the model the column is associated with
+  # @param [String] name
+  #   the column name
+  # @param [Symbol] type
+  #   the column type (:string (default), :counter, :integer, :timestamp)
   def initialize(model, name, type = nil)
     super name.to_s
     @model = model

data/lib/redpear/finders.rb

@@ -46,7 +46,7 @@ module Redpear::Finders
     # @param id the ID to check
     # @return [Boolean] true or false
     def exists?(id)
-      members.exists?(id)
+      members.include?(id)
     end
 
     def instantiate(*a)

data/lib/redpear/index.rb

@@ -14,11 +14,11 @@ class Redpear::Index < Redpear::Column
   #
   #   index = Comment.columns.lookup["post_id"]
   #   index.nest(123) # => "comments:[post_id]:123"
-  #   index.nest(nil) # => nil
-  #   index.nest("")  # => nil
+  #   index.nest(nil) # => "comments:[post_id]:_"
+  #   index.nest("")  # => "comments:[post_id]:_"
   #
   def nest(value)
-    return nil if value.nil? || (value.respond_to?(:empty?) && value.empty?)
+    value = "_" if value.nil? || (value.respond_to?(:empty?) && value.empty?)
     namespace[value]
   end
 

data/lib/redpear/members.rb

@@ -1,37 +1,83 @@
 class Redpear::Members
   include Enumerable
 
+  attr_reader :nest
+
+  # Constructor
+  # @param [Redpear::Nest] nest
+  #   the nest object
   def initialize(nest)
-    @nest    = nest
-    @members = Set.new unless @nest
+    @nest = nest
   end
 
+  # @return [Boolean] true if member have been loaded
   def loaded?
     !@members.nil?
   end
 
+  # @yield [String] do something with each member
   def each(&block)
     members.each(&block)
   end
 
-  def exists?(value)
-    loaded? ? @members.include?(value.to_s) : @nest.sismember(value)
+  # @param [String] value
+  #   check if this value is a member
+  # @return [Boolean] true if members contain the value
+  def include?(value)
+    loaded? ? @members.include?(value.to_s) : is_member?(value)
   end
 
+  # @return [Set] the actual members
   def members
-    @members ||= @nest.smembers.to_set
+    @members ||= nest.smembers.to_set
   end
 
+  # @return [Integer] then count of members
   def count
-    members.count
+    @count ||= loaded? ? @members.size : cardinality
   end
+  alias_method :size, :count
 
-  def size
-    members.size
+  # Compares members
+  # @param [Object] other the object to compare with
+  # @return [Boolean] true if same as other
+  def ==(other)
+    case other
+    when Redpear::Members
+      other.members == members
+    when Set
+      other == members
+    when Array
+      other.to_set == members
+    else
+      super
+    end
   end
 
-  def ==(other)
-    other.is_a?(Array) ? to_a == other : super
+  # Is the value a member? This method is not cached, try using #include? instead.
+  # @param [String] value
+  def is_member?(value)
+    nest.sismember(value)
+  end
+
+  # @return [Integer] the cardinaliry of this set.
+  # This method is not cached, try using #count instead.
+  def cardinality
+    nest.scard
+  end
+
+  # Add a member to this set
+  # @param [Model] record
+  def add(record)
+    @members << record.id if loaded?
+    nest.sadd(record.id)
+  end
+
+  # Remove a member from this set
+  # @param [Model] record
+  def remove(record)
+    @members.delete(record.id) if loaded?
+    nest.srem(record.id)
   end
 
 end

data/lib/redpear/persistence.rb

@@ -52,7 +52,7 @@ module Redpear::Persistence
 
   # Load attributes from DB (destructive)
   def refresh_attributes
-    update nest.mapped_hmget(*self.class.columns.names) if persisted?
+    update nest.mapped_hmget(*__loadable_attributes__) if persisted?
     @__loaded__ = true
     self
   end
@@ -69,7 +69,7 @@ module Redpear::Persistence
 
     transaction do
       nest.mapped_hmset __persistable_attributes__
-      __relevant_sets__.each {|s| s.sadd(id) }
+      __relevant_member_sets__.each {|s| s.add(self) }
       expire options[:expire]
       yield(self) if block
     end
@@ -86,7 +86,7 @@ module Redpear::Persistence
 
     transaction do
       nest.del
-      __relevant_sets__.each {|s| s.srem(id) }
+      __relevant_member_sets__.each {|s| s.remove(self) }
     end
 
     true
@@ -118,7 +118,7 @@ module Redpear::Persistence
     def after_destroy
     end
 
-  private
+  protected
 
     # Attributes that can be persisted
     def __persistable_attributes__
@@ -130,6 +130,11 @@ module Redpear::Persistence
       result
     end
 
+    # Attributes that can be loaded
+    def __loadable_attributes__
+      self.class.columns.names
+    end
+
     def __persistable_value__(value)
       case value
       when Time
@@ -140,8 +145,8 @@ module Redpear::Persistence
     end
 
     # Return relevant set nests
-    def __relevant_sets__
-      @__relevant_sets__ ||= [self.class.mb_nest] + self.class.columns.indices.map {|i| i.nest self[i] }.compact
+    def __relevant_member_sets__
+      @__relevant_member_sets__ ||= [self.class.members] + self.class.columns.indices.map {|i| i.members(self[i]) if self[i] }.compact
     end
 
 end

data/lib/redpear/schema/collection.rb

@@ -2,17 +2,9 @@
 class Redpear::Schema::Collection < Array
 
   # @param [multiple] the column definition. Please see Redpear::Column#initialize
-  def column(*args)
+  def store(klass, *args)
     reset!
-    Redpear::Column.new(*args).tap do |col|
-      self << col
-    end
-  end
-
-  # @param [multiple] the index definition. Please see Redpear::Column#initialize
-  def index(*args)
-    reset!
-    Redpear::Index.new(*args).tap do |col|
+    klass.new(*args).tap do |col|
       self << col
     end
   end

data/lib/redpear/schema.rb

@@ -11,14 +11,21 @@ module Redpear::Schema
 
     # @param [multiple] the column definition. Please see Redpear::Column#initialize
     def column(*args)
-      columns.column(self, *args).tap do |col|
+      columns.store(Redpear::Column, self, *args).tap do |col|
         __define_attribute_accessors__(col)
       end
     end
 
-    # @param [multiple] the index definition. Please see Redpear::Column#initialize
+    # @param [multiple] the index definition. Please see Redpear::Index#initialize
     def index(*args)
-      columns.index(self, *args).tap do |col|
+      columns.store(Redpear::Index, self, *args).tap do |col|
+        __define_attribute_accessors__(col)
+      end
+    end
+
+    # @param [multiple] the sorted index definition. Please see Redpear::ZIndex#initialize
+    def zindex(*args)
+      columns.store(Redpear::ZIndex, self, *args).tap do |col|
         __define_attribute_accessors__(col)
       end
     end

data/lib/redpear/zindex.rb

@@ -0,0 +1,26 @@
+class Redpear::ZIndex < Redpear::Index
+
+  attr_reader :callback
+
+  # Creates a new ZIndex.
+  # @param [Redpear::Model] model
+  #   the model the column is associated with
+  # @param [String] name
+  #   the column name
+  # @param [Symbol] callback
+  #   method to be call on the object, to determine the score
+  # @param [Symbol] type
+  #   the column type (:string (default), :counter, :integer, :timestamp)
+  def initialize(model, name, callback, type = nil)
+    super(model, name, type)
+    @callback = callback
+  end
+
+  # @param [String] value
+  #   the index value
+  # @return [Redpear::SortedMembers] the IDs of all existing records for a given index value
+  def members(value)
+    Redpear::ZMembers.new nest(value), callback
+  end
+
+end

data/lib/redpear/zmembers.rb

@@ -0,0 +1,68 @@
+class Redpear::ZMembers < Redpear::Members
+
+  # Constructor
+  # @param [Redpear::Nest] nest
+  #   the nest object
+  # @param [Symbol] callback
+  #   the method to use for scoring when members are added
+  def initialize(nest, callback)
+    super(nest)
+    @callback = callback.to_sym
+  end
+
+  # @return [Hash] the actual members
+  def members
+    @members ||= range.to_set
+  end
+
+  # @param [Hash] options
+  # @option [Integer] start, start index, defaults to 0
+  # @option [Integer] stop, stop index, defaults to -1
+  # @returns [Hash] range of members, lowest rank first
+  def range(options = {})
+    options = options.merge(:start => 0, :stop => -1)
+    nest.zrange options.delete(:start), options.delete(:stop), options
+  end
+
+  # @param [Hash] options
+  # @option [Integer] start, start index, defaults to 0
+  # @option [Integer] stop, stop index, defaults to -1
+  # @returns [Hash] range or members, highest rank first
+  def reverse_range(options = {})
+    options = options.merge(:start => 0, :stop => -1)
+    nest.zrevrange options.delete(:start), options.delete(:stop), options
+  end
+
+  # Is the value a member? This method is not cached, try using #include? instead.
+  # @param [String] value
+  def is_member?(value)
+    !!nest.zscore(value)
+  end
+
+  # @return [Integer] the cardinality of this set.
+  # This method is not cached, try using #count instead.
+  def cardinality
+    nest.zcard
+  end
+
+  # @return [Integer] the score for a member
+  # This method is not cached.
+  def score(value)
+    nest.zscore(value)
+  end
+
+  # Add a member to this set
+  # @param [Model] record
+  def add(record)
+    @members << record.id if loaded?
+    nest.zadd(record.send(@callback), record.id)
+  end
+
+  # Remove a member from this set
+  # @param [Model] record
+  def remove(record, score = 0)
+    @members.delete(record.id) if loaded?
+    nest.zrem(record.id)
+  end
+
+end

data/lib/redpear.rb

@@ -21,5 +21,7 @@ module Redpear
   autoload :Nest
   autoload :Persistence
   autoload :Schema
+  autoload :ZIndex
+  autoload :ZMembers
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redpear
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-28 00:00:00.000000000Z
+date: 2011-12-01 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &16450640 !ruby/object:Gem::Requirement
+  requirement: &19999180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *16450640
+  version_requirements: *19999180
 - !ruby/object:Gem::Dependency
   name: nest
-  requirement: &16450180 !ruby/object:Gem::Requirement
+  requirement: &19998660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *16450180
+  version_requirements: *19998660
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &16449800 !ruby/object:Gem::Requirement
+  requirement: &19998180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16449800
+  version_requirements: *19998180
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &16449340 !ruby/object:Gem::Requirement
+  requirement: &19997620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16449340
+  version_requirements: *19997620
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &16448360 !ruby/object:Gem::Requirement
+  requirement: &19997060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16448360
+  version_requirements: *19997060
 - !ruby/object:Gem::Dependency
   name: fakeredis
-  requirement: &16447900 !ruby/object:Gem::Requirement
+  requirement: &19996200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16447900
+  version_requirements: *19996200
 - !ruby/object:Gem::Dependency
   name: shoulda-matchers
-  requirement: &16447400 !ruby/object:Gem::Requirement
+  requirement: &19995740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16447400
+  version_requirements: *19995740
 description: Simple, elegant & efficient ORM for Redis
 email: dimitrij@blacksquaremedia.com
 executables: []
@@ -99,9 +99,11 @@ files:
 - lib/redpear/schema/collection.rb
 - lib/redpear/core_ext/stringify_keys.rb
 - lib/redpear/concern.rb
+- lib/redpear/zmembers.rb
 - lib/redpear/namespace.rb
 - lib/redpear/nest.rb
 - lib/redpear/finders.rb
+- lib/redpear/zindex.rb
 - lib/redpear/persistence.rb
 - lib/redpear/expiration.rb
 - lib/redpear/column.rb