scriptster 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29ca137ce4703b707c5f4f423e16a52ad0f20fc0
-  data.tar.gz: 1188b577e385809ff3408006ec80cacf3ef4f97a
+  metadata.gz: 4ab01abdd932c4089a19e464727861c4397c886d
+  data.tar.gz: 771d12e4026b18fc257387c5a4f59ad71debe8ef
 SHA512:
-  metadata.gz: 61d9c1c7b7713cee0d0f15b9734daa9b9bf171e613d4fcd4dd522104ddda9eb03efb3298aaea1d7e2e42782a2514ff48bfaa730e61e4d111a02937a8ae67a8c7
-  data.tar.gz: 2725686e52306e57082efe967a2ec5576c6cc2e72eb75cc189d985a303d26c8b4878f258abfb9ddb48f73ffeee10776b692f66affe6f40e2af9fa30ef6c826ab
+  metadata.gz: 35ff0d7d04e9187d2703636d1cb82e0a4c3879a60d0f64b0d0fff411b3ece52b061a78d4ddd075de2308a5c417df275a530a2040c78041d97606dea5f1ea7d05
+  data.tar.gz: a930061dd62ee56bba2566f41dd186fafc6ae4d31224f34e8858561b65d391ca34374797f63c4eb544ba1d7e2430959cfb05b77ad9fa3a645bd48313cf3ee4dc

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.2.1 (2015-07-06)
+
+Bug fixes:
+
+  - instance methods of the Scriptster module now work
+
 ## 0.1.0 (2014-10-26)
 
 Features:

data/README.md

@@ -4,13 +4,17 @@
 [![Inline docs](http://inch-ci.org/github/pazdera/scriptster.png)](http://inch-ci.org/github/pazdera/scriptster)
 [![Build Status](https://travis-ci.org/pazdera/scriptster.svg)](https://travis-ci.org/pazdera/scriptster)
 
-Scriptster is a small library to help you writing scripts in Ruby. It
-is only consists of two functions and it's especially useful for apps
-that uses many external tools through the shell.
+Scriptster is a small Ruby gem that will help you write scripts in Ruby. It
+only consists of two functions and it's especially useful for apps
+which depend on many external tools.
 
-The two basic things this library focuses on are
+<img alt="Example output"
+     src="http://broken.build/assets/images/posts/scriptster-example.png"
+     style="width:400px;">
+
+This library focuses on these two basic things:
  * Running shell commands
- * Providing nice logs/status messages about what happened
+ * Providing nice logs and status messages about what happened
 
 See the examples bellow.
 
@@ -20,32 +24,41 @@ See the examples bellow.
 require 'scriptster'
 ```
 
-It is not necessary to configure scriptster before using it, in case you're
-fine with the default settings. But if not, the configure method offers
-many options to change. For the full list of options, please refer to
-the [docs](http://www.rubydoc.info/github/pazdera/scriptster/master/frames).
+It's not necessary to configure scriptster before using it, if you're happy
+with the default settings. But chances are you won't be, in which case the
+`configure` method is exactly what you're after. Bellow is a quick example
+(for the full list of options, please refer to the
+[docs](http://www.rubydoc.info/github/pazdera/scriptster/master/frames)):
 
 ```ruby
 Scriptster::configure do |conf|
   conf.name = "my-script"
-  conf.theme = :dark
+  conf.verbosity = :verbose
+  conf.file = nil
+  conf.colours = :dark
+  conf.log_format = "%{timestamp} %{name} %{type} %{message}"
 end
 ```
 
-The following snippet demonstrates exactly how would you use **scriptster**
+The following snippet demonstrates how can you use **scriptster**
 in practice:
 
 ```ruby
-Scriptster::log :info, "Starting ..."
+Scriptster::log :info, "Checking branches"
 
-Scriptster::cmd.new "git branch",
+git_cmd = Scriptster::cmd "git branch",
   :show_out = true,
-  :show_err = true,
+  :show_err = true
+
+branch_exists = git_cmd.out.split("\n").grep(/#{branch}/).length > 0
+Scriptster::log(:warn, "Branch '#{branch}' not found") unless branch_exists
 ```
 
-The `log` method has one more argument available and the `cmd` method
-has other options that you can use. Again, you will find more in the
-[docs](http://www.rubydoc.info/github/pazdera/scriptster/master/frames).
+The first `log` method will format and print a status message to stdout.
+The latter `cmd` method executes the given `git` command, prints it's
+output, but it also keeps it for processing. You will find more about
+the options and parameters of these functions in the
+[documentation](http://www.rubydoc.info/github/pazdera/scriptster/master/frames).
 
 ## Installation
 

data/examples/rainbow.rb

@@ -0,0 +1,83 @@
+#!/usr/bin/env ruby
+
+require 'scriptster'
+
+Scriptster::configure do |conf|
+  conf.verbosity = :verbose
+  conf.log_format = "%{name} %{type}  %{message}"
+  conf.colours = Proc.new do
+    Tco::configure do |conf|
+      conf.names["red"] = "#BF0C43" #"DF151A"
+      conf.names["orange"] = "#F9BA15" #"FD8603"
+      conf.names["yellow"] = "#8EAC00" #"F4F328"
+      conf.names["green"] = "#127A97" #"00DA3C"
+      conf.names["blue"] = "#452B72" #"00CBE7"
+
+      conf.names["light-grey"] = "#ababab"
+      conf.names["medium-grey"] = "#444444"
+      conf.names["dark-grey"] = "#2b2b2b"
+
+      conf.styles["info"] = {
+        :fg => "dark-grey", :bg => "green",
+        :bright => false, :underline => false
+      }
+      conf.styles["info-message"] = {
+        :fg => "default", :bg => "default",
+        :bright => false, :underline => false
+      }
+
+      conf.styles["warn"] = {
+        :fg => "dark-grey", :bg => "orange",
+        :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 => "#000", :bg => "blue",
+        :bright => false, :underline => false
+      }
+      conf.styles["debug-message"] = {
+        :fg => "default", :bg => "default",
+        :bright => false, :underline => false
+      }
+
+      conf.styles["name"] = {
+        :fg => "medium-grey", :bg => "default",
+        :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
+
+Scriptster::log :err,   "{{red:: These}} {{orange:: logs}} {{yellow:: are}} {{green:: pretty}} {{blue:: funky.}}"
+Scriptster::log :err,   "{{red:: These}} {{orange:: logs}} {{yellow:: are}} {{green:: pretty}} {{blue:: funky.}}"
+Scriptster::log :warn,  "{{red:: These}} {{orange:: logs}} {{yellow:: are}} {{green:: pretty}} {{blue:: funky.}}"
+Scriptster::log :warn,  "{{red:: These}} {{orange:: logs}} {{yellow:: are}} {{green:: pretty}} {{blue:: funky.}}"
+Scriptster::log :info,  "{{red:: These}} {{orange:: logs}} {{yellow:: are}} {{green:: pretty}} {{blue:: funky.}}"
+Scriptster::log :info,  "{{red:: These}} {{orange:: logs}} {{yellow:: are}} {{green:: pretty}} {{blue:: funky.}}"
+Scriptster::log :debug, "{{red:: These}} {{orange:: logs}} {{yellow:: are}} {{green:: pretty}} {{blue:: funky.}}"
+Scriptster::log :debug, "{{red:: These}} {{orange:: logs}} {{yellow:: are}} {{green:: pretty}} {{blue:: funky.}}"

data/examples/template.rb

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+
+# Docopt docs:                http://bit.ly/1LT7Rch
+# Scriptster::configure docs: http://bit.ly/1H4X3kR
+# Scriptster::cmd docs:       http://bit.ly/1LOuVrB
+
+require 'docopt'
+require 'scriptster'
+
+include Scriptster
+
+doc = <<DOCOPT
+Usage:
+  #{File.basename __FILE__} [-h]
+
+Options:
+  -h, --help          Show this message.
+DOCOPT
+
+Scriptster::configure do |conf|
+  conf.verbosity = :verbose
+  conf.log_format = '%{timestamp} [%{name}] %{type} %{message}'
+end
+
+begin
+  args = Docopt::docopt doc
+rescue Docopt::Exit => e
+  log :err, e.message
+  exit 1
+end
+
+### >>> Example
+log :info, "Listing files:"
+ls = cmd 'ls -l | grep -v "^total"',
+  show_out: true,
+  out_level: :debug,
+  tag: 'ls -l'
+
+files = []
+ls.out.lines.each do |line|
+  files.push line.split[-1]
+end
+
+log :info, files.join(', ')
+# <<<

data/examples/test.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+require 'scriptster'
+
+include Scriptster
+
+Scriptster::configure do |conf|
+  conf.file = "log.txt"
+  conf.verbosity = :verbose
+  conf.colours = :dark
+  conf.log_format = "%{timestamp} [%{name}] %{type} %{message}"
+end
+
+log :info, "Row, row, row your punt", :verbose
+log :warn, "Gently down the {{highlight stream}}", :verbose
+log :err, "Belts off, trousers down", :verbose
+log :debug, "Isn't life a {{highlight scream}}, whoa!", :verbose
+
+cmd "uname -mnrs",
+  :show_out => true,
+  :show_err => true,
+  :expect => 0

data/lib/scriptster.rb

@@ -40,7 +40,7 @@ module Scriptster
   #
   # @see .log
   def log(*args)
-    self.log *args
+    Logger::log *args
   end
 
   # Execute a shell command
@@ -54,7 +54,7 @@ module Scriptster
   #
   # @see .cmd
   def cmd(*args)
-    self.cmd *args
+    ShellCmd.new *args
   end
 
   # Use this method to reconfigure the library.

data/lib/scriptster/configuration.rb

@@ -35,13 +35,12 @@ module Scriptster
   #                               @see ColourThemes
   # @attr [String] log_format  Template for each line in the logs
   class Configuration
-    attr_writer :name, :verbosity, :file, :colours, :log_format, :theme
+    attr_accessor :name, :verbosity, :file, :colours, :log_format
 
     def initialize
       @name = File.basename($0)
       @verbosity = :verbose
       @file = nil
-      @timestamps = true
       @colours = :dark
       @log_format = "%{timestamp} %{name} %{type} %{message}"
     end

data/lib/scriptster/shellcmd.rb

@@ -46,6 +46,8 @@ module Scriptster
     # @param [String] cmd  The command line to be run.
     # @param [Hash] opts  Various options of the command.
     # @option opts [Boolean] :show_out  Care about STDOUT flag.
+    # @option opts [Boolean] :out_level To which log level to print the output
+    #                                   [default: :info].
     # @option opts [Boolean] :show_err  Care about STDERR flag.
     # @option opts [Boolean] :raise  Raise on error flag.
     # @option opts [String] :tag  Logger tag (defaults to the first
@@ -56,6 +58,7 @@ module Scriptster
       @err = ""
 
       @show_out = false
+      @out_level = :info
       @show_err = true
       @raise = true
       @tag = cmd.split[0]
@@ -74,7 +77,7 @@ module Scriptster
     private
     # Execute the command and collect all the data from it.
     #
-    # The function will blog until the command has finished.
+    # The function will block until the command has finished.
     def run
       Open3.popen3(@cmd) do |stdin, stdout, stderr, wait_thr|
         stdout_buffer=""
@@ -98,7 +101,7 @@ module Scriptster
             if @show_out
               $&.strip.split("\n").each do |line|
                 line = @tag.style("cmd") + " " + line if @tag
-                log(:info, line)
+                log(@out_level, line)
               end
             end
 

data/lib/scriptster/version.rb

@@ -1,4 +1,4 @@
 module Scriptster
   # The version of this library
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scriptster
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Radek Pazdera
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-31 00:00:00.000000000 Z
+date: 2015-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tco
@@ -80,6 +80,9 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/rainbow.rb
+- examples/template.rb
+- examples/test.rb
 - gemrc
 - lib/scriptster.rb
 - lib/scriptster/configuration.rb