blendris 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2010-02-06
+
+* 1 major enhancement:
+  * Initial release

data/Manifest

@@ -0,0 +1,32 @@
+History.txt
+Manifest
+PostInstall.txt
+README.rdoc
+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

data/PostInstall.txt

@@ -0,0 +1 @@
+For more information on blendris, see http://github.com/alexmchale/blendris

data/README.rdoc

@@ -0,0 +1,79 @@
+= blendris
+
+* http://github.com/alexmchale/blendris
+
+== DESCRIPTION:
+
+Blendris is a Ruby interface to a Redis database.
+
+== FEATURES/PROBLEMS:
+
+== SYNOPSIS:
+
+== REQUIREMENTS:
+
+* Blendris uses the redis RubyGem.
+
+== INSTALL:
+
+* gem install blendris
+
+== EXAMPLES:
+
+The following would create a Website model that knows its url and
+paths within the website.
+
+  class Website < Blendris::Model
+    key "website", :title
+
+    string :title
+    string :url
+    set    :paths
+  end
+
+  website = Website.create("One Fake Website")
+  website.url = "http://fakewebsite.com"
+  website.paths << "/blog/index"
+  website.paths << "/admin/index"
+
+The above would create the following Redis keys:
+
+  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" ]
+
+Now suppose we want to open the Website model back up to add a concept of sister sites:
+
+  class Website
+    refs :sister_sites, :class => Website, :reverse => :sister_sites
+  end
+
+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.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Alexander Timothy McHale
+
+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/Rakefile

@@ -0,0 +1,22 @@
+require "rubygems"
+
+gem "echoe", ">= 4.1"
+gem "redis", ">= 0.1.2"
+
+require "echoe"
+
+require 'fileutils'
+require './lib/blendris'
+
+Echoe.new("blendris", "0.0.1") do |p|
+
+  p.description              = "A redis library for Ruby"
+  p.url                      = "http://github.com/alexmchale/blendris"
+  p.author                   = "Alex McHale"
+  p.email                    = "alexmchale@gmail.com"
+  p.ignore_pattern           = [ "tmp", "pkg", "script" ]
+  p.development_dependencies = []
+
+end
+
+Dir['tasks/**/*.rake'].each { |t| load t }

data/autotest/discover.rb

@@ -0,0 +1,3 @@
+Autotest.add_discovery do
+  "rspec"
+end

data/blendris.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{blendris}
+  s.version = "0.0.1"
+
+  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.description = %q{A redis library for Ruby}
+  s.email = %q{alexmchale@gmail.com}
+  s.extra_rdoc_files = ["README.rdoc", "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.rdoc", "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.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{blendris}
+  s.rubygems_version = %q{1.3.5}
+  s.signing_key = %q{/Users/amchale/Dropbox/Security/gem-private_key.pem}
+  s.summary = %q{A redis library for Ruby}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/blendris.rb

@@ -0,0 +1,25 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module Blendris
+  VERSION = '0.0.1'
+end
+
+require "blendris/errors"
+require "blendris/utils"
+
+require "blendris/accessor"
+require "blendris/node"
+
+require "blendris/model"
+
+require "blendris/string"
+require "blendris/integer"
+require "blendris/list"
+require "blendris/set"
+
+require "blendris/reference_base"
+require "blendris/reference"
+require "blendris/reference_set"
+
+require "blendris/types"

data/lib/blendris/accessor.rb

@@ -0,0 +1,62 @@
+require 'redis'
+
+module Blendris
+
+  module RedisAccessor
+
+    include Utils
+
+    def redis
+      RedisAccessor.redis
+    end
+
+    def self.redis
+      $_redis_connection ||= Redis.new
+    end
+
+    def prefix
+      RedisAccessor.prefix
+    end
+
+    def generate_key(klass, values)
+      value_index = 0
+
+      klass.local_parameters.map do |symbol|
+        case symbol
+
+        when String then symbol
+
+        when Symbol
+          value = values[value_index]
+          value_index += 1
+
+          raise ArgumentError.new("#{self.name} created without #{symbol}") unless value
+
+          klass.cast_value symbol, value
+
+        else
+          raise TypeError.new("only strings and symbols allowed in key definition for #{klass.name} (#{symbol.class.name})")
+
+        end
+      end.map do |segment|
+        sanitize_key segment
+      end.compact.join(":")
+    end
+
+    def self.prefix
+      $_redis_prefix ||= ""
+    end
+
+    def self.prefix=(prefix)
+      $_redis_prefix = prefix.to_s
+    end
+
+    def self.flush_keys
+      redis.keys("#{prefix}*").each do |key|
+        redis.del key
+      end
+    end
+
+  end
+
+end

data/lib/blendris/errors.rb

@@ -0,0 +1,3 @@
+module Blendris
+
+end

data/lib/blendris/integer.rb

@@ -0,0 +1,19 @@
+module Blendris
+
+  class RedisInteger
+
+    include RedisNode
+
+    def self.cast_to_redis(value, options = {})
+      raise TypeError.new("#{value.class.name} is not an integer") unless value.kind_of? Fixnum
+
+      value
+    end
+
+    def self.cast_from_redis(value, options = {})
+      value.to_i if value
+    end
+
+  end
+
+end

data/lib/blendris/list.rb

@@ -0,0 +1,37 @@
+module Blendris
+
+  class RedisList
+
+    include RedisNode
+    include Enumerable
+
+    def initialize(key, options = {})
+      @key = key.to_s
+      @options = options
+    end
+
+    def each
+      redis.lrange(key, 0, -1).each do |value|
+        yield value
+      end
+    end
+
+    def <<(value)
+      [ value ].flatten.compact.each do |v|
+        redis.rpush key, v
+      end
+
+      self
+    end
+
+    def get
+      self
+    end
+
+    def delete(value)
+      redis.lrem key, 0, value
+    end
+
+  end
+
+end

data/lib/blendris/model.rb

@@ -0,0 +1,141 @@
+module Blendris
+
+  class Model
+
+    include RedisAccessor
+
+    attr_reader :key
+
+    def initialize(new_key, options = {})
+      @key = sanitize_key(new_key)
+      actual_type = constantize(redis.get(prefix + 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
+
+      if options[:verify] != false
+        parameters = self.class.local_parameters.find_all {|s| s.kind_of? Symbol}
+        dne = parameters.find {|p| not self.send(p.to_s)}
+
+        raise ArgumentError.new("#{self.class.name} #{key} is missing its #{dne}") if dne
+        raise ArgumentError.new("blank keys are not allowed") if @key.length == 0
+      end
+    end
+
+    def id
+      Digest::SHA1.hexdigest key
+    end
+
+    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
+        else
+          return node.get
+        end
+      end
+
+      super
+    end
+
+    def redis_symbol(name)
+      subkey = self.subkey(name)
+
+      options = self.class.redis_symbols[name.to_s]
+
+      return unless options
+
+      options = options.merge(:model => self)
+
+      options[:type].new subkey, options
+    end
+
+    def subkey(key)
+      sanitize_key "#{self.key}:#{key}"
+    end
+
+    def ==(other)
+      return false unless self.class == other.class
+      return self.key == other.key
+    end
+
+    class << self
+
+      include RedisAccessor
+
+      # This method will instantiate a new object with the correct key
+      # and assign the values passed to it.
+      def create(*args)
+        parameters = local_parameters.find_all {|s| s.kind_of? Symbol}
+        got = args.count
+        wanted = parameters.count
+
+        if got != wanted
+          msg = "wrong number of arguments for a new #{self.class.name} (%d for %d)" % [ got, wanted ]
+          raise ArgumentError.new(msg)
+        end
+
+        key = generate_key(self, args)
+        current_model = redis.get(prefix + 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)
+
+        obj = new(key, :verify => false)
+
+        parameters.each_with_index do |parm, i|
+          obj.redis_symbol(parm).set args[i]
+        end
+
+        obj
+      end
+
+      def key(*fields)
+        @local_parameters = fields
+
+        @local_parameters.flatten!
+        @local_parameters.compact!
+
+        nil
+      end
+
+      # Defines a new data type for Blendris:Model construction.
+      def type(name, klass)
+        (class << self; self; end).instance_eval do
+          define_method name do |varname, options|
+            options ||= {}
+            options[:type] = klass
+            redis_symbols[varname.to_s] = options
+          end
+        end
+      end
+
+      # Variables stored in the Redis database.
+      def redis_symbols
+        @redis_symbols ||= {}
+      end
+
+      # Parameters used when creating a new copy of this model.
+      def local_parameters
+        @local_parameters ||= []
+      end
+
+      # Take a value and attempt to make it fit the given field.
+      def cast_value(symbol, value)
+        options = redis_symbols[symbol.to_s]
+        raise ArgumentError.new("#{self.name} is missing its #{symbol}") unless options
+
+        options[:type].cast_to_redis value, options
+      end
+
+    end
+
+  end
+
+end