multitenancy_tools 0.1.11 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 492c6182c4299f4b2895b9b4709a481c202727a7
-  data.tar.gz: ffa962fe311628d2d51d8e84238d980ee0905b79
+  metadata.gz: 4856c5976dee593214b6b38ae73a1f0c2c0d3c2e
+  data.tar.gz: 9a37b22e130a50d8fc5dc472635091e1febc3a87
 SHA512:
-  metadata.gz: 346b3a9769bc400f4dcc11704a0a1734bba480a165ce8bfd4e03148f9e25ce96d05ed2ad39a9d02b1b9824cb40c8b2786ccc64ba121a6a3ce3e72c91ec44962e
-  data.tar.gz: fd44ff73caf4949a6d91a659b08439a4b1f105920747b289ab6ae7fb8c68541acd3c511802c0419102bad5617a5e641cf94a6146ef5c70a9fbd4c1ead4ed782e
+  metadata.gz: 6e78755759a2c2852385ca94aefd8f376daf8b86f46bd3439c1562dda8dca7e647896c1dcdb3af735b5905a79e1b9be5656914afbfd8ce94d034647ed776a772
+  data.tar.gz: 595e5b7f7ac6860bb41aa05b17534b3c1c312b06161ecb46f4feed3164ce5a182be68a34a46ad2fcb2b248d90b28a9575a0df035f1278ead35ac256007709b83

data/lib/multitenancy_tools.rb

@@ -8,6 +8,7 @@ require 'multitenancy_tools/schema_switcher'
 require 'multitenancy_tools/schema_destroyer'
 require 'multitenancy_tools/functions_dumper'
 require 'multitenancy_tools/schema_migrator'
+require 'multitenancy_tools/extensions_dumper'
 
 module MultitenancyTools
   # Creates a new schema using the SQL file as template. This SQL file can be
@@ -61,4 +62,13 @@ module MultitenancyTools
   def self.dump_table(database, schema, table, file, **args)
     TableDumper.new(database, schema, table).dump_to(file, **args)
   end
+
+  # Generates a SQL dump of all extensions enabled on the database.
+  #
+  # @see ExtensionsDumper
+  # @param file [String]
+  # @param connection [ActiveRecord::ConnectionAdapters::PostgreSQLAdapter] connection adapter
+  def self.dump_extensions(file, connection = ActiveRecord::Base.connection, **args)
+    ExtensionsDumper.new(connection).dump_to(file, **args)
+  end
 end

data/lib/multitenancy_tools/extensions_dumper.rb

@@ -0,0 +1,41 @@
+module MultitenancyTools
+  # {ExtensionsDumper} can be used to generate a SQL dump of all extensions that
+  # are enabled on a PostgreSQL database.
+  #
+  # @example
+  #   dumper = MultitenancyTools::ExtensionsDumper.new
+  #   dumper.dump_to('path/to/file.sql')
+  class ExtensionsDumper
+    EXTENSION_SQL = <<-'SQL'.freeze
+      SELECT extname, nspname FROM pg_catalog.pg_extension
+      JOIN pg_catalog.pg_namespace n ON (extnamespace = n.oid)
+    SQL
+
+    CREATE_EXTENSION_SQL = 'CREATE EXTENSION IF NOT EXISTS "%s" WITH SCHEMA %s;'.freeze
+
+    # @param connection [ActiveRecord::ConnectionAdapters::PostgreSQLAdapter] connection adapter
+    def initialize(connection = ActiveRecord::Base.connection)
+      @connection = connection
+    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(EXTENSION_SQL)
+
+      File.open(file, mode) do |f|
+        results.each do |result|
+          name = result.fetch('extname')
+          schema = result.fetch('nspname')
+
+          f.puts(format(CREATE_EXTENSION_SQL, name, schema))
+        end
+      end
+    end
+  end
+end

data/lib/multitenancy_tools/functions_dumper.rb

@@ -2,10 +2,23 @@ module MultitenancyTools
   # {FunctionsDumper} can be used to generate a SQL dump of all functions that
   # are present on a PostgreSQL schema.
   #
+  # Please note that C functions are not included in the dump.
+  #
   # @example
   #   dumper = MultitenancyTools::FunctionsDumper.new('schema name')
   #   dumper.dump_to('path/to/file.sql')
   class FunctionsDumper
+    FUNCTIONS_SQL = <<-SQL.freeze
+      SELECT
+        trim(trailing e' \n' from pg_get_functiondef(f.oid)) || ';'
+        AS definition
+      FROM pg_catalog.pg_proc f
+      JOIN pg_catalog.pg_namespace n ON (f.pronamespace = n.oid)
+      JOIN pg_catalog.pg_language l ON (f.prolang = l.oid)
+      WHERE n.nspname = %s
+      AND l.lanname != 'c';
+    SQL
+
     # @param schema [String] schema name
     # @param connection [ActiveRecord::ConnectionAdapters::PostgreSQLAdapter] connection adapter
     def initialize(schema, connection = ActiveRecord::Base.connection)
@@ -21,18 +34,11 @@ module MultitenancyTools
     # @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
+      results = @connection.execute(format(FUNCTIONS_SQL, @schema))
 
       File.open(file, mode) do |f|
         results.each do |result|
-          f.write result['definition']
+          f.puts result.fetch('definition')
         end
       end
     end

data/lib/multitenancy_tools/schema_dumper.rb

@@ -9,6 +9,7 @@ module MultitenancyTools
   # * tablespace assigments
   # * ownership information
   # * any table data
+  # * extensions (CREATE EXTENSION)
   #
   # {SchemaDumper} is suitable to create SQL templates for {SchemaCreator}.
   #

data/lib/multitenancy_tools/version.rb

@@ -1,3 +1,3 @@
 module MultitenancyTools
-  VERSION = '0.1.11'
+  VERSION = '0.1.12'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: multitenancy_tools
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.12
 platform: ruby
 authors:
 - Lenon Marcel
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-02 00:00:00.000000000 Z
+date: 2015-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -147,6 +147,7 @@ files:
 - lib/multitenancy_tools.rb
 - lib/multitenancy_tools/dump_cleaner.rb
 - lib/multitenancy_tools/errors.rb
+- lib/multitenancy_tools/extensions_dumper.rb
 - lib/multitenancy_tools/functions_dumper.rb
 - lib/multitenancy_tools/schema_creator.rb
 - lib/multitenancy_tools/schema_destroyer.rb
@@ -176,7 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: A collection of tools for multitenant Ruby/Rails apps