aws-sdk 1.8.5 → 1.9.0

data/lib/aws/record/model/attributes.rb

@@ -11,8 +11,6 @@
 # ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
 
-require 'aws/record/attributes.rb'
-
 module AWS
   module Record
     class Model
@@ -46,24 +44,24 @@ module AWS
               range.is_a?(Range) and range.first.is_a?(Integer)
             super(name, options)
           end
-          
+
           # Returns a serialized representation of the integer value suitable for
           # storing in SimpleDB.
           #
-          #   attribute.serialize(123)
-          #   #=> '123'
+          #     attribute.serialize(123)
+          #     #=> '123'
           #
-          #   # padded to the correct number of digits
-          #   attribute.serialize('123', :range => (0..10_000)
-          #   #=> '00123'
+          #     # padded to the correct number of digits
+          #     attribute.serialize('123', :range => (0..10_000)
+          #     #=> '00123'
           #
-          #   # offset applied to make all values positive
-          #   attribute.serialize('-55', :range => (-100..10_000)
-          #   #=> '00045'
+          #     # offset applied to make all values positive
+          #     attribute.serialize('-55', :range => (-100..10_000)
+          #     #=> '00045'
           #
           # @param [Integer] integer The number to serialize.
           # @param [Hash] options
-          # @option options [required,Range] :range A range that represents the 
+          # @option options [required,Range] :range A range that represents the
           #   minimum and maximum values this integer can be.
           #   The returned value will have an offset applied (if min is
           #   less than 0) and will be zero padded.
@@ -117,7 +115,7 @@ module AWS
           end
 
           def self.serialize float, options = {}
-            expect(Float, float) do 
+            expect(Float, float) do
               left, right = float.to_s.split('.')
               left = SortableIntegerAttr.serialize(left.to_i, options)
               SortableIntegerAttr.check_range(float, options)
@@ -138,7 +136,7 @@ module AWS
       end
 
       class << self
-  
+
         # Adds a string attribute to this class.
         #
         # @example A standard string attribute
@@ -150,14 +148,14 @@ module AWS
         #   recipe = Recipe.new(:name => "Buttermilk Pancakes")
         #   recipe.name #=> 'Buttermilk Pancakes'
         #
-        # @example A string attribute with +:set+ set to true
+        # @example A string attribute with `:set` set to true
         #
         #   class Recipe < AWS::Record::Model
         #     string_attr :tags, :set => true
         #   end
         #
         #   recipe = Recipe.new(:tags => %w(popular dessert))
-        #   recipe.tags #=> #<Set: {"popular", "desert"}> 
+        #   recipe.tags #=> #<Set: {"popular", "desert"}>
         #
         # @param [Symbol] name The name of the attribute.
         # @param [Hash] options
@@ -166,15 +164,15 @@ module AWS
         def string_attr name, options = {}
           add_attribute(Record::Attributes::StringAttr.new(name, options))
         end
-  
+
         # Adds an integer attribute to this class.
         #
-        #   class Recipe < AWS::Record::Model
-        #     integer_attr :servings
-        #   end
+        #     class Recipe < AWS::Record::Model
+        #       integer_attr :servings
+        #     end
         #
-        #   recipe = Recipe.new(:servings => '10')
-        #   recipe.servings #=> 10
+        #     recipe = Recipe.new(:servings => '10')
+        #     recipe.servings #=> 10
         #
         # @param [Symbol] name The name of the attribute.
         # @param [Hash] options
@@ -183,24 +181,24 @@ module AWS
         def integer_attr name, options = {}
           add_attribute(Attributes::IntegerAttr.new(name, options))
         end
-  
+
         # Adds a sortable integer attribute to this class.
         #
-        #   class Person < AWS::Record::Model
-        #     sortable_integer_attr :age, :range => 0..150
-        #   end
+        #     class Person < AWS::Record::Model
+        #       sortable_integer_attr :age, :range => 0..150
+        #     end
         #
-        #   person = Person.new(:age => 10)
-        #   person.age #=> 10
+        #     person = Person.new(:age => 10)
+        #     person.age #=> 10
+        #
+        # ### Validations
         #
-        # === Validations
-        # 
         # It is recomended to apply a validates_numericality_of with
         # minimum and maximum value constraints.  If a value is assigned
         # to a sortable integer that falls outside of the +:range: it will
         # raise a runtime error when the record is saved.
         #
-        # === Difference Between Sortable an Regular Integer Attributes
+        # ### Difference Between Sortable an Regular Integer Attributes
         #
         # Because SimpleDB does not support numeric types, all values must
         # be converted to strings.  This complicates sorting by numeric values.
@@ -216,15 +214,15 @@ module AWS
         def sortable_integer_attr name, options = {}
           add_attribute(Attributes::SortableIntegerAttr.new(name, options))
         end
-  
+
         # Adds a float attribute to this class.
         #
-        #   class Listing < AWS::Record::Model
-        #     float_attr :score
-        #   end
+        #     class Listing < AWS::Record::Model
+        #       float_attr :score
+        #     end
         #
-        #   listing = Listing.new(:score => '123.456')
-        #   listing.score # => 123.456
+        #     listing = Listing.new(:score => '123.456')
+        #     listing.score # => 123.456
         #
         # @param [Symbol] name The name of the attribute.
         # @param [Hash] options
@@ -233,35 +231,35 @@ module AWS
         def float_attr name, options = {}
           add_attribute(Attributes::FloatAttr.new(name, options))
         end
-  
+
         # Adds sortable float attribute to this class.
         #
         # Persisted values are stored (and sorted) as strings.  This makes it
-        # more difficult to sort numbers because they don't sort 
+        # more difficult to sort numbers because they don't sort
         # lexicographically unless they have been offset to be positive and
         # then zero padded.
         #
-        # === Postive Floats
+        # ### Postive Floats
         #
         # To store floats in a sort-friendly manor:
         #
-        #   sortable_float_attr :score, :range => (0..10)
+        #     sortable_float_attr :score, :range => (0..10)
         #
-        # This will cause values like 5.5 to persist as a string like '05.5' so 
+        # This will cause values like 5.5 to persist as a string like '05.5' so
         # that they can be sorted lexicographically.
         #
-        # === Negative Floats
+        # ### Negative Floats
         #
-        # If you need to store negative sortable floats, increase your +:range+
+        # If you need to store negative sortable floats, increase your `:range`
         # to include a negative value.
         #
-        #   sortable_float_attr :position, :range => (-10..10)
+        #     sortable_float_attr :position, :range => (-10..10)
         #
-        # AWS::Record will add 10 to all values and zero pad them 
-        # (e.g. -10.0 will be represented as '00.0' and 10 will be represented as 
+        # AWS::Record will add 10 to all values and zero pad them
+        # (e.g. -10.0 will be represented as '00.0' and 10 will be represented as
         # '20.0').  This will allow the values to be compared lexicographically.
         #
-        # @note If you change the +:range+ after some values have been persisted
+        # @note If you change the `:range` after some values have been persisted
         #   you must also manually migrate all of the old values to have the
         #   correct padding & offset or they will be interpreted differently.
         #
@@ -276,7 +274,7 @@ module AWS
         def sortable_float_attr name, options = {}
           add_attribute(Attributes::SortableFloatAttr.new(name, options))
         end
-  
+
         # Adds a boolean attribute to this class.
         #
         # @example
@@ -295,16 +293,16 @@ module AWS
         #
         # @param [Symbol] name The name of the attribute.
         def boolean_attr name, options = {}
-  
+
           attr = add_attribute(Attributes::BooleanAttr.new(name, options))
-  
+
           # add the boolean question mark method
           define_method("#{attr.name}?") do
             !!__send__(attr.name)
           end
-  
+
         end
-  
+
         # Adds a datetime attribute to this class.
         #
         # @example A standard datetime attribute
@@ -316,7 +314,7 @@ module AWS
         #   recipe = Recipe.new(:invented => Time.now)
         #   recipe.invented #=> <DateTime ...>
         #
-        # If you add a datetime_attr for +:created_at+ and/or +:updated_at+ those
+        # If you add a datetime_attr for `:created_at` and/or `:updated_at` those
         # will be automanaged.
         #
         # @param [Symbol] name The name of the attribute.
@@ -329,7 +327,7 @@ module AWS
         def datetime_attr name, options = {}
           add_attribute(Record::Attributes::DateTimeAttr.new(name, options))
         end
-  
+
         # Adds a date attribute to this class.
         #
         # @example A standard date attribute
@@ -352,9 +350,9 @@ module AWS
         def date_attr name, options = {}
           add_attribute(Record::Attributes::DateAttr.new(name, options))
         end
-  
+
         # A convenience method for adding the standard two datetime attributes
-        # +:created_at+ and +:updated_at+.
+        # `:created_at` and `:updated_at`.
         #
         # @example
         #
@@ -366,13 +364,13 @@ module AWS
         #   recipe.save
         #   recipe.created_at #=> <DateTime ...>
         #   recipe.updated_at #=> <DateTime ...>
-        # 
+        #
         def timestamps
           c = datetime_attr :created_at
           u = datetime_attr :updated_at
           [c, u]
         end
-    
+
       end
     end
   end

data/lib/aws/record/model/finder_methods.rb

@@ -24,46 +24,46 @@ module AWS
         #   was no data found for the given id.
         # @return [Record::HashModel] Returns the record with the given id.
         def find_by_id id, options = {}
-  
+
           domain = sdb_domain(options[:shard] || options[:domain])
-  
+
           data = domain.items[id].data.attributes
-  
+
           raise RecordNotFound, "no data found for id: #{id}" if data.empty?
-  
+
           obj = self.new(:shard => domain)
           obj.send(:hydrate, id, data)
           obj
-  
+
         end
         alias_method :[], :find_by_id
-  
-        # Finds records in SimpleDB and returns them as objects of the 
+
+        # Finds records in SimpleDB and returns them as objects of the
         # current class.
         #
-        # Finding +:all+ returns an enumerable scope object
+        # Finding `:all` returns an enumerable scope object
         #
-        #  People.find(:all, :order => [:age, :desc], :limit => 10).each do |person|
-        #    puts person.name
-        #  end
+        #     People.find(:all, :order => [:age, :desc], :limit => 10).each do |person|
+        #       puts person.name
+        #     end
         #
-        # Finding +:first+ returns a single record (or nil)
+        # Finding `:first` returns a single record (or nil)
         #
-        #  boss = People.find(:first, :where => { :boss => true })
+        #     boss = People.find(:first, :where => { :boss => true })
         #
-        # Find accepts a hash of find modifiers (+:where+, +:order+ and
-        # +:limit+).  You can also choose to omit these modifiers and
+        # Find accepts a hash of find modifiers (`:where`, `:order` and
+        # `:limit`).  You can also choose to omit these modifiers and
         # chain them on the scope object returned.  In the following
         # example only one request is made to SimpleDB (when #each is
         # called)
         #
-        #   people = People.find(:all)
+        #     people = People.find(:all)
         #
-        #   johns = people.where(:name => 'John Doe')
+        #     johns = people.where(:name => 'John Doe')
         #
-        #   johns.order(:age, :desc).limit(10).each do |suspects|
-        #     # ...
-        #   end
+        #     johns.order(:age, :desc).limit(10).each do |suspects|
+        #       # ...
+        #     end
         #
         # See also {where}, {order} and {limit} for more
         # information and options.
@@ -73,25 +73,25 @@ module AWS
         #     not found.
         #
         # @overload find(mode, options = {})
-        #   @param [:all,:first] mode (:all) When finding +:all+ matching records
-        #     and array is returned of records.  When finding +:first+ then
-        #     +nil+ or a single record will be returned.
+        #   @param [:all,:first] mode (:all) When finding `:all` matching records
+        #     and array is returned of records.  When finding `:first` then
+        #     `nil` or a single record will be returned.
         #   @param [Hash] options
         #   @option options [Mixed] :where Conditions that determine what
         #     records are returned.
-        #   @option options [String,Array] :sort The order records should be 
+        #   @option options [String,Array] :sort The order records should be
         #     returned in.
         #   @option options [Integer] :limit The max number of records to fetch.
         def find *args
           new_scope.find(*args)
         end
-  
+
         # Returns a chainable scope object that restricts further scopes to a
         # particular domain.
         #
-        #  Book.domain('books-2').each do |book|
-        #    # ...
-        #  end
+        #     Book.domain('books-2').each do |book|
+        #       # ...
+        #     end
         #
         # @param [String] shard_name
         # @return [Scope] Returns a scope for restricting the domain of subsequent
@@ -99,20 +99,20 @@ module AWS
           new_scope.shard(shard_name)
         end
         alias_method :domain, :shard
-  
+
         # Returns an enumerable scope object represents all records.
         #
-        #   Book.all.each do |book|
-        #     # ...
-        #   end
+        #     Book.all.each do |book|
+        #       # ...
+        #     end
         #
-        # This method is equivalent to +find(:all)+, and therefore you can also
-        # pass aditional options.  See {.find} for more information on what 
+        # This method is equivalent to `find(:all)`, and therefore you can also
+        # pass aditional options.  See {.find} for more information on what
         # options you can pass.
         #
-        #   Book.all(:where => { :author' => 'me' }).each do |my_book|
-        #     # ...
-        #   end
+        #     Book.all(:where => { :author' => 'me' }).each do |my_book|
+        #       # ...
+        #     end
         #
         # @return [Scope] Returns an enumerable scope object.
         def all options = {}
@@ -123,20 +123,20 @@ module AWS
         def each &block
           all.each(&block)
         end
-  
+
         # Counts records in SimpleDB.
         #
         # With no arguments, counts all records:
         #
-        #   People.count
+        #     People.count
         #
         # Accepts query options to count a subset of records:
         #
-        #   People.count(:where => { :boss => true })
+        #     People.count(:where => { :boss => true })
         #
         # You can also count records on a scope object:
         #
-        #   People.find(:all).where(:boss => true).count
+        #     People.find(:all).where(:boss => true).count
         #
         # See {find} and {Scope#count} for more details.
         #
@@ -150,43 +150,43 @@ module AWS
           new_scope.count(options)
         end
         alias_method :size, :count
-  
+
         # @return [Object,nil] Returns the first record found.  If there were
         #   no records found, nil is returned.
         def first options = {}
           new_scope.first(options)
         end
-  
+
         # Limits which records are retried from SimpleDB when performing a find.
-        #   
+        #
         # Simple string condition
         #
-        #   Car.where('color = "red" or color = "blue"').each {|car| ... }
-        #   
+        #     Car.where('color = "red" or color = "blue"').each {|car| ... }
+        #
         # String with placeholders for quoting params
         #
-        #   Car.where('color = ?', 'red')
+        #     Car.where('color = ?', 'red')
+        #
+        #     Car.where('color = ? OR style = ?', 'red', 'compact')
         #
-        #   Car.where('color = ? OR style = ?', 'red', 'compact')
+        #     # produces a condition using in, like: WHERE color IN ('red', 'blue')
+        #     Car.where('color IN ?', ['red','blue'])
         #
-        #   # produces a condition using in, like: WHERE color IN ('red', 'blue')
-        #   Car.where('color IN ?', ['red','blue'])
-        # 
         # Hash arguments
         #
-        #   # WHERE age = '40' AND gender = 'male'
-        #   People.where(:age => 40, :gender => 'male').each {|person| ... }
+        #     # WHERE age = '40' AND gender = 'male'
+        #     People.where(:age => 40, :gender => 'male').each {|person| ... }
         #
-        #   # WHERE name IN ('John', 'Jane')
-        #   People.where(:name => ['John', 'Jane']).each{|person| ... }
+        #     # WHERE name IN ('John', 'Jane')
+        #     People.where(:name => ['John', 'Jane']).each{|person| ... }
         #
         # Chaining where with other scope modifiers
         #
-        #   # 10 most expensive red cars
-        #   Car.where(:color => 'red').order(:price, :desc).limit(10)
-        #   
+        #     # 10 most expensive red cars
+        #     Car.where(:color => 'red').order(:price, :desc).limit(10)
+        #
         # @overload where(conditions_hash)
-        #   @param [Hash] conditions_hash A hash of attributes to values.  Each 
+        #   @param [Hash] conditions_hash A hash of attributes to values.  Each
         #     key/value pair from the hash becomes a find condition.  All
         #     conditions are joined by AND.
         #
@@ -195,16 +195,16 @@ module AWS
         def where *args
           new_scope.where(*args)
         end
-  
+
         # Defines the order in which records are returned when performing a find.
         # SimpleDB only allows sorting by one attribute per request.
         #
-        #   # oldest to youngest
-        #   People.order(:age, :desc).each {|person| ... }
+        #     # oldest to youngest
+        #     People.order(:age, :desc).each {|person| ... }
         #
         # You can chain order with the other scope modifiers:
         #
-        #   Pepole.order(:age, :desc).limit(10).each {|person| ... }
+        #     Pepole.order(:age, :desc).limit(10).each {|person| ... }
         #
         # @overload order(attribute, direction = :asc)
         #   @param [String,Symbol] attribute The attribute to sort by.
@@ -212,15 +212,15 @@ module AWS
         def order *args
           new_scope.order(*args)
         end
-  
+
         # The maximum number of records to return.  By default, all records
         # matching the where conditions will be returned from a find.
-        # 
-        #   People.limit(10).each {|person| ... }
+        #
+        #     People.limit(10).each {|person| ... }
         #
         # Limit can be chained with other scope modifiers:
         #
-        #   People.where(:age => 40).limit(10).each {|person| ... }
+        #     People.where(:age => 40).limit(10).each {|person| ... }
         #
         def limit limit
           new_scope.limit(limit)