scriptster 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ab01abdd932c4089a19e464727861c4397c886d
-  data.tar.gz: 771d12e4026b18fc257387c5a4f59ad71debe8ef
+  metadata.gz: 551e2e0a9a146fcef001e12bc824a0e802b390e0
+  data.tar.gz: 286aaacba36201700bd8e4ace12f49a530f32f98
 SHA512:
-  metadata.gz: 35ff0d7d04e9187d2703636d1cb82e0a4c3879a60d0f64b0d0fff411b3ece52b061a78d4ddd075de2308a5c417df275a530a2040c78041d97606dea5f1ea7d05
-  data.tar.gz: a930061dd62ee56bba2566f41dd186fafc6ae4d31224f34e8858561b65d391ca34374797f63c4eb544ba1d7e2430959cfb05b77ad9fa3a645bd48313cf3ee4dc
+  metadata.gz: d16e10d4d6a8442f06b5782075e167cf29906a3e0ab2377b168d98fbd81eb96d27bcc639349c61bc06ea38ef3885c178d5aeebe5f8165cb18d0066706fc86b07
+  data.tar.gz: 0ea04e268a4994bd1b9beba50dfeeae794c8ee0f1416344b389b96dd3303a0fb48de0acc0dd40361fe298b0f22844c107ac30fb54577de848995a0f40dd42b09

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.2.2 (2015-07-12)
+
+Improvements:
+
+  - added the parse_args method
+
 ## 0.2.1 (2015-07-06)
 
 Bug fixes:

data/examples/documented-template.rb

@@ -0,0 +1,55 @@
+#!/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 'scriptster'
+include Scriptster
+
+Scriptster::configure do |conf|
+  # Which log levels will be printed
+  # (one of :quiet, :essential, :important, :informative or :verbose)
+  conf.verbosity = :informative
+
+  # Customise the log line format
+  conf.log_format = '%{timestamp} [%{name}] %{type} %{message}'
+
+  # Save the logs into a file
+  conf.file = "/tmp/lsl-log"
+
+  # Either :light or :dark.
+  conf.colours = :dark
+end
+
+args = parse_args <<DOCOPT
+Usage:
+  #{File.basename __FILE__} [-h] [<dir>]
+  #{File.basename __FILE__} -a
+
+Options:
+  -a, --aaa           Option description
+  -h, --help          Show this message.
+DOCOPT
+
+log :warn, "There are four logging levels (:error, :warn, :info and :debug)"
+
+dir = args['<dir>'] || '~'
+log :info, "Listing files in #{dir}"
+ls = cmd "ls -l #{dir} | grep -v '^total'",
+  show_out: true,     # print stdout as the command runs
+  show_err: true,     # print stderr
+  out_level: :debug,  # which log level to print the output to
+  tag: 'ls -l',       # modify the default command tag
+  expect: 0,          # the expected return status (can be an Array as well)
+  raise: true         # raise if the command exits with an unexpected code
+
+# Iterate through stdout (the same can be done for stderr with .err)
+files = []
+ls.out.lines.each do |line|
+  files.push line.split[-1]
+end
+log :info, files.join(', ')
+
+# Get information about the process
+log :info, "ls(#{ls.status.pid}) exited with #{ls.status.exitstatus}"

data/examples/minimal-template.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require 'scriptster'
+include Scriptster
+
+args = parse_args <<DOCOPT
+Usage:
+  #{File.basename __FILE__} [-h]
+
+Options:
+  -h, --help          Show this message.
+DOCOPT
+
+log :info, "Args received: #{args}"
+ls = cmd 'ls', {show_out: true, out_level: :info}

data/lib/scriptster/version.rb

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

data/lib/scriptster.rb

@@ -20,6 +20,8 @@
 # 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 "docopt"
+
 require "scriptster/version"
 require "scriptster/logger"
 require "scriptster/shellcmd"
@@ -29,6 +31,8 @@ require "scriptster/configuration"
 # functions, cmd and log. The module can be used directly or included
 # in your class.
 module Scriptster
+  Configuration.new.apply
+
   # Pass a message to the logger.
   #
   # @see Logger.log
@@ -40,7 +44,7 @@ module Scriptster
   #
   # @see .log
   def log(*args)
-    Logger::log *args
+    Scriptster.log *args
   end
 
   # Execute a shell command
