zebris 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d82aa602d7e4e5640c78087c63c0707c0301dbb0
-  data.tar.gz: 85bda8fd3143cd50cfa3e0b43af3e216a2fcc287
+  metadata.gz: 3b41c71b77c9cb0ad27d3ebc402203f2d0900a04
+  data.tar.gz: 12550a668b6b8701e9923b6764b3cc7ab00a6ef7
 SHA512:
-  metadata.gz: 582d250221952c4a7694fb069681a8d2792b140ad8b25e76546d1128bb97c3d4d50d5dd3025093f344bee9ac22b34788d47bfe98c1eaefe2e89efc84829ba6ba
-  data.tar.gz: d56c3bf257822fd2165abced26b19bb7dcb434bc5e576bf6d2305be58bd76fb3634dd47d42865b1e344dcc44317f781abb7ce39448acbe054ee134598bad52fb
+  metadata.gz: 03dec832c90d045b163edab0d0bc4748db9211fb07254ebe4058417675639339239ef23f37f5ae8f9aa125ebd4f7ce1b0975230052016fcb92bb5a785f04a840
+  data.tar.gz: 9b7be6818cbbf39b4298b1a67d518ab55d8c356ddc99881d83dafd6995976e7ad1bdb20893bed0f9725dab12151c7d2d506ed199bcfc0a7d9b65dcec3cb80e25

data/README.md

