Import toolshed form builder in remaining modules

lib/tool_shed/galaxy_install/metadata/installed_repository_metadata_manager.py

@@ -5,7 +5,7 @@
 
 from galaxy import util
 from galaxy.util import inflector
-from galaxy.web.form_builder import SelectField
+from tool_shed.util.form_util import SelectField
 from tool_shed.galaxy_install.tools import tool_panel_manager
 from tool_shed.metadata import metadata_generator
 from tool_shed.util import common_util

lib/tool_shed/metadata/repository_metadata_manager.py

@@ -5,10 +5,10 @@
 
 from galaxy import util
 from galaxy.util import inflector
-from galaxy.web.form_builder import SelectField
 from tool_shed.metadata import metadata_generator
 from tool_shed.repository_types import util as rt_util
 from tool_shed.repository_types.metadata import TipOnly
+from tool_shed.util.form_util import SelectField
 from tool_shed.util import (basic_util, common_util, hg_util, metadata_util,
     repository_util, shed_util_common as suc, tool_util)
 

lib/tool_shed/repository_types/util.py

@@ -1,6 +1,6 @@
 import logging
 
-from galaxy.web.form_builder import SelectField
+from tool_shed.util.form_util import SelectField
 
 log = logging.getLogger(__name__)
 

lib/tool_shed/util/admin_util.py

@@ -4,7 +4,7 @@
 
 from galaxy import util, web
 from galaxy.util import inflector
-from galaxy.web.form_builder import CheckboxField
+from tool_shed.util.form_util import CheckboxField
 from tool_shed.util.web_util import escape
 
 

lib/tool_shed/util/form_util.py

@@ -17,7 +17,90 @@
 log = logging.getLogger(__name__)
 
 
-class SelectField(object):
+class BaseField(object):
+    def __init__(self, name, value=None, label=None, **kwds):
+        self.name = name
+        self.label = label
+        self.value = value
+        self.disabled = kwds.get('disabled', False)
+        if 'optional' in kwds:
+            self.optional = asbool(kwds.get('optional'))
+        else:
+            self.optional = kwds.get('required', 'optional') == 'optional'
+        self.help = kwds.get('helptext')
+
+    def get_html(self, prefix=""):
+        """Returns the html widget corresponding to the parameter"""
+        raise TypeError("Abstract Method")
+
+    def get_disabled_str(self, disabled=False):
+        if disabled:
+            return ' disabled="disabled"'
+        else:
+            return ''
+
+    def to_dict(self):
+        return {
+            'name'      : self.name,
+            'label'     : self.label,
+            'disabled'  : self.disabled,
+            'optional'  : self.optional,
+            'value'     : self.value,
+            'help'      : self.help
+        }
+
+
+class CheckboxField(BaseField):
+    """
+    A checkbox (boolean input)
+
+    >>> print(CheckboxField( "foo" ).get_html())
+    <input type="checkbox" id="foo" name="foo" value="__CHECKED__"><input type="hidden" name="foo" value="__NOTHING__">
+    >>> print(CheckboxField( "bar", checked="yes" ).get_html())
+    <input type="checkbox" id="bar" name="bar" value="__CHECKED__" checked="checked"><input type="hidden" name="bar" value="__NOTHING__">
+    """
+
+    def __init__(self, name, checked=None, refresh_on_change=False, refresh_on_change_values=None, value=None, **kwds):
+        super(CheckboxField, self).__init__(name, value, **kwds)
+        self.name = name
+        self.checked = (checked is True) or (isinstance(checked, string_types) and (checked.lower() in ("yes", "true", "on")))
+        self.refresh_on_change = refresh_on_change
+        self.refresh_on_change_values = refresh_on_change_values or []
+        if self.refresh_on_change:
+            self.refresh_on_change_text = ' refresh_on_change="true" '
+            if self.refresh_on_change_values:
+                self.refresh_on_change_text = '%s refresh_on_change_values="%s" ' % (self.refresh_on_change_text, ",".join(self.refresh_on_change_values))
+        else:
+            self.refresh_on_change_text = ''
+
+    def get_html(self, prefix="", disabled=False):
+        if self.checked:
+            checked_text = ' checked="checked"'
+        else:
+            checked_text = ''
+        id_name = prefix + self.name
+        return unicodify('<input type="checkbox" id="%s" name="%s" value="__CHECKED__"%s%s%s><input type="hidden" name="%s" value="__NOTHING__"%s>'
+                         % (id_name, id_name, checked_text, self.get_disabled_str(disabled), self.refresh_on_change_text, id_name, self.get_disabled_str(disabled)))
+
+    @staticmethod
+    def is_checked(value):
+        if value in [True, "true"]:
+            return True
+        return isinstance(value, list) and ('__CHECKED__' in value or len(value) == 2)
+
+    def set_checked(self, value):
+        if isinstance(value, string_types):
+            self.checked = value.lower() in ["yes", "true", "on"]
+        else:
+            self.checked = value
+
+    def to_dict(self):
+        d = super(CheckboxField, self).to_dict()
+        d['type'] = 'boolean'
+        return d
+
+
+class SelectField(BaseField):
     """
     A select field.
 
@@ -56,18 +139,12 @@ class SelectField(object):
     """
 
     def __init__(self, name, multiple=None, display=None, refresh_on_change=False, refresh_on_change_values=None, size=None, field_id=None, value=None, selectlist=None, **kwds):
+        super(SelectField, self).__init__(name, value, **kwds)
         self.name = name
-        self.label = label
-        self.value = value
-        self.disabled = kwds.get('disabled', False)
-        if 'optional' in kwds:
-            self.optional = asbool(kwds.get('optional'))
-        else:
-            self.optional = kwds.get('required', 'optional') == 'optional'
-        self.help = kwds.get('helptext')
         self.field_id = field_id
         self.multiple = multiple or False
         self.selectlist = selectlist or []
+        self.value = value
         self.size = size
         self.options = list()
         if display == "checkboxes":
@@ -86,12 +163,6 @@ def __init__(self, name, multiple=None, display=None, refresh_on_change=False, r
         else:
             self.refresh_on_change_text = ''
 
-    def get_disabled_str(self, disabled=False):
-        if disabled:
-            return ' disabled="disabled"'
-        else:
-            return ''
-
     def add_option(self, text, value, selected=False):
         self.options.append((text, value, selected))
 
@@ -213,7 +284,25 @@ def get_selected(self, return_label=False, return_value=False, multi=False):
             return selected_options
         return None
 
+    def to_dict(self):
+        d = super(SelectField, self).to_dict()
+        d['type'] = 'select'
+        d['display'] = self.display
+        d['multiple'] = self.multiple
+        d['data'] = []
+        for value in self.selectlist:
+            d['data'].append({'label': value, 'value': value})
+        return d
+
+
+def get_suite():
+    """Get unittest suite for this module"""
+    import doctest
+    import sys
+    return doctest.DocTestSuite(sys.modules[__name__])
+
 
+# --------- Utility methods -----------------------------
 def build_select_field(trans, objs, label_attr, select_field_name, initial_value='none',
                        selected_value='none', refresh_on_change=False, multiple=False, display=None, size=None):
     """

lib/tool_shed/util/tool_dependency_util.py

@@ -5,7 +5,7 @@
 from sqlalchemy import and_
 
 from galaxy import util
-from galaxy.web.form_builder import SelectField
+from tool_shed.util.form_util import SelectField
 from tool_shed.util import hg_util
 from tool_shed.util import xml_util
 

lib/tool_shed/util/tool_util.py

@@ -7,7 +7,7 @@
 from galaxy.datatypes.sniff import is_column_based
 from galaxy.util import checkers
 from galaxy.util.expressions import ExpressionContext
-from galaxy.web.form_builder import SelectField
+from tool_shed.util.form_util import SelectField
 from tool_shed.util import basic_util
 
 log = logging.getLogger(__name__)