ohm-sorted 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NDlkNzNmNzllNTJmMDEzODExNGQ5MDlhMWM5NTYyMjA5MDQwNGUwMA==
+  data.tar.gz: !binary |-
+    ZjQ5YzdhNTg2NTYzMzY0YjljZjcxZDQ3Y2JjZjJhMmUzYWFmZmZlNw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MmFmNjgzODkwNzMyYzRiMjNhZTM2MDI5N2Y4NjRhYzMyMzcyNDgxZTYzMWE2
+    ZGZmNjI5M2E1ODdjYTE1MGYzMjlkZGFmYTI1MDE0ZDY1OTEyZTIyYzVhNzg4
+    OTk3NWVkMmFkNjE5M2UwNDdmZTUzYWE4YTE1MGUxNGJmMDg2MmM=
+  data.tar.gz: !binary |-
+    MzM3NDc5YWQzN2ZiN2EzOWQ3OTIxZDAxMDI5Y2YzZTEyMDlhMzcyNjVjMDdi
+    Yzc3NTQ4ZTQ3NzA2ZmI5NmIyZjk1NDIxNjYwZjg4NGU0NTAzM2JlNTljNTE0
+    ZWQ5ZGZjZDkwNmQyNmFhMjRhMDJjNTlmMjY3MmIxN2JiMDdmZWE=

data/.gitignore

