ohm-sorted 0.2.1 → 0.3.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NTdhZWUxZTMxMjI1Y2E4OTliM2MzYjI2OTRmMDkxYjNlMzA1OTgzNg==
+    YmEwYzFiOTIwOGU3OWZhMGM2OTMzY2M4OTM1NTdmZTQ5Yzc4ZmUxMQ==
   data.tar.gz: !binary |-
-    NDMzNzZhMzZhMTIyMTRlODc0Njc1ZmQwNzg4NWY5YjY4NGE1NDVkMQ==
+    MGQ3YzdhZjUwYTQwNzJkZjJjOWEyOTQzYzQxNmJmYjFhNWI3YTc5Ng==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MDMyM2E5NjgxODMxNjI1MmZmMDRjZjU1YzFhNDJkNWRjMzliOTZjMjc2ZWY4
-    MTlkZDY5NmZhZjZmNjVlNGNmMTU2ZTRkM2Q1MTM5ODA1NjA0MWVmZjgyNzli
-    NWRlZjQzNjAyODFlNzQzNmY4MTM5NWYwMGI2M2ZhODA2NzA4Y2Q=
+    MzE1Y2VjYzZiYjFkZjU2ZDExZWI5ZDYxMTllZmYyYWQ1ZWUzNDVmYTk5YmVi
+    NGFmMDExNmU4OTc0ZThjNzE3ZDRiZGZmNDBjYzk3NWQxZGY1MDRhZjNmYWEx
+    M2Y1YTJjNzBhYjc4Mjk3ZjgxMTVjOWY1ODg1Y2I0ZDkxZDdhN2Y=
   data.tar.gz: !binary |-
-    NzBjNmIwYTdhYmJjNDM3NTAwOTFhZDhhZDM5YTYyOTRhMGIzNDU5Y2ZlMWMx
-    Y2VmNmIzZGZlNGZkZmE1YWZmMDIzMmQ5NTczNzViYWRhMGVjN2ViMDJjNjU4
-    YTc5YmFhOTdmYWE1MTA1MzRlN2U3MWQ4M2I0NWMzN2Q2YmZmZjM=
+    NjEzNTQ1M2JkYzk4MmQ3YmVjZmNkZjE0ZTc5NWQwYThiZDUzMDJjNjdmZTI3
+    Nzg1NDVmNzc2YTRhZGEwMjE0NTM0YjM5ZTEzZGEzMmZiN2FkOWY0ZjczYjZm
+    YjQ1MDM5ZTVmOWU1ZTQwMjg5MzEzMjY1ZjNlZGIzOTZjZDE4ZTc=

data/README.md

