scriptster 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ff178ac24fe6fe8fb4f9eb396e39cb7b4a1cc1e
-  data.tar.gz: c15498f312425b65f839202d4819e25a2b32d3db
+  metadata.gz: 717f92265d71abf28271c0da1d1c743d642d7c0d
+  data.tar.gz: b7c73d085a0686d41f40a18649264f9396515bc8
 SHA512:
-  metadata.gz: e9a2fbf770f6a418a62ea92c8e33bbd996149a7f5be5da75b2874f979e1a94a1f3eecfa5721c09eaa080c0ef7ddd47a5aacd4c2bea734f384085c59d5e3952a5
-  data.tar.gz: 2ef139f858f2d6b791f2873ce4990ee8e8b1157dd1c398c3318062a25985b5905b2ae0cb2c67b1f53b17ac126e345f70c4d9f7e8d13b439df141507328a7c42c
+  metadata.gz: be02f5207e7ea2e71c87e1543628f9ffe40514ee72960e696af84e3277d4d7f780d544af1ec063195a39f4401bec540c1d0b98ed4a251436a92a368f37da2c17
+  data.tar.gz: f623e30ac8bf6ab3c371fb720c741770f96902787f5b02ad73c8b6790a10aad47ff537bbf9edf5e46089887d3a9d85c23645f45c3cd796d2fde787ad2be207ba

data/lib/scriptster.rb

@@ -1,4 +1,4 @@
-# scriptster - A small library to make your scipts nicer
+# scriptster - A small library to make your scipts a bit nicer
 # Copyright (c) 2014 Radek Pazdera
 
 # MIT License
@@ -23,24 +23,28 @@
 require "scriptster/version"
 require "scriptster/logger"
 require "scriptster/shellcmd"
+require "scriptster/configuration"
 
 module Scriptster
-  class << self
-    include Logger
+  def self.log(*args)
+    Logger::log *args
   end
 
-  def self.configure
-    c = {
-      :name => "scriptster",
-      :verbosity => :informative,
-      :file => nil,
-      :time => true
-    }
+  def log(*args)
+    Logger::log *args
+  end
 
-    yield c
+  def self.cmd(*args)
+    ShellCmd.new *args
+  end
 
-    Logger.set_script_name c[:name]
-    Logger.set_verbosity c[:verbosity]
-    Logger.set_file c[:file]
+  def cmd(*args)
+    ShellCmd.new *args
+  end
+
+  def self.configure
+    c = Configuration.new
+    yield c
+    c.apply
   end
 end

data/lib/scriptster/configuration.rb

@@ -0,0 +1,184 @@
+# scriptster - A small library to make your scipts a bit 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/logger"
+require "scriptster/shellcmd"
+
+module Scriptster
+  class Configuration
+    attr_writer :name, :verbosity, :file, :timestamps, :scheme
+
+    def initialize
+      @name = File.basename($0)
+      @verbosity = :verbose
+      @file = nil
+      @timestamps = true
+      @scheme = :dark
+    end
+
+    # Put the settings from this object in effect
+    def apply
+      Logger.set_name @name if @name
+      Logger.set_verbosity @verbosity if @verbosity
+      Logger.set_file @file if @file
+      Logger.show_timestamps if @timestamps
+
+      ColourSchemes.send @scheme
+    end
+  end
+
+  module ColourSchemes
+    def self.dark
+      Tco::configure do |conf|
+        conf.names["green"] = "#99ad6a"
+        conf.names["yellow"] = "#d8ad4c"
+        conf.names["red"] = "#cc333f"
+        conf.names["light-grey"] = "#ababab"
+        conf.names["medium-grey"] = "#444444"
+        conf.names["dark-grey"] = "#2b2b2b"
+        conf.names["purple"] = "#90559e"
+        conf.names["blue"] = "#4d9eeb"
+        conf.names["orange"] = "#ff842a"
+
+        conf.styles["info"] = {
+          :fg => "green", :bg => "dark-grey",
+          :bright => false, :underline => false
+        }
+        conf.styles["info-message"] = {
+          :fg => "default", :bg => "default",
+          :bright => false, :underline => false
+        }
+
+        conf.styles["warn"] = {
+          :fg => "dark-grey", :bg => "yellow",
+          :bright => false, :underline => false
+        }
+        conf.styles["warn-message"] = {
+          :fg => "default", :bg => "default",
+          :bright => false, :underline => false
+        }
+
+        conf.styles["err"] = {
+          :fg => "dark-grey", :bg => "red",
+          :bright => false, :underline => false
+        }
+        conf.styles["err-message"] = {
+          :fg => "default", :bg => "default",
+          :bright => false, :underline => false
+        }
+
+        conf.styles["debug"] = {
+          :fg => "light-grey", :bg => "dark-grey",
+          :bright => false, :underline => false
+        }
+        conf.styles["debug-message"] = {
+          :fg => "medium-grey", :bg => "default",
+          :bright => false, :underline => false
+        }
+
+        conf.styles["name"] = {
+          :fg => "purple", :bg => "dark-grey",
+          :bright => false, :underline => false
+        }
+        conf.styles["highlight"] = {
+          :fg => "orange", :bg => "default",
+          :bright => false, :underline => false
+        }
+        conf.styles["cmd"] = {
+          :fg => "blue", :bg => "dark-grey",
+          :bright => false, :underline => false
+        }
+        conf.styles["timestamp"] = {
+          :fg => "medium-grey", :bg => "default",
+          :bright => false, :underline => false
+        }
+      end
+    end
+
+    def self.light
+      Tco::configure do |conf|
+        conf.names["green"] = "#99ad6a"
+        conf.names["yellow"] = "#d8ad4c"
+        conf.names["red"] = "#cc333f"
+        conf.names["light-grey"] = "#eeeeee"
+        conf.names["medium-grey"] = "#cccccc"
+        conf.names["dark-grey"] = "#2b2b2b"
+        conf.names["purple"] = "#90559e"
+        conf.names["blue"] = "#4d9eeb"
+        conf.names["orange"] = "#ff842a"
+
+        conf.styles["info"] = {
+          :fg => "green", :bg => "default",
+          :bright => false, :underline => false
+        }
+        conf.styles["info-message"] = {
+          :fg => "default", :bg => "default",
+          :bright => false, :underline => false
+        }
+
+        conf.styles["warn"] = {
+          :fg => "dark-grey", :bg => "yellow",
+          :bright => false, :underline => false
+        }
+        conf.styles["warn-message"] = {
+          :fg => "default", :bg => "default",
+          :bright => false, :underline => false
+        }
+
+        conf.styles["err"] = {
+          :fg => "dark-grey", :bg => "red",
+          :bright => false, :underline => false
+        }
+        conf.styles["err-message"] = {
+          :fg => "default", :bg => "default",
+          :bright => false, :underline => false
+        }
+
+        conf.styles["debug"] = {
+          :fg => "dark-grey", :bg => "default",
+          :bright => false, :underline => false
+        }
+        conf.styles["debug-message"] = {
+          :fg => "medium-grey", :bg => "default",
+          :bright => false, :underline => false
+        }
+
+        conf.styles["name"] = {
+          :fg => "purple", :bg => "light-grey",
+          :bright => false, :underline => false
+        }
+        conf.styles["highlight"] = {
+          :fg => "orange", :bg => "default",
+          :bright => false, :underline => false
+        }
+        conf.styles["cmd"] = {
+          :fg => "blue", :bg => "light-grey",
+          :bright => false, :underline => false
+        }
+        conf.styles["timestamp"] = {
+          :fg => "medium-grey", :bg => "default",
+          :bright => false, :underline => false
+        }
+      end
+    end
+  end
+end

data/lib/scriptster/logger.rb

@@ -1,4 +1,4 @@
-# scriptster - A small library to make your scipts nicer
+# scriptster - A small library to make your scipts a bit nicer
 # Copyright (c) 2014 Radek Pazdera
 
 # MIT License
@@ -23,78 +23,35 @@
 
 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"
+    @@name = nil
     @@file = nil
-    @@time = false
+    @@timestamps = false
 
     @@message_types = {
       :info => "info",
-      :warn => "warn",
-      :err  => "err",
-      :debug => "debug"
+      :warn => "WARN",
+      :err  => "ERR!",
+      :debug => "dbg?"
     }
 
     @@verbosity = :verbose
