tiny_dyno 0.1.15 → 0.1.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c36f72ed6a7268d1dcb055c82ec8dcf92c87d88e
-  data.tar.gz: 357330a97dab4c2bc0fb145636e0001187febf58
+  metadata.gz: 9f6eb1c54e92c87fa263c8e6f0b771aa92c2ccb4
+  data.tar.gz: d0c96f8ac8c67684f30cf13480284194cec2f2de
 SHA512:
-  metadata.gz: 3b208b2b409cb4153e0b0fa4030d2d61660579ca643b716df65e443662a057650f2ce20b0738802b128eef7cb4f48c4e990bc3a5dae59bc189ef3bc66a8f9d71
-  data.tar.gz: 29286db01b34b9ad78ce1a2a21714646a407d23e851fd93d31caa481e68469f318c6a3d3c296313c0ae32bc93c3a5b6bcd1d14b0732a2fa25b3e6837d45f24bb
+  metadata.gz: e04e399d3bcd7b91c83279c72b55d0a6b4245e8ccc8fc4fe5239a16f191aac9722b80eaa11248e7276930873da570adef5b83a0915a7ed31bfd3f2b5d24ff213
+  data.tar.gz: e99ac9852f5a771203ec483218ac4675bb6028fd057ce665e52f84e7848b89f60507699494aadcde229f0a225cf9f7aaca36dc1859684f4b33e98d7fdeea62e2

data/CHANGES.md

@@ -1,3 +1,22 @@
+0.1.17 (2015-09-08)
+-------------------
+
+* Use simple_attributes: false by default and enforce/ coerce attributes to be of specified Class as per model
+
+0.1.16 (2015-09-04)
+
+* New - Add boolean field type support and introduce type checking on setting field values to assert correct type coercion, when setting values
+
+0.1.15 (2015-09-04)
+-------------------
+
+* New - add query proxy method, to support arbitrary queries to dynamodb
+
+0.1.14 (2015-08-31)
+-------------------
+
+* Fix - TinyDyno::Document.create now returns either the persisted document or nil
+
 0.1.13 (2015-07-06)
 -------------------
 

data/bin/tracer

@@ -13,7 +13,6 @@ class SmallPerson
 
 end
 
-require 'tracer'
-Tracer.on
 sm = SmallPerson.new(first_name: 'peter_parker')
-
+sm.age = '27'
+sm.age = 'foobar'

data/lib/config/locales/en.yml

@@ -159,6 +159,12 @@ en:
             since the child could potentially reference a nonexistant parent."
           resolution: "Make sure to only use create or create! when the parent
             document %{base} is persisted."
+        value_not_typecasted:
+          message: "Value %{value} is not the correct type in field %{name}"
+          summary: "You can not assign values of this type, to a field of type
+            %{name}"
+          resolution: "Only assign supported values to field %{name} or change
+            the field type."
         validations:
           message: "Validation of %{document} failed."
           summary: "The following errors were found: %{errors}"

data/lib/tiny_dyno/adapter/attributes.rb

@@ -0,0 +1,161 @@
+require 'bigdecimal'
+require 'stringio'
+require 'set'
+
+module TinyDyno
+  module Adapter
+
+    class AttributeValue
+    # utilize the same type coercions as in the ruby aws-sdk
+    # ( https://github.com/aws/aws-sdk-ruby/blob/master/aws-sdk-core/lib/aws-sdk-core/dynamodb/attribute_value.rb )
+    # however in a more deterministic fashion
+    # the type conversion employed by the simple attribute feature
+    # is purely based on the value field
+    # tiny_dyno enforces coercion into the designated target data type
+    # or raises an error on mismatch
+
+      def initialize
+        @marshaler = Marshaler.new
+        @unmarshaler = Unmarshaler.new
+      end
+
+      def marshal(type:, value:)
+        @marshaler.format(type: type, obj: value)
+      end
+
+      def unmarshal(value)
+        @unmarshaler.format(value)
+      end
+
+      class Marshaler
+
+        def format(type: 'auto', obj:)
+          type = obj.class.to_s if type == 'auto'
+          case type.to_s
+            when 'Hash'
+              obj.each.with_object(m:{}) do |(key, value), map|
+                map[:m][key.to_s] = format(type: value.class, obj: value)
+              end
+            when 'Array'
+              obj.each.with_object(l:[]) do |value, list|
+                list[:l] << format(type: value.class, obj: value)
+              end
+            when 'String'
+              if obj.nil?
+                { null: true }
+              else
+                { s: obj }
+              end
+            when 'Symbol' then { s: obj.to_s }
+            when 'Numeric', 'Fixnum', 'Float', 'Integer'
+              if obj.to_i != 0 and obj != '0'
+                { n: obj.to_s }
+              elsif obj.to_i === 0 and obj == '0'
+                { n: obj.to_s }
+              elsif obj.is_a?(Integer)
+                { n: obj.to_s }
+              elsif obj.nil?
+                { n: nil }
+              else
+                raise TinyDyno::Errors::InvalidValueType.new(klass: self.class, name: type, value: obj)
+              end
+            when 'StringIO', 'IO' then { b: obj }
+            when 'Set' then format_set(obj)
+            when 'TrueClass', 'FalseClass', 'TinyDyno::Boolean'
+              # ToDo, how can we initialize a boolean field into a valid state?
+              raise TinyDyno::Errors::InvalidValueType.new(klass: self.class, name: type, value: obj) unless [true,false,nil].include?(obj)
+              { bool: obj }
+            when 'NilClass' then { null: true }
+            else
+              msg = "unsupported type, expected Hash, Array, Set, String, Numeric, "
+              msg << "IO, true, false, or nil, got #{obj.class.name}"
+              raise ArgumentError, msg
+          end
+        end
+
+        private
+
+        def format_set(set)
+          case set.first
+            when String, Symbol then { ss: set.map(&:to_s) }
+            when Numeric then { ns: set.map(&:to_s) }
+            when StringIO, IO then { bs: set.to_a }
+            else
+              msg = "set types only support String, Numeric, or IO objects"
+              raise ArgumentError, msg
+          end
+        end
+
+      end
+
+      class Unmarshaler
+
+        def format(obj)
+          type, value = extract_type_and_value(obj)
+          case type
+            when :m
+              value.each.with_object({}) do |(k, v), map|
+                map[k] = format(v)
+              end
+            when :l then value.map { |v| format(v) }
+            when :s then value
+            when :n then BigDecimal.new(value)
+            when :b then StringIO.new(value)
+            when :null then nil
+            when :bool then value
+            when :ss then Set.new(value)
+            when :ns then Set.new(value.map { |n| BigDecimal.new(n) })
+            when :bs then Set.new(value.map { |b| StringIO.new(b) })
+            else
+              raise ArgumentError, "unhandled type #{type.inspect}"
+          end
+        end
+
+        private
+
+        def extract_type_and_value(obj)
+          case obj
+            when Hash then obj.to_a.first
+            when Struct
+              obj.members.each do |key|
+                value = obj[key]
+                return [key, value] unless value.nil?
+              end
+            else
+              raise ArgumentError, "unhandled type #{obj.inspect}"
+          end
+        end
+
+      end
+    end #class AttributeValue
+
+    extend self
+
+    def aws_attribute(field_type:, value:)
+      av = TinyDyno::Adapter::AttributeValue.new
+      av.marshal(type: field_type, value: value)
+    end
+
+    def doc_attribute(value)
+      av = TinyDyno::Adapter::AttributeValue.new
+      av.unmarshal(value)
+    end
+
+    def simple_attribute(field_type:, value:)
+      raw_attribute = aws_attribute(field_type: field_type, value: value)
+
+      case field_type.to_s
+        when 'Fixnum', 'Integer'
+          simple_value = doc_attribute(raw_attribute).to_i
+        when 'Float'
+          simple_value = doc_attribute(raw_attribute).to_f
+        when 'Numeric', 'String', 'Array', 'Hash', 'TinyDyno::Boolean' then
+          simple_value = doc_attribute(raw_attribute)
+      else
+        raise ArgumentError, "unhandled type #{ field_type.inspect }"
+      end
+      simple_value
+    end #simple_attribute
+
+  end
+end

