dm-redis-adapter 0.3.0 → 0.4.0

data/README.textile

@@ -1,19 +1,16 @@
 h1. dm-redis-adapter
 
-This is a <a href="http://datamapper.org">DataMapper</a> adapter for the <a href="http://github.com/antirez/redis/">Redis</a> key-value database.
+This is a <a href="http://datamapper.org">DataMapper</a> adapter for the <a href="http://redis.io/">Redis</a> key-value store.
 
-Redis is a very fast key-value store with some interesting data structures added.  You can have a key that is a SET, LIST, STRING or HASH that is binary safe.  Data structures like SET and LIST allow for even more interesting things.  Redis is a fabulous and fast engine for data structures, and you can read more about it here: <a href="http://code.google.com/p/redis/">redis</a>.  Redis is also a persistent data store, and can be used in large-scale environments with master-slave replication and consistent hashing on the client side.
+Redis is a very fast key-value store with some interesting data structures added, and oh so much more. You can have a key that is a SET, LIST, STRING or HASH that is binary safe. Data structures like SET and LIST allow for even more interesting things. Redis is a fabulous and fast engine for data structures, and you can read more about it here: <a href="http://code.google.com/p/redis/">redis</a>. Redis is also a persistent data store, and can be used in large-scale environments with master-slave replication and consistent hashing on the client side. Redis makes everyone happy and has been known to cause sunshine to spontaneously break out in clouded areas.
 
-<a href="http://datamapper.org">DataMapper</a> is a brilliant ORM that is based on the <a href="http://www.martinfowler.com/eaaCatalog/identityMap.html">IdentityMap</a> pattern.  Usage of DataMapper resembles that of ActiveRecord, the popular ORM bundled with Ruby on Rails, but with some very important differences.  A quote from the DM wiki: "One row in the database should equal one object reference. Pretty simple idea. Pretty profound impact."  Having an identity map allows for very efficient queries to the database, as well as interesting forms of lazy loading of attributes or associations.
+<a href="http://datamapper.org">DataMapper</a> is a brilliant ORM that is based on the <a href="http://www.martinfowler.com/eaaCatalog/identityMap.html">IdentityMap</a> pattern.  Usage of DataMapper resembles that of ActiveRecord, the popular ORM bundled with Ruby on Rails, but with some very important differences. A quote from the DM wiki: "One row in the database should equal one object reference. Pretty simple idea. Pretty profound impact." Having an identity map allows for very efficient queries to the database, as well as interesting forms of lazy loading of attributes or associations.
 
 Marrying DataMapper to Redis allows for schema-less models, you can add fields at any time without having to create a migration.  DataMapper also allows us to store non-native Redis types in the db, like Date fields.
 
-h1. Upgrading
-
-> v0.1 is not compatible with data created with previous versions!  The new storage schema is designed to be more VM friendly.  I won't be releasing a gem version of v0.1 until a stable version of redis that includes hash support has been released.
-
 h1. Changelog
 
+* v0.4.0  Support for dm-core v1.1.0
 * v0.3.0  Updates to support ruby 1.9.2 (thanks arbarlow!)
 * v0.2.1  Fixes to sorting
 * v0.1.1  Update to redis-rb v2.0.0
@@ -24,9 +21,7 @@ h1. Install
 
 Prerequisites:
 * Redis:
-** <a href="http://code.google.com/p/redis/">Redis, v2.0.x RC series</a>
-* Gems:
-** <a href="http://github.com/datamapper/dm-core/">dm-core</a> v1.0.2
+** <a href="http://code.google.com/p/redis/">Redis, v2.2 series</a>
 
 Install the dm-redis adapter:
 <pre>

data/Rakefile

@@ -26,27 +26,14 @@ begin
     gemspec.homepage = HOMEPAGE
     gemspec.description = SUMMARY
     gemspec.authors = AUTHORS
-    gemspec.add_dependency "dm-core", ">= 1.0.2"
-    gemspec.add_dependency "dm-types", ">= 1.0.2"
-    gemspec.add_dependency "redis", ">= 2.0.3"
+    gemspec.add_dependency "dm-core", ">= 1.1.0"
+    gemspec.add_dependency "dm-types", ">= 1.1.0"
+    gemspec.add_dependency "hiredis", "~> 0.3.0"
+    gemspec.add_dependency "redis", "~> 2.2"
     gemspec.files = %w(MIT-LICENSE README.textile Rakefile) + Dir.glob("{lib,spec}/**/*")
     gemspec.has_rdoc = false
     gemspec.extra_rdoc_files = ["MIT-LICENSE"]
