bigrecord 0.0.8 → 0.0.9

data/lib/big_record/br_reflection.rb

@@ -26,11 +26,9 @@ module BigRecord
     # TODO: this sucks... aren't there a better way to do it?
     if self.class < ActiveRecord::Base
       class MacroReflectionAbstract < ActiveRecord::Reflection::MacroReflection
-
       end
     else
       class MacroReflectionAbstract < BigRecord::ArReflection::MacroReflection
-
       end
     end
 
@@ -88,7 +86,7 @@ module BigRecord
 
       # Gets an array of possible :through source reflection names
       #
-      #   [singularized, pluralized]
+      # [singularized, pluralized]
       #
       def source_reflection_names
         @source_reflection_names ||= (options[:source] ? [options[:source]] : [name.to_s.singularize, name]).collect { |n| n.to_sym }

data/lib/big_record/connection_adapters/abstract/database_statements.rb

@@ -1,175 +1,15 @@
 module BigRecord
   module ConnectionAdapters # :nodoc:
     module DatabaseStatements
-#      # Returns an array of record hashes with the column names as keys and
-#      # column values as values.
-#      def select_all(sql, name = nil)
-#        select(sql, name)
-#      end
-#
-#      # Returns a record hash with the column names as keys and column values
-#      # as values.
-#      def select_one(sql, name = nil)
-#        result = select_all(sql, name)
-#        result.first if result
-#      end
-#
-#      # Returns a single value from a record
-#      def select_value(sql, name = nil)
-#        if result = select_one(sql, name)
-#          result.values.first
-#        end
-#      end
-#
-#      # Returns an array of the values of the first column in a select:
-#      #   select_values("SELECT id FROM companies LIMIT 3") => [1,2,3]
-#      def select_values(sql, name = nil)
-#        result = select_rows(sql, name)
-#        result.map { |v| v[0] }
-#      end
-#
-#      # Returns an array of arrays containing the field values.
-#      # Order is the same as that returned by #columns.
-#      def select_rows(sql, name = nil)
-#        raise NotImplementedError, "select_rows is an abstract method"
-#      end
-#
-#      # Executes the SQL statement in the context of this connection.
-#      def execute(sql, name = nil)
-#        raise NotImplementedError, "execute is an abstract method"
-#      end
-#
-#      # Returns the last auto-generated ID from the affected table.
-#      def insert(sql, name = nil, pk = nil, id_value = nil, sequence_name = nil)
-#        insert_sql(sql, name, pk, id_value, sequence_name)
-#      end
-#
-#      # Executes the update statement and returns the number of rows affected.
-#      def update(sql, name = nil)
-#        update_sql(sql, name)
-#      end
-#
-#      # Executes the delete statement and returns the number of rows affected.
-#      def delete(sql, name = nil)
-#        delete_sql(sql, name)
-#      end
-#
-#      # Wrap a block in a transaction.  Returns result of block.
-#      def transaction(start_db_transaction = true)
-#        transaction_open = false
-#        begin
-#          if block_given?
-#            if start_db_transaction
-#              begin_db_transaction
-#              transaction_open = true
-#            end
-#            yield
-#          end
-#        rescue Exception => database_transaction_rollback
-#          if transaction_open
-#            transaction_open = false
-#            rollback_db_transaction
-#          end
-#          raise unless database_transaction_rollback.is_a? ActiveRecord::Rollback
-#        end
-#      ensure
-#        if transaction_open
-#          begin
-#            commit_db_transaction
-#          rescue Exception => database_transaction_rollback
-#            rollback_db_transaction
-#            raise
-#          end
-#        end
-#      end
-#
-#      # Begins the transaction (and turns off auto-committing).
-#      def begin_db_transaction()    end
-#
-#      # Commits the transaction (and turns on auto-committing).
-#      def commit_db_transaction()   end
-#
-#      # Rolls back the transaction (and turns on auto-committing). Must be
-#      # done if the transaction block raises an exception or returns false.
-#      def rollback_db_transaction() end
-#
-#      # Alias for #add_limit_offset!.
-#      def add_limit!(sql, options)
-#        add_limit_offset!(sql, options) if options
-#      end
-#
-#      # Appends +LIMIT+ and +OFFSET+ options to an SQL statement.
-#      # This method *modifies* the +sql+ parameter.
-#      # ===== Examples
-#      #  add_limit_offset!('SELECT * FROM suppliers', {:limit => 10, :offset => 50})
-#      # generates
-#      #  SELECT * FROM suppliers LIMIT 10 OFFSET 50
-#      def add_limit_offset!(sql, options)
-#        if limit = options[:limit]
-#          sql << " LIMIT #{limit}"
-#          if offset = options[:offset]
-#            sql << " OFFSET #{offset}"
-#          end
-#        end
-#      end
-#
-#      # Appends a locking clause to an SQL statement.
-#      # This method *modifies* the +sql+ parameter.
-#      #   # SELECT * FROM suppliers FOR UPDATE
-#      #   add_lock! 'SELECT * FROM suppliers', :lock => true
-#      #   add_lock! 'SELECT * FROM suppliers', :lock => ' FOR UPDATE'
-#      def add_lock!(sql, options)
-#        case lock = options[:lock]
-#          when true;   sql << ' FOR UPDATE'
-#          when String; sql << " #{lock}"
-#        end
-#      end
-#
-#      def default_sequence_name(table, column)
-#        nil
-#      end
-#
-#      # Set the sequence to the max value of the table's column.
-#      def reset_sequence!(table, column, sequence = nil)
-#        # Do nothing by default.  Implement for PostgreSQL, Oracle, ...
-#      end
-
       # Inserts the given fixture into the table. Overridden in adapters that require
       # something beyond a simple insert (eg. Oracle).
       def insert_fixture(fixture, table_name)
