ohm 0.0.19 → 0.0.20

data/README.markdown

@@ -159,8 +159,37 @@ Ohm maintains different sets of objects ids for quick lookups.
 For example, in the example above, the index on the name attribute will
 allow for searches like Event.find(:name, "some value").
 
-Note that the `find` method and the `assert_unique` validation need a
-corresponding index to exist.
+Note that the `assert_unique` validation and the methods `find`, `search` and `filter` need a
+corresponding index in order to work.
+
+### Finding
+
+You can find a collection of records with the `find` method:
+
+    # This returns a collection of users with the username "Albert"
+    User.find(username: "Albert")
+
+### Searching and filtering
+
+    # This returns a collection of users with usernames "Albert" or "Benoit"
+    User.search(username: ["Albert", "Benoit"]) do |search_results|
+      @users = search_results.all
+    end
+
+    # This returns a collection of users with usernames "Albert" or "Benoit",
+    # but only those with the account enabled.
+    User.search(username: ["Albert", "Benoit"]) do |search_results|
+      search_results.filter(account: "enabled") do |filter_results|
+        @users = filter_results.all
+      end
+    end
+
+Important: note that both `search` and `filter` yield the results
+to a block. This is important because the set of results is stored
+for the duration of the block (to allow for chaining of searches and
+filters), but is deleted once the block ends. The `.all` is necessary
+for retrieving the actual instances, as keeping a reference to a set
+that is going to be deleted would only return empty sets.
 
 Validations
 -----------
@@ -237,12 +266,7 @@ Given the following example:
 If all the assertions fail, the following errors will be present:
 
     obj.errors
-    # => [[:foo, :not_present], [:bar, :not_numeric], [:baz, :format], [[:qux], :not_unique]]
-
-Note that the error for assert_unique wraps the field in an array.
-The purpose for this is to standardize the format for both single and
-multicolumn indexes.
-
+    # => [[:foo, :not_present], [:bar, :not_numeric], [:baz, :format], [:qux, :not_unique]]
 
 Presenting errors
 -----------------

data/lib/ohm.rb

@@ -229,8 +229,15 @@ module Ohm
       # @see Ohm::Model.filter
       # @yield [results] Results of the filtering. Beware that the set of results is deleted from Redis when the block ends.
       # @example
+      #   Event.filter(public: true) do |filter_results|
+      #     @events = filter_results.all
+      #   end
+      #
+      #   # You can also combine search and filter
       #   Event.search(day: "2009-09-11") do |search_results|
-      #     events = search_results.all
+      #     search_results.filter(public: true) do |filter_results|
+      #       @events = filter_results.all
+      #     end
       #   end
       def filter(hash, &block)
         apply(:sinterstore, keys(hash).push(key), &block)
@@ -242,9 +249,7 @@ module Ohm
       # @yield [results] Results of the search. Beware that the set of results is deleted from Redis when the block ends.
       # @example
       #   Event.search(day: "2009-09-11") do |search_results|
-      #     search_results.filter(public: true) do |filter_results|
-      #       events = filter_results.all
-      #     end
+      #     events = search_results.all
       #   end
       def search(hash, &block)
         apply(:sunionstore, keys(hash), &block)
@@ -257,7 +262,7 @@ module Ohm
       # Apply a redis operation on a collection of sets. Note that
       # the resulting set is removed inmediatly after use.
       def apply(operation, source, &block)
-        target = source.join(operation)
+        target = source.join(operation.to_s)
         db.send(operation, target, *source)
         set = self.class.new(db, target, model)
         block.call(set)
@@ -536,7 +541,7 @@ module Ohm
     end
 
     def ==(other)
-      other.key == key
+      other.kind_of?(self.class) && other.key == key
     rescue ModelIsNew
       false
     end

data/test/indices_test.rb

@@ -112,9 +112,9 @@ class IndicesTest < Test::Unit::TestCase
     end
 
     setup do
-      @event1 = Event.create(timeline: 1)
-      @event2 = Event.create(timeline: 1)
-      @event3 = Event.create(timeline: 2)
+      @event1 = Event.create(:timeline => 1)
+      @event2 = Event.create(:timeline => 1)
+      @event3 = Event.create(:timeline => 2)
       @event1.days = [1, 2]
       @event2.days = [2, 3]
       @event3.days = [3, 4]
@@ -124,27 +124,27 @@ class IndicesTest < Test::Unit::TestCase
     end
 
     should "intersect multiple sets of results" do
-      Event.filter(timeline: 1, days: [1, 2]) do |set|
+      Event.filter(:timeline => 1, :days => [1, 2]) do |set|
         assert_equal [@event1], set
       end
     end
 
     should "group multiple sets of results" do
-      Event.search(days: [1, 2]) do |set|
+      Event.search(:days => [1, 2]) do |set|
         assert_equal [@event1, @event2], set
       end
     end
 
     should "combine intersections and unions" do
-      Event.search(days: [1, 2, 3]) do |events|
-        events.filter(timeline: 1) do |result|
+      Event.search(:days => [1, 2, 3]) do |events|
+        events.filter(:timeline => 1) do |result|
           assert_equal [@event1, @event2], result
         end
       end
     end
 
     should "work with strings that generate a new line when encoded" do
-      user = User.create(email: "foo@bar", update: "CORRECTED - UPDATE 2-Suspected US missile strike kills 5 in Pakistan")
+      user = User.create(:email => "foo@bar", :update => "CORRECTED - UPDATE 2-Suspected US missile strike kills 5 in Pakistan")
       assert_equal [user], User.find(:update, "CORRECTED - UPDATE 2-Suspected US missile strike kills 5 in Pakistan")
     end
   end

data/test/model_test.rb

@@ -1,4 +1,5 @@
 require File.join(File.dirname(__FILE__), "test_helper")
+require "ostruct"
 
 class Post < Ohm::Model
   attribute :body
@@ -227,7 +228,7 @@ class TestRedis < Test::Unit::TestCase
       Person.create :name => "B"
       Person.create :name => "A"
 
-      assert_equal "A", Person.all.sort_by(:name, get: "Person:*:name", order: "ALPHA").first
+      assert_equal "A", Person.all.sort_by(:name, :get => "Person:*:name", :order => "ALPHA").first
     end
   end
 
@@ -489,5 +490,13 @@ class TestRedis < Test::Unit::TestCase
     should "not be comparable to instances of other models" do
       assert_not_equal @user, Event.create(:name => "Ruby Tuesday")
     end
+
+    should "be comparable to non-models" do
+      assert_not_equal @user, 1
+      assert_not_equal @user, true
+
+      # Not equal although the other object responds to #key.
+      assert_not_equal @user, OpenStruct.new(:key => @user.send(:key))
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ohm
 version: !ruby/object:Gem::Version 
-  version: 0.0.19
+  version: 0.0.20
 platform: ruby
 authors: 
 - Michel Martens
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-15 00:00:00 -03:00
+date: 2009-09-16 00:00:00 -03:00
 default_executable: 
 dependencies: []