dynamoid-edge 1.1.0

data/lib/dynamoid/fields.rb

@@ -0,0 +1,156 @@
+# encoding: utf-8
+module Dynamoid #:nodoc:
+  # All fields on a Dynamoid::Document must be explicitly defined -- if you have fields in the database that are not
+  # specified with field, then they will be ignored.
+  module Fields
+    extend ActiveSupport::Concern
+
+    PERMITTED_KEY_TYPES = [
+      :number,
+      :integer,
+      :string,
+      :datetime
+    ]
+
+    # Initialize the attributes we know the class has, in addition to our magic attributes: id, created_at, and updated_at.
+    included do
+      class_attribute :attributes
+      class_attribute :range_key
+
+      self.attributes = {}
+      field :created_at, :datetime
+      field :updated_at, :datetime
+
+      field :id #Default primary key
+    end
+
+    module ClassMethods
+
+      # Specify a field for a document.
+      #
+      # Its type determines how it is coerced when read in and out of the datastore.
+      # You can specify :integer, :number, :set, :array, :datetime, and :serialized,
+      # or specify a class that defines a serialization strategy.
+      #
+      # If you specify a class for field type, Dynamoid will serialize using
+      # `dynamoid_dump` or `dump` methods, and load using `dynamoid_load` or `load` methods.
+      #
+      # Default field type is :string.
+      #
+      # @param [Symbol] name the name of the field
+      # @param [Symbol] type the type of the field (refer to method description for details)
+      # @param [Hash] options any additional options for the field
+      #
+      # @since 0.2.0
+      def field(name, type = :string, options = {})
+        named = name.to_s
+        if type == :float
+          Dynamoid.logger.warn("Field type :float, which you declared for '#{name}', is deprecated in favor of :number.")
+          type = :number
+        end
+        self.attributes = attributes.merge(name => {:type => type}.merge(options))
+
+        define_method(named) { read_attribute(named) }
+        define_method("#{named}?") { !read_attribute(named).nil? }
+        define_method("#{named}=") {|value| write_attribute(named, value) }
+      end
+
+      def range(name, type = :string)
+        field(name, type)
+        self.range_key = name
+      end
+
+      def table(options)
+        #a default 'id' column is created when Dynamoid::Document is included
+        unless(attributes.has_key? hash_key)
+          remove_field :id
+          field(hash_key)
+        end
+      end
+
+      def remove_field(field)
+        field = field.to_sym
+        attributes.delete(field) or raise "No such field"
+        remove_method field
+        remove_method :"#{field}="
+        remove_method :"#{field}?"
+      end
+    end
+
+    # You can access the attributes of an object directly on its attributes method, which is by default an empty hash.
+    attr_accessor :attributes
+    alias :raw_attributes :attributes
+
+    # Write an attribute on the object. Also marks the previous value as dirty.
+    #
+    # @param [Symbol] name the name of the field
+    # @param [Object] value the value to assign to that field
+    #
+    # @since 0.2.0
+    def write_attribute(name, value)
+      if (size = value.to_s.size) > MAX_ITEM_SIZE
+        Dynamoid.logger.warn "DynamoDB can't store items larger than #{MAX_ITEM_SIZE} and the #{name} field has a length of #{size}."
+      end
+
+      if association = @associations[name]
+        association.reset
+      end
+
+      attributes[name.to_sym] = value
+    end
+    alias :[]= :write_attribute
+
+    # Read an attribute from an object.
+    #
+    # @param [Symbol] name the name of the field
+    #
+    # @since 0.2.0
+    def read_attribute(name)
+      attributes[name.to_sym]
+    end
+    alias :[] :read_attribute
+
+    # Updates multiple attibutes at once, saving the object once the updates are complete.
+    #
+    # @param [Hash] attributes a hash of attributes to update
+    #
+    # @since 0.2.0
+    def update_attributes(attributes)
+      attributes.each {|attribute, value| self.write_attribute(attribute, value)} unless attributes.nil? || attributes.empty?
+      save
+    end
+
+    # Update a single attribute, saving the object afterwards.
+    #
+    # @param [Symbol] attribute the attribute to update
+    # @param [Object] value the value to assign it
+    #
+    # @since 0.2.0
+    def update_attribute(attribute, value)
+      write_attribute(attribute, value)
+      save
+    end
+
+    private
+
+    # Automatically called during the created callback to set the created_at time.
+    #
+    # @since 0.2.0
+    def set_created_at
+      self.created_at = DateTime.now
+    end
+
+    # Automatically called during the save callback to set the updated_at time.
+    #
+    # @since 0.2.0
+    def set_updated_at
+      self.updated_at = DateTime.now
+    end
+
+    def set_type
+      self.type ||= self.class.to_s if self.class.attributes[:type]
+    end
+
+  end
+
+end

data/lib/dynamoid/finders.rb

@@ -0,0 +1,197 @@
+# encoding: utf-8
+module Dynamoid
+
+  # This module defines the finder methods that hang off the document at the
+  # class level, like find, find_by_id, and the method_missing style finders.
+  module Finders
+    extend ActiveSupport::Concern
+
+    RANGE_MAP = {
+      'gt'            => :range_greater_than,
+      'lt'            => :range_less_than,
+      'gte'           => :range_gte,
+      'lte'           => :range_lte,
+      'begins_with'   => :range_begins_with,
+      'between'       => :range_between,
+      'eq'            => :range_eq
+    }
+
+    module ClassMethods
+
+      # Find one or many objects, specified by one id or an array of ids.
+      #
+      # @param [Array/String] *id an array of ids or one single id
+      #
+      # @return [Dynamoid::Document] one object or an array of objects, depending on whether the input was an array or not
+      #
+      # @since 0.2.0
+      def find(*ids)
+        options = if ids.last.is_a? Hash
+                    ids.slice!(-1)
+                  else
+                    {}
+                  end
+        expects_array = ids.first.kind_of?(Array)
+
+        ids = Array(ids.flatten.uniq)
+        if ids.count == 1
+          result = self.find_by_id(ids.first, options)
+          expects_array ? Array(result) : result
+        else
+          find_all(ids)
+        end
+      end
+
+      # Return objects found by the given array of ids, either hash keys, or hash/range key combinations using BatchGet.
+      # Returns empty array if no results found.
+      #
+      # @param [Array<ID>] ids
+      # @param [Hash] options: Passed to the underlying query.
+      #
+      # @example
+      #   find all the user with hash key
+      #   User.find_all(['1', '2', '3'])
+      #
+      #   find all the tweets using hash key and range key with consistent read
+      #   Tweet.find_all([['1', 'red'], ['1', 'green']], :consistent_read => true)
+      def find_all(ids, options = {})
+        items = Dynamoid.adapter.read(self.table_name, ids, options)
+        items ? items[self.table_name].map{|i| from_database(i)} : []
+      end
+
+      # Find one object directly by id.
+      #
+      # @param [String] id the id of the object to find
+      #
+      # @return [Dynamoid::Document] the found object, or nil if nothing was found
+      #
+      # @since 0.2.0
+      def find_by_id(id, options = {})
+        if item = Dynamoid.adapter.read(self.table_name, id, options)
+          from_database(item)
+        else
+          nil
+        end
+      end
+
+      # Find one object directly by hash and range keys
+      #
+      # @param [String] hash_key of the object to find
+      # @param [String/Number] range_key of the object to find
+      #
+      def find_by_composite_key(hash_key, range_key, options = {})
+        find_by_id(hash_key, options.merge({:range_key => range_key}))
+      end
+
+      # Find all objects by hash and range keys.
+      #
+      # @example find all ChamberTypes whose level is greater than 1
+      #   class ChamberType
+      #     include Dynamoid::Document
+      #     field :chamber_type,            :string
+      #     range :level,                   :integer
+      #     table :key => :chamber_type
+      #   end
+      #   ChamberType.find_all_by_composite_key('DustVault', range_greater_than: 1)
+      #
+      # @param [String] hash_key of the objects to find
+      # @param [Hash] options the options for the range key
+      # @option options [Range] :range_value find the range key within this range
+      # @option options [Number] :range_greater_than find range keys greater than this
+      # @option options [Number] :range_less_than find range keys less than this
+      # @option options [Number] :range_gte find range keys greater than or equal to this
+      # @option options [Number] :range_lte find range keys less than or equal to this
+      #
+      # @return [Array] an array of all matching items
+      #
+      def find_all_by_composite_key(hash_key, options = {})
+        Dynamoid.adapter.query(self.table_name, options.merge({hash_value: hash_key})).collect do |item|
+          from_database(item)
+        end
+      end
+
+      # Find all objects by using local secondary or global secondary index
+      #
+      # @example
+      #   class User
+      #     include Dynamoid::Document
+      #     field :email,          :string
+      #     field :age,            :integer
+      #     field :gender,         :string
+      #     field :rank            :number
+      #     table :key => :email
+      #     global_secondary_index :hash_key => :age, :range_key => :gender
+      #   end
+      #   User.find_all_by_secondary_index(:age => 5, :range => {"rank.lte" => 10})
+      #
+      # @param [Hash] eg: {:age => 5}
+      # @param [Hash] eg: {"rank.lte" => 10}
+      # @param [Hash] options - @TODO support more options in future such as
+      #               query filter, projected keys etc
+      # @return [Array] an array of all matching items
+      def find_all_by_secondary_index(hash, options = {})
+        range = options[:range] || {}
+        hash_key_field, hash_key_value = hash.first
+        range_key_field, range_key_value = range.first
+        range_op_mapped = nil
+
+        if range_key_field
+          range_key_field = range_key_field.to_s
+          range_key_op = "eq"
+          if range_key_field.include?(".")
+            range_key_field, range_key_op = range_key_field.split(".", 2)
+          end
+          range_op_mapped = RANGE_MAP.fetch(range_key_op)
+        end
+
+        # Find the index
+        index = self.find_index(hash_key_field, range_key_field)
+        raise Dynamoid::Errors::MissingIndex if index.nil?
+
+        # query
+        opts = {
+          :hash_key => hash_key_field.to_s,
+          :hash_value => hash_key_value,
+          :index_name => index.name,
+        }
+        if range_key_field
+          opts[:range_key] = range_key_field
+          opts[range_op_mapped] = range_key_value
+        end
+        Dynamoid.adapter.query(self.table_name, opts).map do |item|
+          from_database(item)
+        end
+      end
+
+      # Find using exciting method_missing finders attributes. Uses criteria chains under the hood to accomplish this neatness.
+      #
+      # @example find a user by a first name
+      #   User.find_by_first_name('Josh')
+      #
+      # @example find all users by first and last name
+      #   User.find_all_by_first_name_and_last_name('Josh', 'Symonds')
+      #
+      # @return [Dynamoid::Document/Array] the found object, or an array of found objects if all was somewhere in the method
+      #
+      # @since 0.2.0
+      def method_missing(method, *args)
+        if method =~ /find/
+          finder = method.to_s.split('_by_').first
+          attributes = method.to_s.split('_by_').last.split('_and_')
+
+          chain = Dynamoid::Criteria::Chain.new(self)
+          chain.query = Hash.new.tap {|h| attributes.each_with_index {|attr, index| h[attr.to_sym] = args[index]}}
+
+          if finder =~ /all/
+            return chain.all
+          else
+            return chain.first
+          end
+        else
+          super
+        end
+      end
+    end
+  end
+
+end

data/lib/dynamoid/identity_map.rb

@@ -0,0 +1,92 @@
+module Dynamoid
+  module IdentityMap
+    extend ActiveSupport::Concern
+
+    def self.clear
+      Dynamoid.included_models.each { |m| m.identity_map.clear }
+    end
+
+    module ClassMethods
+      def identity_map
+        @identity_map ||= {}
+      end
+
+      def from_database(attrs = {})
+        return super if identity_map_off?
+
+        key = identity_map_key(attrs)
+        document = identity_map[key]
+
+        if document.nil?
+          document = super
+          identity_map[key] = document
+        else
+          document.load(attrs)
+        end
+
+        document
+      end
+
+      def find_by_id(id, options = {})
+        return super if identity_map_off?
+
+        key = id.to_s
+
+        if range_key = options[:range_key]
+          key += "::#{range_key}"
+        end
+
+        if identity_map[key]
+          identity_map[key]
+        else
+          super
+        end
+      end
+
+      def identity_map_key(attrs)
+        key = attrs[hash_key].to_s
+        if range_key
+          key += "::#{attrs[range_key]}"
+        end
+        key
+      end
+
+      def identity_map_on?
+        Dynamoid::Config.identity_map
+      end
+
+      def identity_map_off?
+        !identity_map_on?
+      end
+    end
+
+    def identity_map
+      self.class.identity_map
+    end
+
+    def save(*args)
+      return super if self.class.identity_map_off?
+
+      if result = super
+        identity_map[identity_map_key] = self
+      end
+      result
+    end
+
+    def delete
+      return super if self.class.identity_map_off?
+
+      identity_map.delete(identity_map_key)
+      super
+    end
+
+
+    def identity_map_key
+      key = hash_key.to_s
+      if self.class.range_key
+        key += "::#{range_value}"
+      end
+      key
+    end
+  end
+end

data/lib/dynamoid/middleware/identity_map.rb

@@ -0,0 +1,16 @@
+module Dynamoid
+  module Middleware
+    class IdentityMap
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        Dynamoid::IdentityMap.clear
+        @app.call(env)
+      ensure
+        Dynamoid::IdentityMap.clear
+      end
+    end
+  end
+end