rtasklib 0.2.3.pre.alpha → 0.2.3.pre.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d73dfd0f7795471ff22d0e675bb015be0b310d5d
-  data.tar.gz: c84b7bbee308ddf892c2fe2bc0735149b6b5faee
+  metadata.gz: 6ea31920458cceb17a1ce39892a1ec2ae5d5174e
+  data.tar.gz: 0f4bc7d917dc78a366a2d10185845c937be0451c
 SHA512:
-  metadata.gz: fd9092ece5dec8a2ab6ba4d35b55ae4ba0056d3c0980cc132331fd5a2a5bba5d9da6101d7d6d70ecf21441236133cbf8d0f4a0d42e9d99a32705bf662addb76c
-  data.tar.gz: b7790852d3db6d6771980c32fa6a6eba55ec6939d7439a07c993cab9da880f92dc9896e806daba0c964b7e7f64c1fcec1662ee292f4a777fb2ff166979f2eb92
+  metadata.gz: 4cf37fe6283bb192b1f1333a08713c70787459b8faae75ff56c1f9a3c713cf1641e437b724a4499a9f7f13de741534f6b6240088668a5d07dccafe9532d5bc5e
+  data.tar.gz: 9f66f97b08122ffa14a3b7633c4fc6714dc02e67a97cda0cdb6ac7817aff71f0ef9f14fc50e45fb2f620153a01f86f181ae514c92c88a56024def52d415cbb3a

data/LICENSE.txt

@@ -1,6 +1,7 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Will Paul
+Copyright (c) 2015 Will Paul (whp3652@rit.edu)
+All rights reserved.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -10,6 +10,10 @@ A Ruby wrapper around the TaskWarrior command line tool.
 
 ## Installation
 
+### Using `bundle` or `gem`
+
+#### With Bundler
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -20,23 +24,75 @@ And then execute:
 
     $ bundle
 
+#### With Rubygems
+
 Or install it yourself as:
 
     $ gem install rtasklib
 
+With this method you will need to install TaskWarrior (version 2.4 or above) yourself.
+
+**On OSX:**
+    
+    $ brew install task
+
+**On Fedora:**
+
+    $ yum install task
+
+**On Debian/Ubuntu:**
+
+The major repos TaskWarrior packages are extremely outdated, so you will have to install from source. The following is what we're using to build on Travis CI, your mileage may vary:
+
+    $ sudo add-apt-repository ppa:ubuntu-toolchain-r/test -y
+    $ sudo apt-get update -qq
+    $ sudo apt-get install -qq build-essential cmake uuid-dev g++-4.8
+    $ sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-4.8 50
+    $ git clone https://git.tasktools.org/scm/tm/task.git
+    $ cd task
+    $ git checkout $TASK_VERSION
+    $ git clean -dfx
+    $ cmake .
+    $ make
+    $ sudo make install
+
+### Using the RPM
+
+If you are running Fedora there is an RPM available, this comes with the advantage of being managed by `yum` and installing TaskWarrior for you. Simply get the desired version RPM from the `pkg/` dir:
+
+    $ sudo yum install rubygem-rtasklib-VERSION.rpm
+
+### Configure TaskWarrior
+
+Once you install TaskWarrior a database still needs to be created, luckily this is as simple as running `task` and answer `yes` when it asks you about creating a `.taskrc` file.
+
+There is a small testing database in `spec/data/.task` if you would like to test on something other than you main TaskWarrior db. You can experiment with this by running:
+
+```
+$ ./bin/console
+```
+
+Which returns an interactive Pry Ruby session with the variable `tw` already initialized to a `Rtasklib::TW` instance with the test database. Changes to the database aren't tracked so don't worry about merge conflicts if you plan on contributing.
+
 
 ## Dependencies
 
-* Taskwarrior > 2.4 (require custom UDAs, recurrences, and duration data types)
+* Ruby > 2.0 (Uses keyword args)
+
+* TaskWarrior > 2.4, require custom UDAs, recurrences, and duration data types (MIT license)
+
+* ISO8601 gem, for dealing with duration and datetimes from TaskWarrior (MIT license)
+
+* Virtus gem, for simple Ruby object based domain modeling (TaskModel and TaskrcModel) (MIT license)
 
-* Ruby > 2.1 (Because default keyword arguments are too hard to live without :) )
+* multi_json gem, for parsing JSON objects (MIT license)
 
-* See `./rtasklib.gemspec` for the latest Ruby dependencies
+* See `./rtasklib.gemspec` to verify the latest Ruby dependencies
 
 
 ## Usage
 
