ocean-dynamo 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38c9f3db161b07ef4486141afad09f05af00b752
-  data.tar.gz: 92a73810cedf7aceb64e31fde8582afd2e56fe18
+  metadata.gz: 8eaf6828f75761ed94d2acbfa5a28383b892c2d3
+  data.tar.gz: 9cc793dae4769417a4b87949f6c8a183679f6bc8
 SHA512:
-  metadata.gz: 0116191369abb7f9124034727ea50dc32995cfbebd55a4c030ded15a963c3f5fd7a1ed244ce85971606af4e329cf78f942b84a2d81e270af94bc4eddd135c3b1
-  data.tar.gz: 95861f8c29cd86c2018633549c21ce45b61adf65e8c2742496da04321ef6e2dd40447b8438c7d70ce36c40b35bcc87874bb65a50279ae835ef0f9a4d84b7cd5b
+  metadata.gz: ff59c0d44b7c45cdd07702f199b6816f1daedfa9998d0ffe8c6e75f8bff094c46ab55a144e81a57932d8775e758d0af0e378b922815959144294c715e53c3a40
+  data.tar.gz: ea2b09b9afa20d4a0cf0e6e6d0a7e51b739e0674dd06f9fbbf877a903c31a96e3311e00dad45578948b5a0c5601312f65ceb15539de33c73310a1c09f054a49c

data/README.rdoc

@@ -72,7 +72,22 @@ Sets are represented as arrays and may not contain duplicates and may not be emp
 All attributes except the :string type can take the value nil. Storing nil for a string
 value will return the empty string, "".
 
-Also, dynamo_schema takes args and many options. Detailed documentation is forthcoming.
+Also, dynamo_schema takes args and many options. Here's the full syntax:
+
+ dynamo_schema(
+   table_hash_key = :uuid, 
+   table_range_key = nil,
+   table_name: compute_table_name,
+   table_name_prefix: nil,
+   table_name_suffix: nil,
+   read_capacity_units: 10,
+   write_capacity_units: 5,
+   connect: :late,
+   create: false,
+   locking: :lock_version,
+   timestamps: [:created_at, :updated_at],
+   &block
+ )
 
 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;

data/lib/ocean-dynamo.rb

@@ -15,10 +15,4 @@ require "ocean-dynamo/persistence"
 
 module OceanDynamo
 
-  DEFAULT_ATTRIBUTES = [
-    [:created_at,   :datetime], 
-    [:updated_at,   :datetime],
-    [:lock_version, :integer, default: 0]
-  ]
-
 end

data/lib/ocean-dynamo/attributes.rb

@@ -16,9 +16,7 @@ module OceanDynamo
           write_attribute(name, evaluate_default(md[:default], md[:type]))
           self.class.class_eval "def #{name}; read_attribute('#{name.to_s}'); end"
           self.class.class_eval "def #{name}=(value); write_attribute('#{name.to_s}', value); end"
-          if fields[name][:type] == :boolean
-            self.class.class_eval "def #{name}?; read_attribute('#{name.to_s}'); end"
-          end
+          self.class.class_eval "def #{name}?; read_attribute('#{name.to_s}').present?; end"
         end
         @dynamo_item = nil
         @destroyed = false
@@ -91,9 +89,7 @@ module OceanDynamo
       #     raise ActiveModel::ForbiddenAttributesError
       #   end
       # end
-      values.each do |k, v|
-        _assign_attribute(k, v)
-      end
+      values.each { |k, v| _assign_attribute(k, v) }
     end
 
 
@@ -197,11 +193,11 @@ module OceanDynamo
 
     def _assign_attribute(k, v) # :nodoc:
       public_send("#{k}=", v)
-    rescue ActiveModel::NoMethodError
+    rescue NoMethodError
       if respond_to?("#{k}=")
         raise
       else
-        raise ActiveModel::UnknownAttributeError, "unknown attribute: #{k}"
+        raise UnknownAttributeError, "unknown attribute: #{k}"
       end
     end
 

data/lib/ocean-dynamo/base.rb

@@ -4,5 +4,35 @@ module OceanDynamo
     include ActiveModel::Model
     include ActiveModel::Validations::Callbacks
 