@@ -5,7 +5,7 @@ ohm-sorted
 [![Build Status](https://travis-ci.org/educabilia/ohm-sorted.png?branch=master)](https://travis-ci.org/educabilia/ohm-sorted)
 [![Code Climate](https://codeclimate.com/github/educabilia/ohm-sorted.png)](https://codeclimate.com/github/educabilia/ohm-sorted)
 
-Sorted indexes for Ohm
+Sorted indices for Ohm
 
 
 Setup
@@ -16,22 +16,46 @@ Setup
 		include Ohm::Callbacks 
 		include Ohm::Sorted
 
-2. Add a sorted index to your model with the following line:
+2. Add the sorted indices you want to your model:
 
-		sorted :ranking, group_by: :status
+  - If you want a complete index:
+
+        sorted :created_at
+
+  - If you want to partition the index based on an attribute:
+
+        sorted :created_at, :group_by => :site_id
+
+
+You can use both indices for the same attribute, as the partition keys are
+namespaced by the `group_by` attribute.
+
+You will need to resave every model if they already exist for the index to get
+built.
+
+The ranking attribute must be of a type that responds to `to_f`.
 
-You will need to resave every model if they already exist.
 
 Usage
 -----
 
 To query the sorted index, use the `sorted_find` class method.
 
-    >> Post.sorted_find(:ranking, status: "draft")
+    >> Post.sorted_find(:created_at, site_id: "ar")
+
+This returns an `Ohm::SortedSet`, similiar to an `Ohm::Set` but backed by a sorted
+set.
+
+To limit the results to a certain score range, use the `between` method.
+This and the following methods return a new copy of the set object, but data
+is not read until it is necessary.
+
+    >> Post.sorted_find(:created_at, site_id: "ar").between(start_time, end_time)
 
+To take a slice of the results, use the `slice` method. This returns a new copy
+of the set which will pass its `offset` and `count` parameters to Redis.
 
-This returns an Ohm::SortedSet, which is just a subclass of Ohm::BasicSet
-backed by a sorted set.
+    >> Post.sorted_find(:created_at, site_id: "ar").slice(2, 4)
 
 
 Requirements

data/lib/ohm/sorted.rb

@@ -4,49 +4,52 @@ require 'ohm/contrib'
 module Ohm
 
   module SortedMethods
-    attr_accessor :limit
-    attr_accessor :offset
-    attr_accessor :range
-
-    def limit(n)
-      set = dup
-      set.limit = n
-      set
+    attr :key
+    attr :namespace
+    attr :model
+
+    def initialize(key, namespace, model, options={})
+      @key = key
+      @namespace = namespace
+      @model = model
+      @options = options
     end
 
-    def offset(n)
-      set = dup
-      set.offset = n
-      set
+    def range
+      @options.fetch(:range, "-inf".."inf")
     end
 
-    def start
-      @start ||= (@offset || 0)
+    def offset
+      @options.fetch(:offset, 0)
     end
 
-    def stop
-      @stop ||= (@limit.nil? ? -1 : start + @limit - 1)
+    def count
+      @options.fetch(:count, -1)
     end
 
-    def range(range)
-      set = dup
-      set.range = range
-      set
+    def between(first, last)
+      range = first.to_f..last.to_f
+      opts = @options.merge(range: range)
+      SortedSet.new(key, namespace, model, opts)
     end
 
-    def ids
-      if @range.nil?
-        execute { |key| db.zrange(key, start, stop) }
+    def slice(*args)
+      if args.count == 1
+        self[args.first]
+      elsif args.count == 2
+        offset, count = *args
+        opts = @options.merge(offset: offset, count: count)
+        SortedSet.new(key, namespace, model, opts)
       else
-        execute { |key| db.zrangebyscore(key, @range.begin.to_f, @range.end.to_f, offset: [start, stop]) }
+        raise ArgumentError
       end
     end
 
-    unless instance_methods.include?(:execute)
-      def execute
-        yield key
+    def ids
+      execute do |key|
+        db.zrangebyscore(key, range.begin, range.end,
+          limit: [offset, count])
       end
-      private :execute
     end
   end
 
@@ -54,16 +57,6 @@ module Ohm
     class SortedSet < BasicSet
       include SortedMethods
 
-      attr :key
-      attr :namespace
-      attr :model
-
-      def initialize(key, namespace, model)
-        @key = key
-        @namespace = namespace
-        @model = model
-      end
-
       def size
         execute { |key| db.zcard(key) }
       end
@@ -90,11 +83,14 @@ module Ohm
       include Ohm::SortedMethods
 
       attr :key
+      attr :namespace
       attr :model
 
-      def initialize(key, _, model)
+      def initialize(key, namespace, model, options={})
         @key = key
         @model = model
+        @namespace = namespace
+        @options = options
       end
 
       def db
@@ -122,12 +118,8 @@ module Ohm
       end
 
       def first
-        if @range.nil?
-          ids = db.zrange(key, start, 1)
-        else
-          ids = db.zrangebyscore(key, @range.begin.to_f, @range.end.to_f, offset: [start, 1])
-        end
-        ids.map(&model).first
+        id = db.zrange(key, 0, 1).first
+        model[id] unless id.empty?
       end
 
       def include?(model)
@@ -137,6 +129,11 @@ module Ohm
       def inspect
         "#<SortedSet (#{model}): #{db.zrange(key, 0, -1).inspect}>"
       end
+
+    private
+      def execute
+        yield key
+      end
     end
   end
 
@@ -201,6 +198,7 @@ module Ohm
 
     def before_update
       prune_sorted_indices
+      super
     end
 
     def after_update

data/ohm-sorted.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'ohm-sorted'
-  s.version     = '0.2.1'
+  s.version     = '0.3.0'
   s.summary     = "Sorted indices for Ohm."
   s.description = "An plugin for Ohm that lets you create sorted indices."
   s.author      = "Federico Bond"

data/test/sorted_test.rb

@@ -48,20 +48,14 @@ class SortedTest < Test::Unit::TestCase
     assert_equal [post_3, post_1, post_2], sorted_set.to_a
   end
 
-  def test_sorted_find_with_limit
+  def test_sorted_find_with_slice
     posts = []
     posts << Post.create(order: 1)
     posts << Post.create(order: 2)
     Post.create(status: "draft", order: 3)
-    assert_equal posts, Post.sorted_find(:order).limit(2).to_a
-  end
-
-  def test_sorted_find_with_offset
-    Post.create(order: 1)
-    posts = []
-    posts << Post.create(order: 2)
-    posts << Post.create(order: 3)
-    assert_equal posts, Post.sorted_find(:order).offset(1).to_a
+    assert_equal posts, Post.sorted_find(:order).slice(0, 2).to_a
+    assert_equal posts[0, 1], Post.sorted_find(:order).slice(0, 1).to_a
+    assert_equal posts[1, 1], Post.sorted_find(:order).slice(1, 1).to_a
   end
 
   def test_sorted_find_with_range
@@ -71,8 +65,8 @@ class SortedTest < Test::Unit::TestCase
     posts << Post.create(status: "draft", order: 3)
     posts << Post.create(status: "published", order: 4)
     posts << Post.create(status: "draft", order: 5)
-    assert_equal posts.slice(1, 2), Post.sorted_find(:order).range(2..3).to_a
-    assert_equal [posts[3]], Post.sorted_find(:order, status: "published").range(2..4).to_a
+    assert_equal posts[1, 2], Post.sorted_find(:order).between(2, 3).to_a
+    assert_equal posts[3, 1], Post.sorted_find(:order, status: "published").between(2, 4).to_a
   end
 
   def test_sorted_find_first

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ohm-sorted
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Federico Bond
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-09 00:00:00.000000000 Z
+date: 2013-09-10 00:00:00.000000000 Z
 dependencies: []
 description: An plugin for Ohm that lets you create sorted indices.
 email: federico@educabilia.com