xbrlus / xule

An open-source XBRL processor for business rules, rendering and custom data reporting. See https://xbrl.us/xule for documentation and https://xbrl.us/xule-editor for a VS Code syntax highlighter.
Apache License 2.0
24 stars 10 forks source link

Validate report period against month_day so that we do not get a key error in get_dates() #10

Open derekgengenbacher-wf opened 2 years ago

derekgengenbacher-wf commented 2 years ago

Description:

When a value for report_period does not conform to the Q1, Q2, Q3 or Q4, then a key error can be thrown in the return of get_dates(). This PR rearranges report_year and report_period so that report_period can verify that the value is in the above list of values.

Testing:

Create a document that has a report_period set as something random like Quarter 1. Run it against master and notice that you get a key error. Run the same doc against this branch and you will get a nicely formatted FERCRenderException that explains what the actual issue is.

@campbellpryde @davidtauriello