bigrecord 0.0.5 → 0.0.6

data/README.rdoc

@@ -1,6 +1,6 @@
 = Big Record
 
-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. More information soon...
+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).
@@ -10,9 +10,9 @@ A Ruby Object/Data Mapper for distributed column-oriented data stores (inspired
 * Automatic versioning.
 * Scalability (depending on the data store used).
 
-== Why would I use it?
+== Motivations
 
-BigTable, and by extension, Big Record isn't right for everyone. A great introductory article discussing this topic can be found at http://blog.rapleaf.com/dev/?p=26 explaining why you would or wouldn't use BigTable. The rule of thumb, however, is that if your data model is simple or can fit into a standard RDBMS, then you probably don't need it.
+BigTable, and by extension, Bigrecord isn't right for everyone. A great introductory article discussing this topic can be found at http://blog.rapleaf.com/dev/?p=26 explaining why you would or wouldn't use BigTable. The rule of thumb, however, is that if your data model is simple or can fit into a standard RDBMS, then you probably don't need it.
 
 Beyond this though, there are two basic motivations that almost immediately demand a BigTable model database:
 1. Your data is highly dynamic in nature and would not fit in a schema bound model, or you cannot define a schema ahead of time.

data/Rakefile

@@ -4,12 +4,11 @@ require 'rubygems'
 require 'rake'
 require 'rake/rdoctask'
 require 'rake/gempackagetask'
-require 'pathname'
 require 'spec/rake/spectask'
 
 
 DATA_STORES = ["hbase", "cassandra"]
-ROOT = Pathname(__FILE__).dirname.expand_path
+ROOT = File.expand_path(File.dirname(__FILE__)) + '/'
 
 require ROOT + 'tasks/gem'
 require ROOT + 'tasks/rdoc'

data/VERSION

@@ -1 +1 @@
-0.0.5
+0.0.6

data/doc/getting_started.rdoc

@@ -18,6 +18,10 @@
 
   config.gem "bigrecord", :source => "http://gemcutter.org"
 
+and run the following command to install all the gems listed for your Rails app:
+
+  [sudo] rake gems:install
+
 (3) Bootstrap Bigrecord into your project:
 
   script/generate bigrecord

data/init.rb

@@ -1,9 +1 @@
-require 'big_record'
-
-# Use the same logger as ActiveRecord to make sure that the access to the log file is properly handled
-BigRecord::Base.logger = ActiveRecord::Base.logger
-BigRecord::Embedded.logger = ActiveRecord::Base.logger
-
-# Establish the connection with the database
-BigRecord::Base.configurations = YAML::load(File.open("#{RAILS_ROOT}/config/bigrecord.yml"))
-BigRecord::Base.establish_connection
+require File.join(File.dirname(__FILE__), "rails", "init")

data/lib/big_record/abstract_base.rb

@@ -1,4 +1,3 @@
-## The sub-classes of this class must implement the abstract method 'column_names' of this class.
 module BigRecord
   class BigRecordError < StandardError #:nodoc:
   end

data/lib/big_record/ar_associations.rb

@@ -1,9 +1,11 @@
-require 'big_record/ar_associations/association_proxy'
-require 'big_record/ar_associations/association_collection'
-require 'big_record/ar_associations/belongs_to_association'
-require 'big_record/ar_associations/has_one_association'
-require 'big_record/ar_associations/has_many_association'
-require 'big_record/ar_associations/has_and_belongs_to_many_association'
+dir = File.expand_path(File.join(File.dirname(__FILE__), "ar_associations"))
+
+require dir + '/association_proxy'
+require dir + '/association_collection'
+require dir + '/belongs_to_association'
+require dir + '/has_one_association'
+require dir + '/has_many_association'
+require dir + '/has_and_belongs_to_many_association'
 
 module BigRecord
   class HasManyThroughAssociationNotFoundError < BigRecordError #:nodoc:

data/lib/big_record/ar_reflection.rb

@@ -4,7 +4,7 @@ module BigRecord
       base.extend(ClassMethods)
     end
 
-    # Reflection allows you to interrogate Active Record classes and objects about their associations and aggregations.
+    # Reflection allows you to interrogate Big Record classes and objects about their associations and aggregations.
     # This information can, for example, be used in a form builder that took an Active Record object and created input
     # fields for all of the attributes depending on their type and displayed the associations to other objects.
     #

data/lib/big_record/attribute_methods.rb

@@ -19,7 +19,7 @@ module BigRecord
       # the attr argument.
       #
       # For example:
-      #   class Person < ActiveRecord::Base
+      #   class Person < BigRecord::Base
       #     attribute_method_suffix '_changed?'
       #
       #     private

data/lib/big_record/base.rb

@@ -1,4 +1,3 @@
-## The sub-classes of this class must implement the abstract method 'column_names' of this class.
 module BigRecord
 
   class Base < AbstractBase
@@ -411,14 +410,14 @@ module BigRecord
         (superclass == BigRecord::Base) ? self : superclass.base_class
       end
 
-      def view(name, columns)
+      def view(name, *columns)
         name = name.to_sym
         @views_hash ||= default_views
 
         # The other variables that are cached and depend on @views_hash need to be reloaded
         invalidate_views
 
-        @views_hash[name] = ConnectionAdapters::View.new(name, columns, self)
+        @views_hash[name] = ConnectionAdapters::View.new(name, columns.flatten, self)
       end
 
       def views
@@ -471,6 +470,39 @@ module BigRecord
         end
       end
 
+      # return the list of columns to get from hbase
+      def columns_to_find(options={})
+        c =
+          if options[:columns]
+            column_list = []
+            options[:columns].each do |column_name|
+              # If the column name provided is a full name, i.e. includes column family and qualifier,
+              # then add it to the list.
+              if column_name.to_s =~ /:/
+                column_list << column_name
+
+              # Otherwise, it's probably an alias and we need to check that.
+              else
+                columns.select{|column| column_list << column.name if column.alias == column_name.to_s}
+              end
+            end
+            column_list
+          elsif options[:view]
+            raise ArgumentError, "Unknown view: #{options[:view]}" unless views_hash[options[:view]]
+            if options[:view] == :all
+              ["#{default_family}:"]
+            else
+              views_hash[options[:view]].column_names
+            end
+          elsif views_hash[:default]
+            views_hash[:default].column_names
+          else
+            ["#{default_family}:"]
+          end
+        c += [options[:include]] if options[:include]
+        c.flatten.reject{|x| x == "id"}
+      end
+
     protected
       def invalidate_views
         @views = nil
@@ -567,27 +599,6 @@ module BigRecord
         end
       end
 
-      # return the list of columns to get from hbase
-      def columns_to_find(options={})
-        c =
-        if options[:columns]
-          options[:columns]
-        elsif options[:view]
-          raise ArgumentError, "Unknown view: #{options[:view]}" unless views_hash[options[:view]]
-          if options[:view] == :all
-            ["#{default_family}:"]
-          else
-            views_hash[options[:view]].column_names
-          end
-        elsif views_hash[:default]
-          views_hash[:default].column_names
-        else
-          ["#{default_family}:"]
-        end
-        c += [options[:include]] if options[:include]
-        c.flatten.reject{|x| x == "id"}
-      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.

data/lib/big_record/br_associations.rb

@@ -1,9 +1,11 @@
-require 'big_record/br_associations/association_proxy'
-require 'big_record/br_associations/association_collection'
-require 'big_record/br_associations/belongs_to_association'
-require 'big_record/br_associations/belongs_to_many_association'
-require 'big_record/br_associations/has_one_association'
-require 'big_record/br_associations/has_and_belongs_to_many_association'
+dir = File.expand_path(File.join(File.dirname(__FILE__), "br_associations"))
+
+require dir + '/association_proxy'
+require dir + '/association_collection'
+require dir + '/belongs_to_association'
+require dir + '/belongs_to_many_association'
+require dir + '/has_one_association'
+require dir + '/has_and_belongs_to_many_association'
 
 module BigRecord
   module BrAssociations # :nodoc:

data/lib/big_record/connection_adapters/view.rb

@@ -12,7 +12,19 @@ module BigRecord
       # Return the column objects associated with this view. By default the views 'all' and 'default' return every column.
       def columns
         if @column_names
-          @column_names.collect{|cn| owner.columns_hash[cn]}
+          columns = []
+
+          # First match against fully named columns, e.g. 'attribute:name'
+          @column_names.each{|cn| columns << owner.columns_hash[cn] if owner.columns_hash.has_key?(cn)}
+
+          # Now match against aliases if the number of columns found previously do not
+          # match the expected @columns_names size, i.e. there's still some missing.
+          if columns.size != @column_names.size
+            columns_left = @column_names - columns.map{|column| column.name}
+            owner.columns_hash.each { |name,column| columns << column if columns_left.include?(column.alias) }
+          end
+
+          columns
         else
           owner.columns
         end

data/lib/big_record/dynamic_schema.rb

@@ -1,4 +1,3 @@
-# Replace the anonymous classes
 module BigRecord
   module DynamicSchema
 
@@ -9,12 +8,10 @@ module BigRecord
       base.alias_method_chain :attributes_from_column_definition, :dynamic_schema
       base.alias_method_chain :inspect, :dynamic_schema
       base.alias_method_chain :define_read_methods, :dynamic_schema
-
     end
 
     # Stub of the callback for setting the dynamic columns. Override this to add dynamic columns
     def initialize_columns(options={})
-
     end
 
     # Create and add a dynamic column to this record
@@ -23,10 +20,10 @@ module BigRecord
     end
 
     # Add an existing dynamic column to this record
-    def add_dynamic_column(c)
-      columns_hash[c.name] = c
+    def add_dynamic_column(col)
+      columns_hash[c.name] = col
       @columns_name= nil; @columns= nil #reset
-      c
+      col
     end
 
     def columns_hash

data/lib/big_record/migration.rb

@@ -1,19 +1,4 @@
-# require 'active_support/core_ext/object/metaclass'
-
-# Instead of requiring the activesupport class (metaclass)
-class Object
-  # Get object's meta (ghost, eigenclass, singleton) class
-  def metaclass
-    class << self
-      self
-    end
-  end
-
-  # If class_eval is called on an object, add those methods to its metaclass
-  def class_eval(*args, &block)
-    metaclass.class_eval(*args, &block)
-  end
-end
+require 'active_support/core_ext/object/metaclass'
 
 module BigRecord
   class IrreversibleMigration < BigRecordError#:nodoc:

data/lib/big_record/routing_ext.rb

@@ -35,31 +35,5 @@ module ActionController
       end
     end
   end
-
-  # TODO: Remove this monkey patch once we migrate to rails 2.3. This patch
-  # add support for the :as option in map.resources.
-  module Resources
-    class Resource
-
-      attr_reader :path_segment
-
-      def initialize(entities, options)
-        @plural   ||= entities
-        @singular ||= options[:singular] || plural.to_s.singularize
-        @path_segment = options.delete(:as) || @plural
-
-        @options = options
-
-        arrange_actions
-        add_default_actions
-        set_prefixes
-      end
-
-      def path
-        @path ||= "#{path_prefix}/#{path_segment}"
-      end
-
-    end
-  end
-
+ 
 end

data/lib/big_record/timestamp.rb

@@ -1,15 +1,15 @@
 module BigRecord
-  # Active Record automatically timestamps create and update if the table has fields
+  # Big Record 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
-  #   <tt>ActiveRecord::Base.record_timestamps = false</tt>
+  #   <tt>BigRecord::Base.record_timestamps = false</tt>
   #
   # Keep in mind that, via inheritance, you can turn off timestamps on a per
   # model basis by setting <tt>record_timestamps</tt> to false in the desired
   # models.
   #
-  #   class Feed < ActiveRecord::Base
+  #   class Feed < BigRecord::Base
   #     self.record_timestamps = false
   #     # ...
   #   end

data/lib/big_record/validations.rb

@@ -3,7 +3,7 @@ module BigRecord
   # record method to retrieve the record which did not validate.
   #   begin
   #     complex_operation_that_calls_save!_internally
-  #   rescue ActiveRecord::RecordInvalid => invalid
+  #   rescue BigRecord::RecordInvalid => invalid
   #     puts invalid.record.errors
   #   end
   class RecordInvalid < BigRecordError #:nodoc:

data/lib/big_record.rb

@@ -21,56 +21,42 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+dir = File.expand_path(File.join(File.dirname(__FILE__), "big_record"))
 
-unless defined?(ActiveSupport)
-  begin
-    $:.unshift(File.dirname(__FILE__) + "/../../activesupport/lib")
-    require 'active_support'
-  rescue LoadError
-    require 'rubygems'
-    gem 'activesupport'
-    require 'active_support'
-  end
+begin
+  require 'active_support'
+rescue LoadError
+  raise LoadError, "Bigrecord depends on ActiveSupport. Install it with: gem install activesupport"
 end
 
-unless defined?(ActiveRecord)
-  begin
-    $:.unshift(File.dirname(__FILE__) + "/../../activerecord/lib")
-    require 'active_record'
-  rescue LoadError
-    require 'rubygems'
-    gem 'activerecord'
-    require 'active_record'
-  end
+begin
+  require 'active_record'
+rescue LoadError
+  puts "[Bigrecord] ActiveRecord could not be loaded. Bigrecord associations with AR models disabled."
 end
 
-# FIXME: this shouldn't be required
-# require 'active_record/fixtures'
-
-require 'big_record/routing_ext'
-require 'big_record/abstract_base'
-require 'big_record/base'
-require 'big_record/embedded'
-require 'big_record/validations'
-require 'big_record/callbacks'
-require 'big_record/ar_reflection'
-require 'big_record/br_reflection'
-require 'big_record/ar_associations'
-require 'big_record/br_associations'
-require 'big_record/timestamp'
-require 'big_record/attribute_methods'
-require 'big_record/embedded_associations/association_proxy'
-require 'big_record/dynamic_schema'
-require 'big_record/deletion'
-require 'big_record/family_span_columns'
-require 'big_record/migration'
-require 'big_record/connection_adapters'
-require 'big_record/fixtures'
+require dir + '/routing_ext'
+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'
+require dir + '/br_associations'
+require dir + '/timestamp'
+require dir + '/attribute_methods'
+require dir + '/embedded_associations/association_proxy'
+require dir + '/dynamic_schema'
+require dir + '/deletion'
+require dir + '/family_span_columns'
+require dir + '/migration'
+require dir + '/connection_adapters'
+require dir + '/fixtures'
 
 # Add support for collections to tag builders
-require 'big_record/action_view_extensions'
+require dir + '/action_view_extensions'
 
 BigRecord::Base.class_eval do
   include BigRecord::Validations
@@ -99,12 +85,14 @@ BigRecord::Embedded.class_eval do
 end
 
 # Mixin the BigRecord associations with ActiveRecord
-ActiveRecord::Base.class_eval do
-  include BigRecord::BrAssociations
-  include BigRecord::BrReflection
+if defined?(ActiveRecord)
+  ActiveRecord::Base.class_eval do
+    include BigRecord::BrAssociations
+    include BigRecord::BrReflection
+  end
 end
 
-# Patch to call the validation of the embedded objects to HbaseRecord::Base instances.
+# Patch to call the validation of the embedded objects to BigRecord::Base instances.
 BigRecord::Base.class_eval do
   validate :validate_embeddeds
 

data/rails/init.rb

@@ -4,6 +4,12 @@ require 'big_record'
 BigRecord::Base.logger = ActiveRecord::Base.logger
 BigRecord::Embedded.logger = ActiveRecord::Base.logger
 
-# Establish the connection with the database
-BigRecord::Base.configurations = YAML::load(File.open("#{RAILS_ROOT}/config/bigrecord.yml"))
+# Load in the config from the RAILS_ROOT/config folder
+begin
+  BigRecord::Base.configurations = YAML::load(File.open("#{RAILS_ROOT}/config/bigrecord.yml"))
+rescue
+  puts "[Bigrecord] Couldn't load the config/bigrecord.yml config file. Please bootstrap it into your application with: script/generate bigrecord"
+end
+
+# Try establishing the connection
 BigRecord::Base.establish_connection