-#        execute "INSERT INTO #{quote_table_name(table_name)} (#{fixture.key_list}) VALUES (#{fixture.value_list})", 'Fixture Insert'
+        # execute "INSERT INTO #{quote_table_name(table_name)} (#{fixture.key_list}) VALUES (#{fixture.value_list})", 'Fixture Insert'
         attributes = fixture.to_hash.dup
         id = attributes.delete("id")
         raise ArgumentError, "the id is missing" unless id
         update(table_name, id, attributes, Time.now.to_bigrecord_timestamp)
       end
-
-#      def empty_insert_statement(table_name)
-#        "INSERT INTO #{quote_table_name(table_name)} VALUES(DEFAULT)"
-#      end
-#
-#      protected
-#        # Returns an array of record hashes with the column names as keys and
-#        # column values as values.
-#        def select(sql, name = nil)
-#          raise NotImplementedError, "select is an abstract method"
-#        end
-#
-#        # Returns the last auto-generated ID from the affected table.
-#        def insert_sql(sql, name = nil, pk = nil, id_value = nil, sequence_name = nil)
-#          execute(sql, name)
-#          id_value
-#        end
-#
-#        # Executes the update statement and returns the number of rows affected.
-#        def update_sql(sql, name = nil)
-#          execute(sql, name)
-#        end
-#
-#        # Executes the delete statement and returns the number of rows affected.
-#        def delete_sql(sql, name = nil)
-#          update_sql(sql, name)
-#        end
     end
   end
 end

data/lib/big_record/connection_adapters/abstract_adapter.rb

@@ -7,7 +7,7 @@ module BigRecord
   module ConnectionAdapters # :nodoc:
     # All the concrete database adapters follow the interface laid down in this class.
     # You can use this interface directly by borrowing the database connection from the Base with
-    # Base.connection.
+    # BigRecord::Base.connection
     #
     # Most of the methods in the adapter are useful during migrations.  Most
     # notably, SchemaStatements#create_table, SchemaStatements#drop_table,
@@ -172,19 +172,3 @@ module BigRecord
     end # class AbstractAdapter
   end # module ConnectionAdapters
 end # module BigRecord
-
-
-# Open the time class to add logic for the hbase timestamp
-class Time
-  # Return this time is the hbase timestamp format, i.e. a 'long'. The 4 high bytes contain
-  # the number of seconds since epoch and the 4 low bytes contain the microseconds. That
-  # format is an arbitrary one and could have been something else.
-  def to_bigrecord_timestamp
-    (self.to_i << 32) + self.usec
-  end
-
-  def self.from_bigrecord_timestamp(timestamp)
-    Time.at(timestamp >> 32, timestamp & 0xFFFFFFFF)
-  end
-
-end

data/lib/big_record/connection_adapters/column.rb

@@ -103,6 +103,7 @@ module BigRecord
       end
 
       # Returns the Ruby class that corresponds to the abstract data type.
+      # View the source for the actual mappings.
       def klass
         @klass ||=
         case type
@@ -339,36 +340,6 @@ module BigRecord
           parse_collection(value).collect{|v| string_to_dummy_time(v.to_s)}
         end
 
-#        def hash_to_time_collection(hash)
-#          return []
-#          return hash unless hash.is_a?(Hash)
-#          hash_to_collection(hash).collect do |attributes|
-#            cleaned_attributes = {}
-#            debugger
-#            attributes.each do |k, v|
-#              k =~ /reflect_value(.*)/
-#              cleaned_attributes[$1] = v
-#            end
-#            string_to_time(cleaned_attributes)
-#          end
-#        end
-#
-#        def hash_to_dummy_time_collection(hash)
-#          return []
-#          return hash unless hash.is_a?(Array)
-#          hash.split(COLLECTION_SEPARATOR).collect{|v|string_to_dummy_time(v)}
-#        end
-#
-#        def hash_to_date_collection(hash)
-#          return []
-#          return hash unless hash.is_a?(Array)
-#          hash_to_collection(hash).collect do |attributes|
-#            debugger
-#            callstack = extract_callstack_for_multiparameter_attributes(attributes.to_a)
-#
-#          end
-#        end
-
         def hash_to_boolean_collection(value)
           parse_collection(value).collect{|v| value_to_boolean(v)}
         end

data/lib/big_record/connection_adapters/hbase_adapter.rb

@@ -2,24 +2,26 @@ require 'rubygems'
 require 'set'
 require 'drb'
 
-unless defined?(BigRecordDriver)
-  begin
-    # Bigrecord's source is included with Bigrecord-Driver, that's we check for this first
-    require File.join(File.dirname(__FILE__), "..", "..", "..", "..", "bigrecord-driver", "lib", "big_record_driver")
-  rescue LoadError
-    begin
-      gem 'bigrecord-driver'
-      require 'bigrecord_driver'
-    rescue Gem::LoadError
-      puts "bigrecord-driver not available. Install it with: sudo gem install bigrecord-driver -s http://gemcutter.org"
-    end
-  end
-end
-
 module BigRecord
   class Base
     # Establishes a connection to the database that's used by all Active Record objects.
     def self.hbase_connection(config) # :nodoc:
+      unless defined?(BigRecordDriver)
+        begin
+          # Bigrecord's source is included with Bigrecord-Driver, that's where we check for it first.
+          require File.join(File.dirname(__FILE__), "..", "..", "..", "..", "bigrecord-driver", "lib", "big_record_driver")
+        rescue LoadError
+          # Then we'll require it from the load path (or rubygems)
+          begin
+            require 'bigrecord_driver'
+          rescue LoadError => e
+            # If it couldn't be found, we'll just prompt the user to install the gem.
+            puts "[BigRecord] bigrecord-driver is needed for HbaseAdapter. Install it with: gem install bigrecord-driver"
+            raise e
+          end
+        end
+      end
+
       config = config.symbolize_keys
 
       zookeeper_host          = config[:zookeeper_host]
@@ -233,7 +235,7 @@ module BigRecord
       end
 
       def create_table(table_name, options = {})
-        table_definition = TableDefinition.new
+        table_definition = HbaseAdapterTable.new
 
         yield table_definition if block_given?
 
@@ -398,7 +400,7 @@ module BigRecord
         end
     end
 
-    class TableDefinition
+    class HbaseAdapterTable
 
       def initialize
         @column_families = []

data/lib/big_record/connection_adapters/hbase_rest_adapter.rb

@@ -1,22 +1,27 @@
 require 'set'
-require 'hbase'
 
 module BigRecord
   class Base
     # Establishes a connection to the database that's used by all Active Record objects.
     def self.hbase_rest_connection(config) # :nodoc:
+      begin
+        require 'hbase'
+      rescue LoadError => e
+        puts "[BigRecord] hbase-ruby is needed for HbaseRestAdapter. Install it with: gem install hbase-ruby"
+        raise e
+      end
+
       config = config.symbolize_keys
 
       api_address = config[:api_address]
-
       hbase = HBase::Client.new(api_address)
-
       ConnectionAdapters::HbaseRestAdapter.new(hbase, logger, [], config)
     end
   end
 
   module ConnectionAdapters
     class HbaseRestAdapter < AbstractAdapter
+
       @@emulate_booleans = true
       cattr_accessor :emulate_booleans
 
@@ -83,7 +88,7 @@ module BigRecord
         result = nil
 
         columns = columns_to_hbase_format(values)
-        timestamp = Time.now.to_bigrecord_timestamp
+        timestamp ||= Time.now.to_bigrecord_timestamp
 
         log "UPDATE #{table_name} SET #{values.inspect if values} WHERE ROW=#{row};" do
           @connection.create_row(table_name, row, timestamp, columns)
