storey 1.0.0 → 2.0.0

data/lib/storey/get_migration_versions.rb

@@ -0,0 +1,21 @@
+module Storey
+  class GetMigrationVersions
+
+    def self.call(schema = nil)
+      return migration_versions if schema.nil?
+      Storey.switch(schema) { migration_versions }
+    end
+
+    private
+
+    def self.migration_versions
+      if Gem::Version.new(ActiveRecord::VERSION::STRING) < Gem::Version.new("5.2")
+        ::ActiveRecord::Migrator.get_all_versions
+      else
+        ::ActiveRecord::Base.connection.migration_context.
+          get_all_versions
+      end
+    end
+
+  end
+end

data/lib/storey/migrator.rb

@@ -13,18 +13,13 @@ module Storey
     def self.migrate(schema, options={})
       Storey.switch schema do
         puts "= Migrating #{schema}"
-        ::ActiveRecord::Migrator.migrate(::ActiveRecord::Migrator.migrations_path,
-                                         options[:version])
+        active_record_migrate(options[:version])
       end
     end
 
     def self.run(direction, schema, version)
       Storey.switch schema do
-        ::ActiveRecord::Migrator.run(
-          direction,
-          ::ActiveRecord::Migrator.migrations_path,
-          version
-        )
+        active_record_run(direction, version)
       end
     end
 
@@ -39,11 +34,37 @@ module Storey
       Storey.switch schema do
         puts "= Rolling back `#{schema}` #{step} steps"
         ::ActiveRecord::Migrator.rollback(
-          ::ActiveRecord::Migrator.migrations_path,
+          ::ActiveRecord::Migrator.migrations_paths,
           step
         )
       end
     end
 
+    private
+
+    def self.active_record_migrate(version)
+      if Gem::Version.new(ActiveRecord::VERSION::STRING) < Gem::Version.new("5.2")
+        ::ActiveRecord::Migrator.migrate(
+          ::ActiveRecord::Migrator.migrations_paths,
+          version,
+        )
+      else
+        ::ActiveRecord::Tasks::DatabaseTasks.migrate
+      end
+    end
+
+    def self.active_record_run(direction, target_version)
+      if Gem::Version.new(ActiveRecord::VERSION::STRING) < Gem::Version.new("5.2")
+        ::ActiveRecord::Migrator.run(
+          direction,
+          ::ActiveRecord::Migrator.migrations_paths,
+          target_version
+        )
+      else
+        ::ActiveRecord::Base.connection.migration_context.
+          run(direction, target_version)
+      end
+    end
+
   end
 end

data/lib/storey/sql_dumper.rb

@@ -8,8 +8,8 @@ module Storey
     end
 
     def dump
-      `#{command}`
-      raise 'Error dumping database' if $?.exitstatus == 1
+      stdout_str, stderr_str, status = Open3.capture3(command)
+      raise "Error dumping database: #{stderr_str}" if status.exitstatus != 0
     end
 
     private
@@ -27,10 +27,14 @@ module Storey
     end
 
     def command
-      @command ||= BuildsDumpCommand.execute(structure_only: true,
-                                             file: @file,
-                                             schemas: search_path,
-                                             database: database_name)
+      return @command if defined?(@command)
+      args = Storey.database_config.slice(:host, :username, :password).merge(
+        structure_only: true,
+        file: @file,
+        schemas: search_path,
+        database: database_name,
+      )
+      @command = BuildsDumpCommand.execute(args)
     end
 
   end

data/lib/storey/suffixifier.rb

@@ -16,13 +16,13 @@ module Storey
         else
           "#{schema_name}#{suffix}"
         end
-      end.join(',')
+      end.join(', ')
     end
 
     private
 
     def schema_names
-      @schema_names ||= @schema_name.split(',')
+      @schema_names ||= @schema_name.split(',').map(&:strip)
     end
 
     def suffix

data/lib/storey/version.rb

@@ -1,3 +1,3 @@
 module Storey
-  VERSION = "1.0.0"
+  VERSION = "2.0.0"
 end

data/lib/storey.rb

@@ -1,5 +1,6 @@
 require 'easy_class_to_instance_method'
 require "active_support/core_ext/module" # so we can use mattr_accessor
+require "open3"
 
 require "storey/version"
 require "rails/all"
@@ -20,6 +21,7 @@ require 'storey/builds_dump_command'
 require 'storey/builds_load_command'
 require 'storey/schema_name'
 require 'storey/sets_env_password'
+require 'storey/get_migration_versions'
 
 module Storey
 
@@ -56,12 +58,9 @@ module Storey
     options[:suffix] ||= false
 
     name = ::ActiveRecord::Base.connection.schema_search_path
-
-    if options[:suffix]
-      name
-    else
-      unsuffixify name
-    end
+    name = unsuffixify(name) if !options[:suffix]
+    return name.split(",").map(&:strip) if options[:array]
+    name
   end
 
   def create(name, options={}, &block)
@@ -155,7 +154,7 @@ module Storey
 
     schemas_in_db = self.schemas(suffix: self.suffix.present?)
     schemas_in_db << %("$user")
-    schema_names = schema_name.split(',')
+    schema_names = schema_name.split(',').map(&:strip)
     schemas_not_in_db = schema_names - schemas_in_db
     schemas_not_in_db.empty?
   end

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

@@ -1,6 +1,7 @@
 test:
-  database: storey_test
+  database: postgres
   adapter: postgresql
   min_messages: WARNING
   username: postgres
   password:
+  host: localhost

data/spec/dummy/config/initializers/migrations_path.rb

@@ -1,2 +1,2 @@
-dummy_migrations_path = File.join(File.dirname(__FILE__), '..', '..', 'db', 'migrate')
-ActiveRecord::Migrator.migrations_path = dummy_migrations_path
+dummy_migrations_paths = File.join(File.dirname(__FILE__), '..', '..', 'db', 'migrate')
+ActiveRecord::Migrator.migrations_paths = dummy_migrations_paths

data/spec/dummy/db/migrate/20120115060713_create_companies.rb

@@ -1,4 +1,4 @@
-class CreateCompanies < ActiveRecord::Migration
+class CreateCompanies < ActiveRecord::Migration[5.0]
   def change
     create_table :companies do |t|
       t.string :name

data/spec/dummy/db/migrate/20120115060728_create_posts.rb

@@ -1,4 +1,4 @@
-class CreatePosts < ActiveRecord::Migration
+class CreatePosts < ActiveRecord::Migration[5.0]
   def change
     create_table :posts do |t|
       t.string :name

data/spec/migrator_spec.rb

@@ -2,7 +2,9 @@ require 'spec_helper'
 
 describe Storey::Migrator do
   before do
-    @original_schema = ::ActiveRecord::Base.connection.schema_search_path
+    # split and join to make the expectation later consistent with the code
+    @original_schema = ::ActiveRecord::Base.connection.schema_search_path.
+      split(",").map(&:strip).join(", ")
     @schema_1 = "first_schema"
     Storey.create @schema_1
   end
@@ -37,7 +39,6 @@ describe Storey::Migrator do
       end
 
       it "should migrate db" do
-        ActiveRecord::Migrator.should_receive(:migrate)
         Storey::Migrator.migrate(@schema_1)
       end
     end
@@ -58,10 +59,12 @@ describe Storey::Migrator do
         Storey::Migrator.run(:up, @schema_1, @migration_version_2)
       end
 
-      it "should migrate to a version" do
-        ActiveRecord::Migrator.should_receive(:run).
-          with(:up, anything, @migration_version_1)
-        Storey::Migrator.run(:up, @schema_1, @migration_version_1)
+      it "migrates up a specific version" do
+        Storey.create("blankschema", load_database_structure: false)
+        Storey::Migrator.run(:up, "blankschema", @migration_version_1)
+
+        expect(Storey::GetMigrationVersions.("blankschema")).
+          to match([@migration_version_1])
       end
     end
 
@@ -74,10 +77,12 @@ describe Storey::Migrator do
         Storey::Migrator.run(:down, @schema_1, @migration_version_2)
       end
 
-      it "should migrate to a version" do
-        ActiveRecord::Migrator.should_receive(:run).
-          with(:down, anything, @migration_version_1)
-        Storey::Migrator.run(:down, @schema_1, @migration_version_1)
+      it "migrates down a specific version" do
+        Storey.create("blankschema")
+        Storey::Migrator.run(:down, "blankschema", @migration_version_1)
+
+        expect(Storey::GetMigrationVersions.("blankschema")).
+          to match([@migration_version_2])
       end
     end
 

data/spec/storey/builds_dump_command_spec.rb

@@ -16,6 +16,32 @@ describe Storey::BuildsDumpCommand do
       }
     end
 
+    context "when host is specified" do
+      before do
+        options.merge!(host: "localhost")
+      end
+
+      it { is_expected.to include("--host=localhost") }
+    end
+
+    context "when username is specified" do
+      before do
+        options.merge!(username: "username")
+      end
+
+      it { is_expected.to include("--username=username") }
+    end
+
+    context "when password is specified" do
+      before do
+        options.merge!(password: "pass")
+      end
+
+      it "sets the PGPASSWORD env variable" do
+        expect(subject).to match(/^PGPASSWORD=pass/)
+      end
+    end
+
     context 'when structure_only: true' do
       before do
         options.merge!(

data/spec/storey/create_spec.rb

@@ -46,9 +46,9 @@ describe Storey, "#create" do
 
   it "should copy the schema_migrations over" do
     Storey.create "foobar"
-    public_schema_migrations = Storey.switch { ActiveRecord::Migrator.get_all_versions }
+    public_schema_migrations = Storey.switch { Storey::GetMigrationVersions.() }
     Storey.switch "foobar" do
-      ActiveRecord::Migrator.get_all_versions.should == public_schema_migrations
+      Storey::GetMigrationVersions.().should == public_schema_migrations
     end
   end
 

data/spec/storey/duplicate_spec.rb

@@ -43,9 +43,9 @@ describe Storey, "#duplicate!" do
       end
 
       it 'should copy all the schema_migrations over' do
-        public_schema_migrations = Storey.switch { ActiveRecord::Migrator.get_all_versions }
+        public_schema_migrations = Storey.switch { Storey::GetMigrationVersions.() }
         Storey.switch 'bobby' do
-          ActiveRecord::Migrator.get_all_versions.should == public_schema_migrations
+          Storey::GetMigrationVersions.().should == public_schema_migrations
         end
       end
     end

data/spec/storey/get_migration_versions_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+module Storey
+  RSpec.describe GetMigrationVersions do
+
+    before do
+      Storey.create("schema_1") do
+        ActiveRecord::SchemaMigration.create!(version: 123)
+      end
+
+      Storey.create("schema_2") do
+        ActiveRecord::SchemaMigration.create!(version: 200)
+        ActiveRecord::SchemaMigration.create!(version: 201)
+      end
+
+      Storey.create("schema_3") do
+        ActiveRecord::SchemaMigration.create!(version: 300)
+        ActiveRecord::SchemaMigration.create!(version: 301)
+        ActiveRecord::SchemaMigration.create!(version: 302)
+      end
+    end
+
+    context "given a schema" do
+      it "returns the migration versions in that schema and switches back the schema" do
+        expect(described_class.("schema_1")).to include(123)
+        expect(Storey).to be_default_schema
+        expect(described_class.("schema_3")).to include(300, 301, 302)
+        expect(Storey).to be_default_schema
+      end
+    end
+
+    context "without a schema" do
+      it "returns the migration version in the current schema" do
+        Storey.switch "schema_1"
+        expect(described_class.()).to include(123)
+        Storey.switch "schema_2"
+        expect(described_class.()).to include(200, 201)
+      end
+    end
+
+  end
+end

data/spec/storey/schema_search_path_for_spec.rb

@@ -4,9 +4,9 @@ describe Storey, '#schema_search_path_for' do
 
   context 'given a search path that is one of the persistent schemas' do
     Storey.persistent_schemas = %w(halla)
-    Storey.schema_search_path_for('bola,halla').should == 'bola,halla'
+    Storey.schema_search_path_for('bola,halla').should == 'bola, halla'
     Storey.schema_search_path_for('halla').should == 'halla'
-    Storey.schema_search_path_for('halla,bola').should == 'halla,bola'
+    Storey.schema_search_path_for('halla,bola').should == 'halla, bola'
   end
 
 end

data/spec/storey/schema_spec.rb

@@ -5,6 +5,12 @@ describe Storey, "#schema" do
     Storey.schema.should == %{"$user",public}
   end
 
+  context "array: true" do
+    it "returns it as an array of strings" do
+      expect(Storey.schema(array: true)).to eq %w("$user" public)
+    end
+  end
+
   context "when a suffix is set" do
     before do
       Storey.suffix = "_rock"

data/spec/storey/schemas_spec.rb

@@ -36,15 +36,23 @@ describe Storey, "#schemas" do
       end
     end
 
-    context "when :public => true" do
-      it "should return an array of the schemas without the public schema" do
-        Storey.schemas(:public => true).should include("public")
+    context "`:public` option" do
+      context "when `public: true`" do
+        it "returns an array of the schemas including the public schema" do
+          expect(Storey.schemas(public: true)).to include("public")
+        end
+      end
+
+      context "when `public: false`" do
+        it "returns an array of the schemas without the public schema" do
+          expect(Storey.schemas(public: false)).to_not include("public")
+        end
       end
-    end
 
-    context "when :public => false" do
-      it "should return an array of the schemas with the public schema" do
-        Storey.schemas(:public => false).should_not include("public")
+      context "when `public` is not set" do
+        it "returns an array of the schemas including the public schema" do
+          expect(Storey.schemas).to include("public")
+        end
       end
     end
 

data/spec/storey/suffixifier_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Storey::Suffixifier do
 
   describe '#suffixify' do
-    subject do
+    subject(:schemas) do
       described_class.new(schema_name).suffixify
     end
 
@@ -20,11 +20,11 @@ describe Storey::Suffixifier do
         it { should == 'boom_suff' }
       end
 
-      context 'when given comma separated schemas' do
-        let(:schema_name) { '"$user",public,foo,bar,baz' }
+      context 'when given comma separated schemas (with inconsistent spaces)' do
+        let(:schema_name) { '"$user", public,foo, bar, baz' }
 
         it 'should return a comma separted schema string with the non-native schemas suffixified' do
-          subject.should == '"$user",public,foo_suff,bar_suff,baz_suff'
+          subject.should == '"$user", public, foo_suff, bar_suff, baz_suff'
         end
       end
     end

data/spec/storey/switch_spec.rb

@@ -136,10 +136,12 @@ describe Storey, "#switch" do
 
       it 'should switch to the schema with the persitent schemas still in the search path' do
         Storey.switch 'foobar'
-        Storey.schema.should == %{foobar,handle,bar,foo}
+        expect(Storey.schema(array: true)).
+          to match_array %w(foobar handle bar foo)
 
         Storey.switch
-        Storey.schema.should == %{"$user",public,handle,bar,foo}
+        expect(Storey.schema(array: true)).
+          to match_array %w("$user" public handle bar foo)
       end
     end
 

data/spec/tasks/storey_rake_spec.rb

@@ -6,8 +6,8 @@ describe Storey, "rake tasks" do
     @migration_version_1 = 20120115060713
     @migration_version_2 = 20120115060728
 
-    @number_of_dbs = rand(3) + 1
-    @number_of_dbs.times do |db|
+    @number_of_schemas = rand(3) + 1
+    @number_of_schemas.times do |db|
       Storey.create "schema_#{db}"
     end
   end
@@ -15,21 +15,21 @@ describe Storey, "rake tasks" do
   describe "storey:migrate" do
     before do
       # We don't care how it's migrated
-      ActiveRecord::Migrator.stub(:migrate)
+      Storey::Migrator.migrate_all
     end
 
     it "should migrate all schemas including public" do
       # +1 to take into account the public schema
-      ActiveRecord::Migrator.should_receive(:migrate).exactly(@number_of_dbs + 1).times
+      Storey::Migrator.should_receive(:migrate).exactly(@number_of_schemas + 1).times
       @rake["storey:migrate"].invoke
     end
 
     context 'when a version is given' do
-      it 'should migrate to the given version' do
+      it 'migrates to the given version for each schema' do
         ENV['VERSION'] = '3299329'
-        ActiveRecord::Migrator.should_receive(:migrate).
-          with(ActiveRecord::Migrator.migrations_path, 3299329).
-          exactly(@number_of_dbs + 1).times
+        expect(Storey::Migrator).to receive(:migrate_all).
+          with(version: "3299329").
+          once
         @rake["storey:migrate"].invoke
       end
     end
@@ -57,7 +57,7 @@ describe Storey, "rake tasks" do
           :up,
           anything,
           @migration_version_2.to_i
-        ).exactly(@number_of_dbs+1).times
+        ).exactly(@number_of_schemas+1).times
 
         @rake['storey:migrate:up'].invoke
       end
@@ -86,7 +86,7 @@ describe Storey, "rake tasks" do
           :down,
           anything,
           @migration_version_1
-        ).exactly(@number_of_dbs+1).times
+        ).exactly(@number_of_schemas+1).times
 
         @rake['storey:migrate:down'].invoke
       end
@@ -94,12 +94,12 @@ describe Storey, "rake tasks" do
   end
 
   describe "storey:rollback" do
-    it "should rollback dbs" do
+    it "should rollback schemas" do
       Storey::Migrator.should_receive(:rollback_all).once
       @rake['storey:rollback'].invoke
     end
 
-    it "should rollback dbs STEP amt" do
+    it "should rollback schemas STEP amt" do
       step = 2
       Storey::Migrator.should_receive(:rollback_all).with(step).once
       ENV['STEP'] = step.to_s

data/storey.gemspec

@@ -21,8 +21,8 @@ Gem::Specification.new do |s|
 
   # specify any dependencies here; for example:
   s.add_development_dependency "rspec-rails"
-  s.add_development_dependency "pg", "~> 0.12"
   s.add_development_dependency "database_cleaner"
   s.add_runtime_dependency 'easy_class_to_instance_method', '~> 0.0.2'
-  s.add_runtime_dependency "rails", ">= 3.2.0"
+  s.add_runtime_dependency "rails", ">= 4.0.0"
+  s.add_runtime_dependency "pg"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: storey
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Ramon Tayag
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-07 00:00:00.000000000 Z
+date: 2018-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-rails
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: pg
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +58,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '0'
 description: Storey aims to simplify the implementation of managing a multi-tenant
   application.
 email:
@@ -98,16 +98,20 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- gemfiles/rails_3.gemfile
-- gemfiles/rails_3.gemfile.lock
-- gemfiles/rails_4.gemfile
-- gemfiles/rails_4.gemfile.lock
+- docker-compose.yml
+- gemfiles/rails_5.0.gemfile
+- gemfiles/rails_5.0.gemfile.lock
+- gemfiles/rails_5.1.gemfile
+- gemfiles/rails_5.1.gemfile.lock
+- gemfiles/rails_5.2.gemfile
+- gemfiles/rails_5.2.gemfile.lock
 - lib/storey.rb
 - lib/storey/builds_dump_command.rb
 - lib/storey/builds_load_command.rb
 - lib/storey/dumper.rb
 - lib/storey/duplicator.rb
 - lib/storey/exceptions.rb
+- lib/storey/get_migration_versions.rb
 - lib/storey/hstore.rb
 - lib/storey/migrator.rb
 - lib/storey/native_schema_matcher.rb
@@ -175,6 +179,7 @@ files:
 - spec/storey/duplicate_spec.rb
 - spec/storey/duplicator_spec.rb
 - spec/storey/excluded_models_spec.rb
+- spec/storey/get_migration_versions_spec.rb
 - spec/storey/hstore_spec.rb
 - spec/storey/native_schema_matcher_spec.rb
 - spec/storey/persistent_schemas_spec.rb
@@ -212,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: storey
-rubygems_version: 2.2.2
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Manage multiple PostgreSQL schemas in your multi-tenant app.
@@ -270,6 +275,7 @@ test_files:
 - spec/storey/duplicate_spec.rb
 - spec/storey/duplicator_spec.rb
 - spec/storey/excluded_models_spec.rb
+- spec/storey/get_migration_versions_spec.rb
 - spec/storey/hstore_spec.rb
 - spec/storey/native_schema_matcher_spec.rb
 - spec/storey/persistent_schemas_spec.rb

data/gemfiles/rails_3.gemfile

@@ -1,9 +0,0 @@
-# This file was generated by Appraisal
-
-source "http://rubygems.org"
-
-gem "pry"
-gem "appraisal"
-gem "rails", "3.2.14"
-
-gemspec :path => "../"