dynamoid 0.4.0 → 0.4.1

data/doc/top-level-namespace.html

@@ -96,7 +96,7 @@
 </div>
     
     <div id="footer">
-  Generated on Tue Mar 27 17:53:07 2012 by 
+  Generated on Thu Apr 26 01:26:26 2012 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.7.5 (ruby-1.9.3).
 </div>

data/lib/dynamoid/adapter.rb

@@ -1,12 +1,12 @@
 # encoding: utf-8
 module Dynamoid
 
-  # Adapter provides a generic, write-through class that abstracts variations in the underlying connections to provide a uniform response 
+  # Adapter provides a generic, write-through class that abstracts variations in the underlying connections to provide a uniform response
   # to Dynamoid.
   module Adapter
     extend self
     attr_accessor :tables
-    
+
     # The actual adapter currently in use: presently, either AwsSdk or Local.
     #
     # @since 0.2.0
@@ -14,7 +14,7 @@ module Dynamoid
       reconnect! unless @adapter
       @adapter
     end
-    
+
     # Establishes a connection to the underyling adapter and caches all its tables for speedier future lookups. Issued when the adapter is first called.
     #
     # @since 0.2.0
@@ -24,7 +24,7 @@ module Dynamoid
       @adapter.connect! if @adapter.respond_to?(:connect!)
       self.tables = benchmark('Cache Tables') {list_tables}
     end
-    
+
     # Shows how long it takes a method to run on the adapter. Useful for generating logged output.
     #
     # @param [Symbol] method the name of the method to appear in the log
@@ -40,7 +40,7 @@ module Dynamoid
       Dynamoid.logger.info "(#{((Time.now - start) * 1000.0).round(2)} ms) #{method.to_s.split('_').collect(&:upcase).join(' ')}#{ " - #{args.inspect}" unless args.nil? || args.empty? }"
       return result
     end
-    
+
     # Write an object to the adapter. Partition it to a randomly selected key first if necessary.
     #
     # @param [String] table the name of the table to write the object to
@@ -54,12 +54,12 @@ module Dynamoid
         object[:id] = "#{object[:id]}.#{Random.rand(Dynamoid::Config.partition_size)}"
         object[:updated_at] = Time.now.to_f
       end
-      benchmark('Put Item', object) {put_item(table, object)}
+      put_item(table, object)
     end
-    
+
     # Read one or many keys from the selected table. This method intelligently calls batch_get or get on the underlying adapter depending on
     # whether ids is a range or a single key: additionally, if partitioning is enabled, it batch_gets all keys in the partition space
-    # automatically. Finally, if a range key is present, it will also interpolate that into the ids so that the batch get will acquire the 
+    # automatically. Finally, if a range key is present, it will also interpolate that into the ids so that the batch get will acquire the
     # correct record.
     #
     # @param [String] table the name of the table to write the object to
@@ -72,22 +72,22 @@ module Dynamoid
       if ids.respond_to?(:each)
         ids = ids.collect{|id| range_key ? [id, range_key] : id}
         if Dynamoid::Config.partitioning?
-          results = benchmark('Partitioned Batch Get Item', ids) {batch_get_item(table => id_with_partitions(ids))}
+          results = batch_get_item(table => id_with_partitions(ids))
           {table => result_for_partition(results[table])}
         else
-          benchmark('Batch Get Item', ids) {batch_get_item(table => ids)}
+          batch_get_item(table => ids)
         end
       else
         if Dynamoid::Config.partitioning?
           ids = range_key ? [[ids, range_key]] : ids
-          results = benchmark('Partitioned Get Item', ids) {batch_get_item(table => id_with_partitions(ids))}
+          results = batch_get_item(table => id_with_partitions(ids))
           result_for_partition(results[table]).first
         else
-          benchmark('Get Item', ids) {get_item(table, ids, options)}
+          get_item(table, ids, options)
         end
       end
     end
-    
+
     # Delete an item from a table. If partitioning is turned on, deletes all partitioned keys as well.
     #
     # @param [String] table the name of the table to write the object to
@@ -97,29 +97,27 @@ module Dynamoid
     # @since 0.2.0
     def delete(table, id, options = {})
       if Dynamoid::Config.partitioning?
-        benchmark('Delete Item', id) do
-          id_with_partitions(id).each {|i| delete_item(table, i, options)}
-        end
+        id_with_partitions(id).each {|i| delete_item(table, i, options)}
       else
-        benchmark('Delete Item', id) {delete_item(table, id, options)}
+        delete_item(table, id, options)
       end
     end
-    
+
     # Scans a table. Generally quite slow; try to avoid using scan if at all possible.
     #
     # @param [String] table the name of the table to write the object to
     # @param [Hash] scan_hash a hash of attributes: matching records will be returned by the scan
     #
-    # @since 0.2.0    
+    # @since 0.2.0
     def scan(table, query, opts = {})
       if Dynamoid::Config.partitioning?
         results = benchmark('Scan', table, query) {adapter.scan(table, query, opts)}
         result_for_partition(results)
       else
-        adapter.scan(table, query, opts)
+        benchmark('Scan', table, query) {adapter.scan(table, query, opts)}
       end
     end
-    
+
     [:batch_get_item, :create_table, :delete_item, :delete_table, :get_item, :list_tables, :put_item].each do |m|
       # Method delegation with benchmark to the underlying adapter. Faster than relying on method_missing.
       #
@@ -128,8 +126,8 @@ module Dynamoid
         benchmark("#{m.to_s}", args) {adapter.send(m, *args)}
       end
     end
-    
-    # Takes a list of ids and returns them with partitioning added. If an array of arrays is passed, we assume the second key is the range key 
+
+    # Takes a list of ids and returns them with partitioning added. If an array of arrays is passed, we assume the second key is the range key
     # and pass it in unchanged.
     #
     # @example Partition id 1
@@ -139,15 +137,15 @@ module Dynamoid
     #
     # @param [Array] ids array of ids to partition
     #
-    # @since 0.2.0 
+    # @since 0.2.0
     def id_with_partitions(ids)
       Array(ids).collect {|id| (0...Dynamoid::Config.partition_size).collect{|n| id.is_a?(Array) ? ["#{id.first}.#{n}", id.last] : "#{id}.#{n}"}}.flatten(1)
     end
-    
-    # Takes an array of results that are partitioned, find the most recently updated one, and return only it. Compares each result by 
+
+    # Takes an array of results that are partitioned, find the most recently updated one, and return only it. Compares each result by
     # their id and updated_at attributes; if the updated_at is the greatest, then it must be the correct result.
     #
-    # @param [Array] returned partitioned results from a query 
+    # @param [Array] returned partitioned results from a query
     #
     # @since 0.2.0
     def result_for_partition(results)
@@ -162,7 +160,7 @@ module Dynamoid
         end
       end.values
     end
-    
+
     # Delegate all methods that aren't defind here to the underlying adapter.
     #
     # @since 0.2.0
@@ -170,7 +168,7 @@ module Dynamoid
       return benchmark(method, *args) {adapter.send(method, *args)} if @adapter.respond_to?(method)
       super
     end
-    
+
   end
-  
+
 end

data/lib/dynamoid/adapter/aws_sdk.rb

@@ -3,15 +3,15 @@ require 'aws'
 
 module Dynamoid
   module Adapter
-    
+
     # The AwsSdk adapter provides support for the AWS-SDK for Ruby gem.
     # More information is available at that Gem's Github page:
     # https://github.com/amazonwebservices/aws-sdk-for-ruby
-    # 
+    #
     module AwsSdk
       extend self
       @@connection = nil
-    
+
       # Establish the connection to DynamoDB.
       #
       # @return [AWS::DynamoDB::Connection] the raw DynamoDB connection
@@ -20,7 +20,7 @@ module Dynamoid
       def connect!
         @@connection = AWS::DynamoDB.new(:access_key_id => Dynamoid::Config.access_key, :secret_access_key => Dynamoid::Config.secret_key, :dynamo_db_endpoint => Dynamoid::Config.endpoint)
       end
-    
+
       # Return the established connection.
       #
       # @return [AWS::DynamoDB::Connection] the raw DynamoDB connection
@@ -29,16 +29,16 @@ module Dynamoid
       def connection
         @@connection
       end
-    
+
       # Get many items at once from DynamoDB. More efficient than getting each item individually.
-      # 
+      #
       # @example Retrieve IDs 1 and 2 from the table testtable
       #   Dynamoid::Adapter::AwsSdk.batch_get_item('table1' => ['1', '2'])
       #
       # @param [Hash] options the hash of tables and IDs to retrieve
       #
       # @return [Hash] a hash where keys are the table names and the values are the retrieved items
