ohm 0.0.11 → 0.0.12

data/lib/ohm.rb

@@ -4,7 +4,7 @@ require File.join(File.dirname(__FILE__), "ohm", "validations")
 
 module Ohm
 
-  # Provides access to the redis database. This is shared accross all models and instances.
+  # Provides access to the Redis database. This is shared accross all models and instances.
   def redis
     @redis
   end
@@ -38,18 +38,57 @@ module Ohm
     class Collection
       include Enumerable
 
-      attr_accessor :key, :db
+      attr_accessor :key, :db, :model
 
-      def initialize(db, key)
+      def initialize(db, key, model = nil)
         self.db = db
         self.key = key
+        self.model = model
       end
 
       def each(&block)
         all.each(&block)
       end
 
-      def all(model = nil)
+      # Return instances of model for all the ids contained in the collection.
+      def all
+        instantiate(raw)
+      end
+
+      # Return the values as model instances, ordered by the options supplied.
+      # Check redis documentation to see what values you can provide to each option.
+      #
+      # @param options [Hash] options to sort the collection.
+      # @option options [#to_s] :by Model attribute to sort the instances by.
+      # @option options [#to_s] :order (ASC) Sorting order, which can be ASC or DESC.
+      # @option options [Integer] :limit (all) Number of items to return.
+      # @option options [Integer] :start (0) An offset from where the limit will be applied.
+      # @example Get the first ten users sorted alphabetically by name:
+      #   @event.attendees.sort(User, :by => :name, :order => "ALPHA", :limit => 10)
+      #
+      # @example Get five posts sorted by number of votes and starting from the number 5 (zero based):
+      #   @blog.posts.sort(Post, :by => :votes, :start => 5, :limit => 10")
+      def sort(options = {})
+        options[:start] ||= 0
+        options[:limit] = [options[:start], options[:limit]] if options[:limit]
+        instantiate(db.sort(key, options))
+      end
+
+      def sort_by(att, options = {})
+        sort(options.merge(:by => model.key("*", att)))
+      end
+
+      def to_ary
+        all
+      end
+
+      def ==(other)
+        to_ary == other
+      end
+
+    private
+
+      def instantiate(raw)
         model ? raw.collect { |id| model[id] } : raw
       end
     end
@@ -74,7 +113,9 @@ module Ohm
         db.rpush(key, value)
       end
 
-    private
+      def empty?
+        db.llen(key).zero?
+      end
 
       def raw
         db.list(key)
@@ -113,14 +154,16 @@ module Ohm
         db.srem(key, value)
       end
 
+      def empty?
+        db.scard(key).zero?
+      end
+
       def include?(value)
         db.sismember(key, value)
       end
 
-    private
-
       def raw
-        db.smembers(key).sort
+        db.smembers(key)
       end
     end
   end
@@ -185,8 +228,8 @@ module Ohm
     # is created.
     #
     # @param name [Symbol] Name of the list.
-    def self.list(name)
-      attr_list_reader(name)
+    def self.list(name, model = nil)
+      attr_list_reader(name, model)
       collections << name
     end
 
@@ -195,8 +238,8 @@ module Ohm
     # operations like union, join, and membership checks are important.
     #
     # @param name [Symbol] Name of the set.
-    def self.set(name)
-      attr_set_reader(name)
+    def self.set(name, model = nil)
+      attr_set_reader(name, model)
       collections << name
     end
 
@@ -225,20 +268,18 @@ module Ohm
       indices << Array(attrs)
     end
 
-    def self.attr_list_reader(name)
-      class_eval <<-EOS
-        def #{name}
-          @#{name} ||= Attributes::List.new(db, key("#{name}"))
-        end
-      EOS
+    def self.attr_list_reader(name, model = nil)
+      define_method(name) do
+        instance_variable_get("@#{name}") ||
+          instance_variable_set("@#{name}", Attributes::List.new(db, key(name), model))
+      end
     end
 
-    def self.attr_set_reader(name)
-      class_eval <<-EOS
-        def #{name}
-          @#{name} ||= Attributes::Set.new(db, key("#{name}"))
-        end
-      EOS
+    def self.attr_set_reader(name, model)
+      define_method(name) do
+        instance_variable_get("@#{name}") ||
+          instance_variable_set("@#{name}", Attributes::Set.new(db, key(name), model))
+      end
     end
 
     def self.[](id)
@@ -246,7 +287,7 @@ module Ohm
     end
 
     def self.all
-      filter(:all)
+      @all ||= Attributes::Set.new(db, key(:all), self)
     end
 
     def self.attributes
@@ -272,7 +313,7 @@ module Ohm
     end
 
     def self.find(attribute, value)
-      filter(Ohm.key(attribute, encode(value)))
+      Attributes::Set.new(db, key(attribute, encode(value)), self)
     end
 
     def self.encode(value)
@@ -376,12 +417,6 @@ module Ohm
       Ohm.key(*args.unshift(self))
     end
 
-    def self.filter(name)
-      db.smembers(key(name)).map do |id|
-        new(:id => id)
-      end
-    end
-
     def self.exists?(id)
       db.sismember(key(:all), id)
     end

data/lib/ohm/redis.rb

@@ -94,7 +94,7 @@ module Ohm
       cmd << "BY #{opts[:by]}" if opts[:by]
       cmd << "GET #{[opts[:get]].flatten * ' GET '}" if opts[:get]
       cmd << "#{opts[:order]}" if opts[:order]
-      cmd << "LIMIT #{opts[:limit].join(' ')}" if opts[:limit]
+      cmd << "LIMIT #{Array(opts[:limit]).join(' ')}" if opts[:limit]
       call_command(cmd)
     end
 

data/test/db/redis.pid

@@ -1 +1 @@
-6331
+39163

data/test/model_test.rb

@@ -1,18 +1,13 @@
 require File.join(File.dirname(__FILE__), "test_helper")
 
-class Event < Ohm::Model
-  attribute :name
-  counter :votes
-  set :attendees
+class Post < Ohm::Model
+  attribute :body
+  list :comments
 end
 
 class User < Ohm::Model
   attribute :email
-end
-
-class Post < Ohm::Model
-  attribute :body
-  list :comments
+  set :posts, Post
 end
 
 class Person < Ohm::Model
@@ -23,6 +18,13 @@ class Person < Ohm::Model
   end
 end
 
+class Event < Ohm::Model
+  attribute :name
+  counter :votes
+  set :attendees, Person
+end
+
+
 class TestRedis < Test::Unit::TestCase
   context "An event initialized with a hash of attributes" do
     should "assign the passed attributes" do
@@ -169,6 +171,18 @@ class TestRedis < Test::Unit::TestCase
     end
   end
 
+  context "Sorting" do
+    should "sort all" do
+      Ohm.flush
+      Person.create :name => "D"
+      Person.create :name => "C"
+      Person.create :name => "B"
+      Person.create :name => "A"
+
+      assert_equal %w[A B C D], Person.all.sort_by(:name, :order => "ALPHA").map { |person| person.name }
+    end
+  end
+
   context "Loading attributes" do
     setup do
       event = Event.new
@@ -207,9 +221,9 @@ class TestRedis < Test::Unit::TestCase
       @event.attendees << "1"
       @event.attendees << "2"
       @event.attendees << "3"
-      assert_equal ["1", "2", "3"], @event.attendees.all
+      assert_equal ["1", "2", "3"], @event.attendees.raw.sort
       @event.attendees.delete("2")
-      assert_equal ["1", "3"], Event[@event.id].attendees.all
+      assert_equal ["1", "3"], Event[@event.id].attendees.raw.sort
     end
 
     should "return true if the set includes some member" do
@@ -226,7 +240,7 @@ class TestRedis < Test::Unit::TestCase
       @person = Person.create :name => "albert"
       @event.attendees << @person.id
 
-      assert_equal [@person], @event.attendees.all(Person)
+      assert_equal [@person], @event.attendees.all
     end
 
     should "insert the model instance id instead of the object if using add" do
@@ -234,7 +248,7 @@ class TestRedis < Test::Unit::TestCase
       @person = Person.create :name => "albert"
       @event.attendees.add(@person)
 
-      assert_equal [@person.id.to_s], @event.attendees.all
+      assert_equal [@person.id.to_s], @event.attendees.raw
     end
   end
 
@@ -277,6 +291,74 @@ class TestRedis < Test::Unit::TestCase
     end
   end
 
+  context "Applying arbitrary transformations" do
+    class Calendar < Ohm::Model
+      list :holidays, lambda { |v| Date.parse(v) }
+    end
+
+    setup do
+      @calendar = Calendar.create
+      @calendar.holidays << "05/25/2009"
+      @calendar.holidays << "07/09/2009"
+    end
+
+    should "apply a transformation" do
+      assert_equal [Date.parse("2009-05-25"), Date.parse("2009-07-09")], @calendar.holidays
+    end
+  end
+
+  context "Sorting lists and sets" do
+    setup do
+      @post = Post.create(:body => "Lorem")
+      @post.comments << 2
+      @post.comments << 3
+      @post.comments << 1
+    end
+
+    should "sort values" do
+      assert_equal %w{1 2 3}, @post.comments.sort
+    end
+  end
+
+  context "Sorting lists and sets by model attributes" do
+    setup do
+      @event = Event.create(:name => "Ruby Tuesday")
+      @event.attendees << Person.create(:name => "D").id
+      @event.attendees << Person.create(:name => "C").id
+      @event.attendees << Person.create(:name => "B").id
+      @event.attendees << Person.create(:name => "A").id
+    end
+
+    should "sort the model instances by the values provided" do
+      people = @event.attendees.sort_by(:name, :order => "ALPHA")
+      assert_equal %w[A B C D], people.map { |person| person.name }
+    end
+
+    should "accept a number in the limit parameter" do
+      people = @event.attendees.sort_by(:name, :limit => 2, :order => "ALPHA")
+      assert_equal %w[A B], people.map { |person| person.name }
+    end
+
+    should "use the start parameter as an offset if the limit is provided" do
+      people = @event.attendees.sort_by(:name, :limit => 2, :start => 1, :order => "ALPHA")
+      assert_equal %w[B C], people.map { |person| person.name }
+    end
+  end
+
+  context "Collections initialized with a Model parameter" do
+    setup do
+      @user = User.create(:email => "albert@example.com")
+      @user.posts.add Post.create(:body => "D")
+      @user.posts.add Post.create(:body => "C")
+      @user.posts.add Post.create(:body => "B")
+      @user.posts.add Post.create(:body => "A")
+    end
+
+    should "return instances of the passed model" do
+      assert_equal Post, @user.posts.all.first.class
+    end
+  end
+
   context "Counters" do
     setup do
       @event = Event.create(:name => "Ruby Tuesday")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ohm
 version: !ruby/object:Gem::Version 
-  version: 0.0.11
+  version: 0.0.12
 platform: ruby
 authors: 
 - Michel Martens
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-24 00:00:00 -03:00
+date: 2009-07-27 00:00:00 -03:00
 default_executable: 
 dependencies: []