sohm 0.0.1 → 0.9.0

data/lib/sohm.rb

@@ -33,7 +33,7 @@ module Sohm
   #   Raised when trying to save an object with a `unique` index for
   #   which the value already exists.
   #
-  #   Solution: rescue `Ohm::UniqueIndexViolation` during save, but
+  #   Solution: rescue `Sohm::UniqueIndexViolation` during save, but
   #   also, do some validations even before attempting to save.
   #
   class Error < StandardError; end
@@ -53,14 +53,14 @@ module Sohm
     #
     # Example:
     #
-    #   class Comment < Ohm::Model
+    #   class Comment < Sohm::Model
     #     reference :user, User # NameError undefined constant User.
     #   end
     #
     #   # Instead of relying on some clever `const_missing` hack, we can
     #   # simply use a symbol or a string.
     #
-    #   class Comment < Ohm::Model
+    #   class Comment < Sohm::Model
     #     reference :user, :User
     #     reference :post, "Post"
     #   end
@@ -76,18 +76,6 @@ module Sohm
     def self.dict(arr)
       Hash[*arr]
     end
-
-    def self.sort(redis, key, options)
-      args = []
-
-      args.concat(["BY", options[:by]]) if options[:by]
-      args.concat(["GET", options[:get]]) if options[:get]
-      args.concat(["LIMIT"] + options[:limit]) if options[:limit]
-      args.concat(options[:order].split(" ")) if options[:order]
-      args.concat(["STORE", options[:store]]) if options[:store]
-
-      redis.call("SORT", key, *args)
-    end
   end
 
   # Use this if you want to do quick ad hoc redis commands against the
@@ -98,14 +86,28 @@ module Sohm
   #   Ohm.redis.call("SET", "foo", "bar")
   #   Ohm.redis.call("FLUSH")
   #
+  @redis = Redic.new
   def self.redis
-    @redis ||= Redic.new
+    @redis
   end
 
   def self.redis=(redis)
     @redis = redis
   end
 
+  # If you are using a Redis pool to override @redis above, chances are
+  # you won't need a mutex(since your opertions will run on different
+  # redis instances), so you can use this to override the default mutex
+  # for better performance
+  @mutex = Mutex.new
+  def self.mutex=(mutex)
+    @mutex = mutex
+  end
+
+  def self.mutex
+    @mutex
+  end
+
   # By default, EVALSHA is used
   def self.enable_evalsha
     defined?(@enable_evalsha) ? @enable_evalsha : true
@@ -137,7 +139,6 @@ module Sohm
       size == 0
     end
 
-    # TODO: fix this later
     # Wraps the whole pipelining functionality.
     def fetch(ids)
       data = nil
@@ -154,7 +155,7 @@ module Sohm
 
       [].tap do |result|
         data.each_with_index do |atts, idx|
-          unless attrs.empty?
+          unless atts.empty?
             result << model.new(Utils.dict(atts).update(:id => ids[idx]))
           end
         end
@@ -195,10 +196,10 @@ module Sohm
     #
     # Example:
     #
-    #   class Comment < Ohm::Model
+    #   class Comment < Sohm::Model
     #   end
     #
-    #   class Post < Ohm::Model
+    #   class Post < Sohm::Model
     #     list :comments, :Comment
     #   end
     #
@@ -246,10 +247,10 @@ module Sohm
     #
     # Example:
     #
-    #   class Comment < Ohm::Model
+    #   class Comment < Sohm::Model
     #   end
     #
-    #   class Post < Ohm::Model
+    #   class Post < Sohm::Model
     #     list :comments, :Comment
     #   end
     #
@@ -272,10 +273,10 @@ module Sohm
 
     # Returns an array with all the ID's of the list.
     #
-    #   class Comment < Ohm::Model
+    #   class Comment < Sohm::Model
     #   end
     #
-    #   class Post < Ohm::Model
+    #   class Post < Sohm::Model
     #     list :comments, :Comment
     #   end
     #
@@ -305,57 +306,6 @@ module Sohm
   class BasicSet
     include Collection
 
