scriptster 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 45f7a48fa5788b100b93bea2ff05b294ea399835
+  data.tar.gz: 72d91cd953dedefb677c67fe083a7176dba6caf8
+SHA512:
+  metadata.gz: e07766cc64e52fddaf942400820d283144fad567aa0baa22739295ef52b4c76b94edfef29668d04f9b0a7f49b1113dd2c70abdf75f7a2cdaaf71d2b00234c1e5
+  data.tar.gz: 09340b5aaa14387dca1307090e8850a2c73c1952186a2522f5b29956d47f16c4318b5ccd04be2b91432ac6ddecd6125208d2f6e67a44855c024b61b4e19d36b8

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Radek Pazdera
+
+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,43 @@
+# Scriptster
+
+A small library to make your scripts hip ;-).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'scriptster'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install scriptster
+
+## Usage
+
+TODO: Write usage instructions here
+
+```ruby
+require 'scriptster'
+
+Scriptster::configure do |conf|
+  conf[:name] = "my-script"
+end
+
+Scriptster::log :info, "Starting ..."
+
+Scriptster::ShellCmd.new "git branch",
+  :show_out = true,
+  :show_err = true,
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/scriptster/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 a new Pull Request

data/Rakefile

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

data/lib/scriptster/logger.rb

@@ -0,0 +1,154 @@
+# scriptster - A small library to make your scipts nicer
+# Copyright (c) 2014 Radek Pazdera
+
+# 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
+
+
+require "tco"
+
+Tco::configure do |conf|
+  conf.names["green"] = "#99ad6a"
+  conf.names["yellow"] = "#d8ad4c"
+  conf.names["red"] = "#cc333f"
+  conf.names["light-grey"] = "#ababab"
+  conf.names["dark-grey"] = "#2b2b2b"
+  conf.names["purple"] = "#90559e"
+  conf.names["blue"] = "#4D9EEB"
+  conf.names["orange"] = "#ff842a"
+  conf.names["brown"] = "#6a4a3c"
+
+  conf.styles["info"] = {
+    :fg => "green",
+    :bg => "dark-grey",
+    :bright => false,
+    :underline => false
+  }
+  conf.styles["warn"] = {
+    :fg => "dark-grey",
+    :bg => "yellow",
+    :bright => false,
+    :underline => false
+  }
+  conf.styles["err"] = {
+    :fg => "dark-grey",
+    :bg => "red",
+    :bright => false,
+    :underline => false
+  }
+  conf.styles["debug"] = {
+    :fg => "light-grey",
+    :bg => "dark-grey",
+    :bright => false,
+    :underline => false
+  }
+
+  conf.styles["script-name"] = {
+    :fg => "purple",
+    :bg => "dark-grey",
+    :bright => false,
+    :underline => false
+  }
+end
+
+module Scriptster
+  module Logger
+    @@script_name = "scriptster"
+    @@file = nil
+    @@time = false
+
+    @@message_types = {
+      :info => "info",
+      :warn => "warn",
+      :err  => "err",
+      :debug => "debug"
+    }
+
+    @@verbosity = :verbose
+    @@logger_verbosity_levels = {
+      :essential => 0,
+      :important => 1,
+      :informative => 2,
+      :verbose => 3
+    }
+
+    def self.set_script_name(name)
+      @@script_name = name
+    end
+
+    def self.set_verbosity(level)
+      msg = "Message verbosity level not recognised (#{})."
+      raise msg unless @@logger_verbosity_levels.has_key? level.to_sym
+
+      @@verbosity = level.to_sym
+    end
+
+    def self.set_file(file)
+      @@file.close if @@file
+      @@file = File.open file, "w"
+    end
+
+    def self.set_time(time_enabled)
+      @@time = time_enabled
+    end
+
+    def self.log(msg_type, msg, verbosity=nil)
+      now = Time.now.strftime "%Y-%m-%d %H-%M "
+      out = now + @@script_name.style("script-name") << " "
+      file = now + @@script_name + " "
+
+      case msg_type
+      when :info
+        out << "info".style(@@message_types[:info])
+        file << "info"
+        verbosity = :informative unless verbosity
+      when :warn
+        out << "WARN".style(@@message_types[:warn])
+        file << "WARN"
+        verbosity = :informative unless verbosity
+      when :err
+        out << "ERR!".style(@@message_types[:err])
+        file << "ERR!"
+        verbosity = :essential unless verbosity
+      when :debug
+        out << "dbg?".style(@@message_types[:debug])
+        file << "dbg?"
+        verbosity = :verbose unless verbosity
+      end
+
+      if verbosity <= @@verbosity
+        out << " " << msg.chomp
+        puts out
+        STDOUT.flush
+
+        # Strip colours from the message before writing to a file
+        file << " " << msg.chomp.gsub(/\033\[[0-9]+(;[0-9]+){0,2}m/, "")
+        @@file.puts file if @@file
+      end
+    end
+
+    def log(msg_type, msg, verbosity=nil)
+      Logger::log msg_type, msg
+    end
+
+    def tag(tag, msg)
+      tag.fg("blue").bg("dark-grey") << " " << msg
+    end
+  end
+end

data/lib/scriptster/shellcmd.rb

@@ -0,0 +1,114 @@
+# scriptster - A small library to make your scipts nicer
+# Copyright (c) 2014 Radek Pazdera
+
+# 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
+
+require "open3"
+require "tco"
+
+require "scriptster/logger"
+
+module Scriptster
+  class ShellCmd
+    attr_reader :status, :out, :err
+
+    include Logger
+
+    def initialize(cmd, opts={})
+      @out = ""
+      @err = ""
+
+      @show_out = false
+      @show_err = true
+      @raise_on_error = true
+      @tag = "shell"
+      @expect = 0
+
+      opts.each do |k, v|
+        self.instance_variable_set("@#{k.to_s}", v)
+      end
+
+      @cmd = cmd
+      @status = nil
+
+      run
+    end
+
+    private
+    def run
+      Open3.popen3(@cmd) do |stdin, stdout, stderr, wait_thr|
+        pid = wait_thr.pid
+
+        stdout_buffer=""
+        stderr_buffer=""
+
+        begin
+          loop do
+            IO.select([stdout,stderr]).flatten.compact.each do |io|
+              stdout_buffer += io.readpartial(1) if io.fileno == stdout.fileno
+              stderr_buffer += io.readpartial(1) if io.fileno == stderr.fileno
+            end
+            break if stdout.closed? && stderr.closed?
+
+            stdout_buffer.sub!(/.*\n/m) do
+              @out += $&
+              if @show_out
+                $&.strip.split("\n").each do |line|
+                  line = tag(@tag, line) if @tag
+                  log(:info, line)
+                end
+              end
+
+              ''
+            end
+
+            stderr_buffer.sub!(/.*\n/m) do
+              @err += $&
+              if @show_err
+                $&.strip.split("\n").each do |line|
+                  line = tag(@tag, line) if @tag
+                  log(:err, line)
+                end
+              end
+
+              ''
+            end
+          end
+        rescue EOFError
+          ;
+        end
+
+        @status = wait_thr.value
+      end
+
+      if (@expect.is_a?(Array) && !@expect.include?(@status.exitstatus)) ||
+         (@expect.is_a?(Integer) && @status.exitstatus != @expect)
+        unless @show_err
+          err_lines = @err.split "\n"
+          err_lines.each do |l|
+            l = tag(@tag, l.fg("red")) if @tag
+            log(:err, l.chomp)
+          end
+        end
+        raise "'#{@cmd}' failed!".fg("red") if @raise_on_error
+      end
+    end
+  end
+end

data/lib/scriptster/version.rb

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

data/lib/scriptster.rb

@@ -0,0 +1,46 @@
+# scriptster - A small library to make your scipts nicer
+# Copyright (c) 2014 Radek Pazdera
+
+# 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
+
+require "scriptster/version"
+require "scriptster/logger"
+require "scriptster/shellcmd"
+
+module Scriptster
+  class << self
+    include Logger
+  end
+
+  def self.configure
+    c = {
+      :name => "scriptster",
+      :verbosity => :informative,
+      :file => nil,
+      :time => true
+    }
+
+    yield c
+
+    Logger.set_script_name c[:name]
+    Logger.set_verbosity c[:verbosity]
+    Logger.set_file c[:file]
+  end
+end

data/scriptster.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'scriptster/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "scriptster"
+  spec.version       = Scriptster::VERSION
+  spec.authors       = ["Radek Pazdera"]
+  spec.email         = ["radek@pazdera.co.uk"]
+  spec.summary       = %q{Make your Ruby scipts hip.}
+  spec.description   = %q{A simple library for making your scipts a bit nicer.}
+  spec.homepage      = "https://github.com/pazdera/scriptster"
+  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_runtime_dependency "tco", "~> 0.1"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.1"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: scriptster
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Radek Pazdera
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tco
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+description: A simple library for making your scipts a bit nicer.
+email:
+- radek@pazdera.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/scriptster.rb
+- lib/scriptster/logger.rb
+- lib/scriptster/shellcmd.rb
+- lib/scriptster/version.rb
+- scriptster.gemspec
+homepage: https://github.com/pazdera/scriptster
+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: Make your Ruby scipts hip.
+test_files: []