remodel 0.1.3 → 0.1.4

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.1.4

data/lib/remodel/entity.rb

@@ -0,0 +1,206 @@
+module Remodel
+
+  # The superclass of all persistent remodel entities.
+  class Entity
+    attr_accessor :key
+
+    def initialize(attributes = {}, key = nil)
+      @attributes = {}
+      @key = key
+      attributes = self.class.default_values.merge(attributes) if key.nil?
+      attributes.each do |name, value|
+        send("#{name}=", value) if respond_to? "#{name}="
+      end
+    end
+
+    def id
+      key && key.split(':').last.to_i
+    end
+
+    def save
+      @key = self.class.next_key unless @key
+      Remodel.redis.set(@key, to_json)
+      self
+    end
+
+    def update(properties)
+      properties.each { |name, value| send("#{name}=", value) }
+      save
+    end
+
+    def reload
+      raise EntityNotSaved unless @key
+      initialize(self.class.parse(self.class.fetch(@key)), @key)
+      instance_variables.each do |var|
+        remove_instance_variable(var) if var =~ /^@association_/
+      end
+      self
+    end
+
+    def delete
+      raise EntityNotSaved unless @key
+      Remodel.redis.del(@key)
+    end
+
+    def as_json
+      { :id => id }.merge(@attributes)
+    end
+
+    def to_json
+      JSON.generate(self.class.pack(@attributes))
+    end
+
+    def inspect
+      properties = @attributes.map { |name, value| "#{name}: #{value.inspect}" }.join(', ')
+      "\#<#{self.class.name}(#{id}) #{properties}>"
+    end
+
+    def self.create(attributes = {})
+      new(attributes).save
+    end
+
+    def self.find(key)
+      key = "#{key_prefix}:#{key}" if key.kind_of? Integer
+      restore(key, fetch(key))
+    end
+
+    def self.all
+      keys = Remodel.redis.keys("#{key_prefix}:*").select { |k| k =~ /:[0-9]+$/ }
+      values = keys.empty? ? [] : Remodel.redis.mget(keys)
+      keys.zip(values).map do |key, json|
+        restore(key, json) if json
+      end.compact
+    end
+
+    def self.restore(key, json)
+      new(parse(json), key)
+    end
+
+  protected # --- DSL for subclasses ---
+
+    def self.set_key_prefix(prefix)
+      raise(InvalidKeyPrefix, prefix) unless prefix =~ /^[a-z]+$/
+      @key_prefix = prefix
+    end
+
+    def self.property(name, options = {})
+      name = name.to_sym
+      mapper[name] = Remodel.mapper_for(options[:class])
+      default_values[name] = options[:default] if options.has_key?(:default)
+      define_method(name) { @attributes[name] }
+      define_method("#{name}=") { |value| @attributes[name] = value }
+    end
+
+    def self.has_many(name, options)
+      var = "@association_#{name}".to_sym
+
+      define_method(name) do
+        if instance_variable_defined? var
+          instance_variable_get(var)
+        else
+          clazz = Class[options[:class]]
+          instance_variable_set(var, HasMany.new(self, clazz, "#{key}:#{name}", options[:reverse]))
+        end
+      end
+    end
+
+    def self.has_one(name, options)
+      var = "@association_#{name}".to_sym
+
+      define_method(name) do
+        if instance_variable_defined? var
+          instance_variable_get(var)
+        else
+          clazz = Class[options[:class]]
+          value_key = Remodel.redis.get("#{key}:#{name}")
+          instance_variable_set(var, clazz.find(value_key)) if value_key
+        end
+      end
+
+      define_method("#{name}=") do |value|
+        send("_reverse_association_of_#{name}=", value) if options[:reverse]
+        send("_#{name}=", value)
+      end
+
+      define_method("_#{name}=") do |value|
+        if value
+          instance_variable_set(var, value)
+          Remodel.redis.set("#{key}:#{name}", value.key)
+        else
+          remove_instance_variable(var) if instance_variable_defined? var
+          Remodel.redis.del("#{key}:#{name}")
+        end
+      end; private "_#{name}="
+
+      if options[:reverse]
+        define_method("_reverse_association_of_#{name}=") do |value|
+          if old_value = send(name)
+            association = old_value.send("#{options[:reverse]}")
+            if association.is_a? HasMany
+              association.send("_remove", self)
+            else
+              old_value.send("_#{options[:reverse]}=", nil)
+            end
+          end
+          if value
+            association = value.send("#{options[:reverse]}")
+            if association.is_a? HasMany
+              association.send("_add", self)
+            else
+              value.send("_#{options[:reverse]}=", self)
+            end
+          end
+        end; private "_reverse_association_of_#{name}="
+      end
+    end
+
+  private # --- Helper methods ---
+
+    def self.fetch(key)
+      Remodel.redis.get(key) || raise(EntityNotFound, "no #{name} with key #{key}")
+    end
+
+    # Each entity has its own sequence to generate unique ids.
+    def self.next_key
+      id = Remodel.redis.incr("#{key_prefix}:seq")
+      "#{key_prefix}:#{id}"
+    end
+
+    # Default key prefix is the first letter of the class name, in lowercase.
+    def self.key_prefix
+      @key_prefix ||= name.split('::').last[0,1].downcase
+    end
+
+    def self.parse(json)
+      unpack(JSON.parse(json))
+    end
+
+    def self.pack(attributes)
+      result = {}
+      attributes.each do |name, value|
+        result[name] = mapper[name].pack(value)
+      end
+      result
+    end
+
+    def self.unpack(attributes)
+      result = {}
+      attributes.each do |name, value|
+        name = name.to_sym
+        result[name] = mapper[name].unpack(value)
+      end
+      result
+    end
+
+    # Lazy init
+    def self.mapper
+      @mapper ||= {}
+    end
+
+    def self.default_values
+      @default_values ||= {}
+    end
+
+  end
+
+end

data/lib/remodel/has_many.rb

@@ -0,0 +1,67 @@
+module Remodel
+
+  # Represents the many-end of a many-to-one or many-to-many association.
+  class HasMany < Array
+    def initialize(this, clazz, key, reverse = nil)
+      super _fetch(clazz, key)
+      @this, @clazz, @key, @reverse = this, clazz, key, reverse
+    end
+
+    def create(attributes = {})
+      add(@clazz.create(attributes))
+    end
+
+    def find(id)
+      detect { |x| x.id == id } || raise(EntityNotFound, "no element with id #{id}")
+    end
+
+    def add(entity)
+      _add_to_reverse_association_of(entity) if @reverse
+      _add(entity)
+    end
+
+    def remove(entity)
+      _remove_from_reverse_association_of(entity) if @reverse
+      _remove(entity)
+    end
+
+  private
+
+    def _add(entity)
+      self << entity
+      Remodel.redis.rpush(@key, entity.key)
+      entity
+    end
+
+    def _remove(entity)
+      delete_if { |x| x.key == entity.key }
+      Remodel.redis.lrem(@key, 0, entity.key)
+      entity
+    end
+
+    def _add_to_reverse_association_of(entity)
+      if entity.send(@reverse).is_a? HasMany
+        entity.send(@reverse).send(:_add, @this)
+      else
+        entity.send("_#{@reverse}=", @this)
+      end
+    end
+
+    def _remove_from_reverse_association_of(entity)
+      if entity.send(@reverse).is_a? HasMany
+        entity.send(@reverse).send(:_remove, @this)
+      else
+        entity.send("_#{@reverse}=", nil)
+      end
+    end
+
+    def _fetch(clazz, key)
+      keys = Remodel.redis.lrange(key, 0, -1)
+      values = keys.empty? ? [] : Remodel.redis.mget(keys)
+      keys.zip(values).map do |key, json|
+        clazz.restore(key, json) if json
+      end.compact
+    end
+  end
+
+end

data/lib/remodel/has_one.rb

@@ -0,0 +1,57 @@
+module Remodel
+
+  # Represents the one-end of a many-to-one or one-to-one association.
+  class HasOne
+    def initialize(this, clazz, key, reverse = nil)
+      @this, @clazz, @key, @reverse = this, clazz, key, reverse
+      @value = Remodel.redis.get(@key)
+    end
+    
+    def value
+      @value
+    end
+
+    def add(entity)
+      _add_to_reverse_association_of(entity) if @reverse
+      _add(entity)
+    end
+
+    def remove(entity)
+      _remove_from_reverse_association_of(entity) if @reverse
+      _remove(entity)
+    end
+
+  private
+
+    def _add(entity)
+      @value = entity
+      if entity.nil? 
+        Remodel.redis.del(@key)
+      else
+        Remodel.redis.set(@key, entity.key)
+      end
+      entity
+    end
+
+    def _remove(entity)
+      _add(nil)
+    end
+
+    def _add_to_reverse_association_of(entity)
+      if entity.send(@reverse).is_a? HasMany
+        entity.send(@reverse).send(:_add, @this)
+      else
+        entity.send("_#{@reverse}").send., @this)
+      end
+    end
+
+    def _remove_from_reverse_association_of(entity)
+      if entity.send(@reverse).is_a? HasMany
+        entity.send(@reverse).send(:_remove, @this)
+      else
+        entity.send("_#{@reverse}=", nil)
+      end
+    end
+  end
+
+end

data/lib/remodel/mapper.rb

@@ -0,0 +1,29 @@
+module Remodel
+
+  # A mapper converts a given value into a native JSON value —
+  # *nil*, *true*, *false*, *Number*, *String*, *Hash*, *Array* —
+  # via `pack`, and back again via `unpack`.
+  #
+  # Without any arguments, `Mapper.new` returns the identity mapper, which
+  # maps every value to itself. If `clazz` is set, the mapper rejects any
+  # value which is not of the given type.
+  class Mapper
+    def initialize(clazz = nil, pack_method = nil, unpack_method = nil)
+      @clazz = clazz
+      @pack_method = pack_method
+      @unpack_method = unpack_method
+    end
+
+    def pack(value)
+      return nil if value.nil?
+      raise(InvalidType, "#{value.inspect} is not a #{@clazz}") if @clazz && !value.is_a?(@clazz)
+      @pack_method ? value.send(@pack_method) : value
+    end
+
+    def unpack(value)
+      return nil if value.nil?
+      @unpack_method ? @clazz.send(@unpack_method, value) : value
+    end
+  end
+
+end

data/lib/remodel.rb

@@ -2,42 +2,31 @@ require 'rubygems'
 require 'redis'
 require 'date'
 
-# Use the superfast [YAJL][yajl] lib to parse [JSON][json], if available.
-#
-# [yajl]: http://github.com/brianmario/yajl-ruby
-# [json]: http://json.org/
+# If available, use the superfast YAJL lib to parse JSON.
 begin
   require 'yajl/json_gem'
 rescue LoadError
   require 'json'
 end
 
-#### Monkey patches
-
-# Define `Boolean` as the superclass of `true` and `false`.
+# Define `Boolean` -- the missing superclass of `true` and `false`.
 module Boolean; end
 true.extend(Boolean)
 false.extend(Boolean)
 
-# Find the `Class` object for a given class name, which can be a `String` or `Symbol` (or `Class`).
+# Find the `Class` object for a given class name, which can be
+# a `String` or a `Symbol` (or a `Class`).
 def Class.[](clazz)
   return clazz if clazz.nil? or clazz.is_a?(Class)
   clazz.to_s.split('::').inject(Kernel) { |mod, name| mod.const_get(name) }
 end
 
-#### Remodel
-
-module Remodel
+require File.join(File.dirname(__FILE__), 'remodel', 'mapper')
+require File.join(File.dirname(__FILE__), 'remodel', 'has_many')
+require File.join(File.dirname(__FILE__), 'remodel', 'entity')
 
-  # By default, we expect to find the redis server on `localhost:6379` —
-  # otherwise you will have to set `Remodel.redis` to a suitably initialized redis client.
-  def self.redis
-    @redis ||= Redis.new
-  end
 
-  def self.redis=(redis)
-    @redis = redis
-  end
+module Remodel
 
   # Custom errors
   class Error < ::StandardError; end
@@ -46,35 +35,23 @@ module Remodel
   class InvalidKeyPrefix < Error; end
   class InvalidType < Error; end
 
-  #### Mapper
-
-  # A mapper converts a given value into a native JSON value &mdash;
-  # *nil*, *true*, *false*, *Number*, *String*, *Hash*, *Array* &mdash; via `pack`,
-  # and back again via `unpack`.
-  #
-  # Without any arguments, `Mapper.new` returns the identity mapper, which maps every value into itself.
-  # If `clazz` is set, the mapper rejects any value which is not of the given type.
-  class Mapper
-    def initialize(clazz = nil, pack_method = nil, unpack_method = nil)
-      @clazz = clazz
-      @pack_method = pack_method
-      @unpack_method = unpack_method
-    end
+  # By default, the redis server is expected to listen at `localhost:6379`.
+  # Otherwise you will have to set `Remodel.redis` to a suitably initialized
+  # redis client.
+  def self.redis
+    @redis ||= Redis.new
+  end
 
-    def pack(value)
-      return nil if value.nil?
-      raise(InvalidType, "#{value.inspect} is not a #{@clazz}") if @clazz && !value.is_a?(@clazz)
-      @pack_method ? value.send(@pack_method) : value
-    end
+  def self.redis=(redis)
+    @redis = redis
+  end
 
-    def unpack(value)
-      return nil if value.nil?
-      @unpack_method ? @clazz.send(@unpack_method, value) : value
-    end
+  # Returns the mapper defined for a given class, or the identity mapper.
+  def self.mapper_for(clazz)
+    mapper_by_class[Class[clazz]]
   end
 
-  # So let's define some handy mappers for common types, and a way to look them up.
-  # If no mapper is defined for a given class, the identity mapper is used.
+  # Define some mappers for common types.
   def self.mapper_by_class
     @mapper_by_class ||= Hash.new(Mapper.new).merge(
       Boolean => Mapper.new(Boolean),
@@ -88,284 +65,4 @@ module Remodel
     )
   end
 
-  def self.mapper_for(clazz)
-    mapper_by_class[Class[clazz]]
-  end
-
-  #### HasMany
-
-  # Represents the many-end of a many-to-one or many-to-many association.
-  class HasMany < Array
-    def initialize(this, clazz, key, reverse = nil)
-      super _fetch(clazz, key)
-      @this, @clazz, @key, @reverse = this, clazz, key, reverse
-    end
-
-    def create(attributes = {})
-      add(@clazz.create(attributes))
-    end
-
-    def find(id)
-      detect { |x| x.id == id } || raise(EntityNotFound, "no element with id #{id}")
-    end
-
-    def add(entity)
-      _add_to_reverse_association_of(entity) if @reverse
-      _add(entity)
-    end
-
-    def remove(entity)
-      _remove_from_reverse_association_of(entity) if @reverse
-      _remove(entity)
-    end
-
-  private
-
-    def _add(entity)
-      self << entity
-      Remodel.redis.rpush(@key, entity.key)
-      entity
-    end
-
-    def _remove(entity)
-      delete_if { |x| x.key == entity.key }
-      Remodel.redis.lrem(@key, 0, entity.key)
-      entity
-    end
-
-    def _add_to_reverse_association_of(entity)
-      if entity.send(@reverse).is_a? HasMany
-        entity.send(@reverse).send(:_add, @this)
-      else
-        entity.send("_#{@reverse}=", @this)
-      end
-    end
-
-    def _remove_from_reverse_association_of(entity)
-      if entity.send(@reverse).is_a? HasMany
-        entity.send(@reverse).send(:_remove, @this)
-      else
-        entity.send("_#{@reverse}=", nil)
-      end
-    end
-
-    def _fetch(clazz, key)
-      keys = Remodel.redis.lrange(key, 0, -1)
-      values = keys.empty? ? [] : Remodel.redis.mget(keys)
-      keys.zip(values).map do |key, json|
-        clazz.restore(key, json) if json
-      end.compact
-    end
-  end
-
-#### Entity
-
-  # The superclass of all persistent remodel entities.
-  class Entity
-    attr_accessor :key
-
-    def initialize(attributes = {}, key = nil)
-      @attributes = {}
-      @key = key
-      attributes = self.class.default_values.merge(attributes) if key.nil?
-      attributes.each do |name, value|
-        send("#{name}=", value) if respond_to? "#{name}="
-      end
-    end
-
-    def id
-      key && key.split(':').last.to_i
-    end
-
-    def save
-      @key = self.class.next_key unless @key
-      Remodel.redis.set(@key, to_json)
-      self
-    end
-
-    def update(properties)
-      properties.each { |name, value| send("#{name}=", value) }
-      save
-    end
-
-    def reload
-      raise EntityNotSaved unless @key
-      initialize(self.class.parse(self.class.fetch(@key)), @key)
-      instance_variables.each do |var|
-        remove_instance_variable(var) if var =~ /^@association_/
-      end
-      self
-    end
-
-    def delete
-      raise EntityNotSaved unless @key
-      Remodel.redis.del(@key)
-    end
-
-    def as_json
-      { :id => id }.merge(@attributes)
-    end
-
-    def to_json
-      JSON.generate(self.class.pack(@attributes))
-    end
-
-    def inspect
-      properties = @attributes.map { |name, value| "#{name}: #{value.inspect}" }.join(', ')
-      "\#<#{self.class.name}(#{id}) #{properties}>"
-    end
-
-    def self.create(attributes = {})
-      new(attributes).save
-    end
-
-    def self.find(key)
-      key = "#{key_prefix}:#{key}" if key.kind_of? Integer
-      restore(key, fetch(key))
-    end
-
-    def self.all
-      keys = Remodel.redis.keys("#{key_prefix}:*").select { |k| k =~ /:[0-9]+$/ }
-      values = keys.empty? ? [] : Remodel.redis.mget(keys)
-      keys.zip(values).map do |key, json|
-        restore(key, json) if json
-      end.compact
-    end
-
-    def self.restore(key, json)
-      new(parse(json), key)
-    end
-
-#### DSL for subclasses
-
-  protected
-
-    def self.set_key_prefix(prefix)
-      raise(InvalidKeyPrefix, prefix) unless prefix =~ /^[a-z]+$/
-      @key_prefix = prefix
-    end
-
-    def self.property(name, options = {})
-      name = name.to_sym
-      mapper[name] = Remodel.mapper_for(options[:class])
-      default_values[name] = options[:default] if options.has_key?(:default)
-      define_method(name) { @attributes[name] }
-      define_method("#{name}=") { |value| @attributes[name] = value }
-    end
-
-    def self.has_many(name, options)
-      var = "@association_#{name}".to_sym
-
-      define_method(name) do
-        if instance_variable_defined? var
-          instance_variable_get(var)
-        else
-          clazz = Class[options[:class]]
-          instance_variable_set(var, HasMany.new(self, clazz, "#{key}:#{name}", options[:reverse]))
-        end
-      end
-    end
-
-    def self.has_one(name, options)
-      var = "@association_#{name}".to_sym
-
-      define_method(name) do
-        if instance_variable_defined? var
-          instance_variable_get(var)
-        else
-          clazz = Class[options[:class]]
-          value_key = Remodel.redis.get("#{key}:#{name}")
-          instance_variable_set(var, clazz.find(value_key)) if value_key
-        end
-      end
-
-      define_method("#{name}=") do |value|
-        send("_reverse_association_of_#{name}=", value) if options[:reverse]
-        send("_#{name}=", value)
-      end
-
-      define_method("_#{name}=") do |value|
-        if value
-          instance_variable_set(var, value)
-          Remodel.redis.set("#{key}:#{name}", value.key)
-        else
-          remove_instance_variable(var) if instance_variable_defined? var
-          Remodel.redis.del("#{key}:#{name}")
-        end
-      end; private "_#{name}="
-
-      if options[:reverse]
-        define_method("_reverse_association_of_#{name}=") do |value|
-          if value
-            association = value.send("#{options[:reverse]}")
-            if association.is_a? HasMany
-              association.send("_add", self)
-            else
-              value.send("_#{options[:reverse]}=", self)
-            end
-          else
-            if old_value = send(name)
-              association = old_value.send("#{options[:reverse]}")
-              if association.is_a? HasMany
-                association.send("_remove", self)
-              else
-                old_value.send("_#{options[:reverse]}=", nil)
-              end
-            end
-          end
-        end; private "_reverse_association_of_#{name}="
-      end
-    end
-
-#### Helper methods
-
-  private
-
-    def self.fetch(key)
-      Remodel.redis.get(key) || raise(EntityNotFound, "no #{name} with key #{key}")
-    end
-
-    # Each entity has its own sequence to generate unique ids.
-    def self.next_key
-      id = Remodel.redis.incr("#{key_prefix}:seq")
-      "#{key_prefix}:#{id}"
-    end
-
-    # Default key prefix is the first letter of the class name, in lowercase.
-    def self.key_prefix
-      @key_prefix ||= name.split('::').last[0,1].downcase
-    end
-
-    def self.parse(json)
-      unpack(JSON.parse(json))
-    end
-
-    def self.pack(attributes)
-      result = {}
-      attributes.each do |name, value|
-        result[name] = mapper[name].pack(value)
-      end
-      result
-    end
-
-    def self.unpack(attributes)
-      result = {}
-      attributes.each do |name, value|
-        name = name.to_sym
-        result[name] = mapper[name].unpack(value)
-      end
-      result
-    end
-
-    # Lazy init
-    def self.mapper
-      @mapper ||= {}
-    end
-
-    def self.default_values
-      @default_values ||= {}
-    end
-
-  end
-
-end
+end

data/remodel.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{remodel}
-  s.version = "0.1.3"
+  s.version = "0.1.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tim Lossen"]
-  s.date = %q{2010-05-03}
+  s.date = %q{2010-07-01}
   s.default_executable = %q{redis-monitor.rb}
   s.description = %q{build your domain model in ruby, persist your objects to redis.}
   s.email = %q{tim@lossen.de}
@@ -29,6 +29,10 @@ Gem::Specification.new do |s|
      "docs/remodel.html",
      "example/book.rb",
      "lib/remodel.rb",
+     "lib/remodel/entity.rb",
+     "lib/remodel/has_many.rb",
+     "lib/remodel/has_one.rb",
+     "lib/remodel/mapper.rb",
      "remodel.gemspec",
      "test/helper.rb",
      "test/test_entity.rb",

data/test/test_one_to_many.rb

@@ -9,7 +9,7 @@ class TestOneToMany < Test::Unit::TestCase
   end
 
   class Puzzle < Remodel::Entity
-    has_many :pieces, :class => 'TestOneToMany::Piece'
+    has_many :pieces, :class => 'TestOneToMany::Piece', :reverse => 'puzzle'
     property :topic
   end
 
@@ -48,6 +48,15 @@ class TestOneToMany < Test::Unit::TestCase
         piece = Piece.create
         piece.puzzle = puzzle
         assert_equal 1, puzzle.pieces.size
+        assert_equal piece.id, puzzle.pieces.first.id
+      end
+      
+      should "remove the entity from the old reverse association" do
+        puzzle = Puzzle.create
+        piece = puzzle.pieces.create
+        new_puzzle = Puzzle.create
+        piece.puzzle = new_puzzle
+        assert_equal [], puzzle.reload.pieces
       end
 
       should "be settable to nil" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: remodel
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors: 
 - Tim Lossen
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-03 00:00:00 +02:00
+date: 2010-07-01 00:00:00 +02:00
 default_executable: redis-monitor.rb
 dependencies: []
 
@@ -33,6 +33,10 @@ files:
 - docs/remodel.html
 - example/book.rb
 - lib/remodel.rb
+- lib/remodel/entity.rb
+- lib/remodel/has_many.rb
+- lib/remodel/has_one.rb
+- lib/remodel/mapper.rb
 - remodel.gemspec
 - test/helper.rb
 - test/test_entity.rb