@@ -54,7 +58,7 @@ module Scriptster
   #
   # @see .cmd
   def cmd(*args)
-    ShellCmd.new *args
+    Scriptster.cmd *args
   end
 
   # Use this method to reconfigure the library.
@@ -73,4 +77,30 @@ module Scriptster
     yield c
     c.apply
   end
+
+  # Process command line arguments using docopt and return
+  # the array of options.
+  #
+  # @param [String] docopt_string The interface spec to be passed to docopt.
+  # @return [Array] The processed CLI options, straight from docopt.
+  def self.parse_args(docopt_string, argv=nil)
+    do_parse_args docopt_string, argv
+  end
+
+  # The same as {Scriptster.parse_args}.
+  #
+  # @see .parse_args
+  def parse_args(docopt_string, argv=nil)
+    Scriptster.do_parse_args docopt_string, argv
+  end
+
+  private
+  def self.do_parse_args(docopt_string, argv=nil)
+    begin
+      return Docopt::docopt docopt_string, argv: argv
+    rescue Docopt::Exit => e
+      STDERR.puts e.message
+      exit 1
+    end
+  end
 end

data/scriptster.gemspec

@@ -7,9 +7,9 @@ Gem::Specification.new do |spec|
   spec.name          = "scriptster"
   spec.version       = Scriptster::VERSION
   spec.authors       = ["Radek Pazdera"]
-  spec.email         = ["radek@pazdera.co.uk"]
+  spec.email         = ["me@radek.io"]
   spec.summary       = %q{Making your Ruby scipts hip.}
-  spec.description   = %q{A simple library for making your scipts a bit nicer.}
+  spec.description   = %q{A simple library for making your Ruby scipts nicer.}
   spec.homepage      = "https://github.com/pazdera/scriptster"
   spec.license       = "MIT"
 
@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "tco", "~> 0.1"
+  spec.add_runtime_dependency "docopt", "~> 0.5"
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake", "~> 10.1"

data/spec/scriptster_spec.rb

@@ -106,6 +106,16 @@ describe Scriptster do
       Scriptster::log :info, "Hello there"
       expect(@out.string.strip).to match /info Hello there/
     end
+
+    it "the instance version works" do
+      class Test
+        include Scriptster
+      end
+
+      t = Test.new
+      t.log :info, "Hello there"
+      expect(@out.string.strip).to match /info Hello there/
+    end
   end
 
   describe "#cmd" do
@@ -217,5 +227,55 @@ describe Scriptster do
         Scriptster::cmd "cat #{@dir}/nonexistent.txt", :expect => 10
       }.to raise_exception RuntimeError
     end
+
+    it "the instance version works" do
+      class Test
+        include Scriptster
+      end
+
+      t = Test.new
+      cat = t.cmd "cat #{@dir}/file.txt", :show_out => false
+      expect(cat.out).to eq "Multi-line\nFile contents\n"
+    end
+  end
+
+  describe "#parse_args" do
+    before :all do
+      @doc = <<DOCOPT
+Usage: test [-ab]
+
+Options:
+-a, --aaa      The first option
+-b, --bbb      The second option
+DOCOPT
+
+      @args = Scriptster::parse_args @doc, ['-a']
+    end
+
+    it "returns a Hash" do
+      expect(@args).to be_a Hash
+    end
+
+    it "the Hash has two keys" do
+      expect(@args.length).to be(2)
+    end
+
+    it "--aaa is true" do
+      expect(@args['--aaa']).to be
+    end
+
+    it "--bbb is true" do
+      expect(@args['--bbb']).not_to be
+    end
+
+    it "the instance method works" do
+      class Test
+        include Scriptster
+      end
+
+      t = Test.new
+      args = t.parse_args @doc, ['-a']
+      expect(args).to be_a Hash
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scriptster
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Radek Pazdera
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-06 00:00:00.000000000 Z
+date: 2015-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tco
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: docopt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,9 +80,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
-description: A simple library for making your scipts a bit nicer.
+description: A simple library for making your Ruby scipts nicer.
 email:
-- radek@pazdera.co.uk
+- me@radek.io
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -80,8 +94,9 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/documented-template.rb
+- examples/minimal-template.rb
 - examples/rainbow.rb
-- examples/template.rb
 - examples/test.rb
 - gemrc
 - lib/scriptster.rb

data/examples/template.rb

@@ -1,45 +0,0 @@
-#!/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(', ')
-# <<<