{"id":38956061,"url":"https://github.com/leanovate/doby","last_synced_at":"2026-01-17T16:16:55.620Z","repository":{"id":17146093,"uuid":"19912737","full_name":"leanovate/doby","owner":"leanovate","description":"TODO with expiring dates","archived":false,"fork":false,"pushed_at":"2014-09-06T19:16:31.000Z","size":380,"stargazers_count":12,"open_issues_count":1,"forks_count":1,"subscribers_count":26,"default_branch":"master","last_synced_at":"2024-03-26T15:05:33.851Z","etag":null,"topics":["expiration","scala","scala-macros"],"latest_commit_sha":null,"homepage":null,"language":"Scala","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/leanovate.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-05-18T14:44:26.000Z","updated_at":"2020-12-09T05:18:57.000Z","dependencies_parsed_at":"2022-09-26T22:01:34.097Z","dependency_job_id":null,"html_url":"https://github.com/leanovate/doby","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/leanovate/doby","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leanovate%2Fdoby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leanovate%2Fdoby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leanovate%2Fdoby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leanovate%2Fdoby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/leanovate","download_url":"https://codeload.github.com/leanovate/doby/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leanovate%2Fdoby/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28511854,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T13:38:16.342Z","status":"ssl_error","status_checked_at":"2026-01-17T13:37:44.060Z","response_time":85,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["expiration","scala","scala-macros"],"created_at":"2026-01-17T16:16:55.024Z","updated_at":"2026-01-17T16:16:55.609Z","avatar_url":"https://github.com/leanovate.png","language":"Scala","funding_links":[],"categories":[],"sub_categories":[],"readme":"DoBy\n====\n\nScala implementation of expiring TODO notes.\n\nOriginal idea from [do_by: Automatically expiring TODO notes in Ruby](https://github.com/andyw8/do_by)\n\n## tl;dr\n\nUse this library if you want to write TODO notes with an expiration date.\n\nAn expired TODO will not compiled anymore.\n\n*Example:*\n\n```scala\nTODO(\"YaSi\", \"do not write any TODO anymore\", \"2011/05/25\")\n```\ndoes not compile.\n\n\n## Description\n\nDevelopers like to write TODOs in the code to describe a possible amelioration:\n\n```scala\n// TODO: check the mime-type\n```\n\nAs the project evolves, the number of TODOs typically grows up and nobody take care of them seriously.\n\nWith DoBy, a TODO must have an expiration date:\n\n- Before this date, the program compiles and runs as usual.\n\n- Three weeks before this date, the compiler will emit a warning about the note.\n\n- After this date, the program does not compile anymore. You **must** do something about this TODO.\n\n\n## Usage\n\n### Add DoBy as dependency\n\nTo use this library, add it as [dependency](http://search.maven.org/#search%7Cga%7C1%7Ca%3A%22doby_2.11%22).\n\n```scala\nlibraryDependencies += \"de.leanovate.doby\" %% \"doby\" % \"0.6\" % \"provided\"\n```\nDoBy is only compatible with Scala 2.11.\n\n### Add an import\n\n```scala\nimport de.leanovate.doby._\n```\n\n### Write your TODO\n\nA TODO note must indicate the author, a description and an expiration date.\n\nThe expiration date can be written like `2011/05/25` or like `2011-05-25`\n\n```scala\nTODO(\"YaSi\", \"do not write any TODO anymore\", \"2011/05/25\")\n```\n\nYou can also use the general expire. For info, see the [example](sample/src/test/scala/de/leanovate/doby/ExpirationApp.scala)\n\n## Changelog\n### version 0.6\n\nChange the default package from `de.leanovate.doby.Expiration._` to `de.leanovate.doby._`\n\n\n## FAQ\n\n### Difference with [do_by in in Ruby](https://github.com/andyw8/do_by)\n \ndo_by (in ruby) throws an exception at runtime when a note is expired.\n\nIt means that an expired note will break a running program.\n\nWith DoBy (in Scala), an expired note does not have any effect on a running program. Instead, at compile time, the compiler will warn or output an error if a note is about to expire or has expired. A TODO note is written by a developer and must be take care by a developer.\n \n\n\n## Developer info\n\nTravis: [![Build Status](https://travis-ci.org/leanovate/doby.png?branch=master)](https://travis-ci.org/leanovate/doby)\n\n\n## Alternatives\n\n- [FIXME](https://github.com/tysonjh/fixme)\n\n\n## Credits\n- [do_by: Automatically expiring TODO notes in Ruby](https://github.com/andyw8/do_by)\n\n- [Idea from @brikis98 to implement expiring TODOs with scala macros](https://twitter.com/brikis98/status/467924891837030400): \"TODO's that throw exceptions when they expire. Neat, but I want compile, not runtime errors. Doable w/ scala macros?\"\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleanovate%2Fdoby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fleanovate%2Fdoby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleanovate%2Fdoby/lists"}