cmd_runner 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 75dc4bed7102dec3ca424559b297593ef550fee4
+  data.tar.gz: 09bfc5189491f249602231122a021e7e48bc4ae8
+SHA512:
+  metadata.gz: bbc0097d22eab29ed2e4b12417e55a427b352dbecca68ee86bc42cdbfb3ec418e43707e6059822b3054216fdeabe58f91cd3b99fc5d72d654d9758833dc126dd
+  data.tar.gz: f0ea2f24974b3035620ff3ad81f5da5653e856d7d6a66313b0ef9b5e34ccdfbb49f8fb9b7ce6cbdac3c2be21a9d7f264ade3342f10255f2342d1fdf1aa148c99

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+*.swp
+*.swo
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cmd_runner.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Denis Yagofarov
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+# CmdRunner
+
+Simple wrapper for Open3 to execute command.
+The command treated as an object and is able to be executed.
+You can specify `logger` to point runtime messages to and
+`work_dir` to change into it before each run.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cmd_runner'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cmd_runner
+
+## Usage
+
+```ruby
+  cmd = CmdRunner::Command.new('ls')
+  cmd.work_dir = '/tmp'
+  cmd.logger   = Logger.new('./ls.log')
+  cmd.execute!
+  #=> [0, "launch-qO1j87\ntextmate-501.sock\n", '']
+```
+
+## Contributing
+
+As always:
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/cmd_runner.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cmd_runner/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cmd_runner"
+  spec.version       = CmdRunner::VERSION
+  spec.authors       = ["Denis Yagofarov"]
+  spec.email         = ["denyago@gmail.com"]
+  spec.description   = %q{Simple helper to run commands}
+  spec.summary       = %q{Simple helper to run commands}
+  spec.homepage      = 'https://github.com/denyago/cmd_runner'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry-debugger"
+end

data/lib/cmd_runner/version.rb

@@ -0,0 +1,3 @@
+module CmdRunner
+  VERSION = "0.0.1"
+end

data/lib/cmd_runner.rb

@@ -0,0 +1,74 @@
+require 'cmd_runner/version'
+require 'logger'
+require 'open3'
+
+module CmdRunner
+  ##
+  # Class: Command
+  #
+  # Runs a command and grabs STDOUT, STDERR.
+  # Checks exit status to raise an exception in case of non-zero.
+  #
+  # Example:
+  #   runner = CmdRunner::Command.new
+  #   runner.work_dir = '/tmp'   # to change dir before every command
+  #   runner.logger = Logger.new # to log command results
+  #   runner.execute!('ls')      #=> [0, '.\n..\n', '']
+  #
+  class Command
+    # Change directory before each command
+    attr_accessor :work_dir
+    # Logger to output command results
+    attr_accessor :logger
+    # Command to execute
+    attr_writer :cmd
+
+    def cmd
+      if self.work_dir.to_s.empty?
+        @cmd
+      else
+        "cd #{self.work_dir} && " + @cmd
+      end
+    end
+
+    # Executes command.
+    #
+    # Raises:
+    #   - {RuntimeError} if command returned non-zero status
+    #
+    # Returns {Array} with exit status, stdout, stderr
+    def execute!
+      result = ''
+      error  = ''
+
+      stdin, stdout, stderr, wait_thr = Open3.popen3(self.cmd)
+      exit_status = wait_thr.value.exitstatus
+      result << stdout.read
+      error  << stderr.read
+
+      raise "Command exited with non zero status: #{self.cmd}" unless exit_status.zero?
+      [exit_status, result, error]
+    ensure
+      logger.info   '-'*25
+      logger.info   "Command: #{self.cmd}"
+      logger.info   result
+      logger.error  error
+      logger.info   '-'*25
+    end
+
+  private
+
+    # Initializer
+    #
+    # Params:
+    #   - cmd {String} with command to run
+    #
+    def initialize(cmd)
+      @cmd = cmd
+    end
+
+    def logger
+      @logger ||= ::Logger.new(STDOUT)
+    end
+  end
+end

data/spec/cmd_runner/command_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe CmdRunner::Command do
+  subject { described_class.new(command) }
+
+  before do
+    subject.logger = Logger.new('/dev/null')
+  end
+
+  context 'successfully' do
+    let(:command) { 'ls' }
+
+    it 'runns' do
+      results = subject.execute!
+      expect(results[0]).to eq(0)
+      expect(results[1]).to_not be_empty
+      expect(results[2]).to be_empty
+    end
+
+    context 'in a work dir' do
+      it 'cd to work dir before it runns' do
+        subject.work_dir = 'foo'
+        expect(subject.cmd).to match /^cd foo && /
+      end
+    end
+  end
+
+  context 'unsuccessfully' do
+    let(:command) { 'exit 1' }
+
+    it 'runns' do
+      expect { subject.execute! }.to raise_error("Command exited with non zero status: exit 1")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rspec'
+require 'rspec/mocks'
+require 'pry'
+
+require 'cmd_runner'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.mock_with :rspec
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: cmd_runner
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Denis Yagofarov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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: pry-debugger
+  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: Simple helper to run commands
+email:
+- denyago@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cmd_runner.gemspec
+- lib/cmd_runner.rb
+- lib/cmd_runner/version.rb
+- spec/cmd_runner/command_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/denyago/cmd_runner
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.5
+signing_key: 
+specification_version: 4
+summary: Simple helper to run commands
+test_files:
+- spec/cmd_runner/command_spec.rb
+- spec/spec_helper.rb