script-runner 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57dfbe9b4d71ef02fa67c714ec4b0271c05b58a8
-  data.tar.gz: 555ed1d812cca0a64a5afaf509069a5a22d971b8
+  metadata.gz: 5adc86a5ade412404f97da960195285a5cd9c9d5
+  data.tar.gz: b4ce5c7742f04412fb7df809b1d6a676547b9d3b
 SHA512:
-  metadata.gz: 013670bbf854cf1a7b850df883a1a778e7e59ef445a2825a461136277bb8afde2bac3eca66f7838c1643e1119d03a8f36105576ce43e0afcb0d976d7e341b5eb
-  data.tar.gz: 4c46070e38cfa92c4301a0cd3b4bdc254198eb7e3d7c308daea36c0caee66570d7c3d0ac034abb3da548255e7d6da1a7688758d03dfd03eb63961a5d9abd7a28
+  metadata.gz: 1cffb8d33edaa322fb331e1b91cc73bb2b47cd6fd15e2ccfa6fedad39bfa26d7ac2bf2911e062f0bd69101eb0e9b14e14fbcf0d903fcbf224e5068648bea88b2
+  data.tar.gz: db92f171a17303b7bddb6a679bafbc5f621ea27a677331863c42caddd045a27373f7dc58574f468f4f9559251e1ca54b8036f3be625b522295d37d4c314562a4

data/Gemfile.lock

@@ -1,13 +1,18 @@
 PATH
   remote: .
   specs:
-    script-runner (0.0.1)
+    script-runner (0.0.2)
       thor
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.2.4)
+    little-plugger (1.1.3)
+    logging (1.8.1)
+      little-plugger (>= 1.1.3)
+      multi_json (>= 1.3.6)
+    multi_json (1.7.9)
     rake (10.1.0)
     rspec (2.14.1)
       rspec-core (~> 2.14.0)
@@ -23,6 +28,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  logging (~> 1.8.1)
   rake (~> 10.1.0)
   rspec (~> 2.6)
   script-runner!

data/README.md

@@ -6,11 +6,11 @@ A very simple library for running scripts on a file system.
 
     require 'script-runner'
     ScriptRunner.run( array_of_paths, array_of_env_paths, error_handler, &handle_script_output )
-    
+
 ## Example
 
 If we have the following file structure
-    
+
 
     path-one/
       script.sh
@@ -20,7 +20,7 @@ If we have the following file structure
       script.sh
     env-one/
       one.properties
-      
+
 The following:
 
     require 'script-runner'
@@ -46,5 +46,7 @@ Note: for each root_path, all files under are invoked in alphabetical order
 
 
 ### Changelog
+0.0.4 - fixed dependency on logging
+0.0.3 - Added logging
 0.0.2 - Added mit license
 0.0.1 - First version

data/lib/script-runner.rb

@@ -1,3 +1,4 @@
+require 'logging'
 require 'script-runner/main'
 
 module ScriptRunner
@@ -8,10 +9,22 @@ module ScriptRunner
   #
   # @paths - an array of paths with scripts to invoke
   # @env_vars - an array of paths that contains .properties files
-  # @error_handler - a callback if a non-zero exit code occured
+  # @options -
+  # -- :error_handler - a lambda that gets passed the script file path that exited with a non zero value
+  # -- :log_level - one of :debug, :info, :warn, :errror
   # @block - a block to handle the output of the script if non is given it is sent to the console
-  def self.run( paths, env_vars, error_handler = nil, &block)
-    runner = ScriptRunner::Main.new
+  def self.run( paths, env_vars, options = {}, &block)
+
+    Logging.appenders.stdout(
+      :layout => Logging.layouts.pattern(:pattern => '[%c][%-5l] %m\n'),
+      :color_scheme => 'bright')
+
+    logger = Logging.logger['script-runner']
+    logger.add_appenders(Logging.appenders.stdout)
+    logger.level = options[:log_level] || :warn
+
+    runner = ScriptRunner::Main.new(logger)
+    error_handler = options[:error_handler]
     runner.run(paths, env_vars, error_handler, &block)
   end
 

data/lib/script-runner/main.rb

@@ -1,7 +1,14 @@
+require 'logging'
+
 module ScriptRunner
 
   class Main
 
+    def initialize(logger)
+      @logger = logger
+    end
+
+
     # Run a set of scripts
     #
     # Note: non executable files are skipped and a warning is sent to the console
@@ -11,16 +18,19 @@ module ScriptRunner
     # @error_handler - a callback if a non-zero exit code occured
     # @block - a block to handle the output of the script if non is given it is sent to the console
     def run( paths, env_vars, error_handler = nil, &block)
+
       set_env(env_vars)
       all_paths = all_files(paths).select{ |p| File.file? p }
+      @logger.debug all_paths
       runnable = all_paths.select{ |p| File.executable? p }
       non_runnable = all_paths - runnable
-
+      @logger.debug "non_runnable: #{non_runnable}"
+      @logger.debug "runnable: #{runnable}"
       non_runnable.each{ |nr|
-        puts "warning: #{nr} is not runnable - skipping"
+        @logger.warn "#{nr} is not runnable - skipping"
       }
 
-      all_paths.each{ |p|
+      runnable.each{ |p|
         exec(p, error_handler, &block)
       }
     end
@@ -33,7 +43,7 @@ module ScriptRunner
           if block_given?
             block.call(line.chomp)
           else
-            puts line.chomp
+            @logger.info line.chomp
           end
         end
         io.close
@@ -53,8 +63,9 @@ module ScriptRunner
       env_files.each{ |p|
         File.readlines(p).each do |line|
           if line.include? "="
-            values = line.split("=")
-            ENV[values[0].chomp] = values[1].chomp
+            key, value = line.split("=")
+            @logger.debug "set: #{key} -> #{value}"
+            ENV[key.strip] = value.strip
           end
         end
       }

data/lib/script-runner/version.rb

@@ -1,4 +1,4 @@
 module ScriptRunner
-  VERSION = "0.0.2"
+  VERSION = "0.0.4"
 end
 

data/script-runner.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |gem|
   gem.version       = ScriptRunner::VERSION
   gem.add_development_dependency "rspec", "~> 2.6"
   gem.add_development_dependency "rake", "~> 10.1.0"
+  gem.add_dependency "logging", "~> 1.8.1"
   gem.add_dependency "thor"
 
 end

data/spec/fixtures/nested/one.sh

@@ -0,0 +1,2 @@
+#!/usr/bin/env bash
+echo "$0"

data/spec/fixtures/non_runnable/scripts/one.sh

@@ -0,0 +1,2 @@
+#!/usr/bin/env bash
+echo "$0"

data/spec/main_spec.rb

@@ -27,19 +27,21 @@ describe ScriptRunner do
   end
 
   it "should allow errors to be handled" do
-    error_handler = lambda{ |p| @error_files << p}
-    p = ScriptRunner.run(scripts("one", "has_error"), env("one"), error_handler) { |output| @all_output << output }
+    options = {
+      :error_handler => lambda{ |p| @error_files << p},
+      :log_level => :debug
+    }
+
+    p = ScriptRunner.run(scripts("one", "has_error"), env("one"), options) { |output| @all_output << output }
     @error_files.length.should eql 1
   end
 
   it "should call nested in alphabetical order" do
-    puts "before : #{@all_output}"
     p = ScriptRunner.run(scripts("nested"), env("one")) { |output| @all_output << output }
     @all_output.should eql ["spec/fixtures/nested/scripts/a/one.sh", "spec/fixtures/nested/scripts/one.sh"]
   end
 
   it "should call multiple nested in alphabetical order" do
-    puts "before : #{@all_output}"
     p = ScriptRunner.run(scripts("one", "nested_two", "nested"), env("one")) { |output| @all_output << output }
     @all_output.should eql [
       "hello there custom var",
@@ -48,4 +50,9 @@ describe ScriptRunner do
       "spec/fixtures/nested/scripts/a/one.sh",
       "spec/fixtures/nested/scripts/one.sh"]
   end
+
+  it "should skip non runnable files" do
+     p = ScriptRunner.run(scripts("non_runnable"), env("one")) { |output| @all_output << output }
+    @error_files.length.should eql 0
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: script-runner
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - ed.eustace
@@ -38,6 +38,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 10.1.0
+- !ruby/object:Gem::Dependency
+  name: logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.1
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -73,12 +87,14 @@ files:
 - script-runner.gemspec
 - spec/cmds_spec.rb
 - spec/fixtures/has_error/scripts/error.sh
+- spec/fixtures/nested/one.sh
 - spec/fixtures/nested/scripts/a/one.sh
 - spec/fixtures/nested/scripts/one.sh
 - spec/fixtures/nested_two/nested/scripts/a/one.sh
 - spec/fixtures/nested_two/nested/scripts/one.sh
 - spec/fixtures/nested_two/scripts/a/one.sh
 - spec/fixtures/nested_two/scripts/one.sh
+- spec/fixtures/non_runnable/scripts/one.sh
 - spec/fixtures/one/env/one.properties
 - spec/fixtures/one/scripts/one.sh
 - spec/main_spec.rb
@@ -109,12 +125,14 @@ summary: it just runs scripts
 test_files:
 - spec/cmds_spec.rb
 - spec/fixtures/has_error/scripts/error.sh
+- spec/fixtures/nested/one.sh
 - spec/fixtures/nested/scripts/a/one.sh
 - spec/fixtures/nested/scripts/one.sh
 - spec/fixtures/nested_two/nested/scripts/a/one.sh
 - spec/fixtures/nested_two/nested/scripts/one.sh
 - spec/fixtures/nested_two/scripts/a/one.sh
 - spec/fixtures/nested_two/scripts/one.sh
+- spec/fixtures/non_runnable/scripts/one.sh
 - spec/fixtures/one/env/one.properties
 - spec/fixtures/one/scripts/one.sh
 - spec/main_spec.rb