8.7 C
New York
Friday, November 22, 2024

Check Drive HTML Templates


foo

Let’s examine find out how to do it in levels: We begin with the next take a look at that tries to compile the template. In Go we use the usual html/template bundle.

Go

  func Test_wellFormedHtml(t *testing.T) {
    templ := template.Should(template.ParseFiles("index.tmpl"))
    _ = templ
  }

In Java we use moustache
as a result of it is extremely straightforward to make use of; free marker both
Pace are different widespread choices.

Java

  @Check
  void indexIsSoundHtml() {
      var template = Mustache.compiler().compile(
              new InputStreamReader(
                      getClass().getResourceAsStream("/index.tmpl")));
  }

If we run this take a look at, it’ll fail, as a result of the index.tmpl the file doesn’t exist. So we create it, with the damaged HTML above. Now the take a look at ought to go.

Then we create a mannequin for the template to make use of. The app manages a to-do record and we are able to create a minimal mannequin for demonstration functions.

Go

  func Test_wellFormedHtml(t *testing.T) {
    templ := template.Should(template.ParseFiles("index.tmpl"))
    mannequin := todo.NewList()
    _ = templ
    _ = mannequin
  }

Java

  @Check
  void indexIsSoundHtml() {
      var template = Mustache.compiler().compile(
              new InputStreamReader(
                      getClass().getResourceAsStream("/index.tmpl")));
      var mannequin = new TodoList();
  }

Now we render the template, saving the leads to a byte buffer (Go) or as a String (Java).

Go

  func Test_wellFormedHtml(t *testing.T) {
    templ := template.Should(template.ParseFiles("index.tmpl"))
    mannequin := todo.NewList()
    var buf bytes.Buffer
    err := templ.Execute(&buf, mannequin)
    if err != nil {
      panic(err)
    }
  }

Java

  @Check
  void indexIsSoundHtml() {
      var template = Mustache.compiler().compile(
              new InputStreamReader(
                      getClass().getResourceAsStream("/index.tmpl")));
      var mannequin = new TodoList();
  
      var html = template.execute(mannequin);
  }

At this level we wish parse the HTML and we count on to see an error, as a result of in our damaged HTML there’s a div aspect that’s closed by a p aspect. There may be an HTML parser within the Go customary library, but it surely’s too forgiving: if we run it on our damaged HTML, we do not get an error. Thankfully, the Go customary library additionally has an XML parser that may be configured to parse HTML (due to this stack overflow reply)

Go

  func Test_wellFormedHtml(t *testing.T) {
    templ := template.Should(template.ParseFiles("index.tmpl"))
    mannequin := todo.NewList()
    
    // render the template right into a buffer
    var buf bytes.Buffer
    err := templ.Execute(&buf, mannequin)
    if err != nil {
      panic(err)
    }
  
    // verify that the template might be parsed as (lenient) XML
    decoder := xml.NewDecoder(bytes.NewReader(buf.Bytes()))
    decoder.Strict = false
    decoder.AutoClose = xml.HTMLAutoClose
    decoder.Entity = xml.HTMLEntity
    for {
      _, err := decoder.Token()
      change err {
      case io.EOF:
        return // We're executed, it is legitimate!
      case nil:
        // do nothing
      default:
        t.Fatalf("Error parsing html: %s", err)
      }
    }
  }

fountain

This code configures the HTML parser to have the proper degree of leniency for HTML after which parses the HTML token by token. The truth is, we see the error message we wished:

--- FAIL: Test_wellFormedHtml (0.00s)
    index_template_test.go:61: Error parsing html: XML syntax error on line 4: surprising finish aspect 

In Java, a flexible library to make use of is jsoup:

Java

  @Check
  void indexIsSoundHtml() {
      var template = Mustache.compiler().compile(
              new InputStreamReader(
                      getClass().getResourceAsStream("/index.tmpl")));
      var mannequin = new TodoList();
  
      var html = template.execute(mannequin);
  
      var parser = Parser.htmlParser().setTrackErrors(10);
      Jsoup.parse(html, "", parser);
      assertThat(parser.getErrors()).isEmpty();
  }

fountain

And we see it fail:

java.lang.AssertionError: 
Anticipating empty however was:<(<1:13>: Sudden EndTag token () when in state (InBody),

Success! Now if we copy TodoMVC template content material to our index.tmpl file, the take a look at passes.

The proof, nevertheless, is just too detailed: we extract two auxiliary features to make clear the intent of the proof and acquire

Go

  func Test_wellFormedHtml(t *testing.T) {
    mannequin := todo.NewList()
  
    buf := renderTemplate("index.tmpl", mannequin)
  
    assertWellFormedHtml(t, buf)
  }

fountain

Java

  @Check
  void indexIsSoundHtml() {
      var mannequin = new TodoList();
  
      var html = renderTemplate("/index.tmpl", mannequin);
  
      assertSoundHtml(html);
  }

fountain

Stage 2: Check the HTML construction

What else ought to we attempt?

We all know that in the end solely a human can take a look at the look of a web page and see the way it renders in a browser. Nevertheless, there’s usually logic in templates and we wish to have the ability to take a look at that logic.

One may be tempted to attempt rendered HTML with string equality, however this system fails in apply, as a result of templates comprise many particulars that make string equality assertions impractical. The claims grow to be very detailed and when studying them it’s obscure what we are attempting to show.

What we’d like is a way to claim that some components of the rendered HTML correspond to what we count on, since ignore all the main points that do not matter to us. A technique to do that is by working queries with the CSS selector language: is a strong language that permits us to pick out the weather that curiosity us from all the HTML doc. As soon as now we have chosen these parts, we (1) depend that the variety of parts returned is what we count on and (2) that they comprise the textual content or different content material we count on.

The UI we’re imagined to generate seems to be like this:

There are a number of particulars which are rendered dynamically:

  1. The variety of parts and their textual content material change, clearly.
  2. The fashion of the duty merchandise modifications when it’s accomplished (for instance, the second)
  3. The “2 objects left” textual content will change primarily based on the variety of uncompleted objects
  4. One of many three buttons “All”, “Energetic”, “Accomplished” can be highlighted, relying on the present URL; for instance, if we determine that the URL that exhibits solely “lively” objects is /livelythen when the present url is /livelythe “Energetic” button must be surrounded by a skinny pink rectangle
  5. The “Clear Accomplished” button ought to solely be seen if any merchandise is accomplished

Every of those considerations might be examined with the assistance of CSS selectors.

It is a snippet of the TodoMVC template (barely simplified). I have never added the dynamic bits but, so what we see right here is static content material, offered for instance:

index.tmpl

  

fountain

Related Articles

Latest Articles