-    @@logger_verbosity_levels = {
-      :essential => 0,
-      :important => 1,
-      :informative => 2,
-      :verbose => 3
+    @@verbosity_levels = {
+      :quiet => 0,
+      :essential => 1,
+      :important => 2,
+      :informative => 3,
+      :verbose => 4
     }
 
-    def self.set_script_name(name)
-      @@script_name = name
+    def self.set_name(name)
+      @@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
+      raise msg unless @@verbosity_levels.has_key? level.to_sym
 
       @@verbosity = level.to_sym
     end
@@ -102,54 +59,45 @@ module Scriptster
     def self.set_file(file)
       @@file.close if @@file
       @@file = nil
-      @@file = File.open file, "w" if @@file
+      @@file = File.open file, "w" if file
     end
 
-    def self.set_time(time_enabled)
-      @@time = time_enabled
+    def self.show_timestamps
+      @@timestamps = true
     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
+    def self.log(msg_type, msg, verbosity=:informative)
+      if @@verbosity_levels[verbosity] <= @@verbosity_levels[@@verbosity]
+        ts = if @@timestamps
+          Time.now.strftime("%Y-%m-%d %H:%M").style("timestamp") + " "
+        else
+          ""
+        end
+
+        name = if @@name != nil && @@name.length > 0
+          @@name.style("name") + " "
+        else
+          ""
+        end
+
+        msg.chomp!
+        msg = Tco::parse msg, Tco::get_style("#{msg_type.to_s}-message")
+
+        line = ts << name.style("name") <<
+               @@message_types[msg_type].style(msg_type.to_s) <<
+               " " << msg
+        puts line
         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
+        if @@file
+          # Strip colours from the message before writing to a file
+          @@file.puts line.gsub(/\033\[[0-9]+(;[0-9]+){0,2}m/, "")
+        end
       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
+    def log(msg_type, msg, verbosity=:informative)
+      Logger::log msg_type, msg, verbosity
     end
   end
 end

data/lib/scriptster/shellcmd.rb

@@ -1,4 +1,4 @@
-# scriptster - A small library to make your scipts nicer
+# scriptster - A small library to make your scipts a bit nicer
 # Copyright (c) 2014 Radek Pazdera
 
 # MIT License
@@ -37,8 +37,8 @@ module Scriptster
 
       @show_out = false
       @show_err = true
-      @raise_on_error = true
-      @tag = "shell"
+      @raise = true
+      @tag = cmd.split[0]
       @expect = 0
 
       opts.each do |k, v|
@@ -54,45 +54,46 @@ module Scriptster
     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
+        streams = [stdout, stderr]
+        while streams.length > 0
+          IO.select(streams).flatten.compact.each do |io|
+            if io.eof?
+              streams.delete io
+              next
             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
+            stdout_buffer += io.readpartial(1) if io.fileno == stdout.fileno
+            stderr_buffer += io.readpartial(1) if io.fileno == stderr.fileno
+          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
+          # Remove and process all the finished lines from the output buffer
+          stdout_buffer.sub!(/.*\n/m) do
+            @out += $&
+            if @show_out
+              $&.strip.split("\n").each do |line|
+                line = @tag.style("cmd") + " " + line if @tag
+                log(:info, line)
               end
+            end
 
-              ''
+            ''
+          end
+
+          # Remove and process all the finished lines from the error buffer
+          stderr_buffer.sub!(/.*\n/m) do
+            @err += $&
+            if @show_err
+              $&.strip.split("\n").each do |line|
+                line = @tag.style("cmd") + " " + line if @tag
+                log(:err, line)
+              end
             end
+
+            ''
           end
-        rescue EOFError
-          ;
         end
 
         @status = wait_thr.value
@@ -103,11 +104,11 @@ module Scriptster
         unless @show_err
           err_lines = @err.split "\n"
           err_lines.each do |l|
-            l = tag(@tag, l.fg("red")) if @tag
+            l = @tag.style("cmd") + " " + l if @tag
             log(:err, l.chomp)
           end
         end
-        raise "'#{@cmd}' failed!".fg("red") if @raise_on_error
+        raise "'#{@cmd}' failed!" if @raise
       end
     end
   end

data/lib/scriptster/version.rb

@@ -1,3 +1,3 @@
 module Scriptster
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/scriptster.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Scriptster::VERSION
   spec.authors       = ["Radek Pazdera"]
   spec.email         = ["radek@pazdera.co.uk"]
-  spec.summary       = %q{Make your Ruby scipts hip.}
+  spec.summary       = %q{Making 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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scriptster
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Radek Pazdera
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-23 00:00:00.000000000 Z
+date: 2014-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tco
@@ -65,6 +65,7 @@ files:
 - README.md
 - Rakefile
 - lib/scriptster.rb
+- lib/scriptster/configuration.rb
 - lib/scriptster/logger.rb
 - lib/scriptster/shellcmd.rb
 - lib/scriptster/version.rb
@@ -92,5 +93,5 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Make your Ruby scipts hip.
+summary: Making your Ruby scipts hip.
 test_files: []