miga-base 0.7.13.0 → 0.7.15.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 964b803e09887476153335589fad3d5aee2861ea
-  data.tar.gz: ee0d34a4a7c8569d39bea4855a6054c57de78c81
+SHA256:
+  metadata.gz: 7fa6d4c21b92b81654b146b7f6a25cbe945cadd5a84bd5ff5e2833f90d45a403
+  data.tar.gz: e2ec20139cf6ad565fbdb7419abc84f4083cc0b2f0867c70baeee2adaaaca488
 SHA512:
-  metadata.gz: b84efbc94fbfc848b85ae7c3cca7e26f2baea74c5f066a63cf1ede7fb26ed6c634f4c2e2cbe1c2752e54624cf48d6597b933474d4b4d6083cb505a3b17063cf5
-  data.tar.gz: 0c7cfc6a149cab5fa1cfc5e386de789f84c132d227ad8ebbbc42dee2b076010bfe06b6697e69efe00a6639283c472f9ca3793a1e113506e691e50a182cfee2c6
+  metadata.gz: 07f5dac2c90e9c9273730c441d3ce9167e02be66d29a144457efd99e30c3010d8509d2f74171694addad1c5b83db40877a51ac2befbd77961dcbfe5b0a9e9491
+  data.tar.gz: 0e4c33eb179934a09b37cfcb0323996675e9c46762d765442fc551cefb005a771ed3a82c8895302bb82d454ffc09927670b84ab7d669c1de5b0ee3f0774c09d7

data/README.md

@@ -11,11 +11,12 @@
 
 For additional information on MiGA, visit:
 
-* [MiGA Online][miga-online]: The Microbial Genomes Atlas Online.
+* [MiGA Online][miga-online]: The Microbial Genomes Atlas Online
+* [MiGA@XSEDE][miga-at-xsede]: The MiGA@XSEDE Gateway
 * [MiGA users list][mailing-list]:
-  Forum to discuss with other users and developers.
-* [MiGA manual][manual]: The definitive guide to MiGA.
-* [MiGA API docs][rubydoc]: Inner-workings of the `miga-base` gem.
+  Forum to discuss with other users and developers
+* [MiGA manual][manual]: The definitive guide to MiGA
+* [MiGA API docs][rubydoc]: Inner-workings of the `miga-base` gem
 * [MiGA Web][miga-web]: MiGA on Rails!
 
 # For the impatient
@@ -39,7 +40,8 @@ You have two options:
 
 Developed and maintained by [Luis M. Rodriguez-R][lrr]. MiGA is the result of a
 collaboration between [Kostas Lab][kostas] at the Georgia Institute of
-Technology and [RDP][rdp] at Michigan State University.
+Technology, [Rodriguez-R Lab][lrr] at the University of Innsbruck,
+and [RDP][rdp] at Michigan State University.
 
 See also the [complete list of contributors](manual/part1/contributors.md).
 
@@ -47,7 +49,7 @@ See also the [complete list of contributors](manual/part1/contributors.md).
 
 See [LICENSE](LICENSE).
 
-[lrr]: http://lmrodriguezr.github.io/
+[lrr]: https://rodriguez-r.com/
 [mailing-list]: http://support.microbial-genomes.org/
 [manual]: https://manual.microbial-genomes.org/
 [rubydoc]: http://www.rubydoc.info/github/bio-miga/miga
@@ -55,5 +57,6 @@ See [LICENSE](LICENSE).
 [miga-web]: https://github.com/bio-miga/miga-web
 [miga-gui]: https://github.com/bio-miga/miga-gui
 [miga-online]: http://microbial-genomes.org/
+[miga-at-xsede]: https://xsede.microbial-genomes.org/
 [kostas]: http://enve-omics.gatech.edu/
 [rdp]: http://rdp.cme.msu.edu/

data/lib/miga/cli.rb

@@ -110,30 +110,9 @@ class MiGA::Cli < MiGA::MiGA
   end
 
   ##
-  # Reports the advance of a task at +step+ (String), the +n+ out of +total+.
-  # The advance is reported in powers of 1,024 if +bin+ is true, or powers of
-  # 1,000 otherwise.
-  # The report goes to $stderr iff --verborse
-  def advance(step, n = 0, total = nil, bin = true)
-    return unless self[:verbose]
-
-    adv = total.nil? ? (n == 0 ? '' : num_suffix(n, bin)) :
-      ('%.1f%% (%s/%s)' % [100.0 * n / total,
-                           num_suffix(n, bin), num_suffix(total, bin)])
-    $stderr.print("[%s] %s %s    \r" % [Time.now, step, adv])
-  end
-
-  def num_suffix(n, bin = false)
-    p = ''
-    { T: 4, G: 3, M: 2, K: 1 }.each do |k, x|
-      v = (bin ? 1024 : 1e3)**x
-      if n > v
-        n = '%.1f' % (n / v)
-        p = k
-        break
-      end
-    end
-    "#{n}#{p}"
+  # Same as MiGA::MiGA#advance, but checks if the CLI is verbose
+  def advance(*par)
+    super(*par) if self[:verbose]
   end
 
   ##
@@ -189,8 +168,9 @@ class MiGA::Cli < MiGA::MiGA
   end
 
   ##
-  # Perform the task requested (see #task)
-  def launch
+  # Perform the task requested (see #task); if +abort_on_error+, abort on
+  # error
+  def launch(abort_on_error = false)
     begin
       raise "See `miga -h`" if action.nil?
 
@@ -199,6 +179,7 @@ class MiGA::Cli < MiGA::MiGA
       $stderr.puts "Exception: #{err}"
       $stderr.puts ''
       err.backtrace.each { |l| $stderr.puts "DEBUG: #{l}" }
+      abort if abort_on_error
       err
     end
   end

data/lib/miga/cli/action/browse.rb

@@ -15,12 +15,12 @@ class MiGA::Cli::Action::Browse < MiGA::Cli::Action
     p = cli.load_project
     create_empty_page(p)
     generate_project_page(p)
-    say 'Creating dataset pages'
+    cli.say 'Creating dataset pages'
     cli.load_project.each_dataset do |d|
       generate_dataset_page(p, d)
     end
     generate_datasets_index(p)
-    say "Open in your browser: #{File.join(p.path, 'index.html')}"
+    cli.say "Open in your browser: #{File.join(p.path, 'index.html')}"
   end
 
   private
@@ -28,7 +28,7 @@ class MiGA::Cli::Action::Browse < MiGA::Cli::Action
   ##
   # Create an empty page with necessary assets for project +p+
   def create_empty_page(p)
-    say 'Creating project page'
+    cli.say 'Creating project page'
     FileUtils.mkdir_p(browse_file(p, '.'))
     %w[favicon-32.png style.css].each do |i|
       FileUtils.cp(template_file(i), browse_file(p, i))
@@ -46,8 +46,9 @@ class MiGA::Cli::Action::Browse < MiGA::Cli::Action
 
     # Summaries
     summaries = Dir["#{p.path}/*.tsv"].map do |i|
-      b = File.basename(i)
-      "<li><a href='../#{b}'>#{b}</a></li>"
+      b = File.basename(i, '.tsv')
+      generate_summary_page(i, p)
+      "<li><a href='s-#{b}.html'>#{format_name(b)}</a></li>"
     end.join('')
 
     # Project index page
@@ -60,6 +61,32 @@ class MiGA::Cli::Action::Browse < MiGA::Cli::Action
     write_file(p, 'index.html') { build_from_template('index.html', data) }
   end
 
+  ##
+  # Create page for the summary +path+ in project +p+
+  def generate_summary_page(path, p)
+    b = File.basename(path, '.tsv')
+    table = '<table class="table table-hover table-responsive">'
+    File.open(path, 'r') do |fh|
+      fh.each do |ln|
+        r = ln.chomp.split("\t")
+        if $. == 1
+          table += '<thead><tr>' +
+            r.map { |i| "<th scope=col>#{format_name(i)}</th>" }.join(' ') +
+            '</tr></thead><tbody>'
+        else
+          table += "<tr><th scope=row>#{r.shift}</th>" +
+            r.map { |i| "<td>#{i}</td>" }.join(' ') + "</tr>"
+        end
+      end
+    end
+    table += '</tbody></table>'
+    write_file(p, "s-#{b}.html") do
+      build_from_template(
+        'summary.html', file: "#{b}.tsv", name: format_name(b), table: table
+      )
+    end
+  end
+
   ##
   # Create page for dataset +d+ within project +p+
   def generate_dataset_page(p, d)
@@ -76,7 +103,7 @@ class MiGA::Cli::Action::Browse < MiGA::Cli::Action
   ##
   # Create pages for reference and query dataset indexes
   def generate_datasets_index(p)
-    say 'Creating index pages'
+    cli.say 'Creating index pages'
     data = format_dataset_index(p)
     data.each do |k, v|
       write_file(p, "#{k}_datasets.html") do

data/lib/miga/cli/action/browse/summary.html

@@ -0,0 +1,5 @@
+<h1 class="h2 border-bottom pt-3 pb-2 mb-3">Summary: {{name}}</h1>
+<p class='m-2 mb-3'>
+  Based on <a href='../{{file}}'>{{file}}</a>
+</p>
+{{table}}

data/lib/miga/cli/action/classify_wf.rb

@@ -42,9 +42,7 @@ class MiGA::Cli::Action::ClassifyWf < MiGA::Cli::Action
         '--no-summaries',
         'Do not generate intermediate step summaries'
       ) { |v| cli[:summaries] = v }
-      opts_for_wf(
-        opt, 'Input genome assemblies (nucleotides, FastA)', qual: false
-      )
+      opts_for_wf(opt, 'Input genome assemblies (nucleotides, FastA)')
     end
   end
 

data/lib/miga/cli/action/daemon.rb

@@ -6,7 +6,7 @@ require 'miga/daemon'
 
 class MiGA::Cli::Action::Daemon < MiGA::Cli::Action
   def parse_cli
-    cli.defaults = { daemon_opts: [] }
+    cli.defaults = { daemon_opts: [], show_log: false }
     cli.expect_operation = true
     cli.parse do |opt|
       opt.separator 'Available operations:'
@@ -45,6 +45,10 @@ class MiGA::Cli::Action::Daemon < MiGA::Cli::Action
         '--json PATH',
         'Path to a custom daemon definition in json format'
       ) { |v| cli[:json] = v }
+      opt.on(
+        '--show-log',
+        'Display log on advance instead of the progress summary'
+      ) { |v| cli[:show_log] = v }
       cli.opt_common(opt)
 
       opt.separator 'Daemon options:'
@@ -73,6 +77,7 @@ class MiGA::Cli::Action::Daemon < MiGA::Cli::Action
     d = MiGA::Daemon.new(p, cli[:json])
     dopts = %i[latency maxjobs nodelist ppn shutdown_when_done]
     dopts.each { |k| d.runopts(k, cli[k]) }
+    d.show_log! if cli[:show_log]
     d.daemon(cli.operation, cli[:daemon_opts])
   end
 end

data/lib/miga/cli/action/quality_wf.rb

@@ -9,16 +9,13 @@ class MiGA::Cli::Action::QualityWf < MiGA::Cli::Action
 
   def parse_cli
     default_opts_for_wf
-    cli.defaults = { mytaxa: false }
+    cli.defaults = { mytaxa: false, min_qual: 'no' }
     cli.parse do |opt|
       opt.on(
         '-m', '--mytaxa-scan',
         'Perform MyTaxa scan analysis'
       ) { |v| cli[:mytaxa] = v }
-      opts_for_wf(
-        opt, 'Input genome assemblies (nucleotides, FastA)',
-        qual: false
-      )
+      opts_for_wf(opt, 'Input genome assemblies (nucleotides, FastA)')
     end
   end
 

data/lib/miga/cli/action/wf.rb

@@ -9,7 +9,7 @@ module MiGA::Cli::Action::Wf
     cli.defaults = {
       clean: false, regexp: MiGA::Cli.FILE_REGEXP,
       project_type: :genomes, dataset_type: :popgenome,
-      ncbi_draft: true
+      ncbi_draft: true, min_qual: 25.0
     }
   end
 
@@ -42,10 +42,10 @@ module MiGA::Cli::Action::Wf
     end
     if params[:qual]
       opt.on(
-        '--min-qual FLOAT', Float,
+        '--min-qual FLOAT',
         'Minimum genome quality to include in analysis',
-        'By default: 50.0'
-      ) { |v| cli[:min_qual] = v }
+        "By default: #{cli[:min_qual]}"
+      ) { |v| cli[:min_qual] = v == 'no' ? v : v.to_f }
     end
     if params[:cleanup]
       opt.on(

data/lib/miga/common.rb

@@ -6,6 +6,7 @@ require 'miga/json'
 require 'miga/common/base'
 require 'miga/common/path'
 require 'miga/common/format'
+require 'stringio'
 
 ##
 # Generic class used to handle system-wide information and methods, and parent
@@ -38,10 +39,42 @@ class MiGA::MiGA
   ##
   # Print +par+ ensuring new line at the end.
   # Date/time-stamp each line.
-  # If the first parameter is +IO+, the output is sent there,
+  # If the first parameter is +IO+ or +StringIO+ the output is sent there,
   # otherwise it's sent to +$stderr+
   def say(*par)
-    io = par.first.is_a?(IO) ? par.shift : $stderr
+    io = like_io?(par.first) ? par.shift : $stderr
     io.puts(*par.map { |i| "[#{Time.now}] #{i}" })
   end
+
+  ##
+  # Reports the advance of a task at +step+ (String), the +n+ out of +total+.
+  # The advance is reported in powers of 1,024 if +bin+ is true, or powers of
+  # 1,000 otherwise.
+  # The report goes to $stderr iff --verborse
+  def advance(step, n = 0, total = nil, bin = true)
+    adv = total.nil? ? (n == 0 ? '' : num_suffix(n, bin)) :
+      ('%.1f%% (%s/%s)' % [100.0 * n / total,
+                           num_suffix(n, bin), num_suffix(total, bin)])
+    $stderr.print("[%s] %s %s    \r" % [Time.now, step, adv])
+  end
+
+  ##
+  # Return formatted number +n+ with the appropriate units as
+  # powers of 1,000 (if +bin+ if false) or 1,024 (otherwise)
+  def num_suffix(n, bin = false)
+    p = ''
+    { T: 4, G: 3, M: 2, K: 1 }.each do |k, x|
+      v = (bin ? 1024 : 1e3)**x
+      if n > v
+        n = '%.1f' % (n / v)
+        p = k
+        break
+      end
+    end
+    "#{n}#{p}"
+  end
+
+  def like_io?(obj)
+    obj.is_a?(IO) || obj.is_a?(StringIO)
+  end
 end

data/lib/miga/daemon.rb

@@ -72,6 +72,7 @@ class MiGA::Daemon < MiGA::MiGA
     say '-----------------------------------'
     say 'MiGA:%s launched' % project.name
     say '-----------------------------------'
+    miga_say "Saving log to: #{output_file}" unless show_log?
     recalculate_status!
     load_status
     say 'Configuration options:'
@@ -111,10 +112,12 @@ class MiGA::Daemon < MiGA::MiGA
     say(*msg) if verbosity >= level
   end
 
+  alias miga_say say
+
   ##
   # Same as +l_say+ with +level = 1+
   def say(*msg)
-    super(*msg) if verbosity >= 1
+    super(logfh, *msg) if verbosity >= 1
   end
 
   ##
@@ -173,6 +176,12 @@ class MiGA::Daemon < MiGA::MiGA
       o = true if ds.ref?
       queue_job(:d, ds)
     end
+    unless show_log?
+      n = project.dataset_names.count
+      k = jobs_to_run.size + jobs_running.size
+      advance('Datasets:', n - k, n, false)
+      miga_say if k == 0
+    end
     o
   end
 
@@ -332,8 +341,9 @@ class MiGA::Daemon < MiGA::MiGA
       kill: %w[pid]
     }.each do |k, v|
       if !runopts(k).nil? && runopts(k) =~ /%(\d+\$)?[ds]/
-        runopts(k,
-                runopts(k).gsub(/%(\d+\$)?d/, '%\\1s') % v.map { |i| "{{#{i}}}" })
+        runopts(
+          k, runopts(k).gsub(/%(\d+\$)?d/, '%\\1s') % v.map { |i| "{{#{i}}}" }
+        )
       end
     end
     runopts(:format_version, 1)

data/lib/miga/daemon/base.rb

@@ -17,7 +17,7 @@ module MiGA::Daemon::Base
         if !force && v == 0 && k != :verbosity
           raise "Daemon's #{k} cannot be set to zero"
         end
-      when :shutdown_when_done
+      when :shutdown_when_done, :show_log
         v = !!v
       when :nodelist
         if v =~ /^\$/
@@ -73,4 +73,31 @@ module MiGA::Daemon::Base
   def verbosity
     runopts(:verbosity) || 1
   end
+
+  ##
+  # Writing file handler (IO) to the log file
+  def logfh
+    return $stderr if show_log?
+    return @logfh if @logfh && !@logfh.closed?
+
+    @logfh = File.open(output_file, 'w')
+  end
+
+  ##
+  # Display log instead of the progress summary
+  def show_log!
+    @show_log = true
+  end
+
+  ##
+  # Display progress summary instead of the log
+  def show_summary!
+    @runopts[:show_log] = false
+  end
+
+  ##
+  # Display log instead of the progress summary?
+  def show_log?
+    @runopts[:show_log] ||= false
+  end
 end

data/lib/miga/version.rb

@@ -8,7 +8,7 @@ module MiGA
   # - Float representing the major.minor version.
   # - Integer representing gem releases of the current version.
   # - Integer representing minor changes that require new version number.
-  VERSION = [0.7, 13, 0]
+  VERSION = [0.7, 15, 2]
 
   ##
   # Nickname for the current major.minor version.
@@ -16,7 +16,7 @@ module MiGA
 
   ##
   # Date of the current gem release.
-  VERSION_DATE = Date.new(2020, 7, 31)
+  VERSION_DATE = Date.new(2020, 8, 12)
 
   ##
   # Reference of MiGA.

data/test/daemon_test.rb

@@ -9,7 +9,7 @@ class DaemonTest < Test::Unit::TestCase
   def setup
     initialize_miga_home(
       <<~DAEMON
-        { "maxjobs": 1, "ppn": 1, "latency": 2, "varsep": " ",
+        { "maxjobs": 1, "ppn": 1, "latency": 2, "varsep": " ", "show_log": true,
           "var": "{{key}}={{value}}", "cmd": "echo {{task_name}} >/dev/null",
           "alive": "echo 1 # {{pid}}", "type": "bash", "format_version": 1 }
       DAEMON

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: miga-base
 version: !ruby/object:Gem::Version
-  version: 0.7.13.0
+  version: 0.7.15.2
 platform: ruby
 authors:
 - Luis M. Rodriguez-R
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-31 00:00:00.000000000 Z
+date: 2020-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: daemons
@@ -128,6 +128,7 @@ files:
 - lib/miga/cli/action/browse/layout.html
 - lib/miga/cli/action/browse/redirect.html
 - lib/miga/cli/action/browse/style.css
+- lib/miga/cli/action/browse/summary.html
 - lib/miga/cli/action/classify_wf.rb
 - lib/miga/cli/action/console.rb
 - lib/miga/cli/action/daemon.rb
@@ -560,8 +561,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.5.2.3
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
 summary: MiGA