@@ -0,0 +1,5 @@
+/pkg
+/doc
+/test/db/*
+gemfiles
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+before_script: "rake appraisal:install"
+script: "rake appraisal"

data/Appraisals

@@ -0,0 +1,11 @@
+appraise "ohm-0.x" do
+  gem "redis", "2.2.2"
+  gem "ohm", "0.1.3"
+  gem "ohm-contrib", "0.1.2"
+end
+
+appraise "ohm-1.x" do
+  gem "redis", "3.0.4"
+  gem "ohm", "1.3.2"
+  gem "ohm-contrib", "1.2"
+end

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.1.0
+
+ - Initial release

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "ohm"
+gem "ohm-contrib"

data/README.md

@@ -0,0 +1,41 @@
+ohm-sorted
+==========
+
+Sorted indexes for Ohm
+
+
+Setup
+-----
+
+1. Include the `Callbacks` and `Sorted` modules in your model:
+
+		include Ohm::Callbacks 
+		include Ohm::Sorted
+
+2. Add a sorted index to your model with the following line:
+
+		sorted :status, by: :ranking
+
+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")
+
+This returns an Ohm::SortedSet, which is just a subclass of Ohm::BasicSet
+backed by a sorted set.
+
+
+Requirements
+------------
+
+This plugin works with Ohm versions higher than 0.1.3.
+
+
+Acknowledgements
+----------------
+
+Many thanks to Damian Janowski (https://github.com/djanowski)

data/Rakefile

@@ -0,0 +1,33 @@
+require "rake/testtask"
+require "appraisal"
+require "bundler/setup"
+
+REDIS_DIR = File.expand_path(File.join("..", "test"), __FILE__)
+REDIS_CNF = File.join(REDIS_DIR, "test.conf")
+REDIS_PID = File.join(REDIS_DIR, "db", "redis.pid")
+
+task :default => :run
+
+desc "Run tests and manage server start/stop"
+task :run => [:start, :test, :stop]
+
+desc "Start the Redis server"
+task :start do
+  unless File.exists?(REDIS_PID)
+    system "redis-server #{REDIS_CNF}"
+  end
+end
+
+desc "Stop the Redis server"
+task :stop do
+  if File.exists?(REDIS_PID)
+    system "kill #{File.read(REDIS_PID)}"
+    File.delete(REDIS_PID)
+  end
+end
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end

data/UNLICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <http://unlicense.org/>

data/lib/ohm/sorted.rb

@@ -0,0 +1,163 @@
+require 'ohm'
+require 'ohm/contrib'
+
+module Ohm
+
+  if defined?(BasicSet)
+    class SortedSet < BasicSet
+      attr :key
+      attr :namespace
+      attr :model
+
+      def initialize(key, namespace, model)
+        @key = key
+        @namespace = namespace
+        @model = model
+      end
+
+      def ids
+        execute { |key| db.zrange(key, 0, -1) }
+      end
+
+      def size
+        execute { |key| db.zcard(key) }
+      end
+
+    private
+      def exists?(id)
+        execute { |key| !!db.zscore(key, id) }
+      end
+
+      def execute
+        yield key
+      end
+
+      def db
+        model.db
+      end
+    end
+  else
+    class SortedSet < Model::Collection
+      attr :key
+      attr :model
+
+      def initialize(key, _, model)
+        @key = key
+        @model = model
+      end
+
+      def db
+        model.db
+      end
+
+      def each(&block)
+        db.zrange(key, 0, -1).each { |id| block.call(model.to_proc[id]) }
+      end
+
+      def [](id)
+        model[id] if !!db.zrank(key, id)
+      end
+
+      def size
+        db.zcard(key)
+      end
+
+      def all
+        db.zrange(key, 0, -1).map(&model)
+      end
+
+      def first
+        db.zrange(key, 0, 1).map(&model).first
+      end
+
+      def include?(model)
+        !!db.zrank(key, model.id)
+      end
+
+      def inspect
+        "#<SortedSet (#{model}): #{db.zrange(key, 0, -1).inspect}>"
+      end
+    end
+  end
+
+  module Sorted
+    def self.included(model)
+      model.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def sorted(attr, options={})
+        sorted_indices[attr] = options
+      end
+
+      def sorted_indices
+        @sorted_indices ||= {}
+      end
+
+      def sorted_find(attribute, dict)
+        unless sorted_index_exists?(dict.keys.first, by: attribute)
+          raise index_not_found(attribute)
+        end
+
+        index_key = sorted_index_key(attribute, dict)
+        Ohm::SortedSet.new(index_key, key, self)
+      end
+
+      def sorted_index_exists?(attribute, options=nil)
+        index = sorted_indices[attribute]
+        !!(index && (options.nil? || options == index))
+      end
+
+      def sorted_index_key(attribute, dict)
+        [key, "sorted", dict.keys.first, attribute, dict.values.first].join(":")
+      end
+
+    protected
+      def index_not_found(attribute)
+        if defined?(IndexNotFound)
+          IndexNotFound
+        else
+          Model::IndexNotFound.new(attribute)
+        end
+      end
+    end
+
+  protected
+    def after_create
+      add_sorted_indices
+      super
+    end
+
+    def after_update
+      add_sorted_indices unless new?
+      super
+    end
+
+    def before_delete
+      remove_sorted_indices
+      super
+    end
+
+    def add_sorted_indices
+      update_sorted_indices do |key, attribute, options|
+        score = send(options[:by]).to_f
+        db.zadd(key, score, id)
+      end
+    end
+
+    def remove_sorted_indices
+      update_sorted_indices do |key, attribute, options|
+        db.zrem(key, id)
+      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)})
+        yield(key, attribute, options)
+      end
+    end
+  end
+end

data/ohm-sorted.gemspec

@@ -0,0 +1,11 @@
+Gem::Specification.new do |s|
+  s.name        = 'ohm-sorted'
+  s.version     = '0.1.0'
+  s.summary     = "Sorted indices for Ohm."
+  s.description = "An plugin for Ohm that lets you create sorted indices."
+  s.author      = "Federico Bond"
+  s.email       = 'federico@educabilia.com'
+  s.files       = `git ls-files`.split("\n")
+  s.homepage    = 'https://github.com/educabilia/ohm-sorted'
+  s.license     = 'UNLICENSE'
+end

data/test/sorted_test.rb

@@ -0,0 +1,93 @@
+require 'test/unit'
+require 'ohm/sorted'
+
+class Post < Ohm::Model
+  include Ohm::Callbacks
+  include Ohm::Sorted
+
+  attribute :order
+  attribute :status
+  
+  sorted :status, by: :order
+end
+
+class SortedTest < Test::Unit::TestCase
+  def setup
+    Ohm.flush
+  end
+
+  def test_sorted_find_returns_sorted_set
+    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)
+    sorted_set = Post.sorted_find(:order, status: "draft")
+
+    assert_equal post, sorted_set.first
+  end
+
+  def test_sorted_find_order
+    post_1 = Post.create(status: "draft", order: 2)
+    post_2 = Post.create(status: "draft", order: 3)
+    post_3 = Post.create(status: "draft", order: 1)
+    sorted_set = Post.sorted_find(:order, status: "draft")
+
+    assert_equal [post_3, post_1, post_2], sorted_set.to_a
+  end
+
+  def test_update
+    post_1 = Post.create(status: "draft", order: 1)
+    post_2 = Post.create(status: "draft", order: 2)
+
+    sorted_set = Post.sorted_find(:order, status: "draft")
+    assert_equal [post_1, post_2], sorted_set.to_a
+
+    post_1.update(order: 3)
+
+    sorted_set = Post.sorted_find(:order, status: "draft")
+    assert_equal [post_2, post_1], sorted_set.to_a
+  end
+
+  def test_delete
+    post = Post.create(status: "draft", order: 1)
+    post.delete
+
+    sorted_set = Post.sorted_find(:order, status: "draft")
+    assert_equal [], sorted_set.to_a
+  end
+
+  def test_indexes_nil
+    post = Post.create(status: "draft")
+    sorted_set = Post.sorted_find(:order, status: "draft")
+    assert_equal [post], sorted_set.to_a
+  end
+
+  def test_sorted_find_invalid
+    exception_class = defined?(Ohm::IndexNotFound) ? Ohm::IndexNotFound : Ohm::Model::IndexNotFound
+
+    Post.create(status: "draft", order: 1)
+    assert_raises(exception_class) do
+      Post.sorted_find(:foo, status: "draft")
+    end
+
+    assert_raises(exception_class) do
+      Post.sorted_find(:order, foo: "bar")
+    end
+  end
+
+  def test_sorted_set_index
+    post = Post.create(status: "draft", order: 1)
+    sorted_set = Post.sorted_find(:order, status: "draft")
+    assert_equal post, sorted_set[post.id]
+  end
+
+  def test_sorted_set_size
+    Post.create(status: "draft", order: 1)
+    sorted_set = Post.sorted_find(:order, status: "draft")
+    assert_equal 1, sorted_set.size
+  end
+end

data/test/test.conf

@@ -0,0 +1,8 @@
+dir ./test/db
+pidfile ./redis.pid
+port 6379
+timeout 300
+loglevel debug
+logfile stdout
+databases 16
+daemonize yes

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: ohm-sorted
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Federico Bond
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-05 00:00:00.000000000 Z
+dependencies: []
+description: An plugin for Ohm that lets you create sorted indices.
+email: federico@educabilia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Appraisals
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- UNLICENSE
+- lib/ohm/sorted.rb
+- ohm-sorted.gemspec
+- test/sorted_test.rb
+- test/test.conf
+homepage: https://github.com/educabilia/ohm-sorted
+licenses:
+- UNLICENSE
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.7
+signing_key: 
+specification_version: 4
+summary: Sorted indices for Ohm.
+test_files: []