psql-cm 0.0.1 → 0.0.2

data/History.md

@@ -0,0 +1,7 @@
+# 0.0.2 - 2012-04-18
+
+Initial 'dump' feature.
+
+# 0.0.1 - 2012-04-17
+
+Project setup, initial gem pushed to rubygems.org

data/README.md

@@ -1,4 +1,32 @@
 # PostgreSQL Change Management Tool
 
+This project is a tool for schema change management within a PostgreSQL database
+cluster.
 
+# Setup
+
+Setup the psql\_cm control tables on the target databases,
+
+    $ psql-cm --databases psqlcm_test --uri "postgres://127.0.0.1:5432" setup
+
+# Dump
+
+Dump the current database schema to the specified --sql-path directory, if none
+specified it dumps to $PWD/sql
+
+    $ psql-cm --databases psqlcm_test --uri "postgres://127.0.0.1:5432" dump
+
+# Restore
+
+Restore a previously psql-cm dumped database schema into a brand new postgresql
+database cluster.
+
+    $ psql-cm --databases psqlcm_test --uri "postgres://127.0.0.1:5432" restore
+
+# Example
+
+    $ createdb psqlcm_test
+    $ psql psqlcm_test -c 'CREATE SCHEMA schema_one; CREATE SCHEMA schema_two'
+    $ psql-cm --databases psqlcm_test --uri "postgres://127.0.0.1:5432" setup
+    $ psql-cm --databases psqlcm_test --uri "postgres://127.0.0.1:5432" dump
 

data/lib/psql-cm/base.rb

@@ -14,24 +14,24 @@ module PSQLCM
     end
 
     def config
-      require 'ostruct'
       @config ||= OpenStruct.new
-    end # def self.config
+    end
 
     def databases
       @databases = db.
         exec("SELECT datname as name FROM pg_database WHERE datname !~ 'template*|postgres';").
         map {|row| row["name"]}
 
-      debug "databases> #{@databases}"
-      unless config.databases.to_a.empty?
+      unless config.databases.to_a.empty? # filter out databases not specified.
         @databases.select!{ |name| config.databases.include?(name) }
       end
+
+      debug "databases> #{@databases}"
       @databases
     end
 
-    def schemas
-      @schemas = db.
+    def schemas(name = 'postgres')
+      @schemas = db(name).
         exec("SELECT nspname as name FROM pg_namespace WHERE nspname !~ '^pg_.*|information_schema';").
         map{|row| row["name"]}
       debug "schemas> #{@schemas}"
@@ -41,35 +41,33 @@ module PSQLCM
     def tree
       return @tree if @tree
       @tree = {}
-      databases.each do |name|
-        @config.connection["dbname"] = name and reconnect!
-        @tree[name] = {}
-        schemas.each do |schema|
-          @tree[name][schema] = ['base.sql', 'cm.sql']
+      databases.each do |dbname|
+        @tree[dbname] = {}
+        schemas(dbname).each do |schema|
+          @tree[dbname][schema] = ['base.sql', 'cm.sql']
         end
       end
       debug "tree> tree: #{@tree}"
       @tree
     end
 
-    def generate!
+    def dump!
       unless config.sql_path
         $stdout.puts "Warning: --sql-path was not set, defaulting to $PWD/sql."
         config.sql_path = "#{ENV["PWD"]}/sql"
       end
 
+      debug "dump> sql_path: #{config.sql_path}"
       FileUtils.mkdir(config.sql_path) unless File.directory?(config.sql_path)
-
-      debug "generate> sql_path: #{config.sql_path}"
       Dir.chdir(config.sql_path) do
-        tree.each_pair do |database, hash|
-          debug "generate> database: #{database}"
+        tree.each_pair do |database, schema_hash|
+          debug "dump> database: #{database}"
 
           File.directory?(File.join(config.sql_path,database)) or
             FileUtils.mkdir(File.join(config.sql_path,database))
 
-          hash.each_pair do |schema, files|
-          debug "generate> schema: #{schema}"
+          schema_hash.each_pair do |schema, files|
+          debug "dump> schema: #{schema}"
             File.directory?(File.join(config.sql_path,database,schema)) or
               FileUtils.mkdir(File.join(config.sql_path,database,schema))
 
@@ -86,12 +84,21 @@ module PSQLCM
               command += "--file=#{base_file} --exclude-table=psql_cm "
             end
             command += "#{database}"
-            debug "generate> #{command}"
+            debug "dump> #{command}"
 
             %x[#{command}]
           end
         end
       end
+    end # def dump!
+
+    def setup!
+      # Create psql_cm tables for each schema on the target db.
+    end
+
+    def load!
+      # TODO: Load psql-cm filesystem path files {base,cm}.sql into database
+      # structure.
     end
 
     def run!(action = config.action, parent_id = config.parent_id)
@@ -100,8 +107,12 @@ module PSQLCM
         ::PSQLCM.debug "Starting Console"
         require 'psql-cm/cli'
         ::PSQLCM::Console.run!
-      when "generate"
-        generate!
+      when "dump"
+        dump!
+      when "restore"
+        restore!
+      when "setup"
+        setup!
       else
         halt! "Action '#{action}' is not handled."
       end

data/lib/psql-cm/cli.rb

@@ -10,7 +10,7 @@ module PSQLCM
           options.separator ""
           options.separator "Specific options:"
 
-          options.on("-s", "--sql-path PATH", "Path to generate SQL cm files.") do |path|
+          options.on("-s", "--sql-path PATH", "Path to dump SQL cm files into.") do |path|
             ::PSQLCM.config.sql_path = path
           end
 
@@ -19,7 +19,7 @@ module PSQLCM
           end
 
           options.on("-u", "--uri URI", "Path to the sink database connection file.") do |uri|
-            ::PSQLCM.configure!(uri)
+            ::PSQLCM.config.uri = uri
           end
 
           options.on("-D", "--[no-]debug", "Output debugging information.") do |debug|

data/lib/psql-cm/database.rb

@@ -1,24 +1,45 @@
-require 'uri'
-
 module PSQLCM
-  # "postgres://{user}:{password}@{host}:{port}/{database}"
-  class << self
+  class Connection < Delegator
+    def initialize(options = {})
+      @name = options[:dbname] || 'postgres'
+      @config = ::PSQLCM.config.connection.merge(options)
+
+      super # For delegator pattern:
+      @delegated_object = db
+    end
+
+    # Delegator to PG::Connection
+    def __getobj__ ; @db end
+    def __setobj__(object) ;  end
+
     def db
-      return @db if @db
-      connect!
+      @db || connect!
     end
 
     def connect!
-      @config.connection ||= {"dbname" => "postgres"}
-      @db = PG.connect(@config.connection)
+      @db = PG.connect(@config)
     end
 
-    def reconnect!
-      @db.close
+    def reconnect!(name = @name)
+      close!
       connect!
     end
 
-    def configure!(uri)
+    def close!
+      @db.close
+    end
+  end # class Connection
+
+  class << self
+    def db(name = 'postgres')
+      @db ||= {}
+      return @db[name] if @db[name]
+      @config.connection || configure!
+      @db[name] = Connection.new(:dbname => name)
+    end
+
+    # "postgres://{user}:{password}@{host}:{port}/{database}"
+    def configure!
       uri = URI.parse(::PSQLCM.config.uri)
 
       query = uri.query.to_s.split('&')
@@ -37,5 +58,5 @@ module PSQLCM
       }.delete_if { |key, value| value.nil? }
     end
   end # class << self
-end # module PSQLCM
 
+end # module PSQLCM

data/lib/psql-cm/version.rb

@@ -1,4 +1,4 @@
 module PSQLCM
-  Version = '0.0.1'
+  Version = '0.0.2'
 end
 

data/lib/psql-cm.rb

@@ -1,5 +1,8 @@
 require 'pg'
 require 'fileutils'
+require 'ostruct'
+require 'uri'
+require 'delegate'
 
 require_relative 'psql-cm/base'
 require_relative 'psql-cm/database'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: psql-cm
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.13.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.13.2
 description: PostgreSQL Change Management Tool
 email:
 - wayneeseguin@gmail.com
@@ -43,6 +43,7 @@ files:
 - lib/psql-cm.rb
 - LICENCE
 - README.md
+- History.md
 - spec/psql-cm_spec.rb
 - spec/spec_helper.rb
 homepage: http://rubygems.org/gems/psql-cm/