-```
+```ruby
 require 'rtasklib'
 
 tw = Rtasklib::TW.new('../path/to/.task')
@@ -44,7 +100,23 @@ tw = Rtasklib::TW.new('../path/to/.task')
 # do some stuff with the task database
 # available commands are documented in the Controller class
 
-tw.all
+tasks = tw.all
+#=> returns an array of TaskModels
+
+tasks.first.description
+#=> "An example task"
+
+tasks[-1].due
+#=> #<DateTime: 2015-03-16T17:48:23+00:00 ((2457098j,64103s,0n),+0s,2299161j)>
+
+tw.some(ids: [1..5, 10]).size
+#=> 6
+
+tw.done!(ids: 5)
+#=> 0
+
+tw.some(ids: [1..5, 10]).size
+#=> 5
 ```
 
 [Controller docs](http://will-paul.com/rtasklib/Rtasklib/Controller.html)

data/bin/env

@@ -9,4 +9,4 @@ require "bundler/setup"
 require_relative "../lib/rtasklib"
 require "pry"
 
-Pry.start
+binding.pry

data/lib/rtasklib.rb

@@ -1,3 +1,8 @@
+# Copyright (c) 2015 Will Paul (whp3652@rit.edu)
+# All rights reserved.
+#
+# This file is distributed under the MIT license. See LICENSE.txt for details.
+
 require_relative "rtasklib/version"
 require_relative "rtasklib/models"
 require_relative "rtasklib/execute"
@@ -7,24 +12,89 @@ require_relative "rtasklib/taskrc"
 
 require "pathname"
 
+# Top level namespace for all `rtasklib` functionality
 module Rtasklib
 
+  # To interact with the TaskWarrior database simply instantiate this with a
+  # path to the .task folder where data is stored. If left out it will look
+  # for a database in the default location `~/.task`
+  #
+  # Optionally pass in a hash of taskrc options to override what is in your
+  # .taskrc on every command. By default `rtasklib` provides a set of sensible
+  # defaults:
+  #
+  # @example
+  #   # Use the default path and overrides
+  #   tw = Rtasklib::TaskWarrior.new
+  #   # TaskWarrior is also available aliased as TW:
+  #   tw = Rtasklib::TW.new
+  #   # Custom path, in this case the test db in spec/
+  #   tw = Rtasklib::TW.new("./spec/data/.task")
+  #   # Custom override, in this case calling the gc everytime
+  #   # This will change id numbers whenever the task list changes
+  #   # By default this is off, but may have some performance implications.
+  #   tw = Rtasklib::TW.new(opts={gc: "on"})
+  #
+  # @example
+  #   DEFAULTS = {
+  #     json_array:              'true',
+  #     verbose:                 'nothing',
+  #     gc:                      'off',
+  #     confirmation:            'no',
+  #     dependency_confirmation: 'no',
+  #     exit_on_missing_db:      'yes', }
+  #
+  # These of course can be overridden with opts param as well
+  #
+  # In general `rtasklib` is only feature complete on TaskWarrior installs 2.4
+  # and greater and it will warn you if yours is lower or can't be determined,
+  # but will still allow you to interact with it. Proceed at your own risk.
+  #
+  # @!attribute [r] version
+  #   @return [Gem::Version] The version of the current TaskWarrior install
+  # @!attribute [r] data_location
+  #   @return [String] The file path that you passed in at initialization
+  # @!attribute [r] taskrc
+  #   @return [Rtasklib::Taskrc] Your current TaskWarrior configuration
+  # @!attribute [r] udas
+  #   @return [Hash{Symbol=>Hash}] Currently configured User Defined Attributes
+  # @!attribute [r] override
+  #   @return [Rtasklib::Taskrc] The options to override the default .taskrc
+  # @!attribute [r] override_a
+  #   @return [Array] override in array form, useful for passing to shell
+  # @!attribute [r] override_str
+  #   @return [String] override in string form, useful for passing to shell
   class TaskWarrior
     attr_reader :version, :data_location, :taskrc, :udas,
                 :override, :override_a, :override_str
 
     include Controller
 
+    # Sane defaults to override a base .taskrc
     DEFAULTS = {
+      # Wrap export objects in an array? Disabling this will break Rtasklib
+      # functionality
       json_array:              'true',
+      # Stop writing user friendly methods. Disabling this will break Rtasklib
+      # functionality
       verbose:                 'nothing',
+      # Call the gc on every execution. This will change id numbers whenever the
+      # task list changes. By default this is off, but may have some
+      # performance implications.
       gc:                      'off',
+      # Will ask for confirmation before we do anything TaskWarrior decides is
+      # dangerous. We handle most of these cases in Rtasklib.
       confirmation:            'no',
       dependency_confirmation: 'no',
+      # If it can't find a TaskWarrior db just exit.
       exit_on_missing_db:      'yes', }
 
+    # Lowest supported TaskWarrior version
     LOWEST_VERSION = Gem::Version.new('2.4.0')
 
+    # @param data [String, Pathname] path to the .task database
+    # @param opts [Hash] overrides to the .taskrc to run on each command
+    # @api public
     def initialize data="#{Dir.home}/.task", opts = {}
       # Check TaskWarrior version, and throw warning if unavailable
       begin
@@ -42,6 +112,13 @@ module Rtasklib
       add_udas_to_model!(udas) unless udas.nil?
     end
 
+    # Check the state of the TaskWarrior install. Either pass a Gem::Version
+    # representation passed to the version param or call with no args for
+    # it to make a call to the shell to figure that out itself.
+    #
+    # @param version [Gem::Version, nil] version to check
+    # @return [Gem::Version]
+    # @api public
     def check_version version=nil
       version = get_version if version.nil?
       if version < LOWEST_VERSION
@@ -51,6 +128,6 @@ module Rtasklib
     end
   end
 
-  # Add a convenience alias
+  # Add a convenience alias to Rtasklib::TaskWarrior => Rtasklib:TW
   TW = TaskWarrior
 end

data/lib/rtasklib/controller.rb

@@ -1,21 +1,35 @@
+# Copyright (c) 2015 Will Paul (whp3652@rit.edu)
+# All rights reserved.
+#
+# This file is distributed under the MIT license. See LICENSE.txt for details.
+
 require "multi_json"
-require "active_support/core_ext/object/blank"
 
 module Rtasklib
 
   # Accessed through the main TW, which includes this module, e.g. `tw.all`
   #
-  # Ideally should only be the well documented public, user-facing methods.
-  # We're getting there.
+  # This module contains the public, user-facing methods.
   #
   # By convention bang methods modify the task database, and non-bang read
   # from the database, e.g. `Controller#all` vs `Controller#modify!`
   #
-  # XXX: depends on @override_a currently, which isn't great.
+  # Changes to the config are not effected by #undo!
+  #
+  # XXX: depends on TaskWarrior#override_a currently, which isn't great.
   module Controller
     extend self
 
-    # Retrieves the current task list from the TW database
+    # Retrieves the current task list from the TaskWarrior database. Defaults
+    # to just show active (waiting & pending) tasks, which is usually what is
+    # exposed to the end user through the default reports. To see everything
+    # including completed, deleted, and parent recurring tasks, set
+    # `active: false`. For more granular control see Controller#some.
+    #
+    # @example
+    #   tw.all.count #=> 200
+    #   tw.all(active: true) #=> 200
+    #   tw.all(active: false) #=> 578
     #
     # @param active [Boolean] return only pending & waiting tasks
     # @return [Array<Models::TaskModel>]
@@ -37,16 +51,28 @@ module Rtasklib
     #   tw.some(ids: [1..2, 5])
     # @example filter by tags
     #   tw.some(tags: ["+school", "or", "-work"]
+    #   # You can also pass in a TW style string if you prefer
+    #   tw.some(tags: "+school or -work"]
+    # @example filter by a dom query
+    #   require "date"
+    #   today = DateTime.now
+    #   # 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
+    #   tw.some(dom: "project:Work due.before:#{today}")
     #
     # @param ids [Array<Range, Fixnum, String>, String, Range, Fixnum]
     # @param tags [Array<String>, String]
     # @param dom [Array<String>, String]
+    # @param active [Boolean] return only pending & waiting tasks
     # @return [Array<Models::TaskModel>]
     # @api public
-    def some ids: nil, tags: nil, dom: nil
+    def some ids: nil, tags: nil, dom: nil, active: true
       some = []
       f = Helpers.filter(ids: ids, tags: tags, dom: dom)
-      Execute.task_popen3(*@override_a, f, "export") do |i, o, e, t|
+      a = Helpers.pending_or_waiting(active)
+      Execute.task_popen3(*@override_a, f, a, "export") do |i, o, e, t|
         some = MultiJson.load(o.read).map do |x|
           Rtasklib::Models::TaskModel.new(x)
         end
@@ -54,15 +80,18 @@ module Rtasklib
       return some
     end
 
-    # Add a single task to the database
+    # Count the number of tasks that match a given filter. Faster than counting
+    # an array returned by Controller#all or Controller#some.
     #
     # @param ids [Array<Range, Fixnum, String>, String, Range, Fixnum]
     # @param tags [Array<String>, String]
     # @param dom [Array<String>, String]
+    # @param active [Boolean] return only pending & waiting tasks
     # @api public
-    def count ids: nil, tags: nil, dom: nil
+    def count ids: nil, tags: nil, dom: nil, active: true
       f = Helpers.filter(ids: ids, tags: tags, dom: dom)
-      Execute.task_popen3(*@override_a, f, "count") do |i, o, e, t|
+      a = Helpers.pending_or_waiting(active)
+      Execute.task_popen3(*@override_a, f, a, "count") do |i, o, e, t|
         return Integer(o.read)
       end
     end
@@ -72,7 +101,7 @@ module Rtasklib
     # Calls `task _show` with initial overrides returns a Taskrc object of the
     # result
     #
-    # @return [Taskrc]
+    # @return [Rtasklib::Taskrc]
     # @api public
     def get_rc
       res = []
@@ -97,12 +126,19 @@ module Rtasklib
     # Mark the filter of tasks as started
     # Returns false if filter (ids:, tags:, dom:) is blank.
     #
+    # @param ids [Array<Range, Fixnum, String>, String, Range, Fixnum]
+    # @param tags [Array<String>, String]
+    # @param dom [Array<String>, String]
+    # @param active [Boolean] return only pending & waiting tasks
+    # @return [Process::Status, False] the exit status of the thread or false
+    #   if it exited early because filter was blank.
     # @api public
-    def start! ids: nil, tags: nil, dom: nil
+    def start! ids: nil, tags: nil, dom: nil, active: true
       f = Helpers.filter(ids: ids, tags: tags, dom: dom)
+      a = Helpers.pending_or_waiting(active)
       return false if f.blank?
 
-      Execute.task_popen3(*@override_a, f, "start") do |i, o, e, t|
+      Execute.task_popen3(*@override_a, f, a, "start") do |i, o, e, t|
         return t.value
       end
     end
@@ -110,12 +146,19 @@ module Rtasklib
     # Mark the filter of tasks as stopped
     # Returns false if filter (ids:, tags:, dom:) is blank.
     #
+    # @param ids [Array<Range, Fixnum, String>, String, Range, Fixnum]
+    # @param tags [Array<String>, String]
+    # @param dom [Array<String>, String]
+    # @param active [Boolean] return only pending & waiting tasks
+    # @return [Process::Status, False] the exit status of the thread or false
+    #   if it exited early because filter was blank.
     # @api public
-    def stop! ids: nil, tags: nil, dom: nil
+    def stop! ids: nil, tags: nil, dom: nil, active: true
       f = Helpers.filter(ids: ids, tags: tags, dom: dom)
+      a = Helpers.pending_or_waiting(active)
       return false if f.blank?
 
-      Execute.task_popen3(*@override_a, f, "stop") do |i, o, e, t|
+      Execute.task_popen3(*@override_a, f, a, "stop") do |i, o, e, t|
         return t.value
       end
     end
@@ -126,6 +169,7 @@ module Rtasklib
     # @param description [String] the required desc of the task
     # @param tags [Array<String>, String]
     # @param dom [Array<String>, String]
+    # @return [Process::Status] the exit status of the thread
     # @api public
     def add! description, tags: nil, dom: nil
       f = Helpers.filter(tags: tags, dom: dom)
@@ -144,29 +188,35 @@ module Rtasklib
     # @param ids [Array<Range, Fixnum, String>, String, Range, Fixnum]
     # @param tags [Array<String>, String]
     # @param dom [Array<String>, String]
+    # @param active [Boolean] return only pending & waiting tasks
+    # @return [Process::Status] the exit status of the thread
     # @api public
-    def modify! attr, val, ids: nil, tags: nil, dom: nil
+    def modify! attr, val, ids: nil, tags: nil, dom: nil, active: true
       f = Helpers.filter(ids: ids, tags: tags, dom: dom)
+      a = Helpers.pending_or_waiting(active)
       return false if f.blank?
 
-      query = "#{f} modify #{attr} #{val}"
+      query = "#{f} #{a} modify #{attr}:#{val}"
       Execute.task_popen3(*override_a, query) do |i, o, e, t|
         return t.value
       end
     end
 
-    # Finishes the filtered tasks
+    # Finishes the filtered tasks.
     # Returns false if filter (ids:, tags:, dom:) is blank.
     #
     # @param ids [Array<Range, Fixnum, String>, String, Range, Fixnum]
     # @param tags [Array<String>, String]
     # @param dom [Array<String>, String]
+    # @param active [Boolean] return only pending & waiting tasks
+    # @return [Process::Status] the exit status of the thread
     # @api public
-    def done! ids: nil, tags: nil, dom: nil
+    def done! ids: nil, tags: nil, dom: nil, active: true
       f = Helpers.filter(ids: ids, tags: tags, dom: dom)
+      a = Helpers.pending_or_waiting(active)
       return false if f.blank?
 
-      Execute.task_popen3(*override_a, f, "done") do |i, o, e, t|
+      Execute.task_popen3(*override_a, f, a, "done") do |i, o, e, t|
         return t.value
       end
     end
@@ -176,12 +226,15 @@ module Rtasklib
     # @param ids [Array<Range, Fixnum, String>, String, Range, Fixnum]
     # @param tags [Array<String>, String]
     # @param dom [Array<String>, String]
+    # @param active [Boolean] return only pending & waiting tasks
+    # @return [Process::Status] the exit status of the thread
     # @api public
-    def delete! ids: nil, tags: nil, dom: nil
+    def delete! ids: nil, tags: nil, dom: nil, active: true
       f = Helpers.filter(ids: ids, tags: tags, dom: dom)
+      a = Helpers.pending_or_waiting(active)
       return false if f.blank?
 
-      Execute.task_popen3(*override_a, f, "delete") do |i, o, e, t|
+      Execute.task_popen3(*override_a, f, a, "delete") do |i, o, e, t|
         return t.value
       end
     end
@@ -219,6 +272,7 @@ module Rtasklib
     #
     # @param attr [String]
     # @param val [String]
+    # @return [Process::Status] the exit status of the thread
     # @api public
     def update_config! attr, val
       Execute.task_popen3(*override_a, "config #{attr} #{val}") do |i, o, e, t|
@@ -286,6 +340,20 @@ module Rtasklib
       update_config("uda.#{name}.urgency", urgency) unless urgency.nil?
     end
 
+    # Sync the local TaskWarrior database changes to the remote databases.
+    # Remotes need to be configured in the .taskrc.
+    #
+    # @example
+    #   # make some local changes with add!, modify!, or the like
+    #   tw.sync!
+    #
+    # @return [Process::Status] the exit status of the thread
+    # @api public
+    def sync!
+      Execute.task_popen3(*override_a, "sync") do |i, o, e, t|
+        return t.value
+      end
+    end
 
     # TODO: implement and test convenience methods for modifying tasks
     #

data/lib/rtasklib/execute.rb

@@ -1,3 +1,8 @@
+# Copyright (c) 2015 Will Paul (whp3652@rit.edu)
+# All rights reserved.
+#
+# This file is distributed under the MIT license. See LICENSE.txt for details.
+
 require "open3"
 
 module Rtasklib
@@ -7,17 +12,9 @@ module Rtasklib
     # so that the methods are available within the modules lookup path
     extend self
 
+    # When true writes all shell commands to STDERR
     DEBUG = false
 
-    # Turned off confirmations, so this regex is deprecated
-    # This also means we have to handle that all ourselves
-    # For example warn user with bang methods.
-    #
-    # @@exp_regex = {
-    #   create_rc: %r{Would \s you \s like \s a \s sample \s *.+ \s created, \s
-    #                 so \s taskwarrior \s can \s proceed\? \s
-    #                 \(yes/no\)}x }
-
     # Use Open3#popen3 to execute a unix program with an array of options
     # and an optional block to handle the response.
     #

data/lib/rtasklib/helpers.rb

@@ -1,5 +1,27 @@
+# Copyright (c) 2015 Will Paul (whp3652@rit.edu)
+# All rights reserved.
+#
+# This file is distributed under the MIT license. See LICENSE.txt for details.
+
 require "multi_json"
 
+# Monkey patching String, instead of importing ActiveSupport, bc its overkill
+# for what we were using it for
+class String
+  # Returns true for blank Strings
+  #
+  # @example
+  #   "".blank? #=> true
+  #   "  ".blank? #=> true
+  #   ".".blank? #=> false
+  #
+  # @return [Boolean]
+  # @api public
+  def blank?
+    self.strip.empty?
+  end
+end
+
 module Rtasklib
 
   # A collection of stateless, non-end-user facing functions available
@@ -89,8 +111,10 @@ module Rtasklib
       end
     end
 
-    # Ensures that a tag begins with a + or -
+    # Ensures that a tag begins with a + or - or is one of the operational
+    # operators `and or xor < <= = != >=  > ( )`
     #
+    # @param tag [String]
     # @return [String]
     # @api public
     def process_tag tag
@@ -185,7 +209,6 @@ module Rtasklib
     # Doesn't detect arrays, b/c task stores these as comma separated strings
     # which could just as easily be Strings....
     # If nothing works it defaults to String.
-    # TODO: JSON parse
     #
     # @param value [Object] anything that needs to be coerced, probably string
     # @return [Axiom::Types::Boolean, Integer, Float, String]

data/lib/rtasklib/models.rb

@@ -1,7 +1,14 @@
+# Copyright (c) 2015 Will Paul (whp3652@rit.edu)
+# All rights reserved.
+#
+# This file is distributed under the MIT license. See LICENSE.txt for details.
+
 require "virtus"
 require 'iso8601'
 require 'date'
 
+# Module that holds all domain model related functionality.
+# Primarily Taskrc and TaskModel representations.
 module Rtasklib::Models
 
   # A subclass of the ISO8601::Duration object that use `task calc` to parse
@@ -19,13 +26,20 @@ module Rtasklib::Models
     end
   end
 
-  # Custom coercer to change a string input into an TWDuration object
+  # Custom coercer that changes a string input into an TWDuration object
+  # If nil? or blank? it returns nil
+  # 
+  # Modifies the #coerce method.
   class VirtusDuration < Virtus::Attribute
+    # @param [Object] any value that we are trying to coerce, probably String
+    # @return [TWDuration, nil]
     def coerce(v)
       if v.nil? || v.blank? then nil else TWDuration.new(v) end
     end
   end
 
+  # Allows us to treat the strings "on", "off", "no", "yes" as Booleans,
+  # Which is how TaskWarrior does it.
   RcBooleans = Virtus.model do |mod|
     mod.coerce = true
     mod.coercer.config.string.boolean_map = {
@@ -33,18 +47,23 @@ module Rtasklib::Models
       'no'  => false, 'off' => false }
   end
 
+  # A base Virtus model whose attributes are created dynamically based on the
+  # given attributes are read from a .taskrc or Hash
+  #
+  # attr_accessors are available for all attributes, and more can be added
+  # See Rtasklib::Controller for methods to do this
   class TaskrcModel
-    # A base Virtus model whose attributes are created dynamically based on the
-    # given attributes are read from a .taskrc or Hash
-    #
-    # Dynamically add convert Boolean Strings to Ruby's Boolean values
+    # Dynamically add attrs that use Boolean Strings to Ruby's Boolean values
     include RcBooleans
   end
 
+  # Defines a Virtus model for a single task, defining the data types for all
+  # the default attributes
+  #
   class TaskModel
     include Virtus.model
-    # perhaps use Veto
-    # include ActiveModel::Validations
+    # TODO: perhaps use Veto to validate these, if we ever implement mutable
+    # changes, e.g. task_model.save!
 
     # Default attributes from TW
     # Should match: http://taskwarrior.org/docs/design/task.html

data/lib/rtasklib/taskrc.rb

@@ -1,3 +1,8 @@
+# Copyright (c) 2015 Will Paul (whp3652@rit.edu)
+# All rights reserved.
+#
+# This file is distributed under the MIT license. See LICENSE.txt for details.
+
 require "virtus"
 require "enumerator"
 
@@ -5,8 +10,13 @@ module Rtasklib
 
   # A class that wraps a single Virtus domain model with a number of creation
   # and manipulation methods
+  #
+  # Intialize with either a hash of attribute value pairs or a Pathname
+  # to the raw taskrc file to read.
+  #
+  # @!attribute [rw] config
+  #   @return [Models::TaskrcModel] a custom Virtus domain model
   class Taskrc
-    # @attr config [Models::TaskrcModel] a custom Virtus domain model
     attr_accessor :config
 
     # Generate a dynamic Virtus model, with the attributes defined by the input
@@ -154,6 +164,8 @@ module Rtasklib
       config.send("#{attr.to_s}".to_sym)
     end
 
+    # Convert dot notation to Symbol safe underscores
+    #
     # @param attr [String] the name for the attr, e.g. "json_array"
     # @return [String]
     # @api private
@@ -162,6 +174,8 @@ module Rtasklib
     end
     private :get_hash_attr_from_rc
 
+    # Convert Symbol safe underscores to dot notation
+    #
     # @param attr [String] the name for the attr, e.g. "json_array"
     # @return [String]
     # @api private

data/lib/rtasklib/version.rb

@@ -1,3 +1,9 @@
+# Copyright (c) 2015 Will Paul (whp3652@rit.edu)
+# All rights reserved.
+#
+# This file is distributed under the MIT license. See LICENSE.txt for details.
+
 module Rtasklib
-  VERSION = "0.2.3-alpha"
+  # The latest version of rtasklib
+  VERSION = "0.2.3-beta"
 end

data/rtasklib.gemspec

@@ -21,7 +21,6 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.0'
   spec.requirements << 'taskwarrior, >=2.4.0'
 
-  spec.add_dependency "activesupport", "~> 4"
   spec.add_dependency "multi_json", "~> 1.7"
   spec.add_dependency "virtus", "~> 1.0"
   spec.add_dependency "iso8601", "~> 0.8"

data/spec/controller_spec.rb

@@ -1,3 +1,8 @@
+# Copyright (c) 2015 Will Paul (whp3652@rit.edu)
+# All rights reserved.
+#
+# This file is distributed under the MIT license. See LICENSE.txt for details.
+
 require 'spec_helper'
 
 describe Rtasklib::Controller do

data/spec/execute_spec.rb

@@ -1,2 +1,7 @@
+# Copyright (c) 2015 Will Paul (whp3652@rit.edu)
+# All rights reserved.
+#
+# This file is distributed under the MIT license. See LICENSE.txt for details.
+
 require 'spec_helper'
 

data/spec/helpers_spec.rb

@@ -1,3 +1,8 @@
+# Copyright (c) 2015 Will Paul (whp3652@rit.edu)
+# All rights reserved.
+#
+# This file is distributed under the MIT license. See LICENSE.txt for details.
+
 require 'spec_helper'
 
 describe Rtasklib::Helpers do

data/spec/models_spec.rb

@@ -1,3 +1,8 @@
+# Copyright (c) 2015 Will Paul (whp3652@rit.edu)
+# All rights reserved.
+#
+# This file is distributed under the MIT license. See LICENSE.txt for details.
+
 require 'spec_helper'
 require 'rtasklib/models'
 

data/spec/rtasklib_spec.rb

@@ -1,3 +1,8 @@
+# Copyright (c) 2015 Will Paul (whp3652@rit.edu)
+# All rights reserved.
+#
+# This file is distributed under the MIT license. See LICENSE.txt for details.
+
 require 'spec_helper'
 
 describe Rtasklib do

data/spec/spec_helper.rb

@@ -1,5 +1,10 @@
+# Copyright (c) 2015 Will Paul (whp3652@rit.edu)
+# All rights reserved.
+#
+# This file is distributed under the MIT license. See LICENSE.txt for details.
+
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'coveralls'
+
 Coveralls.wear!
 require 'rtasklib'
-

data/spec/taskrc_spec.rb

@@ -1,3 +1,8 @@
+# Copyright (c) 2015 Will Paul (whp3652@rit.edu)
+# All rights reserved.
+#
+# This file is distributed under the MIT license. See LICENSE.txt for details.
+
 require 'spec_helper'
 
 describe Rtasklib::Taskrc do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rtasklib
 version: !ruby/object:Gem::Version
-  version: 0.2.3.pre.alpha
+  version: 0.2.3.pre.beta
 platform: ruby
 authors:
 - Will Paul
@@ -10,20 +10,6 @@ bindir: exe
 cert_chain: []
 date: 2015-05-18 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -208,8 +194,6 @@ files:
 - lib/rtasklib/taskrc.rb
 - lib/rtasklib/version.rb
 - rtasklib.gemspec
-- rubygem-rtasklib.spec
-- rubygem-rtasklib.spec.template
 - spec/controller_spec.rb
 - spec/data/.task/backlog.data
 - spec/data/.task/completed.data

data/rubygem-rtasklib.spec

@@ -1,71 +0,0 @@
-# Generated from rtasklib-0.2.1.gem by gem2rpm -*- rpm-spec -*-
-%define rbname rtasklib
-%define version 0.2.1
-%define release 1
-
-Summary: A Ruby wrapper around the TaskWarrior CLI
-Name: ruby-gems-%{rbname}
-
-Version: %{version}
-Release: %{release}
-Group: Development/Ruby
-License: MIT
-URL: http://github.com/dropofwill/rtasklib
-Source0: %{rbname}-%{version}.gem
-# Make sure the spec template is included in the SRPM
-Source1: ruby-gems-%{rbname}.spec.in
-BuildRoot: %{_tmppath}/%{name}-%{version}-root
-Requires: ruby >= 2
-Requires: ruby-gems >= 2
-Requires: ruby-gems-virtus 
-Requires: ruby-gems-activesupport 
-Requires: ruby-gems-activemodel 
-Requires: ruby-gems-active_model_serializers 
-Requires: ruby-gems-oj 
-Requires: ruby-gems-multi_json 
-Requires: ruby-gems-iso8601 
-Requires: ruby-gems-bundler => 1.8
-Requires: ruby-gems-bundler < 2
-Requires: ruby-gems-rake => 10.0
-Requires: ruby-gems-rake < 11
-Requires: ruby-gems-coveralls 
-Requires: ruby-gems-rspec 
-Requires: ruby-gems-rspec-nc 
-Requires: ruby-gems-guard 
-Requires: ruby-gems-guard-rspec 
-Requires: ruby-gems-yard 
-BuildRequires: ruby >= 2
-BuildRequires: ruby-gems >= 2
-BuildArch: noarch
-Provides: ruby(Rtasklib) = %{version}
-
-%define gemdir /usr/share/gems
-%define gembuilddir %{buildroot}%{gemdir}
-
-%description
-A Ruby wrapper around the TaskWarrior CLI. Requires a TaskWarrior install
-version 2.4.0 of greater.
-
-
-%prep
-%setup -T -c
-
-%build
-
-%install
-%{__rm} -rf %{buildroot}
-mkdir -p %{gembuilddir}
-gem install --local --install-dir %{gembuilddir} --force %{SOURCE0}
-
-%clean
-%{__rm} -rf %{buildroot}
-
-%files
-%defattr(-, root, root)
-%{gemdir}/gems/rtasklib-0.2.1/
-
-%doc %{gemdir}/doc/rtasklib-0.2.1
-%{gemdir}/cache/rtasklib-0.2.1.gem
-%{gemdir}/specifications/rtasklib-0.2.1.gemspec
-
-%changelog

data/rubygem-rtasklib.spec.template

@@ -1,69 +0,0 @@
-# Generated from <%= package.spec.file_name %> by gem2rpm -*- rpm-spec -*-
-%define rbname <%= spec.name %>
-%define version <%= spec.version %>
-%define release 1
-
-Summary: <%= spec.summary %>
-Name: ruby-gems-%{rbname}
-
-Version: %{version}
-Release: %{release}
-Group: Development/Ruby
-License: MIT
-URL: <%= spec.homepage %>
-Source0: %{rbname}-%{version}.gem
-# Make sure the spec template is included in the SRPM
-Source1: ruby-gems-%{rbname}.spec.in
-BuildRoot: %{_tmppath}/%{name}-%{version}-root
-Requires: ruby <%= spec.required_ruby_version %>
-Requires: ruby-gems >= <%= Gem::RubyGemsVersion %>
-<% for d in spec.dependencies -%>
-<% for req in d.requirement -%>
-Requires: ruby-gems-<%= d.name %> <%= req %>
-<% end -%>
-<% end -%>
-BuildRequires: ruby <%= spec.required_ruby_version %>
-BuildRequires: ruby-gems >= <%= Gem::RubyGemsVersion %>
-BuildArch: noarch
-Provides: ruby(<%= spec.name.capitalize %>) = %{version}
-
-%define gemdir /usr/share/gems
-%define gembuilddir %{buildroot}%{gemdir}
-
-%description
-<%= spec.description %>
-
-%prep
-%setup -T -c
-
-%build
-
-%install
-%{__rm} -rf %{buildroot}
-mkdir -p %{gembuilddir}
-gem install --local --install-dir %{gembuilddir} --force %{SOURCE0}
-<% if ! spec.executables.empty? -%>
-mkdir -p %{buildroot}/%{_bindir}
-mv %{gembuilddir}/bin/* %{buildroot}/%{_bindir}
-rmdir %{gembuilddir}/bin
-<% end -%>
-
-%clean
-%{__rm} -rf %{buildroot}
-
-%files
-%defattr(-, root, root)
-<% for f in spec.executables -%>
-%{_bindir}/<%= f %>
-<% end -%>
-<% package.spec.files.each do |entry, data| -%>
-<%   path = entry['path'] -%>
-<%   doc_prefix = spec.extra_rdoc_files.include?(path) ? "%doc " : "" -%>
-<%= doc_prefix %>%{gemdir}/gems/<%= spec.name %>-<%= spec.version %>/<%= path %>
-<% end %>
-
-%doc %{gemdir}/doc/<%= spec.name %>-<%= spec.version %>
-%{gemdir}/cache/<%= package.spec.file_name %>
-%{gemdir}/specifications/<%= package.spec.file_name %>spec
-
-%changelog