tumugi-plugin-command 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c9b4591bbbf87266be270751214404f6a471c08a
+  data.tar.gz: f699a5e914c3b1d54afc23b28da9114960dfb239
+SHA512:
+  metadata.gz: a2bd5c5872f9815d00504c269dd7fc362f92e5b5169dfd32afa8eccf769c90606fe0d34386fbaeb8455f33b346a12340c4a64f69f6ac0cce97f67ea6435860f7
+  data.tar.gz: f02742e92853b41027b5974c0086d9a324f7a77051a6af1de6b5210d934e1c82fc8722a49cc77c5e031c58eef1ceeb80ef1adf23da0fbe0338b5bcca9731003a

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+test/tmp/

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.1.10
+  - 2.2.5
+  - 2.3.1
+  - ruby-head
+  - jruby-9.0.5.0
+before_install:
+  - gem install bundler
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/Gemfile

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

data/README.md

@@ -0,0 +1,82 @@
+[![Build Status](https://travis-ci.org/tumugi/tumugi-plugin-command.svg?branch=master)](https://travis-ci.org/tumugi/tumugi-plugin-command) [![Code Climate](https://codeclimate.com/github/tumugi/tumugi-plugin-command/badges/gpa.svg)](https://codeclimate.com/github/tumugi/tumugi-plugin-command) [![Coverage Status](https://coveralls.io/repos/github/tumugi/tumugi-plugin-command/badge.svg?branch=master)](https://coveralls.io/github/tumugi/tumugi-plugin-command)  [![Gem Version](https://badge.fury.io/rb/tumugi-plugin-command.svg)](https://badge.fury.io/rb/tumugi-plugin-command)
+
+# tumugi-plugin-command
+
+tumugi-plugin-command is a plugin to execute a command.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tumugi-plugin-command'
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install tumugi-plugin-command
+```
+
+## Task
+
+### Tumugi::Plugin::CommandTask
+
+`Tumugi::Plugin::BigqueryShellTask` is task to execute a specified command.
+
+#### Usage
+
+- Run command
+
+```rb
+task :task1, type: :command do
+  param_set :command, "ls -la"
+end
+```
+
+- Run command and save STDOUT into file
+
+```rb
+task :task1, type: :command do
+  param_set :command, "echo 'success'"
+  param_set :output_file, "result.txt"
+end
+```
+
+- Run external shell script
+
+```sh:external_script.sh
+#!/bin/sh
+echo 'success' > tmp/external_script_result.txt
+```
+
+```rb
+task :task1, type: :command do
+  requires :task2
+  param_set :command, -> { "cat #{input.path}" }
+end
+
+task :task2, type: :command do
+  param_set :command, "./examples/external_script.sh"
+  output target(:local_file, "tmp/external_script_result.txt")
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tumugi/tumugi-plugin-command.
+
+## License
+
+The gem is available as open source under the terms of the [Apache License
+Version 2.0](http://www.apache.org/licenses/).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tumugi/plugin/shell"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/external_script.sh

@@ -0,0 +1,2 @@
+#!/bin/sh
+echo 'success' > tmp/external_script_result.txt

data/examples/run_command.rb

@@ -0,0 +1,3 @@
+task :task1, type: :command do
+  param_set :command, "echo 'test test'"
+end

data/examples/run_external_script.rb

@@ -0,0 +1,9 @@
+task :task1, type: :command do
+  requires :task2
+  param_set :command, -> { "cat #{input.path}" }
+end
+
+task :task2, type: :command do
+  param_set :command, "./examples/external_script.sh"
+  output target(:local_file, "tmp/external_script_result.txt")
+end

data/examples/save_result_to_file.rb

@@ -0,0 +1,4 @@
+task :task1, type: :command do
+  param_set :command, "echo 'success'"
+  param_set :output_file, "tmp/result.txt"
+end

data/lib/tumugi/plugin/command/version.rb

@@ -0,0 +1,7 @@
+module Tumugi
+  module Plugin
+    module Command
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/tumugi/plugin/task/command.rb

@@ -0,0 +1,48 @@
+require 'open3'
+require 'shellwords'
+
+require 'tumugi/plugin'
+require 'tumugi/plugin/target/local_file.rb'
+require 'tumugi/task'
+
+module Tumugi
+  module Plugin
+    class CommandTask < Tumugi::Task
+      Tumugi::Plugin.register_task('command', self)
+
+      param :command, type: :string, required: true
+      param :output_file, type: :string
+
+      def output
+        unless output_file.nil?
+          Tumugi::Plugin::LocalFileTarget.new(output_file)
+        else
+          nil
+        end
+      end
+
+      def run
+        log "Execute command: #{command}"
+        begin
+          out, err, status = Open3.capture3(*Shellwords.split(command))
+        rescue => e
+          raise Tumugi::TumugiError, e.message
+        end
+
+        logger.info out unless out.empty?
+        logger.error err unless err.empty?
+
+        if status.exitstatus == 0
+          if output_file && _output
+            log "Save STDOUT into #{_output.path}"
+            _output.open('w') do |f|
+              f.print(out)
+            end
+          end
+        else
+          raise Tumugi::TumugiError, "Command failed: exit status is #{status.exitstatus}"
+        end
+      end
+    end
+  end
+end

data/tumugi-plugin-command.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tumugi/plugin/command/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tumugi-plugin-command"
+  spec.version       = Tumugi::Plugin::Command::VERSION
+  spec.authors       = ["Kazuyuki Honda"]
+  spec.email         = ["hakobera@gmail.com"]
+
+  spec.summary       = "Tumugi plugin to execute a command"
+  spec.homepage      = "https://github.com/tumugi/tumugi-plugin-command"
+  spec.license       = "Apache License Version 2.0"
+
+  spec.required_ruby_version = ">= 2.1"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "tumugi", "~> 0.4.5"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "test-unit", "~> 3.1"
+  spec.add_development_dependency "test-unit-rr"
+  spec.add_development_dependency 'coveralls'
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: tumugi-plugin-command
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kazuyuki Honda
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tumugi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: test-unit-rr
+  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: coveralls
+  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: 
+email:
+- hakobera@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/external_script.sh
+- examples/run_command.rb
+- examples/run_external_script.rb
+- examples/save_result_to_file.rb
+- lib/tumugi/plugin/command/version.rb
+- lib/tumugi/plugin/task/command.rb
+- tumugi-plugin-command.gemspec
+homepage: https://github.com/tumugi/tumugi-plugin-command
+licenses:
+- Apache License Version 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Tumugi plugin to execute a command
+test_files: []