ohm 1.1.2 → 1.2.0

data/lib/ohm.rb

@@ -140,8 +140,27 @@ module Ohm
     redis.flushdb
   end
 
-  # Wraps the whole pipelining functionality.
-  module PipelinedFetch
+  module Collection
+    include Enumerable
+
+    def each
+      if block_given?
+        to_a.each { |element| yield element }
+      else
+        Enumerator.new(self, :each)
+      end
+    end
+
+    # Fetch the data from Redis in one go.
+    def to_a
+      fetch(ids)
+    end
+
+    def empty?
+      size == 0
+    end
+
+    # Wraps the whole pipelining functionality.
     def fetch(ids)
       arr = db.pipelined do
         ids.each { |id| db.hgetall(namespace[id]) }
@@ -159,24 +178,126 @@ module Ohm
     end
   end
 
-  # Defines most of the methods used by `Set` and `MultiSet`.
-  module Collection
-    include PipelinedFetch
-    include Enumerable
+  class List
+    include Collection
 
-    # Fetch the data from Redis in one go.
-    def to_a
-      fetch(ids)
+    attr :key
+    attr :namespace
+    attr :model
+
+    def initialize(key, namespace, model)
+      @key = key
+      @namespace = namespace
+      @model = model
     end
 
-    def each
-      to_a.each { |e| yield e }
+    # Returns the total size of the list using LLEN.
+    def size
+      db.llen(key)
     end
+    alias :count :size
 
-    def empty?
-      size == 0
+    # Returns the first element of the list using LINDEX.
+    def first
+      model[db.lindex(key, 0)]
+    end
+
+    # Returns the last element of the list using LINDEX.
+    def last
+      model[db.lindex(key, -1)]
+    end
+
+    # Checks if the model is part of this List.
+    #
+    # An important thing to note is that this method loads all of the
+    # elements of the List since there is no command in Redis that
+    # allows you to actually check the list contents efficiently.
+    #
+    # You may want to avoid doing this if your list has say, 10K entries.
+    def include?(model)
+      ids.include?(model.id.to_s)
+    end
+
+    # Replace all the existing elements of a list with a different
+    # collection of models. This happens atomically in a MULTI-EXEC
+    # block.
+    #
+    # Example:
+    #
+    #   user = User.create
+    #   p1 = Post.create
+    #   user.posts.push(p1)
+    #
+    #   p2, p3 = Post.create, Post.create
+    #   user.posts.replace([p2, p3])
+    #
+    #   user.posts.include?(p1)
+    #   # => false
+    #
+    def replace(models)
+      ids = models.map { |model| model.id }
+
+      model.db.multi do
+        db.del(key)
+        ids.each { |id| db.rpush(key, id) }
+      end
+    end
+
+    # Pushes the model to the _end_ of the list using RPUSH.
+    def push(model)
+      db.rpush(key, model.id)
+    end
+
+    # Pushes the model to the _beginning_ of the list using LPUSH.
+    def unshift(model)
+      db.lpush(key, model.id)
+    end
+
+    # Delete a model from the list.
+    #
+    # Note: If your list contains the model multiple times, this method
+    # will delete all instances of that model in one go.
+    #
+    # Example:
+    #
+    #   class Comment < Ohm::Model
+    #   end
+    #
+    #   class Post < Ohm::Model
+    #     list :comments, Comment
+    #   end
+    #
+    #   p = Post.create
+    #   c = Comment.create
+    #
+    #   p.comments.push(c)
+    #   p.comments.push(c)
+    #
+    #   p.comments.delete(c)
+    #
+    #   p.comments.size == 0
+    #   # => true
+    #
+    def delete(model)
+      # LREM key 0 <id> means remove all elements matching <id>
+      # @see http://redis.io/commands/lrem
+      db.lrem(key, 0, model.id)
     end
 
+  private
+    def ids
+      db.lrange(key, 0, -1)
+    end
+
+    def db
+      model.db
+    end
+  end
+
+  # Defines most of the methods used by `Set` and `MultiSet`.
+  class BasicSet
+    include Collection
+
     # Allows you to sort by any field in your model.
     #
     # Example:
@@ -249,6 +370,7 @@ module Ohm
     def size
       execute { |key| db.scard(key) }
     end
+    alias :count :size
 
     # Syntactic sugar for `sort_by` or `sort` when you only need the
     # first element.
@@ -305,128 +427,17 @@ module Ohm
     end
   end
 
-  class List < Struct.new(:key, :namespace, :model)
-    include PipelinedFetch
-    include Enumerable
-
-    # Returns the total size of the list using LLEN.
-    def size
-      db.llen(key)
-    end
-
-    # Returns the first element of the list using LINDEX.
-    def first
-      model[db.lindex(key, 0)]
-    end
-
-    # Returns the last element of the list using LINDEX.
-    def last
-      model[db.lindex(key, -1)]
-    end
-
-    # Checks if the model is part of this List.
-    #
-    # An important thing to note is that this method loads all of the
-    # elements of the List since there is no command in Redis that
-    # allows you to actually check the list contents efficiently.
-    #
-    # You may want to avoid doing this if your list has say, 10K entries.
-    def include?(model)
-      ids.include?(model.id.to_s)
-    end
-
-    # Replace all the existing elements of a list with a different
-    # collection of models. This happens atomically in a MULTI-EXEC
-    # block.
-    #
-    # Example:
-    #
-    #   user = User.create
-    #   p1 = Post.create
-    #   user.posts.push(p1)
-    #
-    #   p2, p3 = Post.create, Post.create
-    #   user.posts.replace([p2, p3])
-    #
-    #   user.posts.include?(p1)
-    #   # => false
-    #
-    def replace(models)
-      ids = models.map { |model| model.id }
+  class Set < BasicSet
+    attr :key
+    attr :namespace
+    attr :model
 
