blendris 0.0.4 → 0.5

data/README.markdown

@@ -16,11 +16,16 @@ BLENDRIS IS IN VERY EARLY ALPHA!!!
 
 PLEASE DON'T USE IT FOR ANYTHING IMPORTANT YET!!!
 
+Blendris provides a way to create an object hierarchy within Redis,
+a key-value database.  It provides very little in the way of indexing
+or querying that data.  It is up to the user to maintain objects
+representing the query in which they are interested.
+
 
 
 # REQUIREMENTS #
 
-Blendris uses the redis RubyGem.
+Blendris uses the [redis](http://gemcutter.org/gems/redis) gem.
 
 
 
@@ -32,38 +37,64 @@ gem install blendris
 
 # EXAMPLES #
 
-The following would create a Website model that knows its url and
-paths within the website.
+Let's say we want to maintain a list of employers and employees.
+
+    class Employer < Blendris::Model
+      key "employer", :name
 
-    class Website < Blendris::Model
-      key "website", :title
+      string :name
+      string :address
 
-      string :title
-      string :url
-      set    :paths
+      refs :employees, :class => "Employee", :reverse => :employer
     end
 
-    website = Website.create("One Fake Website")
-    website.url = "http://fakewebsite.com"
-    website.paths << "/blog/index"
-    website.paths << "/admin/index"
+    class Employee < Blendris::Model
+      key "employee", :name
+
+      string :name
+      string :address
+      set :family_members
 
-The above would create the following Redis keys:
+      ref :employer, :class => "Employer", :reverse => :employees
+    end
 
-    website:One_Fake_Website       => "Website" (This identifies the model type)
-    website:One_Fake_Website:name  => "One Fake Website"
-    website:One_Fake_Website:url   => "http://fakewebsite.com"
-    website:One_Fake_Website:paths => [ "/blog/index", "/admin/index" ]
+### key ###
 
-Now suppose we want to open the Website model back up to add a concept of sister sites:
+Key sets the base key for this object.  In the case of the employer
+"37 Signals" it would create a key "employer:37_Signals" and set its value
+to "Employer".  In the key, strings are interpreted as literals and
+symbols are interpreted as pointers to that data field.
 
-    class Website
-      refs :sister_sites, :class => Website, :reverse => :sister_sites
-    end
+* Note that spaces are converted to underscores, as spaces are not
+  allowed in Redis keys.  This could cause problems in some data sets.
+* Also note that the value assigned to the base key is the class name of
+  the model being used.
+* Only strings and integers should be used as key values.
+
+### string ###
+
+String creates a string key named for the first parameter given to it.
+This means that it would generate a key "employer:37_Signals:name" with
+a value of "37 Signals".
+
+### refs ###
+
+Refs maintains a set of references to other objects.
+
+* *:class* will limit objects in this reference set to the given class.
+  If a string is specified as a class, it will be constantized before
+  comparing.
+* *reverse* will cause the given field to be updated on the object when
+  it is added to or removed from this set.
+
+### new vs create ###
+
+Calling the *create* method will build a new object, generating a new base
+key based upon the parameters.  The parameter list should be the same as
+the list of symbols in your *key* field.
 
-This will cause the website to maintain a set of other websites.  The reverse tag
-causes the other website's sister_sites set to be updated when it is added or removed
-from this site's list.
+Calling the *new* method will instantiate an existing object using the
+given *key* as the base key.
 
 
 

data/Rakefile

@@ -9,7 +9,7 @@ require "redis"
 require "fileutils"
 require "./lib/blendris"
 
-Echoe.new("blendris", "0.0.4") do |p|
+Echoe.new("blendris", "0.5") do |p|
 
   p.description              = "A redis library for Ruby"
   p.url                      = "http://github.com/alexmchale/blendris"

data/blendris.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{blendris}
-  s.version = "0.0.4"
+  s.version = "0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alex McHale"]
-  s.date = %q{2010-02-16}
+  s.date = %q{2010-02-21}
   s.description = %q{A redis library for Ruby}
   s.email = %q{alexmchale@gmail.com}
   s.extra_rdoc_files = ["README.markdown", "lib/blendris.rb", "lib/blendris/accessor.rb", "lib/blendris/errors.rb", "lib/blendris/integer.rb", "lib/blendris/list.rb", "lib/blendris/model.rb", "lib/blendris/node.rb", "lib/blendris/reference.rb", "lib/blendris/reference_base.rb", "lib/blendris/reference_set.rb", "lib/blendris/set.rb", "lib/blendris/string.rb", "lib/blendris/types.rb", "lib/blendris/utils.rb", "tasks/rspec.rake"]

data/lib/blendris/accessor.rb

@@ -52,6 +52,19 @@ module Blendris
       redis.flushdb
     end
 
+    # Build a new temporary set with the given contents, yielding it to
+    # the passed block.  After the block exits, destroy the temporary set.
+    def in_temporary_set(*contents)
+      index = RedisInteger.new("blendris:temporary:index").increment
+
+      temporary_set = RedisSet.new("blendris:temporary:set:#{index}")
+      temporary_set << contents
+      yield temporary_set
+      temporary_set.clear
+
+      self
+    end
+
   end
 
 end

data/lib/blendris/integer.rb

@@ -17,6 +17,14 @@ module Blendris
       value.to_i if value
     end
 
+    def increment
+      redis.incr key
+    end
+
+    def decrement
+      redis.decr key
+    end
+
   end
 
 end

