ohm-sorted 0.1.0 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NDlkNzNmNzllNTJmMDEzODExNGQ5MDlhMWM5NTYyMjA5MDQwNGUwMA==
+    OGIxYjAxZmZiNTBlMmUwZTk0MDRkMTFlYTNjYjdmMGIyN2FmYTZhYQ==
   data.tar.gz: !binary |-
-    ZjQ5YzdhNTg2NTYzMzY0YjljZjcxZDQ3Y2JjZjJhMmUzYWFmZmZlNw==
+    NjAzZjNkNWFiNTM0MjI1OWUyOTA4ZWQ0MGJkY2QzNGZlODU0ODg0MA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MmFmNjgzODkwNzMyYzRiMjNhZTM2MDI5N2Y4NjRhYzMyMzcyNDgxZTYzMWE2
-    ZGZmNjI5M2E1ODdjYTE1MGYzMjlkZGFmYTI1MDE0ZDY1OTEyZTIyYzVhNzg4
-    OTk3NWVkMmFkNjE5M2UwNDdmZTUzYWE4YTE1MGUxNGJmMDg2MmM=
+    MWE3NjZlMDc4ZDY2MDhlODIyZTU1NzZiZTBlMWQyYzI3ZjcyMmU5YzhkZTlk
+    M2EyNTc3MTRjOWUyMjU1MGFmZTE0OTVlOGU5MTNmMzFmMTZjYjkzNTgxYTYw
+    YzM4MGQ0MGQ0MDcyNmQ3ZmQ3OTgwZWI1OWUwMTg1MjU4MWMyZWI=
   data.tar.gz: !binary |-
-    MzM3NDc5YWQzN2ZiN2EzOWQ3OTIxZDAxMDI5Y2YzZTEyMDlhMzcyNjVjMDdi
-    Yzc3NTQ4ZTQ3NzA2ZmI5NmIyZjk1NDIxNjYwZjg4NGU0NTAzM2JlNTljNTE0
-    ZWQ5ZGZjZDkwNmQyNmFhMjRhMDJjNTlmMjY3MmIxN2JiMDdmZWE=
+    MzUxODc5YzgzZDgzZjdmZDQ1ZjRiYmJkMWJlZGM1N2I4YzNlYjRkNTNjYWU0
+    ZDEyNDIzMjM3MjRkMmU1ZDhhYTU5OGUwYTEzOTM5YzkyNGZkNGExZWJiMWIx
+    MDA3NDUyZGUwZWQxYTdhMDlmOTg0NWFkNGQxNWViYjZlMTc0YTE=

data/README.md

@@ -1,6 +1,10 @@
 ohm-sorted
 ==========
 