-      model.db.multi do
-        db.del(key)
-        ids.each { |id| db.rpush(key, id) }
-      end
+    def initialize(key, namespace, model)
+      @key = key
+      @namespace = namespace
+      @model = model
     end
 
-    # Fetch the data from Redis in one go.
-    def to_a
-      fetch(ids)
-    end
-
-    def each
-      to_a.each { |element| yield element }
-    end
-
-    def empty?
-      size == 0
-    end
-
-    # Pushes the model to the _end_ of the list using RPUSH.
-    def push(model)
-      db.rpush(key, model.id)
-    end
-
-    # Pushes the model to the _beginning_ of the list using LPUSH.
-    def unshift(model)
-      db.lpush(key, model.id)
-    end
-
-    # Delete a model from the list.
-    #
-    # Note: If your list contains the model multiple times, this method
-    # will delete all instances of that model in one go.
-    #
-    # Example:
-    #
-    #   class Comment < Ohm::Model
-    #   end
-    #
-    #   class Post < Ohm::Model
-    #     list :comments, Comment
-    #   end
-    #
-    #   p = Post.create
-    #   c = Comment.create
-    #
-    #   p.comments.push(c)
-    #   p.comments.push(c)
-    #
-    #   p.comments.delete(c)
-    #
-    #   p.comments.size == 0
-    #   # => true
-    #
-    def delete(model)
-      # LREM key 0 <id> means remove all elements matching <id>
-      # @see http://redis.io/commands/lrem
-      db.lrem(key, 0, model.id)
-    end
-
-  private
-    def ids
-      db.lrange(key, 0, -1)
-    end
-
-    def db
-      model.db
-    end
-  end
-
-  class Set < Struct.new(:key, :namespace, :model)
-    include Collection
-
     # Chain new fiters on an existing set.
     #
     # Example:
@@ -547,8 +558,16 @@ module Ohm
   #   User.find(:name => "John", :age => 30).kind_of?(Ohm::MultiSet)
   #   # => true
   #
-  class MultiSet < Struct.new(:namespace, :model, :command)
-    include Collection
+  class MultiSet < BasicSet
+    attr :namespace
+    attr :model
+    attr :command
+
+    def initialize(namespace, model, command)
+      @namespace = namespace
+      @model = model
+      @command = command
+    end
 
     # Chain new fiters on an existing set.
     #

data/test/enumerable.rb

@@ -0,0 +1,79 @@
+require File.expand_path("./helper", File.dirname(__FILE__))
+
+scope do
+  class Contact < Ohm::Model
+    attribute :name
+  end
+
+  setup do
+    john = Contact.create(name: "John Doe")
+    jane = Contact.create(name: "Jane Doe")
+
+    [john, jane]
+  end
+
+  test "Set#count doesn't do each" do
+    set = Contact.all
+
+    def set.each
+      raise "Failed"
+    end
+
+    assert_equal 2, set.count
+  end
+
+  test "Set#each as an Enumerator" do |john, jane|
+    enum = Contact.all.each
+
+    enum.each do |c|
+      assert c == john || c == jane
+    end
+  end
+
+  test "select" do |john, jane|
+    assert_equal 2, Contact.all.count
+    assert_equal [john], Contact.all.select { |c| c.id == john.id }
+  end
+end
+
+scope do
+  class Comment < Ohm::Model
+  end
+
+  class Post < Ohm::Model
+    list :comments, :Comment
+  end
+
+  setup do
+    c1 = Comment.create
+    c2 = Comment.create
+
+    post = Post.create
+    post.comments.push(c1)
+    post.comments.push(c2)
+
+    [post, c1, c2]
+  end
+
+  test "List#select" do |post, c1, c2|
+    assert_equal [c1], post.comments.select { |comment| comment == c1 }
+  end
+
+  test "List#each as Enumerator" do |post, c1, c2|
+    enum = post.comments.each
+
+    enum.each do |comment|
+      assert comment == c1 || comment == c2
+    end
+  end
+
+  test "List#count doesn't do each" do |post, c1, c2|
+    list = post.comments
+
+    def list.each
+      raise "Failed"
+    end
+
+    assert_equal 2, list.count
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ohm
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -15,7 +15,7 @@ date: 2012-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &2152402160 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +23,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152402160
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: nest
-  requirement: &2152401480 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -34,10 +39,15 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152401480
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: scrivener
-  requirement: &2152400640 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -45,10 +55,15 @@ dependencies:
         version: 0.0.3
   type: :runtime
   prerelease: false
-  version_requirements: *2152400640
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.3
 - !ruby/object:Gem::Dependency
   name: cutest
-  requirement: &2152400100 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -56,7 +71,12 @@ dependencies:
         version: '1.1'
   type: :development
   prerelease: false
-  version_requirements: *2152400100
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
 description: Ohm is a library that allows to store an object in Redis, a persistent
   key-value database. It includes an extensible list of validations and has very good
   performance.
@@ -81,6 +101,7 @@ files:
 - test/connection.rb
 - test/core.rb
 - test/counters.rb
+- test/enumerable.rb
 - test/extensibility.rb
 - test/filtering.rb
 - test/hash_key.rb
@@ -115,9 +136,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: ohm
-rubygems_version: 1.8.11
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Object-hash mapping library for Redis.
 test_files: []
-has_rdoc: