apartment 0.16.0 → 0.17.0

data/.gitignore

@@ -3,4 +3,6 @@
 Gemfile.lock
 pkg/*
 *.log
-
+*.sw[pno]
+spec/config/database.yml
+spec/dummy/config/database.yml

data/.travis.yml

@@ -1,5 +1,4 @@
 language: ruby
 rvm:
-  - 1.8.7
   - 1.9.2
   - 1.9.3

data/HISTORY.md

@@ -1,8 +1,16 @@
+# 0.17.0
+  * Sept 26, 2012
+
+  - Apartment has [a new home!](https://github.com/influitive/apartment)
+  - Support Sidekiq hooks to switch dbs [maedhr]
+  - Allow VERSION to be used on apartment:migrate [Bhavin Kamani]
+
 # 0.16.0
   * June 1, 2012
 
   - Apartment now supports a default_schema to be set, rather than relying on ActiveRecord's default schema_search_path
-  - Additional schemas can always be maintained in the schema_search_path by configuring persistent_schemas
+  - Additional schemas can always be maintained in the schema_search_path by configuring persistent_schemas [ryanbrunner]
+    - This means Hstore is officially supported!!
   - There is now a full domain based elevator to switch dbs based on the whole domain [lcowell]
   - There is now a generic elevator that takes a Proc to switch dbs based on the return value of that proc.
 

data/README.md

@@ -1,4 +1,7 @@
 # Apartment
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/influitive/apartment)
+[![Build Status](https://secure.travis-ci.org/influitive/apartment.png?branch=development)](http://travis-ci.org/influitive/apartment)
+
 *Multitenancy for Rails 3 and ActiveRecord*
 
 Apartment provides tools to help you deal with multiple databases in your Rails
@@ -129,14 +132,31 @@ Apartment will normally just switch the `schema_search_path` whole hog to the on
 
     config.persistent_schemas = ['some', 'other', 'schemas']
 
-This has numerous useful applications.  [Hstore](http://www.postgresql.org/docs/9.1/static/hstore.html), for instance, is a popular storage engine for Postgresql.  In order to use Hstore, you have to install to a specific schema and have that always in the `schema_search_path`.  This could be achieved like so:
+This has numerous useful applications.  [Hstore](http://www.postgresql.org/docs/9.1/static/hstore.html), for instance, is a popular storage engine for Postgresql.  In order to use Hstore, you have to install it to a specific schema and have that always in the `schema_search_path`.  This could be achieved like so:
 
+    # NOTE do not do this in a migration, must be done
+    # manually before you configure apartment with hstore
     # In a rake task, or on the console...
     ActiveRecord::Base.connection.execute("CREATE SCHEMA hstore; CREATE EXTENSION HSTORE SCHEMA hstore")
 
     # configure Apartment to maintain the `hstore` schema in the `schema_search_path`
     config.persistent_schemas = ['hstore']
 
+There are a few caveats to be aware of when using `hstore`.  First off, the hstore schema and extension creation need to be done manually *before* you reference it in any way in your migrations, database.yml or apartment.  This is an unfortunate manual step, but I haven't found a way around it.  You can achieve this from the command line using something like:
+
+    rails r 'ActiveRecord::Base.connection.execute("CREATE SCHEMA hstore; CREATE EXTENSION HSTORE SCHEMA hstore")'
+
+Next, your `database.yml` file must mimic what you've set for your default and persistent schemas in Apartment.  When you run migrataions with Rails, it won't know about the hstore schema because Apartment isn't injected into the default connection, it's done on a per-request basis, therefore Rails doesn't know about `hstore` during migrations.  To do so, add the following to your `database.yml` for all environments
+
+    # database.yml
+    ...
+    adapter: postgresql
+    schema_search_path: "public,hstore"
+    ...
+
+This would be for a config with `default_schema` set to `public` and `persistent_schemas` set to `['hstore']`
+
+
 ### Managing Migrations
 
 In order to migrate all of your databases (or posgresql schemas) you need to provide a list
@@ -205,7 +225,9 @@ All jobs *must* stored in the global (public) namespace, so add it to the list o
 
 ## Development
 
-* The Local setup for development assumes that a root user with no password exists for both mysql and postgresl
+* In both `spec/dummy/config` and `spec/config`, you will see `database.yml.sample` files
+  * Copy them into the same directory but with the name `database.yml`
+  * Edit them to fit your own settings
 * Rake tasks (see the Rakefile) will help you setup your dbs necessary to run tests
 * Please issue pull requests to the `development` branch.  All development happens here, master is used for releases
-* Ensure that your code is accompanied with tests.  No code will be merged without tests
+* Ensure that your code is accompanied with tests.  No code will be merged without tests

data/Rakefile

@@ -5,7 +5,7 @@ Bundler::GemHelper.install_tasks
 require "rspec"
 require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:spec => "db:test:prepare") do |spec|
+RSpec::Core::RakeTask.new(:spec => %w{ db:copy_credentials db:test:prepare }) do |spec|
   spec.pattern = "spec/**/*_spec.rb"
   # spec.rspec_opts = '--order rand:16996'
 end
@@ -26,6 +26,16 @@ namespace :db do
   namespace :test do
     task :prepare => %w{postgres:drop_db postgres:build_db mysql:drop_db mysql:build_db}
   end
+
+  desc "copy sample database credential files over if real files don't exist"
+  task :copy_credentials do
+    require 'fileutils'
+    apartment_db_file = 'spec/config/database.yml'
+    rails_db_file = 'spec/dummy/config/database.yml'
+
+    FileUtils.copy(apartment_db_file + '.sample', apartment_db_file, :verbose => true) unless File.exists?(apartment_db_file)
+    FileUtils.copy(rails_db_file + '.sample', rails_db_file, :verbose => true)         unless File.exists?(rails_db_file)
+  end
 end
 
 namespace :postgres do

data/apartment.gemspec

@@ -7,13 +7,13 @@ Gem::Specification.new do |s|
   s.version = Apartment::VERSION
 
   s.authors = ["Ryan Brunner", "Brad Robertson"]
-  s.summary = %q{A Ruby gem for managing database multitenancy in Rails applications}
-  s.description = %q{Apartment allows Rails applications to deal with database multitenancy}
+  s.summary = %q{A Ruby gem for managing database multitenancy}
+  s.description = %q{Apartment allows Rack applications to deal with database multitenancy through ActiveRecord}
   s.email = %w{ryan@ryanbrunner.com bradleyrobertson@gmail.com}
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {spec}/*`.split("\n")
 
-  s.homepage = %q{http://github.com/bradrobertson/apartment}
+  s.homepage = %q{https://github.com/influitive/apartment}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}

data/circle.yml

@@ -0,0 +1,9 @@
+machine:
+  ruby:
+    version: 1.9.3-p194
+
+test:
+  override:
+    - bundle exec rake spec:
+        environment:
+          RAILS_ENV: test

data/lib/apartment/adapters/abstract_adapter.rb

@@ -39,6 +39,7 @@ module Apartment
       def current_database
         ActiveRecord::Base.connection.current_database
       end
+      alias_method :current, :current_database
 
       #   Drop the database
       #

data/lib/apartment/adapters/postgresql_adapter.rb

@@ -109,15 +109,9 @@ module Apartment
       #   Generate the final search path to set including persistent_schemas
       #
       def full_search_path
-        persistent_schemas = persistent_schema_string
+        persistent_schemas = Apartment.persistent_schemas.join(', ')
         @current_database.to_s + (persistent_schemas.empty? ? "" : ", #{persistent_schemas}")
       end
-
-      #   Cached persistent schemas joined in a valid search path format (comma separated)
-      #
-      def persistent_schema_string
-        Apartment.persistent_schemas.join(', ')
-      end
     end
   end
 end

data/lib/apartment/database.rb

@@ -8,7 +8,7 @@ module Apartment
 
     extend self
 
-    delegate :create, :current_database, :drop, :process, :process_excluded_models, :reset, :seed, :switch, :to => :adapter
+    delegate :create, :current_database, :current, :drop, :process, :process_excluded_models, :reset, :seed, :switch, :to => :adapter
 
     attr_writer :config
 

data/lib/apartment/migrator.rb

@@ -6,7 +6,11 @@ module Apartment
 
     # Migrate to latest
     def migrate(database)
-      Database.process(database){ ActiveRecord::Migrator.migrate(ActiveRecord::Migrator.migrations_path) }
+      Database.process(database) do
+        ActiveRecord::Migrator.migrate(ActiveRecord::Migrator.migrations_path, ENV["VERSION"] ? ENV["VERSION"].to_i : nil) do |migration|
+          ENV["SCOPE"].blank? || (ENV["SCOPE"] == migration.scope)
+        end
+      end
     end
 
     # Migrate up/down to a specific version
@@ -20,4 +24,4 @@ module Apartment
     end
   end
 
-end
+end

data/lib/apartment/sidekiq/client/database_middleware.rb

@@ -0,0 +1,12 @@
+module Apartment
+  module Sidekiq
+    module Client
+      class DatabaseMiddleware
+        def call(worker_class, item, queue)
+          item["apartment"] = Apartment::Database.current_database
+          yield
+        end
+      end
+    end
+  end
+end

data/lib/apartment/sidekiq/server/database_middleware.rb

@@ -0,0 +1,13 @@
+module Apartment
+  module Sidekiq
+    module Server
+      class DatabaseMiddleware
+        def call(worker_class, item, queue)
+          Apartment::Database.process(item['apartment']) do
+            yield
+          end
+        end
+      end
+    end
+  end
+end

data/lib/apartment/version.rb

@@ -1,3 +1,3 @@
 module Apartment
-  VERSION = "0.16.0"
+  VERSION = "0.17.0"
 end

data/spec/dummy/config/{database.yml → database.yml.sample}

@@ -7,7 +7,7 @@ test:
   min_messages: WARNING
   pool: 5
   timeout: 5000
-  
+
 development:
   adapter: postgresql
   database: apartment_postgresql_development

data/spec/integration/apartment_rake_integration_spec.rb

@@ -24,6 +24,9 @@ describe "apartment rake tasks" do
       config.excluded_models = ["Company"]
       config.database_names = lambda{ Company.scoped.collect(&:database) }
     end
+
+    # fix up table name of shared/excluded models
+    Company.table_name = 'public.companies'
   end
 
   context "with x number of databases" do

data/spec/support/contexts.rb

@@ -26,8 +26,10 @@ shared_context "elevators", :elevator => true do
    let(:api)       { Apartment::Database }
 
    before do
+     Apartment.reset # reset all config
      Apartment.seed_after_create = false
      Apartment.use_postgres_schemas = true
+     api.reload! # reload adapter
 
      api.create(database1)
      api.create(database2)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apartment
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-01 00:00:00.000000000 Z
+date: 2012-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &2152850820 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,15 @@ dependencies:
         version: 3.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *2152850820
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.2
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &2152849500 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +38,15 @@ dependencies:
         version: 1.3.6
   type: :runtime
   prerelease: false
-  version_requirements: *2152849500
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.6
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &2152722880 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +54,15 @@ dependencies:
         version: 0.9.9
   type: :development
   prerelease: false
-  version_requirements: *2152722880
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.9
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2152722120 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +70,15 @@ dependencies:
         version: 3.1.2
   type: :development
   prerelease: false
-  version_requirements: *2152722120
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.2
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2152721240 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,10 +86,15 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *2152721240
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &2152719600 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +102,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152719600
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2152717500 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -88,10 +118,15 @@ dependencies:
         version: 2.10.0
   type: :development
   prerelease: false
-  version_requirements: *2152717500
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &2152733100 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -99,10 +134,15 @@ dependencies:
         version: 2.10.0
   type: :development
   prerelease: false
-  version_requirements: *2152733100
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &2152732580 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -110,10 +150,15 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2152732580
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: pg
-  requirement: &2152732000 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -121,10 +166,15 @@ dependencies:
         version: 0.11.0
   type: :development
   prerelease: false
-  version_requirements: *2152732000
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: mysql2
-  requirement: &2152731420 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -132,10 +182,15 @@ dependencies:
         version: 0.3.10
   type: :development
   prerelease: false
-  version_requirements: *2152731420
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.10
 - !ruby/object:Gem::Dependency
   name: delayed_job
-  requirement: &2152730820 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -143,10 +198,15 @@ dependencies:
         version: '3.0'
   type: :development
   prerelease: false
-  version_requirements: *2152730820
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: delayed_job_active_record
-  requirement: &2152730320 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -154,8 +214,14 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152730320
-description: Apartment allows Rails applications to deal with database multitenancy
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Apartment allows Rack applications to deal with database multitenancy
+  through ActiveRecord
 email:
 - ryan@ryanbrunner.com
 - bradleyrobertson@gmail.com
@@ -173,6 +239,7 @@ files:
 - README.md
 - Rakefile
 - apartment.gemspec
+- circle.yml
 - lib/apartment.rb
 - lib/apartment/adapters/abstract_adapter.rb
 - lib/apartment/adapters/mysql2_adapter.rb
@@ -189,12 +256,14 @@ files:
 - lib/apartment/migrator.rb
 - lib/apartment/railtie.rb
 - lib/apartment/reloader.rb
+- lib/apartment/sidekiq/client/database_middleware.rb
+- lib/apartment/sidekiq/server/database_middleware.rb
 - lib/apartment/version.rb
 - lib/tasks/apartment.rake
 - spec/adapters/mysql2_adapter_spec.rb
 - spec/adapters/postgresql_adapter_spec.rb
 - spec/apartment_spec.rb
-- spec/config/database.yml
+- spec/config/database.yml.sample
 - spec/database_spec.rb
 - spec/dummy/Rakefile
 - spec/dummy/app/controllers/application_controller.rb
@@ -206,7 +275,7 @@ files:
 - spec/dummy/config.ru
 - spec/dummy/config/application.rb
 - spec/dummy/config/boot.rb
-- spec/dummy/config/database.yml
+- spec/dummy/config/database.yml.sample
 - spec/dummy/config/environment.rb
 - spec/dummy/config/environments/development.rb
 - spec/dummy/config/environments/production.rb
@@ -252,7 +321,7 @@ files:
 - spec/unit/middleware/subdomain_elevator_spec.rb
 - spec/unit/migrator_spec.rb
 - spec/unit/reloader_spec.rb
-homepage: http://github.com/bradrobertson/apartment
+homepage: https://github.com/influitive/apartment
 licenses:
 - MIT
 post_install_message: 
@@ -267,7 +336,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2664931283611215158
+      hash: 345291853530360169
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -276,11 +345,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2664931283611215158
+      hash: 345291853530360169
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: A Ruby gem for managing database multitenancy in Rails applications
+summary: A Ruby gem for managing database multitenancy
 test_files: []