https://github.com/samwho/todo-txt-gem

A RubyGem for parsing todo.txt files.
https://github.com/samwho/todo-txt-gem

Last synced: 12 days ago
JSON representation

A RubyGem for parsing todo.txt files.

• Host: GitHub
• URL: https://github.com/samwho/todo-txt-gem
• Owner: samwho
• License: other
• Created: 2011-08-19T20:38:55.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2017-06-22T16:31:48.000Z (over 7 years ago)
• Last Synced: 2025-01-01T08:55:19.524Z (14 days ago)
• Language: Ruby
• Homepage:
• Size: 199 KB
• Stars: 69
• Watchers: 8
• Forks: 18
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Todo.txt

[![Gem Version](http://img.shields.io/gem/v/todo-txt.svg)](https://rubygems.org/gems/todo-txt)

[![Build Status](https://travis-ci.org/samwho/todo-txt-gem.svg?branch=master)](https://travis-ci.org/samwho/todo-txt-gem)

This is a Ruby client library for Gina Trapani's

[todo.txt](https://github.com/ginatrapani/todo.txt-cli/). It allows for easy

management of task lists and tasks in the todo.txt format.

Find the project on GitHub:

[http://github.com/samwho/todo-txt-gem](http://github.com/samwho/todo-txt-gem).

Find the full API docs on Rubydoc.info:

[http://www.rubydoc.info/gems/todo-txt](http://www.rubydoc.info/gems/todo-txt).

# Installation

Installation is very simple. The project is packaged as a Ruby gem and can be

installed by running:

    gem install todo-txt

# Usage

## Todo::List

A `Todo::List` object encapsulates your todo.txt file. You initialise it by

passing the path to your todo.txt to the constructor:

``` ruby

require 'todo-txt'

list = Todo::List.new "path/to/todo.txt"

```

`Todo::List` subclasses `Array` so it has all of the standard methods that are

available on an array. It is, basically, an array of `Todo::Task` items.

### Filtering

You can filter your todo list by priority, project, context or a combination of

all three with ease.

``` ruby

require 'todo-txt'

list = Todo::List.new "path/to/todo.txt"

list.by_priority "A"

# => Contains a Todo::List object with only priority A tasks.

list.by_context "@code"

# => Returns a new Todo::List with only tasks that have a @code context.

list.by_project "+manhattan"

# => Returns a new Todo::List with only tasks that are part of the

#    +manhattan project (see what I did there?)

# And you can combine these, like so

list.by_project("+manhattan").by_priority("B")

```

## Todo::Task

A `Todo::Task` object can be created from a standard task string if you don't

want to use the `Todo::List` approach (though using `Todo::List` is

recommended).

``` ruby

require 'todo-txt'

task = Todo::Task.new "(A) This task is top priority! +project @context"

task.priority

# => "A"

task.contexts

# => ["@context"]

task.projects

# => ["+project"]

task.text

# => "This task is top priority!"

task.orig

# => "(A) This task is top priority! +project @context"

```

### Comparable

The `Todo::Task` object includes the `Comparable` mixin. It compares with other

tasks and sorts by priority in descending order.

``` ruby

task1 = Todo::Task.new "(A) Priority A."

task2 = Todo::Task.new "(B) Priority B."

task1 > task2

# => true

task1 == task2

# => false

task2 > task1

# => false

```

Tasks without a priority will always be less than a task with a priority.

# Requirements

The todo-txt gem requires Ruby 2.0 or higher.