resolver 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.2@resolver --create

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010, 2011 Niklas Holmgren, Sutajio
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+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 OR COPYRIGHT HOLDERS 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.

data/README.md

@@ -0,0 +1,70 @@
+Resolver
+========
+
+Resolver is a flexible Redis-backed high performance index and cache
+solution for ActiveModel-like objects.
+
+Setup
+-----
+
+Assuming you already have Redis installed:
+
+    $ gem install resolver
+
+Or add the gem to your Gemfile.
+
+```ruby
+require 'resolver'
+Resolver.redis = 'redis://.../'
+```
+
+If you are using Rails, add the above to an initializer. If Redis is running
+on localhost and on the default port the second line is not needed.
+
+Example usage
+-------------
+
+```ruby
+class Post < ActiveRecord::Base
+  include Resolver::Key
+
+  key :category
+  key :slug, :unique => true
+
+end
+
+Post.create(:category => 'News', :slug => 'example-post')
+
+Post.find_by(:slug, 'example-post')
+Post.exists_with?(:slug, 'example-post') # => true
+Post.count_with(:category, 'News') # => 1
+```
+
+Development
+-----------
+
+If you want to make your own changes to Resolver, first clone the repo and
+run the tests:
+
+    git clone git://github.com/sutajio/resolver.git
+    cd resolver
+    rake test
+
+Remember to install the Redis server on your local machine.
+
+Contributing
+------------
+
+Once you've made your great commits:
+
+1. Fork Resolver
+2. Create a topic branch - git checkout -b my_branch
+3. Push to your branch - git push origin my_branch
+4. Create a Pull Request from your branch
+5. That's it!
+
+Author
+------
+
+Resolver was created by Niklas Holmgren (niklas@sutajio.se) and released under
+the MIT license.

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+$LOAD_PATH.unshift 'lib'
+
+task :default => [:test]
+
+task :test do
+  Dir.glob('test/**/*_test.rb').each do |file|
+    require File.expand_path(file)
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require 'resolver'

data/lib/resolver/key.rb

@@ -0,0 +1,97 @@
+module Resolver
+  module Key
+
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.send(:resolver_keys)
+      base.send(:include, InstanceMethods)
+      base.after_save :resolver_add_keys_to_index
+      base.after_destroy :resolver_remove_keys_from_index
+    end
+
+    module ClassMethods
+
+      def key(name, options = {})
+        @resolver_keys[name.to_sym] = options || {}
+        define_attribute_method(name)
+      end
+
+      def find_by(key, value)
+        if options = @resolver_keys[key.to_sym]
+          if options[:unique]
+            self.find(*Resolver.redis.get(index_name(key, value)))
+          else
+            self.find(Resolver.redis.smembers(index_name(key, value)))
+          end
+        end
+      end
+
+      def exists_with?(key, value)
+        Resolver.redis.exists(index_name(key, value))
+      end
+
+      def count_with(key, value)
+        if options = @resolver_keys[key.to_sym]
+          if options[:unique]
+            exists_with?(key, value) ? 1 : 0
+          else
+            Resolver.redis.scard(index_name(key, value))
+          end
+        end
+      end
+
+    protected
+
+      def resolver_keys
+        @resolver_keys ||= {}
+        @resolver_keys
+      end
+
+      def index_name(name, value)
+        "#{self.class.to_s}:#{name}:#{value}"
+      end
+
+      def write_index(key, object, options)
+        value = object.send(key)
+        if options[:unique]
+          Resolver.redis.setnx(index_name(key, value), object.id)
+        else
+          if object.respond_to?(:previous_changes) && object.send(:previous_changes).include?(key.to_s)
+            prev_value = object.send(:previous_changes)[key.to_s].first
+            Resolver.redis.smove(index_name(key, prev_value),
+                                 index_name(key, value), object.id)
+          else
+            Resolver.redis.sadd(index_name(key, value), object.id)
+          end
+        end
+      end
+
+      def clean_index(key, object, options)
+        value = object.send(key)
+        if options[:unique]
+          Resolver.redis.del(index_name(key, value))
+        else
+          Resolver.redis.srem(index_name(key, value), object.id)
+        end
+      end
+
+    end
+
+    module InstanceMethods
+
+      def resolver_add_keys_to_index
+        self.class.send(:resolver_keys).each do |key,options|
+          self.class.send(:write_index, key, self, options)
+        end
+      end
+
+      def resolver_remove_keys_from_index
+        self.class.send(:resolver_keys).each do |key,options|
+          self.class.send(:clean_index, key, self, options)
+        end
+      end
+
+    end
+
+  end
+end

data/lib/resolver/version.rb

@@ -0,0 +1,3 @@
+module Resolver
+  VERSION = "0.1.0"
+end

data/lib/resolver.rb

@@ -0,0 +1,44 @@
+require 'redis'
+require 'redis/namespace'
+
+require 'resolver/version'
+require 'resolver/key'
+
+module Resolver
+  extend self
+
+  # Accepts:
+  #   1. A 'hostname:port' string
+  #   2. A 'hostname:port:db' string (to select the Redis db)
+  #   3. A 'hostname:port/namespace' string (to set the Redis namespace)
+  #   4. A redis URL string 'redis://host:port'
+  #   5. An instance of `Redis`, `Redis::Client`, `Redis::DistRedis`,
+  #      or `Redis::Namespace`.
+  def redis=(server)
+    if server.respond_to? :split
+      if server =~ /redis\:\/\//
+        redis = Redis.connect(:url => server)
+      else
+        server, namespace = server.split('/', 2)
+        host, port, db = server.split(':')
+        redis = Redis.new(:host => host, :port => port,
+          :thread_safe => true, :db => db)
+      end
+      namespace ||= :resolver
+      @redis = Redis::Namespace.new(namespace, :redis => redis)
+    elsif server.respond_to? :namespace=
+      @redis = server
+    else
+      @redis = Redis::Namespace.new(:resolver, :redis => server)
+    end
+  end
+
+  # Returns the current Redis connection. If none has been created, will
+  # create a new one.
+  def redis
+    return @redis if @redis
+    self.redis = 'localhost:6379'
+    self.redis
+  end
+
+end

data/resolver.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "resolver/version"
+
+Gem::Specification.new do |s|
+  s.name        = "resolver"
+  s.version     = Resolver::VERSION
+  s.authors     = ["Niklas Holmgren"]
+  s.email       = ["niklas@sutajio.se"]
+  s.homepage    = "http://github.com/sutajio/resolver/"
+  s.summary     = %q{Resolver is a flexible Redis-backed high performance index and cache solution for ActiveModel-like objects.}
+  s.description = %q{Resolver is a flexible Redis-backed high performance index and cache solution for ActiveModel-like objects.}
+
+  s.rubyforge_project = "resolver"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.extra_rdoc_files  = [ "LICENSE", "README.md" ]
+  s.rdoc_options      = ["--charset=UTF-8"]
+
+  s.add_dependency('redis', '> 2.0.0')
+  s.add_dependency('redis-namespace', '> 0.8.0')
+  s.add_development_dependency('activemodel')
+end

data/test/redis-test.conf

