remodel 0.4.2 → 0.5.0

data/README.md

@@ -51,14 +51,13 @@ persistence to disk. for example, on my macbook (2 ghz):
 define your domain model [like this](http://github.com/tlossen/remodel/blob/master/example/book.rb):
 
 	class Book < Remodel::Entity
-	  has_many :chapters, :class => 'Chapter', :reverse => :book
+	  has_many :chapters, :class => 'Chapter'
 	  property :title, :short => 't', :class => 'String'
 	  property :year, :class => 'Integer'
 	  property :author, :class => 'String', :default => '(anonymous)'
 	end
 
 	class Chapter < Remodel::Entity
-	  has_one :book, :class => Book, :reverse => :chapters
 	  property :title, :class => String
 	end
 	
@@ -72,8 +71,6 @@ now you can do:
 	=> #<Book(shelf, 1) title: "Moby Dick", year: 1851, author: "(anonymous)"> 
 	>> chapter = book.chapters.create :title => 'Ishmael'
 	=> #<Chapter(shelf, 1) title: "Ishmael"> 
-	>> chapter.book
-	=> #<Book(shelf, 1) title: "Moby Dick", year: 1851, author: "(anonymous)"> 
 
 all entities have been created in the redis hash 'shelf' we have used as context:
 

data/VERSION

@@ -1 +1 @@
-0.4.2
+0.5.0

data/example/book.rb

@@ -1,14 +1,13 @@
 require File.dirname(__FILE__) + "/../lib/remodel"
 
 class Book < Remodel::Entity
-  has_many :chapters, :class => 'Chapter', :reverse => :book
+  has_many :chapters, :class => 'Chapter'
   property :title, :short => 't', :class => 'String'
   property :year, :class => 'Integer'
   property :author, :class => 'String', :default => '(anonymous)'
 end
 
 class Chapter < Remodel::Entity
-  has_one :book, :class => Book, :reverse => :chapters
   property :title, :class => String
 end
 

data/lib/remodel/entity.rb

@@ -82,7 +82,7 @@ module Remodel
 
     def self.property(name, options = {})
       name = name.to_sym
-      mapper[name] = Remodel.mapper_for(options[:class])
+      _mapper[name] = Remodel.mapper_for(options[:class])
       define_shortname(name, options[:short])
       default_value = options[:default]
       define_method(name) { @attributes[name].nil? ? self.class.copy_of(default_value) : @attributes[name] }
@@ -90,68 +90,44 @@ module Remodel
     end
 
     def self.has_many(name, options)
-      associations.push(name)
+      _associations.push(name)
       var = "@#{name}".to_sym
+      shortname = options[:short] || name
 
       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]))
+          instance_variable_set(var, HasMany.new(self, clazz, "#{key}_#{shortname}"))
         end
       end
     end
 
     def self.has_one(name, options)
-      associations.push(name)
+      _associations.push(name)
       var = "@#{name}".to_sym
+      shortname = options[:short] || name
 
       define_method(name) do
         if instance_variable_defined? var
           instance_variable_get(var)
         else
           clazz = Class[options[:class]]
-          value_key = self.context.hget("#{key}_#{name}")
+          value_key = self.context.hget("#{key}_#{shortname}")
           value = value_key && clazz.find(self.context, value_key) rescue nil
           instance_variable_set(var, value)
         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)
-          self.context.hset("#{key}_#{name}", value.key)
+          self.context.hset("#{key}_#{shortname}", value.key)
         else
           remove_instance_variable(var) if instance_variable_defined? var
-          self.context.hdel("#{key}_#{name}")
+          self.context.hdel("#{key}_#{shortname}")
         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
 
@@ -211,24 +187,42 @@ module Remodel
     def self.define_shortname(name, short)
       return unless short
       short = short.to_sym
-      shortname[name] = short
-      fullname[short] = name
+      _shortname[name] = short
+      _fullname[short] = name
     end
 
-    # class instance variables (lazy init)
+    # class instance variables:
+    # lazy init + recursive lookup in superclasses
+
     def self.mapper
+      self == Entity || superclass == Entity ? _mapper : superclass.mapper.merge(_mapper)
+    end
+
+    def self._mapper
       @mapper ||= {}
     end
 
     def self.shortname
