doing 2.1.40 → 2.1.41

data/lib/doing/string/tags.rb

@@ -2,7 +2,7 @@
 
 module Doing
   # Handling of @tags in strings
-  class ::String
+  module StringTags
     ##
     ## Add @ prefix to string if needed, maintains +/- prefix
     ##
@@ -21,6 +21,17 @@ module Doing
       strip.sub(/^([+-]*)@?/, '\1')
     end
 
+    ##
+    ## Split a string of tags, remove @ symbols, with or
+    ## without @ symbols, with or without parenthetical
+    ## values
+    ##
+    ## @return     [Array] array of tags without @ symbols
+    ##
+    def split_tags
+      gsub(/ *, */, ' ').scan(/(@?(?:\S+(?:\(.+\)))|@?(?:\S+))/).map(&:first).map(&:remove_at).sort.uniq
+    end
+
     ##
     ## Convert a list of tags to an array. Tags can be with
     ## or without @ symbols, separated by any character, and
@@ -29,7 +40,7 @@ module Doing
     ## @return     [Array] array of tags including @ symbols
     ##
     def to_tags
-      arr = gsub(/ *, */, ' ').scan(/(@?(?:\S+(?:\(.+\)))|@?(?:\S+))/).map(&:first).sort.uniq.map(&:add_at)
+      arr = split_tags.map(&:add_at)
       if block_given?
         yield arr
       else
@@ -38,7 +49,7 @@ module Doing
     end
 
     ##
-    ## @brief      Adds tags to a string
+    ## Adds tags to a string
     ##
     ## @param      tags    [String or Array] List of tags to add. @ symbol optional
     ## @param      remove  [Boolean] remove tags instead of adding

data/lib/doing/string/transform.rb

@@ -4,7 +4,7 @@ module Doing
   ##
   ## String helpers
   ##
-  class ::String
+  module StringTransform
     # Compress multiple spaces to single space
     def compress
       gsub(/ +/, ' ').strip

data/lib/doing/string/truncate.rb

@@ -4,7 +4,7 @@ module Doing
   ##
   ## String truncation
   ##
-  class ::String
+  module StringTruncate
     ##
     ## Truncate to nearest word
     ##

data/lib/doing/string/url.rb

@@ -4,7 +4,7 @@ module Doing
   ##
   ## URL linking and formatting
   ##
-  class ::String
+  module StringURL
     ##
     ## Turn raw urls into HTML links
     ##

data/lib/doing/time.rb

@@ -3,18 +3,31 @@ module Doing
   ## Date helpers
   ##
   class ::Time
+    # Format time as a relative date. Dates from today get
+    # just a time, from the last week get a time and day,
+    # from the last year get a month/day/time, and older
+    # entries get month/day/year/time
+    #
+    # @return     [String] formatted date
+    #
     def relative_date
       if self > Date.today.to_time
         strftime('%_I:%M%P')
       elsif self > (Date.today - 6).to_time
         strftime('%a %_I:%M%P')
-      elsif self.year == Date.today.year || (self.year + 1 == Date.today.year && self.month > Date.today.month)
+      elsif year == Date.today.year || (year + 1 == Date.today.year && month > Date.today.month)
         strftime('%m/%d %_I:%M%P')
       else
         strftime('%m/%d/%y %_I:%M%P')
       end
     end
 
+    ##
+    ## Format seconds as a natural language string
+    ##
+    ## @param      seconds  [Integer] number of seconds
+    ##
+    ## @return [String] Date formatted as "X days, X hours, X minutes, X seconds"
     def humanize(seconds)
       s = seconds
       m = (s / 60).floor
@@ -32,6 +45,11 @@ module Doing
       output.join(', ')
     end
 
+    ##
+    ## Format date as "X hours ago"
+    ##
+    ## @return     [String] Formatted date
+    ##
     def time_ago
       if self > Date.today.to_time
         output = humanize(Time.now - self)

data/lib/doing/util_backup.rb

@@ -27,7 +27,7 @@ module Doing
       ##
       ## Delete all redo files
       ##
-      ## @param      limit  Maximum number of backups to retain
+      ## @param      filename  [String] The filename
       ##
       def clear_redo(filename)
         filename ||= Doing.setting('doing_file')
@@ -213,7 +213,7 @@ module Doing
       ## Writes a copy of the content to a dated backup file
       ## in a hidden directory
       ##
-      ## @param      content  The data to back up
+      ## @param      filename  [String] The filename
       ##
       def write_backup(filename = nil)
         Doing.logger.benchmark(:_write_backup, :start)

data/lib/doing/version.rb

@@ -1,3 +1,3 @@
 module Doing
-  VERSION = '2.1.40'
+  VERSION = '2.1.41'
 end