secondbase 0.6.0 → 1.0.0

data/.document

@@ -1,5 +0,0 @@
-lib/**/*.rb
-bin/*
-- 
-features/**/*.feature
-LICENSE.txt

data/Gemfile.lock

@@ -1,38 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    activemodel (3.0.0)
-      activesupport (= 3.0.0)
-      builder (~> 2.1.2)
-      i18n (~> 0.4.1)
-    activerecord (3.0.0)
-      activemodel (= 3.0.0)
-      activesupport (= 3.0.0)
-      arel (~> 1.0.0)
-      tzinfo (~> 0.3.23)
-    activesupport (3.0.0)
-    arel (1.0.1)
-      activesupport (~> 3.0.0)
-    builder (2.1.2)
-    git (1.2.5)
-    i18n (0.4.1)
-    jeweler (1.8.4)
-      bundler (~> 1.0)
-      git (>= 1.2.5)
-      rake
-      rdoc
-    json (1.7.5)
-    rake (0.9.2.2)
-    rdoc (3.12)
-      json (~> 1.4)
-    shoulda (2.11.1)
-    tzinfo (0.3.23)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activerecord (~> 3.0.0)
-  bundler (>= 1.0.0)
-  jeweler (~> 1.8.2)
-  shoulda

data/README.rdoc

@@ -1,143 +0,0 @@
-= secondbase
-
-SecondBase adds a second database to your application.  While Rails enables you to establish connections to as many external databases as you like, Rails can only manage a single database with it's migration and testing tasks.
-
-SecondBase enables Rails to work with, and manage, a second database (almost) transparently.  As a developer, you should not even realize a second database is in play.  Core rake tasks such as rake db:create, rake db:migrate, and rake test will continue to work seamlessly with both databases without you, the developer, having to run any extra rake tasks.
-
-SecondBase works with Rails 2.3.x and 3.0.x.  I've not tried to use SecondBase with Rails 3.1 yet, although someone has submitted a pull request fixing a 3.1 issue, so I assume it's working OK?
-
-== Contributing to SecondBase
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== System Requirements
-SecondBase now supports Rails 2.x and Rails 3.x.
-
-== Installation
-Modify your Gemfile to include SecondBase:
-  
-  gem 'secondbase', '0.5.0'
-
-Run `bundle install`.  You thought it would be harder?  If you're using Rails 2.x, then yes, a little bit harder.  You must also add this to your Rakefile:
-
-  require 'secondbase/tasks' if defined?(SecondBase)
-
-PLEASE NOTE that if you are using bundler with Rails 2.x, then you simply need to add this to your Rakefile:
-
-  require 'secondbase/tasks'
-  
-== Usage
-=== Database
-Configure your database.yml to define your SecondBase:
-
-  # Your normal rails definitions...
-  development:
-    adapter: mysql  #postgres, oracle, etc
-    encoding: utf8
-    database: development
-  
-  test:
-    adapter: mysql  #postgres, oracle, etc
-    encoding: utf8
-    database: test
-      
-  # Your secondbase database configurations...
-  secondbase:
-    development:
-      adapter: mysql
-      encoding: utf8
-      database: secondbase_development
-
-    test:
-      adapter: mysql
-      encoding: utf8
-      database: secondbase_test
-
-
-=== Migrations
-SecondBase comes with a generator to assist in managing your migrations
-
-Rails 3.x:
-  rails generator secondbase:migration CreateWidgetsTable
-
-Rails 2.x:
-  script/generate secondbase_migration CreateWidgetsTable
-    
-The generator will organize your second (data)base migrations alongside of your primary database.  The above command will generate the file:
-
-  db/migrate/secondbase/20101203211338_create_widgets_table.rb
-  
-To run your migrations, simply run:
-
-  rake db:migrate
-  
-This will migrate your first and second (data)bases.  If, for some reason, you only want to migrate your second (data)base, run:
-
-  rake db:migrate:secondbase
-  
-Please note that migrating up and migrating down must be done specifically on your first or second (data)base.  As usual, to migrate your first (data)base up or down to version 20101203211338, you could run:
-
-  rake db:migrate:up VERSION=20101005311335
-  rake db:migrate:down VERSION=20101005311335
-
-To migrate your second (data)base up or down to version 20101203211338, you would run:
-
-  rake db:migrate:up:secondbase VERSION=20101203211338
-  rake db:migrate:down:secondbase VERSION=20101203211338
-
-
-=== Models
-Every model in your project that extends ActiveRecord::Base will point to the database defined by Rails.env.  This is the default Rails behavior and should be of no surprise to you.  So how do we point our models to the second (data)base?
-
-SecondBase offers a base model that you can simply extend:
-  
-  require 'secondbase/model'
-  
-  class Widget < SecondBase::Base
-    # you're Widget model is now pointing to your second (data)base table 'widgets'
-  end
-
-ActiveRecord associations will still work between your Firstbase and SecondBase models!
-
-  # Notice how normal this all looks...
-  class User < ActiveRecord::Base
-    has_many :widgets
-  end
-
-=== Rake Tasks & Custom Classes
-If you need to write rake tasks, or some other code that does not extend ActiveRecord, you can simply establish a connection to your second (data)base:
-
-  SecondBase::has_runner(Rails.env)
-  
-Please note that this is equivalent to using ActiveRecord::Base.establish_connection(config) and will reset the base connection of your ENTIRE application.  No worries, to move the runner back to first you can use:
-
-  FirstBase::has_runner(Rails.env)
-
-=== Testing
-Tests can still be run using `rake test` or `rake test:units`, etc.  However, if you are using fixtures, you will need to update your TestHelper class to include:
-
-  require 'secondbase/fixtures'
-  
-This is patch to fixtures that will identify the fixtures which belong to models that extend SecondBase::Base.  The patch will then ensure that the table descendants of SecondBase::Base get loaded into your second test (data)base.
-
-At this time, I can verify that SecondBase works with Fixtures, Machinist and FactoryGirl.  Conceivably, other test factories should work, but there is currently no support for this.  If you have the time to update this gem to be test object compatible, by all means...
-
-== TODO
-- Migration generator in Rails 3.x needs support for attribute generation (similar to rails generate migration).  For example:
-  `rails generate secondbase:migration AddTitleBodyToPost title:string body:text published:boolean`
-
-- rake db:fixtures:load is currently broken.  Like many other things I have fixed, it assumes you only one a single database and attempts to load all fixtures into it.  I don't believe we can get away with alias chaining this one, I think (like the Fixtures class), we'll have to freedom patch it.
-
-- TESTS!!  Not 100% sure how to test the rake tasks, but I can definitely write tests for the classes and generators. I did this in my spare time, sorry...
-
-== Copyright
-
-Copyright (c) 2010 karledurante. See LICENSE.txt for
-further details.
-

