hrk 0.0.6 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a5606eeb5d8dc713063b4d76ef4633a60d0ba61
-  data.tar.gz: db35ff5cc2c2ea9445087056d1057a4a1db4100f
+  metadata.gz: e8df14c2ca4330a91a5cf758825844724e93a4b6
+  data.tar.gz: 4cf32f72933c72821c09b662ed07fbb62525e3bf
 SHA512:
-  metadata.gz: 425ecb4c9bb064204f13a074b1e3b21b1c066a754241a5d62bfa66ff6a01d9b2bd69736aa85f778e5d9996f50f697ec4b9514ad56f4b5d9ed8a431b62cca0eb9
-  data.tar.gz: c3d7d9ae715a2a0ba7846c6915b975bbf6e589dafd06b0554ca9f2e604491447fc1c2f8531a54b79fc6b6a07be1af6a5b147b048f4405182c82416284d2aed78
+  metadata.gz: fbaf173a98a54834352a8bd0122d21561760f4a6d8f77922b44aac0a2d702b7ecac4a72ac51cdb4fd93c2669693b8a270c6bc91cb99a5940adf3a0f47e67032a
+  data.tar.gz: 98edc74b9c2f69ca20be31d9d3b84319da03046a02aff5bf55bb94d17c47103159482daa6f1ccc122b2e0291cfa7fe269780aa5c899de6eb272f63b971e61e3b

data/README.md

@@ -138,6 +138,7 @@ $ hrk -r demo run rake db:migrate && \ # happens on demo
 **...I place the "-r remote" argument at the end of the command, the heroku way**
 
 It just works.
+
 ```bash
 # this command
 $ hrk run console -r demo
@@ -145,6 +146,17 @@ $ hrk run console -r demo
 $ hrk -r demo run console
 ```
 
+**...I prefer naming my app instead of the remote?**
+
+You can use either the -r or -a option, either will work as expected and the
+latest option will be memorized for subsequent uses.
+
+```bash
+$ hrk maintenance:on -a my-super-duper-app && \ # happens on my-super-duper-app
+  hrk run console && \                          # again on my-super-duper-app
+  hrk maintenance:off                           # aaand on my-super-duper-app
+```
+
 ## Do I still need the heroku toolbelt?
 
 Yes. The hrk command calls the heroku command for you, it does not replace it.

data/lib/hrk/env.rb

@@ -5,16 +5,16 @@ require 'tmpdir'
 
 module Hrk
   class Env
-    def remote= remote_name
-      if remote_name
-        socket_path.write remote_name unless remote == remote_name
+    def remote= *args
+      if args
+        socket_path.write args.join(' ') unless remote == args
       else
         socket_path.delete if remote?
       end
     end
 
     def remote
-      socket_path.read if remote?
+      socket_path.read.split(' ', 2) if remote?
     end
 
     def remote?

data/lib/hrk/execute/command.rb

@@ -3,29 +3,33 @@ module Hrk
     class Command
       attr_reader :env
 
+      ARG = /\A-[ar]\Z/
+
       def initialize
         @env = Hrk::Env.new
       end
 
       def call *args
-        remote = remote_name args
+        remote, command = remote_and_command args
         if remote
           @env.remote = remote
-          Hrk::Heroku.new(remote).call(remoteless_command(remote, args))
+          Hrk::Heroku.new(*remote).call(*command)
         else
           raise ArgumentError.new("No remote has been previously defined and the command does not explicitely mention a remote") unless @env.remote?
-          Hrk::Heroku.new(@env.remote).call(args.join(' '))
+          Hrk::Heroku.new(*@env.remote).call(*command)
         end
       end
 
-      private
-
-      def remote_name args
-        args.each_cons(2).detect { |(parameter, _)| parameter == '-r' }.join ' ' rescue nil
-      end
-
-      def remoteless_command remote, args
-        args.join(' ').gsub(%r{\s*#{remote}\s*}, ' ').strip
+      def remote_and_command args
+        args.slice_before { |arg| arg =~ ARG }.inject([nil, []]) do |r, slice|
+          if slice.first =~ ARG
+            raise ArgumentError.new('Remote option without value') if slice.length < 2
+            raise ArgumentError.new('Too many remotes mentionned') if r.first
+            [slice.take(2), r.last + slice.drop(2)]
+          else
+            [r.first, r.last + slice]
+          end
+        end
       end
     end
   end

data/lib/hrk/execute/help.rb

@@ -16,17 +16,25 @@ module Hrk
       def display
         puts <<-eos
 Usage:
-  hrk [remote]: command...
+  hrk command [(-r remote | -a appname)]...
   hrk [h | help | -h | --help]
 
-hrk remembers the last remote you've used to send a command on this terminal,
-and use it by default when you omit the optional [remote] argument.
+The hrk command remembers the last app you've send a command to on a terminal
+to use it when you omit the optional -r or -a option on subsequent calls.
 
 The command is whatever you would give heroku, except (obviously) for the
 -r or -a argument.
 
+Note that whatever argument and/or options the command is composed of should not
+be tampered with and passed as is to the heroku toolbelt command.
+
 Options:
-  -h --help Display this screen.
+  -h --help   Display this screen.
+  -r remote   Sets the remote for this command and the following
+  -a appname  Sets the heroku app name for this command and the following
+
+More on the hrk command on the gem's website:
+https://github.com/Bastes/hrk
         eos
       end
 

data/lib/hrk/heroku.rb

@@ -1,18 +1,19 @@
 module Hrk
   class Heroku
-    def initialize remote
+    def initialize *remote
       @remote = remote
     end
 
-    def call command
-      validate! command
-      system %Q(heroku #{command} #{@remote})
+    def call *command
+      validate! *command
+      system 'heroku', *(command + @remote)
     end
 
     private
 
-    def validate! command
-      raise ExplicitApplicationError.new, "You're calling a command on remote #{@remote} yet the command explicitly references #{command[%r{-[ar]\s+\S+}]}" if command =~ %r{ -[ra]\b}
+    def validate! *command
+      remote = (command.each_cons(2).detect { |(parameter, _)| parameter =~ %r{\A-[ar]\Z} }.join ' ' rescue nil)
+      raise ExplicitApplicationError.new, "You're calling a command on remote #{@remote.join " "} yet the command explicitly references #{remote}" if remote
     end
 
     class ExplicitApplicationError < Exception

data/lib/hrk.rb

@@ -1,4 +1,6 @@
 module Hrk
+  VERSION = '0.0.8'
+
   autoload :Env,     'hrk/env'
   autoload :Heroku,  'hrk/heroku'
   autoload :Execute, 'hrk/execute'

data/spec/hrk/execute/command_spec.rb

@@ -17,38 +17,48 @@ RSpec.describe Hrk::Execute::Command do
         let(:remote) { "remote-#{rand(1..9)}" }
         let(:args)   { %w(whatever that:may -b) }
 
-        [true, false].each do |result|
-          describe "when the command returns #{result}" do
-            before { allow(heroku).to receive(:call).and_return(result) }
-
-            it { expect(command.call('-r', remote, *args)).to eq result }
+        %w(-a -r).each do |opt|
+          context "using #{opt}" do
+            [true, false].each do |result|
+              context "when the command returns #{result}" do
+                before { allow(heroku).to receive(:call).and_return(result) }
+
+                it { expect(command.call(opt, remote, *args)).to eq result }
+              end
+            end
+
+            describe 'interactions' do
+              before { command.call opt, remote, *args }
+
+              it { expect(Hrk::Heroku).to have_received(:new).with(opt, remote) }
+              it { expect(heroku).to have_received(:call).with(*%w{whatever that:may -b}) }
+              it { expect(command.env).to have_received(:remote=).with([opt, remote]) }
+            end
           end
         end
-
-        describe 'interactions' do
-          before { command.call '-r', remote, *args }
-
-          it { expect(Hrk::Heroku).to have_received(:new).with("-r #{remote}") }
-          it { expect(heroku).to have_received(:call).with("whatever that:may -b") }
-          it { expect(command.env).to have_received(:remote=).with("-r #{remote}") }
-        end
       end
 
-      describe 'edge cases (no remote or improper remote)' do
-        let(:other_args) { %W(something-#{rand(1..9)} or-another) }
+      describe 'edge cases (no remote, improper remote, too many remotes...)' do
+        let(:other_args) { %W(something-#{rand(1..9)} -o r --another) }
 
         before { expect(heroku).not_to receive(:call) }
         before { expect(command.env).not_to receive(:remote=) }
 
         it { expect { command.call }.to raise_error ArgumentError }
         it { expect { command.call "parameterless-remote", *other_args }.to raise_error ArgumentError }
+        it { expect { command.call *other_args }.to raise_error ArgumentError }
         it { expect { command.call *other_args, '-r' }.to raise_error ArgumentError }
+        it { expect { command.call *other_args, '-a' }.to raise_error ArgumentError }
+        it { expect { command.call '-r', 'remote', *other_args, '-r', 'other-remote' }.to raise_error ArgumentError }
+        it { expect { command.call '-r', 'remote', *other_args, '-a', 'app' }.to raise_error ArgumentError }
+        it { expect { command.call '-a', 'app', *other_args, '-a', 'other-app' }.to raise_error ArgumentError }
+        it { expect { command.call '-r', 'something', *other_args, '-a', 'something-else' }.to raise_error ArgumentError }
       end
     end
 
     context 'a remote was previously memorized' do
-      let(:previous_remote) { "-r ye-olde-remote#{rand(1..9)}" }
-      before { allow(command.env).to receive(:remote).and_return(previous_remote) }
+      let(:previous_remote) { "ye-olde-remote#{rand(1..9)}" }
+      before { allow(command.env).to receive(:remote).and_return(['-r', previous_remote]) }
       before { allow(command.env).to receive(:remote?).and_return(true) }
 
       describe 'standard case (a remote, a command)' do
@@ -66,9 +76,9 @@ RSpec.describe Hrk::Execute::Command do
         describe 'interactions' do
           before { command.call '-r', remote, *args }
 
-          it { expect(Hrk::Heroku).to have_received(:new).with("-r #{remote}") }
-          it { expect(heroku).to have_received(:call).with("whatever that:may -b") }
-          it { expect(command.env).to have_received(:remote=).with("-r #{remote}") }
+          it { expect(Hrk::Heroku).to have_received(:new).with('-r', remote) }
+          it { expect(heroku).to have_received(:call).with(*%w{whatever that:may -b}) }
+          it { expect(command.env).to have_received(:remote=).with(['-r', remote]) }
         end
       end
 
@@ -86,10 +96,45 @@ RSpec.describe Hrk::Execute::Command do
         describe 'interactions' do
           before { command.call *args }
 
-          it { expect(Hrk::Heroku).to have_received(:new).with(previous_remote) }
-          it { expect(heroku).to have_received(:call).with("whatever that:may -b") }
+          it { expect(Hrk::Heroku).to have_received(:new).with('-r', previous_remote) }
+          it { expect(heroku).to have_received(:call).with(*%w{whatever that:may -b}) }
         end
       end
+
+      describe 'edge cases (improper remote, too many remotes...)' do
+        let(:other_args) { %W(--whatever#{rand(1..9)} dude) }
+
+        before { expect(heroku).not_to receive(:call) }
+        before { expect(command.env).not_to receive(:remote=) }
+
+        it { expect { command.call *other_args, '-r' }.to raise_error ArgumentError }
+        it { expect { command.call *other_args, '-a' }.to raise_error ArgumentError }
+        it { expect { command.call '-r', 'remote', *other_args, '-r', 'other-remote' }.to raise_error ArgumentError }
+        it { expect { command.call '-r', 'remote', *other_args, '-a', 'app' }.to raise_error ArgumentError }
+        it { expect { command.call '-a', 'app', *other_args, '-a', 'other-app' }.to raise_error ArgumentError }
+        it { expect { command.call '-r', 'something', *other_args, '-a', 'something-else' }.to raise_error ArgumentError }
+      end
+    end
+  end
+
+  describe '#remote_and_command' do
+    subject(:command) { Hrk::Execute::Command.new }
+
+    context '(standard cases, arguments parsed)' do
+      it { expect(command.remote_and_command(%w(run rake db:migrate))).to eq [nil, %w(run rake db:migrate)] }
+      it { expect(command.remote_and_command(%w(restart))).to eq [nil, %w(restart)] }
+      it { expect(command.remote_and_command(%w(-r demo restart))).to eq [%w(-r demo), %w(restart)] }
+      it { expect(command.remote_and_command(%w(run rake db:migrate -r prod))).to eq [%w(-r prod), %w(run rake db:migrate)] }
+      it { expect(command.remote_and_command(%w(some command -r test -i dont know --about))).to eq [%w(-r test), %w(some command -i dont know --about)] }
+    end
+
+    context '(edge cases, argument errors)' do
+      it { expect { command.remote_and_command(%w(-r staging logs -t -r test)) }.to raise_error ArgumentError }
+      it { expect { command.remote_and_command(%w(-a prod run rake db:migrate -r echo)) }.to raise_error ArgumentError }
+      it { expect { command.remote_and_command(%w(run console -r demo -a app)) }.to raise_error ArgumentError }
+      it { expect { command.remote_and_command(%w(-a one -a other maintenance:on)) }.to raise_error ArgumentError }
+      it { expect { command.remote_and_command(%w(maintenance:off -a)) }.to raise_error ArgumentError }
+      it { expect { command.remote_and_command(%w(restart -r)) }.to raise_error ArgumentError }
     end
   end
 end

data/spec/hrk/heroku_spec.rb

@@ -3,48 +3,50 @@ 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) }
+      def self.calling command, on_remote: %W(-r whatever-app), starts: ''
+        describe "calling '#{command.join ' '}' on remote '#{on_remote}', system" do
+          subject(:heroku) { Hrk::Heroku.new(*on_remote) }
 
-          before { heroku.call command }
+          before { heroku.call *command }
 
-          it { expect(heroku).to have_received(:system).with(starts) }
+          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: '-r demo',    starts: 'heroku call rake db:rollback -r demo'
-        calling 'call rake db:migrate',  on_remote: '-r prod',    starts: 'heroku call rake db:migrate -r prod'
-        calling 'call console',          on_remote: '-r staging', starts: 'heroku call console -r staging'
-        calling 'logs -t',               on_remote: '-r prod',    starts: 'heroku logs -t -r prod'
-        calling 'pgbackups:capture',     on_remote: '-r demo',    starts: 'heroku pgbackups:capture -r demo'
+      %w(-a -r).each do |opt|
+        describe "(standard case, using #{opt})" do
+          calling %w(call rake db:rollback), on_remote: %W(#{opt} demo),    starts: %W(heroku call rake db:rollback #{opt} demo)
+          calling %w(call rake db:migrate),  on_remote: %W(#{opt} prod),    starts: %W(heroku call rake db:migrate #{opt} prod)
+          calling %w(call console),          on_remote: %W(#{opt} staging), starts: %W(heroku call console #{opt} staging)
+          calling %w(logs -t),               on_remote: %W(#{opt} prod),    starts: %W(heroku logs -t #{opt} prod)
+          calling %w(pgbackups:capture),     on_remote: %W(#{opt} demo),    starts: %W(heroku pgbackups:capture #{opt} demo)
+        end
       end
 
       describe '(edge case)' do
-        subject(:heroku) { Hrk::Heroku.new('some-remote') }
+        subject(:heroku) { Hrk::Heroku.new(*%w(-r 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) }
+        it { expect { heroku.call(*%w(run rake rake:db:migrate -r some-other-remote)) }.to raise_exception(Hrk::Heroku::ExplicitApplicationError) }
+        it { expect { heroku.call(*%w(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('-r some-remote') }
-      before { allow(heroku).to receive(:system).with('heroku some command -r some-remote').and_return(system_returns) }
+      subject(:heroku) { Hrk::Heroku.new(*%w(-r some-remote)) }
+      before { allow(heroku).to receive(:system).with(*%W(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 }
+        it { expect(heroku.call(*%w(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 }
+        it { expect(heroku.call(*%w(some command))).to be_falsy }
       end
     end
   end

metadata

@@ -1,75 +1,115 @@
 --- !ruby/object:Gem::Specification
 name: hrk
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.8
 platform: ruby
 authors:
 - Michel Belleville
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-06 00:00:00.000000000 Z
+date: 2015-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
-    - - "<"
+        version: '3.1'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 3.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
-    - - "<"
+        version: '3.1'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: nyan-cat-formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.11'
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.11'
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.5.0
-    - - "<"
+        version: '4.5'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 4.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.5.0
-    - - "<"
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 0.2.4
 description: |
   Hrk gives you the hrk command that proxies commands to heroku, keeping track of
   the latest remote you used so you don't have to keep on typing it on every