data_fabric 1.2.7 → 1.3.0

data/CHANGELOG

@@ -1,5 +1,12 @@
 DataFabric changelog
 
+v1.3.0 - 2010-11-22
+
+- Major implementation refactoring
+- Fix issues under Rails 3.0.  Tested with 2.3.10, 3.0.0 and 3.0.3.
+- Drop support for Rails 2.2 (may work but untested)
+- Remove jeweler dependency
+
 v1.2.7 - 2010-08-10
 
 - NO FUNCTIONAL CHANGES.

data/README.rdoc

@@ -21,6 +21,11 @@ then in config/environment.rb, add a config.gem entry:
     ...
     config.gem 'data_fabric'
 
+or add data_fabric to your Gemfile:
+
+  gem 'data_fabric'
+
+data_fabric has been tested with Rails 2.3.10, 3.0.0 and 3.0.3.
 
 == How does it work?
 
@@ -69,19 +74,17 @@ ActionController around_filter based on the user as follows:
 == Warnings
 
 * Sharded models should never be placed in the session store or you will get "Shard not set" errors when the session is persisted.
-* DataFabric does not support running with ActiveRecord's allow_concurrency = true in AR 2.0 and 2.1.  allow_concurrency is gone in AR 2.2.
 * DataFabric does not work in development mode with cache_classes = false.  You will get an error in ActiveRecord's clear_reloadable_connections! method.
 
 == Testing and Bug Reports
 
-If you think you've found a problem with data_fabric, please use the example application to reproduce the bug and send me the diff.  The example application is a stock Rails 2.1 application which uses data_fabric in the expected fashion.
+If you think you've found a problem with data_fabric, please use the example23 or example30 application to reproduce the bug and send me the diff.
 
 
 == Thanks to...
 
 Rick Olsen of Rails Core:: for the Masochism plugin, which showed me how to bend AR's connection handling to my will
 Bradley Taylor of RailsMachine:: for the advice to shard while at acts_as_conference
-FiveRuns:: for paying me to develop this code and allowing its release
 
 
 == Author
@@ -92,11 +95,9 @@ http://twitter.com/mperham
 
 
 == LICENSE:
- 
-(The FiveRuns License)
- 
-Copyright (c) 2008 FiveRuns Corporation
- 
+
+Copyright (c) 2010 Mike Perham
+
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
 'Software'), to deal in the Software without restriction, including

data/Rakefile

@@ -1,55 +1,21 @@
-require 'rubygems'
-
-begin
-  require './lib/data_fabric/version'
-  require 'jeweler'
-  Jeweler::Tasks.new do |p|
-    p.version = DataFabric::Version::STRING
-    p.authors = ["Mike Perham"]
-    p.email  = 'mperham@gmail.com'
-    p.summary = 'Sharding and replication support for ActiveRecord 2.x'
-    p.homepage = "http://github.com/mperham/data_fabric"
-    p.name = "data_fabric"
-    p.files =  FileList['*.rdoc', 'Rakefile', 'init.rb', 'CHANGELOG', "{lib,test,rails,example,example23}/**/*", ]
-    p.add_development_dependency 'jeweler'
-    p.add_development_dependency 'flexmock'
-  end
-rescue LoadError => le
-  puts "Jeweler, or one of its dependencies, is not available. Install it with: gem install jeweler: #{le.message}"
-end
+require 'fileutils'
+include FileUtils::Verbose
 
 require 'rake/testtask'
-
 Rake::TestTask.new do |t|
   t.verbose = true
-  t.libs << 'test' << 'rails'
+  t.libs << 'test'
   t.test_files = FileList['test/*_test.rb']
 end
 
-task :gemspec => [:clean]
-
 task :clean do
-  FileUtils.rm_f Dir['*.gem']
-  FileUtils.rm_f Dir['test/*.db']
-  FileUtils.rm_rf 'coverage'
-end
-
-desc "Install gem locally"
-task :installer do
-  sh "gem install data_fabric-*.gem"
-end
+  rm_f Dir['*.gem']
+  rm_f Dir['test/*.db']
+  rm_rf 'coverage'
 
-task :gem do
-  sh "gem build data_fabric.gemspec"
+  puts `cd example23 ; rake app:clean`
 end
 
-desc "Push gem to RubyForge"
-task :publish => [:clean, :gemspec, :gem, :installer] do
-  require './lib/data_fabric/version'
-  sh "gem push data_fabric-#{DataFabric::Version::STRING}.gem"
-end
-
-
 task :default => :test
 task :test => [:pretest]
 
@@ -80,6 +46,8 @@ def load_database_yml
 end
 
 def setup_connection
+  require 'erb'
+  require 'logger'
   require 'active_record'
   ActiveRecord::Base.configurations = load_database_yml
   ActiveRecord::Base.logger = Logger.new(STDOUT)

data/TESTING.rdoc

@@ -16,9 +16,9 @@ data_fabric ships with an example application which shows an actual Rails applic
 using data_fabric.  You can customize config/database.yml but by default it uses a local
 Sqlite3 database so there should be no customization necessary.
 
-Run the Rake task to prepare the application for testing.  This will copy the latest data_fabric code
-to vendor/plugins, delete existing databases and migrate all the databases from scratch.  You should
-then be able to run the example application's tests.
+Run the Rake task to prepare the application for testing.  This will delete existing SQLite
+databases and migrate all the databases from scratch.  You should then be able to run the
+example application's tests.
 
  cd example
  rake app:prepare

data/example23/Rakefile

@@ -13,28 +13,28 @@ require 'fileutils'
 include FileUtils::Verbose
 
 namespace :db do
-    task :migrate do
-      require 'erb'
-      require 'logger'
-      require 'active_record'
-      reference = YAML::load(ERB.new(IO.read("config/database.yml")).result)
-      env = RAILS_ENV = ENV['RAILS_ENV'] || 'development'
-      ActiveRecord::Base.logger = Logger.new(STDOUT)
-      ActiveRecord::Base.logger.level = Logger::WARN
-      ActiveRecord::Base.configurations = reference.dup
-      old_config = reference[env]
-      reference.each_key do |name|
-        next unless name.include? env
-        next if name.include? 'slave' # Replicated databases should not be touched directly
+  task :migrate do
+    require 'erb'
+    require 'logger'
+    require 'active_record'
+    reference = YAML::load(ERB.new(IO.read("config/database.yml")).result)
+    env = RAILS_ENV = ENV['RAILS_ENV'] || 'development'
+    ActiveRecord::Base.logger = Logger.new(STDOUT)
+    ActiveRecord::Base.logger.level = Logger::INFO
+    ActiveRecord::Base.configurations = reference.dup
+    old_config = reference[env]
+    reference.each_key do |name|
+      next unless name.include? env
+      next if name.include? 'slave' # Replicated databases should not be touched directly
 
-        puts "Migrating #{name}"
-        ActiveRecord::Base.clear_active_connections!
-        ActiveRecord::Base.configurations[env] = reference[name]
-        ActiveRecord::Base.establish_connection RAILS_ENV
-        ActiveRecord::Migration.verbose = ENV["VERBOSE"] ? ENV["VERBOSE"] == "true" : true
-        ActiveRecord::Migrator.migrate("db/migrate/", ENV["VERSION"] ? ENV["VERSION"].to_i : nil)
-      end
+      puts "Migrating #{name}"
+      ActiveRecord::Base.clear_active_connections!
+      ActiveRecord::Base.configurations[env] = reference[name]
+      ActiveRecord::Base.establish_connection RAILS_ENV
+      ActiveRecord::Migration.verbose = ENV["VERBOSE"] ? ENV["VERBOSE"] == "true" : true
+      ActiveRecord::Migrator.migrate("db/migrate/", ENV["VERSION"] ? ENV["VERSION"].to_i : nil)
     end
+  end
 end
 
 task :default => :test
@@ -50,18 +50,19 @@ namespace :app do
   task :prepare => [:clean, :copy_plugin, :migrate]
 
   task :copy_plugin do
-    mkdir_p 'vendor/plugins/data_fabric'
-    cp_r '../lib', 'vendor/plugins/data_fabric'
-    cp '../init.rb', 'vendor/plugins/data_fabric'
+    mkdir_p 'vendor/gems/data_fabric-1.0.0'
+    cp_r '../lib', 'vendor/gems/data_fabric-1.0.0'
   end
 
   task :clean do
-    rm_rf 'vendor/plugins/data_fabric'
-    rm_f 'db/*.sqlite3'
+    rm_rf 'log'
+    rm_rf 'vendor/gems/data_fabric-1.0.0'
+    rm_rf Dir['db/*.sqlite3']
+    rm_f 'db/schema.rb'
   end
 
 	task :migrate do
-		sh "rake db:migrate"
-		sh "rake RAILS_ENV=test db:migrate"
+		puts `rake db:migrate --trace`
+		puts `rake RAILS_ENV=test db:migrate`
 	end
 end

data/example23/config/environment.rb

@@ -5,7 +5,7 @@
 # ENV['RAILS_ENV'] ||= 'production'
 
 # Specifies gem version of Rails to use when vendor/rails is not present
-#RAILS_GEM_VERSION = '2.2.2' unless defined? RAILS_GEM_VERSION
+RAILS_GEM_VERSION = '2.3.10' unless defined? RAILS_GEM_VERSION
 
 # Bootstrap the Rails environment, frameworks, and default configuration
 require File.join(File.dirname(__FILE__), 'boot')
@@ -28,6 +28,8 @@ Rails::Initializer.run do |config|
   # config.gem "sqlite3-ruby", :lib => "sqlite3"
   # config.gem "aws-s3", :lib => "aws/s3"
 
+  config.gem 'data_fabric', :version => '1.0.0'
+
   # Only load the plugins named here, in the order given. By default, all plugins 
   # in vendor/plugins are loaded in alphabetical order.
   # :all can be used as a placeholder for all plugins not explicitly named
@@ -55,7 +57,7 @@ Rails::Initializer.run do |config|
   # Make sure the secret is at least 30 characters and all random, 
   # no regular words or you'll be exposed to dictionary attacks.
   config.action_controller.session = {
-    :key => '_example22_session',
+    :key => '_example23_session',
     :secret      => 'a726ae17b1f84e51e5ae5f8bc861a92dcffb188a7a1e9cb88c0c513ce9722b0983ee718c79741260669bfbc69b68044129fc11d8792b90fa912d719992cb9574'
   }
 

data/example30/Gemfile

@@ -0,0 +1,5 @@
+source 'http://rubygems.org'
+
+gem 'rails', '3.0.3'
+gem 'sqlite3-ruby', :require => 'sqlite3'
+gem 'data_fabric', :path => '..'

data/example30/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: ..
+  specs:
+    data_fabric (1.3.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.3)
+      actionpack (= 3.0.3)
+      mail (~> 2.2.9)
+    actionpack (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.6)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+    activesupport (3.0.3)
+    arel (2.0.4)
+    builder (2.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.4.1)
+    mail (2.2.10)
+      activesupport (>= 2.3.6)
+      i18n (~> 0.4.1)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.6)
+      rack (>= 1.0)
+    rails (3.0.3)
+      actionmailer (= 3.0.3)
+      actionpack (= 3.0.3)
+      activerecord (= 3.0.3)
+      activeresource (= 3.0.3)
+      activesupport (= 3.0.3)
+      bundler (~> 1.0)
+      railties (= 3.0.3)
+    railties (3.0.3)
+      actionpack (= 3.0.3)
+      activesupport (= 3.0.3)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    sqlite3-ruby (1.3.1)
+    thor (0.14.4)
+    treetop (1.4.8)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  data_fabric!
+  rails (= 3.0.3)
+  sqlite3-ruby

data/example30/README

@@ -0,0 +1,256 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.find(:all)
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.com/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |   |-- images
+  |   |-- javascripts
+  |   `-- stylesheets
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Contains subdirectories for
+  images, stylesheets, and javascripts. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.