-      # 
+      #
       # @since 0.2.0
       def batch_get_item(options)
         hash = Hash.new{|h, k| h[k] = []}
@@ -54,15 +54,16 @@ module Dynamoid
         end
         hash
       end
-    
+
       # Create a table on DynamoDB. This usually takes a long time to complete.
       #
       # @param [String] table_name the name of the table to create
       # @param [Symbol] key the table's primary key (defaults to :id)
       # @param [Hash] options provide a range_key here if you want one for the table
-      # 
+      #
       # @since 0.2.0
       def create_table(table_name, key = :id, options = {})
+        Dynamite.logger.info "Creating #{table_name} table. This could take a while."
         options[:hash_key] ||= {key.to_sym => :string}
         read_capacity = options[:read_capacity] || Dynamoid::Config.read_capacity
         write_capacity = options[:write_capacity] || Dynamoid::Config.write_capacity
@@ -70,7 +71,7 @@ module Dynamoid
         sleep 0.5 while table.status == :creating
         return table
       end
-    
+
       # Removes an item from DynamoDB.
       #
       # @param [String] table_name the name of the table
@@ -89,8 +90,8 @@ module Dynamoid
         result.delete unless result.attributes.to_h.empty?
         true
       end
-    
-      # Deletes an entire table from DynamoDB. Only 10 tables can be in the deleting state at once, 
+
+      # Deletes an entire table from DynamoDB. Only 10 tables can be in the deleting state at once,
       # so if you have more this method may raise an exception.
       #
       # @param [String] table_name the name of the table to destroy
@@ -99,9 +100,9 @@ module Dynamoid
       def delete_table(table_name)
         @@connection.tables[table_name].delete
       end
-    
+
       # @todo Add a DescribeTable method.
-    
+
       # Fetches an item from DynamoDB.
       #
       # @param [String] table_name the name of the table
@@ -129,14 +130,14 @@ module Dynamoid
           result.symbolize_keys!
         end
       end
-    
+
       # List all tables on DynamoDB.
       #
       # @since 0.2.0
       def list_tables
         @@connection.tables.collect(&:name)
       end
-    
+
       # Persists an item on DynamoDB.
       #
       # @param [String] table_name the name of the table
@@ -147,9 +148,9 @@ module Dynamoid
         table = get_table(table_name)
         table.items.create(object.delete_if{|k, v| v.nil? || (v.respond_to?(:empty?) && v.empty?)})
       end
-    
-      # Query the DynamoDB table. This employs DynamoDB's indexes so is generally faster than scanning, but is 
-      # only really useful for range queries, since it can only find by one hash key at once. Only provide 
+
+      # Query the DynamoDB table. This employs DynamoDB's indexes so is generally faster than scanning, but is
+      # only really useful for range queries, since it can only find by one hash key at once. Only provide
       # one range key to the hash.
       #
       # @param [String] table_name the name of the table
@@ -176,7 +177,7 @@ module Dynamoid
           get_item(table_name, opts[:hash_value])
         end
       end
-    
+
       # Scan the DynamoDB table. This is usually a very slow operation as it naively filters all data on
       # the DynamoDB servers.
       #
@@ -194,9 +195,9 @@ module Dynamoid
         end
         results
       end
-    
+
       # @todo Add an UpdateItem method.
-    
+
       # @todo Add an UpdateTable method.
 
       def get_table(table_name)

data/lib/dynamoid/persistence.rb

@@ -3,23 +3,23 @@ require 'securerandom'
 # encoding: utf-8
 module Dynamoid
 
-  # Persistence is responsible for dumping objects to and marshalling objects from the datastore. It tries to reserialize 
+  # Persistence is responsible for dumping objects to and marshalling objects from the datastore. It tries to reserialize
   # values to be of the same type as when they were passed in, based on the fields in the class.
   module Persistence
     extend ActiveSupport::Concern
-    
+
     attr_accessor :new_record
     alias :new_record? :new_record
-    
+
     module ClassMethods
-      
+
       # Returns the name of the table the class is for.
       #
       # @since 0.2.0
       def table_name
         "#{Dynamoid::Config.namespace}_#{options[:name] ? options[:name] : self.name.downcase.pluralize}"
       end
-      
+
       # Creates a table.
       #
       # @param [Hash] options options to pass for table creation
@@ -31,26 +31,32 @@ module Dynamoid
       #
       # @since 0.4.0
       def create_table(options = {})
+        if self.range_key
+          range_key_type = [:integer, :float].include?(attributes[range_key][:type]) ? :number : attributes[range_key][:type]
+          range_key_hash = { range_key => range_key_type}
+        else
+          range_key_hash = nil
+        end
         options = {
           :id => self.hash_key,
           :table_name => self.table_name,
           :write_capacity => self.write_capacity,
           :read_capacity => self.read_capacity,
-          :range_key => self.range_key ? {range_key => attributes[range_key][:type]} : nil
+          :range_key => range_key_hash
         }.merge(options)
-        
+
         return true if table_exists?(options[:table_name])
-        
+
         Dynamoid::Adapter.tables << options[:table_name] if Dynamoid::Adapter.create_table(options[:table_name], options[:id], options)
       end
 
       # Does a table with this name exist?
       #
-      # @since 0.2.0      
+      # @since 0.2.0
       def table_exists?(table_name)
         Dynamoid::Adapter.tables.include?(table_name)
       end
-      
+
       # Undump an object into a hash, converting each type from a string representation of itself into the type specified by the field.
       #
       # @since 0.2.0
@@ -58,20 +64,20 @@ module Dynamoid
         incoming = (incoming || {}).symbolize_keys
         Hash.new.tap do |hash|
           self.attributes.each do |attribute, options|
-            hash[attribute] = undump_field(incoming[attribute], options[:type])
+            hash[attribute] = undump_field(incoming[attribute], options)
           end
           incoming.each {|attribute, value| hash[attribute] ||= value }
         end
       end
 
-      # Undump a value for a given type. Given a string, it'll determine (based on the type provided) whether to turn it into a 
+      # Undump a value for a given type. Given a string, it'll determine (based on the type provided) whether to turn it into a
       # string, integer, float, set, array, datetime, or serialized return value.
       #
       # @since 0.2.0
-      def undump_field(value, type)
+      def undump_field(value, options)
         return if value.nil? || (value.respond_to?(:empty?) && value.empty?)
 
-        case type
+        case options[:type]
         when :string
           value.to_s
         when :integer
@@ -92,7 +98,7 @@ module Dynamoid
           end
         when :serialized
           if value.is_a?(String)
-            YAML.load(value)
+            options[:serializer] ? options[:serializer].load(value) : YAML.load(value)
           else
             value
           end
@@ -100,14 +106,14 @@ module Dynamoid
       end
 
     end
-    
+
     # Is this object persisted in the datastore? Required for some ActiveModel integration stuff.
     #
     # @since 0.2.0
     def persisted?
       !new_record?
     end
-    
+
     # Run the callbacks and then persist this object in the datastore.
     #
     # @since 0.2.0
@@ -142,28 +148,28 @@ module Dynamoid
       delete_indexes
       Dynamoid::Adapter.delete(self.class.table_name, self.id)
     end
-    
+
     # Dump this object's attributes into hash form, fit to be persisted into the datastore.
     #
     # @since 0.2.0
     def dump
       Hash.new.tap do |hash|
         self.class.attributes.each do |attribute, options|
-          hash[attribute] = dump_field(self.read_attribute(attribute), options[:type])
+          hash[attribute] = dump_field(self.read_attribute(attribute), options)
         end
       end
     end
-    
+
     private
 
-    # Determine how to dump this field. Given a value, it'll determine how to turn it into a value that can be 
+    # Determine how to dump this field. Given a value, it'll determine how to turn it into a value that can be
     # persisted into the datastore.
     #
     # @since 0.2.0
-    def dump_field(value, type)
+    def dump_field(value, options)
       return if value.nil? || (value.respond_to?(:empty?) && value.empty?)
 
-      case type
+      case options[:type]
       when :string
         value.to_s
       when :integer
@@ -179,11 +185,11 @@ module Dynamoid
       when :datetime
         value.to_time.to_f
       when :serialized
-        value.to_yaml
+        options[:serializer] ? options[:serializer].dump(value) : value.to_yaml
       end
     end
 
-    # Persist the object into the datastore. Assign it an id first if it doesn't have one; then afterwards, 
+    # Persist the object into the datastore. Assign it an id first if it doesn't have one; then afterwards,
     # save its indexes.
     #
     # @since 0.2.0
@@ -196,7 +202,7 @@ module Dynamoid
         true
       end
     end
-        
+
   end
-  
+
 end