data/lib/generators/secondbase/USAGE

@@ -1,19 +0,0 @@
-Description:
-    Stubs out a new (second)database migration. Pass the migration name, either
-    CamelCased or under_scored, and an optional list of attribute pairs as arguments.
-
-    For your organizational convenience, a migration class is generated in 
-    db/migrate/secondbase prefixed by a timestamp of the current date and time.
-
-    You can name your migration in either of these formats to generate add/remove
-    column lines from supplied attributes: AddColumnsToTable or RemoveColumnsFromTable
-
-Example:
-    `rails generate secondbase:migration AddSslFlag`
-
-    If the current date is May 14, 2008 and the current time 09:09:12, this creates the AddSslFlag migration
-    db/migrate/secondbase/20080514090912_add_ssl_flag.rb
-
-    You can continue to use `rake db:migrate` to migrate your first and second databases, or you can 
-    target secondbase by using `rake db:migrate:secondbase`.  Remember, your migrations are timestamped, 
-    so regardless of the database they target, they will be unique and you will not have collision issues.

data/lib/generators/secondbase/migration_generator.rb

@@ -1,36 +0,0 @@
-require 'rails/generators'
-require 'rails/generators/migration'
-require 'active_record'
-
-module Secondbase
-  class MigrationGenerator < Rails::Generators::NamedBase
-    include Rails::Generators::Migration
-
-    def self.source_root
-      File.join(File.dirname(__FILE__), 'templates')
-    end
-
-     # Implement the required interface for Rails::Generators::Migration.
-     # taken from http://github.com/rails/rails/blob/master/activerecord/lib/generators/active_record.rb
-    def self.next_migration_number(dirname) #:nodoc:
-      if ActiveRecord::Base.timestamped_migrations
-        Time.now.utc.strftime("%Y%m%d%H%M%S")
-      else
-        "%.3d" % (current_migration_number(dirname) + 1)
-      end
-    end
-
-    def create_migration_file
-      migration_template 'migration.rb', 
-                          "db/migrate/#{SecondBase::CONNECTION_PREFIX}/#{class_name.underscore}.rb", 
-                          :assigns => get_local_assigns
-    end
-    
-    private 
-    # TODO: We need to add support for name/value pairs like title:string dob:date etc..
-    def get_local_assigns
-      { :class_name => class_name }
-    end
-        
-  end
-end

data/lib/generators/secondbase/templates/migration.rb

@@ -1,13 +0,0 @@
-class <%= class_name.underscore.camelize %> < ActiveRecord::Migration
-  ############################################################
-  # Database migration targeting the SecondBase!
-  # Generated using: rails generator secondbase:migration [MigrationName]
-  
-  def self.up
-    
-  end
-
-  def self.down
-    
-  end
-end

data/lib/secondbase/active_record/associations/has_and_belongs_to_many_association.rb

@@ -1,66 +0,0 @@
-module ActiveRecord
-  # = Active Record Has And Belongs To Many Association
-  module Associations
-    class HasAndBelongsToManyAssociation < AssociationCollection 
-      
-      # determines the appropriate engine for the join table's parent klass
-      def arel_engine
-        Arel::Sql::Engine.new(@reflection.klass.engine)
-      end
-      
-      # This method is entirely replicated, except for line 25.  We simply
-      # need to pass in the appropriate engine to Arel.  
-      def insert_record(record, force = true, validate = true)
-        if record.new_record?
-          if force
-            record.save!
-          else
-            return false unless record.save(:validate => validate)
-          end
-        end
-
-        if @reflection.options[:insert_sql]
-          @owner.connection.insert(interpolate_and_sanitize_sql(@reflection.options[:insert_sql], record))
-        else
-          relation   = Arel::Table.new(@reflection.options[:join_table], arel_engine)
-          timestamps = record_timestamp_columns(record)
-          timezone   = record.send(:current_time_from_proper_timezone) if timestamps.any?
-
-          attributes = Hash[columns.map do |column|
-            name = column.name
-            value = case name.to_s
-              when @reflection.primary_key_name.to_s
-                @owner.id
-              when @reflection.association_foreign_key.to_s
-                record.id
-              when *timestamps
-                timezone
-              else
-                @owner.send(:quote_value, record[name], column) if record.has_attribute?(name)
-            end
-            [relation[name], value] unless value.nil?
-          end]
-
-          relation.insert(attributes)
-        end
-
-        return true
-      end
-      
-      # This method is entirely replicated, except for line 57.  We simply
-      # need to pass in the appropriate engine to Arel.
-      def delete_records(records)
-        if sql = @reflection.options[:delete_sql]
-          records.each { |record| @owner.connection.delete(interpolate_and_sanitize_sql(sql, record)) }
-        else
-
-          relation = Arel::Table.new(@reflection.options[:join_table], arel_engine)
-          
-          relation.where(relation[@reflection.primary_key_name].eq(@owner.id).
-            and(relation[@reflection.association_foreign_key].in(records.map { |x| x.id }.compact))
-          ).delete
-        end
-      end
-    end
-  end
-end

data/lib/secondbase/active_record/base.rb

@@ -1,13 +0,0 @@
-module ActiveRecord
-  class Base
-    
-    # Arel is concerned with "engines".  Normally the engine defaults to the primary
-    # connection (ActiveRecord::Base).  This will let us easily override the engine 
-    # when dealing with Seoncdbase models (deep in ActiveRecord code).
-    # Since SecondBase::Base inherits from ActiveRecord::Base, this will pass the
-    # right engine around.
-    def self.engine
-      self
-    end
-  end
-end

data/lib/secondbase/active_record/fixtures.rb

