time_tree 2.1.0 → 2.2.1

data/README.md

@@ -8,26 +8,26 @@ Timetree is a command line utility that prints a tree-like breakdown of time spe
 
 ## Time Log Format
 
-Each day's log should start with a date in YYYY/MM/DD format. Any text following is ignored as comments. Following this are lines starting with a time in 24 hour format - HHMI, followed by an activity which must contain no spaces, any text following is ignored and considered as comments. Activities may have nested subcategories to any level separated by forward slashes - these will be printed as a hierarchy by timetree. Use a dash (-) for the activity to be ignored and not reported on - this means a day's log must always end with a time followed by a dash to denote when the previous line's activity finished.
+Each day's log should start with a date in YYYY/MM/DD format. Any text following is ignored. Following this are lines starting with a time in 24 hour format - HHMI, followed by an activity which must contain no spaces, any text following can be free form and is treated as a description. Activities may have nested subcategories to any level separated by forward slashes - these will be printed as a hierarchy by timetree. Use a dash (-) for the activity to be ignored and not reported on - this means a day's log must always end with a time followed by a dash to denote when the previous line's activity finished.
 
-Blank lines are ignored and lines starting with # are ignored as comments.
+Blank lines are ignored. Sequences starting with # to the end of the line are ignored as comments.
 
 Here's an example:
 
-    2013/04/21 A splendid day!
+    2013/04/21 A splendid day! This text after the date will be ignored
     
-    0930 admin some comments
-    0945 development/project1 some more comments
+    0930 admin This is a description
+    0945 development/project1 Some more descriptive text
     1005 -
     1030 developemnt/project2
     1115 -
     
-    # Did some work in the evening!
-    2230 bugfixing/project3  # Use a hash after a time line if you want but not needed
+    # Did some work in the evening! This is a comment that will be ignored
+    2230 bugfixing/project3 a description   # This will be ignored because it's a comment
     2315 -
 
 
-A day's log can't span across more than one file, but a file may contain multiple day's logs. This gives flexibility, all time may be stored in one big file or there may be multiple files, one for each day or week for example. Multiple files may be stored in a nested folder hierarchy - time tree will recursively search for files, ignoring those starting with . (dot).
+A day's log can not span across more than one file, but a file may contain multiple day's logs. This gives flexibility, all time may be stored in one big file or there may be multiple files, one for each day or week for example. Multiple files may be stored in a nested folder hierarchy - time tree will recursively search for files, ignoring those starting with . (dot).
 
 ## Usage
 

data/fixtures/time/jun1.txt

@@ -1,3 +1,3 @@
 1975/06/01
-1200 jun1stuff
+1200 jun1stuff jun1
 1201 -

data/fixtures/time/jun2.txt

@@ -1,3 +1,3 @@
 1975/06/02
-1100 jun2stuff
+1100 jun2stuff jun2
 1102 -

data/fixtures/time/jun3.txt

@@ -1,3 +1,3 @@
 1975/06/03
-1000 jun3stuff
+1000 jun3stuff jun3
 1003 -

data/lib/time_tree/activity_tree.rb

@@ -7,19 +7,21 @@ module TimeTree
       @output = []
     end
     
-    def load(activities, minutes, level = 0, target = @activities)
+    def load(activities, minutes, description, level = 0, target = @activities)
       activities.unshift 'All' if level == 0
       activity = activities.shift
-      target[activity] = {:minutes => 0, :children => {}} unless target[activity]
+      target[activity] = {:minutes => 0, :children => {}, :descriptions => []} unless target[activity]
       target[activity][:minutes] += minutes
-      load(activities, minutes, level+1, target[activity][:children]) if activities.any?
+      target[activity][:descriptions] << description if activities.size == 0 && description
+      load(activities, minutes, description, level+1, target[activity][:children]) if activities.any?
     end
     
     def process(level = 0, target = activities)
-      target.each do |activity, values|
-        output << "%-25s %4d min (%s)" % ["#{(1..level*2).to_a.map{' '}.join}#{activity}",
+      target.sort.each do |activity, values|
+        output << "%-25s %4d min (%s)  %s" % ["#{(1..level*2).to_a.map{' '}.join}#{activity}",
                                                 values[:minutes],
-                                                to_hrs_mins(values[:minutes])]
+                                                to_hrs_mins(values[:minutes]),
+                                                values[:descriptions].uniq.join(' - ')]
         process(level+1, values[:children]) if values[:children].any?
       end
     end

data/lib/time_tree/file_parser.rb

@@ -30,6 +30,7 @@ module TimeTree
       @date = date
       @prev_mins = nil
       @prev_activities = nil
+      @prev_comment = nil
     end
     
     def process_file(path)
@@ -65,12 +66,12 @@ module TimeTree
         set_date($1)
         true
 
-      when /^(\d\d\d\d) +([^ ]+) *.*$/
+      when /^(\d\d\d\d) +([-\w\/]+) *(.*)$/
         if minutes = mins($1)
           unless @prev_mins.nil?
             if minutes > @prev_mins
               if @prev_activities != '-' && selected?(@date, @prev_activities)
-                process_line(minutes, @prev_activities) 
+                process_line(minutes, @prev_activities, @prev_comment) 
               end
             else
               add_error(line, 'time does not advance')
@@ -79,7 +80,8 @@ module TimeTree
           end
            
           @prev_mins = minutes
-          @prev_activities = $2
+          @prev_activities = $2.strip
+          @prev_comment = $3.size > 0 ? $3 : nil
           true
         else
           false
@@ -122,9 +124,9 @@ module TimeTree
     
     private
 
-    def process_line(minutes, activities)
+    def process_line(minutes, activities, comment)
       duration = minutes - @prev_mins
-      @activity_tree.load(activities.split('/'), duration)
+      @activity_tree.load(activities.split('/'), duration, comment)
     end
 
     def mins(str)

data/lib/time_tree/version.rb

@@ -1,3 +1,3 @@
 module TimeTree
-  VERSION = "2.1.0"
+  VERSION = "2.2.1"
 end

data/spec/activity_tree_spec.rb

@@ -5,12 +5,14 @@ module TimeTree
     let(:tree) { ActivityTree.new }
 
     before do
-      tree.load(%w{foo bar baz}, 10)
-      tree.load(%w{foo bar bam}, 5)
-      tree.load(%w{blah}, 12)
+      tree.load(%w{foo bar baz}, 9, 'did baz')
+      tree.load(%w{foo bar baz}, 1, nil)
+      tree.load(%w{foo bar bam}, 5, 'did some bam')
+      tree.load(%w{blah}, 11, 'did serious blah')
+      tree.load(%w{blah}, 1, 'did more blah')
     end
       
-    it "should have 2 root activities" do  
+    it "All should have 2 root activities" do  
       tree.activities['All'][:children].size.should == 2
     end
     
@@ -18,6 +20,10 @@ module TimeTree
       tree.activities['All'][:children]['foo'][:minutes].should == 15
     end
 
+    it "foo should have no descriptions" do
+      tree.activities['All'][:children]['foo'][:descriptions].size.should == 0
+    end
+
     it "bar should have 15 mins" do
       tree.activities['All'][:children]['foo'][:children]['bar'][:minutes].should == 15
     end
@@ -26,6 +32,11 @@ module TimeTree
       tree.activities['All'][:children]['foo'][:children]['bar'][:children]['baz'][:minutes].should == 10
     end
 
+    it "baz should have 1 description" do
+      tree.activities['All'][:children]['foo'][:children]['bar'][:children]['baz'][:descriptions].size.should == 1
+      tree.activities['All'][:children]['foo'][:children]['bar'][:children]['baz'][:descriptions].first.should == 'did baz'
+    end
+
     it "bam should have 5 mins" do
       tree.activities['All'][:children]['foo'][:children]['bar'][:children]['bam'][:minutes].should == 5
     end
@@ -34,11 +45,18 @@ module TimeTree
       tree.activities['All'][:children]['blah'][:minutes].should == 12
     end
 
+    it "blah should have 2 descriptions" do
+      tree.activities['All'][:children]['blah'][:descriptions].size.should == 2
+      tree.activities['All'][:children]['blah'][:descriptions].first.should == 'did serious blah'
+      tree.activities['All'][:children]['blah'][:descriptions].last.should == 'did more blah'
+    end
+
     it "blah should have no children" do
       tree.activities['All'][:children]['blah'][:children].size.should == 0
     end
     
     it "should print" do
+      tree.process
       tree.print
     end
   end

data/spec/file_parser_spec.rb

@@ -42,7 +42,7 @@ module TimeTree
           parser.process_file(fixtures('time.txt')).should be_true
         end
 
-        it "calls process_line for each line of the file" do
+        it "calls parse_line for each line of the file" do
           parser.should_receive(:parse_line).exactly(3).times
           parser.process_file(fixtures('time.txt'))
         end
@@ -142,10 +142,16 @@ module TimeTree
           end
 
           it "calls ActivityTree#load after first line" do
-            tree.should_receive(:load).with(%w{adm foo bar}, 1).once
-            parser.parse_line("1634 adm/foo/bar dhffhkdhsdhjdf")
+            tree.should_receive(:load).with(%w{adm foo bar}, 1, 'blart flange').once
+            parser.parse_line("1634 adm/foo/bar blart flange")
             parser.parse_line("1635 -")
           end
+          
+          it "handles absent descriptions" do
+            tree.should_receive(:load).with(%w{adm foo bar}, 1, nil).once
+            parser.parse_line("1734 adm/foo/bar")
+            parser.parse_line("1735 -")
+          end
 
           it "flags invalid times" do
             parser.parse_line("2435 - df sdfsdg").should be_false

data/spec/integration_spec.rb

@@ -11,9 +11,9 @@ module TimeTree
       parser.process_file(fixtures('time'))
       tree.process
       tree.output[0].should =~ /All +6 min/
-      tree.output[1].should =~ /jun1stuff +1 min/
-      tree.output[2].should =~ /jun2stuff +2 min/
-      tree.output[3].should =~ /jun3stuff +3 min/
+      tree.output[1].should =~ /jun1stuff +1 min \(0:01\) +jun1/
+      tree.output[2].should =~ /jun2stuff +2 min \(0:02\) +jun2/
+      tree.output[3].should =~ /jun3stuff +3 min \(0:03\) +jun3/
       tree.output.size.should == 4
     end
     

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: time_tree
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-09 00:00:00.000000000 Z
+date: 2013-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec