brian/go-todotxt
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

initial commit, begin working on library

Browse Source
This commit is contained in:
jamesclonk@jamesclonk.ch 2014-01-03 01:29:54 +01:00
parent 9bfd0a25d0
commit a5c526da68
4 changed files with 495 additions and 281 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

596
LICENSE
View File

@ -1,339 +1,373 @@
GNU GENERAL PUBLIC LICENSE Mozilla Public License Version 2.0
Version 2, June 1991 ==================================
Copyright (C) 1989, 1991 Free Software Foundation, Inc., <http://fsf.org/> 1. Definitions
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA --------------
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble 1.1. "Contributor"
means each individual or legal entity that creates, contributes to
the creation of, or owns Covered Software.
The licenses for most software are designed to take away your 1.2. "Contributor Version"
freedom to share and change it. By contrast, the GNU General Public means the combination of the Contributions of others (if any) used
License is intended to guarantee your freedom to share and change free by a Contributor and that particular Contributor's Contribution.
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Lesser General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not 1.3. "Contribution"
price. Our General Public Licenses are designed to make sure that you means Covered Software of a particular Contributor.
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid 1.4. "Covered Software"
anyone to deny you these rights or to ask you to surrender the rights. means Source Code Form to which the initial Contributor has attached
These restrictions translate to certain responsibilities for you if you the notice in Exhibit A, the Executable Form of such Source Code
distribute copies of the software, or if you modify it. Form, and Modifications of such Source Code Form, in each case
including portions thereof.
For example, if you distribute copies of such a program, whether 1.5. "Incompatible With Secondary Licenses"
gratis or for a fee, you must give the recipients all the rights that means
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and (a) that the initial Contributor has attached the notice described
(2) offer you this license which gives you legal permission to copy, in Exhibit B to the Covered Software; or
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain (b) that the Covered Software was made available under the terms of
that everyone understands that there is no warranty for this free version 1.1 or earlier of the License, but not also under the
software. If the software is modified by someone else and passed on, we terms of a Secondary License.
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software 1.6. "Executable Form"
patents. We wish to avoid the danger that redistributors of a free means any form of the work other than Source Code Form.
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and 1.7. "Larger Work"
modification follow. means a work that combines Covered Software with other material, in
a separate file or files, that is not Covered Software.
GNU GENERAL PUBLIC LICENSE 1.8. "License"
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION means this document.
0. This License applies to any program or other work which contains 1.9. "Licensable"
a notice placed by the copyright holder saying it may be distributed means having the right to grant, to the maximum extent possible,
under the terms of this General Public License. The "Program", below, whether at the time of the initial grant or subsequently, any and
refers to any such program or work, and a "work based on the Program" all of the rights conveyed by this License.
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not 1.10. "Modifications"
covered by this License; they are outside its scope. The act of means any of the following:
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's (a) any file in Source Code Form that results from an addition to,
source code as you receive it, in any medium, provided that you deletion from, or modification of the contents of Covered
conspicuously and appropriately publish on each copy an appropriate Software; or
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and (b) any new file in Source Code Form that contains any Covered
you may at your option offer warranty protection in exchange for a fee. Software.
2. You may modify your copy or copies of the Program or any portion 1.11. "Patent Claims" of a Contributor
of it, thus forming a work based on the Program, and copy and means any patent claim(s), including without limitation, method,
distribute such modifications or work under the terms of Section 1 process, and apparatus claims, in any patent Licensable by such
above, provided that you also meet all of these conditions: Contributor that would be infringed, but for the grant of the
License, by the making, using, selling, offering for sale, having
made, import, or transfer of either its Contributions or its
Contributor Version.
a) You must cause the modified files to carry prominent notices 1.12. "Secondary License"
stating that you changed the files and the date of any change. means either the GNU General Public License, Version 2.0, the GNU
Lesser General Public License, Version 2.1, the GNU Affero General
Public License, Version 3.0, or any later versions of those
licenses.
b) You must cause any work that you distribute or publish, that in 1.13. "Source Code Form"
whole or in part contains or is derived from the Program or any means the form of the work preferred for making modifications.
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively 1.14. "You" (or "Your")
when run, you must cause it, when started running for such means an individual or a legal entity exercising rights under this
interactive use in the most ordinary way, to print or display an License. For legal entities, "You" includes any entity that
announcement including an appropriate copyright notice and a controls, is controlled by, or is under common control with You. For
notice that there is no warranty (or else, saying that you provide purposes of this definition, "control" means (a) the power, direct
a warranty) and that users may redistribute the program under or indirect, to cause the direction or management of such entity,
these conditions, and telling the user how to view a copy of this whether by contract or otherwise, or (b) ownership of more than
License. (Exception: if the Program itself is interactive but fifty percent (50%) of the outstanding shares or beneficial
does not normally print such an announcement, your work based on ownership of such entity.
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If 2. License Grants and Conditions
identifiable sections of that work are not derived from the Program, --------------------------------
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest 2.1. Grants
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program Each Contributor hereby grants You a world-wide, royalty-free,
with the Program (or with a work based on the Program) on a volume of non-exclusive license:
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it, (a) under intellectual property rights (other than patent or trademark)
under Section 2) in object code or executable form under the terms of Licensable by such Contributor to use, reproduce, make available,
Sections 1 and 2 above provided that you also do one of the following: modify, display, perform, distribute, and otherwise exploit its
Contributions, either on an unmodified basis, with Modifications, or
as part of a Larger Work; and
a) Accompany it with the complete corresponding machine-readable (b) under Patent Claims of such Contributor to make, use, sell, offer
source code, which must be distributed under the terms of Sections for sale, have made, import, and otherwise transfer either its
1 and 2 above on a medium customarily used for software interchange; or, Contributions or its Contributor Version.
b) Accompany it with a written offer, valid for at least three 2.2. Effective Date
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer The licenses granted in Section 2.1 with respect to any Contribution
to distribute corresponding source code. (This alternative is become effective for each Contribution on the date the Contributor first
allowed only for noncommercial distribution and only if you distributes such Contribution.
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for 2.3. Limitations on Grant Scope
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering The licenses granted in this Section 2 are the only rights granted under
access to copy from a designated place, then offering equivalent this License. No additional rights or licenses will be implied from the
access to copy the source code from the same place counts as distribution or licensing of Covered Software under this License.
distribution of the source code, even though third parties are not Notwithstanding Section 2.1(b) above, no patent license is granted by a
compelled to copy the source along with the object code. Contributor:
4. You may not copy, modify, sublicense, or distribute the Program (a) for any code that a Contributor has removed from Covered Software;
except as expressly provided under this License. Any attempt or
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not (b) for infringements caused by: (i) Your and any other third party's
signed it. However, nothing else grants you permission to modify or modifications of Covered Software, or (ii) the combination of its
distribute the Program or its derivative works. These actions are Contributions with other software (except as part of its Contributor
prohibited by law if you do not accept this License. Therefore, by Version); or
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the (c) under Patent Claims infringed by Covered Software in the absence of
Program), the recipient automatically receives a license from the its Contributions.
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent This License does not grant any rights in the trademarks, service marks,
infringement or for any other reason (not limited to patent issues), or logos of any Contributor (except as may be necessary to comply with
conditions are imposed on you (whether by court order, agreement or the notice requirements in Section 3.4).
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under 2.4. Subsequent Licenses
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any No Contributor makes additional grants as a result of Your choice to
patents or other property right claims or to contest validity of any distribute the Covered Software under a subsequent version of this
such claims; this section has the sole purpose of protecting the License (see Section 10.2) or under the terms of a Secondary License (if
integrity of the free software distribution system, which is permitted under the terms of Section 3.3).
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to 2.5. Representation
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in Each Contributor represents that the Contributor believes its
certain countries either by patents or by copyrighted interfaces, the Contributions are its original creation(s) or it has sufficient rights
original copyright holder who places the Program under this License to grant the rights to its Contributions conveyed by this License.
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions 2.6. Fair Use
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program This License is not intended to limit any rights You have under
specifies a version number of this License which applies to it and "any applicable copyright doctrines of fair use, fair dealing, or other
later version", you have the option of following the terms and conditions equivalents.
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free 2.7. Conditions
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
in Section 2.1.
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 3. Responsibilities
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN -------------------
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 3.1. Distribution of Source Form
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS All distribution of Covered Software in Source Code Form, including any
Modifications that You create or to which You contribute, must be under
the terms of this License. You must inform recipients that the Source
Code Form of the Covered Software is governed by the terms of this
License, and how they can obtain a copy of this License. You may not
attempt to alter or restrict the recipients' rights in the Source Code
Form.
How to Apply These Terms to Your New Programs 3.2. Distribution of Executable Form
If you develop a new program, and you want it to be of the greatest If You distribute Covered Software in Executable Form then:
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest (a) such Covered Software must also be made available in Source Code
to attach them to the start of each source file to most effectively Form, as described in Section 3.1, and You must inform recipients of
convey the exclusion of warranty; and each file should have at least the Executable Form how they can obtain a copy of such Source Code
the "copyright" line and a pointer to where the full notice is found. Form by reasonable means in a timely manner, at a charge no more
than the cost of distribution to the recipient; and
{description} (b) You may distribute such Executable Form under the terms of this
Copyright (C) {year} {fullname} License, or sublicense it under different terms, provided that the
license for the Executable Form does not attempt to limit or alter
the recipients' rights in the Source Code Form under this License.
This program is free software; you can redistribute it and/or modify 3.3. Distribution of a Larger Work
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful, You may create and distribute a Larger Work under terms of Your choice,
but WITHOUT ANY WARRANTY; without even the implied warranty of provided that You also comply with the requirements of this License for
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the the Covered Software. If the Larger Work is a combination of Covered
GNU General Public License for more details. Software with a work governed by one or more Secondary Licenses, and the
Covered Software is not Incompatible With Secondary Licenses, this
License permits You to additionally distribute such Covered Software
under the terms of such Secondary License(s), so that the recipient of
the Larger Work may, at their option, further distribute the Covered
Software under the terms of either this License or such Secondary
License(s).
You should have received a copy of the GNU General Public License along 3.4. Notices
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Also add information on how to contact you by electronic and paper mail. You may not remove or alter the substance of any license notices
(including copyright notices, patent notices, disclaimers of warranty,
or limitations of liability) contained within the Source Code Form of
the Covered Software, except that You may alter any license notices to
the extent required to remedy known factual inaccuracies.
If the program is interactive, make it output a short notice like this 3.5. Application of Additional Terms
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author You may choose to offer, and to charge a fee for, warranty, support,
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. indemnity or liability obligations to one or more recipients of Covered
This is free software, and you are welcome to redistribute it Software. However, You may do so only on Your own behalf, and not on
under certain conditions; type `show c' for details. behalf of any Contributor. You must make it absolutely clear that any
such warranty, support, indemnity, or liability obligation is offered by
You alone, and You hereby agree to indemnify every Contributor for any
liability incurred by such Contributor as a result of warranty, support,
indemnity or liability terms You offer. You may include additional
disclaimers of warranty and limitations of liability specific to any
jurisdiction.
The hypothetical commands `show w' and `show c' should show the appropriate 4. Inability to Comply Due to Statute or Regulation
parts of the General Public License. Of course, the commands you use may ---------------------------------------------------
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your If it is impossible for You to comply with any of the terms of this
school, if any, to sign a "copyright disclaimer" for the program, if License with respect to some or all of the Covered Software due to
necessary. Here is a sample; alter the names: statute, judicial order, or regulation then You must: (a) comply with
the terms of this License to the maximum extent possible; and (b)
describe the limitations and the code they affect. Such description must
be placed in a text file included with all distributions of the Covered
Software under this License. Except to the extent prohibited by statute
or regulation, such description must be sufficiently detailed for a
recipient of ordinary skill to be able to understand it.
Yoyodyne, Inc., hereby disclaims all copyright interest in the program 5. Termination
`Gnomovision' (which makes passes at compilers) written by James Hacker. --------------
{signature of Ty Coon}, 1 April 1989 5.1. The rights granted under this License will terminate automatically
Ty Coon, President of Vice if You fail to comply with any of its terms. However, if You become
compliant, then the rights granted under this License from a particular
Contributor are reinstated (a) provisionally, unless and until such
Contributor explicitly and finally terminates Your grants, and (b) on an
ongoing basis, if such Contributor fails to notify You of the
non-compliance by some reasonable means prior to 60 days after You have
come back into compliance. Moreover, Your grants from a particular
Contributor are reinstated on an ongoing basis if such Contributor
notifies You of the non-compliance by some reasonable means, this is the
first time You have received notice of non-compliance with this License
from such Contributor, and You become compliant prior to 30 days after
Your receipt of the notice.
This General Public License does not permit incorporating your program into 5.2. If You initiate litigation against any entity by asserting a patent
proprietary programs. If your program is a subroutine library, you may infringement claim (excluding declaratory judgment actions,
consider it more useful to permit linking proprietary applications with the counter-claims, and cross-claims) alleging that a Contributor Version
library. If this is what you want to do, use the GNU Lesser General directly or indirectly infringes any patent, then the rights granted to
Public License instead of this License. You by any and all Contributors for the Covered Software under Section
2.1 of this License shall terminate.
5.3. In the event of termination under Sections 5.1 or 5.2 above, all
end user license agreements (excluding distributors and resellers) which
have been validly granted by You or Your distributors under this License
prior to termination shall survive termination.
************************************************************************
* *
* 6. Disclaimer of Warranty *
* ------------------------- *
* *
* Covered Software is provided under this License on an "as is" *
* basis, without warranty of any kind, either expressed, implied, or *
* statutory, including, without limitation, warranties that the *
* Covered Software is free of defects, merchantable, fit for a *
* particular purpose or non-infringing. The entire risk as to the *
* quality and performance of the Covered Software is with You. *
* Should any Covered Software prove defective in any respect, You *
* (not any Contributor) assume the cost of any necessary servicing, *
* repair, or correction. This disclaimer of warranty constitutes an *
* essential part of this License. No use of any Covered Software is *
* authorized under this License except under this disclaimer. *
* *
************************************************************************
************************************************************************
* *
* 7. Limitation of Liability *
* -------------------------- *
* *
* Under no circumstances and under no legal theory, whether tort *
* (including negligence), contract, or otherwise, shall any *
* Contributor, or anyone who distributes Covered Software as *
* permitted above, be liable to You for any direct, indirect, *
* special, incidental, or consequential damages of any character *
* including, without limitation, damages for lost profits, loss of *
* goodwill, work stoppage, computer failure or malfunction, or any *
* and all other commercial damages or losses, even if such party *
* shall have been informed of the possibility of such damages. This *
* limitation of liability shall not apply to liability for death or *
* personal injury resulting from such party's negligence to the *
* extent applicable law prohibits such limitation. Some *
* jurisdictions do not allow the exclusion or limitation of *
* incidental or consequential damages, so this exclusion and *
* limitation may not apply to You. *
* *
************************************************************************
8. Litigation
-------------
Any litigation relating to this License may be brought only in the
courts of a jurisdiction where the defendant maintains its principal
place of business and such litigation shall be governed by laws of that
jurisdiction, without reference to its conflict-of-law provisions.
Nothing in this Section shall prevent a party's ability to bring
cross-claims or counter-claims.
9. Miscellaneous
----------------
This License represents the complete agreement concerning the subject
matter hereof. If any provision of this License is held to be
unenforceable, such provision shall be reformed only to the extent
necessary to make it enforceable. Any law or regulation which provides
that the language of a contract shall be construed against the drafter
shall not be used to construe this License against a Contributor.
10. Versions of the License
---------------------------
10.1. New Versions
Mozilla Foundation is the license steward. Except as provided in Section
10.3, no one other than the license steward has the right to modify or
publish new versions of this License. Each version will be given a
distinguishing version number.
10.2. Effect of New Versions
You may distribute the Covered Software under the terms of the version
of the License under which You originally received the Covered Software,
or under the terms of any subsequent version published by the license
steward.
10.3. Modified Versions
If you create software not governed by this License, and you want to
create a new license for such software, you may create and use a
modified version of this License if you rename the license and remove
any references to the name of the license steward (except to note that
such modified license differs from this License).
10.4. Distributing Source Code Form that is Incompatible With Secondary
Licenses
If You choose to distribute Source Code Form that is Incompatible With
Secondary Licenses under the terms of this version of the License, the
notice described in Exhibit B of this License must be attached.
Exhibit A - Source Code Form License Notice
-------------------------------------------
This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at http://mozilla.org/MPL/2.0/.
If it is not possible or desirable to put the notice in a particular
file, then You may include the notice in a location (such as a LICENSE
file in a relevant directory) where a recipient would be likely to look
for such a notice.
You may add additional accurate notices of copyright ownership.
Exhibit B - "Incompatible With Secondary Licenses" Notice
---------------------------------------------------------
This Source Code Form is "Incompatible With Secondary Licenses", as
defined by the Mozilla Public License, v. 2.0.

8
todo.txt Normal file
View File

@ -0,0 +1,8 @@
(A) 2012-01-30 Call Mom @Phone +Family
(A) Schedule annual checkup +Health
(B) Outline chapter 5 +Novel @Computer
(C) Add cover sheets @Office +TPSReports
Plan backyard herb garden @Home
2013-02-22 Pick up milk @GroceryStore
Research self-publishing services +Novel @Computer
x Download Todo.txt mobile app @Phone

96
todotxt.go Normal file
View File

@ -0,0 +1,96 @@
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
package todotxt
import (
"bufio"
"os"
"regexp"
"time"
)
type Task struct {
Task string // Raw text
Todo string // Only actual todo part of text
Priority string
Projects []string
Contexts []string
CreatedDate time.Time
DueDate time.Time
CompletedDate time.Time
Completed bool
}
type TaskList []Task
var (
priorityRx = regexp.MustCompile(`^\(([A-Z])\)\s+`) // Match priority value: '(A) ...'
createdDateRx = regexp.MustCompile(`^(\([A-Z]\)|)\s*([\d]{4}-[\d]{2}-[\d]{2})\s+`) // Match date value: '(A) 2012-12-12 ...' or '2012-12-12 ...'
)
// Return raw task text for String()
func (task *Task) String() string {
return task.Task
}
func (task *Task) HasPriority() bool {
return task.Priority != ""
}
func (task *Task) HasCreatedDate() bool {
return !task.CreatedDate.IsZero()
}
func (task *Task) HasDueDate() bool {
return !task.DueDate.IsZero()
}
func (task *Task) HasCompletedDate() bool {
return !task.CompletedDate.IsZero()
}
// Loading from *os.File allows to also use os.Stdin instead of just actual files
func (tasklist *TaskList) LoadFromFile(file *os.File) error {
*tasklist = []Task{} // Reset tasklist
scanner := bufio.NewScanner(file)
for scanner.Scan() {
task := Task{}
task.Task = scanner.Text()
// Check for priority
if priorityRx.MatchString(task.Task) {
task.Priority = priorityRx.FindStringSubmatch(task.Task)[1] // First match is priority value
}
// Check for created date
if createdDateRx.MatchString(task.Task) {
// Second match is created date value
if date, err := time.Parse("2006-01-02", createdDateRx.FindStringSubmatch(task.Task)[2]); err != nil {
return err
} else {
task.CreatedDate = date
}
}
*tasklist = append(*tasklist, task)
}
if err := scanner.Err(); err != nil {
return err
}
return nil
}
// Convenience method, since most of the time tasks will be loaded from an actual file, called "todo.txt" most likely ;)
func (tasklist *TaskList) LoadFromFilename(filename string) error {
file, err := os.Open(filename)
if err != nil {
return err
}
defer file.Close()
return tasklist.LoadFromFile(file)
}

76
todotxt_test.go Normal file
View File

@ -0,0 +1,76 @@
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
package todotxt
import (
"os"
"testing"
"time"
)
func TestLoadFromFile(t *testing.T) {
file, err := os.Open("todo.txt")
if err != nil {
t.Fatal(err)
}
defer file.Close()
var tasklist TaskList
if err := tasklist.LoadFromFile(file); err != nil {
t.Fatal(err)
}
loadTest(t, tasklist)
}
func TestLoadFromFilename(t *testing.T) {
var tasklist TaskList
if err := tasklist.LoadFromFilename("todo.txt"); err != nil {
t.Fatal(err)
}
loadTest(t, tasklist)
}
func loadTest(t *testing.T, tasklist TaskList) {
var expected, got interface{}
var err error
expected = 8
got = len(tasklist)
if got != expected {
t.Errorf("Expected TaskList to contain %d tasks, but got %d", expected, got)
}
expected = "B"
got = tasklist[2].Priority
if got != expected {
t.Errorf("Expected third task to have priority '%s', but got '%s'", expected, got)
}
if tasklist[4].HasPriority() {
t.Errorf("Expected fifth task to have no priority, but got '%s'", tasklist[4].Priority)
}
expected, err = time.Parse("2006-01-02", "2012-01-30")
if err != nil {
t.Fatal(err)
}
got = tasklist[0].CreatedDate
if got != expected {
t.Errorf("Expected first task to have created date '%s', but got '%v'", expected, got)
}
expected, err = time.Parse("2006-01-02", "2013-02-22")
if err != nil {
t.Fatal(err)
}
got = tasklist[5].CreatedDate
if got != expected {
t.Errorf("Expected sixth task to have created date '%s', but got '%v'", expected, got)
}
if tasklist[4].HasCreatedDate() {
t.Errorf("Expected fifth task to have no created date, but got '%v'", tasklist[4].CreatedDate)
}
}