All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog
- Changed
- Removed dependency on
nnichols/nnichols
and added an explicit dependency on org.clojure/test.check
- Added
- Development time functionality to export specs as JSON Schema
- Fixed
- Updated the sample data in each spec to render as the correct type
- Fixed
- Eliminated reader macro usage in test files.
- Fixed
- Added the
<orgnization>
tag to the pom.xml file.
- Added
- Documentation generation from specs to markdown.
- Changed
- Specs now carry metadata indicating the BeerXML Types and Units they are associated with.
- Specs may contain metadata to render human friendly names for abbreviated fields.
- List specs are tightened to only allow valid BeerXML units and types.
- Symbols have been added for all legal values for BeerXML List types. For example:
common-beer-format.miscs/boil
.
- Removed
- Data (de)serialization dependencies (
clojure.data.xml
, clojure.data.json
) leftover from clj-xml
's promotion to a standalone library have been removed. - Data generation dependencies (
clojure.test.check
) have been removed.
- Changed
- Bumped
org.clojure/clojure
to 1.11.2
. Note: Addressing CVE-2024-22871
/ GHSA-vr64-r9qj-h27f
requires consumers to upgrade to this version.
- Fixed
- Ensure all yeast flocculation values are valid.
- Added
- Symbols for keywords in the equipment namespace
- Symbols for keywords in the fermentables namespace
- Symbols for keywords in the hops namespace
- Symbols for keywords in the mash namespace
- Symbols for keywords in the miscs namespace
- Symbols for keywords in the recipes namespace
- Symbols for keywords in the styles namespace
- Symbols for keywords in the waters namespace
- Symbols for keywords in the yeasts namespace
- A forwarding function for
get-spec
- Changed
- The symbols not intended for public consumption are no accurately tagged with the
:no-doc
metadata
- Fixed
- Fixed a bug where collection types would generate maps and sets in property tests.
- Added
- Improved data generators for decimal values to restrict
NaN
and Inf
- Added
explain
, explain-data
, spec-description
, valid?
, and invalid?
to prevent consumers from needing to explicitly import transitive libraries
- Removed
- BREAKING: Removed XML parser and migrated functionality into clj-xml.
- BREAKING: Removed static data and migrated functionality into common-beer-data.
- Added
- Data generators for all specifications
coerce
function to perform type casting on ingested data
- Fixed
- Added missing
::common-beer-format.specs.equipment/boil-time
spec - Added missing
::common-beer-format.specs.equipment/age-temp
spec
- Added
conform
function so downstream users aren't required to install spec-tools
- Fixed
- Selection functions for yeasts to include DCL samples
- Added
- Create
/data
subdirectory for sample static data. - Import sample fermentable data
- Import sample hop data
- Import BJCP style guides
- Import sample yeast data
- Added
- Extend all specifications to include optional BeerXML attributes
- Added
- Create base specification for BeerXML equipment records.
- Create base specification for BeerXML fermentable records.
- Create base specification for BeerXML hop records.
- Create base specification for BeerXML mash records.
- Create base specification for BeerXML misc records.
- Create base specification for BeerXML recipe records.
- Create base specification for BeerXML style records.
- Create base specification for BeerXML water records.
- Create base specification for BeerXML yeast records.
This changelog was generated by sealog.
Please do not edit it directly. Instead, edit the source data files and regenerate this file.