-    gemspec.post_install_message = <<-POST_INSTALL_MESSAGE
-!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-
-                       (!!)   U P G R A D I N G    (!!)
-
-                         WAAAAAAAAAAAAAAAAAAAAAAAAIT!
-
-                  Versions of dm-redis-adapter prior to v0.1
-                 use a different method of storing properties
-               which means that this version of dm-redis-adapter
-                          won't read them properly.
-
-!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-POST_INSTALL_MESSAGE
-    end
+  end
 rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
 end

data/lib/dm-redis-adapter/adapter.rb

@@ -1,5 +1,6 @@
+require 'redis/connection/hiredis'
 require 'redis'
-require "base64"
+require 'base64'
 
 module DataMapper
   module Adapters
@@ -35,7 +36,8 @@ module DataMapper
       #
       # @api semipublic
       def read(query)
-        records = records_for(query).each do |record|
+        records = records_for(query)
+        records.each do |record|
           record_data = @redis.hgetall("#{query.model.to_s.downcase}:#{record[redis_key_for(query.model)]}")
 
           query.fields.each do |property|
@@ -49,11 +51,10 @@ module DataMapper
             # now. All other typecasting is handled by datamapper
             # separately.
             record[name] = [Integer, Date].include?(property.primitive) ? property.typecast( value ) : value
+            record
           end
         end
-        records = query.match_records(records)
-        records = query.sort_records(records)
-        records
+        query.filter_records(records)
       end
 
       ##
@@ -119,7 +120,7 @@ module DataMapper
           properties_to_set = []
           properties_to_del = []
 
-          fields = model.properties(self.name).select {|property| attributes.key?(property) }
+          fields = model.properties(self.name).select {|property| attributes.key?(property)}
           fields.each do |property|
             value = attributes[property]
             if value.nil?
@@ -148,39 +149,73 @@ module DataMapper
       def records_for(query)
         keys = []
 
-        query.conditions.operands.select {|o| o.is_a?(DataMapper::Query::Conditions::EqualToComparison)}.each do |o|
-          if query.model.key.include?(o.subject)
-            if @redis.sismember(key_set_for(query.model), o.value)
-              keys << {"#{redis_key_for(query.model)}" => o.value}
-            end
+        if query.conditions.nil?
+          @redis.smembers(key_set_for(query.model)).each do |key|
+            keys << {redis_key_for(query.model) => key.to_i}
           end
-          find_matches(query, o).each do |k|
-            keys << {"#{redis_key_for(query.model)}" => k.to_i, "#{o.subject.name}" => o.value}
+        else
+          query.conditions.operands.each do |operand|
+            if operand.is_a?(DataMapper::Query::Conditions::OrOperation)
+              operand.each do |op|
+                keys = keys + perform_query(query, op)
+              end
+            else
+              keys = perform_query(query, operand)
+            end
           end
         end
+        keys
+      end
 
-        if keys.empty? && (query.order || query.limit)
-          params = {}
-          params[:limit] = [query.offset, query.limit] if query.limit
+      ##
+      # Find records that match have a matching value
+      #
+      # @param [DataMapper::Query] query
+      #   The query used to locate the resources to be deleted.
+      #
+      # @param [DataMapper::Operation] the operation for the query
+      #
+      # @api private
+      def perform_query(query, operand)
+        matched_records = []
 
-          if query.order
-            order = query.order.first
-            params[:order] = order.operator.to_s
-          end
+        if operand.is_a?(DataMapper::Query::Conditions::NotOperation)
+          subject = operand.first.subject
+          value = operand.first.value
+        elsif operand.subject.is_a?(DataMapper::Associations::ManyToOne::Relationship)
+          subject = operand.subject.child_key.first
+          value = operand.value[operand.subject.parent_key.first.name]
+        else
+          subject = operand.subject
+          value =  operand.value
+        end
 
-          @redis.sort(key_set_for(query.model), params).each do |val|
-            keys << {"#{redis_key_for(query.model)}" => val.to_i}
-          end
+        if subject.is_a?(DataMapper::Associations::ManyToOne::Relationship)
+          subject = subject.child_key.first
         end
 
