dynamoid-moda 0.7.1

data/lib/dynamoid/dirty.rb

@@ -0,0 +1,47 @@
+module Dynamoid
+  module Dirty
+    extend ActiveSupport::Concern
+    include ActiveModel::Dirty
+
+    module ClassMethods
+      def from_database(*)
+        super.tap { |d| d.changed_attributes.clear }
+      end
+    end
+
+    def save(*)
+      clear_changes { super }
+    end
+
+    def update!(*)
+      ret = super
+      clear_changes #update! completely reloads all fields on the class, so any extant changes are wiped out
+      ret
+    end
+
+    def reload
+      super.tap { clear_changes }
+    end
+
+    def clear_changes
+      previous = changes
+      (block_given? ? yield : true).tap do |result|
+        unless result == false #failed validation; nil is OK.
+          @previously_changed = previous
+          changed_attributes.clear
+        end
+      end
+    end
+
+    def write_attribute(name, value)
+      attribute_will_change!(name) unless self.read_attribute(name) == value
+      super
+    end
+
+    protected
+
+    def attribute_method?(attr)
+      super || self.class.attributes.has_key?(attr.to_sym)
+    end
+  end
+end

data/lib/dynamoid/document.rb

@@ -0,0 +1,199 @@
+# encoding: utf-8
+module Dynamoid #:nodoc:
+
+  # This is the base module for all domain objects that need to be persisted to
+  # the database as documents.
+  module Document
+    extend ActiveSupport::Concern
+    include Dynamoid::Components
+
+    included do
+      class_attribute :options, :read_only_attributes, :base_class
+      self.options = {}
+      self.read_only_attributes = []
+      self.base_class = self
+
+      Dynamoid::Config.included_models << self
+    end
+
+    module ClassMethods
+      # Set up table options, including naming it whatever you want, setting the id key, and manually overriding read and
+      # write capacity.
+      #
+      # @param [Hash] options options to pass for this table
+      # @option options [Symbol] :name the name for the table; this still gets namespaced
+      # @option options [Symbol] :id id column for the table
+      # @option options [Integer] :read_capacity set the read capacity for the table; does not work on existing tables
+      # @option options [Integer] :write_capacity set the write capacity for the table; does not work on existing tables
+      #
+      # @since 0.4.0
+      def table(options = {})
+        self.options = options
+        super if defined? super
+      end
+
+      def attr_readonly(*read_only_attributes)
+        self.read_only_attributes.concat read_only_attributes.map(&:to_s)
+      end
+
+      # Returns the read_capacity for this table.
+      #
+      # @since 0.4.0
+      def read_capacity
+        options[:read_capacity] || Dynamoid::Config.read_capacity
+      end
+
+      # Returns the write_capacity for this table.
+      #
+      # @since 0.4.0
+      def write_capacity
+        options[:write_capacity] || Dynamoid::Config.write_capacity
+      end
+
+      # Returns the id field for this class.
+      #
+      # @since 0.4.0
+      def hash_key
+        options[:key] || :id
+      end
+
+      # Returns the number of items for this class.
+      #
+      # @since 0.6.1
+      def count
+        Dynamoid::Adapter.adapter.count(table_name)
+      end
+
+      # Initialize a new object and immediately save it to the database.
+      #
+      # @param [Hash] attrs Attributes with which to create the object.
+      #
+      # @return [Dynamoid::Document] the saved document
+      #
+      # @since 0.2.0
+      def create(attrs = {})
+        attrs[:type] ? attrs[:type].constantize.new(attrs).tap(&:save) : new(attrs).tap(&:save)
+      end
+
+      # Initialize a new object and immediately save it to the database. Raise an exception if persistence failed.
+      #
+      # @param [Hash] attrs Attributes with which to create the object.
+      #
+      # @return [Dynamoid::Document] the saved document
+      #
+      # @since 0.2.0
+      def create!(attrs = {})
+        attrs[:type] ? attrs[:type].constantize.new(attrs).tap(&:save!) : new(attrs).tap(&:save!)
+      end
+
+      # Initialize a new object.
+      #
+      # @param [Hash] attrs Attributes with which to create the object.
+      #
+      # @return [Dynamoid::Document] the new document
+      #
+      # @since 0.2.0
+      def build(attrs = {})
+        attrs[:type] ? attrs[:type].constantize.new(attrs) : new(attrs)
+      end
+
+      # Does this object exist?
+      #
+      # @param [Mixed] id_or_conditions the id of the object or a hash with the options to filter from.
+      #
+      # @return [Boolean] true/false
+      #
+      # @since 0.2.0
+      def exists?(id_or_conditions = {})
+        case id_or_conditions
+          when Hash then ! where(id_or_conditions).all.empty?
+          else !! find(id_or_conditions)
+        end
+      end
+    end
+
+    # Initialize a new object.
+    #
+    # @param [Hash] attrs Attributes with which to create the object.
+    #
+    # @return [Dynamoid::Document] the new document
+    #
+    # @since 0.2.0
+    def initialize(attrs = {})
+      run_callbacks :initialize do
+        @new_record = true
+        @attributes ||= {}
+        @associations ||= {}
+
+        load(attrs)
+      end
+    end
+
+    def load(attrs)
+      self.class.undump(attrs).each {|key, value| send "#{key}=", value }
+    end
+
+    # An object is equal to another object if their ids are equal.
+    #
+    # @since 0.2.0
+    def ==(other)
+      if self.class.identity_map_on?
+        super
+      else
+        return false if other.nil?
+        other.is_a?(Dynamoid::Document) && self.hash_key == other.hash_key && self.range_value == other.range_value
+      end
+    end
+
+    def eql?(other)
+      self == other
+    end
+
+    def hash
+      hash_key.hash ^ range_value.hash
+    end
+
+    # Reload an object from the database -- if you suspect the object has changed in the datastore and you need those
+    # changes to be reflected immediately, you would call this method. This is a consistent read.
+    #
+    # @return [Dynamoid::Document] the document this method was called on
+    #
+    # @since 0.2.0
+    def reload
+      range_key_value = range_value ? dumped_range_value : nil
+      self.attributes = self.class.find(hash_key, :range_key => range_key_value, :consistent_read => true).attributes
+      @associations.values.each(&:reset)
+      self
+    end
+
+    # Return an object's hash key, regardless of what it might be called to the object.
+    #
+    # @since 0.4.0
+    def hash_key
+      self.send(self.class.hash_key)
+    end
+
+    # Assign an object's hash key, regardless of what it might be called to the object.
+    #
+    # @since 0.4.0
+    def hash_key=(value)
+      self.send("#{self.class.hash_key}=", value)
+    end
+
+    def range_value
+      if range_key = self.class.range_key
+        self.send(range_key)
+      end
+    end
+
+    def range_value=(value)
+      self.send("#{self.class.range_key}=", value)
+    end
+
+    private
+
+    def dumped_range_value
+      dump_field(range_value, self.class.attributes[self.class.range_key])
+    end
+  end
+end

data/lib/dynamoid/errors.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+module Dynamoid
+  
+  # All the error specific to Dynamoid.
+  module Errors
+    
+    # Generic error class.
+    class Error < StandardError; end
+    
+    # InvalidField is raised when an attribute is specified for an index, but the attribute does not exist.
+    class InvalidField < Error; end
+    
+    # MissingRangeKey is raised when a table that requires a range key is quieried without one.
+    class MissingRangeKey < Error; end
+
+    # raised when the conditional check failed during update operation
+    class ConditionalCheckFailedException < Error; end
+
+    # DocumentNotValid is raised when the document fails validation.
+    class DocumentNotValid < Error
+      def initialize(document)
+        super("Validation failed: #{document.errors.full_messages.join(", ")}")
+      end
+    end
+
+    class InvalidQuery < Error; end
+  end
+end

data/lib/dynamoid/fields.rb

@@ -0,0 +1,138 @@
+# 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
+
+    # 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:
+      # default is string, but you can also specify :integer, :float, :set, :array, :datetime, and :serialized.
+      #
+      # @param [Symbol] name the name of the field
+      # @param [Symbol] type the type of the field (one of :integer, :float, :set, :array, :datetime, or :serialized)
+      # @param [Hash] options any additional options for the field
+      #
+      # @since 0.2.0
+      def field(name, type = :string, options = {})
+        named = name.to_s
+        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,133 @@
+# 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
+
+    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
+
+        ids = Array(ids.flatten.uniq)
+        if ids.count == 1
+          self.find_by_id(ids.first, options)
+        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/Integer/Float] 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 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