multitenancy_tools 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 607a5090d739ade79846b7d136b1b9b08fa28980
-  data.tar.gz: 8672d9af120642bcfc42f0b2431553210bd62ac7
+  metadata.gz: b17c6615883612747959c317412a274e079dc2c7
+  data.tar.gz: 9159b347030e2aea1985ffa2cea028b4d489d89f
 SHA512:
-  metadata.gz: 142763f57d6f6f7b5356dc2d5160423ec312e54f59058036510d2267d741ec50431003733c49db5ac2af75be9d8c91c118a7e0bfe043b4c5ceb7070cadf06454
-  data.tar.gz: 8c699c5a0e5c89a793234c0fed79985ace9de9b67c465d40a176a04515a14a1df41ed36c3ee17937be7eb3c6426637fa6e349bc8ff878ddc7e23413de3eb7ae5
+  metadata.gz: 3eec95eda8db2c65de64ed630dd17b05c3a53b7b249bcaf2e4693f470a616ea2e25ef442e6daaac4038d61a231fb45f15ecd658fd0ba034845a2eb558c7c65f9
+  data.tar.gz: aafbd8959cac1ca983bb5800788453bdcfb45120e89b40f78f73b83206bb8a445f614e57cc4c79b76ce8266ee7a76180c2df41cc83338f754a906ace0f4c7325

data/.travis.yml

@@ -1,4 +1,11 @@
 language: ruby
 rvm:
-  - 2.1.3
+  - 2.1.6
+  - 2.2.2
+addons:
+  postgresql: "9.3"
 before_install: gem install bundler -v 1.10.5
+before_script:
+  - cp spec/database.yml.travis spec/database.yml
+script:
+  - bundle exec rake spec

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in multitenancy_tools.gemspec
 gemspec
+
+gem 'codeclimate-test-reporter', group: :test, require: nil

data/README.md

@@ -1,9 +1,15 @@
 # MultitenancyTools
 
-This gem is a collection of tools that can be used to handle multitenant
+[![Build Status][travis-badge]][travis-build]
+[![Code Climate][cc-badge]][cc-details]
+[![Test Coverage][cc-cov-badge]][cc-cov-details]
+
+This Ruby gem is a collection of tools that can be used to handle multitenant
 Ruby/Rails apps. The currently only supported database is PostgreSQL and there
 is no plan to support other databases.
 
+The documentation is [available on RubyDoc.info][docs].
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -22,7 +28,7 @@ Or install it yourself as:
 
 ## Usage
 
-#### Dumping the structure of a PostgreSQL schema to a SQL file
+### Dumping the structure of a PostgreSQL schema to a SQL file
 
 Please note that `pg_dump` must be on your `PATH`:
 
@@ -31,7 +37,7 @@ dumper = MultitenancyTools::SchemaDumper.new('database name', 'schema name')
 dumper.dump_to('path/to/file.sql')
 ```
 
-#### Dumping the content of a table to a SQL file
+### Dumping the content of a table to a SQL file
 
 Like `SchemaDumper`, this tool also requires `pg_dump` to be on the `PATH`:
 
@@ -40,7 +46,7 @@ dumper = MultitenancyTools::TableDumper.new('database name', 'schema name', 'tab
 dumper.dump_to('path/to/file.sql')
 ```
 
-#### Creating a new PostgreSQL schema using a SQL file as template
+### Creating a new PostgreSQL schema using a SQL file as template
 
 After using `SchemaDumper` to create the SQL template, you can use the following
 class to create a new schema using this file as template:
@@ -52,19 +58,25 @@ creator.create_from_file('path/to/file.sql')
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then,
-edit `spec/database.yml` with your PostgreSQL database connection details (take
-a look at the example in `spec/database.yml.example`). **IMPORTANT:** this
-database will *be destroyed and recreated* on test execution.
+After checking out the repo:
+
+1. Install dependencies using `bin/setup`.
+2. Create the file `spec/database.yml` and configure it with your PostgreSQL
+database. There is an example on `spec/database.yml.example`. **Important:**
+this database *will be destroyed and recreated* on test execution.
+3. Run specs using `bundle exec rake spec` to make sure that everything is fine.
 
-You can use `rake spec` to run the tests. You can also run `bin/console` for an
-interactive prompt that will allow you to experiment.
+You can use `bin/console` to get an interactive prompt that will allow you to
+experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`.
-To release a new version, update the version number in `version.rb`, and then
-run `bundle exec rake release`, which will create a git tag for the version,
-push git commits and tags, and push the `.gem` file to
-[rubygems.org](https://rubygems.org).
+## Releasing a new version
+
+If you are the maintainer of this project:
+
+1. Update the version number in `lib/multitenancy_tools/version.rb`.
+2. Make sure that all tests are green (run `bundle exec rake spec`).
+3. Execute `bundle exec rake release` to create a git tag for the version, push
+git commits and tags, and publish the gem on [RubyGems.org][rubygems].
 
 ## Contributing
 
@@ -75,3 +87,12 @@ https://github.com/locaweb/multitenancy_tools.
 
 The gem is available as open source under the terms of the
 [MIT License](http://opensource.org/licenses/MIT).
+
+[travis-badge]: https://travis-ci.org/locaweb/multitenancy_tools.svg?branch=master
+[travis-build]: https://travis-ci.org/locaweb/multitenancy_tools
+[cc-badge]: https://codeclimate.com/github/locaweb/multitenancy_tools/badges/gpa.svg
+[cc-details]: https://codeclimate.com/github/locaweb/multitenancy_tools
+[cc-cov-badge]: https://codeclimate.com/github/locaweb/multitenancy_tools/badges/coverage.svg
+[cc-cov-details]: https://codeclimate.com/github/locaweb/multitenancy_tools/coverage
+[docs]: http://www.rubydoc.info/gems/multitenancy_tools
+[rubygems]: https://rubygems.org/gems/multitenancy_tools

data/lib/multitenancy_tools.rb

@@ -5,6 +5,32 @@ require 'multitenancy_tools/schema_dumper'
 require 'multitenancy_tools/schema_creator'
 require 'multitenancy_tools/table_dumper'
 require 'multitenancy_tools/schema_switcher'
+require 'multitenancy_tools/schema_destroyer'
 
 module MultitenancyTools
+  # Creates a new schema using the SQL file as template.
+  #
+  # @param name [String] schema name
+  # @param sql_file [String] absolute path to the SQL template
+  # @param connection [ActiveRecord::ConnectionAdapters::PostgreSQLAdapter] connection adapter
+  def self.create(name, sql_file, connection = ActiveRecord::Base.connection)
+    SchemaCreator.new(name, connection).create_from_file(sql_file)
+  end
+
+  # Removes a schema from the database.
+  #
+  # @param name [String] schema name
+  # @param connection [ActiveRecord::ConnectionAdapters::PostgreSQLAdapter] connection adapter
+  def self.destroy(name, connection = ActiveRecord::Base.connection)
+    SchemaDestroyer.new(name, connection).destroy
+  end
+
+  # Uses the passed schema as the scope for all queries triggered by the block.
+  #
+  # @param schema [String] schema name
+  # @param connection [ActiveRecord::ConnectionAdapters::PostgreSQLAdapter] connection adapter
+  # @yield The block that must be executed using the schema as scope
+  def self.using(schema, connection = ActiveRecord::Base.connection, &block)
+    SchemaSwitcher.new(schema, connection).run(&block)
+  end
 end

data/lib/multitenancy_tools/schema_creator.rb

@@ -9,7 +9,7 @@ module MultitenancyTools
   class SchemaCreator
     # @param schema [String] schema name
     # @param connection [ActiveRecord::ConnectionAdapters::PostgreSQLAdapter] connection adapter
-    def initialize(schema, connection)
+    def initialize(schema, connection = ActiveRecord::Base.connection)
       @schema = schema
       @connection = connection
     end

data/lib/multitenancy_tools/schema_destroyer.rb

@@ -0,0 +1,20 @@
+module MultitenancyTools
+  # {SchemaDestroyer} can be used to destroy a PostgreSQL schema.
+  #
+  # @example
+  #   destroyer = MultitenancyTools::SchemaDestroyer.new('schema name')
+  #   destroyer.destroy
+  class SchemaDestroyer
+    # @param schema [String] schema name
+    # @param connection [ActiveRecord::ConnectionAdapters::PostgreSQLAdapter] connection adapter
+    def initialize(schema, connection = ActiveRecord::Base.connection)
+      @connection = connection
+      @schema = @connection.quote_table_name(schema)
+    end
+
+    # Drops the schema.
+    def destroy
+      @connection.drop_schema(@schema)
+    end
+  end
+end

data/lib/multitenancy_tools/schema_switcher.rb

@@ -4,7 +4,7 @@ module MultitenancyTools
   class SchemaSwitcher
     # @param schema [String] schema name
     # @param connection [ActiveRecord::ConnectionAdapters::PostgreSQLAdapter] connection adapter
-    def initialize(schema, connection)
+    def initialize(schema, connection = ActiveRecord::Base.connection)
       @connection = connection
       @schema = @connection.quote(schema)
     end

data/lib/multitenancy_tools/version.rb

@@ -1,3 +1,3 @@
 module MultitenancyTools
-  VERSION = '0.1.7'
+  VERSION = '0.1.8'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: multitenancy_tools
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Lenon Marcel
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-20 00:00:00.000000000 Z
+date: 2015-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -120,6 +120,7 @@ files:
 - lib/multitenancy_tools/dump_cleaner.rb
 - lib/multitenancy_tools/errors.rb
 - lib/multitenancy_tools/schema_creator.rb
+- lib/multitenancy_tools/schema_destroyer.rb
 - lib/multitenancy_tools/schema_dumper.rb
 - lib/multitenancy_tools/schema_switcher.rb
 - lib/multitenancy_tools/table_dumper.rb