kuromi 0.0.1

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - "1.9.2"
+  - "1.9.3"
+  - "2.0.0"

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in boxy.gemspec
+gemspec
+
+group :test do
+  gem 'mocha', require: false
+  gem 'minitest', require: false
+  gem 'simplecov', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 On The Beach LTD
+
+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,58 @@
+# Kuromi
+
+[![Build Status](https://travis-ci.org/onthebeach/kuromi.png)](https://travis-ci.org/onthebeach/kuromi)
+[![Code Climate](https://codeclimate.com/github/onthebeach/kuromi.png)](https://codeclimate.com/github/onthebeach/kuromi)
+
+Kuromi is a command runner and a pretty DSL around your command line. It's basically a nice friendly way to interact with `Open3#popen3` from the standard library
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'kuromi', github: 'onthebeach/kuromi'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kuromi
+
+## Usage
+
+Commands are built using Runners. and can be built up in chains until they are finally executed with `#run`.
+
+    output = Kuromi::Runner.for('hostname').run
+
+You will end up with a Kuromi::Output object that you can use.
+
+    output.code # => 0, the exit code of the process
+    output.stdout # => Optional information from STDOUT
+    output.stderr # => Optional information from STDERR
+
+like most OnTheBeach projects, Kuromi is allergic to `nil` so where applicable (currently `stdout` and `stderr` do this) you will either get `Some[value]` or `None`. For the implementation of Optional Values see [the Optional gem here](http://github.com/rsslldnphy/optional)
+
+You can pass extra arguments and build up command line chains with Kuromi using `#command`, `#with` and `#and`. For example
+
+    Kuromi::Runner.for('git').
+      command('rebase').
+      with('--interactive').
+      and('origin/master').
+      run
+
+## TODO
+
+* Kuromi is synchronous - it will block while your command is being executed.
+
+## Contributing
+
+Pull requests are welcome. Please ensure they're tested or we may reject them.
+
+Run the tests as follows
+
+    bundle exec rake
+
+or with coverage
+
+    COVERAGE=true bundle exec rake

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/kuromi.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kuromi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kuromi"
+  spec.version       = Kuromi::VERSION
+  spec.authors       = ["Matt House"]
+  spec.email         = ["matt@eightbitraptor.com"]
+  spec.description   = %q{Kuromi is an application runner}
+  spec.summary       = %q{Kuromi provides a DSL for running command lines in Ruby}
+  spec.homepage      = ""
+  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_dependency "optional"
+end

data/lib/kuromi.rb

@@ -0,0 +1,7 @@
+require "optional"
+
+require "kuromi/runner"
+require "kuromi/version"
+
+module Kuromi
+end

data/lib/kuromi/runner.rb

@@ -0,0 +1,11 @@
+require_relative 'runner/all'
+
+module Kuromi
+  class Runner
+
+    def self.for(binary_name)
+      Binary.new(binary_name)
+    end
+  end
+end
+

data/lib/kuromi/runner/all.rb

@@ -0,0 +1,8 @@
+require_relative 'runnable'
+require_relative 'options'
+
+require_relative 'binary'
+require_relative 'command'
+require_relative 'option_value'
+
+require_relative 'output'

data/lib/kuromi/runner/binary.rb

@@ -0,0 +1,24 @@
+module Kuromi
+  class Runner
+    class Binary
+      include Runnable
+      include Options
+
+      def initialize(name)
+        @name = name
+      end
+
+      def command(com)
+        Command.new(self, com)
+      end
+
+      def to_s
+        name
+      end
+
+      private
+
+      attr_reader :name
+    end
+  end
+end

data/lib/kuromi/runner/command.rb

@@ -0,0 +1,21 @@
+module Kuromi
+  class Runner
+    class Command
+      include Runnable
+      include Options
+
+      def initialize(binary, command)
+        @binary = binary
+        @command = command
+      end
+
+      def to_s
+        "#{binary} #{command}"
+      end
+
+      private
+
+      attr_reader :binary, :command
+    end
+  end
+end

data/lib/kuromi/runner/option_value.rb

@@ -0,0 +1,22 @@
+module Kuromi
+  class Runner
+    class OptionValue
+      include Runnable
+      include Options
+
+      def initialize(binary, option, value)
+        @binary = binary
+        @option = option
+        @value = value
+      end
+
+      def to_s
+        "#{binary} #{option} #{value}".strip
+      end
+
+      private
+
+      attr_reader :binary, :option, :value
+    end
+  end
+end

data/lib/kuromi/runner/options.rb

@@ -0,0 +1,11 @@
+module Kuromi
+  class Runner
+    module Options
+      def with(option, value=nil)
+        OptionValue.new(self, option, value)
+      end
+
+      alias_method :and, :with
+    end
+  end
+end

data/lib/kuromi/runner/output.rb

@@ -0,0 +1,17 @@
+module Kuromi
+  class Runner
+    class Output
+      attr_reader :stdout, :stderr, :code
+
+      def initialize(code, stdout, stderr)
+        @code = code
+        @stdout = Option[stdout]
+        @stderr = Option[stderr]
+      end
+
+      def success?
+        @code == 0
+      end
+    end
+  end
+end

data/lib/kuromi/runner/runnable.rb

@@ -0,0 +1,13 @@
+require 'open3'
+
+module Kuromi
+  class Runner
+    module Runnable
+      def run
+        Open3.popen3(self.to_s) do |sin, sout, serr, thr|
+          return Output.new(thr.value, sout.read, serr.read)
+        end
+      end
+    end
+  end
+end

data/lib/kuromi/version.rb

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

data/test/lib/kuromi/output_test.rb

@@ -0,0 +1,66 @@
+require 'test_helper'
+
+module Kuromi
+  describe "Runner Output" do
+    it "is returned from a Runner object" do
+      Open3.expects(:popen3).yields(stub,
+                                    stub(read: nil),
+                                    stub(read: nil),
+                                    stub(value: 0))
+
+      output = Runner.for('ps').run
+      output.must_be_instance_of Runner::Output
+    end
+  end
+
+  describe "An Output object" do
+    let(:stdout){ stub }
+    let(:stderr){ stub }
+    let(:stdin){ stub }
+
+    subject{ Runner.for('hostname').run }
+
+    it "puts the stdout stream in the output object" do
+      stdout.expects(:read).returns('hitomi')
+      stderr.stubs(:read)
+      Open3.expects(:popen3).yields(stdin, stdout, stderr, stub(:value => 0))
+
+      subject.stdout.must_equal Some['hitomi']
+    end
+
+    it "puts the exit code in the output object" do
+      stdout.stubs(:read)
+      stderr.stubs(:read)
+      Open3.expects(:popen3).yields(stdin, stdout, stderr, stub(:value => 0))
+
+      subject.code.must_equal 0
+    end
+
+    it "puts the stderr stream in the output object" do
+      stdout.stubs(:read)
+      stderr.expects(:read).returns('ERR: Panic')
+      Open3.expects(:popen3).yields(stdin, stdout, stderr, stub(:value => 1))
+
+      subject.stderr.must_equal Some['ERR: Panic']
+    end
+
+    it "reports success and failure" do
+      Open3.expects(:popen3).yields(stub,
+                                    stub(read: nil),
+                                    stub(read: nil),
+                                    stub(value: 0))
+
+      subject.success?.must_equal true
+    end
+
+    it "reports failure" do
+      Open3.expects(:popen3).yields(stub,
+                                    stub(read: nil),
+                                    stub(read: nil),
+                                    stub(value: 1))
+
+      subject.success?.must_equal false
+    end
+  end
+
+end

data/test/lib/kuromi/runner_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+
+module Kuromi
+  describe "running a binary" do
+    subject { Runner.for('hostname')}
+
+    it "runs" do
+      Open3.expects(:popen3).with("hostname")
+      subject.run
+    end
+  end
+
+  describe "running a binary with a command" do
+    subject { Runner.for('git').command('st') }
+
+    it "runs" do
+      Open3.expects(:popen3).with("git st")
+      subject.run
+    end
+  end
+
+  describe "running a binary with options" do
+    let(:runner) { Runner.for('ps').with('-ef') }
+
+    it "runs with a single option" do
+      Open3.expects(:popen3).with("ps -ef")
+      runner.run
+    end
+
+    it "runs with multiple options" do
+      Open3.expects(:popen3).with("ps -ef foo")
+      runner.and("foo").run
+    end
+  end
+
+  describe "chaining all the things" do
+    let(:runner) { Runner.for('git').
+                     command('rebase').
+                     with('--interactive').
+                     and('origin/safe') }
+
+    it "runs with everything" do
+      Open3.expects(:popen3).with("git rebase --interactive origin/safe")
+      runner.run
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,16 @@
+require 'simplecov'
+if ENV['COVERAGE']
+  SimpleCov.start do
+    add_filter "/test/"
+  end
+end
+
+require 'minitest/autorun'
+require 'mocha/setup'
+
+require 'kuromi'
+
+Mocha::Configuration.prevent(:stubbing_non_existent_method)
+Mocha::Configuration.prevent(:stubbing_method_unnecessarily)
+Mocha::Configuration.prevent(:stubbing_non_public_method)
+

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: kuromi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Matt House
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: optional
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Kuromi is an application runner
+email:
+- matt@eightbitraptor.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- kuromi.gemspec
+- lib/kuromi.rb
+- lib/kuromi/runner.rb
+- lib/kuromi/runner/all.rb
+- lib/kuromi/runner/binary.rb
+- lib/kuromi/runner/command.rb
+- lib/kuromi/runner/option_value.rb
+- lib/kuromi/runner/options.rb
+- lib/kuromi/runner/output.rb
+- lib/kuromi/runner/runnable.rb
+- lib/kuromi/version.rb
+- test/lib/kuromi/output_test.rb
+- test/lib/kuromi/runner_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Kuromi provides a DSL for running command lines in Ruby
+test_files:
+- test/lib/kuromi/output_test.rb
+- test/lib/kuromi/runner_test.rb
+- test/test_helper.rb