@@ -171,16 +176,12 @@ module BigRecord
 
         result = rows.collect do |row|
           cols = {}
+          cols['id'] = row.name
           row.columns.each do |col|
             key = col.name
             value = col.value
             begin
-              cols[key] =
-              if key == 'id'
-                value
-              else
-                deserialize(value)
-              end
+              cols[key] = deserialize(value)
             rescue Exception => e
               puts "Could not load column value #{key} for row=#{row.name}"
             end
@@ -228,7 +229,7 @@ module BigRecord
       end
 
       def create_table(table_name, options = {})
-        table_definition = TableDefinition.new
+        table_definition = HbaseRestAdapterTable.new
 
         yield table_definition if block_given?
 
@@ -310,68 +311,70 @@ module BigRecord
         end
       end
 
-      private
+    private
 
-        def connect
-        end
+      def connect
+      end
 
-      protected
-        def log(str, name = nil)
-          if block_given?
-            if @logger and @logger.level <= Logger::INFO
-              result = nil
-              seconds = Benchmark.realtime { result = yield }
-              @runtime += seconds
-              log_info(str, name, seconds)
-              result
-            else
-              yield
-            end
+    protected
+
+      def log(str, name = nil)
+        if block_given?
+          if @logger and @logger.level <= Logger::INFO
+            result = nil
+            seconds = Benchmark.realtime { result = yield }
+            @runtime += seconds
+            log_info(str, name, seconds)
+            result
           else
-            log_info(str, name, 0)
-            nil
+            yield
           end
-        rescue Exception => e
-          # Log message and raise exception.
-          # Set last_verfication to 0, so that connection gets verified
-          # upon reentering the request loop
-          @last_verification = 0
-          message = "#{e.class.name}: #{e.message}: #{str}"
-          log_info(message, name, 0)
-          raise e
+        else
+          log_info(str, name, 0)
+          nil
         end
