postmodern 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d013705c58d3482656ad333f0076fb2a05ed88fe
-  data.tar.gz: 31856208b6be6e7e39c5366dc04ffea60f06143f
+  metadata.gz: b6751185ec42ad83428d20347ec925ecca99080a
+  data.tar.gz: e2055ed0ca440c7739ccda5d1a4e1687a64c1ef7
 SHA512:
-  metadata.gz: 15b9cd5442b710534d42e67d9511a2abf2ddf93b5a26bd5bd4bf3de6612a4397c1759d8c2a8750466abd87e74fde6550dba497223a73cebdc2464205edd6a3a3
-  data.tar.gz: 12e4927b7fac0afe85b06785ca6ba7a9ed01200efdcb1244d7b931e4ab619dd46166e6b629c8318ff531ff8a0af3c5b182673895caac57eb68548e338e76ed47
+  metadata.gz: 67846656007c0e10721af39593d07ad28fe93a15fd3a1a17f6a13874a6ea232f5fdcf14f7e508634d71453e1bd2ee06d030495d84027c44c234b6503eebd04da
+  data.tar.gz: db5af7acb228f891ae5e447bbb3259298308134fd8f564e97f078539fcff59c08e7ff6076e8b45d5256236edfeac1d553af762e756cdd98dedfc9572d1897da5

data/README.md

@@ -8,12 +8,47 @@ Tools for managing PostgreSQL databases.
 ## Installation
 
 ```bash
-gem install postmodern
+[sudo] gem install postmodern
 ```
 
+As a system utility, this assumes that you are installing the gem into
+the system's ruby, however that is installed.
+
 ## Usage
 
-TBD
+### WAL archives
+
+The wal archiving scripts packaged in this gem are intended to serve as
+wrappers for YOUR archiving mechanism.
+
+In postgresql.conf
+
+```
+archive_command = 'pg_wal_archive %p %f'
+```
+
+In recovery.conf
+
+```
+restore_command = 'pg_wal_restore %p %f'
+```
+
+By default these scripts will do nothing. With the presence of local
+scripts available in the path, the following variables will be
+exported to the environment and the local scripts called (with arguments
+preserved):
+
+```ruby
+ENV['WAL_ARCHIVE_PATH'] = ARGV[0]
+ENV['WAL_ARCHIVE_FILE'] = ARGV[1]
+```
+
+Local scripts can be written in any language. They should be able access
+the relevant arguments either as $1, $2 or using the variables listed above.
+
+`pg_wal_archive` will attempt to call a `pg_wal_archive.local` script.
+`pg_wal_restore` will attempt to call a `pg_wal_restore.local` script.
+
 
 ## Contributing
 

data/bin/pg_wal_archive

@@ -7,11 +7,13 @@
 # This script (and the local script) should be executable as the
 # postgres user.
 
-ENV['WAL_ARCHIVE_FILE']=ARGV[0] # maps to %f in postgres archiving
-ENV['WAL_ARCHIVE_PATH']=ARGV[1] # maps to %p in postgres archiving
+archive_path = ARGV[0]
+archive_file = ARGV[1]
 
-puts "Archiving file: #{ENV['WAL_ARCHIVE_FILE']}"
-puts "Archiving path: #{ENV['WAL_ARCHIVE_PATH']}"
+ENV['WAL_ARCHIVE_PATH']=archive_path # maps to %p in postgres archiving
+ENV['WAL_ARCHIVE_FILE']=archive_file # maps to %f in postgres archiving
+
+puts "Archiving file: #{archive_file}, path: #{archive_path}"
 
 def local_script_exists?
   `which pg_wal_archive.local >/dev/null 2>/dev/null`
@@ -19,5 +21,5 @@ def local_script_exists?
 end
 
 if local_script_exists?
-  `pg_wal_archive.local`
+  `pg_wal_archive.local #{archive_path} #{archive_file}`
 end

data/bin/pg_wal_restore

@@ -1,10 +1,18 @@
 #!/usr/bin/env ruby
 
+archive_path = ARGV[0]
+archive_file = ARGV[1]
+
+ENV['WAL_ARCHIVE_PATH']=archive_path # maps to %p in postgres archiving
+ENV['WAL_ARCHIVE_FILE']=archive_file # maps to %f in postgres archiving
+
+puts "Archiving file: #{archive_file}, path: #{archive_path}"
+
 def local_script_exists?
   `which pg_wal_restore.local >/dev/null 2>/dev/null`
   $?.exitstatus == 0
 end
 
 if local_script_exists?
-  `pg_wal_restore.local #{ARGV[0]} #{ARGV[1]}`
+  `pg_wal_restore.local #{archive_path} #{archive_file}`
 end

data/lib/postmodern/version.rb

@@ -1,3 +1,3 @@
 module Postmodern
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/bin/pg_wal_archive_spec.rb

@@ -6,12 +6,12 @@ describe 'pg_wal_archive' do
     double_cmd('which', exit: 1)
   end
 
-  it 'exports WAL_ARCHIVE_FILE' do
-    expect(`bin/pg_wal_archive filename filepath`).to include('Archiving file: filename')
+  it 'exports second argument as WAL_ARCHIVE_FILE' do
+    expect(`bin/pg_wal_archive filepath filename`).to include('Archiving file: filename')
   end
 
-  it 'exports WAL_ARCHIVE_PATH' do
-    expect(`bin/pg_wal_archive filename filepath`).to include('Archiving path: filepath')
+  it 'exports first argument WAL_ARCHIVE_PATH' do
+    expect(`bin/pg_wal_archive filepath filename`).to include('path: filepath')
   end
 
   context 'when local script is present' do
@@ -24,7 +24,7 @@ describe 'pg_wal_archive' do
     it 'calls a local file with file name and path' do
       expect {
         `bin/pg_wal_archive 11111 222222`
-      }.to shellout('pg_wal_archive.local')
+      }.to shellout('pg_wal_archive.local 11111 222222')
     end
   end
 
@@ -38,7 +38,7 @@ describe 'pg_wal_archive' do
     it 'does nothing' do
       expect {
         `bin/pg_wal_archive 11111 222222`
-      }.not_to shellout('pg_wal_archive.local')
+      }.not_to shellout('pg_wal_archive.local 11111 222222')
     end
   end
 end

data/spec/bin/pg_wal_restore_spec.rb

@@ -3,6 +3,15 @@ require 'spec_helper'
 describe 'pg_wal_restore' do
   before do
     double_cmd('pg_wal_restore.local')
+    double_cmd('which')
+  end
+
+  it 'exports second argument as WAL_ARCHIVE_FILE' do
+    expect(`bin/pg_wal_restore filepath filename`).to include('Archiving file: filename')
+  end
+
+  it 'exports first argument as WAL_ARCHIVE_PATH' do
+    expect(`bin/pg_wal_restore filepath filename`).to include('path: filepath')
   end
 
   context 'when local script exists' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: postmodern
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Eric Saxby