blendris 0.0.2 → 0.0.3

data/Manifest

@@ -4,7 +4,6 @@ PostInstall.txt
 README.markdown
 Rakefile
 autotest/discover.rb
-blendris.gemspec
 lib/blendris.rb
 lib/blendris/accessor.rb
 lib/blendris/errors.rb

data/README.markdown

@@ -1,6 +1,6 @@
 # Blendris #
 
-* http://github.com/alexmchale/blendris
+http://github.com/alexmchale/blendris
 
 
 
@@ -20,13 +20,13 @@ PLEASE DON'T USE IT FOR ANYTHING IMPORTANT YET!!!
 
 # REQUIREMENTS #
 
-* Blendris uses the redis RubyGem.
+Blendris uses the redis RubyGem.
 
 
 
 # INSTALL #
 
-* gem install blendris
+gem install blendris
 
 
 

data/Rakefile

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

data/blendris.gemspec

@@ -2,16 +2,16 @@
 
 Gem::Specification.new do |s|
   s.name = %q{blendris}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alex McHale"]
   s.cert_chain = ["/Users/amchale/Dropbox/Security/gem-public_cert.pem"]
-  s.date = %q{2010-02-11}
+  s.date = %q{2010-02-15}
   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"]
-  s.files = ["History.txt", "Manifest", "PostInstall.txt", "README.markdown", "Rakefile", "autotest/discover.rb", "blendris.gemspec", "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", "script/console", "script/destroy", "script/generate", "spec/list_spec.rb", "spec/model_spec.rb", "spec/redis-tools_spec.rb", "spec/ref_spec.rb", "spec/set_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "spec/string_spec.rb", "tasks/rspec.rake"]
+  s.files = ["History.txt", "Manifest", "PostInstall.txt", "README.markdown", "Rakefile", "autotest/discover.rb", "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", "script/console", "script/destroy", "script/generate", "spec/list_spec.rb", "spec/model_spec.rb", "spec/redis-tools_spec.rb", "spec/ref_spec.rb", "spec/set_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "spec/string_spec.rb", "tasks/rspec.rake", "blendris.gemspec"]
   s.homepage = %q{http://github.com/alexmchale/blendris}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Blendris", "--main", "README.markdown"]
   s.require_paths = ["lib"]

data/lib/blendris/accessor.rb

@@ -1,5 +1,8 @@
 module Blendris
 
+  # This module serves as a gateway to the Redis library.  Any object
+  # that needs to access Redis directly should include it.
+
   module RedisAccessor
 
     include Utils
@@ -12,10 +15,8 @@ module Blendris
       $_redis_connection ||= Redis.new
     end
 
-    def prefix
-      RedisAccessor.prefix
-    end
-
+    # Generate a key for the given model class with the given values list.
+    # This is used to determine a new object's key in the Model.create method.
     def generate_key(klass, values)
       value_index = 0
 
@@ -41,18 +42,14 @@ module Blendris
       end.compact.join(":")
     end
 
-    def self.prefix
-      $_redis_prefix ||= ""
-    end
-
-    def self.prefix=(prefix)
-      $_redis_prefix = prefix.to_s
+    # Change which database we're accessing in Redis.
+    def self.database=(index)
+      $_redis_connection = Redis.new(:db => index.to_i)
     end
 
-    def self.flush_keys
-      redis.keys("#{prefix}*").each do |key|
-        redis.del key
-      end
+    # This will delete all keys in the current database.  Dangerous!
+    def self.flushdb
+      redis.flushdb
     end
 
   end

data/lib/blendris/integer.rb

@@ -1,5 +1,8 @@
 module Blendris
 
+  # RedisInteger is a string-value in Redis wrapped up to make
+  # sure that it is used as an integer.
+
   class RedisInteger
 
     include RedisNode
@@ -7,7 +10,7 @@ module Blendris
     def self.cast_to_redis(value, options = {})
       raise TypeError.new("#{value.class.name} is not an integer") unless value.kind_of? Fixnum
 
-      value
+      value.to_s
     end
 
     def self.cast_from_redis(value, options = {})

data/lib/blendris/list.rb

@@ -1,5 +1,7 @@
 module Blendris
 
+  # RedisList is a wrapper for the Redis LIST data type.
+
   class RedisList
 
     include RedisNode
@@ -8,6 +10,7 @@ module Blendris
     def initialize(key, options = {})
       @key = key.to_s
       @options = options
+      @on_change = options[:on_change]
     end
 
     def each
@@ -17,10 +20,14 @@ module Blendris
     end
 
     def <<(value)
-      [ value ].flatten.compact.each do |v|
+      values = [ value ].flatten.compact
+
+      values.flatten.compact.each do |v|
         redis.rpush key, v
       end
 
+      notify_changed if values.count > 0
+
       self
     end
 
@@ -30,6 +37,8 @@ module Blendris
 
     def delete(value)
       redis.lrem key, 0, value
+    ensure
+      notify_changed
     end
 
   end

data/lib/blendris/model.rb

@@ -1,18 +1,29 @@
 module Blendris
 
+  # Model is the main driver for Blendris.  All Blendris objects
+  # will inherit from it to function as a database model.
+
   class Model
 
     include RedisAccessor
 
     attr_reader :key
 
+    # Instantiate a new instance of this model.  We do some basic
+    # checking to make sure that this object already exists in Redis
+    # as the requested type.  This is to prevent keys being used in
+    # the wrong way.
+
+    # If the :verify option isn't set to false, then each field of
+    # this model is also verified.
+
     def initialize(new_key, options = {})
       @key = sanitize_key(new_key)
-      actual_type = constantize(redis.get(prefix + key))
+      actual_type = constantize(redis.get(key))
 
       raise ArgumentError.new("#{self.class.name} second argument must be a hash") unless options.kind_of? Hash
-      raise TypeError.new("#{prefix + key} does not exist, not a #{self.class.name} - you may want create instead of new") if !actual_type
-      raise TypeError.new("#{prefix + key} is a #{actual_type}, not a #{self.class.name}") if actual_type != self.class
+      raise TypeError.new("#{key} does not exist, not a #{self.class.name} - you may want create instead of new") if !actual_type
+      raise TypeError.new("#{key} is a #{actual_type}, not a #{self.class.name}") if actual_type != self.class
 
       if options[:verify] != false
         parameters = self.class.local_parameters.find_all {|s| s.kind_of? Symbol}
@@ -23,16 +34,21 @@ module Blendris
       end
     end
 
+    # An object's id is considered to be the SHA1 digest of its key.  This is
+    # to ensure that all objects that represent the same key return the same id.
     def id
       Digest::SHA1.hexdigest key
     end
 
+    # TODO: Create the methods in the initialize method instead of depending
+    # on method_missing to dispatch to the correct methods.  This will make
+    # these objects better for mocking and stubbing.
     def method_missing(method_sym, *arguments)
       (name, setter) = method_sym.to_s.scan(/(.*[^=])(=)?/).first
 
       if node = redis_symbol(name)
         if setter
-          return node.set *arguments
+          return node.set(*arguments)
         else
           return node.get
         end
@@ -41,6 +57,9 @@ module Blendris
       super
     end
 
+    # Look up the given symbol by its name.  The list of symbols are defined
+    # when the model is declared.
+    # TODO: This can also probably go away when I remove the need for method_missing.
     def redis_symbol(name)
       subkey = self.subkey(name)
 
@@ -48,23 +67,44 @@ module Blendris
 
       return unless options
 
-      options = options.merge(:model => self)
+      on_change = lambda { self.fire_on_change_for name }
+      options = options.merge(:model => self, :on_change => on_change)
 
       options[:type].new subkey, options
     end
 
-    def subkey(key)
-      sanitize_key "#{self.key}:#{key}"
+    # Calculate the key to address the given child node.
+    def subkey(child)
+      sanitize_key "#{self.key}:#{child}"
     end
 
+    # Compare two instances.  If two instances have the same class and key, they are equal.
     def ==(other)
       return false unless self.class == other.class
       return self.key == other.key
     end
 
+    # Return a list of field names for this model.
+    def fields
+      self.class.redis_symbols.map {|name, field| name.to_s}
+    end
+
+    # Fire the list of blocks called when the given symbol changes.
+    def fire_on_change_for(symbol)
+      blocks = [ self.class.on_change_table[nil], self.class.on_change_table[symbol.to_s] ]
+
+      blocks.flatten!
+      blocks.compact!
+
+      blocks.each do |block|
+        self.instance_exec symbol.to_s, &block
+      end
+    end
+
     class << self
 
       include RedisAccessor
+      include Enumerable
 
       # This method will instantiate a new object with the correct key
       # and assign the values passed to it.
@@ -79,13 +119,14 @@ module Blendris
         end
 
         key = generate_key(self, args)
-        current_model = redis.get(prefix + key)
+        current_model = redis.get(key)
 
         if current_model && current_model != self.name
           raise ArgumentError.new("#{key} is a #{current_model}, not a #{self.name}")
         end
 
-        redis.set(prefix + key, self.name)
+        redis.set key, self.name
+        redis.sadd index_key, key
 
         obj = new(key, :verify => false)
 
@@ -105,6 +146,14 @@ module Blendris
         nil
       end
 
+      def each
+        RedisSet.new(index_key).each {|k| yield new(k)}
+      end
+
+      def index_key
+        "index:model:#{self.name}"
+      end
+
       # Defines a new data type for Blendris:Model construction.
       def type(name, klass)
         (class << self; self; end).instance_eval do
@@ -136,6 +185,27 @@ module Blendris
         options[:type].cast_to_redis value, options
       end
 
+      # Define a block to call when one of the given symbol values changes.
+      def on_change(*symbols, &block)
+        symbols.flatten!
+        symbols.compact!
+
+        if symbols.count == 0
+          on_change_table[nil] ||= []
+          on_change_table[nil] << block
+        else
+          symbols.each do |symbol|
+            on_change_table[symbol.to_s] ||= []
+            on_change_table[symbol.to_s] << block
+          end
+        end
+      end
+
+      # The hash of blocks called when fields on this object change.
+      def on_change_table
+        @on_change_table ||= {}
+      end
+
     end
 
   end

data/lib/blendris/node.rb

@@ -1,16 +1,22 @@
 module Blendris
 
   # RedisNode is used to compose all Redis value wrapper classes.
+
   module RedisNode
 
     include RedisAccessor
 
+    attr_reader :key
+
     def initialize(key, options = {})
       @key = sanitize_key(key)
       @default = options[:default]
       @options = options
+      @on_change = options[:on_change]
 
-      set(@default) if @default && !redis.exists(self.key)
+      if @default && !redis.exists(self.key)
+        redis.set key, self.class.cast_to_redis(@default, @options)
+      end
     end
 
     def set(value)
@@ -19,18 +25,18 @@ module Blendris
       else
         redis.del key
       end
+    ensure
+      notify_changed
     end
 
     def get
       self.class.cast_from_redis redis.get(self.key), @options
     end
 
-    def key
-      prefix + @key
-    end
-
     def clear
       redis.del key
+    ensure
+      notify_changed
     end
 
     def type
@@ -41,6 +47,10 @@ module Blendris
       redis.exists key
     end
 
+    def notify_changed
+      @on_change.call if @on_change
+    end
+
   end
 
 end

data/lib/blendris/reference.rb

@@ -1,5 +1,8 @@
 module Blendris
 
+  # RedisReference is a wrapper to a Redis string value and serves
+  # as a pointer to another blendris object.
+
   class RedisReference < RedisReferenceBase
 
     include RedisNode
@@ -22,7 +25,10 @@ module Blendris
         modified = true
       end
 
-      apply_reverse_delete(old_obj) if modified
+      if modified
+        apply_reverse_delete(old_obj)
+        notify_changed
+      end
 
       obj
     end

data/lib/blendris/reference_base.rb

@@ -1,5 +1,8 @@
 module Blendris
 
+  # RedisReferenceBase holds the methods that are common to
+  # RedisReference objects and RedisReferenceSet objects.
+
   class RedisReferenceBase
 
     include RedisNode
@@ -10,6 +13,7 @@ module Blendris
       @key = sanitize_key(key)
       @reverse = options[:reverse]
       @options = options
+      @on_change = options[:on_change]
 
       @klass = options[:class] || Model
       @klass = constantize(camelize @klass) if @klass.kind_of? String
@@ -52,7 +56,7 @@ module Blendris
       expect = constantize(expect) if expect.kind_of? String
       expect = Model unless expect.ancestors.include? Model
 
-      klass = constantize(redis.get(prefix + refkey)) if refkey
+      klass = constantize(redis.get(refkey)) if refkey
 
       if klass == nil
         nil

data/lib/blendris/reference_set.rb

@@ -1,5 +1,8 @@
 module Blendris
 
+  # RedisReferenceSet is a wrapper to a Redis set value and serves
+  # as a pointer to multiple other blendris objects.
+
   class RedisReferenceSet < RedisReferenceBase
 
     include RedisNode
@@ -9,6 +12,7 @@ module Blendris
       @refs ||= RedisSet.new(@key)
     end
 
+    # TODO set should be a real set, while << appends
     def set(*objs)
       objs.flatten!
       objs.compact!
@@ -20,6 +24,8 @@ module Blendris
         end
       end
 
+      notify_changed if objs.count > 0
+
       self
     end
     alias :<< :set
@@ -28,6 +34,7 @@ module Blendris
       if refkey = self.class.cast_to_redis(obj, @options)
         deleted = refs.delete(refkey)
         apply_reverse_delete(obj) if deleted
+        notify_changed
         deleted
       end
     end

data/lib/blendris/set.rb

@@ -1,5 +1,7 @@
 module Blendris
 
+  # RedisSet is a wrapper to the Redis SET data type.
+
   class RedisSet
 
     include RedisNode
@@ -8,6 +10,7 @@ module Blendris
     def initialize(key, options = {})
       @key = key.to_s
       @options = options
+      @on_change = options[:on_change]
     end
 
     def each
@@ -24,6 +27,8 @@ module Blendris
       end
 
       self
+    ensure
+      notify_changed
     end
 
     def get
@@ -32,6 +37,8 @@ module Blendris
 
     def delete(value)
       redis.srem key, value
+    ensure
+      notify_changed
     end
 
   end

data/lib/blendris/string.rb

@@ -1,5 +1,7 @@
 module Blendris
 
+  # RedisString is a wrapper to the Redis string data type.
+
   class RedisString
 
     include RedisNode

data/lib/blendris/types.rb

@@ -1,5 +1,7 @@
 module Blendris
 
+  # Define what types are built into blendris models.
+
   class Model
 
     type :string, RedisString

data/lib/blendris/utils.rb

@@ -1,5 +1,7 @@
 module Blendris
 
+  # This module provides a few utility methods that are used throughout Blendris.
+
   module Utils
 
     # Method lifted from Rails.

data/spec/model_spec.rb

@@ -48,6 +48,21 @@ describe Model do
     fav.food.should == @onion
   end
 
+  it "should have a valid list of fields" do
+
+    fields = %w( name foods )
+
+    @vegetable.fields.should == fields
+
+  end
+
+  it "should use its on_change field correctly" do
+    @apple.calories.should == 0
+    @apple.description = "good"
+    @apple.description = "bad"
+    @apple.calories.should == 2
+  end
+
   context "with single reference" do
 
     it "should reverse to a single reference" do
@@ -177,4 +192,27 @@ describe Model do
 
   end
 
+  it "should enumerable all foods" do
+    Food.count.should == 5
+
+    count = 0
+
+    Food.each do |food|
+      count += 1
+      food.should be_a(Food)
+    end
+
+    count.should == 5
+  end
+
+  it "should call its on_change method for all fields" do
+    o = OnChangeTestModel.create
+    lambda { o.string = "test" }.should raise_exception TestEx
+    lambda { o.integer = 123 }.should raise_exception TestEx
+    lambda { o.set = [1,2,3] }.should raise_exception TestEx
+    lambda { o.list = [1,5,8] }.should raise_exception TestEx
+    lambda { o.ref = o }.should raise_exception TestEx
+    lambda { o.refs << o }.should raise_exception TestEx
+  end
+
 end

data/spec/redis-tools_spec.rb

@@ -5,7 +5,7 @@ describe "redis connection accessor" do
   it "should connect for reading and writing" do
     extend RedisAccessor
 
-    testkey = prefix + "test-string"
+    testkey = "test-string"
 
     redis.get(testkey).should == nil
     redis.set(testkey, "foo").should == true

data/spec/spec_helper.rb

@@ -29,6 +29,10 @@ module TestFixtures
     refs    :friends, :class => Food, :reverse => :friends
     ref     :something
 
+    on_change :description do
+      self.calories += 1
+    end
+
   end
 
   class Category < Model
@@ -58,14 +62,29 @@ module TestFixtures
     refs   :sister_sites, :class => Website, :reverse => :sister_sites
   end
 
+  class OnChangeTestModel < Blendris::Model
+    key "fixed"
+
+    string :string
+    integer :integer
+    set :set
+    list :list
+    ref :ref
+    refs :refs
+
+    on_change { raise TestEx.new }
+  end
+
+  class TestEx < Exception; end
+
 end
 
 Spec::Runner.configure do |config|
   include TestFixtures
 
   config.before(:each) do
-    RedisAccessor.prefix = "blendris-spec:"
-    RedisAccessor.flush_keys
+    RedisAccessor.database = 11
+    RedisAccessor.flushdb
 
     @vegetable = Category.create("vegetable")
     @onion = Food.create("onion")
@@ -80,7 +99,7 @@ Spec::Runner.configure do |config|
   end
 
   config.after(:each) do
-    RedisAccessor.flush_keys
+    RedisAccessor.flushdb
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: blendris
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Alex McHale
@@ -30,7 +30,7 @@ cert_chain:
   V3OoCfxVK/4Dqg==
   -----END CERTIFICATE-----
 
-date: 2010-02-11 00:00:00 -06:00
+date: 2010-02-15 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
@@ -64,7 +64,6 @@ files:
 - README.markdown
 - Rakefile
 - autotest/discover.rb
-- blendris.gemspec
 - lib/blendris.rb
 - lib/blendris/accessor.rb
 - lib/blendris/errors.rb
@@ -91,6 +90,7 @@ files:
 - spec/spec_helper.rb
 - spec/string_spec.rb
 - tasks/rspec.rake
+- blendris.gemspec
 has_rdoc: true
 homepage: http://github.com/alexmchale/blendris
 licenses: []