data/lib/blendris/model.rb

@@ -76,6 +76,7 @@ module Blendris
 
       options[:type].new subkey, options
     end
+    alias :[] :redis_symbol
 
     # Calculate the key to address the given child node.
     def subkey(child)

data/lib/blendris/node.rb

@@ -33,6 +33,12 @@ module Blendris
       self.class.cast_from_redis redis.get(self.key), @options
     end
 
+    def rename(newkey)
+      redis.rename @key, sanitize_key(newkey)
+
+      @key = newkey
+    end
+
     def clear
       redis.del key
     ensure

data/lib/blendris/reference_set.rb

@@ -12,8 +12,16 @@ module Blendris
       @refs ||= RedisSet.new(@key)
     end
 
-    # TODO set should be a real set, while << appends
     def set(*objs)
+      refkeys = objs.flatten.compact.map {|o| o.key}
+      self.refs.set refkeys
+
+      self
+    ensure
+      notify_changed
+    end
+
+    def <<(*objs)
       objs.flatten!
       objs.compact!
 
@@ -28,7 +36,6 @@ module Blendris
 
       self
     end
-    alias :<< :set
 
     def delete(obj)
       if refkey = self.class.cast_to_redis(obj, @options)
@@ -56,7 +63,7 @@ module Blendris
     end
 
     def assign_ref(*values)
-      self.set *values
+      self << values
     end
 
     def remove_ref(value)

data/lib/blendris/set.rb

@@ -21,6 +21,18 @@ module Blendris
       self
     end
 
+    def set(*values)
+      self.clear
+
+      values.flatten.compact.each do |v|
+        redis.sadd key, v
+      end
+
+      self
+    ensure
+      notify_changed
+    end
+
     def <<(value)
       [ value ].flatten.compact.each do |v|
         redis.sadd key, v
@@ -41,6 +53,20 @@ module Blendris
       notify_changed
     end
 
+    # Set this set's members to the intersection of this set and the given set.
+    def intersect!(other)
+      redis.sinterstore key, key, other.key
+    ensure
+      notify_changed
+    end
+
+    # Set this set's members to the union of this set and the given set.
+    def union!(other)
+      redis.sunionstore key, key, other.key
+    ensure
+      notify_changed
+    end
+
   end
 
 end

data/lib/blendris/utils.rb

@@ -32,6 +32,8 @@ module Blendris
       return false
     end
 
+    # Redis keys cannot contain spaces, carriage returns, or newlines.
+    # We do not want colons at the start or end of keys.
     def sanitize_key(key)
       key.to_s.gsub(/[\r\n\s]/, "_").gsub(/^:+|:+$/, "")
     end

data/spec/model_spec.rb

@@ -35,6 +35,11 @@ describe Model do
     @fruit.foods.should be_include(@lemon)
     @fruit.foods.should be_include(Food.new("food:lemon"))
     @fruit.foods.should_not be_include(@steak)
+
+    @fruit.foods = @onion
+
+    @fruit.foods.count.should == 1
+    @fruit.foods.first.should == @onion
   end
 
   it "should not allow you to instantiate with a key that doesnt match its class" do

data/spec/redis-tools_spec.rb

@@ -14,4 +14,16 @@ describe "redis connection accessor" do
     redis.del(testkey).should == false
   end
 
+  it "should allow for keys to be renamed" do
+    s = RedisString.new("string1")
+    s.set "hobo"
+
+    s.rename "string2"
+    s.key.should == "string2"
+    s.get.should == "hobo"
+
+    RedisString.new("string1").get.should be_nil
+    RedisString.new("string2").get.should == "hobo"
+  end
+
 end

data/spec/set_spec.rb

@@ -17,4 +17,50 @@ describe "redis sets" do
     @onion.qualities.to_a.sort.should == %w( delicious white )
   end
 
+  it "should allow for temporary sets" do
+    extend RedisAccessor
+
+    redis.keys("blendris:temporary:set:*").count.should == 0
+
+    in_temporary_set do |set|
+      redis.keys("blendris:temporary:set:*").count.should == 0
+      set.count.should == 0
+    end
+
+    redis.keys("blendris:temporary:set:*").count.should == 0
+
+    in_temporary_set(1, 2, 3) do |set|
+      redis.keys("blendris:temporary:set:*").count.should == 1
+      set.count.should == 3
+    end
+
+    redis.keys("blendris:temporary:set:*").count.should == 0
+  end
+
+  it "should do intersections properly" do
+    s1 = RedisSet.new("set1")
+    s2 = RedisSet.new("set2")
+
+    s1 << [ 1, 2, 3 ]
+    s2 << [ 1, 4, 5 ]
+
+    s1.intersect!(s2).should == 1
+
+    s1.sort.should == %w( 1 )
+    s2.sort.should == %w( 1 4 5 )
+  end
+
+  it "should be able to union two sets" do
+    s1 = RedisSet.new("set1")
+    s2 = RedisSet.new("set2")
+
+    s1 << %w( 1 4 5 )
+    s2 << %w( 1 2 3 )
+
+    s1.union!(s2).should == 5
+
+    s1.sort.should == %w( 1 2 3 4 5 )
+    s2.sort.should == %w( 1 2 3 )
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: blendris
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: "0.5"
 platform: ruby
 authors: 
 - Alex McHale
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-16 00:00:00 -06:00
+date: 2010-02-21 00:00:00 -06:00
 default_executable: 
 dependencies: []