aws-record 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d74cea18f658e37fa6d0859826cbf76cb013a17
-  data.tar.gz: 8c624c68f54659a10c48231a70be86608254fe49
+  metadata.gz: 1183f72d5c4a9eb76cce79e3dc780651d33840a8
+  data.tar.gz: 9b003057c87a84aca97b35e1bbeb2c92f873cb53
 SHA512:
-  metadata.gz: b420c83918fc9306243df3e2b2f3cbb2226893763317bd84f97851c1cd9f7e34d1136929546417f627328ad275f4eb50e8621aa428ca49aa760e2d5e9a005b84
-  data.tar.gz: 1139b5b759c65e1b6387046ba0ad139cb695e438f1e8dc5cab7d343a74a0473f3e24da5b173cb9e5bfa227f3648401e276462a616a70a30bb4ff7830c91f572a
+  metadata.gz: 641f8d63bd27d4c77725cf09c67260e7ea46d11b1502778c180fdb356fd987ae4ded2267428f4466bcf8412aefcf57135a3ea56383fe017af076e67573af6daa
+  data.tar.gz: 6cd6d4756195610a012767c3f7a9b5a7818ab931a5c0b78ab47b8a895963a7378d90e38ee829f45399826e1648a7b78391b61d9be0fe70155933635625c3f0e6

data/lib/aws-record/record/dirty_tracking.rb

@@ -135,6 +135,70 @@ module Aws
         @data.dirty?
       end
 
+      # Returns +true+ if the model is not new and has not been deleted, +false+ otherwise.
+      #
+      # @example
+      #  class Model
+      #    include Aws::Record
+      #    integer_attr :id, hash_key: true
+      #    string_attr  :name
+      #  end
+      #
+      #  model = Model.new
+      #  model.persisted? # => false
+      #  model.save
+      #  model.persisted? # => true
+      #  model.delete!
+      #  model.persisted? # => false
+      #
+      # @return [Boolean] +true+ if the model is not new and has not been deleted, +false+ 
+      #  otherwise.
+      def persisted?
+        @data.persisted?
+      end
+
+      # Returns +true+ if the model is newly initialized, +false+ otherwise.
+      #
+      # @example
+      #  class Model
+      #    include Aws::Record
+      #    integer_attr :id, hash_key: true
+      #    string_attr  :name
+      #  end
+      #
+      #  model = Model.new
+      #  model.new_record? # => true
+      #  model.save
+      #  model.new_record? # => false
+      #
+      # @return [Boolean] +true+ if the model is newly initialized, +false+ 
+      #  otherwise.
+      def new_record?
+        @data.new_record?
+      end
+
+      # Returns +true+ if the model has been destroyed, +false+ otherwise.
+      #
+      # @example
+      #  class Model
+      #    include Aws::Record
+      #    integer_attr :id, hash_key: true
+      #    string_attr  :name
+      #  end
+      #
+      #  model = Model.new
+      #  model.destroyed? # => false
+      #  model.save
+      #  model.destroyed? # => false
+      #  model.delete! 
+      #  model.destroyed? # => true
+      #
+      # @return [Boolean] +true+ if the model has been destroyed, +false+ 
+      #  otherwise.
+      def destroyed?
+        @data.destroyed?
+      end
+
       # Fetches attributes for this instance of an item from Amazon DynamoDB 
       # using its primary key and the +find(*)+ class method.
       #

data/lib/aws-record/record/item_collection.rb

@@ -97,6 +97,7 @@ module Aws
             data.set_attribute(name, attr.extract(item))
           end
           data.clean!
+          data.new_record = false
           ret << record
         end
         ret

data/lib/aws-record/record/item_data.rb

@@ -23,8 +23,13 @@ module Aws
         @model_attributes = model_attributes
         @track_mutations = opts[:track_mutations]
         @track_mutations = true if opts[:track_mutations].nil?
+        @new_record = true
+        @destroyed = false
+
         populate_default_values
       end
+      
+      attr_accessor :new_record, :destroyed
 
       def get_attribute(name)
         @model_attributes.attribute_for(name).type_cast(@data[name])
@@ -34,6 +39,18 @@ module Aws
         @data[name] = value
       end
 
+      def new_record?
+        @new_record
+      end
+
+      def destroyed?
+        @destroyed
+      end
+
+      def persisted?
+        !(new_record? || destroyed?)
+      end
+
       def raw_value(name)
         @data[name]
       end

data/lib/aws-record/record/item_operations.rb

@@ -81,6 +81,109 @@ module Aws
         end
       end
 
+
+      # Deletes the item instance that matches the key values of this item
+      # instance in Amazon DynamoDB.
+      #
+      # @example Usage Example
+      #   class MyModel
+      #     include Aws::Record
+      #     integer_attr :uuid,   hash_key: true
+      #     string_attr  :name, range_key: true
+      #     integer_attr :age
+      #     float_attr   :height
+      #   end
+      #
+      #   model = MyModel.new(id: 4, name: "John", age: 4, height: 70.5)
+      #   model.age    # => 4
+      #   model.height # => 70.5
+      #   model.save
+      #   model.dirty? # => false  
+      # 
+      #   model.assign_attributes(age: 5, height: 150.75)
+      #   model.age    # => 5
+      #   model.height # => 150.75
+      #   model.dirty? # => true
+      #   
+      #
+      # @param [Hash] opts
+      def assign_attributes(opts)
+        opts.each do |field, new_value|
+          field = field.to_sym
+          setter = "#{field}="
+          raise ArgumentError.new "Invalid field: #{field} for model" unless respond_to?(setter)
+          public_send(setter, new_value)
+        end
+      end
+
+      # Mass assigns the attributes to the model and then performs a save
+      #
+      # You can use the +:force+ option to perform a simple put/overwrite
+      # without conditional validation or update logic.
+      #
+      # Note that aws-record allows you to change your model's key values,
+      # but this will be interpreted as persisting a new item to your DynamoDB
+      # table
+      #
+      # @example Usage Example
+      #   class MyModel
+      #     include Aws::Record
+      #     integer_attr :uuid,   hash_key: true
+      #     string_attr  :name, range_key: true
+      #     integer_attr :age
+      #     float_attr   :height
+      #   end
+      #
+      #   model = MyModel.new(id: 4, name: "John", age: 4, height: 70.5)
+      #   model.age    # => 4
+      #   model.height # => 70.5
+      #   model.save
+      #   model.dirty? # => false  
+      # 
+      #   model.update(age: 5, height: 150.75)
+      #   model.age    # => 5
+      #   model.height # => 150.75
+      #   model.dirty? # => false
+      #
+      # 
+      # @param [Hash] new_param, contains the new parameters for the model
+      #
+      # @param [Hash] opts
+      # @option opts [Boolean] :force if true, will save as a put operation and
+      #  overwrite any existing item on the remote end. Otherwise, and by
+      #  default, will either perform a conditional put or an update call.
+      # @return false if the record is invalid as defined by an attempt to call
+      #  +valid?+ on this item, if that method exists. Otherwise, returns client
+      #  call return value.
+      def update(new_params, opts = {})
+        assign_attributes(new_params)
+        save(opts)
+      end
+
+      # Updates model attributes and validates new values
+      #
+      # You can use the +:force+ option to perform a simple put/overwrite
+      # without conditional validation or update logic.
+      #
+      # Note that aws-record allows you to change your model's key values,
+      # but this will be interpreted as persisting a new item to your DynamoDB
+      # table
+      # 
+      # @param [Hash] new_param, contains the new parameters for the model
+      #
+      # @param [Hash] opts
+      # @option opts [Boolean] :force if true, will save as a put operation and
+      #  overwrite any existing item on the remote end. Otherwise, and by
+      #  default, will either perform a conditional put or an update call.
+      # @return The update mode if the update is successful
+      #
+      # @raise [Aws::Record::Errors::ValidationError] if any new values
+      #  violate the models validations.
+      def update!(new_params, opts = {})
+        assign_attributes(new_params)
+        save!(opts)
+      end
+
       # Deletes the item instance that matches the key values of this item
       # instance in Amazon DynamoDB. Uses the
       # {http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#delete_item-instance_method Aws::DynamoDB::Client#delete_item}
@@ -90,7 +193,7 @@ module Aws
           table_name: self.class.table_name,
           key: key_values
         )
-        true
+        self.instance_variable_get("@data").destroyed = true
       end
 
       private
@@ -151,6 +254,10 @@ module Aws
             )
           end
         end
+        data = self.instance_variable_get("@data")
+        data.destroyed = false
+        data.new_record = false
+        true
       end
 
       def _build_item_for_save
@@ -382,6 +489,7 @@ module Aws
           data = record.instance_variable_get("@data")
           attributes.attributes.each do |name, attr|
             data.set_attribute(name, attr.extract(resp.item))
+            data.new_record = false
           end
           record
         end

data/lib/aws-record/record/version.rb

@@ -13,6 +13,6 @@
 
 module Aws
   module Record
-    VERSION = '2.0.2'
+    VERSION = '2.1.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-record
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-08 00:00:00.000000000 Z
+date: 2018-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-dynamodb