storey 0.0.1

data/.gitignore

@@ -0,0 +1,12 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.swp
+**/*.swp
+*.swo
+**/*.swo
+spec/config/database.yml
+spec/dummy/config/database.yml
+spec/dummy/log/*
+spec/dummy/tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in storey.gemspec
+gemspec

data/README.md

@@ -0,0 +1,83 @@
+# Storey
+
+Storey is used to manage multiple schemas in your multi-tenant Rails application.
+
+Heavily inspired by the Apartment gem, Storey simplifies the implementation of managing a multi-tenant application. This simplifies things by doing away with the other implementations that Apartment has - like MysqlAdapter and managing multiple databases (instead of managing multiple schemas) which complicated development and testing.
+
+# Configuration
+
+Typically set in an initializer: config/initializer/storey.rb
+
+    # Defines the tables that should stay available to all (ie in the public schema)
+    Storey.excluded_tables = %w(users companies)
+
+    # If set, all schemas are created with the suffix.
+    # Used for obscuring the schema name - which is important when performing schema duplication.
+    # Storey.suffix = "_suffix"
+
+# Methods
+
+## schemas
+
+Returns all schemas except postgres' schemas.
+
+Accepts options:
+
+    :exclude_public => true
+
+Usage:
+
+    Storey.schemas
+    Storey.schemas(:exclude_public => true)
+
+## create
+
+Accepts:
+
+    String - name of schema
+
+Usage:
+
+    Storey.create "schema_name"
+
+## drop
+
+Accepts
+
+    String - name of schema
+
+Usage:
+
+    Storey.drop "schema_name"
+
+## switch
+
+Accepts
+
+    String - optional - schema name
+    Block - optional
+
+If a block is passed, Storey will execute the block in the specified schema name. Then, it will switch back to the schema it was previously in.
+
+Usage:
+
+    Storey.switch "some_other_schema"
+    Post.create "My new post"
+    Storey.switch # switch back to the original schema
+
+    Storey.switch "some_other_schema" do
+      Post.create "My new post"
+    end
+
+## duplicate!(origin, copy)
+
+Accepts
+
+    origin - name of old schema to copy
+    copy - name of new schema
+
+Copies a schema with all data under a new name.
+
+Usage:
+
+    Storey.duplicate!("original_schema", "new_schema")

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end

data/lib/storey/duplicator.rb

@@ -0,0 +1,61 @@
+class Storey::Duplicator
+  DUMP_PATH        = File.join Rails.root, 'tmp', 'schema_dumps'
+  SOURCE_DUMP_PATH = File.join DUMP_PATH, 'source'
+  TARGET_DUMP_PATH = File.join DUMP_PATH, 'target'
+
+  attr_accessor :source_schema, :target_schema, :source_file, :target_file
+
+  def initialize(from_schema, to_schema)
+    self.source_schema = Storey.suffixify from_schema
+    self.target_schema = Storey.suffixify to_schema
+    self.source_file   = File.join SOURCE_DUMP_PATH, "#{Time.now.to_i}_#{self.source_schema}.sql"
+    self.target_file   = File.join TARGET_DUMP_PATH, "#{Time.now.to_i}_#{self.target_schema}.sql"
+  end
+
+  def perform!
+    dump_schema
+    replace_occurances
+    load_schema
+  end
+
+  private
+
+  def dump_schema(options={})
+    ENV['PGPASSWORD'] = Storey.database_config[:password]
+    prepare_schema_dump_directories
+
+    options[:host]     ||= Storey.database_config[:host] unless Storey.database_config[:host].blank?
+    options[:username] ||= Storey.database_config[:username]
+    options[:file]     ||= self.source_file
+    options[:schema]   ||= self.source_schema
+
+    switches = options.map { |k, v| "--#{k}=#{v}" }.join(" ")
+
+    `pg_dump #{switches} #{Storey.database_config[:database]}`
+  end
+
+  def prepare_schema_dump_directories
+    [SOURCE_DUMP_PATH, TARGET_DUMP_PATH].each { |d| FileUtils.mkdir_p(d) }
+  end
+
+  def load_schema(options={})
+    options[:host]     ||= Storey.database_config[:host] unless Storey.database_config[:host].blank?
+    options[:dbname]   ||= Storey.database_config[:database]
+    options[:username] ||= Storey.database_config[:username]
+    options[:file] ||= self.target_file
+
+    switches = options.map { |k, v| "--#{k}=#{v}" }.join(" ")
+
+    `psql #{switches}`
+    ENV['PGPASSWORD'] = nil
+  end
+
+  def replace_occurances
+    File.open(self.source_file, 'r') do |file|
+      file.each_line do |line|
+        new_line = line.gsub(/#{self.source_schema}/, self.target_schema)
+        File.open(self.target_file, 'a') {|tf| tf.puts new_line}
+      end
+    end
+  end
+end

data/lib/storey/exceptions.rb

@@ -0,0 +1,6 @@
+module Storey
+  class StoreyError < StandardError; end
+  class SchemaExists < StoreyError; end
+  class SchemaNotFound < StoreyError; end
+  class TableNotFOund < StoreyError; end
+end

data/lib/storey/migrator.rb

@@ -0,0 +1,28 @@
+module Storey::Migrator
+  extend self
+
+  def migrate(schema)
+    Storey.switch schema do
+      ActiveRecord::Migrator.migrate ActiveRecord::Migrator.migrations_path
+    end
+  end
+
+  def run(direction, schema, version)
+    Storey.switch schema do
+      ActiveRecord::Migrator.run(
+        direction,
+        ActiveRecord::Migrator.migrations_path,
+        version
+      )
+    end
+  end
+
+  def rollback(schema, step=1)
+    Storey.switch schema do
+      ActiveRecord::Migrator.rollback(
+        ActiveRecord::Migrator.migrations_path,
+        step
+      )
+    end
+  end
+end

data/lib/storey/railtie.rb

@@ -0,0 +1,47 @@
+#require 'rails'
+class Storey::Railtie < Rails::Railtie
+  #
+  #   Set up our default config options
+  #   Do this before the app initializers run so we don't override custom settings
+  #
+  #config.before_initialize do
+    #Storey.configure do |config|
+      #config.excluded_models = []
+      #config.use_postgres_schemas = true
+      #config.database_names = []
+      #config.seed_after_create = false
+      #config.prepend_environment = true
+    #end
+  #end
+
+  # @bradrobertson's note in Apartment:
+  # Hook into ActionDispatch::Reloader to ensure Storey is properly initialized
+  # Note that this doens't entirely work as expected in Development, because this is called before classes are reloaded
+  # See the above middleware/console declarations below to help with this.  Hope to fix that soon.
+  config.to_prepare do
+    Storey.init
+  end
+
+  # Load Storey's rake tasks
+  rake_tasks do
+    load 'tasks/storey.rake'
+  end
+
+  #
+  #   The following initializers are a workaround to the fact that I can't properly hook into the rails reloader
+  #   Note this is technically valid for any environment where cache_classes is false, for us, it's just development
+  #
+  #if Rails.env.development?
+
+    # Storey::Reloader is middleware to initialize things properly on each request to dev
+    #initializer 'storey.init' do |app|
+      #app.config.middleware.use "Storey::Reloader"
+    #end
+
+    # Overrides reload! to also call Storey::Database.init as well so that the reloaded classes have the proper table_names
+    #console do
+      #require 'storey/console'
+    #end
+
+  #end
+end

data/lib/storey/version.rb

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

data/lib/storey.rb

@@ -0,0 +1,161 @@
+require "storey/version"
+require "rails/all"
+require "active_support/core_ext/module" # so we can use mattr_accessor
+require 'storey/railtie' if defined?(Rails)
+require 'storey/exceptions'
+require 'storey/migrator'
+
+module Storey
+  extend self
+
+  autoload :Duplicator, 'storey/duplicator'
+
+  mattr_accessor :suffix, :default_search_path
+  mattr_reader :excluded_models
+
+  def init
+    @@default_search_path = schema
+    self.excluded_models ||= []
+    process_excluded_models
+  end
+
+  def excluded_models=(array)
+    @@excluded_models = array
+    process_excluded_models
+  end
+
+  def schema(options={})
+    options[:suffix] ||= false
+
+    name = ActiveRecord::Base.connection.schema_search_path
+
+    if options[:suffix]
+      name
+    else
+      unsuffixify name
+    end
+  end
+
+  def create(name, options={}, &block)
+    fail ArgumentError, "Must pass in a valid schema name" if name.blank?
+
+    options[:load_database_schema] = true unless options.has_key?(:load_database_schema)
+
+    name = suffixify(name)
+    ActiveRecord::Base.connection.execute "CREATE SCHEMA #{name}"
+    switch name do
+      load_database_schema if options[:load_database_schema] == true
+      block.call if block_given?
+    end
+  rescue ActiveRecord::StatementInvalid => e
+    if e.to_s =~ /schema ".+" already exists/
+      fail Storey::SchemaExists, %{The schema "#{name}" already exists.}
+    else
+      raise e
+    end
+  end
+
+  def schemas(options={})
+    options[:suffix] ||= false
+    options[:public] = true unless options.has_key?(:public)
+
+    sql = "SELECT nspname FROM pg_namespace"
+    sql << " WHERE nspname !~ '^pg_.*'"
+    sql << " AND nspname != 'information_schema'"
+    sql << " AND nspname != 'public'" unless options[:public]
+
+    names = ActiveRecord::Base.connection.query(sql).flatten
+
+    if options[:suffix]
+      names
+    else
+      names = names.map {|name| unsuffixify(name)}
+    end
+  end
+
+  def drop(name)
+    name = suffixify name
+    ActiveRecord::Base.connection.execute("DROP SCHEMA #{name} CASCADE")
+  rescue ActiveRecord::StatementInvalid => e
+    raise Storey::SchemaNotFound, %{The schema "#{name}" cannot be found.}
+  end
+
+  def switch(name=nil, &block)
+    if block_given?
+      original_schema = schema
+      switch name
+      result = block.call
+      switch original_schema
+      result
+    else
+      reset and return if name.blank?
+      name = suffixify name
+      ActiveRecord::Base.connection.schema_search_path = name
+    end
+  rescue ActiveRecord::StatementInvalid => e
+    if e.to_s =~ /invalid value for parameter "search_path"/
+      fail Storey::SchemaNotFound, %{The schema "#{name}" cannot be found.}
+    else
+      raise e
+    end
+  end
+
+  def reload_config!
+    self.excluded_models = []
+    self.suffix = nil
+  end
+
+  def database_config
+    Rails.configuration.database_configuration[Rails.env].with_indifferent_access
+  end
+
+  def duplicate!(from_schema, to_schema)
+    duplicator = Duplicator.new from_schema, to_schema
+    duplicator.perform!
+  end
+
+  def suffixify(name)
+    if Storey.suffix && !name.include?(Storey.suffix) && name != self.default_search_path
+      "#{name}#{Storey.suffix}"
+    else
+      name
+    end
+  end
+
+  def unsuffixify(name)
+    Storey.suffix && name =~ /(\w+)#{Storey.suffix}/ ? $1 : name
+  end
+
+  protected
+
+  def schema_migrations
+    ActiveRecord::Migrator.get_all_versions
+  end
+
+  def reset
+    ActiveRecord::Base.connection.schema_search_path = self.default_search_path
+  end
+
+  # Loads the Rails schema.rb into the current schema
+  def load_database_schema
+    ActiveRecord::Schema.verbose = false # do not log schema load output.
+    load_or_abort("#{Rails.root}/db/schema.rb")
+  end
+
+  def load_or_abort(file)
+    if File.exists?(file)
+      load(file)
+    else
+      abort %{#{file} doesn't exist yet}
+    end
+  end
+
+  def process_excluded_models
+    self.excluded_models.each do |model_name|
+      model_name.constantize.tap do |klass|
+        table_name = klass.table_name.split('.', 2).last
+        klass.table_name = "public.#{table_name}"
+      end
+    end
+  end
+end

data/lib/tasks/storey.rake

@@ -0,0 +1,57 @@
+namespace :storey do
+
+  desc "Migrate all schemas including public"
+  task :migrate => "db:migrate" do
+    Storey.schemas.each do |schema|
+      Storey::Migrator.migrate schema
+    end
+  end
+
+  desc "Rolls the schema back to the previous version (specify steps w/ STEP=n) across all schemas."
+  task :rollback => 'db:rollback' do
+    step = ENV['STEP'] ? ENV['STEP'].to_i : 1
+
+    Storey.schemas.each do |db|
+      puts("Rolling back #{db} database")
+      Storey::Migrator.rollback db, step
+    end
+  end
+
+  namespace :migrate do
+
+    desc 'Runs the "up" for a given migration VERSION across all schemas.'
+    task :up => 'db:migrate:up' do
+      version = ENV['VERSION'] ? ENV['VERSION'].to_i : nil
+      raise 'VERSION is required' unless version
+
+      Storey.schemas.each do |schema|
+        puts "Migrating #{schema} schema up"
+        Storey::Migrator.run :up, schema, version
+      end
+    end
+
+    desc 'Runs the "down" for a given migration VERSION across all schemas.'
+    task :down => 'db:migrate:down' do
+      version = ENV['VERSION'] ? ENV['VERSION'].to_i : nil
+      raise 'VERSION is required' unless version
+
+      Storey.schemas.each do |schema|
+        puts "Migrating #{schema} schema down"
+        Storey::Migrator.run :down, schema, version
+      end
+    end
+
+    desc 'Rollbacks the database one migration and re migrate up (options: STEP=x, VERSION=x).'
+    task :redo => 'db:migrate:redo' do
+      if ENV['VERSION']
+        apartment_namespace['migrate:down'].invoke
+        apartment_namespace['migrate:up'].invoke
+      else
+        apartment_namespace['rollback'].invoke
+        apartment_namespace['migrate'].invoke
+      end
+    end
+
+  end
+
+end

data/spec/config/database.yml.sample

@@ -0,0 +1,6 @@
+test:
+  database: storey_test
+  adapter: postgresql
+  min_messages: WARNING
+  username: root
+  password:

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,9 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,7 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *= require_self
+ *= require_tree . 
+*/

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/models/company.rb

@@ -0,0 +1,2 @@
+class Company < ActiveRecord::Base
+end

data/spec/dummy/app/models/fake.rb

@@ -0,0 +1,2 @@
+class Fake < ActiveRecord::Base
+end

data/spec/dummy/app/models/post.rb

@@ -0,0 +1,2 @@
+class Post < ActiveRecord::Base
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/config/application.rb

@@ -0,0 +1,45 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require
+require "storey"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Enable the asset pipeline
+    config.assets.enabled = true
+
+    # Version of your assets, change this if you want to expire all your assets
+    config.assets.version = '1.0'
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml.sample

@@ -0,0 +1,6 @@
+test:
+  database: storey_test
+  adapter: postgresql
+  min_messages: WARNING
+  username: root
+  password:

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,30 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+
+  # Do not compress assets
+  config.assets.compress = false
+
+  # Expands the lines which load the assets
+  config.assets.debug = true
+end