Add REST API functionality for generating menus#302

Open

ababic wants to merge 153 commits intojazzband:masterfrom ababic:menus_api

+2,743-94

Commits on Sep 6, 2020

Add API functionality that can be used to generate JSON representations of the primary menu types

Andy Babic
authored and
ababic
committed
Tweak validation errors

Andy Babic
authored and
ababic
committed
Add a make_dummy_request() method to help with derive pages from 'current_url'

Andy Babic
authored and
ababic
committed
Add 'djangorestframework-recursive' dependency to setup.py

Andy Babic
authored and
ababic
committed
Add a 'base' urls file that will be update to include new versions as required

Andy Babic
authored and
ababic
committed
Add menu_api urls to test.urls

Andy Babic
authored and
ababic
committed
Rewording of help text for 'current_url'

Andy Babic
authored and
ababic
committed
Add a custom field for 'handle' in FlatMenuGeneratorArgumentForm that uses a select widget if the FLAT_MENUS_HANDLE_CHOICES setting is being used.

Andy Babic
authored and
ababic
committed
Use get_initial_for_field() here so that initial values in field definintions will also be picked up

Andy Babic
authored and
ababic
committed
Multilingual support: Add 'language' field to form, and activate the selected language before rendering the menu

Andy Babic
authored and
ababic
committed
Only supplement values from initial data if the field is not required, and accept 'falsey' values as initial values - just not None

Andy Babic
authored and
ababic
committed
Minor docstring tweaks

Andy Babic
authored and
ababic
committed
Add namespacing for URLs

Andy Babic
authored and
ababic
committed
Move missing data supplementation logic out to a separate method to make things easier to test

Andy Babic
authored and
ababic
committed
Simplify BaseAPIViewArgumentForm.to_html() - Can't see a good reason to supply the 'view' argument currently

Andy Babic
authored and
ababic
committed
Update conditional logic for BaseAPIViewArgumentForm.helper() to make it easier to test

Andy Babic
authored and
ababic
committed
Rename template() to template_name()

Andy Babic
authored and
ababic
committed
Start adding tests (focusing on forms first)

Andy Babic
authored and
ababic
committed
Update ArgumentFormTestMixin.make_request() to be a bit more flexible

Andy Babic
authored and
ababic
committed
- Rename get_dummy_request() to make_dummy_request(), and update it to accept the url to make a request from

Andy Babic
authored and
ababic
committed
Fix typo on field name

Andy Babic
authored and
ababic
committed
Rename guess_page_from_url() to get_page_for_url()

Andy Babic
authored and
ababic
committed
Don't ever add an error because of failure to derive a page. If it causes other pages to be underivable, then the error should be raised for those fields, not 'current_page'

Andy Babic
authored and
ababic
committed
Rename 'test_forms' module to 'test_base_forms' and add bunch of tests base form methods

Andy Babic
authored and
ababic
committed
Remove setting of attribute that is no longer used

Andy Babic
authored and
ababic
committed
Use a better pattern for overriding derive_current_page() - the current design felt a bit too convoluted

Andy Babic
authored and
ababic
committed
Remove TestBaseMenuGeneratorArgumentFormCommonMethods from here - running the common tests for all specific form types will be enough :)

Andy Babic
authored and
ababic
committed
Use JSONRenderer by default (format=api must be added to the URL to access the Browsable API version)

Andy Babic
authored and
ababic
committed
Minor comment additions

Andy Babic
authored and
ababic
committed
Update ArgumentFormTestMixin.get_form() to support a 'set_errors' argument and added a better docstring

Andy Babic
authored and
ababic
committed
Minor formatting amend

Andy Babic
authored and
ababic
committed
Add tests for ChildrenMenuGeneratorArgumentForm.derive_parent_page() and SectionMenuGeneratorArgumentForm.derive_section_root_page()

Andy Babic
authored and
ababic
committed
Be consistent in using assertNumQueries() to help show how the method is behaving

Andy Babic
authored and
ababic
committed
Import wagtailmenus core settings as wagtailmenus_settings for clarity

Andy Babic
authored and
ababic
committed
Serializer/setting revision

Andy Babic
authored and
ababic
committed
View updates

Andy Babic
authored and
ababic
committed
Fix a couple of method name errors in MenuGeneratorView.get_serializer()

Andy Babic
authored and
ababic
committed
Make site not required, and if not supplied, attempt to derive the value from the request object provided at initialisation

Andy Babic
authored and
ababic
committed
The find_for_request() method is on the Site model, not the manager

Andy Babic
authored and
ababic
committed
Factor out site identification from derive_site() to a new get_site_for_request() method

Andy Babic
authored and
ababic
committed
Add tests for derive_site()

Andy Babic
authored and
ababic
committed
Add tests for get_site_for_request()

Andy Babic
authored and
ababic
committed
Reorder BaseMenuGeneratorArgumentForm methods and update get_page_for_url() to not attempt matching if url is blank or None

Andy Babic
authored and
ababic
committed
Add tests for get_page_for_url

Andy Babic
authored and
ababic
committed
Add basic tests to show views are not 500ing

Andy Babic
authored and
ababic
committed
Move site and page fetching logic to utils.misc and update tests accordingly

Andy Babic
authored and
ababic
committed
Update context processor to use updated functions from utils.misc

Andy Babic
authored and
ababic
committed
Fix eronous patch on test

Andy Babic
authored and
ababic
committed
Add a test for MenuGeneratorIndexView too

Andy Babic
authored and
ababic
committed
Shorten NotImplementedError messages

Andy Babic
authored and
ababic
committed
Remove the now redundant get_page_for_url() method from BaseMenuGeneratorArgumentForm

Andy Babic
authored and
ababic
committed
Move make_dummy_request() to bottom of BaseMenuGeneratorArgumentForm definition

Andy Babic
authored and
ababic
committed
Move language activation logic to MenuGeneratorView.get(), and also add restore the original language at the last minute, so that the language used when rendering the Browsable API response is not …

Andy Babic
authored and
ababic
committed
Don't add full stops to error messages

Andy Babic
authored and
ababic
committed
Update make_dummy_request() in-line with wagtail change in wagtail/wagtail@5f7b723

Andy Babic
authored and
ababic
committed
Add full stops to ALL validation error messages, so it is at least consistent

Andy Babic
authored and
ababic
committed
Reorder methods on MenuGeneratorView

Andy Babic
authored and
ababic
committed
Add a few more view tests

Andy Babic
authored and
ababic
committed
Update Menu._create_contextualvals_obj_from_context() to respect 'current_site' if it's present in the context data

Andy Babic
authored and
ababic
committed
Values in error messages seem not to be getting substituted, so keep things simple

Andy Babic
authored and
ababic
committed
Tweak error text again

Andy Babic
authored and
ababic
committed
Split view tests into two separate modules and add tests for 'get_serializer_class' to test_base_views.py

Andy Babic
authored and
ababic
committed
Add .coveragerc to help make coverage reports more useful

Andy Babic
authored and
ababic
committed
Add test to show handling of Site.DoesNotExist in get_site_from_request()

Andy Babic
authored and
ababic
committed
Added test that uses format=api to activate the custom renderer, which renders the argument form to a template

Andy Babic
authored and
ababic
committed
Tweak source value in .coveragerc

Andy Babic
authored and
ababic
committed
Remove pointless query here (we're mocking the method)

Andy Babic
authored and
ababic
committed
Shorten api setting names by removing 'DEFAULT_'

Andy Babic
authored and
ababic
committed
Remove unnecessary try/except from _clean_triggers_call_to_method()

Andy Babic
authored and
ababic
committed
Replace InstanceSpecificFieldsMixin with ContextSpecificFieldsMixin make_instance_specific_field_changes() has been replaced with update_fields(), which receives the current fields dict, and contex…

Andy Babic
authored and
ababic
committed
Add 'api_fields' and 'api_page_fields' attributes to AbstractMenuItem to allow easier customisation of API representation

Andy Babic
authored and
ababic
committed
Add 'api_fields' attributes to AbstractMainMenu and AbstractFlatMenu to allow easier customisation of API representation

Andy Babic
authored and
ababic
committed
Rename api field attribute names on AbstractMenuItem and add attributes to allow overriding of child item fields also

Andy Babic
authored and
ababic
committed
Remove child_api_fields and and child_api_page fields from AbstractMenuItem

Andy Babic
authored and
ababic
committed
Add field lists to ChildrenMenu and SectionMenu too, to allow custom class representation to be changed more easily

Andy Babic
authored and
ababic
committed
Move the api settings module into the v1 sub app. this way, new versions can have different settings

Andy Babic
authored and
ababic
committed
Update renderer classes for MenuGeneratorIndexView to render to JSON by default

Andy Babic
authored and
ababic
committed
Use 'serializer' instead of 'field' in method names where the functionality is obviously specific to serializers

Andy Babic
authored and
ababic
committed
Add settings to allow menu item serializer fields to be overridden for children and section menus

Andy Babic
authored and
ababic
committed
Split serializers module into it's own sub-app and update menu serializers to take into account setting values and menu/menuitem class attribute values when determining the fields to use for menu i…

Andy Babic
authored and
ababic
committed
Add methods to ChildrenMenuSerializer and SectionMenuSerializer for getting a field list to use when serializing parent and section root pages

Andy Babic
authored and
ababic
committed
Add some settings to allow page representation to controlled for each type of menu

Andy Babic
authored and
ababic
committed
Update menu classes with a get_item_page_serializer_fields() method that is used to set an additional 'page_fields' value on the Meta class for the item serializer for each menu type

Andy Babic
authored and
ababic
committed
Update MenuItemSerializerMixin.get_page_serializer_class() to use the new meta class attribute to determine fields used for page serialisation

Andy Babic
authored and
ababic
committed
Use two base classes to create DefaultSectionRootSerializer, so that it knows how to render 'type' field as well as the common menu item fields

Andy Babic
authored and
ababic
committed
Use None values for settings so that values are picked up from menu/menuitem classes by default

Andy Babic
authored and
ababic
committed
Add a few more tests for menu specific views

Andy Babic
authored and
ababic
committed
Use non-plurals in new module names

Andy Babic
authored and
ababic
committed
Drop the 'Default' from the beginning of dynamically generated class names

Andy Babic
authored and
ababic
committed
Simplify views by removing the 'default_serializer_class' attribute and adding serializer class paths as default setting values

Andy Babic
authored and
ababic
committed
Shorten field setting names

Andy Babic
authored and
ababic
committed
Use the translation.override context manager to temporarily activate the selected language
ababic
committed
View class simplification
ababic
committed
Simplify serializers and settings
ababic
committed
backtrack on classmethod use for forms
ababic
committed
Fix ArgumentFormTestMixin.get_form()
ababic
committed
Remove request argument from get_form_initial()
ababic
committed
Fix get_form_init_kwargs()
ababic
committed
Fix base class reference
ababic
committed
More fixes
ababic
committed
Simplify serializers by utilising SerializerMethodField
ababic
committed
Remove ContextSpecificFieldsMixin and fix a lot of breakages
ababic
committed
Make serializer class fetching from settings lazy
ababic
committed
Attempt to fix failing tests
ababic
committed
Use appropriate values for AbstractMenuItem.sub_item_page_api_fields
ababic
committed
Serializer improvements
ababic
committed
Use PageSerializer to render page details for menu items by default
ababic
committed
Use a CharField for current_url to allow relative urls to be supplied
ababic
committed
Remove redundant RecursiveField import
ababic
committed
Further refactoring
ababic
committed
Minor formatting/docstring amends for menu serializers
ababic
committed
Fix some errors in forms
ababic
committed
Move derivation logic to views
ababic
committed
Always attempt to derive the current site, and fix attribute name issue
ababic
committed
Update form field help text
ababic
committed
- Rename get_augmented_form_data() to process_form_data()
ababic
committed
Remove unnecessary __init__ override from BaseAPIViewArgumentForm
ababic
committed
Override label_from_instance for PageChoiceField
ababic
committed
derive_page function replaces get_page_from_request
ababic
committed
No need to specify use_specific any longer
ababic
committed
Remove / amend failing/irrelevant form tests
ababic
committed
Remove old tests for get_page_from_request()
ababic
committed
make_dummy_request() has moved to wagtailmenus.api.utils
ababic
committed
Move 'ancestor derivation' to it's own util function
ababic
committed
Form updates:
ababic
committed
View logic tweaks
ababic
committed
- Move value derivation logic back to forms and tidy cross-field validation
ababic
committed
Add make_serializer_class() function to aid in dynamic creation of serlializer classes
ababic
committed
Adopt wagtail.api.APIField as a means of allowing serializer customisation (for menus, menu items and menu item page data)
ababic
committed
Get current tests passing
ababic
committed
Use 'ancestor_page_ids' to set the relevant value in dummy_context
ababic
committed
Rename use_relative_page_urls to relative_page_urls
ababic
committed
Update tests to account for field name change
ababic
committed
Use field names as labels
ababic
committed
Finish up form field renaming
ababic
committed
Shuffle serializer field order
ababic
committed
Update choice labels for JavascriptStyleBooleanSelect
ababic
committed
Rename MenuBasedMenuGeneratorView to BaseModelMenuGeneratorView
ababic
committed
Remove unused global from views
ababic
committed
Base view tests
ababic
committed
Remove BASE_MAIN_MENU_SERIALIZER and BASE_FLAT_MENU_SERIALIZER in favour of specifying directly on the class
ababic
committed
Update tests
ababic
committed
Rename x_serializer_init_kwargs() methods to x_serializer_create_kwargs() and remove 'base_class' as the first parameter
ababic
committed
Remove some unnecessary lines/variabalisation from _prime_menu_item()
ababic
committed
Provide request with calleing relative_url() for root_page
ababic
committed
Improve override instructions for 'api_fields' attributes on menu and menu item classes
ababic
committed
Optimise PageChoiceField
ababic
committed
Allow current_site_id to be provided (if available), and add SINGLE_SITE_MODE to simplify things for single-site projects
ababic
committed
Utilise the new request_forms block to output custom argument form
ababic
committed
- Refer to the argument form as 'argument_form' in view classes / attribute names
ababic
committed
Utilise settings to allow control over authentication_classes, permission_classes and renderer_classes for menu generator views
ababic
committed
Begin refactoring argument forms as serializers. TODO:
ababic
committed

Commits on Dec 28, 2020

Rename get_menu_instance -> get_object
ababic
committed