pretty_multitask 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 855e2f7b1a3ddf9492a15002917bad4a6b72fd0bbec804e40adc12d9e9736730
-  data.tar.gz: fb5d4f8224dd483d1dc6730fd4f9be2145aee5b3f0a560790524fa53a4a0882d
+  metadata.gz: a6d5c09df7c6d302bcb593e960369610d59fe42a0a30325138578e72d1cf8f9c
+  data.tar.gz: 57162253ef143f8865477141490d0f1839920bdd70d36a95154c3938d79b06d5
 SHA512:
-  metadata.gz: 855889a02269799b938d12af331850b8fa1f3e19a9f2ef912f46c04690a26e1160761ee85195538b82e26c383fb1c7a95cd565bf8bc5510d83db056a5e830b9e
-  data.tar.gz: 4991776fa6b3ab42143f4e627e3c33a519a9fe099f9cf8c51b51931160214fd8f044352dff9cd62421e781ae43c90ade0a7330fa484f4f3d218137ebe16df098
+  metadata.gz: 5c6c07f9165c2fa8add57d0647e64d936a915f54c4f09596f5a1160dcb46f1d537677124384d8f71021fb3f64cc0c85e255ffa8c63be7b25463ae83d3c60c4f9
+  data.tar.gz: 85526699eaa75ab56932d9de650cc2eb46991a1449ad3e3872bb0f04fc7ef2b725b5ae85d45980cbe51adb773e45d7416352771bd82cc005f24808f8177e82c2

data/.rubocop.yml

@@ -0,0 +1,35 @@
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Style/ConditionalAssignment:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Layout/FirstArrayElementIndentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 35 
+
+Metrics/LineLength:
+  Max: 120
+  Exclude:
+    - test/**/*
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/AbcSize:
+  Max: 30
+
+Security/MarshalLoad:
+  Exclude:
+    - lib/pretty_multitask/run_callable.rb
+ 
+Layout/ElseAlignment:
+  Enabled: false
+Metrics/BlockLength:
+  Exclude:
+    - '*.gemspec' 

data/Gemfile

@@ -1,6 +1,8 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in pretty_multitask.gemspec
 gemspec

data/Rakefile

@@ -1,10 +1,12 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :test
+task default: :test

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "pretty_multitask"
+require 'bundler/setup'
+require 'pretty_multitask'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "pretty_multitask"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/pretty_multitask/color.rb

@@ -1,14 +1,18 @@
+# frozen_string_literal: true
+
 module PrettyMultitask
+  # Class to provide some ANSI colors
   class Color
     def self.green(str)
       "\e[32;1m#{str}\e[0m"
     end
+
     def self.yellow(str)
       "\e[33;1m#{str}\e[0m"
     end
+
     def self.red(str)
       "\e[31;1m#{str}\e[0m"
     end
   end
 end
-

data/lib/pretty_multitask/run_callable.rb

@@ -1,72 +1,92 @@
-module PrettyMultitask 
+# frozen_string_literal: true
 
+module PrettyMultitask
+  # This class will run a callable, and wrap it's output adding nice format
   class RunCallable
     def initialize(opts = {})
       @opts = opts
     end
-  
+
     def run(opts = @opts)
       cmd = opts[:cmd]
       name = opts[:name]
-      out = opts[:out] || STDOUT
-      err = opts[:err] || STDERR
+      out = STDOUT
       @padding = opts[:padding]
       master, slave = PTY.open
       err_read, err_write = IO.pipe
-  
+
       r, w = UNIXSocket.pair(:STREAM, 0)
-  
-      pid = fork do
-        STDERR.reopen err_write
-        STDOUT.reopen master
-        begin
-          result = cmd.call
-          obj = { result: result, error: nil }
-        rescue StandardError => e
-          new_error = e.class.new(e.message)
-          new_error.set_backtrace e.backtrace
-          Logger.new(STDERR).error new_error
-          obj = { result: nil, error: new_error }
-          File.open('/tmp/error','w+'){|f| f.puts obj.to_yaml}
-          w.puts Marshal.dump(obj), 0
-        end
-        w.puts Marshal.dump(obj), 0
-        w.close
-      end
+
+      pid = run_on_fork(cmd, err_write, master, w)
 
       t_out = consume_and_print slave, out, name, false
       t_err = consume_and_print err_read, out, name, true
 
       chars = []
