doit 0.2.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 79a433db8959ba8237dbc94e440e09e81cf8cac6
+  data.tar.gz: ae14003d0bb47603b5b84cb65952ba89a68135f5
+SHA512:
+  metadata.gz: 418fe282ab06d1b9bdf7293702eb03251855937194114d68967616ff89402c58ff8d23272bfe02cdd5cd3b90f146b2e920d8597d4ecee883011cc6d0fb4a5e31
+  data.tar.gz: 80b566ffc7fbdb1af2752b366c05c958f414d26930c51e06b4198e493c7b71ae49f59c51ebc15ef9cc6862ec69c87eade97dee6d699055ee631c4be861519a65

data/.doit/hello

@@ -0,0 +1,2 @@
+echo Hello
+pwd

data/.doit/hello.yml

@@ -0,0 +1,13 @@
+env:
+ - DIR=tmp OPTION=y
+ - x=<%= 1 + 3 %>
+a:
+ - 1
+where:
+ - doit
+# - bob@sample.com
+# - alice@customer.com
+# - app@localhost
+# - login@localhost
+# - docu@localhost
+# - hour4@localhost

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.2

data/.travis.yml

@@ -0,0 +1,5 @@
+bundler_args: "--without development"
+script: bundle exec rake
+rvm:
+  - 2.0.0
+  - 2.1.3

data/.watchr