+    
+    def ==(comparison_object)
+      super ||
+        comparison_object.instance_of?(self.class) &&
+        id.present? &&
+        comparison_object.id == id
+    end
+    alias :eql? :==
+
+
+    # Clone and freeze the attributes hash such that associations are still
+    # accessible, even on destroyed records, but cloned models will not be
+    # frozen.
+    def freeze
+      @attributes = @attributes.clone.freeze
+      self
+    end
+
+    # Returns +true+ if the attributes hash has been frozen.
+    def frozen?
+      @attributes.frozen?
+    end
+
+    # Allows sort on objects
+    def <=>(other_object)
+      if other_object.is_a?(self.class)
+        self.to_key <=> other_object.to_key
+      end
+    end
+
   end
 end

data/lib/ocean-dynamo/class_variables.rb

@@ -43,5 +43,11 @@ module OceanDynamo
     class_attribute :table_create_policy, instance_writer: false
     self.table_create_policy = false
 
+    class_attribute :lock_attribute, instance_writer: false
+    self.lock_attribute = :lock_version
+
+    class_attribute :timestamp_attributes, instance_writer: false
+    self.timestamp_attributes = [:created_at, :updated_at]
+
   end
 end

data/lib/ocean-dynamo/persistence.rb

@@ -108,9 +108,7 @@ module OceanDynamo
           run_callbacks :create do
             k = read_attribute(table_hash_key)
             write_attribute(table_hash_key, SecureRandom.uuid) if k == "" || k == nil
-            t = Time.zone.now
-            self.created_at ||= t
-            self.updated_at ||= t
+            set_timestamps
             dynamo_persist
             true
           end
@@ -124,8 +122,8 @@ module OceanDynamo
       run_callbacks :commit do
         run_callbacks :save do
           run_callbacks :update do
-            self.updated_at = Time.zone.now
-            dynamo_persist
+            set_timestamps
+            dynamo_persist(lock: lock_attribute)
             true
           end
         end
@@ -148,12 +146,11 @@ module OceanDynamo
 
 
     def delete
-      _connect_late?
       if persisted?
-        @dynamo_item.delete
+        dynamo_delete(lock: lock_attribute)
       end
+      freeze
       @destroyed = true
-      #freeze
     end
 
 
@@ -167,17 +164,16 @@ module OceanDynamo
 
     def touch(name=nil)
       raise DynamoError, "can not touch on a new record object" unless persisted?
-      _connect_late?
+      _late_connect?
       run_callbacks :touch do
-        attrs = ['updated_at']
-        attrs << name if name
-        t = Time.zone.now
-        attrs.each { |k| write_attribute k, t }
-        # TODO: handle lock_version
-        dynamo_item.attributes.update do |u|
-          attrs.each do |k|
-            u.set(k => serialize_attribute(k, t))
+        begin
+          dynamo_item.attributes.update(_handle_locking) do |u|
+            set_timestamps(name).each do |k|
+              u.set(k => serialize_attribute(k, read_attribute(k)))
+            end
           end
+        rescue AWS::DynamoDB::Errors::ConditionalCheckFailedException
+          raise OceanDynamo::StaleObjectError
         end
         self
       end
@@ -187,7 +183,7 @@ module OceanDynamo
 
     protected
 
-    def self._connect_late?
+    def self._late_connect?
       return false if table_connected
       return false unless table_connect_policy
       establish_db_connection
@@ -195,8 +191,8 @@ module OceanDynamo
     end
 
 
-    def _connect_late?
-      self.class._connect_late?
+    def _late_connect?
+      self.class._late_connect?
     end
 
 
@@ -205,16 +201,33 @@ module OceanDynamo
     end
 
 
-    def dynamo_persist # :nodoc:
-      _connect_late?
-      @dynamo_item = dynamo_items.put(serialized_attributes)
+    def dynamo_persist(lock: nil) # :nodoc:
+      _late_connect?
+      begin
+        options = _handle_locking(lock)
+        @dynamo_item = dynamo_items.put(serialized_attributes, options)
+      rescue AWS::DynamoDB::Errors::ConditionalCheckFailedException
+        raise OceanDynamo::StaleObjectError
+      end
+
       @new_record = false
       true
     end
 
 
