aws-record 1.0.0.pre.3 → 1.0.0.pre.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9169388f2bc16aa254c9c374304bedfdbf9257b9
-  data.tar.gz: b6e10a6ec3c737436eb9667f84ed4a5235dd33ab
+  metadata.gz: 102f5cb13fee3789030badc882c2d171ddb800e8
+  data.tar.gz: e4bad779188f59b940492fb2644636901826f41e
 SHA512:
-  metadata.gz: 868f158bd20470e096bd40258b5a88670a519637746b95314d0d05a4f9414e05adf631b10904cd99a637a46cd4ba933427f3ef8fd3368c9fbd0d0a8c03c87845
-  data.tar.gz: 72faa6654ba4a9b66c59b2c20778cbf1d00635e12ee4aef5b1a561d603613fbc49d817b3e2c48246ee41b15a3f51df2fc4074ea6ac5b3a3eaf6b876e1bc1403a
+  metadata.gz: a3ef6f71866145568e25d6cac31ebd31c33ad37bfa776ae648e4a0424f69e2e7c6fa46b8d22e5b0c5d5231f1fbde98d1460e5f83e88a812ea85dd4d87e3d3b68
+  data.tar.gz: 9cb2cf7a7644a0a6754c7e32452dbf5b83e422e6d7e94ca8a5c0442aa1532ac81ed47519bb00175a1a5e8107f193c1612a0a2ebd3df66a046763daa6c51378a5

data/lib/aws-record.rb

@@ -19,6 +19,7 @@ module Aws
   module Record
     autoload :Attribute,        'aws-record/record/attribute'
     autoload :Attributes,       'aws-record/record/attributes'
+    autoload :DirtyTracking,    'aws-record/record/dirty_tracking'
     autoload :Errors,           'aws-record/record/errors'
     autoload :ItemCollection,   'aws-record/record/item_collection'
     autoload :ItemOperations,   'aws-record/record/item_operations'

data/lib/aws-record/record.rb

@@ -26,6 +26,7 @@ module Aws
       sub_class.send(:extend, RecordClassMethods)
       sub_class.send(:include, Attributes)
       sub_class.send(:include, ItemOperations)
+      sub_class.send(:include, DirtyTracking)
       sub_class.send(:include, Query)
       sub_class.send(:include, SecondaryIndexes)
     end

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

@@ -33,6 +33,20 @@ module Aws
         @data.dup
       end
 
+      private
+
+      # @private
+      def read_attribute(name, attribute)
+        raw = @data[name]
+        attribute.type_cast(raw)
+      end
+
+      # @private
+      def write_attribute(name, attribute, value)
+        @data[name] = value
+      end
+        
+
       module ClassMethods
 
         # Define an attribute for your model, providing your own attribute type.
@@ -304,12 +318,11 @@ module Aws
         private
         def define_attr_methods(name, attribute)
           define_method(name) do
-            raw = @data[name]
-            attribute.type_cast(raw)
+            read_attribute(name, attribute)
           end
 
           define_method("#{name}=") do |value|
-            @data[name] = value
+            write_attribute(name, attribute, value)
           end
         end
 

data/lib/aws-record/record/attributes/date_marshaler.rb

@@ -29,17 +29,9 @@ module Aws
             when Date
               raw_value
             when Integer
-              begin
-                Date.parse(Time.at(raw_value).to_s) # assumed timestamp
-              rescue
-                nil
-              end
+              Date.parse(Time.at(raw_value).to_s) # assumed timestamp
             else
-              begin
-                Date.parse(raw_value.to_s) # Time, DateTime or String
-              rescue
-                nil
-              end
+              Date.parse(raw_value.to_s) # Time, DateTime or String
             end
           end
 

data/lib/aws-record/record/attributes/date_time_marshaler.rb

@@ -29,17 +29,9 @@ module Aws
             when DateTime
               raw_value
             when Integer
-              begin
-                DateTime.parse(Time.at(raw_value).to_s) # timestamp
-              rescue
-                nil
-              end
+              DateTime.parse(Time.at(raw_value).to_s) # timestamp
             else
-              begin
-                DateTime.parse(raw_value.to_s) # Time, Date or String
-              rescue
-                nil
-              end
+              DateTime.parse(raw_value.to_s) # Time, Date or String
             end
           end
 

data/lib/aws-record/record/attributes/float_marshaler.rb

@@ -40,7 +40,7 @@ module Aws
             elsif float.is_a?(Float)
               float
             else
-              msg = "expected a Float value or nil, got #{value.class}"
+              msg = "expected a Float value or nil, got #{float.class}"
               raise ArgumentError, msg
             end
           end

data/lib/aws-record/record/attributes/integer_marshaler.rb

