rbbt-rest 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e55cf49281298b1246307255c0a12b1d21ed9c7
-  data.tar.gz: f1c82dbd4fbcfa7aa7319a062572d7e2668a372e
+  metadata.gz: 7c3bfc548ebb34eaabf50cfcf9393b93f5eb889a
+  data.tar.gz: 7dad0127b8830e498db504f0ab74fc5ad0478fbc
 SHA512:
-  metadata.gz: 6a115419189c4329aa8a21583470a30aabf4b6df83496ba0c4458b4c82abd69c52735d960dd593e8daf8ff4edb50aa3bd98104c5543e4e8f4e659301d6e30e7a
-  data.tar.gz: df4116e66c81deda238babf66b90a660b66dd20cd09a61b80a00ad2714a62204fa69752c12e4418e1cdd68569dafe9142af9248487ffdc40ac3b4a63ed98411a
+  metadata.gz: 8aaa4bf85659e3b623e241298b2df6b33e7a669ebaea57e0956d8b22bb4c04359f75a96b57906b9f6b37b40fb09885f716f0357fa619d3f46b1756ee3e77a604
+  data.tar.gz: ad5cca4ee8c9f51f84102ed95bd0cc64d4dbcebcd9ee4d698419ad74ed93ee2fdb7327e9309cfeb126ce43afc04f00fc53018a23f6d5820700fd0904fe2044ec

data/lib/rbbt/rest/client.rb

@@ -189,6 +189,10 @@ class WorkflowRESTClient
     WorkflowRESTClient.get_raw(File.join(url, 'description'))
   end
 
+  def documentation
+    @documention ||= IndiferentHash.setup(WorkflowRESTClient.get_json(File.join(url, "documentation"),{}))
+  end
+
   def task_info(task)
     @task_info ||= {}
     @task_info[task]
@@ -327,4 +331,40 @@ class WorkflowRESTClient
       task.doc(dependencies)
     end
   end
+
+  def doc(task = nil)
+
+    if task.nil?
+      puts Log.color :magenta, self.to_s 
+      puts Log.color :magenta, "=" * self.to_s.length
+      if self.documentation[:description] and not self.documentation[:description].empty?
+        puts
+        puts Misc.format_paragraph self.documentation[:description] 
+      end
+      puts
+
+      puts Log.color :magenta, "## TASKS"
+      if self.documentation[:task_description] and not self.documentation[:task_description].empty?
+        puts
+        puts Misc.format_paragraph self.documentation[:task_description] 
+      end
+      puts
+
+      tasks.each do |name,task|
+        puts Misc.format_definition_list_item(name.to_s, task.description || "", 80, 30, :yellow)
+      end
+
+    else
+
+      if Task === task
+        task_name = task.name
+      else
+        task_name = task
+        task = self.tasks[task_name]
+      end
+      dependencies = self.rec_dependencies(task_name).collect{|dep_name| self.tasks[dep_name.to_sym]}
+
+      task.doc(dependencies)
+    end
+  end
 end

data/lib/rbbt/rest/workflow.rb

@@ -55,6 +55,17 @@ module Sinatra
         end
       end
 
+      get "/#{workflow.to_s}/documentation" do
+        case format
+        when :html
+          workflow_render('tasks', workflow)
+        when :json
+          content_type "application/json"
+          workflow.documentation.to_json
+        else
+          raise "Unsupported format specified: #{ format }"
+        end
+      end
       get "/#{workflow.to_s}/:task/info" do
         task     = consume_parameter(:task)
 
@@ -94,7 +105,7 @@ module Sinatra
 
         task_parameters = consume_task_parameters(workflow, task, params)
 
-        if complete_input_set(workflow, task, task_parameters) or format == :json
+        if complete_input_set(workflow, task, task_parameters) or format != :html 
           issue_job(workflow, task, jobname, task_parameters)
         else
           workflow_render('form', workflow, task, task_parameters)

data/share/views/compass/rbbt/form.sass

@@ -93,3 +93,4 @@
   select.format
     float: right
     width: auto
+

data/share/views/compass/workflow.sass

@@ -25,3 +25,8 @@ dd.job_control
     li a
 
 
+.workflow.tasks
+  font-size: 1.2em
+  p
+    max-width: 60em
+

data/share/views/tasks.haml

@@ -1,20 +1,28 @@
-%h3= workflow.to_s
+.workflow.tasks
+  %h3= workflow.to_s
 
-- unless workflow.workflow_description.empty?
-  :markdown 
-    #{workflow.workflow_description}
+  - unless workflow.documentation[:title].empty?
+    :markdown 
+      #{workflow.documentation[:title]}
+  - unless workflow.documentation[:description].empty?
+    :markdown 
+      #{workflow.documentation[:description]}
 
 
-%h5 Tasks
+  %h5 Tasks
 
-%ul.tasks.clean_list
-  - tasks = workflow.exec_exports + workflow.synchronous_exports + workflow.asynchronous_exports
+  - unless workflow.documentation[:task_description].empty?
+    :markdown 
+      #{workflow.documentation[:task_description]}
 
-  - tasks.sort.each do |task|
-    %li
-      //%a(href="#{to(File.join("/", workflow.to_s, task.to_s))}")= task
-      %a(href="#{File.join("/", workflow.to_s, task.to_s)}")= task
-      - info = workflow.task_info(task)
-      - if info[:description]
-        %p= info[:description].split(/\n\s*\n/).first
+  %ul.tasks.clean_list
+    - tasks = workflow.exec_exports + workflow.synchronous_exports + workflow.asynchronous_exports
+
+    - tasks.sort.each do |task|
+      %li
+        //%a(href="#{to(File.join("/", workflow.to_s, task.to_s))}")= task
+        %a(href="#{File.join("/", workflow.to_s, task.to_s)}")= task
+        - info = workflow.task_info(task)
+        - if info[:description]
+          %p= info[:description].split(/\n\s*\n/).first
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbbt-rest
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Miguel Vazquez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-25 00:00:00.000000000 Z
+date: 2014-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake