tiny_dyno 0.1.11 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dad49629c87d23c41034877a01393def956c568e
-  data.tar.gz: 0e6ceca28ce34d7c53a8ed3ad4e9c75b531d8036
+  metadata.gz: 042ea3b53fd10c8a3a6b8ab228d568e501b1b843
+  data.tar.gz: 5222389a219e25dc9a40b88a6ed748e54fb381d3
 SHA512:
-  metadata.gz: 2b0ceaaf98b68e1f216f93099aa5ee8749145a561b7e729bc92be64668894cc6fee883f6cfd7d28ca232941e0059e28f583cec51dc1cbda3d61cadbb37694527
-  data.tar.gz: 47f32b1f3d66bc0128b505a5a64c6f971987a16490489bd9abef230e9689e6d4d1c0d6d3b796c8ff474c0f9c93c010197b0b2dfa4f73abbe3bb17f93d14d71b1
+  metadata.gz: 051dabb980854bc99bcb736ea43bea31df12c0eecdbf5e848c5e40f1a20e5bc6b8338e4239b218552597fb0929bfd1c1e427850e6ca1495d9315e45f77df47e5
+  data.tar.gz: 7df845254448752c5eb6c16ea6d1ed7fa954adc55b2dbe69e11fba1b5f47f024d01508cf6b5277b2fc1a871c297cb9ddeb240462be3d06de5b94ec7b64c74ad7

data/CHANGES.md

@@ -1,3 +1,8 @@
+0.1.12 (2015-07-04)
+-------------------
+
+* New - simple range_key support
+
 0.1.11 (2015-07-04)
 -------------------
 

data/README.md

@@ -81,18 +81,32 @@ Or install it yourself as:
 
 ## Usage
 
+It is highly recommended to work through the specs and also the fabricators and models in the spec folder to see example implementations.
+
 ```
 
+require 'securerandom'
 require 'tiny_dyno'
 
-class Person
+
+class Account
   include TinyDyno::Document
 
-  hash_key :id, type: Integer
+  hash_key :id, type: String
+
+  field :email, type: String, range_key: true
+  field :label, type: String
+
+  validates_presence_of :id, :email, :label
+
+  def initialize(attrs = nil)
+    super
+    set_id if id.nil?
+  end
 
-  field :first_name, type: String
-  field :last_name, type: String
-  field :age, type: Integer
+  def set_id
+    self.id ||= SecureRandom.uuid
+  end
 
 end
 

data/lib/tiny_dyno/document.rb

@@ -53,8 +53,9 @@ module TinyDyno
 
     module ClassMethods
 
+      # TODO, extract into its own class to allow better testing
       def where(options = {})
-        valid_option_keys(options)
+        validate_option_keys(options)
         get_query = build_where_query(options)
         attributes = TinyDyno::Adapter.get_item(get_item_request: get_query)
         if attributes.nil?
@@ -67,16 +68,21 @@ module TinyDyno
         end
       end
 
+
       private
 
       # minimimum implementation for now
       # check that each option key relates to a hash_key present on the model
       # do not permit scan queries
-      def valid_option_keys(options)
+      def validate_option_keys(options)
         raise TinyDyno::Errors::HashKeyOnly.new(klass: self.class, name: 'primary_key') if primary_key.nil?
-        # options.keys.each do |name|
-        #   named = name.to_s
-        # end
+        options.keys.each do |key|
+          raise TinyDyno::Errors::InvalidSelector.new(klass: self.class, name: key) unless valid_field_selector?(field_name: key.to_s)
+        end
+      end
+
+      def valid_field_selector?(field_name:)
+        key_schema.map {|k| k[:attribute_name] }.include?(field_name)
       end
 
       # minimimum implementation for now

data/lib/tiny_dyno/errors/hash_key_errors.rb

@@ -102,3 +102,30 @@ module TinyDyno
   end
 end
 
+
+# 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 InvalidSelector < 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:)
+        super(
+            compose_message("look up only by key fields", { klass: klass.name, name: name })
+        )
+      end
+    end
+  end
+end
+

data/lib/tiny_dyno/fields/range_key.rb

@@ -0,0 +1,35 @@
+module TinyDyno
+  module Fields
+    class RangeKey
+
+      # Defines the behaviour for defined fields in the document.
+      # Set readers for the instance variables.
+      attr_accessor :default_val, :label, :name, :options
+
+      # Create the new field with a name and optional additional options.
+      #
+      # @example Create the new field.
+      #   Field.new(:name, :type => String)
+      #
+      # @param [ Hash ] options The field options.
+      #
+      # @option options [ Class ] :type The class of the field.
+      # @option options [ Object ] :default The default value for the field.
+      # @option options [ String ] :label The field's label.
+      #
+      # @since 3.0.0
+      def initialize(name, options = {})
+        @name = name
+        @options = options
+        @label = options[:label]
+        @default_val = options[:default]
+        @type = options[:type]
+      end
+
+      def as_selector
+        binding.pry
+      end
+
+    end
+  end
+end

data/lib/tiny_dyno/fields.rb

@@ -1,4 +1,5 @@
 require 'tiny_dyno/fields/standard'
+require 'tiny_dyno/fields/range_key'
 
 module TinyDyno
   module Fields
@@ -166,7 +167,6 @@ module TinyDyno
       # @param [ Field ] field the field to process
       def process_options(field)
         field_options = field.options
-
         Fields.options.each_pair do |option_name, handler|
           if field_options.key?(option_name)
             handler.call(self, field, field_options[option_name])
@@ -176,7 +176,14 @@ module TinyDyno
 
       def field_for(name, options)
         opts = options.merge(klass: self)
-        Fields::Standard.new(name, opts)
+        if opts.has_key?(:range_key) && opts[:range_key] == true
+          named = name.to_s
+          attribute_definitions << build_attribute_definition(named,options[:type])
+          key_schema << { attribute_name: named, key_type: 'RANGE' }
+          Fields::RangeKey.new(name, opts)
+        else
+          Fields::Standard.new(name, opts)
+        end
       end
 
       # Create the field accessors.

data/lib/tiny_dyno/hash_key.rb

@@ -37,7 +37,7 @@ module TinyDyno
         raise TinyDyno::Errors::OnlyOneHashKeyPermitted.new(klass: self.class, name: name) unless primary_key.empty?
         named = name.to_s
         attribute_definition = build_attribute_definition(named,options[:type])
-        key_schema = build_key_schema(named)
+        key_schema = hash_key_schema(named)
         unless attribute_definition_meets_spec?(attribute_definition)
           raise TinyDyno::Errors::InvalidHashKey.new(klass: self.class, name: name)
         end
@@ -52,12 +52,6 @@ module TinyDyno
         }
       end
 
-      # convert a hash key into a format as expected by
-      # put_item and update_item request
-      def as_item_entry(hash_key)
-
-      end
-
       private
 
       # Return true or false, depending on whether the attribute_definitions on the model
@@ -80,17 +74,17 @@ module TinyDyno
       def build_attribute_definition(name, key_type)
         {
             attribute_name: name,
-            attribute_type: hash_key_type(key_type)
+            attribute_type: determine_key_class(key_type)
         }
       end
 
-      def hash_key_type(key_type = nil)
+      def determine_key_class(key_type = nil)
         return 'S' if key_type == String
         return 'N' if key_type == Fixnum or key_type == Integer
         return nil
       end
 
-      def build_key_schema(name)
+      def hash_key_schema(name)
         {
             attribute_name: name,
             key_type: 'HASH'

data/lib/tiny_dyno/version.rb

@@ -1,3 +1,3 @@
 module TinyDyno
-  VERSION = '0.1.11'
+  VERSION = '0.1.12'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tiny_dyno
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.12
 platform: ruby
 authors:
 - Tobias Gerschner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-04 00:00:00.000000000 Z
+date: 2015-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -190,13 +190,12 @@ files:
 - lib/tiny_dyno/extensions.rb
 - lib/tiny_dyno/extensions/module.rb
 - lib/tiny_dyno/fields.rb
+- lib/tiny_dyno/fields/range_key.rb
 - lib/tiny_dyno/fields/standard.rb
 - lib/tiny_dyno/hash_key.rb
 - lib/tiny_dyno/hash_keys.rb
 - lib/tiny_dyno/loggable.rb
 - lib/tiny_dyno/persistable.rb
-- lib/tiny_dyno/range_attributes.rb
-- lib/tiny_dyno/range_key.rb
 - lib/tiny_dyno/stateful.rb
 - lib/tiny_dyno/tables.rb
 - lib/tiny_dyno/version.rb

data/lib/tiny_dyno/range_attributes.rb

@@ -1,15 +0,0 @@
-module TinyDyno
-  module RangeAttributes
-    extend ActiveSupport::Concern
-
-    attr_reader :range_attributes
-
-    included do
-      class_attribute :range_attributes
-
-      self.range_attributes = []
-
-    end
-
-  end
-end