equipment.cljc

(ns common-beer-format.equipment
  "The definition of an equipment record used in BeerXML."
  {:added "2.0"}
  (:require [clojure.spec.alpha :as spec]
            [common-beer-format.impl :as impl]
            [common-beer-format.primitives :as prim]
            [spec-tools.core :as st])
  (:refer-clojure :exclude [name]))


(def equipment
  "A map representing the brewing equipment used during the mash."
  :equipment)


(def equipments
  "A vector of equipment records."
  :equipments)


(def name
  "The name of the equipment record."
  :name)


(def version
  "The version of the BeerXML specification used to create the equipment record."
  :version)


(def boil-size
  "The pre-boil volume for the equipment setup."
  :boil-size)


(def batch-size
  "The target volume of the batch at the start of fermentation."
  :batch-size)


(def tun-volume
  "The volume of the of the mash tun in liters."
  :tun-volume)


(def tun-weight
  "The weight of the of the mash tun in kilograms."
  :tun-weight)


(def tun-specific-heat
  "The specific heat of the mash tun in Calories per gram-degree Celsius."
  :tun-specific-heat)


(def top-up-water
  "The volume of top-up water added before fermentation in liters."
  :top-up-water)


(def trub-chiller-loss
  "The volume of wort lost during transition from the boiler to primary fermentation vessel."
  :trub-chiller-loss)


(def evap-rate
  "The percentage of wort lost to evaporation per hour of the boil."
  :evap-rate)


(def boil-time
  "The normal amount of time one boils for this equipment setup. This can be used with the evaporation rate to calculate the evaporation loss."
  :boil-time)


(def calc-boil-volume
  "A boolean denoting whether or not programs reading this equipment record should calculate the boil size."
  :calc-boil-volume)


(def lauter-deadspace
  "The volume of wort lost to deadspace in the mash tun."
  :lauter-deadspace)


(def top-up-kettle
  "The volume of wort lost to deadspace in the kettle."
  :top-up-kettle)


(def hop-utilization
  "The percentage of hops that are utilized in the boil."
  :hop-utilization)


(def notes
  "A string containing notes about the equipment setup."
  :notes)


(def display-boil-size
  "The pre-boil volume for the equipment setup in a human-readable format."
  :display-boil-size)


(def display-batch-size
  "The target volume of the batch at the start of fermentation in a human-readable format."
  :display-batch-size)


(def display-tun-volume
  "The volume of the of the mash tun in liters in a human-readable format."
  :display-tun-volume)


(def display-tun-weight
  "The weight of the of the mash tun in kilograms in a human-readable format."
  :display-tun-weight)


(def display-top-up-water
  "The volume of top-up water added before fermentation in liters in a human-readable format."
  :display-top-up-water)


(def display-trub-chiller-loss
  "The volume of wort lost during transition from the boiler to primary fermentation vessel in a human-readable format."
  :display-trub-chiller-loss)


(def display-lauter-deadspace
  "The volume of wort lost to deadspace in the mash tun in a human-readable format."
  :display-lauter-deadspace)


(def display-top-up-kettle
  "The volume of wort lost to deadspace in the kettle in a human-readable format."
  :display-top-up-kettle)


(spec/def ::boil-size
  (st/spec
    {:type                   :double
     :spec                   ::prim/liter
     impl/beer-xml-type-key  impl/beer-xml-floating-point
     impl/beer-xml-units-key impl/beer-xml-liter
     :description            "A non-negative IEEE-754 floating point number representing the pre-boil volume for the equipment setup."
     :json-schema/example    "10.8"}))


(spec/def ::batch-size
  (st/spec
    {:type                   :double
     :spec                   ::prim/liter
     impl/beer-xml-type-key  impl/beer-xml-floating-point
     impl/beer-xml-units-key impl/beer-xml-liter
     :description            "A non-negative IEEE-754 floating point number representing the target volume of the batch at the start of fermentation."
     :json-schema/example    "5.8"}))


(spec/def ::tun-volume
  (st/spec
    {:type                   :double
     :spec                   ::prim/liter
     impl/beer-xml-type-key  impl/beer-xml-floating-point
     impl/beer-xml-units-key impl/beer-xml-liter
     :description            "A non-negative IEEE-754 floating point number representing the volume of the of the mash tun in liters."
     :json-schema/example    "15.0"}))


(spec/def ::tun-weight
  (st/spec
    {:type                   :double
     :spec                   ::prim/kilogram
     impl/beer-xml-type-key  impl/beer-xml-floating-point
     impl/beer-xml-units-key impl/beer-xml-kilogram
     :description            "A non-negative IEEE-754 floating point number representing the weight of the of the mash tun in kilograms."
     :json-schema/example    "15.0"}))


(spec/def ::tun-specific-heat
  (st/spec
    {:type                   :double
     :spec                   ::prim/non-negative-number
     :gen                    impl/real-positive-double-generator
     impl/beer-xml-type-key  impl/beer-xml-floating-point
     impl/beer-xml-units-key impl/beer-xml-calories-per-gram-degree-celsius
     :description            "A non-negative IEEE-754 floating point number representing the specific heat of the mash tun in Calories per gram-degree Celsius."
     :json-schema/example    "0.2"}))


(spec/def ::top-up-water
  (st/spec
    {:type                   :double
     :spec                   ::prim/liter
     impl/beer-xml-type-key  impl/beer-xml-floating-point
     impl/beer-xml-units-key impl/beer-xml-liter
     :description            "A non-negative IEEE-754 floating point number representing the volume of top-up water added before fermentation in liters."
     :json-schema/example    "2.1"}))


(spec/def ::trub-chiller-loss
  (st/spec
    {:type                   :double
     :spec                   ::prim/liter
     impl/beer-xml-type-key  impl/beer-xml-floating-point
     impl/beer-xml-units-key impl/beer-xml-liter
     :description            "A non-negative IEEE-754 floating point number representing the volume of wort lost during transition from the boiler to primary fermentation vessel."
     :json-schema/example    "0.1"}))


(spec/def ::evap-rate
  (st/spec
    {:type                   :double
     :spec                   ::prim/percent
     impl/display-name-key   "Evaporation Rate"
     impl/beer-xml-type-key  impl/beer-xml-percentage
     impl/beer-xml-units-key impl/beer-xml-percent-per-hour
     :description            "A non-negative IEEE-754 floating point number representing the percentage of wort lost to evaporation per hour of the boil."
     :json-schema/example    "1.2"}))


(spec/def ::boil-time
  (st/spec
    {:type                   :double
     :spec                   ::prim/minute
     impl/beer-xml-type-key  impl/beer-xml-floating-point
     impl/beer-xml-units-key impl/beer-xml-minute
     :description            "A non-negative IEEE-754 floating point number representing the normal amount of time one boils for this equipment setup. This can be used with the evaporation rate to calculate the evaporation loss."
     :json-schema/example    "15"}))


(spec/def ::calc-boil-volume
  (st/spec
    {:spec                  ::prim/boolean
     impl/display-name-key  "Calculate Boil Volume"
     impl/beer-xml-type-key impl/beer-xml-boolean
     :description           (impl/multiline "A boolean denoting whether or not programs reading this equipment record should calculate the boil size."
                                            "When absent, assume false."
                                            "When true, then boil-size = `(batch-size - top-up-water - trub-chiller-loss) * (1 + boil-time * evap-rate)`")
     :json-schema/example   "TRUE"
     :decode/string         impl/decode-boolean
     :encode/string         impl/encode-boolean}))


(spec/def ::lauter-deadspace
  (st/spec
    {:type                   :double
     :spec                   ::prim/liter
     impl/beer-xml-type-key  impl/beer-xml-floating-point
     impl/beer-xml-units-key impl/beer-xml-liter
     :description            "A non-negative IEEE-754 floating point number representing the volume of wort lost to the lauter tun."
     :json-schema/example    "0.1"}))


(spec/def ::top-up-kettle
  (st/spec
    {:type                   :double
     :spec                   ::prim/liter
     impl/beer-xml-type-key  impl/beer-xml-floating-point
     impl/beer-xml-units-key impl/beer-xml-liter
     :description            "A non-negative IEEE-754 floating point number representing the volume of top-up water added to the boil kettle before the boil begins."
     :json-schema/example    "2.1"}))


(spec/def ::hop-utilization
  (st/spec
    {:type                  :double
     :spec                  ::prim/percent
     impl/beer-xml-type-key impl/beer-xml-percentage
     :description           "A non-negative IEEE-754 floating point number representing the percentage of large batch hop utilization."
     :json-schema/example   "1.2"}))


(spec/def ::display-boil-size
  (st/spec
    {:type                  :string
     :spec                  ::prim/text
     impl/beer-xml-type-key impl/beer-xml-text
     :description           "A non-empty string denoting a display value for the pre-boil volume formatted for display in arbitrary units."
     :json-schema/example   "5.0 gallons"}))


(spec/def ::display-batch-size
  (st/spec
    {:type                  :string
     :spec                  ::prim/text
     impl/beer-xml-type-key impl/beer-xml-text
     :description           "A non-empty string denoting a display value for the pre-fermentation volume formatted for display in arbitrary units."
     :json-schema/example   "4.5 gallons"}))


(spec/def ::display-tun-volume
  (st/spec
    {:type                  :string
     :spec                  ::prim/text
     impl/beer-xml-type-key impl/beer-xml-text
     :description           "A non-empty string denoting a display value for the volume capacity of the mash tun formatted for display in arbitrary units."
     :json-schema/example   "20 liters"}))


(spec/def ::display-tun-weight
  (st/spec
    {:type                  :string
     :spec                  ::prim/text
     impl/beer-xml-type-key impl/beer-xml-text
     :description           "A non-empty string denoting a display value for the empty weight of the mash tun formatted for display in arbitrary units."
     :json-schema/example   "5.5 pounds"}))


(spec/def ::display-top-up-water
  (st/spec
    {:type                  :string
     :spec                  ::prim/text
     impl/beer-xml-type-key impl/beer-xml-text
     :description           "A non-empty string denoting a display value for the volume of top-up water added before fermentation formatted for display in arbitrary units."
     :json-schema/example   "2.2 liters"}))


(spec/def ::display-trub-chiller-loss
  (st/spec
    {:type                  :string
     :spec                  ::prim/text
     impl/beer-xml-type-key impl/beer-xml-text
     :description           "A non-empty string denoting a display value for the volume of wort lost in transition between boiler and fermentation vessel formatted for display in arbitrary units."
     :json-schema/example   "2.2 liters"}))


(spec/def ::display-lauter-deadspace
  (st/spec
    {:type                  :string
     :spec                  ::prim/text
     impl/beer-xml-type-key impl/beer-xml-text
     :description           "A non-empty string denoting a display value for the volume of wort lost in the lauter vessel formatted for display in arbitrary units."
     :json-schema/example   "2.2 liters"}))


(spec/def ::display-top-up-kettle
  (st/spec
    {:type                  :string
     :spec                  ::prim/text
     impl/beer-xml-type-key impl/beer-xml-text
     :description           "A non-empty string denoting a display value for the top-up water added to the pre-boil stage of the kettle formatted for display in arbitrary units."
     :json-schema/example   "2.2 liters"}))


(spec/def ::equipment
  (st/spec
    {:type        :map
     :description "A record representing the brewing equipment used in brewing."
     :spec        (spec/keys :req-un [::prim/name
                                      ::prim/version
                                      ::boil-size
                                      ::batch-size]
                             :opt-un [::tun-volume
                                      ::tun-weight
                                      ::tun-specific-heat
                                      ::top-up-water
                                      ::trub-chiller-loss
                                      ::evap-rate
                                      ::boil-time
                                      ::calc-boil-volume
                                      ::lauter-deadspace
                                      ::top-up-kettle
                                      ::hop-utilization
                                      ::prim/notes
                                      ::display-boil-size
                                      ::display-batch-size
                                      ::display-tun-volume
                                      ::display-tun-weight
                                      ::display-top-up-water
                                      ::display-trub-chiller-loss
                                      ::display-lauter-deadspace
                                      ::display-top-up-kettle])}))


(spec/def ::equipment-wrapper
  (st/spec
    {:type                 :map
     impl/wrapper-spec-key true
     impl/beer-xml-type-key impl/beer-xml-record
     :description          "An `::equipment` record wrapped in an `:equipment` map."
     :spec                 (spec/keys :req-un [::equipment])
     :decode/string        #(impl/decode-wrapper %1 ::equipment %2)
     :encode/string        #(impl/encode-wrapper %1 ::equipment %2)}))


(spec/def ::equipments
  (st/spec
    {:type          :vector
     :description   "A vector of valid `::equipment-wrapper` records."
     :spec          (spec/coll-of ::equipment-wrapper :into [] :kind vector?)
     :decode/string #(impl/decode-sequence %1 ::equipment-wrapper %2)
     :encode/string #(impl/encode-sequence %1 ::equipment-wrapper %2)}))


(spec/def ::equipments-wrapper
  (st/spec
    {:type                 :map
     impl/wrapper-spec-key true
     impl/beer-xml-type-key impl/beer-xml-record-set
     :description          "An `::equipment-wrapper` record set."
     :spec                 (spec/keys :req-un [::equipments])}))