bigrecord 0.0.8 → 0.0.9

data/README.rdoc

@@ -3,10 +3,10 @@
 A Ruby Object/Data Mapper for distributed column-oriented data stores (inspired by BigTable) such as HBase. Intended to work as a drop-in for Rails applications.
 
 == Features
-* Dynamic schemas (due to the schema-less design of BigTable).
+* {BigRecord::DynamicSchema Dynamic schemas} (due to the schema-less design of BigTable).
 * Support for column-oriented data stores.
 * Similar usage to Active Record.
-* Embedded records that store within a single table row.
+* {BigRecord::Embedded Embedded records} that store within a single table row.
 * Automatic versioning.
 * Scalability (depending on the data store used).
 
@@ -31,11 +31,11 @@ Beyond this though, there are two basic motivations that almost immediately dema
 
 == Getting Started
 
-Check out the guides/getting_started.rdoc file for more information.
+Check out the {file:guides/getting_started.rdoc guides/getting_started.rdoc} file for more information.
 
 == Deployment
 
-Refer to guides/deployment.rdoc for more information.
+Refer to {file:guides/deployment.rdoc guides/deployment.rdoc} for more information.
 
 == Documentation
 
@@ -48,5 +48,6 @@ Big Record is released under the MIT license.
 == Links
 
 * Contact Us
+  * Google Group - http://groups.google.com/group/bigrecord
   * Website - http://www.bigrecord.org
   * IRC Channel - <tt>#bigrecord</tt> on irc.freenode.net

data/VERSION

@@ -1 +1 @@
-0.0.8
+0.0.9

data/lib/big_record/abstract_base.rb

@@ -367,14 +367,14 @@ module BigRecord
       write_attribute(self.class.primary_key, value)
     end
 
-    # Returns true if this object hasn't been saved yet -- that is, a record for the object doesn't
-    # yet exist in the data store.
+    # Returns true if this object hasn't been saved yet -- that is, a record for the object doesn't exist yet.
     def new_record?
       false
     end
 
-    # * No record exists: Creates a new record with values matching those of the object attributes.
-    # * A record does exist: Updates the record with values matching those of the object attributes.
+    # Method that saves the BigRecord object into the database. It will do one of two things:
+    # * If no record currently exists: Creates a new record with values matching those of the object attributes.
+    # * If a record already exist: Updates the record with values matching those of the object attributes.
     def save
       raise NotImplemented
     end
@@ -435,6 +435,7 @@ module BigRecord
     end
 
   protected
+
     def clone_in_persistence_format
       validate_attributes_schema
 
@@ -682,6 +683,7 @@ module BigRecord
     end
 
   protected
+
     # Returns the value of the attribute identified by <tt>attr_name</tt> after it has been typecast (for example,
     # "2004-12-12" in a data column is cast to a date object, like Date.new(2004, 12, 12)).
     def read_attribute(attr_name)
@@ -701,7 +703,8 @@ module BigRecord
       @attributes[attr_name.to_s]
     end
 
-private
+  private
+
     # Called on first read access to any given column and generates reader
     # methods for all columns in the columns_hash if
     # BigRecord::Base.generate_read_methods is set to true.
@@ -778,6 +781,7 @@ private
     end
 
   public
+
     class << self
 
       # Evaluate the name of the column of the primary key only once
@@ -884,7 +888,8 @@ private
       # adds the new column into the model's column hash.
       #
       # @param type [Symbol, String] Column type as defined in the source of {ConnectionAdapters::Column#klass}
-      # @option options [true,false] :collection Whether this column is a collection.
+      # @param [Hash] options The options to define the column with.
+      # @option options [TrueClass,FalseClass] :collection Whether this column is a collection.
       # @option options [String] :alias Define an alias for the column that cannot be inferred. By default, 'attribute:name' will be aliased to 'name'.
       # @option options [String] :default Default value to set for this column.
       #
@@ -918,7 +923,7 @@ private
       end
 
       # Contains the names of the generated reader methods.
-      def read_methods #:nodoc:
+      def read_methods
         @read_methods ||= Set.new
       end
 
@@ -1045,7 +1050,15 @@ private
        read_inheritable_attribute(:attr_create_accessible)
       end
 
+      # Guesses the table name, but does not decorate it with prefix and suffix information.
+      def undecorated_table_name(class_name = base_class.name)
+        table_name = Inflector.underscore(Inflector.demodulize(class_name))
+        table_name = Inflector.pluralize(table_name) if pluralize_table_names
+        table_name
+      end
+
     protected
+
       def invalidate_views
         @views = nil
         @view_names = nil
@@ -1081,16 +1094,10 @@ private
         type_name.constantize
       end
 
-    public
-      # Guesses the table name, but does not decorate it with prefix and suffix information.
-      def undecorated_table_name(class_name = base_class.name)
-        table_name = Inflector.underscore(Inflector.demodulize(class_name))
-        table_name = Inflector.pluralize(table_name) if pluralize_table_names
-        table_name
-      end
     end
 
   protected
+
     # Handle *? for method_missing.
     def attribute?(attribute_name)
       query_attribute(attribute_name)

