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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f411d61078b7eeb8fbd7081d51c3f41b1c9116ca
-  data.tar.gz: 073b4953897897aba7298b5ba90e8050a015fcde
+  metadata.gz: 9169388f2bc16aa254c9c374304bedfdbf9257b9
+  data.tar.gz: b6e10a6ec3c737436eb9667f84ed4a5235dd33ab
 SHA512:
-  metadata.gz: ba35bcbfadff82862f5170c428d213c23157307c07ef9325263d877596cb2c32e0a9b65ee150e7492538b67f422c90d3f8112b5d51def09508e55c974ae6944f
-  data.tar.gz: 9301a70e55fae642dd83c814720ab78543dae3ec12e1c806df096326009308dce7fbb2666a1a8610cd18c69418be9e70d93649b1d2780b42523fb9361c7e04a6
+  metadata.gz: 868f158bd20470e096bd40258b5a88670a519637746b95314d0d05a4f9414e05adf631b10904cd99a637a46cd4ba933427f3ef8fd3368c9fbd0d0a8c03c87845
+  data.tar.gz: 72faa6654ba4a9b66c59b2c20778cbf1d00635e12ee4aef5b1a561d603613fbc49d817b3e2c48246ee41b15a3f51df2fc4074ea6ac5b3a3eaf6b876e1bc1403a

data/lib/aws-record.rb

@@ -28,12 +28,16 @@ module Aws
     autoload :VERSION,          'aws-record/record/version'
 
     module Attributes
-      autoload :StringMarshaler,   'aws-record/record/attributes/string_marshaler'
-      autoload :BooleanMarshaler,  'aws-record/record/attributes/boolean_marshaler'
-      autoload :IntegerMarshaler,  'aws-record/record/attributes/integer_marshaler'
-      autoload :FloatMarshaler,    'aws-record/record/attributes/float_marshaler'
-      autoload :DateMarshaler,     'aws-record/record/attributes/date_marshaler'
-      autoload :DateTimeMarshaler, 'aws-record/record/attributes/date_time_marshaler'
+      autoload :StringMarshaler,    'aws-record/record/attributes/string_marshaler'
+      autoload :BooleanMarshaler,   'aws-record/record/attributes/boolean_marshaler'
+      autoload :IntegerMarshaler,   'aws-record/record/attributes/integer_marshaler'
+      autoload :FloatMarshaler,     'aws-record/record/attributes/float_marshaler'
+      autoload :DateMarshaler,      'aws-record/record/attributes/date_marshaler'
+      autoload :DateTimeMarshaler,  'aws-record/record/attributes/date_time_marshaler'
+      autoload :ListMarshaler,      'aws-record/record/attributes/list_marshaler'
+      autoload :MapMarshaler,       'aws-record/record/attributes/map_marshaler'
+      autoload :StringSetMarshaler, 'aws-record/record/attributes/string_set_marshaler'
+      autoload :NumericSetMarshaler, 'aws-record/record/attributes/numeric_set_marshaler'
     end
 
   end

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

@@ -161,6 +161,120 @@ module Aws
           attr(name, Attributes::DateTimeMarshaler, opts)
         end
 
+        # Define a list-type attribute for your model.
+        #
+        # Lists do not have to be homogeneous, but they do have to be types that
+        # the AWS SDK for Ruby V2's DynamoDB client knows how to marshal and
+        # unmarshal. Those types are:
+        #
+        # * Hash
+        # * Array
+        # * String
+        # * Numeric
+        # * Boolean
+        # * IO
+        # * Set
+        # * nil
+        #
+        # Also note that, since lists are heterogeneous, you may lose some
+        # precision when marshaling and unmarshaling. For example, symbols will
+        # be stringified, but there is no way to return those strings to symbols
+        # when the object is read back from DynamoDB.
+        #
+        # @param [Symbol] name Name of this attribute.  It should be a name that
+        #   is safe to use as a method.
+        # @param [Hash] opts
+        # @option opts [Boolean] :nil_as_empty_list Set to true if this
+        #   attribute should interpret nil values as an empty list. If false,
+        #   nil values will remain nil.
+        # @option opts [Boolean] :hash_key Set to true if this attribute is
+        #   the hash key for the table.
+        # @option opts [Boolean] :range_key Set to true if this attribute is
+        #   the range key for the table.
+        def list_attr(name, opts = {})
+          opts[:dynamodb_type] = "L"
+          attr(name, Attributes::ListMarshaler, opts)
+        end
+
+        # Define a map-type attribute for your model.
+        #
+        # Maps do not have to be homogeneous, but they do have to use types that
+        # the AWS SDK for Ruby V2's DynamoDB client knows how to marshal and
+        # unmarshal. Those types are:
+        #
+        # * Hash
+        # * Array
+        # * String
+        # * Numeric
+        # * Boolean
+        # * IO
+        # * Set
+        # * nil
+        #
+        # Also note that, since maps are heterogeneous, you may lose some
+        # precision when marshaling and unmarshaling. For example, symbols will
+        # be stringified, but there is no way to return those strings to symbols
+        # when the object is read back from DynamoDB.
+        #
+        # @param [Symbol] name Name of this attribute.  It should be a name that
+        #   is safe to use as a method.
+        # @param [Hash] opts
+        # @option opts [Boolean] :nil_as_empty_map Set to true if this
+        #   attribute should interpret nil values as an empty hash. If false,
+        #   nil values will remain nil.
+        # @option opts [Boolean] :hash_key Set to true if this attribute is
+        #   the hash key for the table.
+        # @option opts [Boolean] :range_key Set to true if this attribute is
+        #   the range key for the table.
+        def map_attr(name, opts = {})
+          opts[:dynamodb_type] = "M"
+          attr(name, Attributes::MapMarshaler, opts)
+        end
+
+        # Define a string set attribute for your model.
+        #
+        # String sets are homogeneous sets, containing only strings. Note that
+        # empty sets cannot be persisted to DynamoDB. Empty sets are valid for
+        # aws-record items, but they will not be persisted as sets. nil values
+        # from your table, or a lack of value from your table, will be treated
+        # as an empty set for item instances. At persistence time, the marshaler
+        # will attempt to marshal any non-strings within the set to be String
+        # objects.
+        #
+        # @param [Symbol] name Name of this attribute.  It should be a name that
+        #   is safe to use as a method.
+        # @param [Hash] opts
+        # @option opts [Boolean] :hash_key Set to true if this attribute is
+        #   the hash key for the table.
+        # @option opts [Boolean] :range_key Set to true if this attribute is
+        #   the range key for the table.
+        def string_set_attr(name, opts = {})
+          opts[:dynamodb_type] = "SS"
+          attr(name, Attributes::StringSetMarshaler, opts)
+        end
+
+        # Define a numeric set attribute for your model.
+        #
+        # Numeric sets are homogeneous sets, containing only strings. Note that
+        # empty sets cannot be persisted to DynamoDB. Empty sets are valid for
+        # aws-record items, but they will not be persisted as sets. nil values
+        # from your table, or a lack of value from your table, will be treated
+        # as an empty set for item instances. At persistence time, the marshaler
+        # will attempt to marshal any non-numerics within the set to be Numeric
+        # objects.
+        #
+        # @param [Symbol] name Name of this attribute.  It should be a name that
+        #   is safe to use as a method.
+        # @param [Hash] opts
+        # @option opts [Boolean] :hash_key Set to true if this attribute is
+        #   the hash key for the table.
+        # @option opts [Boolean] :range_key Set to true if this attribute is
+        #   the range key for the table.
+        def string_set_attr(name, opts = {})
+          opts[:dynamodb_type] = "NS"
+          attr(name, Attributes::NumericSetMarshaler, opts)
+        end
+
         # @return [Hash] hash of symbolized attribute names to attribute objects
         def attributes
           @attributes

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

@@ -0,0 +1,66 @@
+# 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 Attributes
+      module ListMarshaler
+
+        class << self
+
+          def type_cast(raw_value, options = {})
+            case raw_value
+            when nil
+              _cast_nil(raw_value, options)
+            when ''
+              _cast_nil(raw_value, options)
+            when Array
+              raw_value
+            else
+              if raw_value.respond_to?(:to_a)
+                raw_value.to_a
+              else
+                msg = "Don't know how to make #{raw_value} of type"\
+                  " #{raw_value.class} into an array!"
+                raise ArgumentError, msg
+              end
+            end
+          end
+
+          def serialize(raw_value, options = {})
+            list = type_cast(raw_value, options)
+            if list.is_a?(Array)
+              list
+            elsif list.nil?
+              nil
+            else
+              msg = "expected an Array value or nil, got #{list.class}"
+              raise ArgumentError, msg
+            end
+          end
+
+          private
+          def _cast_nil(raw_value, options)
+            if options[:nil_as_empty_list]
+              []
+            else
+              nil
+            end
+          end
+
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+# 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 Attributes
+      module MapMarshaler
+
+        class << self
+
+          def type_cast(raw_value, options = {})
+            case raw_value
+            when nil
+              _cast_nil(raw_value, options)
+            when ''
+              _cast_nil(raw_value, options)
+            when Hash
+              raw_value
+            else
+              if raw_value.respond_to?(:to_h)
+                raw_value.to_h
+              else
+                msg = "Don't know how to make #{raw_value} of type"\
+                  " #{raw_value.class} into a hash!"
+                raise ArgumentError, msg
+              end
+            end
+          end
+
+          def serialize(raw_value, options = {})
+            map = type_cast(raw_value, options)
+            if map.is_a?(Hash)
+              map
+            elsif map.nil?
+              nil
+            else
+              msg = "expected a Hash value or nil, got #{map.class}"
+              raise ArgumentError, msg
+            end
+          end
+
+          private
+          def _cast_nil(raw_value, options)
+            if options[:nil_as_empty_map]
+              {}
+            else
+              nil
+            end
+          end
+
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+# 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.
+
+require 'bigdecimal'
+
+module Aws
+  module Record
+    module Attributes
+      module NumericSetMarshaler
+
+        class << self
+
+          def type_cast(raw_value, options = {})
+            case raw_value
+            when nil
+              Set.new
+            when ''
+              Set.new
+            when Set
+              _as_numeric(raw_value)
+            else
+              msg = "Don't know how to make #{raw_value} of type"\
+                " #{raw_value.class} into a Numeric Set!"
+              raise ArgumentError, msg
+            end
+          end
+
+          def serialize(raw_value, options = {})
+            set = type_cast(raw_value, options)
+            if set.is_a?(Set)
+              if set.empty?
+                nil
+              else
+                set
+              end
+            else
+              msg = "expected a Set value or nil, got #{set.class}"
+              raise ArgumentError, msg
+            end
+          end
+
+          private
+          def _as_numeric(set)
+            set.collect! do |item|
+              if item.is_a?(Numeric)
+                item
+              else
+                BigDecimal.new(item.to_s)
+              end
+            end
+          end
+
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+# 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 Attributes
+      module StringSetMarshaler
+
+        class << self
+
+          def type_cast(raw_value, options = {})
+            case raw_value
+            when nil
+              Set.new
+            when ''
+              Set.new
+            when Set
+              _as_strings(raw_value)
+            else
+              msg = "Don't know how to make #{raw_value} of type"\
+                " #{raw_value.class} into a String Set!"
+              raise ArgumentError, msg
+            end
+          end
+
+          def serialize(raw_value, options = {})
+            set = type_cast(raw_value, options)
+            if set.is_a?(Set)
+              if set.empty?
+                nil
+              else
+                set
+              end
+            else
+              msg = "expected a Set value or nil, got #{set.class}"
+              raise ArgumentError, msg
+            end
+          end
+
+          private
+          def _as_strings(set)
+            set.collect! do |item|
+              if item.is_a?(String)
+                item
+              else
+                item.to_s
+              end
+            end
+          end
+
+        end
+
+      end
+    end
+  end
+end

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-record
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.2
+  version: 1.0.0.pre.3
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-04 00:00:00.000000000 Z
+date: 2016-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-resources
@@ -40,7 +40,11 @@ files:
 - lib/aws-record/record/attributes/date_time_marshaler.rb
 - lib/aws-record/record/attributes/float_marshaler.rb
 - lib/aws-record/record/attributes/integer_marshaler.rb
+- lib/aws-record/record/attributes/list_marshaler.rb
+- lib/aws-record/record/attributes/map_marshaler.rb
+- 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/errors.rb
 - lib/aws-record/record/item_collection.rb
 - lib/aws-record/record/item_operations.rb