@@ -40,7 +40,7 @@ module Aws
             elsif integer.is_a?(Integer)
               integer
             else
-              msg = "expected an Integer value or nil, got #{value.class}"
+              msg = "expected an Integer value or nil, got #{integer.class}"
               raise ArgumentError, msg
             end
           end

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

@@ -0,0 +1,302 @@
+# Copyright 2015-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You may not
+# use this file except in compliance with the License. A copy of the License is
+# located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is distributed on
+# an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+# or implied. See the License for the specific language governing permissions
+# and limitations under the License.
+
+module Aws
+  module Record
+    module DirtyTracking
+
+      def self.included(sub_class)
+        sub_class.extend(DirtyTrackingClassMethods)
+      end
+
+      # @private
+      #
+      # @override initialize(*)
+      def initialize(*)
+        super.tap { @dirty_data = {} }
+      end
+
+      # Returns +true+ if the specified attribute has any dirty changes, +false+ otherwise.
+      #
+      # @example
+      #  class Model
+      #    include Aws::Record
+      #    integer_attr :id, hash_key: true
+      #    string_attr  :name
+      #  end
+      #
+      #  model.name_dirty? # => false
+      #  model.name     # => 'Alex'
+      #  model.name = 'Nick'
+      #  model.name_dirty? # => true
+      #
+      # @param [String, Symbol] name The name of the attribute to to check for dirty changes.
+      # @return [Boolean] +true+ if the specified attribute has any dirty changes, +false+ otherwise.
+      def attribute_dirty?(name)
+        @dirty_data.has_key?(name)
+      end 
+
+      # Returns the original value of the specified attribute.
+      #
+      # @example
+      #  class Model
+      #    include Aws::Record
+      #    integer_attr :id,   hash_key: true
+      #    string_attr  :name
+      #  end
+      #
+      #  model.name         # => 'Alex'
+      #  model.name = 'Nick'
+      #  model.name_was     # => 'Alex'   
+      #
+      # @param [String, Symbol] name The name of the attribute to retrieve the original value of.
+      # @return [Object] The original value of the specified attribute.
+      def attribute_was(name)
+        attribute_dirty?(name) ? @dirty_data[name] : @data[name]
+      end
+
+      # Mark that an attribute is changing. This is useful in situations where it is necessary to track that the value of an 
+      # attribute is changing in-place. 
+      #
+      # @example
+      #  class Model
+      #    include Aws::Record
+      #    integer_attr :id,   hash_key: true
+      #    string_attr  :name
+      #  end
+      #
+      #  model.name        # => 'Alex'
+      #  model.name_dirty? # => false
+      #  model.name_was    # => 'Alex'
+      #
+      #  model.name << 'i'
+      #  model.name        # => 'Alexi'
+      # 
+      #  # The change was made in place. Since the String instance representing 
+      #  # the value of name is the same as it was originally, the change is not 
+      #  # detected.
+      #  model.name_dirty? # => false
+      #  model.name_was    # => 'Alexi'
+      #
+      #  model.name_dirty!
+      #  model.name_dirty? # => true
+      #  model.name_was    # => 'Alexi'
+      #
+      #  model.name << 's'
+      #  model.name        # => 'Alexis'
+      #  model.name_dirty? # => true
+      #  model.name_was    # => 'Alexi'
+      #
+      # @param [String, Symbol] name The name of the attribute to mark as 
+      #  changing.
+      def attribute_dirty!(name)
+        return if attribute_dirty?(name)
+
+        current_value = @data[name]
+
+        @dirty_data[name] = 
+          begin
+            current_value.clone
+          rescue TypeError
+            current_value
+          end
+      end
+
+      # Marks the changes as applied by clearing the current changes and making 
+      # them accessible through +previous_changes+.
+      #
+      # # @example
+      #  class Model
+      #    include Aws::Record
+      #    integer_attr :id, hash_key: true
+      #    string_attr  :name
+      #  end
+      #
+      #  model.name   # => 'Alex'
+      #  model.name = 'Nick'
+      #  model.dirty? # => true
+      #
+      #  model.clean!
+      #  model.dirty? # false
+      #
+      def clean!
+        @dirty_data.clear
+      end
+
+      # Returns an array with the name of the attributes with dirty changes.
+      #
+      # @example
+      #  class Model
+      #    include Aws::Record
+      #    integer_attr :id, hash_key: true
+      #    string_attr  :name
+      #  end
+      #
+      #  model.dirty # => []
+      #  model.name  # => 'Alex'
+      #  model.name = 'Nick'
+      #  model.dirty # => ['name']
+      #
+      # @return [Array] The names of attributes with dirty changes.
+      def dirty
+        @dirty_data.keys
+      end
+
+      # Returns +true+ if any attributes have dirty changes, +false+ otherwise.
+      #
+      # @example
+      #  class Model
+      #    include Aws::Record
+      #    integer_attr :id, hash_key: true
+      #    string_attr  :name
+      #  end
+      #
+      #  model.dirty? # => false
+      #  model.name   # => 'Alex'
+      #  model.name = 'Nick'
+      #  model.dirty? # => true
+      #
+      # @return [Boolean] +true+ if any attributes have dirty changes, +false+ 
+      #  otherwise.
+      def dirty?
+        @dirty_data.size > 0
+      end
+
+      # Fetches attributes for this instance of an item from Amazon DynamoDB 
+      # using its primary key and the +find(*)+ class method.
+      #
+      # @raise [Aws::Record::Errors::NotFound] if no record exists in the 
+      #  database matching the primary key of the item instance.
+      # 
+      # @return [self] Returns the item instance.
+      def reload!
+        primary_key = self.class.keys.values.inject({}) do |memo, key| 
+          memo[key] = send(key)
+          memo 
+        end
+
+        record = self.class.find(primary_key)
+
+        unless record.nil? 
+          @data = record.instance_variable_get("@data")
+        else
+          raise Errors::NotFound.new("No record found")
+        end
+
+        clean!
+
+        self
+      end
+
+      # Restores the attribute specified to its original value.
+      #
+      # @example
+      #  class Model
+      #    include Aws::Record
+      #    integer_attr :id, hash_key: true
+      #    string_attr  :name
+      #  end
+      #
+      #  model.name # => 'Alex'
+      #  model.name = 'Nick'
+      #  model.rollback_attribute!(:name)
+      #  model.name # => 'Alex'
+      #
+      # @param [String, Symbol] name The name of the attribute to restore
+      def rollback_attribute!(name)
+        return unless attribute_dirty?(name)
+
+        @data[name] = @dirty_data.delete(name)
+      end
+
+      # Restores all attributes to their original values.
+      #
+      # @example
+      #  class Model
+      #    include Aws::Record
+      #    integer_attr :id, hash_key: true
+      #    string_attr  :name
+      #  end
+      #
+      #  model.name # => 'Alex'
+      #  model.name = 'Nick'
+      #  model.rollback!
+      #  model.name # => 'Alex'
+      #
+      # @param [Array, String, Symbol] names The names of attributes to restore. 
+      def rollback!(names = dirty)
+        Array(names).each { |name| rollback_attribute!(name) }
+      end
+
+      # @private
+      #
+      # @override save(*)
+      def save(*)
+        super.tap { clean! }
+      end
+
+      private 
+      
+      # @private
+      #
+      # @override write_attribute(*)
+      def write_attribute(name, attribute, value)
+        if value == attribute_was(name)
+          @dirty_data.delete(name)
+        else
+          attribute_dirty!(name)
+        end
+
+        super
+      end
+
+
+      module DirtyTrackingClassMethods
+
+        private
+
+        # @private
+        #
+        # @override build_item_from_resp(*)
+        def build_item_from_resp(*)
+          super.tap { |item| item.clean! }
+        end
+
+        # @private
+        #
+        # @override define_attr_methods(*)
+        def define_attr_methods(name, attribute)
+          super.tap do 
+            define_method("#{name}_dirty?") do 
+              attribute_dirty?(name)
+            end
+
+            define_method("#{name}_dirty!") do 
+              attribute_dirty!(name)
+            end
+
+            define_method("#{name}_was") do 
+              attribute_was(name)
+            end
+
+            define_method("rollback_#{name}!") do 
+              rollback_attribute!(name)
+            end
+          end
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -18,6 +18,7 @@ module Aws
       class KeyMissing < RuntimeError; end
       class NameCollision < RuntimeError; end
       class ReservedName < RuntimeError; end
+      class NotFound < RuntimeError; end
       class InvalidModel < RuntimeError; end
       class TableDoesNotExist < RuntimeError; end
 

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

@@ -13,6 +13,6 @@
 
 module Aws
   module Record
-    VERSION = "1.0.0.pre.3"
+    VERSION = "1.0.0.pre.4"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-record
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.3
+  version: 1.0.0.pre.4
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-10 00:00:00.000000000 Z
+date: 2016-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-resources
@@ -45,6 +45,7 @@ files:
 - lib/aws-record/record/attributes/numeric_set_marshaler.rb
 - lib/aws-record/record/attributes/string_marshaler.rb
 - lib/aws-record/record/attributes/string_set_marshaler.rb
+- lib/aws-record/record/dirty_tracking.rb
 - lib/aws-record/record/errors.rb
 - lib/aws-record/record/item_collection.rb
 - lib/aws-record/record/item_operations.rb