-    # Allows you to sort by any attribute in the hash, this doesn't include
-    # the +id+. If you want to sort by ID, use #sort.
-    #
-    #   class User < Ohm::Model
-    #     attribute :name
-    #   end
-    #
-    #   User.all.sort_by(:name, :order => "ALPHA")
-    #   User.all.sort_by(:name, :order => "ALPHA DESC")
-    #   User.all.sort_by(:name, :order => "ALPHA DESC", :limit => [0, 10])
-    #
-    # Note: This is slower compared to just doing `sort`, specifically
-    # because Redis has to read each individual hash in order to sort
-    # them.
-    #
-    def sort_by(att, options = {})
-      sort(options.merge(:by => to_key(att)))
-    end
-
-    # Allows you to sort your models using their IDs. This is much
-    # faster than `sort_by`. If you simply want to get records in
-    # ascending or descending order, then this is the best method to
-    # do that.
-    #
-    # Example:
-    #
-    #   class User < Ohm::Model
-    #     attribute :name
-    #   end
-    #
-    #   User.create(:name => "John")
-    #   User.create(:name => "Jane")
-    #
-    #   User.all.sort.map(&:id) == ["1", "2"]
-    #   # => true
-    #
-    #   User.all.sort(:order => "ASC").map(&:id) == ["1", "2"]
-    #   # => true
-    #
-    #   User.all.sort(:order => "DESC").map(&:id) == ["2", "1"]
-    #   # => true
-    #
-    def sort(options = {})
-      if options.has_key?(:get)
-        options[:get] = to_key(options[:get])
-        return execute { |key| Utils.sort(redis, key, options) }
-      end
-
-      fetch(execute { |key| Utils.sort(redis, key, options) })
-    end
-
     # Check if a model is included in this set.
     #
     # Example:
@@ -377,34 +327,28 @@ module Sohm
       execute { |key| redis.call("SCARD", key) }
     end
 
-    # Syntactic sugar for `sort_by` or `sort` when you only need the
-    # first element.
+    # SMEMBERS then choosing the first will take too much memory in case data
+    # grow big enough, which will be slow in this case.
+    # Providing +sample+ only gives a hint that we won't preserve any order
+    # for this, there will be 2 cases:
     #
-    # Example:
+    # 1. Anyone in the set will do, this is the original use case of +sample*
+    # 2. For some reasons(maybe due to filters), we only have 1 element left
+    # in this set, using +sample+ will do the trick
     #
-    #   User.all.first ==
-    #     User.all.sort(:limit => [0, 1]).first
-    #
-    #   User.all.first(:by => :name, "ALPHA") ==
-    #     User.all.sort_by(:name, :order => "ALPHA", :limit => [0, 1]).first
-    #
-    def first(options = {})
-      opts = options.dup
-      opts.merge!(:limit => [0, 1])
-
-      if opts[:by]
-        sort_by(opts.delete(:by), opts).first
-      else
-        sort(opts).first
-      end
+    # For all the other cases, we won't be able to fetch a single element
+    # without fetching all elements first(in other words, doing this
+    # efficiently)
+    def sample
+      model[execute { |key| redis.call("SRANDMEMBER", key) }]
     end
 
     # Returns an array with all the ID's of the set.
     #
-    #   class Post < Ohm::Model
+    #   class Post < Sohm::Model
     #   end
     #
-    #   class User < Ohm::Model
+    #   class User < Sohm::Model
     #     attribute :name
     #     index :name
     #
@@ -442,10 +386,10 @@ module Sohm
     #
     # Example:
     #
-    #   class Post < Ohm::Model
+    #   class Post < Sohm::Model
     #   end
     #
-    #   class User < Ohm::Model
+    #   class User < Sohm::Model
     #     set :posts, :Post
     #   end
     #
@@ -459,15 +403,6 @@ module Sohm
     def exists?(id)
       execute { |key| redis.call("SISMEMBER", key, id) == 1 }
     end
-
-  private
-    def to_key(att)
-      if model.counters.include?(att)
-        namespace["*:counters->%s" % att]
-      else
-        namespace["*->%s" % att]
-      end
-    end
   end
 
   class Set < BasicSet
@@ -583,13 +518,13 @@ module Sohm
   #
   # Example:
   #
-  #   User.all.kind_of?(Ohm::Set)
+  #   User.all.kind_of?(Sohm::Set)
   #   # => true
   #
-  #   User.find(:name => "John").kind_of?(Ohm::Set)
+  #   User.find(:name => "John").kind_of?(Sohm::Set)
   #   # => true
   #
-  #   User.find(:name => "John", :age => 30).kind_of?(Ohm::MultiSet)
+  #   User.find(:name => "John", :age => 30).kind_of?(Sohm::MultiSet)
   #   # => true
   #
   class MultiSet < BasicSet
@@ -704,7 +639,7 @@ module Sohm
   #
   # Example:
   #
-  #   class User < Ohm::Model
+  #   class User < Sohm::Model
   #     attribute :name
   #     index :name
   #
@@ -740,7 +675,7 @@ module Sohm
   #
   # Next we increment points:
   #
-  #   HINCR User:1:counters points 1
+  #   HINCR User:1:_counters points 1
   #
   # And then we add a Post to the `posts` set.
   # (For brevity, let's assume the Post created has an ID of 1).
@@ -757,7 +692,7 @@ module Sohm
     end
 
     def self.mutex
-      @@mutex ||= Mutex.new
+      Sohm.mutex
     end
 
     def self.synchronize(&block)
@@ -768,7 +703,7 @@ module Sohm
     #
     # Example:
     #
-    #   class User < Ohm::Model
+    #   class User < Sohm::Model
     #   end
     #
     #   User.key == "User"
@@ -782,7 +717,7 @@ module Sohm
     #   http://github.com/soveran/nido
     #
     def self.key
-      @key ||= Nido.new(self.name)
+      Nido.new(self.name)
     end
 
     # Retrieve a record by ID.
@@ -807,7 +742,7 @@ module Sohm
     # Note: The use of this should be a last resort for your actual
     # application runtime, or for simply debugging in your console. If
     # you care about performance, you should pipeline your reads. For
-    # more information checkout the implementation of Ohm::List#fetch.
+    # more information checkout the implementation of Sohm::List#fetch.
     #
     def self.to_proc
       lambda { |id| self[id] }
@@ -822,7 +757,7 @@ module Sohm
     #
     # Example:
     #
-    #   class User < Ohm::Model
+    #   class User < Sohm::Model
     #     attribute :email
     #
     #     attribute :name
@@ -860,9 +795,9 @@ module Sohm
       keys = filters(dict)
 
       if keys.size == 1
-        Ohm::Set.new(keys.first, key, self)
+        Sohm::Set.new(keys.first, key, self)
       else
-        Ohm::MultiSet.new(key, self, Command.new(:sinterstore, *keys))
+        Sohm::MultiSet.new(key, self, Command.new(:sinterstore, *keys))
       end
     end
 
@@ -882,11 +817,11 @@ module Sohm
       indices << attribute unless indices.include?(attribute)
     end
 
-    # Declare an Ohm::Set with the given name.
+    # Declare an Sohm::Set with the given name.
     #
     # Example:
     #
-    #   class User < Ohm::Model
+    #   class User < Sohm::Model
     #     set :posts, :Post
     #   end
     #
@@ -895,7 +830,7 @@ module Sohm
     #   # => true
     #
     # Note: You can't use the set until you save the model. If you try
-    # to do it, you'll receive an Ohm::MissingID error.
+    # to do it, you'll receive an Sohm::MissingID error.
     #
     def self.set(name, model)
       track(name)
@@ -903,18 +838,18 @@ module Sohm
       define_method name do
         model = Utils.const(self.class, model)
 
-        Ohm::MutableSet.new(key[name], model.key, model)
+        Sohm::MutableSet.new(key[name], model.key, model)
       end
     end
 
-    # Declare an Ohm::List with the given name.
+    # Declare an Sohm::List with the given name.
     #
     # Example:
     #
-    #   class Comment < Ohm::Model
+    #   class Comment < Sohm::Model
     #   end
     #
-    #   class Post < Ohm::Model
+    #   class Post < Sohm::Model
     #     list :comments, :Comment
     #   end
     #
@@ -925,7 +860,7 @@ module Sohm
     #   # => true
     #
     # Note: You can't use the list until you save the model. If you try
-    # to do it, you'll receive an Ohm::MissingID error.
+    # to do it, you'll receive an Sohm::MissingID error.
     #
     def self.list(name, model)
       track(name)
@@ -933,24 +868,24 @@ module Sohm
       define_method name do
         model = Utils.const(self.class, model)
 
-        Ohm::List.new(key[name], model.key, model)
+        Sohm::List.new(key[name], model.key, model)
       end
     end
 
     # A macro for defining a method which basically does a find.
     #
     # Example:
-    #   class Post < Ohm::Model
+    #   class Post < Sohm::Model
     #     reference :user, :User
     #   end
     #
-    #   class User < Ohm::Model
+    #   class User < Sohm::Model
     #     collection :posts, :Post
     #   end
     #
     #   # is the same as
     #
-    #   class User < Ohm::Model
+    #   class User < Sohm::Model
     #     def posts
     #       Post.find(:user_id => self.id)
     #     end
@@ -968,27 +903,25 @@ module Sohm
     #
     # Example:
     #
-    #   class Post < Ohm::Model
+    #   class Post < Sohm::Model
     #     reference :user, :User
     #   end
     #
     #   # It's the same as:
     #
-    #   class Post < Ohm::Model
+    #   class Post < Sohm::Model
     #     attribute :user_id
     #     index :user_id
     #
     #     def user
-    #       @_memo[:user] ||= User[user_id]
+    #       User[user_id]
     #     end
     #
     #     def user=(user)
     #       self.user_id = user.id
-    #       @_memo[:user] = user
     #     end
     #
     #     def user_id=(user_id)
-    #       @_memo.delete(:user_id)
     #       self.user_id = user_id
     #     end
     #   end
@@ -1006,20 +939,16 @@ module Sohm
       end
 
       define_method(writer) do |value|
-        @_memo.delete(name)
         @attributes[reader] = value
       end
 
       define_method(:"#{name}=") do |value|
-        @_memo.delete(name)
         send(writer, value ? value.id : nil)
       end
 
       define_method(name) do
-        @_memo[name] ||= begin
-          model = Utils.const(self.class, model)
-          model[send(reader)]
-        end
+        model = Utils.const(self.class, model)
+        model[send(reader)]
       end
     end
 
@@ -1027,7 +956,7 @@ module Sohm
     # persisted attributes. All attributes are stored on the Redis
     # hash.
     #
-    #   class User < Ohm::Model
+    #   class User < Sohm::Model
     #     attribute :name
     #   end
     #
@@ -1042,7 +971,7 @@ module Sohm
     # A +lambda+ can be passed as a second parameter to add
     # typecasting support to the attribute.
     #
-    #   class User < Ohm::Model
+    #   class User < Sohm::Model
     #     attribute :age, ->(x) { x.to_i }
     #   end
     #
@@ -1089,10 +1018,15 @@ module Sohm
 
       if cast
         define_method(name) do
+          # NOTE: This is a temporary solution, since we might use
+          # composite objects (such as arrays), which won't always
+          # do a reset
+          @serial_attributes_changed = true
           cast[@serial_attributes[name]]
         end
       else
         define_method(name) do
+          @serial_attributes_changed = true
           @serial_attributes[name]
         end
       end
@@ -1111,7 +1045,7 @@ module Sohm
     #
     # Example:
     #
-    #   class User < Ohm::Model
+    #   class User < Sohm::Model
     #     counter :points
     #   end
     #
@@ -1122,7 +1056,7 @@ module Sohm
     #   # => 1
     #
     # Note: You can't use counters until you save the model. If you
-    # try to do it, you'll receive an Ohm::MissingID error.
+    # try to do it, you'll receive an Sohm::MissingID error.
     #
     def self.counter(name)
       counters << name unless counters.include?(name)
