README.md in ros-apartment-2.3.0 vs README.md in ros-apartment-2.4.0
- old
+ new
@@ -1,10 +1,10 @@
# Apartment
-[](https://badge.fury.io/rb/apartment)
-[](https://codeclimate.com/github/influitive/apartment)
-[](https://travis-ci.org/influitive/apartment)
+[](https://badge.fury.io/rb/apartment)
+[](https://codeclimate.com/github/rails-on-services/apartment/maintainability)
+[](https://travis-ci.org/rails-on-services/apartment)
*Multitenancy for Rails and ActiveRecord*
Apartment provides tools to help you deal with multiple tenants in your Rails
application. If you need to have certain data sequestered based on account or company,
@@ -31,11 +31,11 @@
### Rails
Add the following to your Gemfile:
```ruby
-gem 'ros-apartment'
+gem 'ros-apartment', require: 'apartment'
```
Then generate your `Apartment` config file using
```ruby
@@ -227,11 +227,11 @@
```ruby
# application.rb
module MyApplication
class Application < Rails::Application
# Obviously not a contrived example
- config.middleware.use Apartment::Elevators::Generic, Proc.new { |request| request.host.reverse }
+ config.middleware.use Apartment::Elevators::Generic, proc { |request| request.host.reverse }
end
end
```
Your other option is to subclass the Generic elevator and implement your own
@@ -287,10 +287,31 @@
Apartment::Tenant.drop('tenant_name')
```
When method is called, the schema is dropped and all data from itself will be lost. Be careful with this method.
+### Custom Prompt
+
+#### Console methods
+
+`ros-apartment` console configures two helper methods:
+1. `tenant_list` - list available tenants while using the console
+2. `st(tenant_name:String)` - Switches the context to the tenant name passed, if
+it exists.
+
+#### Custom printed prompt
+
+`ros-apartment` also has a custom prompt that gives a bit more information about
+the context in which you're running. It shows the environment as well as the tenant
+that is currently switched to. In order for you to enable this, you need to require
+the custom console in your application.
+
+In `application.rb` add `require 'apartment/custom_console'`.
+Please note that we rely on `pry-rails` to edit the prompt, thus your project needs
+to install it as well. In order to do so, you need to add `gem 'pry-rails'` to your
+project's gemfile.
+
## Config
The following config options should be set up in a Rails initializer such as:
config/initializers/apartment.rb
@@ -566,9 +587,16 @@
* 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
* If you're looking to help, check out the TODO file for some upcoming changes I'd like to implement in Apartment.
+
+### Running bundle install
+
+mysql2 gem in some cases fails to install.
+If you face problems running bundle install in OSX, try installing the gem running:
+
+`gem install mysql2 -v '0.5.3' -- --with-ldflags=-L/usr/local/opt/openssl/lib --with-cppflags=-I/usr/local/opt/openssl/include`
## License
Apartment is released under the [MIT License](http://www.opensource.org/licenses/MIT).