@@ -0,0 +1,115 @@
+# Redis configuration file example
+
+# By default Redis does not run as a daemon. Use 'yes' if you need it.
+# Note that Redis will write a pid file in /var/run/redis.pid when daemonized.
+daemonize yes
+
+# When run as a daemon, Redis write a pid file in /var/run/redis.pid by default.
+# You can specify a custom pid file location here.
+pidfile ./test/redis-test.pid
+
+# Accept connections on the specified port, default is 6379
+port 9736
+
+# If you want you can bind a single interface, if the bind option is not
+# specified all the interfaces will listen for connections.
+#
+# bind 127.0.0.1
+
+# Close the connection after a client is idle for N seconds (0 to disable)
+timeout 300
+
+# Save the DB on disk:
+#
+#   save <seconds> <changes>
+#
+#   Will save the DB if both the given number of seconds and the given
+#   number of write operations against the DB occurred.
+#
+#   In the example below the behaviour will be to save:
+#   after 900 sec (15 min) if at least 1 key changed
+#   after 300 sec (5 min) if at least 10 keys changed
+#   after 60 sec if at least 10000 keys changed
+save 900 1
+save 300 10
+save 60 10000
+
+# The filename where to dump the DB
+dbfilename dump.rdb
+
+# For default save/load DB in/from the working directory
+# Note that you must specify a directory not a file name.
+dir ./test/
+
+# Set server verbosity to 'debug'
+# it can be one of:
+# debug (a lot of information, useful for development/testing)
+# notice (moderately verbose, what you want in production probably)
+# warning (only very important / critical messages are logged)
+loglevel debug
+
+# Specify the log file name. Also 'stdout' can be used to force
+# the demon to log on the standard output. Note that if you use standard
+# output for logging but daemonize, logs will be sent to /dev/null
+logfile stdout
+
+# Set the number of databases. The default database is DB 0, you can select
+# a different one on a per-connection basis using SELECT <dbid> where
+# dbid is a number between 0 and 'databases'-1
+databases 16
+
+################################# REPLICATION #################################
+
+# Master-Slave replication. Use slaveof to make a Redis instance a copy of
+# another Redis server. Note that the configuration is local to the slave
+# so for example it is possible to configure the slave to save the DB with a
+# different interval, or to listen to another port, and so on.
+
+# slaveof <masterip> <masterport>
+
+################################## SECURITY ###################################
+
+# Require clients to issue AUTH <PASSWORD> before processing any other
+# commands.  This might be useful in environments in which you do not trust
+# others with access to the host running redis-server.
+#
+# This should stay commented out for backward compatibility and because most
+# people do not need auth (e.g. they run their own servers).
+
+# requirepass foobared
+
+################################### LIMITS ####################################
+
+# Set the max number of connected clients at the same time. By default there
+# is no limit, and it's up to the number of file descriptors the Redis process
+# is able to open. The special value '0' means no limts.
+# Once the limit is reached Redis will close all the new connections sending
+# an error 'max number of clients reached'.
+
+# maxclients 128
+
+# Don't use more memory than the specified amount of bytes.
+# When the memory limit is reached Redis will try to remove keys with an
+# EXPIRE set. It will try to start freeing keys that are going to expire
+# in little time and preserve keys with a longer time to live.
+# Redis will also try to remove objects from free lists if possible.
+#
+# If all this fails, Redis will start to reply with errors to commands
+# that will use more memory, like SET, LPUSH, and so on, and will continue
+# to reply to most read-only commands like GET.
+#
+# WARNING: maxmemory can be a good idea mainly if you want to use Redis as a
+# 'state' server or cache, not as a real DB. When Redis is used as a real
+# database the memory usage will grow over the weeks, it will be obvious if
+# it is going to use too much memory in the long run, and you'll have the time
+# to upgrade. With maxmemory after the limit is reached you'll start to get
+# errors for write operations, and this may even lead to DB inconsistency.
+
+# maxmemory <bytes>
+
+############################### ADVANCED CONFIG ###############################
+
+# Glue small output buffers together in order to send small replies in a
+# single TCP packet. Uses a bit more CPU but most of the times it is a win
+# in terms of number of queries per second. Use 'yes' if unsure.
+glueoutputbuf yes

data/test/resolver_test.rb

@@ -0,0 +1,60 @@
+require File.expand_path('test/test_helper')
+require File.expand_path('test/test_model')
+
+class ResolverTest < Test::Unit::TestCase
+
+  TestModel.send(:include, Resolver::Key)
+
+  def setup
+    Resolver.redis.flushall
+    TestModel.reset
+  end
+
+  def test_can_set_a_namespace_through_a_url_like_string
+    assert Resolver.redis
+    assert_equal :resolver, Resolver.redis.namespace
+    Resolver.redis = 'localhost:9736/namespace'
+    assert_equal 'namespace', Resolver.redis.namespace
+  end
+
+  def test_key
+    TestModel.key(:example)
+    TestModel.create('one', :example => 'foo')
+    TestModel.create('two', :example => 'foo')
+    assert_equal [TestModel.new('one'), TestModel.new('two')], TestModel.find_by(:example, 'foo').sort
+    assert_equal [], TestModel.find_by(:example, 'bar')
+    assert_equal true, TestModel.exists_with?(:example, 'foo')
+    assert_equal false, TestModel.exists_with?(:example, 'bar')
+    assert_equal 2, TestModel.count_with(:example, 'foo')
+    assert_equal 0, TestModel.count_with(:example, 'bar')
+    TestModel.find('one').first.destroy
+    TestModel.find('two').first.destroy
+    assert_equal 0, TestModel.count_with(:example, 'foo')
+    assert_equal false, TestModel.exists_with?(:example, 'foo')
+  end
+
+  def test_key_moving
+    TestModel.key(:example)
+    one = TestModel.create('one', :example => 'foo')
+    assert_equal [one], TestModel.find_by(:example, 'foo')
+    one.update_attributes(:example => 'bar')
+    assert_equal [], TestModel.find_by(:example, 'foo')
+    assert_equal [one], TestModel.find_by(:example, 'bar')
+  end
+
+  def test_unique_key
+    TestModel.key(:example, :unique => true)
+    TestModel.create('one', :example => 'foo')
+    TestModel.create('two', :example => 'foo')
+    assert_equal [TestModel.new('one')], TestModel.find_by(:example, 'foo')
+    assert_equal true, TestModel.exists_with?(:example, 'foo')
+    assert_equal false, TestModel.exists_with?(:example, 'bar')
+    assert_equal 1, TestModel.count_with(:example, 'foo')
+    assert_equal 0, TestModel.count_with(:example, 'bar')
+    TestModel.find('one').first.destroy
+    TestModel.find('two').first.destroy
+    assert_equal 0, TestModel.count_with(:example, 'foo')
+    assert_equal false, TestModel.exists_with?(:example, 'foo')
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,43 @@
+
+dir = File.dirname(File.expand_path(__FILE__))
+$LOAD_PATH.unshift dir + '/../lib'
+
+require 'rubygems'
+require 'test/unit'
+require 'resolver'
+
+#
+# make sure we can run redis
+#
+
+if !system("which redis-server")
+  puts '', "** can't find `redis-server` in your path"
+  puts "** try running `sudo rake install`"
+  abort ''
+end
+
+
+#
+# start our own redis when the tests start,
+# kill it when they end
+#
+
+at_exit do
+  next if $!
+
+  if defined?(MiniTest)
+    exit_code = MiniTest::Unit.new.run(ARGV)
+  else
+    exit_code = Test::Unit::AutoRunner.run
+  end
+
+  pid = `ps -A -o pid,command | grep [r]edis-test`.split(" ")[0]
+  puts "Killing test redis server..."
+  `rm -f #{dir}/dump.rdb`
+  Process.kill("KILL", pid.to_i)
+  exit exit_code
+end
+
+puts "Starting redis for testing at localhost:9736..."
+`redis-server #{dir}/redis-test.conf`
+Resolver.redis = 'localhost:9736'

data/test/test_model.rb

@@ -0,0 +1,99 @@
+require 'active_model'
+
+class TestModel
+  extend ActiveModel::Callbacks
+  include ActiveModel::Dirty
+
+  define_model_callbacks :create, :update, :destroy, :save
+
+  attr_reader :id
+  attr_reader :attributes
+  attr_accessor :persisted
+
+  def initialize(id, attributes = {})
+    @id = id
+    @attributes = attributes
+  end
+
+  def to_key
+    @id
+  end
+
+  def method_missing(sym, *args, &block)
+     if @attributes.keys.include?(sym)
+       @attributes[sym]
+     else
+       super
+     end
+  end
+
+  def <=>(other)
+    self.to_key <=> other.to_key
+  end
+
+  def ==(other)
+    other ? self.to_key == other.to_key : false
+  end
+
+  def save
+    run_callbacks :save do
+      @persisted ? update : create
+      @previously_changed = changes
+      @changed_attributes.clear
+    end
+    self
+  end
+
+  def destroy
+    run_callbacks :destroy do
+      @@database ||= {}
+      @@database[@id] = nil
+    end
+  end
+
+  def update_attributes(attributes)
+    attributes.keys.each do |key|
+      unless @attributes[key] == attributes[key]
+        self.send("#{key}_will_change!")
+      end
+    end
+    @attributes.merge!(attributes)
+    save
+  end
+
+  def self.create(id, attributes = {})
+    self.new(id, attributes).save
+  end
+
+  def self.find(*ids)
+    @@database ||= {}
+    ids.flatten.map do |id|
+      if @@database[id]
+        doc = self.new(id, @@database[id])
+        doc.persisted = true
+        doc
+      end
+    end
+  end
+
+  def self.reset
+    @@database = {}
+  end
+
+protected
+
+  def create
+    run_callbacks :create do
+      @@database ||= {}
+      @@database[@id] = @attributes
+    end
+  end
+
+  def update
+    run_callbacks :update do
+      @@database ||= {}
+      @@database[@id] = @attributes
+    end
+  end
+
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification 
+name: resolver
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Niklas Holmgren
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-02 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: redis-namespace
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 0
+        version: 0.8.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activemodel
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Resolver is a flexible Redis-backed high performance index and cache solution for ActiveModel-like objects.
+email: 
+- niklas@sutajio.se
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- init.rb
+- lib/resolver.rb
+- lib/resolver/key.rb
+- lib/resolver/version.rb
+- resolver.gemspec
+- test/redis-test.conf
+- test/resolver_test.rb
+- test/test_helper.rb
+- test/test_model.rb
+has_rdoc: true
+homepage: http://github.com/sutajio/resolver/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: resolver
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Resolver is a flexible Redis-backed high performance index and cache solution for ActiveModel-like objects.
+test_files: 
+- test/redis-test.conf
+- test/resolver_test.rb
+- test/test_helper.rb
+- test/test_model.rb