remodel 0.3.0 → 0.3.1

data/README.md

@@ -10,6 +10,7 @@ entities are serialized to json and stored as fields in a redis hash. using diff
 for example.
 
 
+
 ## why redis?
 
 redis offers in-memory read and write performance — on the order of 10K to 100K 
@@ -51,7 +52,7 @@ define your domain model [like this](http://github.com/tlossen/remodel/blob/mast
 
 	class Book < Remodel::Entity
 	  has_many :chapters, :class => 'Chapter', :reverse => :book
-	  property :title, :class => 'String'
+	  property :title, :short => 't', :class => 'String'
 	  property :year, :class => 'Integer'
 	  property :author, :class => 'String', :default => '(anonymous)'
 	end
@@ -75,7 +76,7 @@ now you can do:
 all entities have been created in the redis hash 'shelf' we have used as context:
 
 	>> Remodel.redis.hgetall 'shelf'
-	=> {"b"=>"1", "b1"=>"{\"title\":\"Moby Dick\",\"year\":1851}", "c"=>"1", 
+	=> {"b"=>"1", "b1"=>"{\"t\":\"Moby Dick\",\"year\":1851}", "c"=>"1", 
 	   "c1"=>"{\"title\":\"Ishmael\"}", "c1_book"=>"b1", "b1_chapters"=>"[\"c1\"]"}
 
 ## inspired by
@@ -102,4 +103,4 @@ it has some rough edges, but i have successfully been using remodel in productio
 
 ## license
 
-[MIT](http://github.com/tlossen/remodel/raw/master/LICENSE)
+[MIT](http://github.com/tlossen/remodel/raw/master/LICENSE)

data/Rakefile

@@ -5,8 +5,8 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "remodel"
-    gem.summary = "remodel variant which uses hashes"
-    gem.description = "persist your objects to redis hashes."
+    gem.summary = "a minimal ORM (object-redis-mapper)"
+    gem.description = "persist your objects to redis hashes"
     gem.email = "tim@lossen.de"
     gem.homepage = "http://github.com/tlossen/remodel"
     gem.authors = ["Tim Lossen"]

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/example/book.rb

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

data/lib/remodel/entity.rb

@@ -83,6 +83,7 @@ module Remodel
     def self.property(name, options = {})
       name = name.to_sym
       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] }
       define_method("#{name}=") { |value| @attributes[name] = value }
@@ -186,31 +187,48 @@ module Remodel
     def self.pack(attributes)
       result = {}
       attributes.each do |name, value|
-        result[name] = mapper[name].pack(value)
+        short = shortname[name] || name
+        result[short] = mapper[name].pack(value)
       end
       result
     end
 
     def self.unpack(attributes)
       result = {}
-      attributes.each do |name, value|
-        name = name.to_sym
+      attributes.each do |short, value|
+        short = short.to_sym
+        name = fullname[short] || short
         result[name] = mapper[name].unpack(value) if mapper[name]
       end
       result
     end
 
-    # Lazy init
+    def self.copy_of(value)
+      value.is_a?(Array) || value.is_a?(Hash) ? value.dup : value
+    end
+
+    def self.define_shortname(name, short)
+      return unless short
+      short = short.to_sym
+      shortname[name] = short
+      fullname[short] = name
+    end
+
+    # class instance variables (lazy init)
     def self.mapper
       @mapper ||= {}
     end
 
-    def self.associations
-      @associations ||= []
+    def self.shortname
+      @shortname ||= {}
     end
 
-    def self.copy_of(value)
-      value.is_a?(Array) || value.is_a?(Hash) ? value.dup : value
+    def self.fullname
+      @fullname ||= {}
+    end
+
+    def self.associations
+      @associations ||= []
     end
 
   end

data/test/test_entity.rb

@@ -70,7 +70,7 @@ class TestEntity < Test::Unit::TestCase
 
     should "not store the key as a property" do
       foo = Foo.create('cx', :x => 'hello', :y => false)
-      assert !(/f:1/ =~ redis.hget('cx', foo.key))
+      assert !(/f1/ =~ redis.hget('cx', foo.key))
     end
   end
 

data/test/test_entity_shortnames.rb

@@ -0,0 +1,36 @@
+require 'helper'
+
+class TestEntityShortnames < Test::Unit::TestCase
+
+  class Bar < Remodel::Entity
+    property :foo, :short => 'z'
+  end
+
+  context "[short names]" do
+    setup do
+      @bar = Bar.create('cx', :foo => 42)
+    end
+    
+    should "be used when storing properties" do
+      serialized = redis.hget('cx', @bar.key)
+      assert !serialized.match(/foo/)
+      assert serialized.match(/z/)
+    end
+    
+    should "work in roundtrip" do
+      @bar.reload
+      assert_equal 42, @bar.foo
+    end
+    
+    should "not be used in as_json" do
+      assert !@bar.as_json.has_key?(:z)
+      assert @bar.as_json.has_key?(:foo)
+    end
+    
+    should "not be used in inspect" do
+      assert !@bar.inspect.match(/z/)
+      assert @bar.inspect.match(/foo/)
+    end
+  end
+
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Tim Lossen
@@ -14,14 +14,14 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-31 00:00:00 +02:00
-default_executable: redis-monitor.rb
+date: 2011-06-16 00:00:00 +02:00
+default_executable: 
 dependencies: []
 
-description: persist your objects to redis hashes.
+description: persist your objects to redis hashes
 email: tim@lossen.de
-executables: 
-- redis-monitor.rb
+executables: []
+
 extensions: []
 
 extra_rdoc_files: 
@@ -32,7 +32,6 @@ files:
 - README.md
 - Rakefile
 - VERSION
-- bin/redis-monitor.rb
 - docs/docco.css
 - docs/remodel.html
 - example/book.rb
@@ -44,6 +43,7 @@ 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_mappers.rb
@@ -81,12 +81,13 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: remodel variant which uses hashes
+summary: a minimal ORM (object-redis-mapper)
 test_files: 
 - test/helper.rb
 - 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_mappers.rb

data/bin/redis-monitor.rb

@@ -1,25 +0,0 @@
-#!/usr/bin/env ruby
-
-# http://gist.github.com/267149 (mathias meyer)
-
-require 'socket'
-host = ARGV[0] || 'localhost'
-port = ARGV[1] || '6379'
-
-trap(:INT) {
-  exit
-}
-
-puts "Connecting to #{host}:#{port}"
-begin
-  sock = TCPSocket.new(host, port)
-  sock.setsockopt Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1
-
-  sock.write("monitor\r\n")
-
-  while line = sock.gets
-    puts line
-  end
-rescue Errno::ECONNREFUSED
-  puts "Connection refused"
-end