+    def dynamo_delete(lock: nil)
+      _late_connect?
+      begin
+        options = _handle_locking(lock)
+        @dynamo_item.delete(options)
+      rescue AWS::DynamoDB::Errors::ConditionalCheckFailedException
+        raise OceanDynamo::StaleObjectError
+      end
+    end
+
+
     def dynamo_unpersist(item, consistent) # :nodoc:
-      _connect_late?
+      _late_connect?
       @dynamo_item = item
       @new_record = false
       assign_attributes(_dynamo_read_attributes(consistent_read: consistent))
@@ -237,5 +250,34 @@ module OceanDynamo
     end
 
 
+    def set_timestamps(name=nil)
+      attrs = []
+      attrs << timestamp_attributes[0] if timestamp_attributes && new_record?
+      attrs << timestamp_attributes[1] if timestamp_attributes
+      attrs << name if name
+      _set_timestamp_attributes(attrs)
+      attrs
+    end
+
+
+    def _set_timestamp_attributes(attrs)
+      return if attrs.blank?
+      t = Time.zone.now
+      attrs.each { |a| write_attribute a, t }
+      t
+    end
+
+
+    def _handle_locking(lock=lock_attribute)
+      _late_connect?
+      if lock
+        current_v = read_attribute(lock)
+        write_attribute(lock, current_v+1) unless frozen?
+        {if: {lock => current_v}}
+      else
+        {}
+      end
+    end
+
   end
 end

data/lib/ocean-dynamo/queries.rb

@@ -2,15 +2,22 @@ module OceanDynamo
   class Base
 
     def self.find(hash, range=nil, consistent: false)
-      _connect_late?
+      _late_connect?
       item = dynamo_items[hash, range]
       raise RecordNotFound unless item.exists?
       new.send(:dynamo_unpersist, item, consistent)
     end
 
 
+    def self.find_by_key(*args)
+      find(*args)
+    rescue RecordNotFound
+      nil
+    end
+
+
     def self.count
-      _connect_late?
+      _late_connect?
       dynamo_table.item_count || -1    # The || -1 is for fake_dynamo specs.
     end
 

data/lib/ocean-dynamo/schema.rb

@@ -2,7 +2,8 @@ module OceanDynamo
   class Base
 
 
-    def self.dynamo_schema(table_hash_key=:uuid, table_range_key=nil,
+    def self.dynamo_schema(table_hash_key=:uuid, 
+                           table_range_key=nil,
                            table_name: compute_table_name,
                            table_name_prefix: nil,
                            table_name_suffix: nil,
@@ -10,6 +11,8 @@ module OceanDynamo
                            write_capacity_units: 5,
                            connect: :late,
                            create: false,
+                           locking: :lock_version,
+                           timestamps: [:created_at, :updated_at],
                            &block)
       # Set class vars
       self.dynamo_client = nil
@@ -25,10 +28,13 @@ module OceanDynamo
       self.table_name_suffix = table_name_suffix
       self.table_read_capacity_units = read_capacity_units
       self.table_write_capacity_units = write_capacity_units
+      self.lock_attribute = locking
+      self.timestamp_attributes = timestamps
       # Init
       self.fields = HashWithIndifferentAccess.new
       attribute table_hash_key, :string, default: ''
-      DEFAULT_ATTRIBUTES.each { |name, type, **pairs| attribute name, type, **pairs }
+      timestamp_attributes.each { |name| attribute name, :datetime } if timestamp_attributes
+      attribute lock_attribute, :integer, default: 0
       block.call
       # Connect to AWS
       establish_db_connection if connect == true

data/lib/ocean-dynamo/tables.rb

@@ -38,7 +38,6 @@ module OceanDynamo
         else
           raise UnknownTableStatus.new("Unknown DynamoDB table status '#{dynamo_table.status}'")
         end
-        sleep 1
       end
     end
 

data/lib/ocean-dynamo/version.rb

@@ -1,3 +1,3 @@
 module OceanDynamo
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ocean-dynamo
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Peter Bengtson