@@ -0,0 +1,51 @@
+HH = '#' * 22  unless defined?(HH)
+H = '#' * 5    unless defined?(H)
+
+def usage
+  puts <<-EOS
+  Ctrl-\\ or ctrl-4   Running all tests
+  Ctrl-C             Exit
+  EOS
+end
+
+def run(cmd)
+  puts "#{HH} #{Time.now} #{HH}"
+  puts "#{H} #{cmd}"
+  system "/usr/bin/time --format '#{HH} Elapsed time %E' #{cmd}"
+end
+
+def run_it(type, file)
+  case type
+  when 'test';  run %Q{ruby -I"lib:test" -rubygems #{file}}
+  else;         puts "#{H} unknown type: #{type}, file: #{file}"
+  end
+end
+
+def run_all_tests
+  puts "\n#{HH} Running all tests #{HH}\n"
+  %w{test}.each { |dir| run "rake #{dir}"  if  File.exists?(dir) }
+end
+
+def run_matching_files(base)
+  base = base.split('_').first
+  %w{test spec}.each { |type|
+    files = Dir["#{type}/**/*.rb"].select { |file| file =~ /#{base}_.*\.rb/ }
+    run_it type, files.join(' ')  unless files.empty?
+  }
+end
+
+%w{test spec}.each { |type|
+  watch("#{type}/#{type}_helper\.rb") { run_all_tests }
+  watch("#{type}/.*/*_#{type}\.rb")   { |match| run_it type, match[0] }
+}
+%w{rb erb haml slim}.each { |type|
+  watch(".*/.*\.#{type}") { |m|
+    run_matching_files("#{m[0].split('/').last.split('.').first}")
+  }
+}
+
+# Ctrl-\ or ctrl-4
+    Signal.trap('QUIT') { run_all_tests }
+# Ctrl-C
+    Signal.trap('INT')  { abort("Interrupted\n") }
+usage

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gem 'micro-optparse'
+
+group :test do
+  gem 'simplecov', require: false
+end
+
+group :test, :development do
+  gem 'rake'
+  gem 'watchr'
+end
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: .
+  specs:
+    doit (0.2.4)
+      micro-optparse
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    docile (1.1.5)
+    micro-optparse (1.2.0)
+    multi_json (1.10.1)
+    rake (10.3.2)
+    simplecov (0.9.1)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    watchr (0.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  doit!
+  micro-optparse
+  rake
+  simplecov
+  watchr

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2014 Dittmar Krall
+
+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,71 @@
+Doit
+====
+
+Executes good old shell/bash scripts locally as well as remotely.
+The environment is set by a ".yml" configuration file.
+An array environment variable triggers multiple calls of the script.
+
+Installation
+------------
+  gem install doit
+
+Usage
+-----
+    doit script... [options]
+    doit push
+    doit deploy tag
+
+Options
+-------
+    -l, --[no-]list          Lists available scripts
+    -r, --remote ["host"]    remote host or comma separated hosts
+    -s, --[no-]silent        run silently; suppress output
+    -v, --[no-]verbose       Enable verbose output
+    -n, --[no-]noop          Suppress execution of commannds
+    -h, --help               Show this message
+    -V, --version            Print version
+
+File Structure
+--------------
+    ~/.doit/deploy          # chmod +x .doit/deploy
+    ~/.doit/deploy.yml
+    $PROJ/.doit/deploy.yml  # overwrites
+    $PROJ/.doit/push        # chmod +x .doit/deploy
+    $PROJ/.doit/push.yml
+
+$PROJ/.doit/push
+----------------
+    if ! (git status | grep 'nothing to commit'); then
+      echo "push: commits are pending"
+      exit 1
+    fi
+
+    current_branch=`git rev-parse --abbrev-ref HEAD`
+    echo "**** branch is '$current_branch'"
+
+    case $current_branch in
+    development)
+      git checkout master && git merge --no-ff development &&
+	git push origin master
+      git checkout development
+      ;;
+    master)
+      git push origin master
+      ;;
+    esac
+
+~/.doit/deploy
+--------------
+    uname -a
+    git status
+
+~/.doit/deploy.yml
+------------------
+    env:
+      - DIR=tmp OPTION=run
+      - DIR=proj OPTION=list
+    where:
+      - bob@sample.com
+      - alice@customer.com
+
+Copyright (c) 2014 [Dittmar Krall], released under the MIT license

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rake'
+require 'rake/testtask'
+require 'bundler/gem_tasks'
+
+Rake::TestTask.new do |t|
+  t.libs.push 'test'
+  t.pattern = 'test/*_test.rb'
+end
+
+desc 'Default: run unit tests.'
+task :default => :test

data/bin/doit

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'doit'
+require 'micro-optparse'
+require 'globals'
+
+options = Parser.new do |p|
+   p.banner = "Usage: doit script... [options] # execute locally or remotely"
+   p.version = "doit #{Globals::VERSION}"
+   p.option :list, 'Lists available scripts'
+   p.option :remote, 'remote host or comma separated hosts', default: ['host'], optional: true
+   p.option :silent, 'run silently; suppress output'
+   p.option :verbose, 'Enable verbose output'
+   p.option :noop, 'Suppress execution of commannds'
+end.process!
+
+Doit.start(options)

data/doit.gemspec

@@ -0,0 +1,22 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'globals'
+
+Gem::Specification.new do |gem|
+  gem.name    = 'doit'
+  gem.version = Globals::VERSION
+  gem.summary = "Simple local & remote script executor"
+  gem.description = "Run good old shell/bash scripts locally or remotely(ssh)."
+
+  gem.authors  = ['Dittmar Krall']
+  gem.email    = 'dittmar.krall@matique.de'
+  gem.homepage = 'http://www.matique.de'
+  gem.license  = 'MIT'
+
+  gem.add_dependency 'micro-optparse', '~> 0'
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- test`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.require_paths = ["lib"]
+
+end

data/lib/doit.rb

@@ -0,0 +1,69 @@
+require 'my'
+require 'run'
+require 'import'
+require 'what'
+
+class Doit
+
+  def self.start(options)
+    @options = options
+    list  if options[:list]
+
+    script = ARGV.shift
+    str = ARGV.map { |x| "\"#{x}\"" }.join(' ')
+    @argv = str.empty? ? '' : "set #{str}\n"
+    execute(script)  if script
+  end
+
+  def self.options
+    @options || {}
+  end
+
+  def self.list
+    hsh = Import.list
+    hsh.sort.each { |abb, long|
+      puts "#{abb}\t- #{long}"
+      lines = `grep -i 'usage\\|summary' #{long} | grep '^#'`.split("\n")
+      lines.each { |line|
+	next  unless line
+	next  if line.empty?
+	puts "\t  #{line}"
+      }
+    }
+  end
+
+  def self.execute(name)
+    Import.init(name)
+    unless Import.script
+      puts "doit: script '#{name}' not found"
+      return
+    end
+    What.init(Import.script, Import.config)
+
+    where_loop
+  end
+
+ private
+  def self.where_loop
+    What.where.each { |w|
+      matrix_loop(w)
+    }
+  end
+
+  def self.matrix_loop(w)
+    What.matrix.each { |mm|
+      prefix = mm.empty? ? '' : "#{What.to_env(mm)}\n"
+
+      What.env.each { |en|
+	prefix2 = en.empty? ? '' : "#{en}\n"
+
+	cmds = Import.script
+	cmds = @argv + prefix + prefix2 + cmds
+	Run.init cmds, w
+	Run.info  if options[:verbose]
+	Run.run
+      }
+    }
+  end
+
+end

data/lib/globals.rb

@@ -0,0 +1,3 @@
+module Globals
+  VERSION = '0.2.4'
+end

data/lib/import.rb

@@ -0,0 +1,61 @@
+require 'pathname'
+require 'erb'
+
+class Import
+
+  def self.script;  @script;  end
+  def self.config;  @config;  end
+
+  def self.init(name)
+    @script  = read(name)
+    @config  = ERB.new(read("#{name}.yml") || '').result
+    info
+  end
+
+# returns Hash { 'pull' => '/home/dk/.doit/pull', ... }
+  def self.list
+    @list ||= list2
+  end
+
+  def self.info
+    return  unless Doit.options[:verbose]
+
+    My.verbose "SCRIPT", @script
+    My.verbose "CONFIG(yml)", @config
+  end
+
+
+ private
+  def self.list2
+    res = {}
+    Pathname.pwd.descend { |dir|
+      doit_dir = dir + '.doit'
+      next  unless File.directory?(doit_dir)
+
+      lst = []
+      Dir.entries(doit_dir).each { |name|
+	name = File.join(doit_dir, name)
+
+	next  unless File.executable?(name)
+	next  if     File.directory?(name)
+
+	lst << name
+      }
+      lst.each { |itm|  res[File.basename(itm)] = itm }
+    }
+    res
+  end
+
+  def self.read(name)
+    try_ascend(".doit/#{name}")
+  end
+
+  def self.try_ascend(filename)
+    Pathname.pwd.ascend { |dir|
+      str = dir + filename
+      return File.read(str)  if File.exists?(str)
+    }
+    nil
+  end
+
+end

data/lib/my.rb

@@ -0,0 +1,16 @@
+class My
+
+  def self.verbose(what, txt)
+    marker = '*'*4
+    arr = txt
+    arr = txt ? txt.split("\n") : ''  unless Array === txt
+    if arr.length > 1
+      puts "#{marker} #{what} #{marker}"
+      puts txt
+      puts marker
+    else
+      puts "#{marker} #{what}: #{txt}"
+    end
+  end
+
+end

data/lib/run.rb

@@ -0,0 +1,42 @@
+class Run
+
+  def self.ssh; @ssh; end
+
+  def self.init(cmds, where)
+    aster = '*'*24
+    puts "#{aster} #{where} #{aster}"
+    @ssh = nil
+    @cmds = cmds
+
+    if where.include?('@')
+      arr = where.split(':')
+      host = arr.first
+      dir = arr.length > 1 ? arr.last : nil
+    else
+      host = nil
+      dir = where
+    end
+
+    @cmds = "cd; cd #{dir}\n" + @cmds  unless dir && dir.empty?
+    @ssh = "ssh #{host}"  if host
+  end
+
+  def self.info
+    My.verbose('SSH', @ssh)
+    My.verbose('cmds', @cmds)
+  end
+
+  def self.run
+    here = '___EOS___'
+    silent = Doit.options[:silent] ? '>/dev/null' : ''
+    cmd = "cat <<'#{here}\' | #{@ssh} bash -i -l #{silent} 2>&1"
+    cmds = "#{cmd}\n#{@cmds}#{here}\n"
+
+    unless Doit.options[:noop]
+      IO.popen(cmds) { |p| p.each { |f| puts f } }
+    else
+      My.verbose('noop', cmds)
+    end
+  end
+
+end

data/lib/what.rb

@@ -0,0 +1,60 @@
+require 'yaml'
+require 'doit'
+
+class What
+
+  def self.matrix;  @matrix;  end
+  def self.where;   @where;   end
+  def self.env;     @env;     end
+
+  def self.init(script, config)
+    @matrix = nil
+    @yml   = (config && YAML.load(config)) || {}
+
+    @where = @yml.delete('where')
+    @env   = @yml.delete('env')
+    @env ||= ['']
+    @env   = [@env].flatten.compact
+
+    remote = Doit.options[:remote]
+    @where   = remote  if remote
+    @where ||= Dir.pwd   # default is current directory
+    @where   = [@where].flatten.compact
+
+    build_matrix
+    @matrix ||= []
+    @matrix = [@matrix]  unless Array === @matrix.first
+    @matrix.map! { |m| m.flatten.inject({}) { |hsh, h| hsh.merge(h) } }
+    info
+  end
+
+  def self.to_env(hsh)
+    arr = hsh.collect { |key, value| "#{key.to_s.upcase}=#{value}" }
+    arr.join ' '
+  end
+
+  def self.info
+    return  unless Doit.options[:verbose]
+
+    My.verbose "where",  @where
+    My.verbose "matrix", @matrix
+    My.verbose "env",    @env
+  end
+
+
+ private
+  def self.build_matrix
+    unless @yml.empty?
+      key, value = @yml.first
+      @yml.delete(key)
+      add_to_matrix(key, value)
+      build_matrix
+    end
+  end
+
+  def self.add_to_matrix(key, val)
+    arr = Array === val ? val.collect {|v| [{key => v}] } : [{key => val}]
+    @matrix = @matrix ? @matrix.product(arr) : arr
+  end
+
+end

data/test/doit_test.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+require 'doit'
+
+describe Doit do
+
+  before do
+    Doit.start({})
+  end
+
+  it "start" do
+    out = noop { }
+    assert_equal '', out
+  end
+
+  it "options" do
+    assert_equal({}, Doit.options)
+  end
+
+  it "list" do
+    out = noop {
+      Doit.list
+    }
+    assert_match /\/\.doit/, out
+  end
+
+  it "execute" do
+    out, err = capture_io do
+      Doit.execute('hello')
+    end
+    assert_match /\nHello\n/, out
+  end
+
+  it "execute with unknown script" do
+    out, err = capture_io do
+      Doit.execute('______unknown______')
+    end
+    assert_match /not found/, out
+  end
+
+end

data/test/import_test.rb

@@ -0,0 +1,38 @@
+require 'test_helper'
+require 'import'
+require 'doit'
+require 'my'
+
+describe Import do
+
+  it "init fails with empty" do
+    assert_raises(Errno::EISDIR) { Import.init('') }
+  end
+
+  it "init" do
+    Import.init('hello')
+  end
+
+  it "list" do
+    Import.init('hello')
+    assert_match /\/\.doit\/hello$/, Import.list['hello']
+  end
+
+  it "info" do
+    out = noop({verbose: true}) {
+	Import.init('hello')
+	Import.info
+    }
+    assert_match /SCRIPT/, out
+    assert_match /CONFIG/, out
+  end
+
+  it "coverage: script" do
+    Import.script
+  end
+
+  it "coverage: config" do
+    Import.config
+  end
+
+end

data/test/my_test.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+require 'my'
+
+describe My do
+
+  it "verbose" do
+    h = 'hello'
+    out, err = capture_io do
+      My.verbose('a', h)
+    end
+    assert_match /#{h}/, out
+  end
+
+  it "verbose text" do
+    h = 'hello'
+    out, err = capture_io do
+      My.verbose('a', "#{h}\nx\n")
+    end
+    assert_match /#{h}/, out
+  end
+
+end

data/test/run_test.rb

