cashapp / barber Goto Github PK

Some documents may have an identifier field present on many types of documents that won't must not have a BarberField configuration on them since it is not predictable how it will be resolved in DocumentTemplate.compile()

Similar to https://square.github.io/okhttp/

For example, a DocumentData with a paramter of type Money could include a lambda on how to format that anytime it is rendered removing the need for every DocumentData constructor to format before construction.

data class RecipientReceipt(
  val sender: String,
  @BarberField(fomat = { amount ->
    Money.of(amount).asCasual()
  })
  val amount: Money,
  val cancelUrl: String,
  @BarberField(format = { dateTime -> Instant.of(dateTime).format("YYYY-MM-DD") })
  val deposit_expected_at: Instant
) : DocumentData

Documents can have null fields, DocumentData can have null fields, DocumentTemplates should support null fields as well.

Consider case of a DocumentTemplate that has the entire field as a DocumentData variable and targets Document with nullable fields. Currently I don't think this is possible because the DocumentData variable even if set to null, can't propagate through the DocumentTemplate on render correctly.

https://blog.solidsoft.pl/2020/06/03/simpler-and-safer-artifact-signing-on-ci-server-with-gradle/

Especially once field stemming is supported, we want to explicitly indicate which types are supported and which aren't.

  @Disabled @Test
  fun `Fails on a non supported DocumentData unit`() {
    data class StrangeUnitDocumentData(
      val strange: Unit
    ) : DocumentData

    val strangeUnitEN_US = DocumentTemplate(
      fields = mapOf(
        "sms_body" to "That's {{ strange }}"
      ),
      source = StrangeUnitDocumentData::class,
      targets = setOf(TransactionalSmsDocument::class),
      locale = Locale.EN_US
    )

    val exception = assertFailsWith<BarberException> {
      BarbershopBuilder()
        .installDocument<TransactionalEmailDocument>()
        .installDocument<TransactionalSmsDocument>()
        .installDocumentTemplate<StrangeUnitDocumentData>(strangeUnitEN_US)
        .build()
    }
    assertEquals(
      """
        |Problems
        |1) ...
        |
      """.trimMargin(),
      exception.toString())
  }

like mustache demo:

Template:
{{#items}}
{{#first}}
<li><strong>{{name}}</strong></li>
{{/first}}
{{#link}}
<li><a href="{{url}}">{{name}}</a></li>
{{/link}}
{{/items}}

Input:
{
"items": [
{"name": "red", "first": true, "url": "#Red"},
{"name": "green", "link": true, "url": "#Green"},
{"name": "blue", "link": true, "url": "#Blue"}
]
}

output:
<li><strong>red</strong></li>
<li><a href="#Green">green</a></li>
<li><a href="#Blue">blue</a></li>

I used Set type, but there was a execption, like:
"Failure to generate signature because of [memberProperty=properties] which must be a data class [returnType=kotlin.collections.Set<com.microsoft.thrifty.ogen.IDLModelHeaderProperty>]"

For clients that deal primarily with non-HTML fields, let's make it easy for them to set a default and not have to annotate every Document field

https://cashapp.github.io/barber/0.x/barber/app.cash.barber/index.md shows a 404

Allow for final Document object to not only be a flat object of String fields.

This allows for configuring whether allWarningsAsErrors for stricter validation. Specifically in consideration of #16 (comment)

Hello, I spotted a typo on the main website page:

Could the same unique data blob could be used to support templates in different languages?

I couldn't send a PR because of #94

Have a great day!

Louis CAD

Template strings that have apostrophes are getting HTML escaped which is not desired for non-HTML documents.

Currently getTargetDocuments doesn't take into account template version and returns an aggregate set across all versions. Instead BarberKey should include version, getTargetDocuments should accept an optional version (and otherwise default to the latest version) and only include the target documents from that specific template version.

Hello devs!

We have around 6 Mio Users so we send a lot of emails daily.

We are currently investigating your library for our purposes and since it is relatively new I have some questions on which I yet couldn't find any answers online yet:

• Does your templating engine support partials? It is a quite crutial feature for us. If yes how can I incorporate such a Template into another? A tutorial in the README would be nice.
• Does your templating engine support loading of files instead of making dozens of Kotlin files (also with potentially partials?)
• Your Locale does only support english, spanish and french. Why only these three? Does it make a difference at all when rendering?