+      self == Entity || superclass == Entity ? _shortname : superclass.shortname.merge(_shortname)
+    end
+
+    def self._shortname
       @shortname ||= {}
     end
 
     def self.fullname
+      self == Entity || superclass == Entity ? _fullname : superclass.fullname.merge(_fullname)
+    end
+
+    def self._fullname
       @fullname ||= {}
     end
 
     def self.associations
+      self == Entity || superclass == Entity ? _associations : superclass.associations + _associations
+    end
+
+    def self._associations
       @associations ||= []
     end
 

data/lib/remodel/has_many.rb

@@ -2,9 +2,9 @@ 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)
+    def initialize(this, clazz, key)
       super _fetch(clazz, this.context, key)
-      @this, @clazz, @key, @reverse = this, clazz, key, reverse
+      @this, @clazz, @key = this, clazz, key
     end
 
     def create(attributes = {})
@@ -16,51 +16,25 @@ module Remodel
     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
       _store
       entity
     end
 
-    def _remove(entity)
+    def remove(entity)
       delete_if { |x| x.key == entity.key }
       _store
       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
+  private
 
     def _store
-      @this.context.hset(@key, JSON.generate(self.map(&:key)))
+      @this.context.hset(@key, self.map(&:key).join(' '))
     end
 
     def _fetch(clazz, context, key)
-      keys = JSON.parse(context.hget(key) || '[]').uniq
+      keys = (context.hget(key) || '').split.uniq
       values = keys.empty? ? [] : context.hmget(*keys)
       keys.zip(values).map do |key, json|
         clazz.restore(context, key, json) if json

data/test/test_has_many.rb

@@ -0,0 +1,105 @@
+require 'helper'
+require 'json'
+
+class TestHasMany < Test::Unit::TestCase
+
+  class Puzzle < Remodel::Entity
+    has_many :pieces, :class => 'TestHasMany::Piece'
+    property :topic
+  end
+
+  class Piece < Remodel::Entity
+    property :color
+  end
+
+  context "association" do
+    should "exist" do
+      assert Puzzle.create(context).respond_to?(:pieces)
+    end
+
+    should "return an empty list by default" do
+      assert_equal [], Puzzle.create(context).pieces
+    end
+    
+    should "return any existing children" do
+      puzzle = Puzzle.create(context)
+      red_piece = Piece.create(context, :color => 'red')
+      blue_piece = Piece.create(context, :color => 'blue')
+      redis.hset(context.key, "#{puzzle.key}_pieces", "#{red_piece.key} #{blue_piece.key}")
+      assert_equal 2, puzzle.pieces.size
+      assert_equal Piece, puzzle.pieces[0].class
+      assert_equal 'red', puzzle.pieces[0].color
+    end
+
+    should "not return any child multiple times" do
+      puzzle = Puzzle.create(context)
+      red_piece = Piece.create(context, :color => 'red')
+      redis.hset(context.key, "#{puzzle.key}_pieces", "#{red_piece.key} #{red_piece.key}")
+      assert_equal 1, puzzle.pieces.size
+      assert_equal Piece, puzzle.pieces[0].class
+      assert_equal 'red', puzzle.pieces[0].color
+    end
+
+    context "create" do
+      should "have a create method" do
+        assert Puzzle.create(context).pieces.respond_to?(:create)
+      end
+
+      should "work without attributes" do
+        puzzle = Puzzle.create(context)
+        piece = puzzle.pieces.create
+        assert piece.is_a?(Piece)
+      end
+
+      should "create and store a new child" do
+        puzzle = Puzzle.create(context)
+        puzzle.pieces.create :color => 'green'
+        assert_equal 1, puzzle.pieces.size
+        puzzle.reload
+        assert_equal 1, puzzle.pieces.size
+        assert_equal Piece, puzzle.pieces[0].class
+        assert_equal 'green', puzzle.pieces[0].color
+      end
+    end
+
+    context "add" do
+      should "add the given entity to the association" do
+        puzzle = Puzzle.create(context)
+        piece = Piece.create(context, :color => 'white')
+        puzzle.pieces.add piece
+        assert_equal 1, puzzle.pieces.size
+        puzzle.reload
+        assert_equal 1, puzzle.pieces.size
+        assert_equal Piece, puzzle.pieces[0].class
+        assert_equal 'white', puzzle.pieces[0].color
+      end
+    end
+
+    context "find" do
+      setup do
+        @puzzle = Puzzle.create(context)
+        5.times { @puzzle.pieces.create :color => 'blue' }
+      end
+
+      should "find the element with the given id" do
+        piece = @puzzle.pieces[2]
+        assert_equal piece, @puzzle.pieces.find(piece.id)
+      end
+
+      should "raise an exception if no element with the given id exists" do
+        assert_raises(Remodel::EntityNotFound) { @puzzle.pieces.find(-1) }
+      end
+    end
+  end
+
+  context "reload" do
+    should "reset has_many associations" do
+      puzzle = Puzzle.create(context)
+      piece = puzzle.pieces.create :color => 'black'
+      redis.hdel(context.key, "#{puzzle.key}_pieces")
+      puzzle.reload
+      assert_equal [], puzzle.pieces
+    end
+  end
+
+end

