hrk 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b49a0cf56d15242a4698692039f7bc6bcbe5ba6
-  data.tar.gz: 14d7a71edcf4b28066719f2d4e39f250348b6963
+  metadata.gz: 67b379c0812c173de1d738d526b6b350947acf9c
+  data.tar.gz: 30708b927366d6842771652f86fcd73b6a962593
 SHA512:
-  metadata.gz: 56ba559a77eac95014dd40ca7351342ad09bcb3607d858ecb164505d1195b2009426631756c4864e0ffd7ae4c998c7be1c453c39eecbb5f9ab234a50c53f92e7
-  data.tar.gz: 9f0acc8e03334c960b4acd870cfc9d69235de3c64ade99817991a3a53c433f97180bd5c92135fd3155420b00803e06b067b6d1f881015fa3d515604dd4f366f8
+  metadata.gz: f74f6a0f912eb4baa1b6d02c202f71c9791b375c0d34b7e4a54598fb67c16a0ec1e262ce37414e672c0c459fc9b0d01b0727eb99847c939572a1a5d9b0748876
+  data.tar.gz: 6b029a0c02a97c3f4632a90c4f157928e28e9a1cb7c28f085b944285d936933d917c4226cc03fd91a9a4dff4ea316b3d28af623f6fa96e1caebc9a4a15c05dce

data/bin/hrk

@@ -1,3 +1,9 @@
 #!/usr/bin/env ruby
 
-exit (if system("heroku #{ARGV.drop(1).join " "} -r #{ARGV.first}") then 0 else 1 end)
+begin
+  $:.unshift(File.expand_path(File.dirname(__FILE__) + '/../lib'))
+  require 'hrk'
+rescue IOError
+end
+
+exit (if Hrk::Execute.(*ARGV) then 0 else 1 end)

data/lib/hrk.rb

@@ -0,0 +1,4 @@
+module Hrk
+  autoload :Heroku,  'hrk/heroku'
+  autoload :Execute, 'hrk/execute'
+end

data/lib/hrk/execute.rb

@@ -0,0 +1,15 @@
+module Hrk
+  module Execute
+    autoload :Command, 'hrk/execute/command'
+    autoload :Help,    'hrk/execute/help'
+
+    def self.call *args
+      executer.call *args
+    end
+
+    def self.executer
+      Hrk::Execute::Help.new \
+        Hrk::Execute::Command.new
+    end
+  end
+end

data/lib/hrk/execute/command.rb

@@ -0,0 +1,12 @@
+module Hrk
+  module Execute
+    class Command
+      REMOTE_MATCHER = %r{\A(.+):\Z}
+
+      def call remote, *args
+        raise ArgumentError.new("#{remote.inspect} isn't a proper remote marker") unless remote =~ REMOTE_MATCHER
+        Hrk::Heroku.new(remote[REMOTE_MATCHER, 1]).call(args.join(' '))
+      end
+    end
+  end
+end

data/lib/hrk/execute/help.rb

@@ -0,0 +1,36 @@
+module Hrk
+  module Execute
+    class Help
+      def initialize fallback = nil
+        @fallback = fallback
+      end
+
+      def call *args
+        if args.empty? || args.first =~ %r(\A(?:(?:(?:-)?h)|(?:(?:--)?help))\Z)
+          display || true
+        else
+          fallback *args
+        end
+      end
+
+      def display
+        puts <<-eos
+Usage:
+  hrk remote: command..."
+  hrk [h | help | -h | --help]"
+
+Options:
+  -h --help Display this screen.
+        eos
+      end
+
+      def fallback *args
+        if @fallback
+          @fallback.call *args
+        else
+          raise ArgumentError.new
+        end
+      end
+    end
+  end
+end

data/lib/hrk/heroku.rb

@@ -0,0 +1,21 @@
+module Hrk
+  class Heroku
+    def initialize remote_name
+      @remote_name = remote_name
+    end
+
+    def call command
+      validate! command
+      system %Q(heroku #{command} -r #{@remote_name})
+    end
+
+    private
+
+    def validate! command
+      raise ExplicitApplicationError.new, "You're calling a command on remote #{@remote_name} yet the command explicitely references #{command[%r{-[ar]\s+\S+}]}" if command =~ %r{ -[ra]\b}
+    end
+
+    class ExplicitApplicationError < Exception
+    end
+  end
+end

data/spec/hrk/execute/command_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+RSpec.describe Hrk::Execute::Command do
+  describe '#call' do
+    subject(:command) { Hrk::Execute::Command.new }
+
+    describe 'standard case (a remote, a command)' do
+      let(:remote) { "remote-#{rand(1..9)}" }
+      let(:args)   { %w(whatever that:may -b) }
+
+      let(:heroku) { double("Hrk::Heroku") }
+      before { allow(heroku).to receive(:call) }
+      before { allow(Hrk::Heroku).to receive(:new).and_return(heroku) }
+
+      before { command.call "#{remote}:", *args }
+
+      it { expect(Hrk::Heroku).to have_received(:new).with(remote) }
+      it { expect(heroku).to have_received(:call).with("whatever that:may -b") }
+    end
+
+    describe 'edge cases (no remote or improper remote)' do
+      let(:other_args) { %w(something or-another) }
+      it { expect { command.call }.to raise_error ArgumentError }
+      it { expect { command.call "bad-remote", *other_args }.to raise_error ArgumentError }
+      it { expect { command.call ":misplaced-marker", *other_args }.to raise_error ArgumentError }
+      it { expect { command.call ":", *other_args }.to raise_error ArgumentError }
+    end
+  end
+end

data/spec/hrk/execute/help_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+RSpec.describe Hrk::Execute::Help do
+  describe '#call' do
+    subject(:help) { Hrk::Execute::Help.new }
+
+    describe 'with the right arguments' do
+      before { expect(help).to receive :display }
+
+      it { expect(help.call).to eq true }
+      it { expect(help.call('h')).to eq true }
+      it { expect(help.call('-h')).to eq true }
+      it { expect(help.call('help')).to eq true }
+      it { expect(help.call('--help')).to eq true }
+    end
+
+    describe 'with wrong arguments' do
+      [
+        %w(run rake db:migrate),
+        %w(helpe),
+        %w(ahelp)
+      ].each do |args|
+        before { allow(help).to receive(:fallback).with(*args).and_return :fallouts }
+
+        it { expect(help.call(*args)).to eq :fallouts}
+      end
+    end
+  end
+
+  describe '#display' do
+    subject(:help) { Hrk::Execute::Help.new }
+
+    before { allow(help).to receive :puts }
+    before { help.display }
+
+    it { expect(help).to have_received(:puts).at_least(1).times }
+  end
+
+  describe '#fallback' do
+    describe 'without a fallback command' do
+      subject(:help) { Hrk::Execute::Help.new }
+
+      it { expect { help.fallback(*%w(whatever arguments it received)) }.to raise_error ArgumentError }
+    end
+
+    describe 'with a fallback command' do
+      let(:fallback) { double }
+      before { allow(fallback).to receive :call }
+
+      subject(:help) { Hrk::Execute::Help.new fallback }
+
+      before { expect(fallback).to receive(:call).with(*%w(whatever arguments it received)).and_return(:some_result) }
+
+      it { expect(help.fallback(*%w(whatever arguments it received))).to eq :some_result }
+    end
+  end
+end

data/spec/hrk/execute_spec.rb

@@ -0,0 +1,19 @@
+require 'hrk/execute'
+
+RSpec.describe Hrk::Execute do
+  describe '.call' do
+    let(:executer) { double }
+    let(:args)     { %w(run rake db:migrate) }
+
+    before { allow(Hrk::Execute).to receive(:executer).and_return(executer) }
+    before { expect(executer).to receive(:call).with(*args).and_return(return_value) }
+
+    [true, false].each do |value|
+      describe "the executer returns #{value}" do
+        let(:return_value) { value }
+
+        it { expect(Hrk::Execute.call(*args)).to eq return_value }
+      end
+    end
+  end
+end

data/spec/hrk/heroku_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+RSpec.describe Hrk::Heroku do
+  describe '#call' do
+    describe 'the system command ran' do
+      def self.calling command, on_remote: 'whatever-app', starts: ''
+        describe "calling '#{command}' on remote '#{on_remote}', system" do
+          subject(:heroku) { Hrk::Heroku.new(on_remote) }
+
+          before { heroku.call command }
+
+          it { expect(heroku).to have_received(:system).with(starts) }
+        end
+      end
+
+      before { allow(heroku).to receive(:system) }
+
+      describe '(standard case)' do
+        calling 'call rake db:rollback', on_remote: 'demo',    starts: 'heroku call rake db:rollback -r demo'
+        calling 'call rake db:migrate',  on_remote: 'prod',    starts: 'heroku call rake db:migrate -r prod'
+        calling 'call console',          on_remote: 'staging', starts: 'heroku call console -r staging'
+        calling 'logs -t',               on_remote: 'prod',    starts: 'heroku logs -t -r prod'
+        calling 'pgbackups:capture',     on_remote: 'demo',    starts: 'heroku pgbackups:capture -r demo'
+      end
+
+      describe '(edge case)' do
+        subject(:heroku) { Hrk::Heroku.new('some-remote') }
+
+        it { expect { heroku.call('run rake rake:db:migrate -r some-other-remote') }.to raise_exception(Hrk::Heroku::ExplicitApplicationError) }
+        it { expect { heroku.call('run rake rake:db:migrate -a different-app') }.to raise_exception(Hrk::Heroku::ExplicitApplicationError) }
+      end
+    end
+
+    describe 'the result of the command' do
+      subject(:heroku) { Hrk::Heroku.new('some-remote') }
+      before { allow(heroku).to receive(:system).with('heroku some command -r some-remote').and_return(system_returns) }
+
+      context 'the command result is truthy' do
+        let(:system_returns) { true }
+
+        it { expect(heroku.call('some command')).to be_truthy }
+      end
+
+      context 'the command result is falsy' do
+        let(:system_returns) { false }
+
+        it { expect(heroku.call('some command')).to be_falsy }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'hrk'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+  config.disable_monkey_patching!
+  config.warnings = true
+  config.default_formatter =
+    if config.files_to_run.one?
+      'doc'
+    else
+      'NyanCatFormatter'
+    end
+
+  config.order = :random
+
+  Kernel.srand config.seed
+end

metadata

@@ -1,15 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: hrk
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Michel Belleville
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-18 00:00:00.000000000 Z
-dependencies: []
+date: 2015-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nyan-cat-formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Hrk 2 swim like a dolphin in a sea of heroku commands
 email: michel.belleville@gmail.com
 executables:
@@ -19,6 +61,16 @@ extra_rdoc_files: []
 files:
 - README.md
 - bin/hrk
+- lib/hrk.rb
+- lib/hrk/execute.rb
+- lib/hrk/execute/command.rb
+- lib/hrk/execute/help.rb
+- lib/hrk/heroku.rb
+- spec/hrk/execute/command_spec.rb
+- spec/hrk/execute/help_spec.rb
+- spec/hrk/execute_spec.rb
+- spec/hrk/heroku_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/Bastes/hrk
 licenses:
 - GPL-3