+[![Gem Version](https://badge.fury.io/rb/ohm-sorted.png)](http://badge.fury.io/rb/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
 
 
@@ -14,7 +18,7 @@ Setup
 
 2. Add a sorted index to your model with the following line:
 
-		sorted :status, by: :ranking
+		sorted :ranking, group_by: :status
 
 You will need to resave every model if they already exist.
 
@@ -25,6 +29,7 @@ To query the sorted index, use the `sorted_find` class method.
 
     >> Post.sorted_find(:ranking, status: "draft")
 
+
 This returns an Ohm::SortedSet, which is just a subclass of Ohm::BasicSet
 backed by a sorted set.
 

data/lib/ohm/sorted.rb

@@ -3,8 +3,57 @@ 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
+    end
+
+    def offset(n)
+      set = dup
+      set.offset = n
+      set
+    end
+
+    def start
+      @start ||= (@offset || 0)
+    end
+
+    def stop
+      @stop ||= (@limit.nil? ? -1 : start + @limit - 1)
+    end
+
+    def range(range)
+      set = dup
+      set.range = range
+      set
+    end
+
+    def ids
+      if @range.nil?
+        execute { |key| db.zrange(key, start, stop) }
+      else
+        execute { |key| db.zrangebyscore(key, @range.begin.to_f, @range.end.to_f, offset: [start, stop]) }
+      end
+    end
+
+    unless instance_methods.include?(:execute)
+      def execute
+        yield key
+      end
+      private :execute
+    end
+  end
+
   if defined?(BasicSet)
     class SortedSet < BasicSet
+      include SortedMethods
+
       attr :key
       attr :namespace
       attr :model
@@ -15,14 +64,14 @@ module Ohm
         @model = model
       end
 
-      def ids
-        execute { |key| db.zrange(key, 0, -1) }
-      end
-
       def size
         execute { |key| db.zcard(key) }
       end
 
+      def first
+        fetch(execute { |key| db.zrange(key, 0, 1) }).first
+      end
+
     private
       def exists?(id)
         execute { |key| !!db.zscore(key, id) }
@@ -38,6 +87,8 @@ module Ohm
     end
   else
     class SortedSet < Model::Collection
+      include Ohm::SortedMethods
+
       attr :key
       attr :model
 
@@ -51,7 +102,7 @@ module Ohm
       end
 
       def each(&block)
-        db.zrange(key, 0, -1).each { |id| block.call(model.to_proc[id]) }
+        ids.each { |id| block.call(model.to_proc[id]) }
       end
 
       def [](id)
@@ -63,11 +114,16 @@ module Ohm
       end
 
       def all
-        db.zrange(key, 0, -1).map(&model)
+        ids.map(&model)
       end
 
       def first
-        db.zrange(key, 0, 1).map(&model).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
       end
 
       def include?(model)
@@ -86,16 +142,16 @@ module Ohm
     end
 
     module ClassMethods
-      def sorted(attr, options={})
-        sorted_indices[attr] = options
+      def sorted(attribute, options={})
+        sorted_indices << [attribute, options]
       end
 
       def sorted_indices
-        @sorted_indices ||= {}
+        @sorted_indices ||= []
       end
 
-      def sorted_find(attribute, dict)
-        unless sorted_index_exists?(dict.keys.first, by: attribute)
+      def sorted_find(attribute, dict={})
+        unless sorted_index_exists?(attribute, to_options(dict))
           raise index_not_found(attribute)
         end
 
@@ -104,12 +160,18 @@ module Ohm
       end
 
       def sorted_index_exists?(attribute, options=nil)
-        index = sorted_indices[attribute]
-        !!(index && (options.nil? || options == index))
+        !!sorted_indices.detect { |i| i == [attribute, options] }
       end
 
-      def sorted_index_key(attribute, dict)
-        [key, "sorted", dict.keys.first, attribute, dict.values.first].join(":")
+      def sorted_index_key(attribute, dict={})
+        index_key = [key, "sorted", attribute]
+        if dict.keys.size == 1
+          index_key << dict.keys.first
+          index_key << dict.values.first
+        elsif dict.keys.size > 1
+          raise ArgumentError
+        end
+        index_key.join(":")
       end
 
     protected
@@ -120,6 +182,11 @@ module Ohm
           Model::IndexNotFound.new(attribute)
         end
       end
+
+      def to_options(dict)
+        return {} if dict.empty?
+        {group_by: dict.keys.first}
+      end
     end
 
   protected
@@ -128,6 +195,10 @@ module Ohm
       super
     end
 
+    def before_update
+      prune_sorted_indices
+    end
+
     def after_update
       add_sorted_indices unless new?
       super
@@ -140,7 +211,7 @@ module Ohm
 
     def add_sorted_indices
       update_sorted_indices do |key, attribute, options|
-        score = send(options[:by]).to_f
+        score = send(attribute).to_f
         db.zadd(key, score, id)
       end
     end
@@ -151,11 +222,33 @@ module Ohm
       end
     end
 
+    def prune_sorted_indices
+      return if new?
+      update_sorted_indices do |key, attribute, options|
+        return unless options.include?(:group_by)
+
+        old_value = db.hget(self.key, options[:group_by])
+        new_value = send(options[:group_by])
+
+        if old_value != new_value
+          opts = {options[:group_by] => old_value}
+          key = self.class.sorted_index_key(attribute, opts)
+          db.zrem(key, id)
+        end
+      end
+    end
+
     def update_sorted_indices
       self.class.sorted_indices.each do |args|
         attribute, options = *args
-        key = self.class.sorted_index_key(
-          options[:by], {attribute => send(attribute)})
+
+        opts = {}
+        if options.include?(:group_by)
+          group_by = options[:group_by]
+          opts[group_by] = send(group_by)
+        end
+        key = self.class.sorted_index_key(attribute, opts)
+
         yield(key, attribute, options)
       end
     end

data/ohm-sorted.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'ohm-sorted'
-  s.version     = '0.1.0'
+  s.version     = '0.2.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

@@ -7,8 +7,9 @@ class Post < Ohm::Model
 
   attribute :order
   attribute :status
-  
-  sorted :status, by: :order
+
+  sorted :order, group_by: :status
+  sorted :order
 end
 
 class SortedTest < Test::Unit::TestCase
@@ -20,14 +21,22 @@ class SortedTest < Test::Unit::TestCase
     Post.create(status: "draft", order: 1)
     sorted_set = Post.sorted_find(:order, status: "draft")
     assert_equal Ohm::SortedSet, sorted_set.class
-    assert_equal "Post:sorted:status:order:draft", sorted_set.key
   end
 
-  def test_sorted_find_first
-    post = Post.create(status: "draft", order: 1)
+  def test_sorted_find_set_key
+    Post.create(status: "draft", order: 1)
     sorted_set = Post.sorted_find(:order, status: "draft")
+    assert_equal "Post:sorted:order:status:draft", sorted_set.key
 
-    assert_equal post, sorted_set.first
+    sorted_set = Post.sorted_find(:order)
+    assert_equal "Post:sorted:order", sorted_set.key
+  end
+
+  def test_sorted_find_all
+    posts = []
+    posts << Post.create(order: 1)
+    posts << Post.create(order: 2)
+    assert_equal posts, Post.sorted_find(:order).to_a
   end
 
   def test_sorted_find_order
@@ -39,6 +48,41 @@ class SortedTest < Test::Unit::TestCase
     assert_equal [post_3, post_1, post_2], sorted_set.to_a
   end
 
+  def test_sorted_find_with_limit
+    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
+  end
+
+  def test_sorted_find_with_range
+    posts = []
+    posts << Post.create(status: "draft", order: 1)
+    posts << Post.create(status: "draft", order: 2)
+    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
+  end
+
+  def test_sorted_find_first
+    Post.create(status: "draft", order: 2)
+    post = Post.create(status: "draft", order: 1)
+    sorted_set = Post.sorted_find(:order, status: "draft")
+
+    assert_equal post, sorted_set.first
+  end
+
   def test_update
     post_1 = Post.create(status: "draft", order: 1)
     post_2 = Post.create(status: "draft", order: 2)
@@ -50,6 +94,13 @@ class SortedTest < Test::Unit::TestCase
 
     sorted_set = Post.sorted_find(:order, status: "draft")
     assert_equal [post_2, post_1], sorted_set.to_a
+
+    post_1.update(status: "published")
+
+    sorted_set = Post.sorted_find(:order, status: "draft")
+    assert_equal [post_2], sorted_set.to_a
+    sorted_set = Post.sorted_find(:order, status: "published")
+    assert_equal [post_1], sorted_set.to_a
   end
 
   def test_delete
@@ -67,7 +118,11 @@ class SortedTest < Test::Unit::TestCase
   end
 
   def test_sorted_find_invalid
-    exception_class = defined?(Ohm::IndexNotFound) ? Ohm::IndexNotFound : Ohm::Model::IndexNotFound
+    exception_class = if defined?(Ohm::IndexNotFound)
+      Ohm::IndexNotFound
+    else
+      Ohm::Model::IndexNotFound
+    end
 
     Post.create(status: "draft", order: 1)
     assert_raises(exception_class) do

metadata

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