data/lib/tiny_dyno/adapter/items.rb

@@ -13,7 +13,9 @@ module TinyDyno
     def get_item(get_item_request:)
       resp = connection.get_item(get_item_request)
       if resp.respond_to?(:item)
-        resp.item
+        typed_attributes = {}
+        resp.item.each {|k,v| typed_attributes[k] = TinyDyno::Adapter.doc_attribute(v) }
+        typed_attributes
       else
         nil
       end

data/lib/tiny_dyno/adapter.rb

@@ -2,6 +2,7 @@ require 'aws-sdk'
 
 require 'tiny_dyno/adapter/tables'
 require 'tiny_dyno/adapter/items'
+require 'tiny_dyno/adapter/attributes'
 
 module TinyDyno
 
@@ -42,7 +43,7 @@ module TinyDyno
     def connection
       unless @connection
         TinyDyno.logger.info 'setting up new connection ... ' if TinyDyno.logger
-        @connection =  Aws::DynamoDB::Client.new
+        @connection =  Aws::DynamoDB::Client.new(simple_attributes: false)
         update_table_cache
       end
       @connection

data/lib/tiny_dyno/attributes.rb

@@ -1,7 +1,8 @@
 require 'active_model/attribute_methods'
-
 require 'tiny_dyno/attributes/readonly'
 
+require 'pry'
+
 module TinyDyno
   module Attributes
 
@@ -115,10 +116,8 @@ module TinyDyno
     #
     # @since 1.0.0
     def typed_value_for(key, value)
-      # raise MissingAttributeError if fields[key].nil? and hash_keys.find_index { |a| a[:attr] == key }.nil?
       raise MissingAttributeError if fields[key].nil?
-      typed_class = self.fields[key].options[:type]
-      return (self.class.document_typed(klass: typed_class, value: value))
+      TinyDyno::Adapter.simple_attribute(field_type: self.fields[key].options[:type], value: value)
     end
 
     # Determine if the attribute is missing from the document, due to loading
@@ -136,22 +135,5 @@ module TinyDyno
       return (!self.fields.keys.include?(name))
     end
 
-    private
-
-
-    module ClassMethods
-
-      # convert to the type used on the Document
-      def document_typed(klass:, value: )
-        if klass == String
-          value.blank? ? nil : value.to_s
-        elsif (klass == Integer or klass == Fixnum )
-          value.to_i
-        else
-          value
-        end
-      end
-    end
-
   end
 end

data/lib/tiny_dyno/document_composition.rb

@@ -49,3 +49,4 @@ module TinyDyno
 
   end
 end
+

data/lib/tiny_dyno/errors/invalid_type_error.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+module TinyDyno
+  module Errors
+
+    # This error is raised, when a query is performed with fields specified
+    # that are not HashKeys, which would result in a table scan
+    class InvalidValueType < TinyDynoError
+
+      # Create the new error.
+      #
+      # @example Instantiate the error.
+      #   InvalidSelector.new(Person, "gender")
+      #
+      # @param [ Class ] klass The model class.
+      # @param [ String, Symbol ] name The name of the attribute.
+      #
+      # @since 3.0.0
+      def initialize(klass:, name:, value:)
+        super(
+            compose_message("value_not_typecasted", { klass: klass.name, name: name, value: value })
+        )
+      end
+    end
+  end
+end
+

data/lib/tiny_dyno/errors.rb

@@ -1,3 +1,4 @@
 require 'tiny_dyno/errors/tiny_dyno_error'
 require 'tiny_dyno/errors/attribute_errors'
-require 'tiny_dyno/errors/hash_key_errors'
+require 'tiny_dyno/errors/hash_key_errors'
+require 'tiny_dyno/errors/invalid_type_error'

data/lib/tiny_dyno/extensions/boolean.rb

@@ -0,0 +1,4 @@
+module ::TinyDyno::Boolean; end
+
+class TrueClass; include ::TinyDyno::Boolean; end
+class FalseClass; include ::TinyDyno::Boolean; end

data/lib/tiny_dyno/extensions/false_class.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+module TinyDyno
+  module Extensions
+    module FalseClass
+
+      # Is the passed value a boolean?
+      #
+      # @example Is the value a boolean type?
+      #   false.is_a?(Boolean)
+      #
+      # @param [ Class ] other The class to check.
+      #
+      # @return [ true, false ] If the other is a boolean.
+      #
+      # @since 1.0.0
+      def is_a?(other)
+        if other == ::TinyDyno::Boolean || other.class == ::TinyDyno::Boolean
+          return true
+        end
+        super(other)
+      end
+    end
+  end
+end
+
+::FalseClass.__send__(:include, TinyDyno::Extensions::FalseClass)

data/lib/tiny_dyno/extensions/true_class.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+module TinyDyno
+  module Extensions
+    module TrueClass
+
+      # Is the passed value a boolean?
+      #
+      # @example Is the value a boolean type?
+      #   true.is_a?(Boolean)
+      #
+      # @param [ Class ] other The class to check.
+      #
+      # @return [ true, false ] If the other is a boolean.
+      #
+      # @since 1.0.0
+      def is_a?(other)
+        if other == ::TinyDyno::Boolean || other.class == ::TinyDyno::Boolean
+          return true
+        end
+        super(other)
+      end
+    end
+  end
+end
+
+::TrueClass.__send__(:include, TinyDyno::Extensions::TrueClass)

data/lib/tiny_dyno/extensions.rb

@@ -1 +1,5 @@
-require 'tiny_dyno/extensions/module'
+require 'tiny_dyno/extensions/module'
+require 'tiny_dyno/extensions/boolean'
+require 'tiny_dyno/extensions/false_class'
+require 'tiny_dyno/extensions/true_class'
+

data/lib/tiny_dyno/fields/range_key.rb

@@ -26,10 +26,6 @@ module TinyDyno
         @type = options[:type]
       end
 
-      def as_selector
-        binding.pry
-      end
-
     end
   end
 end

data/lib/tiny_dyno/fields.rb

@@ -1,26 +1,11 @@
 require 'tiny_dyno/fields/standard'
 require 'tiny_dyno/fields/range_key'
+require 'tracer'
 
 module TinyDyno
   module Fields
     extend ActiveSupport::Concern
 
-    TYPE_MAPPINGS= {
-        # binary_blob: 'B',
-        # bool: Boolean,
-        # binary_set: Array,
-        list: Array,
-        map: Hash,
-        number: Integer,
-        number_set: Array,
-        # null: Null,
-        string: String,
-        string_set: Array,
-        time: Time,
-    }
-
-    SUPPORTED_FIELD_TYPES = [Array, Hash, Integer, Array, String, Time].freeze
-
     included do
       class_attribute :fields
 
@@ -249,6 +234,7 @@ module TinyDyno
           end
         end
       end
+
       # Create the setter method for the provided field.
       #
       # @example Create the setter.
@@ -260,8 +246,8 @@ module TinyDyno
       def create_field_setter(name, meth, field)
         generated_methods.module_eval do
           re_define_method("#{meth}=") do |value|
-            val = write_attribute(name, value)
-            val
+            typed_value = TinyDyno::Adapter.simple_attribute(field_type: field.options[:type], value: value)
+            write_attribute(name, typed_value)
           end
         end
       end

data/lib/tiny_dyno/hash_key.rb

@@ -15,7 +15,8 @@ module TinyDyno
     # for further use in DynamoDB queries, i.e. to look up an object
     #
     def hash_key_as_selector
-      { "#{ self.class.primary_key[:attr] }": attributes[self.class.primary_key[:attr]] }
+      key_field = self.class.primary_key[:attr]
+      { "#{ self.class.primary_key[:attr] }": TinyDyno::Adapter.aws_attribute(field_type: fields[key_field].options[:type], value: attributes[key_field]) }
     end
 
     module ClassMethods
@@ -94,8 +95,8 @@ module TinyDyno
       # convert values in queries to DynamoDB
       # into types as expected by DynamoDB
       def dyno_typed_key(key:, val:)
-        typed_class = self.fields[key].options[:type]
-        return (document_typed(klass: typed_class, value: val))
+        field_type = self.fields[key].options[:type]
+        return (TinyDyno::Adapter.aws_attribute(field_type: field_type, value: val))
       end
 
     end

data/lib/tiny_dyno/persistable.rb

@@ -50,7 +50,7 @@ module TinyDyno
 
     def build_item_request_entries
       item_entries = {}
-      attributes.each { |k,v| item_entries[k] = v }
+      attributes.each { |k,v| item_entries[k] = TinyDyno::Adapter.aws_attribute(field_type: fields[k].options[:type], value: v) }
       item_entries
     end
 

data/lib/tiny_dyno/version.rb

@@ -1,3 +1,3 @@
 module TinyDyno
-  VERSION = '0.1.15'
+  VERSION = '0.1.17'
 end

data/lib/tiny_dyno.rb

@@ -1,4 +1,5 @@
 require 'active_model'
+require 'active_support/core_ext/hash/indifferent_access'
 require 'aws-sdk'
 
 require 'tiny_dyno/extensions'

data/tiny_dyno.gemspec

@@ -34,8 +34,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'guard-rspec', '~> 4.5'
   spec.add_development_dependency 'fabrication', '~> 2.13'
   spec.add_development_dependency 'faker', '~> 1.4'
-  # spec.add_development_dependency 'awesome_print'
-  # spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'awesome_print'
+  spec.add_development_dependency 'pry'
 
   spec.add_dependency 'aws-sdk', '~> 2.1.2'
   spec.add_dependency 'activemodel', '~> 4.2.3'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tiny_dyno
 version: !ruby/object:Gem::Version
-  version: 0.1.15
+  version: 0.1.17
 platform: ruby
 authors:
 - Tobias Gerschner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-01 00:00:00.000000000 Z
+date: 2015-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,6 +122,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
@@ -175,6 +203,7 @@ files:
 - lib/config/locales/en.yml
 - lib/tiny_dyno.rb
 - lib/tiny_dyno/adapter.rb
+- lib/tiny_dyno/adapter/attributes.rb
 - lib/tiny_dyno/adapter/items.rb
 - lib/tiny_dyno/adapter/tables.rb
 - lib/tiny_dyno/attributes.rb
@@ -186,10 +215,14 @@ files:
 - lib/tiny_dyno/errors.rb
 - lib/tiny_dyno/errors/attribute_errors.rb
 - lib/tiny_dyno/errors/hash_key_errors.rb
+- lib/tiny_dyno/errors/invalid_type_error.rb
 - lib/tiny_dyno/errors/tiny_dyno_error.rb
 - lib/tiny_dyno/expected.rb
 - lib/tiny_dyno/extensions.rb
+- lib/tiny_dyno/extensions/boolean.rb
+- lib/tiny_dyno/extensions/false_class.rb
 - lib/tiny_dyno/extensions/module.rb
+- lib/tiny_dyno/extensions/true_class.rb
 - lib/tiny_dyno/fields.rb
 - lib/tiny_dyno/fields/range_key.rb
 - lib/tiny_dyno/fields/standard.rb