+      t = consume_and_store r, chars
+
+      Process.wait pid
+
+      wait_until_streams_are_ready [slave, err_read]
+
+      join_threads [t_out, t_err, t]
+
+      close_streams [master, slave, err_read, err_write]
+
+      result = Marshal.load(chars.join)
+      raise result[:error] if result[:error]
+
+      result[:result]
+    end
+
+    def consume_and_store(reader, store)
       t = Thread.new do
-        sleep 0.1 until r.ready?
-        (1..3).each do 
-          chars << r.getc while r.ready?
+        sleep 0.1 until reader.ready?
+        3.times do
+          store << reader.getc while reader.ready?
         end
       end
+      t
+    end
 
-      Process.wait pid
-      Timeout.timeout(1) { t.join }
-  
-      %i[slave err_read].each do |e|
-        loop { break unless binding.local_variable_get(e).ready? }
+    def wait_until_streams_are_ready(streams)
+      streams.each do |s|
+        loop { break unless s.ready? }
       end
-  
-      begin
-        Timeout.timeout(0.1) do
-          %i[t_out t_err].each { |e| binding.local_variable_get(e).join }
+    end
+
+    def join_threads(threads)
+      threads.each do |t|
+        begin
+          Timeout.timeout(0.1) { t.join }
+        rescue Timeout::Error
+          nil
         end
-      rescue Timeout::Error
-        nil
       end
-  
-      %i[master slave err_read err_write].each { |e| binding.local_variable_get(e).close }
-  
-  
-      result = Marshal.load(chars.join)
-      raise result[:error] if result[:error]
-  
-      result[:result]
+    end
+
+    def close_streams(streams)
+      streams.each(&:close)
+    end
+
+    def run_on_fork(cmd, err_w, out_w, socket_w)
+      pid = fork do
+        STDERR.reopen err_w
+        STDOUT.reopen out_w
+        begin
+          result = cmd.call
+          obj = { result: result, error: nil }
+        rescue StandardError => e
+          new_error = e.class.new(e.message)
+          new_error.set_backtrace e.backtrace
+          Logger.new(STDERR).error new_error
+          obj = { result: nil, error: new_error }
+          socket_w.puts Marshal.dump(obj), 0
+        end
+        socket_w.puts Marshal.dump(obj), 0
+        socket_w.close
+      end
+      pid
     end
 
     def consume_and_print(reader, writer, name, error = false)
@@ -77,10 +97,12 @@ module PrettyMultitask
           colored = Color.green format(fmt, name) unless error
           reader.each_line do |line|
             writer.write "#{colored} #{line}"
-            File.open(@opts[:out_file],'a+') do |f|
+            next unless @opts[:out_file]
+
+            File.open(@opts[:out_file], 'a+') do |f|
               f.puts "#{colored} #{line}" if error
               f.puts "#{colored} #{line}" unless error
-            end if @opts[:out_file]
+            end
           end
         rescue Errno::EIO
           nil

data/lib/pretty_multitask/runner.rb

@@ -1,47 +1,54 @@
-module PrettyMultitask
+# frozen_string_literal: true
 
-  LOGGER ||= Logger.new STDOUT
+module PrettyMultitask
+  # This class will run multiple callables in parallel using RunCallable which add a nice format
   class Runner
+    LOGGER ||= Logger.new STDOUT
     def initialize(jobs)
       @jobs = jobs
       @jobs.each do |j|
-        [:name, :cmd ].each {|o| raise "#{o} must be specified for job #{j}" unless j[o]  }
+        %i[name cmd].each { |o| raise "#{o} must be specified for job #{j}" unless j[o] }
         j[:out_file] = "/tmp/#{j[:name]}-#{Time.now.strftime('%s.%N')}"
         FileUtils.touch j[:out_file]
       end
     end
-  
+
     def run
       exec = Tlopo::Executor.new 10