@@ -0,0 +1,58 @@
+require 'test_helper'
+require 'run'
+require 'my'
+require 'doit'
+
+describe Run do
+
+  it "coverage #info" do
+    out, err = capture_io do
+      Run.init('', '')
+      Run.info
+    end
+  end
+
+  it "where '' returns nil" do
+    out, err = capture_io do
+      Run.init('', '')
+      assert_equal nil, Run.ssh
+    end
+  end
+
+  it "where 'a' returns nil" do
+    out, err = capture_io do
+      Run.init('', 'a')
+      assert_equal nil, Run.ssh
+    end
+  end
+
+  it "where 'a@b' returns 'ssh a@b'" do
+    out, err = capture_io do
+      Run.init('', 'a@b')
+      assert_equal 'ssh a@b', Run.ssh
+    end
+  end
+
+  it "where 'a@b:c' returns 'ssh a@b'" do
+    out, err = capture_io do
+      Run.init('', 'a@b:c')
+      assert_equal 'ssh a@b', Run.ssh
+    end
+  end
+
+  it "coverage #run" do
+    out, err = capture_io do
+      Run.init('', '')
+      Run.run
+    end
+  end
+
+  it "coverage #run noop" do
+    out = noop {
+	Run.init('', '')
+	Run.run
+    }
+    assert_match /EOS/, out
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,19 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter 'test'
+  command_name 'Minitest'
+end
+
+require 'minitest/autorun'
+
+def noop(options = {noop: true}, &block)
+  return 'noop: missing block' unless block
+
+  out = '---'
+  Doit.stub :options, options do
+    out, err = capture_io do
+      block.call
+    end
+  end
+  out
+end

data/test/what_test.rb

@@ -0,0 +1,45 @@
+require 'test_helper'
+require 'what'
+require 'my'
+
+describe What do
+
+  it "is robust against empty params" do
+    What.init('', '')
+    assert_equal [Dir.pwd], What.where
+    assert_equal [{}], What.matrix
+  end
+
+  it "#to_env({}) must be ''" do
+    assert_equal '', What.to_env({})
+  end
+
+  it "to_env converts variable to uppercase" do
+    assert_equal 'A=1', What.to_env({a: 1})
+  end
+
+  it "coverage: #info" do
+    Doit.stub :options, {verbose: true} do
+      out, err = capture_io do
+	What.init('', '')
+	What.info
+      end
+    end
+  end
+
+  it "builds simple matrix" do
+    What.init('', "a: 1\n")
+    assert_equal [{"a"=>1}], What.matrix
+  end
+
+  it "builds matrix" do
+    What.init('', "a:\n - 1\n - 2\n")
+    assert_equal [{"a"=>1}, {"a"=>2}], What.matrix
+  end
+
+  it "builds product matrix" do
+    What.init('', "a:\n - 1\nb:\n - 3\n - 4\n")
+    assert_equal [{"a"=>1, "b"=>3}, {"a"=>1, "b"=>4}], What.matrix
+  end
+
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: doit
+version: !ruby/object:Gem::Version
+  version: 0.2.4
+platform: ruby
+authors:
+- Dittmar Krall
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: micro-optparse
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Run good old shell/bash scripts locally or remotely(ssh).
+email: dittmar.krall@matique.de
+executables:
+- doit
+extensions: []
+extra_rdoc_files: []
+files:
+- ".doit/hello"
+- ".doit/hello.yml"
+- ".ruby-version"
+- ".travis.yml"
+- ".watchr"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/doit
+- doit.gemspec
+- lib/doit.rb
+- lib/globals.rb
+- lib/import.rb
+- lib/my.rb
+- lib/run.rb
+- lib/what.rb
+- test/doit_test.rb
+- test/import_test.rb
+- test/my_test.rb
+- test/run_test.rb
+- test/test_helper.rb
+- test/what_test.rb
+homepage: http://www.matique.de
+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.4.2
+signing_key: 
+specification_version: 4
+summary: Simple local & remote script executor
+test_files:
+- test/doit_test.rb
+- test/import_test.rb
+- test/my_test.rb
+- test/run_test.rb
+- test/test_helper.rb
+- test/what_test.rb