Added websocketUrl to discovery document. Workbench websockets testing page
[arvados.git] / apps / workbench / app / helpers / application_helper.rb
index c3409bd24e4f08073ac1201712912f83c7c30800..7231ff8addaac462791c8001f9f5fd7b16941f6d 100644 (file)
@@ -38,7 +38,7 @@ module ApplicationHelper
     end
 
     return h(n)
-      #raw = n.to_s
+    #raw = n.to_s
     #cooked = ''
     #while raw.length > 3
     #  cooked = ',' + raw[-3..-1] + cooked
@@ -51,6 +51,31 @@ module ApplicationHelper
     ArvadosBase::resource_class_for_uuid(attrvalue, opts)
   end
 
+  ##
+  # Returns HTML that links to the Arvados object specified in +attrvalue+
+  # Provides various output control and styling options.
+  #
+  # +attrvalue+ an Arvados model object or uuid
+  #
+  # +opts+ a set of flags to control output:
+  #
+  # [:link_text] the link text to use (may include HTML), overrides everything else
+  #
+  # [:friendly_name] whether to use the "friendly" name in the link text (by
+  # calling #friendly_link_name on the object), otherwise use the uuid
+  #
+  # [:with_class_name] prefix the link text with the class name of the model
+  #
+  # [:no_tags] disable tags in the link text (default is to show tags).
+  # Currently tags are only shown for Collections.
+  #
+  # [:thumbnail] if the object is a collection, show an image thumbnail if the
+  # collection consists of a single image file.
+  #
+  # [:no_link] don't create a link, just return the link text
+  #
+  # +style_opts+ additional HTML properties for the anchor tag, passed to link_to
+  #
   def link_to_if_arvados_object(attrvalue, opts={}, style_opts={})
     if (resource_class = resource_class_for_uuid(attrvalue, opts))
       link_uuid = attrvalue.is_a?(ArvadosBase) ? attrvalue.uuid : attrvalue
@@ -78,6 +103,15 @@ module ApplicationHelper
             link_name += ' <span class="label label-info">' + html_escape(tag.name) + '</span>'
           end
         end
+        if opts[:thumbnail] and resource_class == Collection
+          # add an image thumbnail if the collection consists of a single image file.
+          Collection.where(uuid: link_uuid).each do |c|
+            if c.files.length == 1 and CollectionsHelper::is_image c.files.first[1]
+              link_name += " "
+              link_name += image_tag "#{url_for c}/#{CollectionsHelper::file_path c.files.first}", style: "height: 4em; width: auto"
+            end
+          end
+        end
       end
       style_opts[:class] = (style_opts[:class] || '') + ' nowrap'
       if opts[:no_link]
@@ -86,6 +120,7 @@ module ApplicationHelper
         link_to raw(link_name), { controller: resource_class.to_s.tableize, action: 'show', id: link_uuid }, style_opts
       end
     else
+      # just return attrvalue if it is not recognizable as an Arvados object or uuid.
       attrvalue
     end
   end
@@ -118,49 +153,39 @@ module ApplicationHelper
     }.merge(htmloptions)
   end
 
-  def render_editable_subattribute(object, attr, subattr, template, htmloptions={})
-    if object
-      attrvalue = object.send(attr)
-      subattr.each do |k|
-        if attrvalue and attrvalue.is_a? Hash
-          attrvalue = attrvalue[k]
-        else
-          break
-        end
-      end
-    end
-
+  def render_pipeline_component_attribute(object, attr, subattr, value_info, htmloptions={})
     datatype = nil
     required = true
-    if template
-      #puts "Template is #{template.class} #{template.is_a? Hash} #{template}"
-      if template.is_a? Hash
-        if template[:output_of]
-          return raw("<span class='label label-default'>#{template[:output_of]}</span>")
-        end
-        if template[:dataclass]
-          dataclass = template[:dataclass]
-        end
-        if template[:optional] != nil
-          required = (template[:optional] != "true")
-        end
-        if template[:required] != nil
-          required = template[:required]
-        end
+    attrvalue = value_info
+
+    if value_info.is_a? Hash
+      if value_info[:output_of]
+        return raw("<span class='label label-default'>#{value_info[:output_of]}</span>")
+      end
+      if value_info[:dataclass]
+        dataclass = value_info[:dataclass]
+      end
+      if value_info[:optional] != nil
+        required = (value_info[:optional] != "true")
+      end
+      if value_info[:required] != nil
+        required = value_info[:required]
       end
-    end
 
-    rsc = template
-    if template.is_a? Hash
-      if template[:value]
-        rsc = template[:value]
-      elsif template[:default]
-        rsc = template[:default]
+      # Pick a suitable attrvalue to show as the current value (i.e.,
+      # the one that would be used if we ran the pipeline right now).
+      if value_info[:value]
+        attrvalue = value_info[:value]
+      elsif value_info[:default]
+        attrvalue = value_info[:default]
+      else
+        attrvalue = ''
       end
     end
 
-    return link_to_if_arvados_object(rsc) if !object
-    return link_to_if_arvados_object(attrvalue) if !object.attribute_editable? attr
+    unless object.andand.attribute_editable? attr
+      return link_to_if_arvados_object attrvalue
+    end
 
     if dataclass
       begin
@@ -168,23 +193,20 @@ module ApplicationHelper
       rescue NameError
       end
     else
-      dataclass = ArvadosBase.resource_class_for_uuid(rsc)
+      dataclass = ArvadosBase.resource_class_for_uuid(attrvalue)
     end
 
-    if dataclass && dataclass.is_a?(Class)
+    if dataclass.andand.is_a?(Class)
       datatype = 'select'
     elsif dataclass == 'number'
       datatype = 'number'
-    else
-      if template.is_a? Array
-        # ?!?
-      elsif template.is_a? String
-        if /^\d+$/.match(template)
-          datatype = 'number'
-        else
-          datatype = 'text'
-        end
-      end
+    elsif attrvalue.is_a? Array
+      # TODO: find a way to edit arrays with x-editable
+      return attrvalue
+    elsif attrvalue.is_a? Fixnum or attrvalue.is_a? Float
+      datatype = 'number'
+    elsif attrvalue.is_a? String
+      datatype = 'text'
     end
 
     id = "#{object.uuid}-#{subattr.join('-')}"
@@ -192,14 +214,13 @@ module ApplicationHelper
     subattr.each do |a|
       dn += "[#{a}]"
     end
-
-    if attrvalue.is_a? String
-      attrvalue = attrvalue.strip
+    if value_info.is_a? Hash
+      dn += '[value]'
     end
 
+    items = []
     attrtext = attrvalue
     if dataclass and dataclass.is_a? Class
-      items = []
       if attrvalue and !attrvalue.empty?
         Link.where(head_uuid: attrvalue, link_class: ["tag", "identifier"]).each do |tag|
           attrtext += " [#{tag.name}]"
@@ -227,7 +248,7 @@ module ApplicationHelper
       "data-emptytext" => "none",
       "data-placement" => "bottom",
       "data-type" => datatype,
-      "data-url" => url_for(action: "update", id: object.uuid, controller: object.class.to_s.pluralize.underscore),
+      "data-url" => url_for(action: "update", id: object.uuid, controller: object.class.to_s.pluralize.underscore, merge: true),
       "data-title" => "Set value for #{subattr[-1].to_s}",
       "data-name" => dn,
       "data-pk" => "{id: \"#{object.uuid}\", key: \"#{object.class.to_s.underscore}\"}",
@@ -239,7 +260,7 @@ module ApplicationHelper
 
     lt += raw("\n<script>")
 
-    if items and items.length > 0
+    if items.any?
       lt += raw("add_form_selection_sources(#{items.to_json});\n")
     end