data/lib/big_record/base.rb

@@ -12,8 +12,10 @@ module BigRecord
       super
     end
 
+  public
+
     # New objects can be instantiated as either empty (pass no construction parameter) or pre-set with
-    # attributes but not yet saved (pass a hash with key names matching the associated table column names).
+    # attributes but not yet saved (pass a hash with key names matching the associated column names).
     # In both instances, valid attribute keys are determined by the column names of the associated table --
     # hence you can't have attributes that aren't part of the table columns.
     def initialize(attrs = nil)
@@ -24,7 +26,6 @@ module BigRecord
 
     # Returns the value of the attribute identified by <tt>attr_name</tt> after it has been typecast (for example,
     # "2004-12-12" in a data column is cast to a date object, like Date.new(2004, 12, 12)).
-    # (Alias for the protected read_attribute method).
     def [](attr_name)
       if attr_name.ends_with?(":")
         read_family_attributes(attr_name)
@@ -80,7 +81,7 @@ module BigRecord
       end
     end
 
-    # Read an attribute that defines a column family.
+    # Read an attribute that defines a column family, as opposed to a column qualifier.
     def read_family_attributes(attr_name)
       attr_name = attr_name.to_s
       column = column_for_attribute(attr_name)
@@ -130,24 +131,14 @@ module BigRecord
       end
     end
 
-    def set_loaded(name)
-      @loaded_columns ||= []
-      @loaded_columns << name
-    end
-
-    def is_loaded?(name)
-      @loaded_columns ||= []
-      @loaded_columns.include?(name)
-    end
-
-  public
     # Returns true if this object hasn't been saved yet -- that is, a record for the object doesn't exist yet.
     def new_record?
       @new_record
     end
 
-    # * No record exists: Creates a new record with values matching those of the object attributes.
-    # * A record does exist: Updates the record with values matching those of the object attributes.
+    # Method that saves the BigRecord object into the database. It will do one of two things:
+    # * If no record currently exists: Creates a new record with values matching those of the object attributes.
+    # * If a record already exist: Updates the record with values matching those of the object attributes.
     def save
       create_or_update
     end
@@ -158,8 +149,7 @@ module BigRecord
       create_or_update || raise(RecordNotSaved)
     end
 
-    # Deletes the record in the database and freezes this instance to reflect that no changes should
-    # be made (since they can't be persisted).
+    # Deletes the record in the database.
     def destroy
       unless new_record?
         connection.delete(self.class.table_name, self.id)
@@ -197,6 +187,16 @@ module BigRecord
 
   protected
 
+    def set_loaded(name)
+      @loaded_columns ||= []
+      @loaded_columns << name
+    end
+
+    def is_loaded?(name)
+      @loaded_columns ||= []
+      @loaded_columns.include?(name)
+    end
+
     # Invoke {#create} if {#new_record} returns true, otherwise it's an {#update}
     def create_or_update
       raise ReadOnlyRecord if readonly?
@@ -218,8 +218,8 @@ module BigRecord
       update_bigrecord
     end
 
-    # Update this record in hbase. Cannot be directly in the method 'update' because it would trigger callbacks and
-    # therefore weird behaviors.
+    # Update this record in the database. Cannot be directly in the method 'update' because it would trigger callbacks and
+    # therefore weird behavior.
     def update_bigrecord
       timestamp = self.respond_to?(:updated_at) ? self.updated_at.to_bigrecord_timestamp : Time.now.to_bigrecord_timestamp
 
@@ -229,6 +229,7 @@ module BigRecord
     end
 
   public
+
     class << self
 
       # Return the name of the primary key. Defaults to "id".
@@ -299,6 +300,16 @@ module BigRecord
         end
       end
 
+      # Returns all records for the model by invoking find(:all)
+      def all
+        find(:all)
+      end
+
+      # Returns the first record for the model by invoke find(:first)
+      def first
+        find(:first)
+      end
+
       # Returns true if the given +id+ represents the primary key of a record in the database, false otherwise.
       def exists?(id)
         !find(id).nil?
@@ -387,10 +398,16 @@ module BigRecord
         connection.truncate_table(table_name)
       end
 
+      # Returns the inflected table name as it's called in your database.
       def table_name
         (superclass == BigRecord::Base) ? @table_name : superclass.table_name
       end
 
+      # If you want to avoid the table name inflection, you can define the name
+      # explicitly with this method.
+      #
+      # @example
+      #   set_table_name :table_xyz
       def set_table_name(name)
         @table_name = name.to_s
       end
@@ -519,6 +536,7 @@ module BigRecord
       end
 
     protected
+
       def invalidate_views
         @views = nil
         @view_names = nil
@@ -614,16 +632,6 @@ module BigRecord
         end
       end
 
-      def find_all_by_id(ids, options={})
-        ids.inject([]) do |result, id|
-          begin
-            result << find_one(id, options)
-          rescue BigRecord::RecordNotFound => e
-          end
-          result
-        end
-      end
-
       # Add the missing cells to the raw record and set them to nil. We know that it's
       # nil because else we would have received those cells. That way, when the value of
       # one of these cells will be requested by the client we won't try to lazy load it.