rtasklib 0.2.3.pre.beta → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ea31920458cceb17a1ce39892a1ec2ae5d5174e
-  data.tar.gz: 0f4bc7d917dc78a366a2d10185845c937be0451c
+  metadata.gz: 55fa7b52d0b936a660f0bd5ec3abec540061899f
+  data.tar.gz: 5477d47c2444d63804f6a8a3e04ea92d8144c5a8
 SHA512:
-  metadata.gz: 4cf37fe6283bb192b1f1333a08713c70787459b8faae75ff56c1f9a3c713cf1641e437b724a4499a9f7f13de741534f6b6240088668a5d07dccafe9532d5bc5e
-  data.tar.gz: 9f66f97b08122ffa14a3b7633c4fc6714dc02e67a97cda0cdb6ac7817aff71f0ef9f14fc50e45fb2f620153a01f86f181ae514c92c88a56024def52d415cbb3a
+  metadata.gz: c72b5d7e96f38eb352a3bc4dd21d1bc39bd6cc73134e0679a0d61edd9c62c92c1171f0d6d7483f8e1e41a030fb3ace9b7d5741a76b3d9857f281b393e37837ad
+  data.tar.gz: 28ead3888140bc9b38cb641051a2a1814d68333ae03429618cb5df5cc67a56ce92bd0a6b78d2a0485fa4ff67f86311fc01d46bb141b35f85d21b5c34ffaec4c4

data/README.md

@@ -113,14 +113,24 @@ tw.some(ids: [1..5, 10]).size
 #=> 6
 
 tw.done!(ids: 5)
-#=> 0
 
 tw.some(ids: [1..5, 10]).size
 #=> 5
+
+tw.get_uda_names
+#=> ["author", "estimate"]
+
+task.sync!
 ```
 
-[Controller docs](http://will-paul.com/rtasklib/Rtasklib/Controller.html)
+[Controller docs has more examples for each method](http://will-paul.com/rtasklib/Rtasklib/Controller.html)
+
+
+## Documentation
+
+[Generated using yardoc](http://will-paul.com/rtasklib/Rtasklib)
 
+100.00% documented
 
 ## Development
 

data/lib/rtasklib/controller.rb

@@ -14,9 +14,42 @@ module Rtasklib
   # By convention bang methods modify the task database, and non-bang read
   # from the database, e.g. `Controller#all` vs `Controller#modify!`
   #
+  # Most methods accept filtering in the form of ids, tags, and dom
+  #
   # Changes to the config are not effected by #undo!
   #
   # XXX: depends on TaskWarrior#override_a currently, which isn't great.
+  #
+  # @example ids: can be a single id as a String or Fixnum or Range
+  #   tw.some(ids: 1)
+  #   tw.some(ids: "1")
+  #   tw.some(ids: 1..4)  # 1,2,3,4
+  #   tw.some(ids: 1...4) # 1,2,3
+  #
+  # @example ids: can be an array of mixed types
+  #   tw.some(ids: [1,2,4...10,"12"])
+  #
+  # @example ids: can be a TaskWarrior formatted string
+  #   tw.some(ids: "1-3,10")
+  #
+  # @example tags: can be a single string
+  #   tw.some(tags: "work") # converted to +work
+  #   tw.some(tags: "-work")
+  #
+  # @example tags: can be an array and include relational operators
+  #   tw.some(tags: ["work", "and", "-fun"])
+  #
+  # @example tags: work with TaskWarrior built-in virtual tags http://taskwarrior.org/docs/tags.html
+  #   tw.some(tags: "+TODAY")
+  #
+  # @example dom: work as hashes
+  #   require "date"
+  #   today = DateTime.now
+  #   tw.some(dom: {project: "Work", "due.before" => today})
+  #
+  # @example You can also pass in a TW style string if you prefer
+  #   tw.some(dom: "project:Work due.before:#{today}")
+  #
   module Controller
     extend self
 
@@ -56,7 +89,7 @@ module Rtasklib
     # @example filter by a dom query
     #   require "date"
     #   today = DateTime.now
-    #   # note that queries with dots need to be Strings, as they would be 
+    #   # note that queries with dots need to be Strings, as they would be
     #   # invalid Symbols
     #   tw.some(dom: {project: "Work", "due.before" => today})
     #   # You can also pass in a TW style string if you prefer
@@ -126,6 +159,9 @@ module Rtasklib
     # Mark the filter of tasks as started
     # Returns false if filter (ids:, tags:, dom:) is blank.
     #
+    # @example
+    #   tw.start!(ids: 1)
+    #
     # @param ids [Array<Range, Fixnum, String>, String, Range, Fixnum]
     # @param tags [Array<String>, String]
     # @param dom [Array<String>, String]

data/lib/rtasklib/version.rb

@@ -5,5 +5,5 @@
 
 module Rtasklib
   # The latest version of rtasklib
-  VERSION = "0.2.3-beta"
+  VERSION = "0.2.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rtasklib
 version: !ruby/object:Gem::Version
-  version: 0.2.3.pre.beta
+  version: 0.2.3
 platform: ruby
 authors:
 - Will Paul
@@ -221,9 +221,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements:
 - taskwarrior, >=2.4.0
 rubyforge_project: