rtasklib 0.2.3.pre.beta → 0.2.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +12 -2
- data/lib/rtasklib/controller.rb +37 -1
- data/lib/rtasklib/version.rb +1 -1
- metadata +3 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 55fa7b52d0b936a660f0bd5ec3abec540061899f
|
|
4
|
+
data.tar.gz: 5477d47c2444d63804f6a8a3e04ea92d8144c5a8
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c72b5d7e96f38eb352a3bc4dd21d1bc39bd6cc73134e0679a0d61edd9c62c92c1171f0d6d7483f8e1e41a030fb3ace9b7d5741a76b3d9857f281b393e37837ad
|
|
7
|
+
data.tar.gz: 28ead3888140bc9b38cb641051a2a1814d68333ae03429618cb5df5cc67a56ce92bd0a6b78d2a0485fa4ff67f86311fc01d46bb141b35f85d21b5c34ffaec4c4
|
data/README.md
CHANGED
|
@@ -113,14 +113,24 @@ tw.some(ids: [1..5, 10]).size
|
|
|
113
113
|
#=> 6
|
|
114
114
|
|
|
115
115
|
tw.done!(ids: 5)
|
|
116
|
-
#=> 0
|
|
117
116
|
|
|
118
117
|
tw.some(ids: [1..5, 10]).size
|
|
119
118
|
#=> 5
|
|
119
|
+
|
|
120
|
+
tw.get_uda_names
|
|
121
|
+
#=> ["author", "estimate"]
|
|
122
|
+
|
|
123
|
+
task.sync!
|
|
120
124
|
```
|
|
121
125
|
|
|
122
|
-
[Controller docs](http://will-paul.com/rtasklib/Rtasklib/Controller.html)
|
|
126
|
+
[Controller docs has more examples for each method](http://will-paul.com/rtasklib/Rtasklib/Controller.html)
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
## Documentation
|
|
130
|
+
|
|
131
|
+
[Generated using yardoc](http://will-paul.com/rtasklib/Rtasklib)
|
|
123
132
|
|
|
133
|
+
100.00% documented
|
|
124
134
|
|
|
125
135
|
## Development
|
|
126
136
|
|
data/lib/rtasklib/controller.rb
CHANGED
|
@@ -14,9 +14,42 @@ module Rtasklib
|
|
|
14
14
|
# By convention bang methods modify the task database, and non-bang read
|
|
15
15
|
# from the database, e.g. `Controller#all` vs `Controller#modify!`
|
|
16
16
|
#
|
|
17
|
+
# Most methods accept filtering in the form of ids, tags, and dom
|
|
18
|
+
#
|
|
17
19
|
# Changes to the config are not effected by #undo!
|
|
18
20
|
#
|
|
19
21
|
# XXX: depends on TaskWarrior#override_a currently, which isn't great.
|
|
22
|
+
#
|
|
23
|
+
# @example ids: can be a single id as a String or Fixnum or Range
|
|
24
|
+
# tw.some(ids: 1)
|
|
25
|
+
# tw.some(ids: "1")
|
|
26
|
+
# tw.some(ids: 1..4) # 1,2,3,4
|
|
27
|
+
# tw.some(ids: 1...4) # 1,2,3
|
|
28
|
+
#
|
|
29
|
+
# @example ids: can be an array of mixed types
|
|
30
|
+
# tw.some(ids: [1,2,4...10,"12"])
|
|
31
|
+
#
|
|
32
|
+
# @example ids: can be a TaskWarrior formatted string
|
|
33
|
+
# tw.some(ids: "1-3,10")
|
|
34
|
+
#
|
|
35
|
+
# @example tags: can be a single string
|
|
36
|
+
# tw.some(tags: "work") # converted to +work
|
|
37
|
+
# tw.some(tags: "-work")
|
|
38
|
+
#
|
|
39
|
+
# @example tags: can be an array and include relational operators
|
|
40
|
+
# tw.some(tags: ["work", "and", "-fun"])
|
|
41
|
+
#
|
|
42
|
+
# @example tags: work with TaskWarrior built-in virtual tags http://taskwarrior.org/docs/tags.html
|
|
43
|
+
# tw.some(tags: "+TODAY")
|
|
44
|
+
#
|
|
45
|
+
# @example dom: work as hashes
|
|
46
|
+
# require "date"
|
|
47
|
+
# today = DateTime.now
|
|
48
|
+
# tw.some(dom: {project: "Work", "due.before" => today})
|
|
49
|
+
#
|
|
50
|
+
# @example You can also pass in a TW style string if you prefer
|
|
51
|
+
# tw.some(dom: "project:Work due.before:#{today}")
|
|
52
|
+
#
|
|
20
53
|
module Controller
|
|
21
54
|
extend self
|
|
22
55
|
|
|
@@ -56,7 +89,7 @@ module Rtasklib
|
|
|
56
89
|
# @example filter by a dom query
|
|
57
90
|
# require "date"
|
|
58
91
|
# today = DateTime.now
|
|
59
|
-
# # note that queries with dots need to be Strings, as they would be
|
|
92
|
+
# # note that queries with dots need to be Strings, as they would be
|
|
60
93
|
# # invalid Symbols
|
|
61
94
|
# tw.some(dom: {project: "Work", "due.before" => today})
|
|
62
95
|
# # You can also pass in a TW style string if you prefer
|
|
@@ -126,6 +159,9 @@ module Rtasklib
|
|
|
126
159
|
# Mark the filter of tasks as started
|
|
127
160
|
# Returns false if filter (ids:, tags:, dom:) is blank.
|
|
128
161
|
#
|
|
162
|
+
# @example
|
|
163
|
+
# tw.start!(ids: 1)
|
|
164
|
+
#
|
|
129
165
|
# @param ids [Array<Range, Fixnum, String>, String, Range, Fixnum]
|
|
130
166
|
# @param tags [Array<String>, String]
|
|
131
167
|
# @param dom [Array<String>, String]
|
data/lib/rtasklib/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: rtasklib
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.2.3
|
|
4
|
+
version: 0.2.3
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Will Paul
|
|
@@ -221,9 +221,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
|
221
221
|
version: '2.0'
|
|
222
222
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
223
223
|
requirements:
|
|
224
|
-
- - "
|
|
224
|
+
- - ">="
|
|
225
225
|
- !ruby/object:Gem::Version
|
|
226
|
-
version:
|
|
226
|
+
version: '0'
|
|
227
227
|
requirements:
|
|
228
228
|
- taskwarrior, >=2.4.0
|
|
229
229
|
rubyforge_project:
|