ocean-dynamo 0.3.12 → 0.3.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78c329fb34c6009e6168abc0d4a8f8bd5a973de4
-  data.tar.gz: 0acc91468d0d8a3a7773dd1dde5f63d3c330381e
+  metadata.gz: ff62cac1b81cd01f68f4d8be25004ae94c0afa14
+  data.tar.gz: f5fa8a4e8d8c7b86421a2ad977fd279136a08402
 SHA512:
-  metadata.gz: 26850203ac5c1f3665bce77a2c14c33990e0355a84cc10163bd3275d56d9afcf33d03a0e766b7e3679e36aabd385311e1a5373da74f6543e1f7191f05f953b5a
-  data.tar.gz: 810d9c6bab90781479716dccb02cd9390576ceedc06f883f16d155ea97f839323ff42a7ca3f83e0c208ce4ce86e369898a83b59c3f12befde20d2e7726e64f52
+  metadata.gz: d2296afae10ea96ca8eecdb5822878da60fbd2c20b293a868694f6167bfc95ddb9519153a8b1fb08bacc7ec2506a25c307aefc4cf01398e4486d17e01f568c9e
+  data.tar.gz: 02ec483b0b395f07e5213bc572cf57e30ad30cd420d0b9bf39fafbcb04198f391bb8b73603f22c1e6b98dc728d18e7491e1d84c72e0ecd0232ccabfe62fbb798

data/README.rdoc

@@ -18,9 +18,9 @@ is of course based on ActiveModel.
 
 The attribute and persistence layer of OceanDynamo is modeled on that of ActiveRecord:
 there's +save+, +save!+, +create+, +update+, +update!+, +update_attributes+, +find_each+,
-and all the other methods you're used to. The design goal is always to implement as much 
-of the ActiveRecord interface as possible, without compromising scalability. This makes the 
-task of switching from SQL to no-SQL much easier.
++destroy_all+, +delete_all+ and all the other methods you're used to. The design goal 
+is always to implement as much of the ActiveRecord interface as possible, without 
+compromising scalability. This makes the task of switching 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.
@@ -30,7 +30,9 @@ which means it will scale without limits.
 
 === Example
 
-The following example shows the syntax. 
+==== Basic syntax
+
+The following example shows the basic syntax for declaring a DynamoDB-based schema. 
 
   class AsyncJob < OceanDynamo::Base
 
@@ -54,6 +56,8 @@ The following example shows the syntax.
     
   end
 
+==== Attributes
+
 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
@@ -65,7 +69,9 @@ Sets are represented as arrays, may not contain duplicates and may not be empty.
 All attributes except the +:string+ type can take the value +nil+. Storing +nil+ for a string
 value will return the empty string, <tt>""</tt>.
 