data/test/test_has_one.rb

@@ -0,0 +1,68 @@
+require 'helper'
+
+
+class TestHasOne < Test::Unit::TestCase
+
+  class Piece < Remodel::Entity
+    has_one :puzzle, :class => 'TestHasOne::Puzzle'
+    property :color
+  end
+
+  class Puzzle < Remodel::Entity
+    property :topic
+  end
+
+  context "association getter" do
+    should "exist" do
+      assert Piece.create(context).respond_to?(:puzzle)
+    end
+
+    should "return nil by default" do
+      assert_nil Piece.create(context).puzzle
+    end
+
+    should "return the associated entity" do
+      puzzle = Puzzle.create(context, :topic => 'animals')
+      piece = Piece.create(context)
+      redis.hset(context.key, "#{piece.key}_puzzle", puzzle.key)
+      assert_equal 'animals', piece.puzzle.topic
+    end
+  end
+
+  context "association setter" do
+    should "exist" do
+      assert Piece.create(context).respond_to?(:'puzzle=')
+    end
+
+    should "store the key of the associated entity" do
+      puzzle = Puzzle.create(context)
+      piece = Piece.create(context)
+      piece.puzzle = puzzle
+      assert_equal puzzle.key, redis.hget(context.key, "#{piece.key}_puzzle")
+    end
+
+    should "be settable to nil" do
+      piece = Piece.create(context)
+      piece.puzzle = nil
+      assert_nil piece.puzzle
+    end
+
+    should "remove the key if set to nil" do
+      piece = Piece.create(context)
+      piece.puzzle = Puzzle.create(context)
+      piece.puzzle = nil
+      assert_nil redis.hget(piece.context, "#{piece.key}_puzzle")
+    end
+  end
+
+  context "reload" do
+    should "reset has_one associations" do
+      piece = Piece.create(context, :color => 'black')
+      piece.puzzle = Puzzle.create(context)
+      redis.hdel(context.key, "#{piece.key}_puzzle")
+      piece.reload
+      assert_nil piece.puzzle
+    end
+  end
+
+end

data/test/test_inheritance.rb

@@ -0,0 +1,65 @@
+require 'helper'
+
+class TestInheritance < Test::Unit::TestCase
+
+  class Foo < Remodel::Entity
+    property :test
+  end
+
+  class Bar < Remodel::Entity
+    property :test
+  end
+
+  class Person < Remodel::Entity
+    property :name, :short => 'n'
+    has_one  :foo, :class => Foo
+    has_many :foos, :class => Foo
+  end
+
+  class Admin < Person
+    property :password, :short => 'p'
+    has_one  :bar, :class => Bar
+    has_many :bars, :class => Bar
+  end
+
+  context "a subclass of another entity" do
+    setup do
+      @admin = Admin.create(context, :name => 'peter', :password => 'secret')
+    end
+
+    should "inherit properties" do
+      @admin.reload
+      assert_equal 'peter', @admin.name
+      assert_equal 'secret', @admin.password
+    end
+
+    should "inherit has_one associations" do
+      @admin.foo = Foo.create(context, :test => 'foo')
+      @admin.bar = Bar.create(context, :test => 'bar')
+      @admin.reload
+      assert_equal 'foo', @admin.foo.test
+      assert_equal 'bar', @admin.bar.test
+    end
+
+    should "inherit has_many associations" do
+      @admin.foos.create(:test => 'foo')
+      @admin.bars.create(:test => 'bar')
+      @admin.reload
+      assert_equal 'foo', @admin.foos[0].test
+      assert_equal 'bar', @admin.bars[0].test
+    end
+
+    should "be usable as superclass" do
+      person = Person.find(context, @admin.key)
+      assert_equal 'peter', person.name
+      assert_raise(NoMethodError) { person.password }
+    end
+
+    should "use property shortnames in redis" do
+      json = redis.hget(context.key, @admin.key)
+      assert_match /"n":/, json
+      assert_match /"p":/, json
+    end
+  end
+
+end

data/test/test_shortnames.rb

@@ -0,0 +1,73 @@
+require 'helper'
+
+class TestShortnames < Test::Unit::TestCase
+
+  class Foo < Remodel::Entity; end
+
+  class Bar < Remodel::Entity
+    property :test, :short => 'z'
+    has_one  :foo,  :short => 'y', :class => Foo
+    has_many :foos, :short => 'x', :class => Foo
+  end
+
+  context "property shortnames" do
+    setup do
+      @bar = Bar.create(context, :test => 42)
+    end
+
+    should "be used when storing properties" do
+      serialized = redis.hget(context.key, @bar.key)
+      assert !serialized.match(/test/)
+      assert serialized.match(/z/)
+    end
+
+    should "work in roundtrip" do
+      @bar.reload
+      assert_equal 42, @bar.test
+    end
+
+    should "not be used in as_json" do
+      assert !@bar.as_json.has_key?(:z)
+      assert @bar.as_json.has_key?(:test)
+    end
+
+    should "not be used in inspect" do
+      assert !@bar.inspect.match(/z/)
+      assert @bar.inspect.match(/test/)
+    end
+  end
+
+  context "has_one shortnames" do
+    setup do
+      @bar = Bar.create(context, :test => 42)
+      @bar.foo = Foo.create(context)
+    end
+
+    should "be used when storing" do
+      assert_not_nil redis.hget(context.key, "#{@bar.key}_y")
+    end
+
+    should "work in roundtrip" do
+      @bar.reload
+      assert_not_nil @bar.foo
+    end
+  end
+
+  context "has_many shortnames" do
+    setup do
+      @bar = Bar.create(context, :test => 42)
+      @bar.foos.create
+      @bar.foos.create
+    end
+
+    should "be used when storing" do
+      assert_not_nil redis.hget(context.key, "#{@bar.key}_x")
+    end
+
+    should "work in roundtrip" do
+      @bar.reload
+      assert_equal 2, @bar.foos.size
+    end
+  end
+
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 4
-  - 2
-  version: 0.4.2
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Tim Lossen
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-11 00:00:00 +02:00
+date: 2011-08-16 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -32,8 +32,6 @@ files:
 - README.md
 - Rakefile
 - VERSION
-- docs/docco.css
-- docs/remodel.html
 - example/book.rb
 - lib/remodel.rb
 - lib/remodel/caching_context.rb
@@ -46,14 +44,13 @@ files:
 - test/test_entity.rb
 - test/test_entity_defaults.rb
 - test/test_entity_delete.rb
-- test/test_entity_shortnames.rb
-- test/test_many_to_many.rb
-- test/test_many_to_one.rb
+- test/test_has_many.rb
+- test/test_has_one.rb
+- test/test_inheritance.rb
 - test/test_mappers.rb
 - test/test_monkeypatches.rb
-- test/test_one_to_many.rb
-- test/test_one_to_one.rb
 - test/test_remodel.rb
+- test/test_shortnames.rb
 has_rdoc: true
 homepage: http://github.com/tlossen/remodel
 licenses: []
@@ -92,11 +89,10 @@ test_files:
 - test/test_entity.rb
 - test/test_entity_defaults.rb
 - test/test_entity_delete.rb
-- test/test_entity_shortnames.rb
-- test/test_many_to_many.rb
-- test/test_many_to_one.rb
+- test/test_has_many.rb
+- test/test_has_one.rb
+- test/test_inheritance.rb
 - test/test_mappers.rb
 - test/test_monkeypatches.rb
-- test/test_one_to_many.rb
-- test/test_one_to_one.rb
 - test/test_remodel.rb
+- test/test_shortnames.rb