base_script 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 91535aa854da3d358a28b6b7e4884289660acbaf
+  data.tar.gz: f9193287d1d234469f4e3f4d3d0f8e3d23d683da
+SHA512:
+  metadata.gz: 8fa846e22950009fcb784386cd5a1252cec899bf619eec6615993e2559fe374d47c674ae4c801f5e77ad872bb648639ea7a07b1e1149027067862379412b3c50
+  data.tar.gz: 13d62f528063361c76f0c96af574640498bed0db4b55841b3e152b8bb1e5f21fd34657918137a773357722e43c32b347d416542c71cea53820ad1fd8de9cbbb2

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/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# See: base_script.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Paul Annesley
+
+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,60 @@
+# BaseScript
+
+Small base for CLI scripts; signal handling, indented logging, colors
+ticks/crosses, injectable args/IO.
+
+It was kicking around the `lib/` directory of various Rails projects I've
+built. Now it's a gem with a [version number][semver].
+
+
+## Installation
+
+With bundler:
+
+    $ echo 'gem "base_script"' >> Gemfile
+    $ bundle
+
+Manually:
+
+    $ gem install base_script
+
+## Usage
+
+```ruby
+require "base_script"
+
+class HelloScript < BaseScript
+
+  def run
+    if arg("lunar")
+      log "hello moon"
+    else
+      log "hello world"
+    end
+
+    log "Doing some work, ctrl-c to cleanly interrupt.."
+    indented do
+      100.times do |i|
+        exit_on_signals
+        vlog "Step #{i}"
+        do_some_work() unless dry?
+      end
+    end
+  end
+
+end
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/base_script/fork )
+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
+
+Author: [Paul Annesley][pda]
+
+
+[semver]: http://semver.org/
+[pda]: https://twitter.com/pda

data/Rakefile

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

data/base_script.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'base_script/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "base_script"
+  spec.version       = BaseScript::VERSION
+  spec.authors       = ["Paul Annesley"]
+  spec.email         = ["paul@annesley.cc"]
+  spec.summary       = %q{CLI script simple base class.}
+  spec.description   = %q{Small base for CLI scripts; signal handling, indented logging, colors ticks/crosses, injectable args/IO.}
+  spec.homepage      = "https://github.com/pda/base_script"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.5"
+  spec.add_development_dependency "rake"
+end

data/lib/base_script/version.rb

@@ -0,0 +1,3 @@
+module BaseScript
+  VERSION = "1.0.0"
+end

data/lib/base_script.rb

@@ -0,0 +1,133 @@
+require "base_script/version"
+
+# A base class for implementing CLI scripts.
+# ARGV and in/out IO's are injected, so can be mocked & tested.
+# Basic signal handling by calling exit_on_signals inside work loops etc.
+# Requires Ruby 2.0.0+ for keyword args etc.
+class BaseScript
+
+  EXIT_SUCCESS = 0
+  INDENT = "  "
+
+  def initialize(argv, stdin: $stdin, stdout: $stdout, stderr: $stderr)
+    @argv = argv
+
+    @input = stdin
+    @output = stdout
+    @error_output = stderr
+    sync_io!
+
+    @indentation = 0
+  end
+
+  private
+
+  # I/O
+  attr_reader :input
+  attr_reader :output
+  attr_reader :error_output
+
+  # Set I/O streams as unbuffered if they support it.
+  def sync_io!
+    [input, output, error_output].each do |io|
+      io.sync = true if io.respond_to?(:sync=)
+    end
+  end
+
+  ##
+  # Argument handling.
+
+  def args
+    @_args ||= @argv.reduce({}) do |memo, argument|
+      key, value = argument.split("=", 2)
+      option = key.gsub(/\A-+/, "") # strip leading hyphens.
+      memo[option] = value || true # store as true for value-less options.
+      memo
+    end
+  end
+
+  # Fetch a --key or --key=value argument.
+  # Returns the provided default if not set.
+  def arg(key, default = nil)
+    args.fetch(key.to_s, default)
+  end
+
+  # Like #arg, but raises KeyError if missing.
+  def arg!(key)
+    args.fetch(key.to_s) do
+      raise KeyError, "--#{key} argument required"
+    end
+  end
+
+  def dry?; arg("dry-run") end
+  def verbose?; arg("v") end
+
+  ##
+  # Logging.
+
+  def log(message)
+    message += "\n" unless message[-1] == ?\n
+    output << indent_string(message)
+  end
+
+  def vlog(message)
+    log(message) if verbose?
+  end
+
+  def indented
+    @indentation += 1
+    yield
+  ensure
+    @indentation -= 1
+  end
+
+  def indent_string(content)
+    spaces = INDENT * @indentation
+    content.each_line.map {|line| "#{spaces}#{line}" }.join
+  end
+
+  # Colorize text if output is a tty.
+  def colorize(text, code)
+    if output.respond_to?(:tty?) && output.tty?
+      "\033[#{code}m#{text}\033[0m"
+    else
+      text
+    end
+  end
+
+  # A green tick.
+  def tick; colorize("✔", 32) end
+
+  # A red cross.
+  def cross; colorize("✘", 31) end
+
+  ##
+  # Signal handling.
+
+  # Call this method prior to doing work inside a loop.
+  # Alternatively, call at start of script to install handlers, and
+  # then at safe-exit points throughout script.
+  # Don't set up signal handlers (first call) and then fail to call again.
+  def exit_on_signals
+    install_signal_handlers unless defined?(@_signal)
+
+    if @_signal
+      log "Exiting due to SIG#{@_signal}"
+      exit(1)
+    end
+  end
+
+  def install_signal_handlers
+    @_signal = nil
+    @_previous_signal_handlers = {}
+    %w{INT TERM}.each do |signal|
+      log "Installing #{signal} handler" if verbose?
+      @_previous_signal_handlers[signal] = Signal.trap(signal) do
+        log "Received SIG#{signal}, will exit at next opportunity"
+        @_signal = signal
+        Signal.trap(signal, @_previous_signal_handlers[signal])
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: base_script
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Paul Annesley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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'
+description: Small base for CLI scripts; signal handling, indented logging, colors
+  ticks/crosses, injectable args/IO.
+email:
+- paul@annesley.cc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- base_script.gemspec
+- lib/base_script.rb
+- lib/base_script/version.rb
+homepage: https://github.com/pda/base_script
+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.2.2
+signing_key: 
+specification_version: 4
+summary: CLI script simple base class.
+test_files: []