{"id":15789863,"url":"https://github.com/helpscout/jekyll-joule","last_synced_at":"2025-03-14T13:30:31.830Z","repository":{"id":56878643,"uuid":"93205476","full_name":"helpscout/jekyll-joule","owner":"helpscout","description":"Joule 🔸: A Jekyll library for Unit Testing","archived":false,"fork":false,"pushed_at":"2017-07-20T14:45:20.000Z","size":37,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-12T20:43:05.480Z","etag":null,"topics":["jekyll","open-source","unit-testing"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/helpscout.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-06-02T21:33:59.000Z","updated_at":"2020-02-10T06:22:41.000Z","dependencies_parsed_at":"2022-08-20T11:40:39.578Z","dependency_job_id":null,"html_url":"https://github.com/helpscout/jekyll-joule","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/helpscout%2Fjekyll-joule","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/helpscout%2Fjekyll-joule/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/helpscout%2Fjekyll-joule/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/helpscout%2Fjekyll-joule/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/helpscout","download_url":"https://codeload.github.com/helpscout/jekyll-joule/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243293765,"owners_count":20268139,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["jekyll","open-source","unit-testing"],"created_at":"2024-10-04T22:04:00.089Z","updated_at":"2025-03-14T13:30:31.321Z","avatar_url":"https://github.com/helpscout.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Joule 🔸 [![Build Status](https://travis-ci.org/helpscout/jekyll-joule.svg?branch=master)](https://travis-ci.org/helpscout/jekyll-joule) [![Gem Version](https://badge.fury.io/rb/jekyll-joule.svg)](https://badge.fury.io/rb/jekyll-joule) [![Coverage Status](https://coveralls.io/repos/github/helpscout/jekyll-joule/badge.svg?branch=master)](https://coveralls.io/github/helpscout/jekyll-joule?branch=master)\n\nJoule is a Jekyll utility helper designed to make it (way) easier to write unit tests.\n\nSo far, Joule has only been tested with [minitest](https://github.com/seattlerb/minitest). However, you **should** be able to use it with other testing frameworks.\n\n\n## Install\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'jekyll-joule'\n```\n\nAnd then execute:\n```\nbundle\n```\n\nOr install it yourself as:\n```\ngem install jekyll-joule\n```\n\n\n\n## Basic Usage\n\nBelow is an example of how you can write a test with Joule.\n\n```rb\nclass ExampleTest \u003c JekyllUnitTest\n  should \"render a div containing the Page title\" do\n    @joule.render(%Q[\n      ---\n      title: \"Yiss\"\n      ---\n      \u003cdiv class=\"aww\"\u003e\n        {{ page.title }}\n      \u003c/div\u003e\n    ])\n\n    el = @joule.find(\".aww\")\n\n    assert(el)\n    assert(el.text.include?(\"Yiss\"))\n    assert(el[\"class\"].include?(\"aww\"))\n  end\nend\n```\n\nCheck out the full [rendering API documentation](./docs/rendering.md)\n\n\n\n## Documentation\n\n**[View the docs](https://github.com/helpscout/jekyll-joule/blob/master/docs/introduction.md)** to get started with Joule!\n\n\n\n## Examples\n\n**[View the example](https://github.com/helpscout/jekyll-joule/tree/master/examples)** Jekyll setup + Joule test files.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhelpscout%2Fjekyll-joule","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhelpscout%2Fjekyll-joule","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhelpscout%2Fjekyll-joule/lists"}