postmodern 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c873bca7e7b892917fe6b1d1e0f322985419209c
-  data.tar.gz: a183be591075d4c67948124695ad69da0c3e35e3
+  metadata.gz: 15bd95a1daf5a24f06fcfa1645094b3bd1a76c0c
+  data.tar.gz: 60aeb0096180e784f4e13e812075319523609823
 SHA512:
-  metadata.gz: bf053810004c5e3a9e6f1876d95e90996d23ad4134ef6f06893b101e88701c1e7d75e24d344a6f97fb3ffdb853581221cd47ecdd88823c9065dfa01fa4aa602e
-  data.tar.gz: c49137fac8a2fed972ce655364e69fdf63aea8a8aac3fba6925acc9e1872a2a6bf595a65f2b0690dca5cba754b7c6285346d7f3110b6d4c504f7e93a81c1003e
+  metadata.gz: fac44addd806dc9688c1cf5a076c2bed5b6ebf6aa44c58d1c78357a9c4046b3735aa13317b0fa890546f6202d054c3a2971bfb7806c09b4cfa5f13a78a16b0f0
+  data.tar.gz: bc2afb31d22804a418ed917b5bae2d1422cf4740b41ab3cdab0508a4edbaa2a12566afde2c6c445e16fc6f3e5c51504e4d211230baa59e0281c0a6be8adcb836

data/bin/postmodern

@@ -2,38 +2,6 @@
 
 $:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
 
-require 'postmodern/errors'
-require 'postmodern/wal'
-require 'optparse'
+require 'postmodern/runner'
 
-options = {}
-parser = OptionParser.new do |opts|
-  opts.banner = "Usage: postmodern (archive|restore) <options>"
-
-  opts.on('-f', '--filename FILE', 'File name to archive') do |o|
-    options[:file] = o
-  end
-
-  opts.on('-p', '--path PATH', 'Path name of file to archive') do |o|
-    options[:path] = o
-  end
-
-  opts.on_tail("-h", "--help", "Show this message") do
-    puts opts
-    exit
-  end
-
-  opts.on_tail("--version", "Show version") do
-    require 'postmodern/version'
-    puts Postmodern::VERSION
-    exit
-  end
-end
-parser.parse!
-
-begin
-  Postmodern::WAL.run(ARGV.first, options)
-rescue Postmodern::Error => e
-  puts e.message
-  puts parser.to_s
-end
+Postmodern::Runner.run(ARGV)

data/lib/postmodern.rb

@@ -1,5 +1,4 @@
 require "postmodern/version"
 
 module Postmodern
-  # Your code goes here...
 end

data/lib/postmodern/command.rb

@@ -0,0 +1,37 @@
+require 'optparse'
+
+module Postmodern
+  class Command
+    def self.required_options
+      @required_options ||= []
+    end
+
+    def parser
+      OptionParser.new
+    end
+
+    attr_reader :options
+
+    def initialize(args)
+      @options = {}
+
+      parse_args(args)
+      validate!
+    end
+
+    def run
+    end
+
+    def validate!
+      if (self.class.required_options - self.options.keys).any?
+        puts parser
+        exit 1
+      end
+    end
+
+    def parse_args(args)
+      parser.parse!(args)
+      self.options
+    end
+  end
+end

data/lib/postmodern/dummy.rb

@@ -0,0 +1,29 @@
+require 'postmodern/command'
+
+module Postmodern
+  class Dummy < Command
+    def parser
+      @parser ||= OptionParser.new do |opts|
+        opts.banner = "Usage: postmodern <command> <options>"
+
+        opts.separator ""
+        opts.separator "Available commands:"
+        opts.separator "    archive"
+        opts.separator "    restore"
+        opts.separator ""
+        opts.separator "Options:"
+
+        opts.on_tail("-h", "--help", "Show this message") do
+          puts opts
+          exit
+        end
+
+        opts.on_tail("--version", "Show version") do
+          require 'postmodern/version'
+          puts Postmodern::VERSION
+          exit
+        end
+      end
+    end
+  end
+end

data/lib/postmodern/runner.rb

@@ -0,0 +1,22 @@
+require 'postmodern/wal'
+require 'postmodern/dummy'
+
+module Postmodern
+  module Runner
+    attr_reader :argv
+
+    DEFAULT_COMMAND = Dummy
+    COMMAND_MAP = {
+      'archive' => WAL::Archive,
+      'restore' => WAL::Restore
+    }.freeze
+
+    def self.run(args)
+      command_for(args.first).new(args).run
+    end
+    
+    def self.command_for(command)
+      COMMAND_MAP[command] || DEFAULT_COMMAND
+    end
+  end
+end

data/lib/postmodern/version.rb

@@ -1,3 +1,3 @@
 module Postmodern
-  VERSION = "0.0.10"
+  VERSION = "0.0.11"
 end

data/lib/postmodern/wal.rb

@@ -1,23 +1,3 @@
 require 'postmodern/wal/archive'
 require 'postmodern/wal/restore'
-require 'postmodern/errors'
 
-module Postmodern
-  module WAL
-    COMMANDS = {
-      'archive' => Postmodern::WAL::Archive,
-      'restore' => Postmodern::WAL::Restore
-    }
-
-    def self.run(command, options)
-      validate!(options)
-      COMMANDS[command].new(options[:file], options[:path]).run
-    end
-
-    def self.validate!(options)
-      unless options[:file] and options[:path]
-        raise Postmodern::Error.new('Missing required options')
-      end
-    end
-  end
-end

data/lib/postmodern/wal/archive.rb

@@ -1,8 +1,64 @@
-require_relative 'base'
+require 'postmodern/command'
 
 module Postmodern
   module WAL
-    class Archive < Base
+    class Archive < Postmodern::Command
+      required_options << :file
+      required_options << :path
+
+      def parser
+        @parser ||= OptionParser.new do |opts|
+          opts.banner = "Usage: postmodern (archive|restore) <options>"
+
+          opts.on('-f', '--filename FILE', 'File name of xlog') do |o|
+            self.options[:file] = o
+          end
+
+          opts.on('-p', '--path PATH', 'Path of xlog file') do |o|
+            self.options[:path] = o
+          end
+
+          opts.on_tail("-h", "--help", "Show this message") do
+            puts opts
+            exit
+          end
+
+          opts.on_tail("--version", "Show version") do
+            require 'postmodern/version'
+            puts Postmodern::VERSION
+            exit
+          end
+        end
+      end
+
+      def run
+        if local_script_exists?
+          IO.popen("#{local_script} #{path} #{filename}",
+                   env: {
+            'WAL_ARCHIVE_PATH' => path,
+            'WAL_ARCHIVE_FILE' => filename,
+            'PATH' => ENV['PATH']
+          }) { |f| puts f.gets }
+        end
+      end
+
+      private
+
+      def path
+        @options[:path]
+      end
+
+      def filename
+        @options[:file]
+      end
+
+      def local_script_exists?
+        system({'PATH' => ENV['PATH']}, "which #{local_script} >/dev/null 2>/dev/null")
+      end
+
+      def local_script
+        'postmodern_archive.local'
+      end
     end
   end
 end

data/lib/postmodern/wal/restore.rb

@@ -1,8 +1,8 @@
-require_relative 'base'
+require_relative 'archive'
 
 module Postmodern
   module WAL
-    class Restore < Base
+    class Restore < Archive
       private
 
       def local_script

data/spec/features/archive_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe 'archive help' do
+  it 'responds' do
+    expect(`bin/postmodern archive --help`).to eq <<-END
+Usage: postmodern (archive|restore) <options>
+    -f, --filename FILE              File name of xlog
+    -p, --path PATH                  Path of xlog file
+    -h, --help                       Show this message
+        --version                    Show version
+    END
+  end
+end
+
+describe 'archive' do
+  let(:command) { `bin/postmodern archive --path filepath --filename filename` }
+
+  let(:usage) { <<-END
+Usage: postmodern (archive|restore) <options>
+    -f, --filename FILE              File name of xlog
+    -p, --path PATH                  Path of xlog file
+    -h, --help                       Show this message
+        --version                    Show version
+                END
+  }
+
+  before do
+    double_cmd('postmodern_archive.local', exit: 0)
+  end
+
+  describe 'validations' do
+    context 'with no --path' do
+      let(:command) { `bin/postmodern archive --filename filename` }
+
+      it 'fails' do
+        expect { command }.to have_exit_status(1)
+      end
+
+      it 'prints usage' do
+        expect(command).to eq(usage)
+      end
+    end
+
+    context 'with no --filename' do
+      let(:command) { `bin/postmodern archive --path path` }
+
+      it 'fails' do
+        expect { command }.to have_exit_status(1)
+      end
+
+      it 'prints usage' do
+        expect(command).to eq(usage)
+      end
+    end
+  end
+
+  context 'when local script is present' do
+    before { double_cmd('which postmodern_archive.local', exit: 0) }
+
+    it 'succeeds' do
+      expect { command }.to have_exit_status(0)
+    end
+
+    it 'calls a local file with file name and path' do
+      expect { command }.to shellout('postmodern_archive.local filepath filename')
+    end
+  end
+
+  context 'when local script is not present' do
+    before { double_cmd('which postmodern_archive.local', exit: 1) }
+
+    it 'succeeds' do
+      expect { command }.to have_exit_status(0)
+    end
+
+    it 'does nothing' do
+      expect { command }.not_to shellout('pg_wal_archive.local filepath filename')
+    end
+  end
+end

data/spec/features/dummy_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'postmodern/version'
+
+describe 'dummy help' do
+  it 'responds with usage info' do
+    expect(`bin/postmodern --help`).to eq <<-END
+Usage: postmodern <command> <options>
+
+Available commands:
+    archive
+    restore
+
+Options:
+    -h, --help                       Show this message
+        --version                    Show version
+    END
+  end
+end
+
+describe 'dummy version' do
+  it 'responds with the Postmodern version' do
+    expect(`bin/postmodern --version`).to match(Postmodern::VERSION)
+  end
+end

data/spec/features/restore_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe 'restore help' do
+  it 'responds' do
+    expect(`bin/postmodern restore --help`).to eq <<-END
+Usage: postmodern (archive|restore) <options>
+    -f, --filename FILE              File name of xlog
+    -p, --path PATH                  Path of xlog file
+    -h, --help                       Show this message
+        --version                    Show version
+    END
+  end
+end
+
+describe 'restore' do
+  let(:command) { `bin/postmodern restore --path filepath --filename filename` }
+
+  before do
+    double_cmd('postmodern_restore.local')
+  end
+
+  context 'when local script is present' do
+    before { double_cmd('which', exit: 0) }
+
+    it 'succeeds' do
+      expect { command }.to have_exit_status(0)
+    end
+
+    it 'calls a local file with file name and path' do
+      expect { command }.to shellout('postmodern_restore.local filepath filename')
+    end
+  end
+
+  context 'when local script is not present' do
+    before { double_cmd('which', exit: 1) }
+
+    it 'succeeds' do
+      expect { command }.to have_exit_status(0)
+    end
+
+    it 'does nothing' do
+      expect { command }.not_to shellout('pg_wal_restore.local filepath filename')
+    end
+  end
+end

data/spec/postmodern/runner_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+require 'postmodern/runner'
+
+describe Postmodern::Runner do
+
+  describe '.command' do
+    it 'chooses archiver' do
+      expect(Postmodern::Runner.command_for('archive')).to be Postmodern::WAL::Archive
+    end
+
+    it 'chooses restorer' do
+      expect(Postmodern::Runner.command_for('restore')).to be Postmodern::WAL::Restore
+    end
+
+    it 'defaults to dummy' do
+      expect(Postmodern::Runner.command_for('ljfaldf')).to be Postmodern::Dummy
+    end
+  end
+
+  describe '.run' do
+    it 'runs the command class' do
+      args = ['blahrgh', 'first', 'second']
+      dummy_class = double
+      expect(Postmodern::Runner).to receive(:command_for).and_return(dummy_class)
+      expect(dummy_class).to receive(:new).with(args).and_return(dummy_class)
+      expect(dummy_class).to receive(:run)
+      Postmodern::Runner.run(args)
+    end
+  end
+end

data/spec/postmodern/wal/archive_spec.rb

@@ -6,8 +6,9 @@ describe Postmodern::WAL::Archive do
 
   let(:filename) { "some_file" }
   let(:path) { "/path/to/file" }
+  let(:arguments) { %W(--filename #{filename} --path #{path}) }
 
-  subject(:archiver) { Postmodern::WAL::Archive.new(filename, path) }
+  subject(:archiver) { Postmodern::WAL::Archive.new(arguments) }
 
   describe '#run' do
     let(:expected_command) { "postmodern_archive.local #{path} #{filename}" }

data/spec/postmodern/wal/restore_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require 'postmodern/wal/restore'
+
+describe Postmodern::WAL::Restore do
+  before { allow(IO).to receive(:popen) }
+
+  let(:filename) { "some_file" }
+  let(:path) { "/path/to/file" }
+  let(:arguments) { %W(--filename #{filename} --path #{path}) }
+
+  subject(:restorer) { Postmodern::WAL::Restore.new(arguments) }
+
+  describe '#run' do
+    let(:expected_command) { "postmodern_restore.local #{path} #{filename}" }
+
+    context 'when local script exists' do
+      before { double_cmd('which postmodern_restore.local', exit: 0) }
+
+      it 'executes postmodern_restore.local with filename and path' do
+        restorer.run
+        expect(IO).to have_received(:popen).with(expected_command, env:
+          {
+            'WAL_ARCHIVE_PATH' => path,
+            'WAL_ARCHIVE_FILE' => filename,
+            'PATH' => anything
+          }
+        )
+      end
+    end
+
+    context 'when local script does not exist' do
+      before { double_cmd('which postmodern_restore.local', exit: 1) }
+
+      it 'executes postmodern_restore.local with filename and path' do
+        restorer.run
+        expect(IO).not_to have_received(:popen)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: postmodern
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Eric Saxby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-28 00:00:00.000000000 Z
+date: 2014-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,15 +56,20 @@ files:
 - Rakefile
 - bin/postmodern
 - lib/postmodern.rb
-- lib/postmodern/errors.rb
+- lib/postmodern/command.rb
+- lib/postmodern/dummy.rb
+- lib/postmodern/runner.rb
 - lib/postmodern/version.rb
 - lib/postmodern/wal.rb
 - lib/postmodern/wal/archive.rb
-- lib/postmodern/wal/base.rb
 - lib/postmodern/wal/restore.rb
 - postmodern.gemspec
-- spec/bin/postmodern_spec.rb
+- spec/features/archive_spec.rb
+- spec/features/dummy_spec.rb
+- spec/features/restore_spec.rb
+- spec/postmodern/runner_spec.rb
 - spec/postmodern/wal/archive_spec.rb
+- spec/postmodern/wal/restore_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/wanelo/postmodern
 licenses:
@@ -91,7 +96,11 @@ signing_key:
 specification_version: 4
 summary: Tools for managing PostgreSQL
 test_files:
-- spec/bin/postmodern_spec.rb
+- spec/features/archive_spec.rb
+- spec/features/dummy_spec.rb
+- spec/features/restore_spec.rb
+- spec/postmodern/runner_spec.rb
 - spec/postmodern/wal/archive_spec.rb
+- spec/postmodern/wal/restore_spec.rb
 - spec/spec_helper.rb
 has_rdoc: 

data/lib/postmodern/errors.rb

@@ -1,4 +0,0 @@
-module Postmodern
-  class Error < StandardError
-  end
-end

data/lib/postmodern/wal/base.rb

@@ -1,34 +0,0 @@
-module Postmodern
-  module WAL
-    class Base
-      attr_reader :filename, :path
-
-      def initialize(filename, path)
-        @filename = filename
-        @path = path
-      end
-
-      def run
-        if local_script_exists?
-          IO.popen("#{local_script} #{path} #{filename}",
-            env: {
-              'WAL_ARCHIVE_PATH' => path,
-              'WAL_ARCHIVE_FILE' => filename,
-              'PATH' => ENV['PATH']
-            })
-        end
-      end
-
-      private
-
-      def local_script_exists?
-        `which #{local_script} >/dev/null 2>/dev/null`
-        $?.exitstatus == 0
-      end
-
-      def local_script
-        'postmodern_archive.local'
-      end
-    end
-  end
-end

data/spec/bin/postmodern_spec.rb

@@ -1,67 +0,0 @@
-require 'spec_helper'
-
-describe 'postmodern' do
-  describe 'archive' do
-    let(:command) { `bin/postmodern archive --path filepath --filename filename` }
-
-    before do
-      double_cmd('postmodern_archive.local')
-    end
-
-    context 'when local script is present' do
-      before { double_cmd('which', exit: 0) }
-
-      it 'succeeds' do
-        expect { command }.to have_exit_status(0)
-      end
-
-      it 'calls a local file with file name and path' do
-        expect { command }.to shellout('postmodern_archive.local filepath filename')
-      end
-    end
-
-    context 'when local script is not present' do
-      before { double_cmd('which', exit: 1) }
-
-      it 'succeeds' do
-        expect { command }.to have_exit_status(0)
-      end
-
-      it 'does nothing' do
-        expect { command }.not_to shellout('pg_wal_archive.local filepath filename')
-      end
-    end
-  end
-
-  describe 'restore' do
-    let(:command) { `bin/postmodern restore --path filepath --filename filename` }
-
-    before do
-      double_cmd('postmodern_restore.local')
-    end
-
-    context 'when local script is present' do
-      before { double_cmd('which', exit: 0) }
-
-      it 'succeeds' do
-        expect { command }.to have_exit_status(0)
-      end
-
-      it 'calls a local file with file name and path' do
-        expect { command }.to shellout('postmodern_restore.local filepath filename')
-      end
-    end
-
-    context 'when local script is not present' do
-      before { double_cmd('which', exit: 1) }
-
-      it 'succeeds' do
-        expect { command }.to have_exit_status(0)
-      end
-
-      it 'does nothing' do
-        expect { command }.not_to shellout('pg_wal_restore.local filepath filename')
-      end
-    end
-  end
-end