@@ -1130,7 +1064,7 @@ module Sohm
       define_method(name) do
         return 0 if new?
 
-        redis.call("HGET", key[:counters], name).to_i
+        redis.call("HGET", key[:_counters], name).to_i
       end
     end
 
@@ -1142,11 +1076,11 @@ module Sohm
     # Create a new model, notice that under Sohm's circumstances,
     # this is no longer a syntactic sugar for Model.new(atts).save
     def self.create(atts = {})
-      new(atts).save(create: true)
+      new(atts).save
     end
 
     # Returns the namespace for the keys generated using this model.
-    # Check `Ohm::Model.key` documentation for more details.
+    # Check `Sohm::Model.key` documentation for more details.
     def key
       model.key[id]
     end
@@ -1160,7 +1094,6 @@ module Sohm
     def initialize(atts = {})
       @attributes = {}
       @serial_attributes = {}
-      @_memo = {}
       @serial_attributes_changed = false
       update_attributes(atts)
     end
@@ -1170,7 +1103,7 @@ module Sohm
     #
     # Example:
     #
-    #   class User < Ohm::Model; end
+    #   class User < Sohm::Model; end
     #
     #   u = User.create
     #   u.id
@@ -1201,52 +1134,16 @@ module Sohm
     # Preload all the attributes of this model from Redis. Used
     # internally by `Model::[]`.
     def load!
-      update_attributes(Utils.dict(redis.call("HGETALL", key))) unless new?
+      update_attributes(Utils.dict(redis.call("HGETALL", key))) if id
       @serial_attributes_changed = false
       return self
     end
 
-    # Read an attribute remotely from Redis. Useful if you want to get
-    # the most recent value of the attribute and not rely on locally
-    # cached value.
-    #
-    # Example:
-    #
-    #   User.create(:name => "A")
-    #
-    #   Session 1     |    Session 2
-    #   --------------|------------------------
-    #   u = User[1]   |    u = User[1]
-    #   u.name = "B"  |
-    #   u.save        |
-    #                 |    u.name == "A"
-    #                 |    u.get(:name) == "B"
-    #
-    def get(att)
-      @attributes[att] = redis.call("HGET", key, att)
-    end
-
-    # Update an attribute value atomically. The best usecase for this
-    # is when you simply want to update one value.
-    #
-    # Note: This method is dangerous because it doesn't update indices
-    # and uniques. Use it wisely. The safe equivalent is `update`.
-    #
-    def set(att, val)
-      if val.to_s.empty?
-        redis.call("HDEL", key, att)
-      else
-        redis.call("HSET", key, att, val)
-      end
-
-      @attributes[att] = val
-    end
-
     # Returns +true+ if the model is not persisted. Otherwise, returns +false+.
     #
     # Example:
     #
-    #   class User < Ohm::Model
+    #   class User < Sohm::Model
     #     attribute :name
     #   end
     #
@@ -1258,12 +1155,12 @@ module Sohm
     #   u.new?
     #   # => false
     def new?
-      !model.exists?(id)
+      !(defined?(@id) && model.exists?(id))
     end
 
     # Increment a counter atomically. Internally uses HINCRBY.
     def incr(att, count = 1)
-      redis.call("HINCRBY", key[:counters], att, count)
+      redis.call("HINCRBY", key[:_counters], att, count)
     end
 
     # Decrement a counter atomically. Internally uses HINCRBY.
@@ -1294,7 +1191,7 @@ module Sohm
     #
     # Example:
     #
-    #   class User < Ohm::Model
+    #   class User < Sohm::Model
     #     attribute :name
     #   end
     #
@@ -1316,7 +1213,7 @@ module Sohm
     #
     # Example:
     #
-    #   class User < Ohm::Model
+    #   class User < Sohm::Model
     #     attribute :name
     #   end
     #
@@ -1326,7 +1223,7 @@ module Sohm
     #
     # In order to add additional attributes, you can override `to_hash`:
     #
-    #   class User < Ohm::Model
+    #   class User < Sohm::Model
     #     attribute :name
     #
     #     def to_hash
@@ -1351,7 +1248,7 @@ module Sohm
     #
     # Example:
     #
-    #   class User < Ohm::Model
+    #   class User < Sohm::Model
     #     attribute :name
     #   end
     #
@@ -1362,7 +1259,7 @@ module Sohm
     def save
       if serial_attributes_changed
         response = script(LUA_SAVE, 1, key,
-          serial_attributes.to_msgpack,
+          sanitize_attributes(serial_attributes).to_msgpack,
           cas_token)
 
         if response.is_a?(RuntimeError)
@@ -1377,7 +1274,8 @@ module Sohm
         @serial_attributes_changed = false
       end
 
-      redis.call("HSET", key, "_ndata", attributes.to_msgpack)
+      redis.call("HSET", key, "_ndata",
+                 sanitize_attributes(attributes).to_msgpack)
 
       refresh_indices
 
@@ -1387,18 +1285,21 @@ module Sohm
     # Delete the model, including all the following keys:
     #
     # - <Model>:<id>
-    # - <Model>:<id>:counters
+    # - <Model>:<id>:_counters
     # - <Model>:<id>:<set name>
     #
     # If the model has uniques or indices, they're also cleaned up.
     #
     def delete
       memo_key = key["_indices"]
-      commands = [["DEL", key], ["DEL", memo_key]]
+      commands = [["DEL", key], ["DEL", memo_key], ["DEL", key["_counters"]]]
       index_list = redis.call("SMEMBERS", memo_key)
       index_list.each do |index_key|
         commands << ["SREM", index_key, id]
       end
+      model.tracked.each do |tracked_key|
+        commands << ["DEL", key[tracked_key]]
+      end
 
       model.synchronize do
         commands.each do |command|
@@ -1459,24 +1360,33 @@ module Sohm
         downcase.to_sym
     end
 
+    # Workaround to JRuby's concurrency problem
+    def self.inherited(subclass)
+      subclass.instance_variable_set(:@indices, [])
+      subclass.instance_variable_set(:@counters, [])
+      subclass.instance_variable_set(:@tracked, [])
+      subclass.instance_variable_set(:@attributes, [])
+      subclass.instance_variable_set(:@serial_attributes, [])
+    end
+
     def self.indices
-      @indices ||= []
+      @indices
     end
 
     def self.counters
-      @counters ||= []
+      @counters
     end
 
     def self.tracked
-      @tracked ||= []
+      @tracked
     end
 
     def self.attributes
-      @attributes ||= []
+      @attributes
     end
 
     def self.serial_attributes
-      @serial_attributes ||= []
+      @serial_attributes
     end
 
     def self.filters(dict)
@@ -1493,9 +1403,9 @@ module Sohm
       raise IndexNotFound unless indices.include?(att)
 
       if val.kind_of?(Enumerable)
-        val.map { |v| key[:indices][att][v] }
+        val.map { |v| key[:_indices][att][v] }
       else
-        [key[:indices][att][val]]
+        [key[:_indices][att][val]]
       end
     end
 
@@ -1511,7 +1421,7 @@ module Sohm
       # Add new indices first
       commands = fetch_indices.each_pair.map do |field, vals|
         vals.map do |val|
-          index_key = key["_indices"][field][val]
+          index_key = model.key["_indices"][field][val]
           [["SADD", memo_key, index_key], ["SADD", index_key, id]]
         end
       end.flatten(2)
@@ -1529,7 +1439,7 @@ module Sohm
       index_set = ::Set.new(redis.call("SMEMBERS", memo_key))
       valid_list = model[id].send(:fetch_indices).each_pair.map do |field, vals|
         vals.map do |val|
-          key["_indices"][field][val]
+          model.key["_indices"][field][val]
         end
       end.flatten(1)
       valid_set = ::Set.new(valid_list)
@@ -1565,6 +1475,10 @@ module Sohm
       attrs
     end
 
+    def sanitize_attributes(attributes)
+      attributes.select { |key, val| val }
+    end
+
     def model
       self.class
     end