-Also, dynamo_schema takes args and many options. Here's the full syntax:
+==== Schema args and options
+
++dynamo_schema+ takes args and many options. Here's the full syntax:
 
  dynamo_schema(
    table_hash_key = :id,                   # The name of the hash key attribute
@@ -85,7 +91,11 @@ Also, dynamo_schema takes args and many options. Here's the full syntax:
    ...
  end
 
-The following example shows how to set up a belongs_to relation:
+=== +belongs_to+
+
+==== Example
+
+The following example shows how to set up a +belongs_to+ relation:
 
  class Parent < OceanDynamo::Base
    dynamo_schema do
@@ -106,38 +116,28 @@ The following example shows how to set up a belongs_to relation:
    belongs_to :parent
  end
 
-The +belongs_to+ declaration must follow after the +dynamo_schema+ attribute block.
-
-
-=== Current State
-
-At the moment, OceanDynamo is fully usable as an ActiveModel and can be used by Rails
-controllers. Furthermore, OceanDynamo implements much of the infrastructure of ActiveRecord;
-for instance, +read_attribute+, +write_attribute+, and much of the control logic and
-parameters.
-
-+Model.all+ and +.count+ work as expected. +Model.find_each+ is also available.
-
-+belongs_to+ is now operational. The other side, +has_many+, is much simpler and should 
-follow very soon (probably today). 
+==== Restrictions
 
 Restrictions for +belongs_to+ tables: 
 * The hash key must be specified and must not be +:id+. 
 * The range key must not be specified at all.
 * +belongs_to+ can be specified only once in each class.
+* +belongs_to+ must be placed after the +dynamo_schema+ attribute block.
 
 These restrictions allow OceanDynamo to implement the +has_many+ / +belongs_to+ 
 relation in a very efficient and massively scalable way. 
 
+==== Implementation
+
 +belongs_to+ claims the range key and uses it to store its own UUID, which normally
 would be stored in the hash key attribute. Instead, the hash key attribute holds the
 UUID of the parent. We have thus reversed the roles of these two fields. As a result, 
 all children have their parent UUID as their hash key, and their own UUID in their 
 range key.
 
-This type of association is even more efficient than its ActiveRecord counterpart as
-it uses only the primary index of the child model for finds and scans in both directions
-of the +has_many+ / +belongs_to+ association.
+This type of relation is even more efficient than its ActiveRecord counterpart as
+it uses only the primary index of the child model in both directions of the
++has_many+ / +belongs_to+ association. No scans.
 
 Furthermore, since DynamoDB has powerful primary index searches involving substrings
 and matching, the fact that the range key is a string can be used to implement
@@ -149,24 +149,26 @@ which means that secondary indices won't be necessary for the vast majority of
 OceanDynamo use cases. This ultimately means reduced operational costs, as well as
 reduced complexity.
 
-+.has_belongs_to?+ returns true if the class has a belongs_to association.
-
-+.belongs_to_class returns the class of the belongs_to association, or false if none.
 
-+.find+ can now take an array arg.
+=== Current State
 
-+#hash_key+ and +#range_key+ readers added.
+OceanDynamo is fully usable as an ActiveModel and can be used by Rails
+controllers. OceanDynamo implements much of the infrastructure of ActiveRecord;
+for instance, +read_attribute+, +write_attribute+, and much of the control logic and
+parameters.
 
++belongs_to+ is now operational. The other side, +has_many+, is much simpler and should 
+follow very soon (probably today). 
 
 === Future milestones
 
-After the +has_many+ / +belongs_to+ association, the +has_and_belongs_to_many+ assocation
-will be implemented. 
+* After the +has_many+ / +belongs_to+ association, the +has_and_belongs_to_many+ assocation
+  will be implemented. 
 
-A generator to install the <tt>config/aws.yml</tt> file.
+* A generator to install the <tt>config/aws.yml</tt> file.
 
-OceanDynamo will use association proxies to achieve the same kind of
-interface as ActiveRecord, e.g.: <code>blog_entry.comments.build(body: "Cool!").save!</code>
+* OceanDynamo will use association proxies to achieve the same kind of
+  interface as ActiveRecord, e.g.: <code>blog_entry.comments.build(body: "Cool!").save!</code>
 
 
 === Current use

data/lib/ocean-dynamo/version.rb

@@ -1,3 +1,3 @@
 module OceanDynamo
-  VERSION = "0.3.12"
+  VERSION = "0.3.13"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ocean-dynamo
 version: !ruby/object:Gem::Version
-  version: 0.3.12
+  version: 0.3.13
 platform: ruby
 authors:
 - Peter Bengtson
@@ -144,15 +144,15 @@ description: "== OceanDynamo\n\nOceanDynamo is a massively scalable Amazon Dynam
   and support methods. Ocean-dynamo follows this pattern closely and\nis of course
   based on ActiveModel.\n\nThe attribute and persistence layer of OceanDynamo is modeled
   on that of ActiveRecord:\nthere's +save+, +save!+, +create+, +update+, +update!+,
-  +update_attributes+, +find_each+,\nand all the other methods you're used to. The
-  design goal is always to implement as much \nas possible of the ActiveRecord interface,
-  without sacrificing scalability. This makes the \ntask of switching from SQL to
-  no-SQL much easier.\n\nThanks to its structural similarity to ActiveRecord, OceanDynamo
-  works with FactoryGirl.\nTo facilitate testing, future versions will keep track
-  of and delete instances after tests.\n\nOceanDynamo uses primary indices to retrieve
-  related table items, \nwhich means it will scale without limits.\n\nSee also Ocean,
-  a Rails framework for creating highly scalable SOAs in the cloud, in which\nocean-dynamo
-  is used as a central component: http://wiki.oceanframework.net"
+  +update_attributes+, +find_each+,\n+destroy_all+, +delete_all+ and all the other
+  methods you're used to. The design goal \nis always to implement as much of the
+  ActiveRecord interface as possible, without \ncompromising scalability. This makes
+  the task of switching from SQL to no-SQL much easier.\n\nThanks to its structural
+  similarity to ActiveRecord, OceanDynamo works with FactoryGirl.\nTo facilitate testing,
+  future versions will keep track of and delete instances after tests.\n\nOceanDynamo
+  uses primary indices to retrieve related table items, \nwhich means it will scale
+  without limits.\n\nSee also Ocean, a Rails framework for creating highly scalable
+  SOAs in the cloud, in which\nocean-dynamo is used as a central component: http://wiki.oceanframework.net"
 email:
 - peter@peterbengtson.com
 executables: []