-        # Keys are empty, fall back and load all the values for this model
-        if keys.empty?
-          @redis.smembers(key_set_for(query.model)).each do |val|
-            keys << {"#{redis_key_for(query.model)}" => val.to_i}
+        if query.model.key.include?(subject)
+          if operand.is_a?(DataMapper::Query::Conditions::NotOperation)
+            @redis.smembers(key_set_for(query.model)).each do |key|
+              if operand.matches?(subject.typecast(key))
+                matched_records << {redis_key_for(query.model) => key}
+              end
+            end
+          elsif @redis.sismember(key_set_for(query.model), value)
+            matched_records << {redis_key_for(query.model) => value}
+          end
+        elsif subject.index
+          find_indexed_matches(subject, value).each do |k|
+            matched_records << {redis_key_for(query.model) => k.to_i, "#{subject.name}" => value}
+          end
+        else # worst case, loop through each record and match
+          @redis.smembers(key_set_for(query.model)).each do |key|
+            if operand.matches?(subject.typecast(@redis.hget("#{query.model.to_s.downcase}:#{key}", subject.name)))
+              matched_records << {redis_key_for(query.model) => key.to_i}
+            end
           end
         end
-
-        keys
+        matched_records
       end
 
       ##
@@ -211,10 +246,10 @@ module DataMapper
       # Find a matching entry for a query
       #
       # @return [Array]
-      #   Array of id's of all members matching the query
+      #   Array of id's of all members for an indexed field
       # @api private
-      def find_matches(query, operand)
-        @redis.smembers("#{query.model.to_s.downcase}:#{operand.subject.name}:#{encode(operand.value.to_s)}")
+      def find_indexed_matches(subject, value)
+        @redis.smembers("#{subject.model.to_s.downcase}:#{subject.name}:#{encode(value)}")
       end
 
       ##

data/spec/dm_redis_associations_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe DataMapper::Adapters::RedisAdapter do
+  before(:all) do
+    @adapter = DataMapper.setup(:default, {
+      :adapter  => "redis",
+      :db => 15
+    })
+  end
+
+  it "should allow has n :through" do
+    class Book
+      include DataMapper::Resource
+
+      property :id,   Serial
+      property :name, String
+
+      has n, :book_tags
+      has n, :tags, :through => :book_tags
+    end
+
+    class Tag
+      include DataMapper::Resource
+
+      property :id,   Serial
+      property :name, String
+
+      has n, :book_tags
+      has n, :books, :through => :book_tags
+    end
+
+    class BookTag
+      include DataMapper::Resource
+
+      property :id,   Serial
+
+      belongs_to :book
+      belongs_to :tag
+    end
+
+    b = Book.create(:name => "Harry Potter")
+    t = Tag.create(:name => "fiction")
+
+    b.tags << t
+    b.save
+
+    b2 = Book.get(b.id)
+    b2.tags.should == [t]
+  end
+end

data/spec/dm_redis_spec.rb

@@ -1,12 +1,5 @@
 require 'spec_helper'
 
-require 'dm-core'
-require 'dm-core/spec/shared/adapter_spec'
-require 'dm-redis-adapter/spec/setup'
-
-ENV['ADAPTER']          = 'redis'
-ENV['ADAPTER_SUPPORTS'] = 'all'
-
 describe DataMapper::Adapters::RedisAdapter do
   before(:all) do
     @adapter = DataMapper.setup(:default, {
@@ -14,12 +7,39 @@ describe DataMapper::Adapters::RedisAdapter do
       :db => 15
     })
     @repository = DataMapper.repository(@adapter.name)
+    @redis = Redis.new(:db => 15)
   end
 
   it_should_behave_like 'An Adapter'
-  
+
+  describe "adapter level tests" do
+    before(:all) do
+      class Hooloovoo
+        include DataMapper::Resource
+
+        property :id,         Serial
+        property :iq,         Integer
+        property :shade,      String, :index => true
+      end
+    end
+
+    it "should save the id of the resource in a set" do
+      h = Hooloovoo.create
+      @redis.smembers("hooloovoo:id:all").should == [h.id.to_s]
+    end
+
+    it "should save indexed fields in a set by Base64 encoding the value" do
+      h = Hooloovoo.create(:shade => '336699')
+      @redis.smembers("hooloovoo:shade:MzM2Njk5").should == [h.id.to_s]
+    end
+
+    it "should create a hash of properties for the resource" do
+      h = Hooloovoo.create(:iq => '4069')
+      @redis.hmget("hooloovoo:#{h.id}", 'iq').should == ['4069']
+    end
+  end
+
   after(:all) do
-    redis = Redis.new(:db => 15)
-    redis.flushdb
+    @redis.flushdb
   end
-end
+end

data/spec/dm_redis_validations_spec.rb

@@ -1,14 +1,12 @@
 require File.expand_path("../spec_helper", __FILE__)
 require 'dm-validations'
 require 'dm-types'
-require 'logger'
 
 describe DataMapper::Adapters::RedisAdapter do
   before(:all) do
     @adapter = DataMapper.setup(:default, {
       :adapter  => "redis",
       :db => 15,
-      # :logger => Logger.new(STDOUT)
     })
   end
 
@@ -117,7 +115,7 @@ describe DataMapper::Adapters::RedisAdapter do
     petey = Blackguard.create(:nickname => "Petey 'one-eye' McGraw")
     james = Blackguard.create(:nickname => "James 'cannon-fingers' Doolittle")
     Blackguard.get(petey.id).should_not be_destroyed
-    #Blackguard.first(:nickname => "James 'cannon-fingers' Doolittle").should_not be_destroyed
+    Blackguard.first(:nickname => "James 'cannon-fingers' Doolittle").should_not be_destroyed
   end
 
   after(:each) do

data/spec/spec_helper.rb

@@ -8,4 +8,9 @@ rescue LoadError
   Bundler.setup
 end
 
-require 'dm-core'
+require 'dm-core'
+require 'dm-core/spec/shared/adapter_spec'
+require 'dm-redis-adapter/spec/setup'
+
+ENV['ADAPTER']          = 'redis'
+ENV['ADAPTER_SUPPORTS'] = 'all'

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Dan Herrera
@@ -14,11 +14,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-13 00:00:00 -08:00
+date: 2011-05-17 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: dm-core
+  prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -26,14 +27,14 @@ dependencies:
       - !ruby/object:Gem::Version 
         segments: 
         - 1
+        - 1
         - 0
-        - 2
-        version: 1.0.2
+        version: 1.1.0
   type: :runtime
-  prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: dm-types
+  prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -41,27 +42,40 @@ dependencies:
       - !ruby/object:Gem::Version 
         segments: 
         - 1
+        - 1
         - 0
-        - 2
-        version: 1.0.2
+        version: 1.1.0
   type: :runtime
-  prerelease: false
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: redis
+  name: hiredis
+  prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
-        - 2
         - 0
         - 3
-        version: 2.0.3
+        - 0
+        version: 0.3.0
   type: :runtime
-  prerelease: false
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 2
+        version: "2.2"
+  type: :runtime
+  version_requirements: *id004
 description: DataMapper adapter for the Redis key-value database
 email: whoahbot@gmail.com
 executables: []
@@ -77,6 +91,7 @@ files:
 - lib/dm-redis-adapter.rb
 - lib/dm-redis-adapter/adapter.rb
 - lib/dm-redis-adapter/spec/setup.rb
+- spec/dm_redis_associations_spec.rb
 - spec/dm_redis_spec.rb
 - spec/dm_redis_validations_spec.rb
 - spec/spec_helper.rb
@@ -84,20 +99,7 @@ has_rdoc: true
 homepage: http://github.com/whoahbot/dm-redis-adapter
 licenses: []
 
-post_install_message: |
-  !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-  
-                         (!!)   U P G R A D I N G    (!!)
-  
-                           WAAAAAAAAAAAAAAAAAAAAAAAAIT!
-  
-                    Versions of dm-redis-adapter prior to v0.1
-                   use a different method of storing properties
-                 which means that this version of dm-redis-adapter
-                            won't read them properly.
-  
-  !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-
+post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
 require_paths: 
@@ -107,7 +109,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -599772013771505698
       segments: 
       - 0
       version: "0"
@@ -127,6 +128,7 @@ signing_key:
 specification_version: 3
 summary: DataMapper adapter for the Redis key-value database
 test_files: 
+- spec/dm_redis_associations_spec.rb
 - spec/dm_redis_spec.rb
 - spec/dm_redis_validations_spec.rb
 - spec/spec_helper.rb