multitenancy_tools 0.1.9 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 660954dd5f64df45380a4cc405912a4dbb8366ec
-  data.tar.gz: c46e9cc25a12190d1648262e0cc57874dfc9914e
+  metadata.gz: 38a295e4d0fb3dc90035639d066137927c576551
+  data.tar.gz: f0ee6b1bd47bf9d4f357b599fd88aab97c7a2bfe
 SHA512:
-  metadata.gz: 291d66ebc172a1b205c684f46bed7bc228e9b05a99d456906685bd1dc85db169a898bede1c72bfae54e350a10caa9390f7c7a15c4de62f4c76297730da27fe96
-  data.tar.gz: cc438125123d4bc2ffa963be2445fa86973d36f7029562caf604b51767d038ba371de825648d5c1411d66d53be93d74eebfac96cef7e9dc17814ad42048aad25
+  metadata.gz: 1c354ac59d1a9bdd44ebcd9832f69b16e794d086104b9d8fa1ba9361c86b82715f48220479ba5a31091c3f90bc7af3e84e7028f58a78cc3ef1c9747fb1930720
+  data.tar.gz: acdf161ac4b73e1c57c9631c5d836d3fb892312a487d1ff9f9266d92fac985f37ca58b96e2d7a613e970954c60d48a8e0e500198627bf97c0b22f5d7f61aafd0

data/README.md

@@ -5,8 +5,11 @@
 [![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.
+Ruby/Rails apps. Like the name says, it is just a collection of tools and not
+an opinionated implementation and does not require a specific architecture.
+
+The currently only supported database is PostgreSQL and there is no plan to
+support other databases.
 
 The documentation is [available on RubyDoc.info][docs].
 

data/lib/multitenancy_tools.rb

@@ -6,10 +6,14 @@ require 'multitenancy_tools/schema_creator'
 require 'multitenancy_tools/table_dumper'
 require 'multitenancy_tools/schema_switcher'
 require 'multitenancy_tools/schema_destroyer'
+require 'multitenancy_tools/functions_dumper'
 
 module MultitenancyTools
-  # Creates a new schema using the SQL file as template.
+  # Creates a new schema using the SQL file as template. This SQL file can be
+  # generated by {SchemaDumper}.
   #
+  # @see SchemaCreator
+  # @see SchemaDumper
   # @param name [String] schema name
   # @param sql_file [String] absolute path to the SQL template
   # @param connection [ActiveRecord::ConnectionAdapters::PostgreSQLAdapter] connection adapter
@@ -17,8 +21,9 @@ module MultitenancyTools
     SchemaCreator.new(name, connection).create_from_file(sql_file)
   end
 
-  # Removes a schema from the database.
+  # Drops the schema from the database.
   #
+  # @see SchemaDestroyer
   # @param name [String] schema name
   # @param connection [ActiveRecord::ConnectionAdapters::PostgreSQLAdapter] connection adapter
   def self.destroy(name, connection = ActiveRecord::Base.connection)
@@ -27,10 +32,32 @@ module MultitenancyTools
 
   # Uses the passed schema as the scope for all queries triggered by the block.
   #
+  # @see SchemaSwitcher
   # @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
+
+  # Generates a SQL dump of the schema. Requires pg_dump.
+  #
+  # @see SchemaDumper
+  # @param database [String]
+  # @param schema [String]
+  # @param file [String]
+  def self.dump_schema(database, schema, file, **args)
+    SchemaDumper.new(database, schema).dump_to(file, **args)
+  end
+
+  # Generates a SQL dump of the table. Requires pg_dump.
+  #
+  # @see TableDumper
+  # @param database [String]
+  # @param schema [String]
+  # @param table [String]
+  # @param file [String]
+  def self.dump_table(database, schema, table, file, **args)
+    TableDumper.new(database, schema, table).dump_to(file, **args)
+  end
 end

data/lib/multitenancy_tools/functions_dumper.rb

@@ -0,0 +1,40 @@
+module MultitenancyTools
+  # {FunctionsDumper} can be used to generate a SQL dump of all functions that
+  # are present on a PostgreSQL schema.
+  #
+  # @example
+  #   dumper = MultitenancyTools::FunctionsDumper.new('schema name')
+  #   dumper.dump_to('path/to/file.sql')
+  class FunctionsDumper
+    # @param schema [String] schema name
+    # @param connection [ActiveRecord::ConnectionAdapters::PostgreSQLAdapter] connection adapter
+    def initialize(schema, connection = ActiveRecord::Base.connection)
+      @connection = connection
+      @schema = @connection.quote(schema)
+    end
+
+    # Generates a dump and writes it into a file. Please see {IO.new} for open
+    # modes.
+    #
+    # @see http://ruby-doc.org/core-2.2.2/IO.html#method-c-new-label-Open+Mode
+    #      IO Open Modes
+    # @param file [String] file path
+    # @param mode [String] IO open mode
+    def dump_to(file, mode: 'w')
+      results = @connection.execute(<<-SQL)
+        SELECT
+          trim(trailing e' \n' from pg_get_functiondef(f.oid)) || ';\n'
+          AS definition
+        FROM pg_catalog.pg_proc f
+        INNER JOIN pg_catalog.pg_namespace n ON (f.pronamespace = n.oid)
+        WHERE n.nspname = #{@schema};
+      SQL
+
+      File.open(file, mode) do |f|
+        results.each do |result|
+          f.write result['definition']
+        end
+      end
+    end
+  end
+end

data/lib/multitenancy_tools/version.rb

@@ -1,3 +1,3 @@
 module MultitenancyTools
-  VERSION = '0.1.9'
+  VERSION = '0.1.10'
 end

data/multitenancy_tools.gemspec

@@ -20,10 +20,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'activerecord', '~> 4.2.0'
+  spec.add_dependency 'pg'
+
   spec.add_development_dependency 'bundler', '~> 1.10'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.3.0'
-  spec.add_development_dependency 'activerecord', '~> 4.2.0'
-  spec.add_development_dependency 'pg'
   spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'pry'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: multitenancy_tools
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.10
 platform: ruby
 authors:
 - Lenon Marcel
@@ -11,66 +11,80 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-03 00:00:00.000000000 Z
+date: 2015-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
-  type: :development
+        version: 4.2.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
-  name: rake
+  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: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.10'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 3.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 3.3.0
 - !ruby/object:Gem::Dependency
-  name: pg
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -84,7 +98,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -119,6 +133,7 @@ files:
 - lib/multitenancy_tools.rb
 - lib/multitenancy_tools/dump_cleaner.rb
 - lib/multitenancy_tools/errors.rb
+- lib/multitenancy_tools/functions_dumper.rb
 - lib/multitenancy_tools/schema_creator.rb
 - lib/multitenancy_tools/schema_destroyer.rb
 - lib/multitenancy_tools/schema_dumper.rb