@@ -1,66 +0,0 @@
-###########################
-# Monkey patch Fixtures
-# Fixtures needs to load fixtures into the database defined by the parent class!
-#
-# I feel like the concepts here could be incorporated directly into Fixtures. 
-# I mean, they shouldn't be so presumptions to think that every model lives in the 
-# same database....
-class Fixtures < (RUBY_VERSION < '1.9' ? YAML::Omap : Hash)
-  def self.create_fixtures(fixtures_directory, table_names, class_names = {})
-    table_names = [table_names].flatten.map { |n| n.to_s }
-    table_names.each { |n| class_names[n.tr('/', '_').to_sym] = n.classify if n.include?('/') }
-    connection  = block_given? ? yield : ActiveRecord::Base.connection
-    
-    # make sure we only load secondbase tables that have fixtures defined...
-    sb_table_names = SecondBase::Base.send(:descendants).map(&:table_name)
-    sb_table_names = sb_table_names & table_names
-    sb_connection = SecondBase::Base.connection                          
-    
-    # filter out the secondbase tables from firstbase, otherwise we'll get SQL errors...
-    table_names_to_fetch = table_names.reject { |table_name| fixture_is_cached?(connection, table_name) || sb_table_names.include?(table_name) }
-    fixtures = process_fixture_table_names(table_names_to_fetch, class_names, connection, fixtures_directory)
-    fixtures = [fixtures] if !fixtures.instance_of?(Array)
-    
-    sb_table_names_to_fetch = sb_table_names.reject { |table_name| fixture_is_cached?(sb_connection, table_name)}
-    sb_fixtures = process_fixture_table_names(sb_table_names_to_fetch, class_names, sb_connection, fixtures_directory)
-    sb_fixtures = [sb_fixtures] if !sb_fixtures.instance_of?(Array)
-    
-    (fixtures + sb_fixtures).compact
-  end
-  
-  def self.process_fixture_table_names(table_names_to_fetch, class_names, connection, fixtures_directory)
-    fixtures_map = {}
-    unless table_names_to_fetch.empty?
-      ActiveRecord::Base.silence do
-        connection.disable_referential_integrity do
-          # fixtures_map = {}
-
-          fixtures = table_names_to_fetch.map do |table_name|
-            obj = Fixtures.new(connection, table_name.tr('/', '_'), class_names[table_name.tr('/', '_').to_sym], File.join(fixtures_directory, table_name))
-            fixtures_map[table_name] = obj
-          end
-
-          all_loaded_fixtures.update(fixtures_map)
-
-          connection.transaction(:requires_new => true) do
-            fixtures.reverse.each { |fixture| fixture.delete_existing_fixtures }
-            fixtures.each { |fixture| fixture.insert_fixtures }
-
-            # Cap primary key sequences to max(pk).
-            if connection.respond_to?(:reset_pk_sequence!)
-              table_names_to_fetch.each do |table_name|
-                connection.reset_pk_sequence!(table_name.tr('/', '_'))
-              end
-            end
-          end
-
-          cache_fixtures(connection, fixtures_map)
-        end
-      end
-    end
-    
-    table_names_to_fetch = nil if table_names_to_fetch.blank?
-    cached_fixtures(connection, table_names_to_fetch)
-  end
-
-end

data/lib/secondbase/active_record/patches.rb

@@ -1,13 +0,0 @@
-####################
-## ActiveRecord patches for all versions of rails
-require 'secondbase/active_record/base'
-
-
-####################
-## ActiveRecord patches for specific versions of rails
-if Rails.env.test?
-  require 'secondbase/active_record/fixtures'
-  require 'secondbase/active_record/test_fixtures' 
-end
-
-require 'secondbase/active_record/associations/has_and_belongs_to_many_association' 

data/lib/secondbase/active_record/test_fixtures.rb

@@ -1,32 +0,0 @@
-## ActiveRecord::TestFixtures
-## Monkey patch active record's test_fixtures module to manage
-## transactions for the SecondBase
-module ActiveRecord
-  module TestFixtures
-    alias_method :original_setup_fixtures, :setup_fixtures
-    alias_method :original_teardown_fixtures, :teardown_fixtures
-    
-    def setup_fixtures
-      original_setup_fixtures
-      # start tx for secondbase, if required
-      # Load fixtures once and begin transaction.
-      if run_in_transaction?
-        SecondBase::Base.connection.increment_open_transactions
-        SecondBase::Base.connection.transaction_joinable = false
-        SecondBase::Base.connection.begin_db_transaction
-      end
-    end
-    
-    def teardown_fixtures
-      original_teardown_fixtures
-      
-      # Rollback secondbase changes if a transaction is active.
-      if run_in_transaction? && SecondBase::Base.connection.open_transactions != 0
-        SecondBase::Base.connection.rollback_db_transaction
-        SecondBase::Base.connection.decrement_open_transactions
-      end
-      
-      SecondBase::Base.clear_active_connections!
-    end
-  end
-end