ocean-dynamo 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 138288de7c56bfec0e6b855364e910db04068cb9
-  data.tar.gz: 7d7777352fdd4fbd27b9bcc78cba18ce7e5f7343
+  metadata.gz: 8e2c646cd685be098d298f74ceab69c47f2902f9
+  data.tar.gz: 3739a76a1112bd433280cce959a2072c48ea33b6
 SHA512:
-  metadata.gz: 6914457ba9a20640a814391b537d374b3654493c06fb455f054c200a0a4968a274c1acffc3d8e651ee6ba9ea7d74af45ca09287e997df10dc7190d7d1f68815f
-  data.tar.gz: f8d8966879edc71173e31482a5cdbab7904b2eac1990549293c5ebc392501dedb4090a16f817cd7ab08034cd9cb3f2a6ead0ebe347384fef1e0e551d1e5c7237
+  metadata.gz: c60acec3262ac60b21834edbf0f83c2d6d4107e411e763eb870f2e1a40a711c950b98983f3913ada9a033f42aa6a7c703dd182b67668e041f169b1b216b893c9
+  data.tar.gz: 78b9983c8d189f1c9f755a301eeac0075c9252fc96590cd6f2d68f8407220113b943c2a871839f3801bff632ebb1724ceda5fa422838f62b6cf885a8671f36a2

data/README.rdoc

@@ -30,7 +30,7 @@ from SQL to no-SQL much easier.
 Thanks to its structural similarity to ActiveRecord, OceanDynamo works with FactoryGirl.
 To facilitate testing, future versions will keep track of and delete instances after tests.
 
-OceanDynamo will use secondary indices to retrieve related table items, 
+OceanDynamo will use primary and secondary indices to retrieve related table items, 
 which means it will scale without limits.
 
 
@@ -62,7 +62,7 @@ The following example shows the syntax.
 
 Each attribute has a name, a type (+:string+, +:integer+, +:float+, +:datetime+, +:boolean+, 
 or +:serialized+) where +:string+ is the default. Each attribute also optionally has a default 
-value, which can be a Proc. The hash key attribute is by default +:id+ (overridden as :uuid in
+value, which can be a Proc. The hash key attribute is by default +:id+ (overridden as +:uuid+ in
 the example above) and is a +:string+. The keys can also be explicitly declared.
 
 The +:string+, +:integer+, +:float+ and +:datetime+ types can also store sets of their type.
@@ -96,9 +96,10 @@ controllers. Furthermore, OceanDynamo implements much of the infrastructure of A
 for instance, +read_attribute+, +write_attribute+, and much of the control logic and
 parameters.
 
-Relations are not yet implemented, but are underway. Relations will use secondary
+Relations are not yet implemented, but are underway. Assocations will use secondary
 indices, up to the DynamoDB maximum of 5 secondary keys per table. At the moment,
-only find with a single uuid is implemented. Collections can not yet be obtained.
+only find with a single id is implemented. Collections can not yet be obtained.
+Work has begun on the +belongs_to+ association which requires only a primary index.
 
 OceanDynamo is currently used in the Ocean framework (http://wiki.oceanframework.net)
 e.g. to implement critical job queues. It will be used increasingly as features are

data/lib/ocean-dynamo.rb

@@ -13,6 +13,7 @@ require "ocean-dynamo/callbacks"
 require "ocean-dynamo/attributes"
 require "ocean-dynamo/queries"
 require "ocean-dynamo/persistence"
+require "ocean-dynamo/associations"
 
 
 module OceanDynamo

data/lib/ocean-dynamo/associations.rb

@@ -0,0 +1,51 @@
+module OceanDynamo
+  class Base
+
+    def self.belongs_to(other_class)
+      klass = other_class.to_s.capitalize.constantize
+      other_class_attr = other_class.to_s.underscore
+      name = "#{other_class_attr}_id"
+      attribute name,             :reference, default: nil, target_class: klass
+      attribute other_class_attr, :reference, default: nil, target_class: klass, no_save: true
+
+      self.class_eval "def #{other_class_attr}
+                         read_and_maybe_load_pointer('#{name}')
+                       end"
+
+      self.class_eval "def #{name}
+                         read_pointer_id('#{name}')
+                       end"
+
+      self.class_eval "def #{other_class_attr}=(value) 
+                         write_attribute('#{name}', value) 
+                         write_attribute('#{other_class_attr}', value)
+                       end"
+
+      self.class_eval "def #{name}=(value)
+                         write_attribute('#{name}', value) 
+                         write_attribute('#{other_class_attr}', value)
+                       end"
+      # TODO: Additional "?" method for name
+    end
+
+
+    protected
+
+    def read_and_maybe_load_pointer(name)  # :nodoc:
+      ptr = read_attribute(name)
+      return nil if ptr.blank?
+      if persisted? && ptr.is_a?(String)
+        write_attribute(name, fields[name][:target_class].find(ptr))  # Keep the instance we've just read
+      else
+        ptr
+      end
+    end
+
+    def read_pointer_id(name)  # :nodoc:
+      ptr = read_attribute(name)
+      return nil if ptr.blank?
+      ptr.is_a?(String) ? ptr : ptr.id
+    end
+
+  end
+end

data/lib/ocean-dynamo/attributes.rb

@@ -101,6 +101,8 @@ module OceanDynamo
     def type_cast_attribute_for_write(name, value, metadata=fields[name],
                                       type: metadata[:type])
       case type
+      when :reference
+        return value
       when :string
         return nil if value == nil
         return value.collect(&:to_s) if value.is_a?(Array)
@@ -131,7 +133,7 @@ module OceanDynamo
 
 
     def serialized_attributes
-      result = {}
+      result = Hash.new
       fields.each do |attribute, metadata|
         serialized = serialize_attribute(attribute, read_attribute(attribute), metadata)
         result[attribute] = serialized unless serialized == nil
@@ -141,11 +143,21 @@ module OceanDynamo
 
 
     def serialize_attribute(attribute, value, metadata=fields[attribute],
-                            type: metadata[:type])
+                            target_class: metadata[:target_class],
+                            type: metadata[:type],
+                            no_save: metadata[:no_save]
+                            )
       return nil if value == nil
       case type
+      when :reference
+        return nil if no_save
+        raise DynamoError, ":reference must always have a :target_class" unless target_class
+        return value if value.is_a?(String)
+        return value.id if value.is_a?(target_class)
+        raise AssociationTypeMismatch, "can't save a #{value.class} in a #{target_class} :reference"
       when :string
-        ["", []].include?(value) ? nil : value
+        return nil if ["", []].include?(value)
+        value
       when :integer
         value == [] ? nil : value
       when :float
@@ -164,6 +176,8 @@ module OceanDynamo
 
     def deserialize_attribute(value, metadata, type: metadata[:type])
       case type
+      when :reference
+        return value
       when :string
         return "" if value == nil
         value.is_a?(Set) ? value.to_a : value

data/lib/ocean-dynamo/exceptions.rb

@@ -52,4 +52,6 @@ module OceanDynamo
 
   class MultiparameterAssignmentErrors < DynamoError; end
 
+  class AssociationTypeMismatch < DynamoError; end
+
 end

data/lib/ocean-dynamo/persistence.rb

@@ -237,8 +237,9 @@ module OceanDynamo
 
     def _dynamo_read_attributes(consistent_read: false) # :nodoc:
       hash = _dynamo_read_raw_attributes(consistent_read)
-      result = {}
+      result = Hash.new
       fields.each do |attribute, metadata|
+        next if metadata[:no_save]
         result[attribute] = deserialize_attribute(hash[attribute], metadata)
       end
       result

data/lib/ocean-dynamo/queries.rb

@@ -4,7 +4,7 @@ module OceanDynamo
     def self.find(hash, range=nil, consistent: false)
       _late_connect?
       item = dynamo_items[hash, range]
-      raise RecordNotFound unless item.exists?
+      raise RecordNotFound, "can't find a #{self} with primary key ['#{hash}', #{range.inspect}]" unless item.exists?
       new.send(:dynamo_unpersist, item, consistent)
     end
 

data/lib/ocean-dynamo/schema.rb

@@ -61,10 +61,10 @@ module OceanDynamo
     end
 
 
-    def self.attribute(name, type=:string, **pairs)
+    def self.attribute(name, type=:string, default: nil, **extra)
       raise DangerousAttributeError, "#{name} is defined by OceanDynamo" if self.dangerous_attributes.include?(name.to_s)
       attr_accessor name
-      fields[name.to_s] = {type: type, default: pairs[:default]}
+      fields[name.to_s] = {type: type, default: default}.merge(extra)
     end
 
 

data/lib/ocean-dynamo/version.rb

@@ -1,3 +1,3 @@
 module OceanDynamo
-  VERSION = "0.3.3"
+  VERSION = "0.3.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ocean-dynamo
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Peter Bengtson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-13 00:00:00.000000000 Z
+date: 2013-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -160,6 +160,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - config/routes.rb
+- lib/ocean-dynamo/associations.rb
 - lib/ocean-dynamo/attributes.rb
 - lib/ocean-dynamo/base.rb
 - lib/ocean-dynamo/callbacks.rb