r2do 0.0.6
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +28 -0
- data/.travis.yml +4 -0
- data/Gemfile +3 -0
- data/LICENSE +176 -0
- data/README.md +112 -0
- data/Rakefile +2 -0
- data/bin/r2do +7 -0
- data/lib/r2do/category.rb +105 -0
- data/lib/r2do/command.rb +63 -0
- data/lib/r2do/exceptions.rb +27 -0
- data/lib/r2do/handlers/handle_categories.rb +52 -0
- data/lib/r2do/handlers/handle_category.rb +106 -0
- data/lib/r2do/handlers/handle_current.rb +22 -0
- data/lib/r2do/handlers/handle_init.rb +40 -0
- data/lib/r2do/handlers/handle_task.rb +122 -0
- data/lib/r2do/state.rb +82 -0
- data/lib/r2do/task.rb +91 -0
- data/lib/r2do/ui.rb +47 -0
- data/lib/r2do/utility.rb +89 -0
- data/lib/r2do/version.rb +19 -0
- data/lib/r2do.rb +117 -0
- data/r2do.gemspec +23 -0
- data/spec/r2do/category_spec.rb +211 -0
- data/spec/r2do/command_spec.rb +85 -0
- data/spec/r2do/controller_spec.rb +54 -0
- data/spec/r2do/r2do_spec.rb +22 -0
- data/spec/r2do/task_spec.rb +102 -0
- data/spec/spec_helper.rb +20 -0
- metadata +167 -0
data/.gitignore
ADDED
@@ -0,0 +1,28 @@
|
|
1
|
+
*.gem
|
2
|
+
*.rbc
|
3
|
+
.bundle
|
4
|
+
.config
|
5
|
+
coverage
|
6
|
+
InstalledFiles
|
7
|
+
lib/bundler/man
|
8
|
+
pkg
|
9
|
+
rdoc
|
10
|
+
spec/reports
|
11
|
+
test/tmp
|
12
|
+
test/version_tmp
|
13
|
+
tmp
|
14
|
+
tags
|
15
|
+
*.swp
|
16
|
+
|
17
|
+
# YARD artifacts
|
18
|
+
.yardoc
|
19
|
+
_yardoc
|
20
|
+
doc/
|
21
|
+
|
22
|
+
*.lock
|
23
|
+
db/*.sqlite3
|
24
|
+
log/*.log
|
25
|
+
.DS_Store
|
26
|
+
|
27
|
+
r2do_data.yml
|
28
|
+
coverage
|
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,176 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
data/README.md
ADDED
@@ -0,0 +1,112 @@
|
|
1
|
+
# r2do [![Build Status](https://secure.travis-ci.org/cgiacomi/r2do.png?branch=master)](http://travis-ci.org/cgiacomi/r2do) [![Dependency Status](https://gemnasium.com/cgiacomi/r2do.png)](http://gemnasium.com/cgiacomi/r2do) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/cgiacomi/r2do)
|
2
|
+
|
3
|
+
r2do is a simple todo gem to help you remember anything that comes to mind. r2do can be used for normal daily tasks or for your ruby development.
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
gem 'r2do'
|
10
|
+
|
11
|
+
And then execute:
|
12
|
+
|
13
|
+
$ bundle install
|
14
|
+
|
15
|
+
Or install it yourself as:
|
16
|
+
|
17
|
+
$ gem install r2do
|
18
|
+
|
19
|
+
## Usage
|
20
|
+
|
21
|
+
r2do is still in early development and there are many things missing at present.
|
22
|
+
|
23
|
+
As r2do evolves this usage section will reflect the new changes.
|
24
|
+
|
25
|
+
At present this is what is available.
|
26
|
+
|
27
|
+
|
28
|
+
To initialize or reset the application:
|
29
|
+
|
30
|
+
r2do initialize
|
31
|
+
|
32
|
+
|
33
|
+
### Category
|
34
|
+
|
35
|
+
To create a new category or to switch to an existing category:
|
36
|
+
|
37
|
+
r2do category 'My new category'
|
38
|
+
|
39
|
+
To display the information of the current category:
|
40
|
+
|
41
|
+
r2do category --display
|
42
|
+
|
43
|
+
# or the shortcut
|
44
|
+
|
45
|
+
r2do now
|
46
|
+
|
47
|
+
To permanently delete a Category and its contents:
|
48
|
+
|
49
|
+
r2do category --delete
|
50
|
+
|
51
|
+
To list all existing categories:
|
52
|
+
|
53
|
+
r2do display
|
54
|
+
|
55
|
+
|
56
|
+
### Task
|
57
|
+
|
58
|
+
To create a new Task or to select an existing one:
|
59
|
+
|
60
|
+
r2do task MyTask
|
61
|
+
|
62
|
+
To view the information regarding a Task:
|
63
|
+
|
64
|
+
r2do task --display
|
65
|
+
|
66
|
+
To complete a Task:
|
67
|
+
|
68
|
+
r2do task --done
|
69
|
+
|
70
|
+
To permanently delete a Task:
|
71
|
+
|
72
|
+
r2do task --delete
|
73
|
+
|
74
|
+
|
75
|
+
### Short command format
|
76
|
+
|
77
|
+
All commands support a short format, for example:
|
78
|
+
|
79
|
+
r2do category 'My new category'
|
80
|
+
|
81
|
+
#can be written
|
82
|
+
|
83
|
+
r2do c 'My new category'
|
84
|
+
|
85
|
+
To see all the available commands:
|
86
|
+
|
87
|
+
r2do --help
|
88
|
+
|
89
|
+
|
90
|
+
## What is missing?
|
91
|
+
|
92
|
+
There are many features presently missing from r2do, which will be implemented in future versions but there is one thing which must be noted here.
|
93
|
+
|
94
|
+
1) The ability to edit a Category or a Task is lacking at present. It is the top priority, but please note that it is missing.
|
95
|
+
|
96
|
+
If you need to edit a Task you can delete the old one and re-create it.
|
97
|
+
The same goes for a Category, although this is more annoying as you will loose your Tasks when you delete a Category.
|
98
|
+
|
99
|
+
2) The ability to move a Task from one Category to another is also missing.
|
100
|
+
|
101
|
+
|
102
|
+
## Contributing
|
103
|
+
|
104
|
+
1. Fork it
|
105
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
106
|
+
3. Commit your changes (`git commit -am 'Added some feature'`)
|
107
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
108
|
+
5. Create new Pull Request
|
109
|
+
|
110
|
+
## License
|
111
|
+
|
112
|
+
r2do is released under the Apache License, Version 2.0
|
data/Rakefile
ADDED
data/bin/r2do
ADDED
@@ -0,0 +1,105 @@
|
|
1
|
+
#
|
2
|
+
# Copyright 2012 Christian Giacomi http://www.christiangiacomi.com
|
3
|
+
#
|
4
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
5
|
+
# you may not use this file except in compliance with the License.
|
6
|
+
# You may obtain a copy of the License at
|
7
|
+
#
|
8
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
9
|
+
#
|
10
|
+
# Unless required by applicable law or agreed to in writing, software
|
11
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
12
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
13
|
+
# See the License for the specific language governing permissions and
|
14
|
+
# limitations under the License.
|
15
|
+
#
|
16
|
+
|
17
|
+
module R2do
|
18
|
+
|
19
|
+
class Category
|
20
|
+
# @return [String] the name of this category.
|
21
|
+
attr_accessor :name
|
22
|
+
# @return [Array] the tasks this category contains.
|
23
|
+
attr_accessor :tasks
|
24
|
+
# @return [Task] the current task
|
25
|
+
attr_accessor :current_task
|
26
|
+
|
27
|
+
|
28
|
+
# Creates a new instance of a Category
|
29
|
+
#
|
30
|
+
# @param [String] name the name for this category
|
31
|
+
def initialize(name)
|
32
|
+
@name = name
|
33
|
+
@tasks = Array.new
|
34
|
+
@current_task = nil
|
35
|
+
end
|
36
|
+
|
37
|
+
# Finds a task based on the description.
|
38
|
+
#
|
39
|
+
# @param [String] description the task description.
|
40
|
+
# @return [Task] the task identified by description.
|
41
|
+
def find_by_description(description)
|
42
|
+
@tasks.find { |t| t.description == description }
|
43
|
+
end
|
44
|
+
|
45
|
+
# Adds the object into the specific Category.
|
46
|
+
#
|
47
|
+
# @param [Task] task the task to add.
|
48
|
+
# @raise [ArgumentError] if task is nil.
|
49
|
+
# @raise [Exceptions::TaskAlreadyExistsError] if task with same description is already present.
|
50
|
+
# @return [void]
|
51
|
+
def add(task)
|
52
|
+
raise ArgumentError unless not task.nil?
|
53
|
+
|
54
|
+
duplicate = @tasks.find { |t| t.description == task.description }
|
55
|
+
raise TaskAlreadyExistsError unless duplicate.nil?
|
56
|
+
|
57
|
+
@tasks.push(task)
|
58
|
+
end
|
59
|
+
|
60
|
+
# Sets a Task as the current one.
|
61
|
+
#
|
62
|
+
# @param [Task] category the category to be set as current.
|
63
|
+
# @return [void]
|
64
|
+
def set_current(task)
|
65
|
+
@current_task = task
|
66
|
+
end
|
67
|
+
|
68
|
+
# Clears the current task
|
69
|
+
#
|
70
|
+
# @return [void]
|
71
|
+
def clear_current_task()
|
72
|
+
@current_task = nil
|
73
|
+
end
|
74
|
+
|
75
|
+
# Removes the object from the specific Category.
|
76
|
+
#
|
77
|
+
# @param [Task] task the task to remove.
|
78
|
+
# @raise [Exceptions::TaskNotFoundError] if task is not found.
|
79
|
+
# @return [void]
|
80
|
+
def remove(task)
|
81
|
+
@tasks.delete(task) { raise TaskNotFoundError.new() }
|
82
|
+
end
|
83
|
+
|
84
|
+
# Returns a string representation of this Category
|
85
|
+
#
|
86
|
+
# @return [String] the representation of this Category
|
87
|
+
def to_s()
|
88
|
+
count = 0
|
89
|
+
result = StringIO.new
|
90
|
+
|
91
|
+
result << "%s:\n\n" % [@name]
|
92
|
+
result << " %-30s %s\n" % ["Task", "Completed"]
|
93
|
+
result << " " << "-"*51
|
94
|
+
result << "\n"
|
95
|
+
|
96
|
+
@tasks.each do | task |
|
97
|
+
count += 1
|
98
|
+
result << " %s\n" % task
|
99
|
+
end
|
100
|
+
|
101
|
+
return result.string
|
102
|
+
end
|
103
|
+
end
|
104
|
+
|
105
|
+
end
|
data/lib/r2do/command.rb
ADDED
@@ -0,0 +1,63 @@
|
|
1
|
+
#
|
2
|
+
# Copyright 2012 Christian Giacomi http://www.christiangiacomi.com
|
3
|
+
#
|
4
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
5
|
+
# you may not use this file except in compliance with the License.
|
6
|
+
# You may obtain a copy of the License at
|
7
|
+
#
|
8
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
9
|
+
#
|
10
|
+
# Unless required by applicable law or agreed to in writing, software
|
11
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
12
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
13
|
+
# See the License for the specific language governing permissions and
|
14
|
+
# limitations under the License.
|
15
|
+
#
|
16
|
+
|
17
|
+
module R2do
|
18
|
+
|
19
|
+
class Command
|
20
|
+
# @return [String] the value for the command switch.
|
21
|
+
attr_reader :short
|
22
|
+
# @return [String] the name of this command.
|
23
|
+
attr_reader :extended
|
24
|
+
# @return [String] the description for the command.
|
25
|
+
attr_reader :description
|
26
|
+
|
27
|
+
# Creates an instance of a Command
|
28
|
+
#
|
29
|
+
# @param [String] short the short option name for this command
|
30
|
+
# @param [String] extended the full option name for this command
|
31
|
+
# @param [String] argument the optional argument for commands that have arguments
|
32
|
+
# @param [String] description the command's description
|
33
|
+
# @param [callback] callback the callback method for this command
|
34
|
+
def initialize(short, extended, argument, description, callback)
|
35
|
+
raise ArgumentError unless not short.nil? and
|
36
|
+
not extended.nil? and
|
37
|
+
not description.nil? and
|
38
|
+
not callback.nil?
|
39
|
+
|
40
|
+
@short = short
|
41
|
+
@extended = extended
|
42
|
+
@description = description
|
43
|
+
@callback = callback
|
44
|
+
end
|
45
|
+
|
46
|
+
# Executes the callback of this command
|
47
|
+
#
|
48
|
+
# @param [Array] args the collection of arguments
|
49
|
+
# @return [void]
|
50
|
+
def execute(args)
|
51
|
+
@callback.call(args)
|
52
|
+
end
|
53
|
+
|
54
|
+
# Returns a string representation of this Command
|
55
|
+
#
|
56
|
+
# @return [String] the representation of this Command
|
57
|
+
def to_s()
|
58
|
+
return "%2s, %-10s \t# %s" % [@short, @extended, @description]
|
59
|
+
end
|
60
|
+
|
61
|
+
end
|
62
|
+
|
63
|
+
end
|
@@ -0,0 +1,27 @@
|
|
1
|
+
#
|
2
|
+
# Copyright 2012 Christian Giacomi http://www.christiangiacomi.com
|
3
|
+
#
|
4
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
5
|
+
# you may not use this file except in compliance with the License.
|
6
|
+
# You may obtain a copy of the License at
|
7
|
+
#
|
8
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
9
|
+
#
|
10
|
+
# Unless required by applicable law or agreed to in writing, software
|
11
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
12
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
13
|
+
# See the License for the specific language governing permissions and
|
14
|
+
# limitations under the License.
|
15
|
+
#
|
16
|
+
|
17
|
+
module R2do
|
18
|
+
class InvalidOptionError < Exception; end;
|
19
|
+
|
20
|
+
class TaskNotFoundError < Exception; end;
|
21
|
+
class TaskAlreadyExistsError < Exception; end;
|
22
|
+
class TaskNotSelectedError < Exception; end;
|
23
|
+
|
24
|
+
class CategoryNotFoundError < Exception; end;
|
25
|
+
class CategoryAlreadyExistsError < Exception; end;
|
26
|
+
class CategoryNotSelectedError < Exception; end;
|
27
|
+
end
|
@@ -0,0 +1,52 @@
|
|
1
|
+
#
|
2
|
+
# Copyright 2012 Christian Giacomi http://www.christiangiacomi.com
|
3
|
+
#
|
4
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
5
|
+
# you may not use this file except in compliance with the License.
|
6
|
+
# You may obtain a copy of the License at
|
7
|
+
#
|
8
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
9
|
+
#
|
10
|
+
# Unless required by applicable law or agreed to in writing, software
|
11
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
12
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
13
|
+
# See the License for the specific language governing permissions and
|
14
|
+
# limitations under the License.
|
15
|
+
#
|
16
|
+
|
17
|
+
module R2do
|
18
|
+
module Handlers
|
19
|
+
module_function
|
20
|
+
|
21
|
+
# Displays all the categories available
|
22
|
+
#
|
23
|
+
# @param [Array] args the arguments passed to the app by the user
|
24
|
+
# @return [void]
|
25
|
+
def handle_categories(args)
|
26
|
+
if @state.categories.empty?
|
27
|
+
UI.status("No categories to display")
|
28
|
+
else
|
29
|
+
@state.categories.each do |key, value|
|
30
|
+
current = (value == @state.current_category && "*") || ' '
|
31
|
+
UI.status("#{current} #{value.name}")
|
32
|
+
end
|
33
|
+
end
|
34
|
+
end
|
35
|
+
|
36
|
+
# Displays the help for a command
|
37
|
+
#
|
38
|
+
# @param [Array] args the arguments passed to the app by the user
|
39
|
+
# @return [void]
|
40
|
+
def handle_help(args)
|
41
|
+
if args.length < 2
|
42
|
+
show_help(args)
|
43
|
+
return
|
44
|
+
end
|
45
|
+
|
46
|
+
command = args[1]
|
47
|
+
UI.status("TODO: show the help for command '%s'" % command)
|
48
|
+
end
|
49
|
+
|
50
|
+
end
|
51
|
+
|
52
|
+
end
|
@@ -0,0 +1,106 @@
|
|
1
|
+
#
|
2
|
+
# Copyright 2012 Christian Giacomi http://www.christiangiacomi.com
|
3
|
+
#
|
4
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
5
|
+
# you may not use this file except in compliance with the License.
|
6
|
+
# You may obtain a copy of the License at
|
7
|
+
#
|
8
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
9
|
+
#
|
10
|
+
# Unless required by applicable law or agreed to in writing, software
|
11
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
12
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
13
|
+
# See the License for the specific language governing permissions and
|
14
|
+
# limitations under the License.
|
15
|
+
#
|
16
|
+
|
17
|
+
module R2do
|
18
|
+
module Handlers
|
19
|
+
module_function
|
20
|
+
|
21
|
+
# Creates a new category or makes a category current in the state if a category with the
|
22
|
+
# same name already exists
|
23
|
+
#
|
24
|
+
# @param [Array] args the arguments passed to the app by the user
|
25
|
+
# @raise [ArgumentError] if the command does not contain a name for the category
|
26
|
+
# @return [void]
|
27
|
+
def handle_category(args)
|
28
|
+
if args.length < 2
|
29
|
+
raise ArgumentError, "The 'category' command requires additional arguments."
|
30
|
+
end
|
31
|
+
|
32
|
+
option = args[1]
|
33
|
+
|
34
|
+
if option.eql?(DISPLAY)
|
35
|
+
display_current_category(args)
|
36
|
+
elsif option.eql?(DELETE)
|
37
|
+
require_selected_category()
|
38
|
+
delete_category(args)
|
39
|
+
elsif option.start_with?("--")
|
40
|
+
raise InvalidOptionError
|
41
|
+
else
|
42
|
+
parse_category(args)
|
43
|
+
end
|
44
|
+
end
|
45
|
+
|
46
|
+
# Shows the detailed information for the current category, including the tasks contained
|
47
|
+
#
|
48
|
+
# @param [Array] args the arguments passed to the app by the user
|
49
|
+
# @return [void]
|
50
|
+
def display_current_category(args)
|
51
|
+
if not @state.current_category
|
52
|
+
UI.status("No category is currently selected.")
|
53
|
+
else
|
54
|
+
UI.status(@state.current_category.to_s)
|
55
|
+
UI.new_line()
|
56
|
+
end
|
57
|
+
end
|
58
|
+
|
59
|
+
# Deletes the currently selected category
|
60
|
+
#
|
61
|
+
# @param [Array] args the argumets passed to the app by the user
|
62
|
+
# @return [void]
|
63
|
+
def delete_category(args)
|
64
|
+
UI.status("Are you sure you want to delete the category:")
|
65
|
+
UI.status(" #{@state.current_category.name}")
|
66
|
+
UI.new_line()
|
67
|
+
UI.status("All tasks contained in this category will be lost.")
|
68
|
+
value = UI.input("This action cannot be undone. Continue? [Yn]")
|
69
|
+
if value == YES
|
70
|
+
cat = @state.current_category
|
71
|
+
@state.remove(cat)
|
72
|
+
@state.clear_current_category()
|
73
|
+
@modified = true
|
74
|
+
|
75
|
+
UI.status("Category '#{cat.name}' has been deleted.")
|
76
|
+
end
|
77
|
+
end
|
78
|
+
|
79
|
+
|
80
|
+
def parse_category(args)
|
81
|
+
extra = ''
|
82
|
+
category_name = args[1]
|
83
|
+
if @state.contains?(category_name)
|
84
|
+
cat = @state.get(category_name)
|
85
|
+
else
|
86
|
+
extra = 'new '
|
87
|
+
cat = Category.new(category_name)
|
88
|
+
@state.add(cat)
|
89
|
+
end
|
90
|
+
|
91
|
+
@state.set_current(cat)
|
92
|
+
@modified = true
|
93
|
+
|
94
|
+
UI.status("Switched to #{extra}category '#{category_name}'")
|
95
|
+
end
|
96
|
+
|
97
|
+
|
98
|
+
def require_selected_category()
|
99
|
+
if not @state.current_category
|
100
|
+
raise CategoryNotSelectedError, "This action requires a selected category."
|
101
|
+
end
|
102
|
+
end
|
103
|
+
|
104
|
+
end
|
105
|
+
|
106
|
+
end
|