@@ -1,3 +1,5 @@
+[![Gem Version](https://badge.fury.io/rb/zebris.png)](http://badge.fury.io/rb/zebris)
+
 # Zebris
 
 Zebris is built to allow you to add persisting and retrieving your objects to and from Redis with a minimum of hassle or re-writing of your code.
@@ -58,6 +60,69 @@ Zebris is happy to delegate to any Redis client that supports the 2.0+ command l
 
     # Tyler is back
 
+### Custom serialization/deserialization
+
+    class WaterSample
+      include Zebris::Document
+
+      key {UUID.generate}   # Or anything that will generate unique keys
+
+      # Redis likes strings, so you can provide a proc to serialize
+      # and deserialize your data to/from strings if it doesn't fit
+      # the built-in types
+      property :subject, String
+      property :time, lambda {|time| time.to_i.to_s}, lambda {|milli| Time.at(milli.to_i)}
+      property :measurement, lambda {|m| "#{m.value}:#{m.units}"}, lambda {|m| value,units = m.split(/:/); Measurement.new(value.to_f, units)}
+    end
+
+    sample = WaterSample.new
+    sample.subject = "Arsenic Levels"
+    sample.time = Time.now
+    sample.measurement = Measurement.new(0.05, "ppm")
+
+    key = sample.save
+    => "some uuid here"
+
+    last_sample = Sample.find(key)
+
+### Embedded Documents
+There is also support for embedded documents.  If you declare a property with a type that includes Zebris::Document, what
+you will get is an embedded serialization of the property when you save.  This is different than a relational model where
+the two documents are stored separately and related together via keys.
+
+    class Listing
+      include Zebris::Document
+
+      key {UUID.generate}
+
+      collection :people, Person
+
+      class Person
+        include Zebris::Document
+
+        # No key needed since this is embedded
+
+        property :name, String
+        property :age, Integer
+
+        def initialize(name, age)
+          @name = name
+          @age = age
+        end
+      end
+    end
+
+    l = Listing.new
+    l.people << Listing::Person.new("John", 30)
+    l.people << Listing::Person.new("Mary", 28)
+
+    key = l.save
+
+    # ... some time later ...
+    l2 = Listing.find(key)
+
+    # Our listings are back
+
 ## Contributing
 
 1. Fork it

data/lib/zebris/document.rb

@@ -37,23 +37,29 @@ module Zebris
         end
       end
 
-      def serialize(object)
-        attributes = {"key" => object.key}
+      def serialize(object, embed = false)
+        attributes = (embed ? {} : {"key" => object.key})
 
         properties.each do |property, conversion|
           if val = object.send(property.to_sym)
             if conversion.kind_of?(Zebris::Types::GenericConverter)
               attributes[property.to_s] = conversion.serializer.call(val)
             else
-              attributes[property.to_s] = conversion.serialize(val)
+              if conversion.ancestors.include?(Zebris::Document)
+                attributes[property.to_s] = conversion.serialize(val, true)
+              else
+                attributes[property.to_s] = conversion.serialize(val)
+              end
             end
           end
         end
 
         collections.each do |property, klass|
+          raise "#{klass} does not implement the Zebris::Document interface" unless klass.ancestors.include?(Zebris::Document)
+
           attributes[property] ||= []
           object.send(:instance_variable_get, :"@#{property}").each do |record|
-            attributes[property] << record.serialize
+            attributes[property] << klass.serialize(record, true)
           end
         end
 
@@ -137,7 +143,10 @@ module Zebris
 
       def collection(name, klass)
         collections[name] = klass
-        self.send(:attr_accessor, name)
+        self.send(:attr_writer, name)
+        self.send(:define_method, :"#{name}") {
+          self.send(:instance_variable_get, :"@#{name}") || self.send(:instance_variable_set, :"@#{name}", [])
+        }
       end
     end
   end

data/lib/zebris/version.rb

@@ -1,3 +1,3 @@
 module Zebris
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/lib/document_spec.rb

@@ -34,6 +34,32 @@ describe Zebris::Document do
     end
   end
 
+  class CollectionDocument
+    include Zebris::Document
+
+    key {UUID.generate}
+
+    collection :people, Person
+
+    class Person
+      include Zebris::Document
+
+      property :name, String
+      property :age, Integer
+    end
+  end
+
+  class InvalidCollectionDocument
+    include Zebris::Document
+
+    key {UUID.generate}
+
+    collection :people, Person
+
+    class Person
+    end
+  end
+
   let!(:redis)      {double(:redis, set: "OK", get: true)}
   let(:key)         {"ABCDEFG"}
   let(:name)        {"John Henry"}
@@ -89,7 +115,7 @@ describe Zebris::Document do
           person.age = age
           person.stub(:key).and_return(person_key)
 
-          redis.should_receive(:set).with(key, {"key" => key, "person" => {"key" => person_key, "name" => name, "age" => age}}.to_json)
+          redis.should_receive(:set).with(key, {"key" => key, "person" => {"name" => name, "age" => age}}.to_json)
 
           document = NestedDocument.new
           document.stub(:key).and_return(key)
@@ -113,6 +139,31 @@ describe Zebris::Document do
           }.to raise_exception
         end
       end
+
+      context "collections" do
+        it "serializes each item in a collection properly" do
+          document = CollectionDocument.new
+          document.stub(:key).and_return(key)
+          redis.should_receive(:set).with(key, {"key" => key, "people" => [{"name" => name, "age" => age}]}.to_json)
+
+          p = CollectionDocument::Person.new
+          p.name = name
+          p.age = age
+
+          document.people << p
+          document.save
+        end
+
+        it "raises an error if the serialization type does not support the Zebris::Document interface" do
+          document = InvalidCollectionDocument.new
+          document.stub(:key).and_return(key)
+          document.people << InvalidCollectionDocument::Person.new
+
+          expect {
+            expect document.save
+          }.to raise_exception
+        end
+      end
     end
   end
 

data/zebris.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["jgailor@gmail.com"]
   spec.description   = %q{Zebris is a library to persist your object data to Redis.  Its goal is to be as unobtrusive as possible.}
   spec.summary       = %q{Zebris makes persisting your objects to Redis easy.}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/JGailor/zebris"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zebris
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jeremy Gailor
@@ -86,7 +86,7 @@ files:
 - spec/lib/document_spec.rb
 - spec/lib/types_spec.rb
 - zebris.gemspec
-homepage: ''
+homepage: https://github.com/JGailor/zebris
 licenses:
 - MIT
 metadata: {}