-  
-      longest= 0
-      @jobs.each {|job| longest = job[:name].length if job[:name].length > longest }
-      @jobs.each {|job| job[:padding] = longest }
-  
+
+      @jobs.each { |job| job[:padding] = longest_jobname }
       @jobs.each do |j|
         task = proc { j[:exit_status] = RunCallable.new(j).run }
         exec.schedule task
       end
       errors = exec.run.errors
-  
+
+      print_out
+
+      unless errors.empty?
+        errors.each { |e| LOGGER.error e }
+        raise 'Found errors'
+      end
+    end
+
+    def print_out
       @jobs.each do |j|
         label = "[ #{j[:name]} ]"
         width = IO.console.winsize[-1]
-        left = '='*((width - label.length)/2)
+        left = '=' * ((width - label.length) / 2)
         right = j[:name].length.even? ? left : left + '='
         puts "\n"
-        puts Color.yellow left +  label + right
+        puts Color.yellow left + label + right
         puts File.read j[:out_file]
-        puts Color.yellow "="*width
+        puts Color.yellow '=' * width
         File.delete j[:out_file]
       end
-  
-      unless errors.empty?
-        errors.each {|e| LOGGER.error e}
-        raise 'Found errors'
-      end
     end
-  
-  end
 
+    def longest_jobname
+      longest = 0
+      @jobs.each { |job| longest = job[:name].length if job[:name].length > longest }
+      longest
+    end
+  end
 end

data/lib/pretty_multitask/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PrettyMultitask
-  VERSION = "0.1.7"
+  VERSION = '0.1.8'
 end

data/lib/pretty_multitask.rb

@@ -1,4 +1,6 @@
-require "pretty_multitask/version"
+# frozen_string_literal: true
+
+require 'pretty_multitask/version'
 require 'tlopo/executor'
 require 'logger'
 require 'pty'
@@ -9,6 +11,7 @@ require 'timeout'
 require 'yaml'
 require 'fileutils'
 
+# Main module
 module PrettyMultitask
   require "#{__dir__}/pretty_multitask/color"
   require "#{__dir__}/pretty_multitask/runner"
@@ -16,15 +19,16 @@ module PrettyMultitask
 end
 
 def pretty_multitask(hash)
-  name, tasks = hash.keys.first, hash.values.first
+  name = hash.keys.first
+  tasks = hash.values.first
   task name do
     jobs = []
     tasks.each do |t|
-      job = Proc.new do 
+      job = proc do
         Rake::Task[t].invoke
         nil
       end
-      jobs.push({ name: t, cmd: job})
+      jobs.push({ name: t, cmd: job })
     end
     PrettyMultitask::Runner.new(jobs).run
   end

data/pretty_multitask.gemspec

@@ -1,38 +1,39 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "pretty_multitask/version"
+require 'pretty_multitask/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "pretty_multitask"
+  spec.name          = 'pretty_multitask'
   spec.version       = PrettyMultitask::VERSION
-  spec.authors       = ["Tiago Lopo Da Silva"]
-  spec.email         = ["tiagolopo@yahoo.com.br"]
+  spec.authors       = ['Tiago Lopo Da Silva']
+  spec.email         = ['tiagolopo@yahoo.com.br']
 
-  spec.summary       = %q{Multitask with pretty output for Rake}
-  spec.description   = %q{Multitask with pretty output for Rake}
-  spec.homepage      = "https://github.com/tlopo-ruby/tlopo-executor"
-  spec.license       = "MIT"
+  spec.summary       = 'Multitask with pretty output for Rake'
+  spec.description   = 'Multitask with pretty output for Rake'
+  spec.homepage      = 'https://github.com/tlopo-ruby/tlopo-executor'
+  spec.license       = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
-    #spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
   else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
   end
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "tlopo-executor", "~> 0.1.0"
+  spec.add_dependency 'tlopo-executor', '~> 0.1.0'
 
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 12.3.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pretty_multitask
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Tiago Lopo Da Silva
@@ -39,33 +39,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.15'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 12.3.3
 description: Multitask with pretty output for Rake
 email:
 - tiagolopo@yahoo.com.br
@@ -74,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile