From a301cc40368d78d71e8fbabed122066cccd2618f Mon Sep 17 00:00:00 2001
From: "david.henne" <david.henne@wildcardcorp.com>
Date: Tue, 21 Mar 2023 13:05:33 -0500
Subject: [PATCH 1/6] define castle choice field to override easyform choice
 default.

---
 castle/cms/easyform/configure.zcml |  17 ++++
 castle/cms/easyform/field.py       | 147 ++++++++++++++++++++++++++++-
 castle/cms/easyform/supermodel.py  |  59 +++++++++++-
 castle/cms/easyform/terms.py       |  17 +++-
 castle/cms/widgets.py              |   7 ++
 5 files changed, 242 insertions(+), 5 deletions(-)

diff --git a/castle/cms/easyform/configure.zcml b/castle/cms/easyform/configure.zcml
index 5e5cb3f48..cfc0c54ce 100644
--- a/castle/cms/easyform/configure.zcml
+++ b/castle/cms/easyform/configure.zcml
@@ -26,6 +26,23 @@
     name="castle.cms.easyform.field.QueryChoice"
     />
 
+  <!-- Castle specific override for choice field -->
+  <utility
+    name="castle.cms.easyform.field.CastleChoice"
+    component=".field.CastleChoiceFactory"
+    />
+  <adapter factory=".field.getCastleChoiceFieldSchema" />
+  <adapter factory=".field.TextLineCastleChoiceField"
+           provides=".field.ICastleChoiceFieldSchema" />
+  <!-- z3c.form terms translation -->
+  <adapter factory=".terms.CastleChoiceTerms" />
+
+  <!-- supermodel integration to be able to (de)?serialize field -->
+  <utility
+    component=".supermodel.CastleChoiceImportExportHandler"
+    name="castle.cms.easyform.field.CastleChoice"
+    />
+
   <!--
   Tweak toolbar so when you're on fields, you can click the "View Page" button
   and go back
diff --git a/castle/cms/easyform/field.py b/castle/cms/easyform/field.py
index 2ba3799cd..a8a0b356b 100644
--- a/castle/cms/easyform/field.py
+++ b/castle/cms/easyform/field.py
@@ -2,7 +2,7 @@
 from plone.uuid.interfaces import IUUID
 
 from castle.cms.utils import parse_query_from_data
-from castle.cms.widgets import QueryFieldWidget
+from castle.cms.widgets import CastleFieldWidget, QueryFieldWidget
 from plone.autoform import directives as form
 from plone.schemaeditor.fields import FieldFactory
 from plone.schemaeditor.fields import TextLineChoiceField
@@ -163,3 +163,148 @@ def getQueryChoiceFieldSchema(field):
 @adapter(IQueryChoice)
 class TextLineQueryChoiceField(TextLineChoiceField):
     pass
+
+
+# TODO:
+#! --------------- CASTLE CHOICE SCHEMA ---------------
+
+class ICastleChoice(IChoice):
+    query = schema.List(
+        title=u'Query',
+        value_type=schema.Dict(value_type=schema.Field(),
+                               key_type=schema.TextLine()),
+        required=False
+    )
+
+    sort_on = schema.TextLine(
+        title=u'Sort on',
+        required=False,
+        default=u'effective'
+    )
+
+    sort_reversed = schema.Bool(
+        title=u'Reversed order',
+        required=False,
+        default=True
+    )
+
+    limit = schema.Int(
+        title=u'Limit',
+        required=False,
+        default=15,
+        min=1,
+    )
+
+
+@implementer(ICastleChoice)
+class CastleChoice(schema.Choice):
+
+    def __init__(self, query=None, sort_on='effective', sort_reversed=True,
+                 limit=15, **kw):
+        self.query = query or []
+        self.sort_on = sort_on
+        self.sort_reversed = sort_reversed
+        self.limit = limit
+        kw['source'] = CastleChoiceSource(self)  # bind to field
+        self._fix_query()
+        super(CastleChoice, self).__init__(**kw)
+
+    def _fix_query(self):
+        # does not save data properly often here
+        for item in (self.query or []):
+            if (item['v'] and
+                    isinstance(item['v'], basestring) and
+                    item['v'][0] in ('[', '{') and
+                    item['v'][-1] in (']', '}')):
+                item['v'] = ast.literal_eval(item['v'])
+
+
+@implementer(IContextSourceBinder)
+class CastleChoiceSource(object):
+    __name__ = 'CastleChoiceSource'
+
+    def __init__(self, field):
+        self.field = field
+
+    def get_cache_key(self, context):
+        return 'easyform-source-value--{}-{}'.format(
+            IUUID(context, 'default'), self.field.__name__)
+
+    def __call__(self, context):
+        cache_key = self.get_cache_key(context)
+        request = getRequest()
+        if request is not None and cache_key in request.environ:
+            # prevent doing query many times
+            return request.environ[cache_key]
+
+        if not self.field.query:
+            return SimpleVocabulary([])
+
+        query = parse_query_from_data({
+            'query': self.field.query,
+            'sort_on': self.field.sort_on,
+            'sort_reversed': self.field.sort_reversed,
+        })
+        catalog = getToolByName(context, 'portal_catalog')
+        if query.get('sort_on', '') not in catalog._catalog.indexes:
+            query['sort_on'] = 'effective'
+
+        terms = []
+        for item in catalog(**query)[:self.field.limit]:
+            terms.append(
+                SimpleVocabulary.createTerm(item.id, item.id, item.Title))
+
+        value = SimpleVocabulary(terms)
+        if request is not None:
+            request.environ[cache_key] = value
+        return value
+
+
+# so we can still resolve correctly
+alsoProvides(CastleChoiceSource, IContextSourceBinder)
+
+
+CastleChoiceFactory = FieldFactory(
+    CastleChoice, _(u'label_castle_choice_field', default=u'Castle Choice'),
+    source=CastleChoiceSource)
+
+
+class ICastleChoiceFieldSchema(IField):
+    form.widget(query=CastleFieldWidget)
+    query = schema.List(
+        title=u'Query',
+        value_type=schema.Dict(value_type=schema.Field(),
+                               key_type=schema.TextLine()),
+        required=False
+    )
+
+    sort_on = schema.TextLine(
+        title=u'Sort on',
+        required=False,
+        default=u'effective'
+    )
+
+    sort_reversed = schema.Bool(
+        title=u'Reversed order',
+        required=False,
+        default=True
+    )
+
+    limit = schema.Int(
+        title=u'Limit',
+        required=False,
+        default=15,
+        min=1,
+    )
+
+
+@implementer(IFieldEditFormSchema)
+@adapter(ICastleChoice)
+def getCastleChoiceFieldSchema(field):
+    return ICastleChoiceFieldSchema
+
+
+@implementer(ICastleChoiceFieldSchema)
+@adapter(ICastleChoice)
+class TextLineCastleChoiceField(TextLineChoiceField):
+    pass
diff --git a/castle/cms/easyform/supermodel.py b/castle/cms/easyform/supermodel.py
index c792e2263..3cd31d4d1 100644
--- a/castle/cms/easyform/supermodel.py
+++ b/castle/cms/easyform/supermodel.py
@@ -6,7 +6,7 @@
 
 from zope.schema.interfaces import ISource
 
-from .field import QueryChoice
+from .field import CastleChoice, QueryChoice
 
 
 class QueryChoiceHandler(plone.supermodel.exportimport.ChoiceHandler):
@@ -63,3 +63,60 @@ def write(self, field, name, type, elementName='field'):
 
 
 QueryChoiceImportExportHandler = QueryChoiceHandler(QueryChoice)
+
+
+# TODO:
+class CastleChoiceHandler(plone.supermodel.exportimport.ChoiceHandler):
+    """
+    Extend/override ChoiceHandler to work for CastleChoice field
+    """
+
+    def _constructField(self, attributes):
+        if 'vocabulary' in attributes:
+            try:
+                component = resolve(attributes['vocabulary'])
+                if IBaseVocabulary.providedBy(component):
+                    attributes['vocabulary'] = component
+                elif (ISource.providedBy(component) or
+                        IContextSourceBinder.providedBy(component)):
+                    attributes['source'] = component
+                    del attributes['vocabulary']
+            except ImportError:
+                # regular named vocabulary, leave as is
+                pass
+        return super(CastleChoiceHandler, self)._constructField(attributes)
+
+    def write(self, field, name, type, elementName='field'):
+        element = super(plone.supermodel.exportimport.ChoiceHandler, self).write(
+            field,
+            name,
+            type,
+            elementName
+        )
+        if field.vocabulary is not None:
+            value = "{}.{}".format(
+                field.vocabulary.__module__,
+                field.vocabulary.__name__)
+            child = valueToElement(
+                self.fieldAttributes['vocabulary'],
+                value,
+                name='vocabulary',
+                force=True
+            )
+            element.append(child)
+        else:
+            value = "{}.{}".format(
+                field.source.__module__,
+                field.source.__name__)
+            child = valueToElement(
+                self.fieldAttributes['source'],
+                value,
+                name='source',
+                force=True
+            )
+            element.append(child)
+
+        return element
+
+
+CastleChoiceImportExportHandler = CastleChoiceHandler(CastleChoice)
diff --git a/castle/cms/easyform/terms.py b/castle/cms/easyform/terms.py
index 8d963be81..fab73d765 100644
--- a/castle/cms/easyform/terms.py
+++ b/castle/cms/easyform/terms.py
@@ -1,12 +1,12 @@
 from castle.cms.interfaces import ICastleLayer
 from z3c.form.interfaces import ITerms
 from z3c.form.interfaces import IWidget
-from z3c.form.term import ChoiceTerms
+from z3c.form import term
 from zope.component import adapter
 from zope.interface import Interface
 from zope.interface import implementer
 
-from .field import IQueryChoice
+from .field import ICastleChoice, IQueryChoice
 
 
 @implementer(ITerms)
@@ -17,4 +17,15 @@
     IQueryChoice,
     IWidget)
 def QueryChoiceTerms(context, request, form, field, widget):
-    return ChoiceTerms(context, request, form, field, widget)
+    return term.ChoiceTerms(context, request, form, field, widget)
+
+
+@implementer(ITerms)
+@adapter(
+    Interface,
+    ICastleLayer,
+    Interface,
+    ICastleChoice,
+    IWidget)
+def CastleChoiceTerms(context, request, form, field, widget):
+    return term.ChoiceTerms(context, request, form, field, widget)
diff --git a/castle/cms/widgets.py b/castle/cms/widgets.py
index deede71c1..fcb309454 100644
--- a/castle/cms/widgets.py
+++ b/castle/cms/widgets.py
@@ -197,6 +197,13 @@ def QueryFieldWidget(field, request):
     return z3c.form.widget.FieldWidget(field, QueryStringWidget(request))
 
 
+# TODO: widget definition
+@adapter(IField, ICastleLayer)
+@implementer(IFieldWidget)
+def CastleFieldWidget(field, request):
+    return z3c.form.widget.FieldWidget(field, QueryStringWidget(request))
+
+
 @adapter(IField, ICastleLayer)
 @implementer(IFieldWidget)
 def RelatedItemsFieldWidget(field, request):

From 4f1e3b521006ca71dc2e0d5dde380d78285e5fde Mon Sep 17 00:00:00 2001
From: "david.henne" <david.henne@wildcardcorp.com>
Date: Wed, 22 Mar 2023 14:10:15 -0500
Subject: [PATCH 2/6] add default None value with required choice field

---
 castle/cms/easyform/configure.zcml |   2 -
 castle/cms/easyform/field.py       | 148 +++++++++--------------------
 castle/cms/easyform/terms.py       |  13 +--
 3 files changed, 46 insertions(+), 117 deletions(-)

diff --git a/castle/cms/easyform/configure.zcml b/castle/cms/easyform/configure.zcml
index cfc0c54ce..cd0e63ff7 100644
--- a/castle/cms/easyform/configure.zcml
+++ b/castle/cms/easyform/configure.zcml
@@ -34,8 +34,6 @@
   <adapter factory=".field.getCastleChoiceFieldSchema" />
   <adapter factory=".field.TextLineCastleChoiceField"
            provides=".field.ICastleChoiceFieldSchema" />
-  <!-- z3c.form terms translation -->
-  <adapter factory=".terms.CastleChoiceTerms" />
 
   <!-- supermodel integration to be able to (de)?serialize field -->
   <utility
diff --git a/castle/cms/easyform/field.py b/castle/cms/easyform/field.py
index a8a0b356b..683f2ecf8 100644
--- a/castle/cms/easyform/field.py
+++ b/castle/cms/easyform/field.py
@@ -167,58 +167,6 @@ class TextLineQueryChoiceField(TextLineChoiceField):
 
 # TODO:
 #! --------------- CASTLE CHOICE SCHEMA ---------------
-
-class ICastleChoice(IChoice):
-    query = schema.List(
-        title=u'Query',
-        value_type=schema.Dict(value_type=schema.Field(),
-                               key_type=schema.TextLine()),
-        required=False
-    )
-
-    sort_on = schema.TextLine(
-        title=u'Sort on',
-        required=False,
-        default=u'effective'
-    )
-
-    sort_reversed = schema.Bool(
-        title=u'Reversed order',
-        required=False,
-        default=True
-    )
-
-    limit = schema.Int(
-        title=u'Limit',
-        required=False,
-        default=15,
-        min=1,
-    )
-
-
-@implementer(ICastleChoice)
-class CastleChoice(schema.Choice):
-
-    def __init__(self, query=None, sort_on='effective', sort_reversed=True,
-                 limit=15, **kw):
-        self.query = query or []
-        self.sort_on = sort_on
-        self.sort_reversed = sort_reversed
-        self.limit = limit
-        kw['source'] = CastleChoiceSource(self)  # bind to field
-        self._fix_query()
-        super(CastleChoice, self).__init__(**kw)
-
-    def _fix_query(self):
-        # does not save data properly often here
-        for item in (self.query or []):
-            if (item['v'] and
-                    isinstance(item['v'], basestring) and
-                    item['v'][0] in ('[', '{') and
-                    item['v'][-1] in (']', '}')):
-                item['v'] = ast.literal_eval(item['v'])
-
-
 @implementer(IContextSourceBinder)
 class CastleChoiceSource(object):
     __name__ = 'CastleChoiceSource'
@@ -231,71 +179,65 @@ def get_cache_key(self, context):
             IUUID(context, 'default'), self.field.__name__)
 
     def __call__(self, context):
-        cache_key = self.get_cache_key(context)
-        request = getRequest()
-        if request is not None and cache_key in request.environ:
-            # prevent doing query many times
-            return request.environ[cache_key]
-
-        if not self.field.query:
+        if self.field.possible_values == []:
             return SimpleVocabulary([])
+        else:
+            default_none_val = SimpleVocabulary.createTerm(None, None, None)
+            terms = [default_none_val]
+            for item in self.field.possible_values:
+                terms.append(
+                    SimpleVocabulary.createTerm(item, item, item))
 
-        query = parse_query_from_data({
-            'query': self.field.query,
-            'sort_on': self.field.sort_on,
-            'sort_reversed': self.field.sort_reversed,
-        })
-        catalog = getToolByName(context, 'portal_catalog')
-        if query.get('sort_on', '') not in catalog._catalog.indexes:
-            query['sort_on'] = 'effective'
-
-        terms = []
-        for item in catalog(**query)[:self.field.limit]:
-            terms.append(
-                SimpleVocabulary.createTerm(item.id, item.id, item.Title))
-
-        value = SimpleVocabulary(terms)
-        if request is not None:
-            request.environ[cache_key] = value
-        return value
+            return SimpleVocabulary(terms)
 
 
 # so we can still resolve correctly
 alsoProvides(CastleChoiceSource, IContextSourceBinder)
 
 
+class ICastleChoice(IChoice):
+    possible_values = schema.List(
+        title=u'Possible values',
+        description=u'Enter allowed choices one per line.',
+        value_type=schema.TextLine()
+    )
+
+    # vocabulary_name = schema.Choice(
+    #     title=u'Vocabulary name',
+    #     description=u'Vocabulary name to lookup in the vocabulary registry',
+    #     default=u'',
+    #     vocabulary='castle.cms.vocabularies.MimeTypes'
+    # )
+
+
+@implementer(ICastleChoice)
+class CastleChoice(schema.Choice):
+
+    def __init__(self, possible_values=[], **kw):
+        self.possible_values = possible_values
+        # self.vocabulary_name = vocabulary_name
+        kw['source'] = CastleChoiceSource(self)  # bind to field
+        super(CastleChoice, self).__init__(**kw)
+
+
 CastleChoiceFactory = FieldFactory(
     CastleChoice, _(u'label_castle_choice_field', default=u'Castle Choice'),
     source=CastleChoiceSource)
 
 
 class ICastleChoiceFieldSchema(IField):
-    form.widget(query=CastleFieldWidget)
-    query = schema.List(
-        title=u'Query',
-        value_type=schema.Dict(value_type=schema.Field(),
-                               key_type=schema.TextLine()),
-        required=False
-    )
-
-    sort_on = schema.TextLine(
-        title=u'Sort on',
-        required=False,
-        default=u'effective'
-    )
-
-    sort_reversed = schema.Bool(
-        title=u'Reversed order',
-        required=False,
-        default=True
-    )
-
-    limit = schema.Int(
-        title=u'Limit',
-        required=False,
-        default=15,
-        min=1,
-    )
+    possible_values = schema.List(
+        title=u'Possible values',
+        description=u'Enter allowed choices one per line.',
+        value_type=schema.TextLine()
+    )
+
+    # vocabulary_name = schema.Choice(
+    #     title=u'Vocabulary name',
+    #     description=u'Vocabulary name to lookup in the vocabulary registry',
+    #     default=u'',
+    #     vocabulary='castle.cms.vocabularies.MimeTypes'
+    # )
 
 
 @implementer(IFieldEditFormSchema)
diff --git a/castle/cms/easyform/terms.py b/castle/cms/easyform/terms.py
index fab73d765..bbf79392c 100644
--- a/castle/cms/easyform/terms.py
+++ b/castle/cms/easyform/terms.py
@@ -6,7 +6,7 @@
 from zope.interface import Interface
 from zope.interface import implementer
 
-from .field import ICastleChoice, IQueryChoice
+from .field import IQueryChoice
 
 
 @implementer(ITerms)
@@ -18,14 +18,3 @@
     IWidget)
 def QueryChoiceTerms(context, request, form, field, widget):
     return term.ChoiceTerms(context, request, form, field, widget)
-
-
-@implementer(ITerms)
-@adapter(
-    Interface,
-    ICastleLayer,
-    Interface,
-    ICastleChoice,
-    IWidget)
-def CastleChoiceTerms(context, request, form, field, widget):
-    return term.ChoiceTerms(context, request, form, field, widget)

From f9531661ac7f328f962a9ae53e8f6a1665222961 Mon Sep 17 00:00:00 2001
From: "david.henne" <david.henne@wildcardcorp.com>
Date: Fri, 24 Mar 2023 14:26:23 -0500
Subject: [PATCH 3/6] handle vocabulary value, add form validation.

---
 castle/cms/easyform/field.py | 60 +++++++++++++++++++++++++-----------
 castle/cms/widgets.py        |  7 -----
 2 files changed, 42 insertions(+), 25 deletions(-)

diff --git a/castle/cms/easyform/field.py b/castle/cms/easyform/field.py
index 683f2ecf8..42ef8df7f 100644
--- a/castle/cms/easyform/field.py
+++ b/castle/cms/easyform/field.py
@@ -2,7 +2,7 @@
 from plone.uuid.interfaces import IUUID
 
 from castle.cms.utils import parse_query_from_data
-from castle.cms.widgets import CastleFieldWidget, QueryFieldWidget
+from castle.cms.widgets import QueryFieldWidget
 from plone.autoform import directives as form
 from plone.schemaeditor.fields import FieldFactory
 from plone.schemaeditor.fields import TextLineChoiceField
@@ -14,6 +14,8 @@
 from zope.i18nmessageid import MessageFactory
 from zope.interface import alsoProvides
 from zope.interface import implementer
+from zope.interface import Invalid
+from zope.interface import invariant
 from zope.schema.interfaces import IChoice
 from zope.schema.interfaces import IContextSourceBinder
 from zope.schema.interfaces import IField
@@ -180,7 +182,13 @@ def get_cache_key(self, context):
 
     def __call__(self, context):
         if self.field.possible_values == []:
-            return SimpleVocabulary([])
+            if self.field.vocabulary_name == None:
+                return SimpleVocabulary([])
+            else:
+                # TODO: use vocab selection if there are no fields input.
+                # get name of vocabulary from vocabulary_name value and lookup all vocab terms associated with it
+                thing = 'vocabulary: %s' % self.field.vocabulary_name
+                return SimpleVocabulary([SimpleVocabulary.createTerm(thing, thing, thing)])
         else:
             default_none_val = SimpleVocabulary.createTerm(None, None, None)
             terms = [default_none_val]
@@ -199,23 +207,31 @@ class ICastleChoice(IChoice):
     possible_values = schema.List(
         title=u'Possible values',
         description=u'Enter allowed choices one per line.',
-        value_type=schema.TextLine()
+        value_type=schema.TextLine(),
+        required=False
+    )
+
+    vocabulary_name = schema.Choice(
+        title=u'Vocabulary name',
+        description=u'Vocabulary name to lookup in the vocabulary registry',
+        default=u'',
+        vocabulary='plone.app.vocabularies.Groups',
+        required=False
     )
 
-    # vocabulary_name = schema.Choice(
-    #     title=u'Vocabulary name',
-    #     description=u'Vocabulary name to lookup in the vocabulary registry',
-    #     default=u'',
-    #     vocabulary='castle.cms.vocabularies.MimeTypes'
-    # )
+    @invariant
+    def validate(data):
+        if data.possible_values and data.vocabulary_name:
+            msg = 'You can not set a vocabulary name AND vocabulary values. Please clear values field or set "No value" for vocabulary name.'
+            raise Invalid(_(msg))
 
 
 @implementer(ICastleChoice)
 class CastleChoice(schema.Choice):
 
-    def __init__(self, possible_values=[], **kw):
+    def __init__(self, possible_values=[], vocabulary_name=None, **kw):
         self.possible_values = possible_values
-        # self.vocabulary_name = vocabulary_name
+        self.vocabulary_name = vocabulary_name
         kw['source'] = CastleChoiceSource(self)  # bind to field
         super(CastleChoice, self).__init__(**kw)
 
@@ -229,15 +245,23 @@ class ICastleChoiceFieldSchema(IField):
     possible_values = schema.List(
         title=u'Possible values',
         description=u'Enter allowed choices one per line.',
-        value_type=schema.TextLine()
+        value_type=schema.TextLine(),
+        required=False
+    )
+
+    vocabulary_name = schema.Choice(
+        title=u'Vocabulary name',
+        description=u'Vocabulary name to lookup in the vocabulary registry',
+        default=u'',
+        vocabulary='plone.app.vocabularies.Groups',
+        required=False
     )
 
-    # vocabulary_name = schema.Choice(
-    #     title=u'Vocabulary name',
-    #     description=u'Vocabulary name to lookup in the vocabulary registry',
-    #     default=u'',
-    #     vocabulary='castle.cms.vocabularies.MimeTypes'
-    # )
+    @invariant
+    def validate(data):
+        if data.possible_values and data.vocabulary_name:
+            msg = 'You can not set a vocabulary name AND vocabulary values. Please clear values field or set "No value" for vocabulary name.'
+            raise Invalid(_(msg))
 
 
 @implementer(IFieldEditFormSchema)
diff --git a/castle/cms/widgets.py b/castle/cms/widgets.py
index fcb309454..deede71c1 100644
--- a/castle/cms/widgets.py
+++ b/castle/cms/widgets.py
@@ -197,13 +197,6 @@ def QueryFieldWidget(field, request):
     return z3c.form.widget.FieldWidget(field, QueryStringWidget(request))
 
 
-# TODO: widget definition
-@adapter(IField, ICastleLayer)
-@implementer(IFieldWidget)
-def CastleFieldWidget(field, request):
-    return z3c.form.widget.FieldWidget(field, QueryStringWidget(request))
-
-
 @adapter(IField, ICastleLayer)
 @implementer(IFieldWidget)
 def RelatedItemsFieldWidget(field, request):

From 1f02accac766d40cb3a9d49d50f2c1d2bc63cc15 Mon Sep 17 00:00:00 2001
From: "david.henne" <david.henne@wildcardcorp.com>
Date: Wed, 29 Mar 2023 15:11:03 -0500
Subject: [PATCH 4/6] use strictly Castle defined vocabularies for easyform
 choice field.

---
 castle/cms/easyform/field.py | 25 ++++++++++++-------------
 castle/cms/vocabularies.py   | 11 +++++++++++
 2 files changed, 23 insertions(+), 13 deletions(-)

diff --git a/castle/cms/easyform/field.py b/castle/cms/easyform/field.py
index 42ef8df7f..f4bef2168 100644
--- a/castle/cms/easyform/field.py
+++ b/castle/cms/easyform/field.py
@@ -2,6 +2,7 @@
 from plone.uuid.interfaces import IUUID
 
 from castle.cms.utils import parse_query_from_data
+from castle.cms.vocabularies import castle_vocabularies
 from castle.cms.widgets import QueryFieldWidget
 from plone.autoform import directives as form
 from plone.schemaeditor.fields import FieldFactory
@@ -167,8 +168,6 @@ class TextLineQueryChoiceField(TextLineChoiceField):
     pass
 
 
-# TODO:
-#! --------------- CASTLE CHOICE SCHEMA ---------------
 @implementer(IContextSourceBinder)
 class CastleChoiceSource(object):
     __name__ = 'CastleChoiceSource'
@@ -181,20 +180,22 @@ def get_cache_key(self, context):
             IUUID(context, 'default'), self.field.__name__)
 
     def __call__(self, context):
+        default_none_val = SimpleVocabulary.createTerm(None, None, None)
         if self.field.possible_values == []:
             if self.field.vocabulary_name == None:
                 return SimpleVocabulary([])
             else:
-                # TODO: use vocab selection if there are no fields input.
-                # get name of vocabulary from vocabulary_name value and lookup all vocab terms associated with it
-                thing = 'vocabulary: %s' % self.field.vocabulary_name
-                return SimpleVocabulary([SimpleVocabulary.createTerm(thing, thing, thing)])
+                try:
+                    vocab = castle_vocabularies[self.field.vocabulary_name](context)
+                except TypeError:
+                    vocab = castle_vocabularies[self.field.vocabulary_name]
+                vocab._terms.insert(0, default_none_val)
+                return vocab
         else:
-            default_none_val = SimpleVocabulary.createTerm(None, None, None)
             terms = [default_none_val]
-            for item in self.field.possible_values:
+            for term in self.field.possible_values:
                 terms.append(
-                    SimpleVocabulary.createTerm(item, item, item))
+                    SimpleVocabulary.createTerm(term, term, term))
 
             return SimpleVocabulary(terms)
 
@@ -214,8 +215,7 @@ class ICastleChoice(IChoice):
     vocabulary_name = schema.Choice(
         title=u'Vocabulary name',
         description=u'Vocabulary name to lookup in the vocabulary registry',
-        default=u'',
-        vocabulary='plone.app.vocabularies.Groups',
+        values=castle_vocabularies.keys(),
         required=False
     )
 
@@ -252,8 +252,7 @@ class ICastleChoiceFieldSchema(IField):
     vocabulary_name = schema.Choice(
         title=u'Vocabulary name',
         description=u'Vocabulary name to lookup in the vocabulary registry',
-        default=u'',
-        vocabulary='plone.app.vocabularies.Groups',
+        values=castle_vocabularies.keys(),
         required=False
     )
 
diff --git a/castle/cms/vocabularies.py b/castle/cms/vocabularies.py
index 480d7ed55..05adb89bd 100644
--- a/castle/cms/vocabularies.py
+++ b/castle/cms/vocabularies.py
@@ -380,3 +380,14 @@ def make_terms(brains1, brains2):
             included_brains.append(brain['UID'])
 
     return [SimpleTerm(value=result[0], token=result[0], title=result[1]) for result in results]
+
+
+castle_vocabularies = {
+    'Countries': CountriesVocabularyFactory,
+    'Friendly Types': ReallyUserFriendlyTypesVocabularyFactory,
+    'Business Types': BusinessTypesVocabulary,
+    'Survey': SurveyVocabulary,
+    'Email Category': EmailCategoryVocabulary,
+    'Mime Types': MimeTypeVocabulary,
+    'Locations': LocationsVocabulary
+}

From 5679e7809449b9924b2f321d502bd5aabf2c08e2 Mon Sep 17 00:00:00 2001
From: "david.henne" <david.henne@wildcardcorp.com>
Date: Thu, 30 Mar 2023 12:48:55 -0500
Subject: [PATCH 5/6] rename choice field

---
 castle/cms/easyform/field.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/castle/cms/easyform/field.py b/castle/cms/easyform/field.py
index f4bef2168..23aea05b7 100644
--- a/castle/cms/easyform/field.py
+++ b/castle/cms/easyform/field.py
@@ -237,7 +237,7 @@ def __init__(self, possible_values=[], vocabulary_name=None, **kw):
 
 
 CastleChoiceFactory = FieldFactory(
-    CastleChoice, _(u'label_castle_choice_field', default=u'Castle Choice'),
+    CastleChoice, _(u'label_castle_choice_field', default=u'Choice (no default value)'),
     source=CastleChoiceSource)
 
 

From f76b4025b315244f2cd319c6c0a0d9b25c01e851 Mon Sep 17 00:00:00 2001
From: "david.henne" <david.henne@wildcardcorp.com>
Date: Thu, 30 Mar 2023 12:52:56 -0500
Subject: [PATCH 6/6] remove 'todo:'

---
 castle/cms/easyform/supermodel.py | 1 -
 1 file changed, 1 deletion(-)

diff --git a/castle/cms/easyform/supermodel.py b/castle/cms/easyform/supermodel.py
index 3cd31d4d1..32295207e 100644
--- a/castle/cms/easyform/supermodel.py
+++ b/castle/cms/easyform/supermodel.py
@@ -65,7 +65,6 @@ def write(self, field, name, type, elementName='field'):
 QueryChoiceImportExportHandler = QueryChoiceHandler(QueryChoice)
 
 
-# TODO:
 class CastleChoiceHandler(plone.supermodel.exportimport.ChoiceHandler):
     """
     Extend/override ChoiceHandler to work for CastleChoice field