storey 0.2.0 → 0.3.0

data/README.md

@@ -86,3 +86,9 @@ Copies a schema with all data under a new name. Best used in conjunction with `S
 Usage:
 
     Storey.duplicate!("original_schema", "new_schema")
+
+# Rake tasks
+
+## storey:hstore:install
+
+Run `rake storey:hstore:install` to install hstore extension into the hstore schema. Ensure that 'hstore' is one of the persistent schemas.

data/lib/storey.rb

@@ -4,11 +4,12 @@ require "active_support/core_ext/module" # so we can use mattr_accessor
 require 'storey/railtie' if defined?(Rails)
 require 'storey/exceptions'
 require 'storey/migrator'
+require 'storey/duplicator'
+require 'storey/hstore'
 
 module Storey
   extend self
-
-  autoload :Duplicator, 'storey/duplicator'
+  RESERVED_SCHEMAS = %w(hstore)
 
   mattr_accessor :suffix, :default_search_path, :persistent_schemas
   mattr_reader :excluded_models
@@ -39,23 +40,27 @@ module Storey
 
   def create(name, options={}, &block)
     fail ArgumentError, "Must pass in a valid schema name" if name.blank?
+    fail ArgumentError, "'#{name}' is a reserved schema name" if RESERVED_SCHEMAS.include?(name) && !options[:force]
+    fail Storey::SchemaExists, %{The schema "#{name}" already exists.} if self.schemas.include?(name)
 
-    options[:load_database_schema] = true unless options.has_key?(:load_database_schema)
+    options[:load_database_structure] = true if options[:load_database_structure].nil?
 
-    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.}
+    if options[:load_database_structure]
+      duplicator = Storey::Duplicator.new 'public', name, structure_only: true
+      duplicator.perform!
+      name = suffixify name
+      switch name do
+        block.call if block_given?
+      end
     else
-      raise e
+      self.create_plain_schema name
     end
   end
 
+  def create_plain_schema(schema_name)
+    ActiveRecord::Base.connection.execute "CREATE SCHEMA #{self.suffixify schema_name}"
+  end
+
   def schemas(options={})
     options[:suffix] ||= false
     options[:public] = true unless options.has_key?(:public)
@@ -119,16 +124,20 @@ module Storey
     Rails.configuration.database_configuration[Rails.env].with_indifferent_access
   end
 
-  def duplicate!(from_schema, to_schema)
-    duplicator = Duplicator.new from_schema, to_schema
+  def duplicate!(from_schema, to_schema, options={})
+    duplicator = Duplicator.new from_schema, to_schema, options
     duplicator.perform!
   end
 
-  def suffixify(name)
-    if Storey.suffix && !name.include?(Storey.suffix) && name != self.default_search_path
-      "#{name}#{Storey.suffix}"
+  def suffixify(schema_name)
+
+    if Storey.suffix &&
+      !schema_name.include?(Storey.suffix) &&
+      !matches_default_search_path?(schema_name)
+
+      "#{schema_name}#{Storey.suffix}"
     else
-      name
+      schema_name
     end
   end
 
@@ -149,6 +158,15 @@ module Storey
     search_path
   end
 
+  def matches_default_search_path?(schema_name)
+    paths = self.default_search_path.split(',')
+    paths.each do |path|
+      return true if path == schema_name
+    end
+    return true if self.default_search_path == schema_name
+    return false
+  end
+
   protected
 
   def schema_migrations
@@ -160,20 +178,6 @@ module Storey
     ActiveRecord::Base.connection.schema_search_path = 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|

data/lib/storey/duplicator.rb

@@ -1,15 +1,17 @@
 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, :structure_only, :file_prefix, :dump_path, :source_dump_path, :target_dump_path
 
-  attr_accessor :source_schema, :target_schema, :source_file, :target_file
+  def initialize(from_schema, to_schema, options={})
+    self.dump_path = File.join Rails.root, 'tmp', 'schema_dumps'
+    self.source_dump_path = File.join self.dump_path, 'source'
+    self.target_dump_path = File.join self.dump_path, 'target'
+    self.structure_only = options[:structure_only] || false
 
-  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"
+    self.file_prefix = "#{Time.now.to_i}_#{rand(100000)}"
+    self.source_file   = File.join self.source_dump_path, "#{self.file_prefix}_#{self.source_schema}.sql"
+    self.target_file   = File.join self.target_dump_path, "#{self.file_prefix}_#{self.target_schema}.sql"
   end
 
   def perform!
@@ -29,13 +31,15 @@ class Storey::Duplicator
     options[:file]     ||= self.source_file
     options[:schema]   ||= self.source_schema
 
-    switches = options.map { |k, v| "--#{k}=#{v}" }.join(" ")
+    switches = options.map { |k, v| "--#{k}=#{v}" }
+    switches << '--schema-only' if self.structure_only
+    switches = switches.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) }
+    [self.source_dump_path, self.target_dump_path].each { |d| FileUtils.mkdir_p(d) }
   end
 
   def load_schema(options={})
@@ -46,7 +50,25 @@ class Storey::Duplicator
 
     switches = options.map { |k, v| "--#{k}=#{v}" }.join(" ")
 
+    if duplicating_from_default?
+      # Since we are copying the source schema and we're after structure only,
+      # the dump_schema ended up creating a SQL file without the "CREATE SCHEMA" command
+      # thus we have to create it manually
+      ::Storey.create_plain_schema self.target_schema
+    end
+
+    source_schema_migrations = ::Storey.switch(self.source_schema) do
+      ActiveRecord::Migrator.get_all_versions
+    end
+
     `psql #{switches}`
+
+    ::Storey.switch self.target_schema do
+      source_schema_migrations.each do |version|
+        ActiveRecord::Base.connection.execute "INSERT INTO schema_migrations (version) VALUES ('#{version}');"
+      end
+    end
+
     ENV['PGPASSWORD'] = nil
   end
 
@@ -58,4 +80,8 @@ class Storey::Duplicator
       end
     end
   end
+
+  def duplicating_from_default?
+    ::Storey.matches_default_search_path?(self.source_schema) && self.structure_only
+  end
 end

data/lib/storey/hstore.rb

@@ -0,0 +1,8 @@
+class Storey::Hstore
+  def self.install
+    fail Storey::StoreyError, 'You are attempting to install hstore data type, but the hstore schema (where the data type will be installed) is not one of the persistent schemas. Please add hstore to the list of persistent schemas.' unless Storey.persistent_schemas.include?('hstore')
+
+    Storey.create 'hstore', force: true
+    ActiveRecord::Base.connection.execute "CREATE EXTENSION IF NOT EXISTS hstore SCHEMA #{Storey.suffixify('hstore')}"
+  end
+end

data/lib/storey/version.rb

@@ -1,3 +1,3 @@
 module Storey
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/tasks/storey.rake

@@ -1,5 +1,12 @@
 namespace :storey do
 
+  namespace :hstore do
+    desc "Install hstore into the hstore#{Storey.suffix} schema"
+    task :install => :environment do
+      Storey::Hstore.install
+    end
+  end
+
   desc "Migrate all schemas including public"
   task :migrate => "db:migrate" do
     Storey.schemas.each do |schema|

data/spec/spec_helper.rb

@@ -51,6 +51,7 @@ RSpec.configure do |config|
     # we don't want any test that has set this to keep it hanging around
     # screwing with our migration
     ENV['STEP'] = ENV['VERSION'] = nil
+    Rails.application.config.active_record.schema_format = :ruby
     @rake["db:migrate"].invoke
   end
 end

data/spec/storey/create_plain_schema_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Storey, '.create_plain_schema' do
+  context 'when there is no suffix set' do
+    it 'should create a schema without a suffix' do
+      Storey.create_plain_schema 'dun'
+      Storey.schemas(suffix: true).should include('dun')
+    end
+  end
+
+  context 'when there is a suffix set' do
+    before do
+      Storey.suffix = '_lop'
+    end
+
+    it 'should create a schema with the suffix' do
+      Storey.create_plain_schema 'dun'
+      Storey.schemas(suffix: true).should include('dun_lop')
+    end
+  end
+end

data/spec/storey/create_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Storey, "#create" do
-  it "should load the schema.rb into the new schema" do
+  it "should load the database structure into the new schema" do
     public_tables = Storey.switch { ActiveRecord::Base.connection.tables }.sort
     Storey.create "foobar" do
       foobar_tables = ActiveRecord::Base.connection.tables.sort
@@ -17,10 +17,13 @@ describe Storey, "#create" do
     end
   end
 
-  context ":load_database_schema => false" do
-    it "should not load the schema.rb" do
-      Storey.should_not_receive(:load_database_schema)
-      Storey.create "foobar", :load_database_schema => false
+  context "when load_database_schema: false" do
+    it "should not load the structure" do
+      Storey.create "foobar", load_database_structure: false do
+        tables = ActiveRecord::Base.connection.tables
+        tables.should_not include('companies')
+        tables.should_not include('posts')
+      end
     end
   end
 
@@ -84,4 +87,20 @@ describe Storey, "#create" do
       end
     end
   end
+
+  context 'when creating a reserved schema' do
+    it 'should fail' do
+      expect {Storey.create('hstore')}.to raise_error(ArgumentError, "'hstore' is a reserved schema name")
+    end
+
+    context 'when force: true is passed in' do
+      it 'should create the schema' do
+        expect {
+          Storey.create 'hstore', force: true
+        }.to_not raise_error(ArgumentError)
+        Storey.schemas.should include('hstore')
+      end
+    end
+  end
+
 end

data/spec/storey/duplicate_spec.rb

@@ -3,7 +3,8 @@ require 'spec_helper'
 describe Storey, "#duplicate!" do
   before do
     # Always clear the tmp file of the Rails app
-    FileUtils.rm_rf(Storey::Duplicator::DUMP_PATH)
+    tmp_dir = File.join Rails.root, 'tmp'
+    FileUtils.rm_rf(tmp_dir)
   end
 
   context "when there's no suffix set" do
@@ -21,6 +22,27 @@ describe Storey, "#duplicate!" do
         Post.find_by_name("Hi").should_not be_nil
       end
     end
+
+    context 'when setting structure_only: true' do
+      before do
+        Storey.duplicate! 'ricky', 'bobby', structure_only: true
+      end
+
+      it 'should create a duplicate schema but copy the structure only' do
+        Storey.schemas.should include('bobby')
+        Storey.switch 'bobby' do
+          Post.count.should == 0
+        end
+      end
+
+      it 'should copy all the schema_migrations over' do
+        public_schema_migrations = Storey.switch { ActiveRecord::Migrator.get_all_versions }
+        Storey.switch 'bobby' do
+          ActiveRecord::Migrator.get_all_versions.should == public_schema_migrations
+        end
+      end
+    end
+
   end
 
   it "should clear the PGPASSWORD environment variable" do

data/spec/storey/hstore_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Storey::Hstore do
+  describe '.install' do
+    it 'should install the extension into the hstore schema' do
+      Storey.persistent_schemas = %w(hstore)
+      described_class.install
+      expect {
+        ActiveRecord::Base.connection.execute "DROP EXTENSION hstore"
+      }.to_not raise_error(ActiveRecord::StatementInvalid)
+    end
+
+    context 'when hstore is not one of the persistent schemas' do
+      it 'should fail with an StoreyError' do
+        Storey.persistent_schemas = []
+        expect {
+          described_class.install
+        }.to raise_error(Storey::StoreyError, 'You are attempting to install hstore data type, but the hstore schema (where the data type will be installed) is not one of the persistent schemas. Please add hstore to the list of persistent schemas.')
+      end
+    end
+  end
+end

data/spec/storey/suffixify_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Storey, '.suffixify' do
+  context 'given a schema that is not the default schema' do
+    it 'should not add a suffix' do
+      Storey.suffix = '_doo'
+      Storey.suffixify('public').should == 'public'
+      Storey.suffixify(%{"$user",public}).should == %{"$user",public}
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: storey
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-06-17 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &82245390 !ruby/object:Gem::Requirement
+  requirement: &76025600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *82245390
+  version_requirements: *76025600
 - !ruby/object:Gem::Dependency
   name: pg
-  requirement: &82244830 !ruby/object:Gem::Requirement
+  requirement: &76025050 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.12.2
   type: :development
   prerelease: false
-  version_requirements: *82244830
+  version_requirements: *76025050
 - !ruby/object:Gem::Dependency
   name: database_cleaner
-  requirement: &82244090 !ruby/object:Gem::Requirement
+  requirement: &76024290 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *82244090
+  version_requirements: *76024290
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &82243450 !ruby/object:Gem::Requirement
+  requirement: &76023620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *82243450
+  version_requirements: *76023620
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &82242810 !ruby/object:Gem::Requirement
+  requirement: &76023040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,7 +65,7 @@ dependencies:
         version: 3.2.2
   type: :runtime
   prerelease: false
-  version_requirements: *82242810
+  version_requirements: *76023040
 description: Storey aims to simplify the implementation of managing a multi-tenant
   application.
 email:
@@ -83,6 +83,7 @@ files:
 - lib/storey.rb
 - lib/storey/duplicator.rb
 - lib/storey/exceptions.rb
+- lib/storey/hstore.rb
 - lib/storey/migrator.rb
 - lib/storey/railtie.rb
 - lib/storey/version.rb
@@ -130,13 +131,16 @@ files:
 - spec/migrator_spec.rb
 - spec/spec_helper.rb
 - spec/storey/configuration_spec.rb
+- spec/storey/create_plain_schema_spec.rb
 - spec/storey/create_spec.rb
 - spec/storey/drop_spec.rb
 - spec/storey/duplicate_spec.rb
 - spec/storey/excluded_models_spec.rb
+- spec/storey/hstore_spec.rb
 - spec/storey/persistent_schemas_spec.rb
 - spec/storey/schema_spec.rb
 - spec/storey/schemas_spec.rb
+- spec/storey/suffixify_spec.rb
 - spec/storey/switch_spec.rb
 - spec/tasks/storey_rake_spec.rb
 - storey.gemspec