-
-        def log_info(str, name, runtime)
-          return unless @logger
-
-          @logger.debug(
-            format_log_entry(
-              "#{name.nil? ? "HBASE" : name} (#{sprintf("%f", runtime)})",
-              str.gsub(/ +/, " ")
-            )
+      rescue Exception => e
+        # Log message and raise exception.
+        # Set last_verfication to 0, so that connection gets verified
+        # upon reentering the request loop
+        @last_verification = 0
+        message = "#{e.class.name}: #{e.message}: #{str}"
+        log_info(message, name, 0)
+        raise e
+      end
+
+      def log_info(str, name, runtime)
+        return unless @logger
+
+        @logger.debug(
+          format_log_entry(
+            "#{name.nil? ? "HBASE" : name} (#{sprintf("%f", runtime)})",
+            str.gsub(/ +/, " ")
           )
-        end
-
-        def format_log_entry(message, dump = nil)
-          if BigRecord::Base.colorize_logging
-            if @@row_even
-              @@row_even = false
-              message_color, dump_color = "4;36;1", "0;1"
-            else
-              @@row_even = true
-              message_color, dump_color = "4;35;1", "0"
-            end
+        )
+      end
 
-            log_entry = "  \e[#{message_color}m#{message}\e[0m   "
-            log_entry << "\e[#{dump_color}m%#{String === dump ? 's' : 'p'}\e[0m" % dump if dump
-            log_entry
+      def format_log_entry(message, dump = nil)
+        if BigRecord::Base.colorize_logging
+          if @@row_even
+            @@row_even = false
+            message_color, dump_color = "4;36;1", "0;1"
           else
-            "%s  %s" % [message, dump]
+            @@row_even = true
+            message_color, dump_color = "4;35;1", "0"
           end
+
+          log_entry = "  \e[#{message_color}m#{message}\e[0m   "
+          log_entry << "\e[#{dump_color}m%#{String === dump ? 's' : 'p'}\e[0m" % dump if dump
+          log_entry
+        else
+          "%s  %s" % [message, dump]
         end
+      end
+
     end
 
-    class TableDefinition
+    class HbaseRestAdapterTable
 
       ##
       # Given an column descriptor's options hash from Bigrecord, translate it into

data/lib/big_record/dynamic_schema.rb

@@ -1,4 +1,18 @@
 module BigRecord
+
+  # = Dynamic Schema
+  #
+  # The dynamic schema functionality of Bigrecord refers to the ability to
+  # modify the attributes of a model within the class itself, rather than being
+  # bounded by the database. This is an inherit property of using the BigTable
+  # database model, and Bigrecord leverages its use.
+  #
+  # New attributes defined will simply return nil for records that existed
+  # before their addition into the model, while attributes that are removed
+  # from the model will just be ignored when accessing existing records.
+  #
+  # Refer to {BigRecord::ConnectionAdapters::Column} for more information.
+  #
   module DynamicSchema
 
     def self.included(base) #:nodoc:

data/lib/big_record/embedded_associations/association_proxy.rb

@@ -3,12 +3,6 @@ module BigRecord
     class AssociationProxy #:nodoc:
       instance_methods.each { |m| undef_method m unless m =~ /(^__|^nil\?$|^send$|proxy_)/ }
 
-#      def initialize(owner, reflection)
-#        @owner, @reflection = owner, reflection
-#        Array(reflection.options[:extend]).each { |ext| proxy_extend(ext) }
-#        reset
-#      end
-
       def find(id)
         @target.select{|s| s.id == id}.first
       end

data/lib/big_record/timestamp.rb

@@ -1,5 +1,5 @@
 module BigRecord
-  # Big Record automatically timestamps create and update if the table has fields
+  # BigRecord automatically timestamps create and update if the table has fields
   # created_at/created_on or updated_at/updated_on.
   #
   # Timestamping can be turned off by setting
@@ -15,7 +15,7 @@ module BigRecord
   #   end
   #
   # Timestamps are in the local timezone by default but can use UTC by setting
-  #   <tt>ActiveRecord::Base.default_timezone = :utc</tt>
+  #   <tt>BigRecord::Base.default_timezone = :utc</tt>
   module Timestamp
     def self.included(base) #:nodoc:
       super
@@ -49,3 +49,29 @@ module BigRecord
     end
   end
 end
+
+# Open the Time class to add methods which convert the time into the Bigrecord
+# timestamp format.
+class Time
+
+  # Return the time in the Bigrecord timestamp format, i.e. a 'long' where the
+  # 4 high bytes contain the number of seconds since epoch and the 4 low bytes
+  # contain the microseconds.
+  #
+  # @example
+  #   > Time.now.to_bigrecord_timestamp
+  #   => 5410405886576175030
+  def to_bigrecord_timestamp
+    (self.to_i << 32) + self.usec
+  end
+
+  # Converts a timestamp in Bigrecord format into a regular Time object.
+  #
+  # @example
+  #   > Time.from_bigrecord_timestamp(5410405886576175030)
+  #   => Tue Dec 01 17:58:05 -0500 2009
+  def self.from_bigrecord_timestamp(timestamp)
+    Time.at(timestamp >> 32, timestamp & 0xFFFFFFFF)
+  end
+
+end

data/lib/big_record.rb

@@ -32,7 +32,7 @@ end
 begin
   require 'active_record'
 rescue LoadError
-  puts "[Bigrecord] ActiveRecord could not be loaded. Bigrecord associations with AR models disabled."
+  raise LoadError, "Bigrecord depends on ActiveRecord. Install it with: gem install activerecord"
 end
 
 require dir + '/routing_ext'
@@ -40,7 +40,6 @@ require dir + '/abstract_base'
 require dir + '/base'
 require dir + '/embedded'
 require dir + '/validations'
-#require dir + '/callbacks'
 require dir + '/ar_reflection'
 require dir + '/br_reflection'
 require dir + '/ar_associations'
@@ -60,7 +59,6 @@ require dir + '/action_view_extensions'
 
 BigRecord::Base.class_eval do
   include BigRecord::Validations
-#  include BigRecord::Callbacks
   include ActiveRecord::Callbacks
   include BigRecord::Timestamp
   include BigRecord::ArAssociations
@@ -75,7 +73,6 @@ end
 
 BigRecord::Embedded.class_eval do
   include BigRecord::Validations
-#  include BigRecord::Callbacks
   include ActiveRecord::Callbacks
   include BigRecord::Timestamp
   include BigRecord::ArAssociations

data/lib/bigrecord.rb

@@ -1 +1 @@
-require 'big_record'
+require File.join(File.dirname(__FILE__), 'big_record')

data/spec/connections/bigrecord.yml

@@ -1,7 +1,7 @@
-hbase:
+hbase_rest:
   adapter: hbase_rest
   api_address: http://localhost:8080
-hbase_brd:
+hbase:
   adapter: hbase
   zookeeper_quorum: localhost
   zookeeper_client_port: 2181