vpd 0.0.1

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+
+
+#gem 'rails', '~> 3.0.7'
+gem 'activesupport', '~> 3.0.7'
+gem 'activerecord', '~> 3.0.7'
+gem 'pg', '~> 0.11.0'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,38 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.7)
+      activesupport (= 3.0.7)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.7)
+      activemodel (= 3.0.7)
+      activesupport (= 3.0.7)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.7)
+    arel (2.0.9)
+    builder (2.1.2)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    pg (0.11.0)
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+    tzinfo (0.3.26)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.0.7)
+  activesupport (~> 3.0.7)
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  pg (~> 0.11.0)
+  rcov
+  shoulda

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Paul Gallagher
+
+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
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,76 @@
+= vpd
+
+Virtual Private Database for Rails
+
+This is a quick gemification of the schema partitioning solution for multi-tenancy support in Rails.
+It is EXPERIMENTAL and currently specific to PostgreSQL.
+
+It requires Rails 3.0.7+ and pg 0.11.0+.
+
+The schema partitioning approach is described by Guy Naor in his definitive presentation:
+
+== What it does
+
+* patches the postgresql adapter so it is possible to run your rails migrations into a specific schema
+* adds helper methods for activating a selected schema
+
+== How to use it
+
+To install, add to your Gemfile:
+
+  gem 'vpd'
+
+and run bundle install.
+
+Once installed, it provides a number of methods to setup and switch between schemas.
+
+=== Vpd.activate(schema,verify_migration = false)
+
+This is the main method to switch to a specified schema.
+If you pass true for verify_migration, it will create the schema if necessary
+and make sure your rails migrations (in that schema) are up-to-date.
+
+How do you know which schema to switch to? Well, that's up to you .. could be
+on the basis of the request subdomain, or the an attribute of the current_user.
+  
+e.g. we might do this in a before_filter of our ApplicationController...
+
+  # this may evaluate to 'my_company' for example ..
+  schema_to_use = request.subdomains.last
+  if schema_to_use.present?
+    # now activate the schema
+    Vpd.activate(schema_to_use,true)
+  else
+    # ensure we are running with the default
+    Vpd.activate_default
+  end
+
+=== Vpd.activate_default
+Returns to default schema search path. This will either be '"$user",public' (postgres default)
+or the schema_search_path setting from your database.yml
+
+=== and a bunch of other methods #nodoc
+
+
+== What it doesn't do / things to do
+
+* Provide some syntactic sugar to allow migrations to be selectively included/excluded
+* Genericise the approach to support other db backends
+* Useful tests to ensure this isn't breaking soemthing in Rails that I haven't noticed yet
+* Find a way to do this without monkey-patching
+* Better documentation
+
+== Contributing to vpd
+ 
+* 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.
+
+== Copyright
+
+Copyright (c) 2011 Paul Gallagher. See LICENSE for further details.
+

data/Rakefile

@@ -0,0 +1,61 @@
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+$LOAD_PATH << './lib'
+require 'vpd'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+    gem.name = %q{vpd}
+    gem.version = Vpd::VERSION
+    gem.homepage = %q{http://github.com/tardate/vpd}
+    gem.license = "MIT"
+    gem.summary = %Q{virtual private database for rails}
+    gem.description = %Q{implements schema partitioning for multi-tenancy support in rails.
+      Currently only supports PostgreSQL and is officially "experimental"!}
+    gem.email = "paul@evendis.com"
+    gem.authors = ["Paul Gallagher"]
+    # Include your dependencies below. Runtime dependencies are required when using your gem,
+    # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+    #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+    #  gem.add_development_dependency 'rspec', '> 1.2.3'
+  end
+  Jeweler::RubygemsDotOrgTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "vpd #{Vpd::VERSION}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb

@@ -0,0 +1 @@
+require 'vpd'

data/lib/vpd.rb

@@ -0,0 +1,3 @@
+require 'vpd/version'
+require 'vpd/postgresql_adapter'
+require 'vpd/base'

data/lib/vpd/base.rb

@@ -0,0 +1,42 @@
+module Vpd
+
+  # record the initial schema_search_path
+  def self.initial_search_path
+    @@initial_search_path ||= YAML::load(File.open('config/database.yml'))[Rails.env]["schema_search_path"]
+    @@initial_search_path ||= '"$user",public'
+  end
+
+  # creates +schema+ and optionally runs rails migrations to it
+  def self.create(schema,and_migrate = true)
+    conn = ActiveRecord::Base.connection
+    conn.execute("CREATE SCHEMA #{schema}") unless conn.schema_exists? schema
+    self.migrate(schema) if and_migrate
+  end
+
+  # runs rails migrations into +schema+
+  # preserves the current schema search path
+  def self.migrate(schema, to_version = nil)
+    conn = ActiveRecord::Base.connection
+    return false unless conn.schema_exists? schema
+    current_search_path = conn.schema_search_path
+    conn.schema_search_path = schema
+    ActiveRecord::Migrator.migrate('db/migrate', to_version)
+    conn.schema_search_path = current_search_path
+  end
+
+  # prepends +schema+ to the schema search path
+  # if verify_migration is true, will create the schema if required
+  # and ensure that it is migrated up-to-date
+  def self.activate(schema,verify_migration = false)
+    base_path = self.initial_search_path
+    self.create(schema) if verify_migration
+    conn = ActiveRecord::Base.connection
+    return false unless conn.schema_exists?(schema)
+    conn.schema_search_path = [schema, base_path].compact.join(',')
+  end
+
+  def self.activate_default
+    ActiveRecord::Base.connection.schema_search_path = self.initial_search_path
+  end
+
+end

data/lib/vpd/postgresql_adapter.rb

@@ -0,0 +1,61 @@
+require 'active_record'
+require 'active_record/base'
+require 'active_record/connection_adapters/postgresql_adapter'
+
+module ActiveRecord
+  module ConnectionAdapters
+    class PostgreSQLAdapter
+
+      # get the current schema
+      def current_schema
+        query('SELECT current_schema', 'SCHEMA')[0][0]
+      end
+
+      # tests it +name+ schema exists
+      def schema_exists?(name)
+        query(<<-SQL).first[0].to_i > 0
+            SELECT COUNT(*)
+            FROM pg_namespace
+            WHERE nspname = '#{name.gsub(/(^"|"$)/,'')}'
+        SQL
+      end
+
+      # Overrides ActiveRecord::ConnectionAdapters::PostgreSQLAdapter#table_exists?
+      # Change to only look in the current schema - unless schema is specified in the name
+      # This is required to enable rails migrations to run into the currently selected schema
+      def table_exists?(name)
+        schema, table = extract_schema_and_table(name.to_s)
+        schema ||= current_schema
+
+        binds = [[nil, table.gsub(/(^"|"$)/,'')]]
+        binds << [nil, schema] if schema
+
+        query(<<-SQL, 'SCHEMA').first[0].to_i > 0
+            SELECT COUNT(*)
+            FROM pg_tables
+            WHERE tablename = '#{table.gsub(/(^"|"$)/,'')}'
+            #{schema ? "AND schemaname = '#{schema}'" : ''}
+        SQL
+      end
+
+      # Extracts the table and schema name from +name+
+      # - copied from HEAD but not in 3.0.7 yet
+      def extract_schema_and_table(name)
+        schema, table = name.split('.', 2)
+
+        unless table # A table was provided without a schema
+          table  = schema
+          schema = nil
+        end
+
+        if name =~ /^"/ # Handle quoted table names
+          table  = name
+          schema = nil
+        end
+        [schema, table]
+      end
+
+    end
+  end
+end
+

data/lib/vpd/version.rb

@@ -0,0 +1,3 @@
+module Vpd
+  VERSION = "0.0.1"
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'vpd'
+
+class Test::Unit::TestCase
+end

data/test/test_vpd.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestVpd < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/vpd.gemspec

@@ -0,0 +1,76 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{vpd}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Paul Gallagher"]
+  s.date = %q{2011-04-22}
+  s.description = %q{implements schema partitioning for multi-tenancy support in rails.
+      Currently only supports PostgreSQL and is officially "experimental"!}
+  s.email = %q{paul@evendis.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "init.rb",
+    "lib/vpd.rb",
+    "lib/vpd/base.rb",
+    "lib/vpd/postgresql_adapter.rb",
+    "lib/vpd/version.rb",
+    "test/helper.rb",
+    "test/test_vpd.rb",
+    "vpd.gemspec"
+  ]
+  s.homepage = %q{http://github.com/tardate/vpd}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{virtual private database for rails}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_vpd.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, ["~> 3.0.7"])
+      s.add_runtime_dependency(%q<activerecord>, ["~> 3.0.7"])
+      s.add_runtime_dependency(%q<pg>, ["~> 0.11.0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, ["~> 3.0.7"])
+      s.add_dependency(%q<activerecord>, ["~> 3.0.7"])
+      s.add_dependency(%q<pg>, ["~> 0.11.0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, ["~> 3.0.7"])
+    s.add_dependency(%q<activerecord>, ["~> 3.0.7"])
+    s.add_dependency(%q<pg>, ["~> 0.11.0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification 
+name: vpd
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Paul Gallagher
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-22 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 7
+        version: 3.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 7
+        version: 3.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: pg
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 11
+        - 0
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id007
+description: |-
+  implements schema partitioning for multi-tenancy support in rails.
+        Currently only supports PostgreSQL and is officially "experimental"!
+email: paul@evendis.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- init.rb
+- lib/vpd.rb
+- lib/vpd/base.rb
+- lib/vpd/postgresql_adapter.rb
+- lib/vpd/version.rb
+- test/helper.rb
+- test/test_vpd.rb
+- vpd.gemspec
+has_rdoc: true
+homepage: http://github.com/tardate/vpd
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 1832961237987341343
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: virtual private database for rails
+test_files: 
+- test/helper.rb
+- test/test_vpd.rb