ocean-dynamo 0.4.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3dc795167d56cef7e557c8f233b0e6e2fe3a205a
-  data.tar.gz: 4979ca24a5937658f00a325981dec200a81f0263
+  metadata.gz: f06f0f651adf9199dd190cedd203390528548a1f
+  data.tar.gz: 1082719f92e830ef6e60658b77048719cfaed6b1
 SHA512:
-  metadata.gz: 4796a5bb3c5b216a96b10c9955ec6815ce676e869c7ec6367bb4534bb8f8f349535f96c77308dcaa18a49a786bdcfff631321787a01079bc356aa9f106a6d911
-  data.tar.gz: 132101d4bb782d609c75e912a658f19ba423f455e2be2b2bad4d4a720ddc7f45aee1c1ded129bb6713026af0ada9703b14f0539804d4a7dede8d9eb4d478ae99
+  metadata.gz: 67d5231c8cef81f6b566c4e9a1f630c32dc510289a5fe3d27a05cb2a83a4bf5f31db1df13b16a6369e7482351dbbf87470d4bb8fa859710eae6290d050701ec5
+  data.tar.gz: b529ee10710b85465e3b82668268ed5c78226b83a2a3619f54c213492ebf4d8aa334b0344fefb960548db84e536dd92e8f614da51592a7849405e0f758402ccc

data/README.rdoc

@@ -94,28 +94,37 @@ value will return the empty string, <tt>""</tt>.
 
 ==== Example
 
-The following example shows how to set up a +has_many+ / +belongs_to+ relation:
-
- class Child < OceanDynamo::Table; end
+The following example shows how to set up +has_many+ / +belongs_to+ relations:
  
- class Parent < OceanDynamo::Table
+ class Forum < OceanDynamo::Table
    dynamo_schema do
-     attribute :this
-     attribute :that
-     attribute :the_other
+     attribute :name
+     attribute :description
    end
-   has_many :children, dependent: :destroy
+   has_many :topics, dependent: :destroy
  end
  
  
- class Child < OceanDynamo::Table
+ class Topic < OceanDynamo::Table
    dynamo_schema(:uuid) do
-     attribute :foo
-     attribute :bar
-     attribute :baz
+     attribute :title
    end
-   belongs_to :parent
+   belongs_to :forum
+   has_many :posts, dependent: :destroy
  end
+ 
+
+ class Post < OceanDynamo::Table
+   dynamo_schema(:uuid) do
+     attribute :body
+   end
+   belongs_to :topic, composite_key: true
+ end
+
+The only non-standard aspect of the above is <tt>composite_key: true</tt>, which 
+is required as the Topic class itself has a +belongs_to+ relation and thus has
+a composite key. This must be declared in the child class as it needs to know
+how to retrieve its parent.
 
 ==== Restrictions
 
@@ -126,7 +135,6 @@ Restrictions for +belongs_to+ tables:
 * +belongs_to+ must be placed after the +dynamo_schema+ attribute block.
 
 Restrictions for +has_many+ tables:
-* The +has_many+ table may not have a range key.
 * +has_many+ must be placed after the +dynamo_schema+ attribute block.
 
 These restrictions allow OceanDynamo to implement the +has_many+ / +belongs_to+ 
@@ -162,10 +170,8 @@ controllers. OceanDynamo implements much of the infrastructure of ActiveRecord;
 for instance, +read_attribute+, +write_attribute+, and much of the control logic and
 internal organisation.
 
-* The +dependent:+ keyword arg may now be +:destroy+, +:delete+ or +:nullify+
-  with the same semantics as in ActiveRecord. With +:nullify+, however,
-  the hash key is set to the string "NULL" rather than binary NULL, as
-  DynamoDB doesn't permit storing empty fields.
+* +has_many+ can now be nested in multiple layers through the use of +:composite_key+ 
+  in +belongs_to+. See the documentation for +belongs_to+.
 
 === Future milestones
 

data/lib/ocean-dynamo/associations/associations.rb

@@ -52,6 +52,11 @@ module OceanDynamo
         super
       end
 
+
+      def define_class_if_not_defined(class_name)
+        Object.const_set(class_name, Class.new(OceanDynamo::Table)) unless const_defined?(class_name)
+      end
+
     end
 
 

data/lib/ocean-dynamo/associations/belongs_to.rb

@@ -15,12 +15,46 @@ module OceanDynamo
     module ClassMethods
       
       #
-      # Class macro to define the +belongs_to+ relation.
+      # Class macro to define the +belongs_to+ relation. For example:
       #
-      def belongs_to(target)                             # :master, "master", Master
+      #  class Forum < OceanDynamo::Table
+      #    dynamo_schema do
+      #      attribute :name
+      #      attribute :description
+      #    end
+      #    has_many :topics, dependent: :destroy
+      #  end
+      # 
+      # class Topic < OceanDynamo::Table
+      #   dynamo_schema(:uuid) do
+      #     attribute :title
+      #   end
+      #   belongs_to :forum
+      #   has_many :posts, dependent: :destroy
+      # end
+      # 
+      # class Post < OceanDynamo::Table
+      #   dynamo_schema(:uuid) do
+      #     attribute :body
+      #   end
+      #   belongs_to :topic, composite_key: true
+      # end
+      # 
+      # The only non-standard aspect of the above is <tt>composite_key: true</tt>, 
+      # which is required as the Topic class itself has a +belongs_to+ relation and 
+      # thus has a composite key. This must be declared in the child class as it 
+      # needs to know how to retrieve its parent. If you were to add a Comment class
+      # to the above with a <tt>has_many/belongs_to</tt> relation to Post, the Comment
+      # class would also have a <tt>belongs_to :post, composite_key: true</tt> statement,
+      # since Post already has a composite key due to its +belongs_to+ relation to
+      # the Topic class.
+      #
+      def belongs_to(target, composite_key: false)       # :master, "master", Master
         target_attr = target.to_s.underscore             # "master"
         target_attr_id = "#{target_attr}_id"             # "master_id"
-        target_class = target_attr.camelize.constantize  # Master
+        class_name = target_attr.classify                # "Master"
+        define_class_if_not_defined(class_name)
+        target_class = class_name.constantize            # Master
 
         assert_only_one_belongs_to!
 
@@ -47,7 +81,7 @@ module OceanDynamo
 
         # Define accessors for instances
         self.class_eval "def #{target_attr}
-                           @#{target_attr} ||= load_target_from_id('#{target_attr_id}')
+                           @#{target_attr} ||= load_target_from_id('#{target_attr_id}', #{composite_key})
                          end"
 
         self.class_eval "def #{target_attr_id}
@@ -55,7 +89,7 @@ module OceanDynamo
                          end"
 
         self.class_eval "def #{target_attr}=(value) 
-                           target, target_id = type_check_target(#{target_class}, value)
+                           target, target_id = type_check_target(#{target_class}, value, #{composite_key})
                            write_attribute('#{target_attr_id}', target_id) 
                            @#{target_attr} = target
                            value
@@ -118,11 +152,6 @@ module OceanDynamo
     #  Instance variables and methods
     #
     # ---------------------------------------------------------
-    # def initialize(attrs={})
-    #   super
-    # end
-
-
 
     #
     # This is run by #initialize and by #assign_attributes to set the
@@ -138,10 +167,11 @@ module OceanDynamo
     end
 
 
-    def load_target_from_id(name)  # :nodoc:
+    def load_target_from_id(name, composite_key)  # :nodoc:
       v = read_attribute(name)
       return nil unless v
-      fields[name][:target_class].find(v, consistent: true)
+      h, r = composite_key ? v.split(':') : v
+      fields[name][:target_class].find(h, r, consistent: true)
     end
 
 
@@ -152,10 +182,15 @@ module OceanDynamo
     end
 
 
-    def type_check_target(target_class, value)
+    def type_check_target(target_class, value, composite_key)
       return nil unless value
-      return [value, value.hash_key] if value.kind_of?(target_class)
-      raise AssociationTypeMismatch, "can't save a #{value.class} in a #{target_class} foreign key"
+      if value.kind_of?(target_class)
+        foreign_key = value.hash_key
+        foreign_key += ':' + value.range_key if composite_key
+        return [value, foreign_key]
+      else
+        raise AssociationTypeMismatch, "can't save a #{value.class} in a #{target_class} foreign key"
+      end
     end
 
   end

data/lib/ocean-dynamo/associations/has_many.rb

@@ -16,16 +16,18 @@ module OceanDynamo
 
 
       #
-      # Defines a has_many relation to a belongs_to class.
+      # Defines a +has_many+ relation to a +belongs_to+ class.
       #
       # The +dependent:+ keyword arg may be +:destroy+, +:delete+ or +:nullify+
       # and have the same semantics as in ActiveRecord. With +:nullify+, however,
       # the hash key is set to the string "NULL" rather than binary NULL, as
       # DynamoDB doesn't permit storing empty fields.
       #
-      def has_many(children, dependent: :nullify)                    # :children
-        children_attr = children.to_s.underscore                     # "children"
-        child_class = children_attr.singularize.camelize.constantize # Child
+      def has_many(children, dependent: :nullify)            # :children
+        children_attr = children.to_s.underscore             # "children"
+        class_name = children_attr.classify                  # "Child"
+        define_class_if_not_defined(class_name)
+        child_class = class_name.constantize                 # Child
         register_relation(child_class, :has_many)
 
         # Handle children= after create and update

data/lib/ocean-dynamo/version.rb

@@ -1,3 +1,3 @@
 module OceanDynamo
-  VERSION = "0.4.4"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ocean-dynamo
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.0
 platform: ruby
 authors:
 - Peter Bengtson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-30 00:00:00.000000000 Z
+date: 2013-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk