Merge pull request #48 from input-output-hk/nc/optics

Add optics for modifying name and comment

Author: nc6

cuddle.cabal

@@ -51,6 +51,7 @@ library
     Codec.CBOR.Cuddle.CDDL.Resolve
     Codec.CBOR.Cuddle.Huddle
     Codec.CBOR.Cuddle.Huddle.HuddleM
+    Codec.CBOR.Cuddle.Huddle.Optics
     Codec.CBOR.Cuddle.Parser
     Codec.CBOR.Cuddle.Pretty
 

src/Codec/CBOR/Cuddle/Huddle/Optics.hs

@@ -0,0 +1,24 @@
+-- | Optics for mutating Huddle rules
+module Codec.CBOR.Cuddle.Huddle.Optics (commentL, nameL) where
+
+import Codec.CBOR.Cuddle.Huddle
+import Data.Generics.Product (HasField' (field'))
+import Data.Text qualified as T
+import Optics.Core
+
+mcommentL ::
+  (HasField' "description" a (Maybe T.Text)) =>
+  Lens a a (Maybe T.Text) (Maybe T.Text)
+mcommentL = field' @"description"
+
+-- | Traversal to the comment field of a description. Using this we can for
+--   example set the comment with 'a & commentL .~ "This is a comment"' 
+commentL ::
+  (HasField' "description" a (Maybe T.Text)) =>
+  AffineTraversal a a T.Text T.Text
+commentL = mcommentL % _Just
+
+-- | Lens to the name of a rule (or other named entity). Using this we can
+--   for example append to the name with 'a & nameL %~ (<> "_1")'
+nameL :: Lens (Named a) (Named a) T.Text T.Text
+nameL = field' @"name"