worked 0.1.0 → 0.2.0

data/lib/worked/inputparser.rb

@@ -4,24 +4,14 @@ require 'worked/inputgrammar'
 
 class Treetop::Runtime::SyntaxNode
 
+  attr_reader :from, :to, :total
+
   # Remove all clutter ('hour', ':', etc) from the
   # time and turn into an integer
   def to_i
     text_value.gsub(/\D/, '').to_i
   end
 
-  def from
-    time_to_seconds_from_day(DateTime.now - total)
-  end
-
-  def to
-    time_to_seconds_from_day(DateTime.now)
-  end
-
-  def time_to_seconds_from_day t
-    t.hour.hours + t.min.minutes
-  end
-
   # Default value so we don't have to care whether
   # there really is a minute component
   def minutes
@@ -29,22 +19,44 @@ class Treetop::Runtime::SyntaxNode
   end
 end
 
+class InputGrammarParser
+  def initialize
+    @root = nil
+  end
+end
+
+class CannotParse < Exception ; end
+
 class InputParser
 
-  def self.parse source
+  def self.parse(source, now = DateTime.now)
 
-    root = InputGrammarParser.new.parse(source)
+    from, to, total, activity = parse_input source
 
-    from, to = root.time.from, root.time.to
+    from ||= time_in_seconds_from_day(now - total)
+    to   ||= time_in_seconds_from_day(now)
 
     if from > to
       from -= 24.hours
     end
 
-    now      = DateTime.now
     midnight = DateTime.new(now.year, now.month, now.day)
 
-    [midnight + from.seconds, midnight + to.seconds, root.activity.text_value]
+    [midnight + from.seconds, midnight + to.seconds, activity]
+  end
+
+  private
+
+  def self.parse_input source
+    root = InputGrammarParser.new.parse(source)
+
+    raise CannotParse unless root
+
+    [root.time.from, root.time.to, root.time.total, root.activity.text_value]
+  end
+
+  def self.time_in_seconds_from_day t
+    t.hour.hours + t.min.minutes
   end
 end
 

data/lib/worked/reader.rb

@@ -0,0 +1,74 @@
+require 'worked/inputparser'
+
+class Date
+  def week_of_year
+    strftime("%U").to_i + 1
+  end
+end
+
+module Worked
+
+  class Entry < Struct.new(:hours, :date)
+    def week_of_year
+      date.week_of_year
+    end
+
+    def <=> other
+      self.date <=> other.date
+    end
+  end
+
+  class Reader
+
+    def self.by_week data
+      sort create_entries merge_by_week read_all_entries data
+    end
+
+    def self.read data
+      sort create_entries merge_by_day read_all_entries data
+    end
+
+    private
+
+    def self.extract_times line
+      from, to, rest = line.split
+
+      [DateTime.parse(from), DateTime.parse(to)]
+    end
+
+    def self.read_all_entries data
+      data.to_a.collect do |line|
+        from, to = extract_times line
+        Entry.new((to - from) * 24, from.to_date)
+      end
+    end
+
+    def self.merge_by_week entries
+      merge_entries(entries) {|e| e.week_of_year}
+    end
+
+    def self.merge_by_day entries
+      merge_entries(entries) {|e| e.date}
+    end
+
+    def self.merge_entries entries
+      merged = Hash.new(0)
+
+      entries.each do |entry|
+        merged[yield(entry)] += entry.hours
+      end
+
+      merged
+    end
+
+    def self.create_entries entries
+      entries.collect do |date, hours|
+        Entry.new(hours, date)
+      end
+    end
+
+    def self.sort entries
+      entries.sort
+    end
+  end
+end

data/tasks/parser_generate.rake

@@ -0,0 +1,4 @@
+desc 'Generate Treetop Parser'
+task :parser_generate do
+  sh %{ tt lib/worked/inputgrammar.treetop }
+end

data/test/test_grammar.rb

@@ -3,34 +3,34 @@ require File.dirname(__FILE__) + '/test_helper.rb'
 class TestGrammar < Test::Unit::TestCase
 
   def test_hours
-    assert_equal 5, hours("5 hours")
-    assert_equal 5, hours("5hours")
-    assert_equal 5, hours("5 h")
-    assert_equal 5, hours("5h")
-    assert_equal 5, hours("5")
+    assert_equal 5.hours, hours("5 hours")
+    assert_equal 5.hours, hours("5hours")
+    assert_equal 5.hours, hours("5 h")
+    assert_equal 5.hours, hours("5h")
+    assert_equal 5.hours, hours("5")
   end
 
   def test_minutes
-    assert_equal 10, minutes("5 h 10 minutes")
-    assert_equal 10, minutes("5 h 10 m")
-    assert_equal 10, minutes("5 h 10m")
-    assert_equal 10, minutes("5h10m")
-    assert_equal 10, minutes("5:10")
+    assert_equal 10.minutes, minutes("5 h 10 minutes")
+    assert_equal 10.minutes, minutes("5 h 10 m")
+    assert_equal 10.minutes, minutes("5 h 10m")
+    assert_equal 10.minutes, minutes("5h10m")
+    assert_equal 10.minutes, minutes("5:10")
   end
 
   def test_hour_ranges
-    assert_equal  4.hours, range("13 to 17")
-    assert_equal  4.hours, range("1 to 5")
-    assert_equal  4.hours, range("1pm to 5pm")
-    assert_equal  4.hours, range("1 pm to 5 pm")
-    assert_equal 16.hours, range("1 am to 5 pm")
-    assert_equal  2.hours, range("11 to 1pm")
-    assert_equal  2.hours, range("11pm to 1am")
+    assert_equal  4.hours, hours("13 to 17")
+    assert_equal  4.hours, hours("1 to 5")
+    assert_equal  4.hours, hours("1pm to 5pm")
+    assert_equal  4.hours, hours("1 pm to 5 pm")
+    assert_equal 16.hours, hours("1 am to 5 pm")
+    assert_equal  2.hours, hours("11 to 1pm")
+    assert_equal  2.hours, hours("11pm to 1am")
   end
 
   def test_hour_minute_ranges
-    assert_equal 4.hours + 30.minutes, range("1 to 5:30")
-    assert_equal 4.hours + 10.minutes, range("13:30 to 17:40")
+    assert_equal 4.hours + 30.minutes, hours("1 to 5:30")
+    assert_equal 4.hours + 10.minutes, hours("13:30 to 17:40")
   end
 
   def test_with_activity
@@ -39,30 +39,24 @@ class TestGrammar < Test::Unit::TestCase
   end
 
   def test_from_time
-    assert_in_delta 2.hours, range("from #{DateTime.now.hour - 2}:#{DateTime.now.min}"), 10 #seconds of delta
+    assert_in_delta 2.hours, hours("from #{DateTime.now.hour - 2}:#{DateTime.now.min}"), 10.seconds #of delta
   end
 
   def activity source
     parse(source).last
   end
 
-  def range source
-    res = parse("#{source} on X")
-    ((res[1] - res[0]) * 24).hours
-  end
-
   def hours source
     res = parse("#{source} on X")
-    res[1].hour - res[0].hour
+    ((res[1] - res[0]) * 24).hours
   end
 
   def minutes source
-    res = parse("#{source} on X")
-    res[1].min - res[0].min
+    hours(source) % 1.hour
   end
 
   def parse source
-    InputParser.parse(source)
+    InputParser.parse(source, DateTime.now )
   end
 
 end

data/test/test_reader.rb

@@ -0,0 +1,101 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+require 'worked/reader'
+require 'mathn'
+
+class TestReader < Test::Unit::TestCase
+
+  def test_single_day
+    data = <<-EOS
+2009-04-21T21:26:00+00:00       2009-04-21T22:26:00+00:00       fixed bugs
+    EOS
+
+    recorded = Worked::Reader.read(data)
+
+    assert_equal 17, recorded[0].week_of_year
+    assert_equal 1, recorded[0].hours
+  end
+
+  def test_single_day_two_records
+    data = <<-EOS
+2009-04-21T21:26:00+00:00       2009-04-21T22:26:00+00:00       fixed bugs
+2009-04-21T23:26:00+00:00       2009-04-21T23:46:00+00:00       fixed bugs
+    EOS
+
+    recorded = Worked::Reader.read(data)
+
+    assert_equal 4/3, recorded[0].hours
+  end
+
+  def test_multiple_days
+    data = <<-EOS
+2009-04-21T21:00:00+00:00       2009-04-21T22:30:00+00:00       fixed bugs
+2009-04-24T17:00:00+00:00       2009-04-24T23:30:00+00:00       fixed bugs
+    EOS
+
+    recorded = Worked::Reader.read(data)
+
+    assert_equal 3/2, recorded[0].hours
+    assert_equal 13/2, recorded[1].hours
+  end
+
+  def test_multiple_weeks
+    data = <<-EOS
+2009-04-21T21:00:00+00:00       2009-04-21T22:30:00+00:00       fixed bugs
+2009-05-24T17:00:00+00:00       2009-05-24T23:30:00+00:00       fixed bugs
+    EOS
+
+    recorded = Worked::Reader.read(data)
+
+    assert_equal 17, recorded[0].week_of_year
+    assert_equal 22, recorded[1].week_of_year
+  end
+
+  def test_januar_first
+    data = <<-EOS
+2009-01-01T00:00:00+00:00       2009-01-1T22:00:00+00:00       fixed bugs
+    EOS
+
+    recorded = Worked::Reader.read(data)
+
+    assert_equal 1, recorded[0].week_of_year
+    assert_equal 22, recorded[0].hours
+  end
+
+  def test_worked_over_midnight
+    data = <<-EOS
+2009-01-01T23:00:00+00:00       2009-01-02T02:00:00+00:00       fixed bugs
+    EOS
+
+    recorded = Worked::Reader.read(data)
+
+    assert_equal 3, recorded[0].hours
+  end
+
+  def test_multiple_weeks_2
+    data = <<-EOS
+2009-04-21T21:00:00+00:00       2009-04-21T22:30:00+00:00       fixed bugs
+2009-06-21T21:00:00+00:00       2009-06-21T22:30:00+00:00       fixed bugs
+2009-05-24T17:00:00+00:00       2009-05-24T23:30:00+00:00       fixed bugs
+    EOS
+
+    recorded = Worked::Reader.read(data)
+
+    assert_equal 17, recorded[0].week_of_year
+    assert_equal 22, recorded[1].week_of_year
+    assert_equal 26, recorded[2].week_of_year
+  end
+
+  def test_merge_by_week
+    data = <<-EOS
+2009-04-21T21:00:00+00:00       2009-04-21T22:00:00+00:00       fixed bugs
+2009-04-22T21:00:00+00:00       2009-04-22T22:00:00+00:00       fixed bugs
+2009-05-23T21:00:00+00:00       2009-05-23T22:00:00+00:00       fixed bugs
+2009-05-23T21:00:00+00:00       2009-05-23T22:00:00+00:00       fixed bugs
+    EOS
+
+    recorded = Worked::Reader.by_week(data)
+
+    assert_equal 2, recorded[0].hours
+    assert_equal 2, recorded[1].hours
+  end
+end

data/test/test_worked_cli.rb

@@ -1,5 +1,6 @@
 require File.join(File.dirname(__FILE__), "test_helper.rb")
 require 'tempfile'
+require 'fileutils'
 require 'enumerator'
 require 'active_support'
 require 'worked/cli'
@@ -14,12 +15,16 @@ class TestWorkedCli < Test::Unit::TestCase
     reset_stdout
   end
 
+  def teardown
+    @file.unlink
+  end
+
   def reset_stdout
     @stdout_io = StringIO.new
   end
 
   def run_with argument
-    Worked::CLI.execute(@stdout_io, argument, @file)
+    Worked::CLI.execute(@stdout_io, argument.split, @file)
     @file.flush
   end
 
@@ -29,6 +34,20 @@ class TestWorkedCli < Test::Unit::TestCase
     end
   end
 
+  def stdio
+    @stdout_io.string
+  end
+
+  def test_graph
+    graph_file = Tempfile.new("graph").path + ".png"
+
+    run_with " -g #{graph_file}"
+
+    assert_equal "Graph saved to #{graph_file}.\n", stdio
+
+    FileUtils::remove graph_file
+  end
+
   def test_with_new_file
     @file.open
     run_with "5 hours on coding"
@@ -42,7 +61,7 @@ class TestWorkedCli < Test::Unit::TestCase
     assert "coding",                        first[1]
     assert "documentation and refactoring", second[1]
 
-    assert_equal "", @stdout_io.read
+    assert_equal "", stdio
 
     reset_stdout
 
@@ -54,6 +73,6 @@ class TestWorkedCli < Test::Unit::TestCase
     assert 1.hours,       third[0]
     assert "refactoring", third[1]
 
-    assert_equal "", @stdout_io.read
+    assert_equal "", stdio
   end
 end

data/website/index.html

@@ -0,0 +1,120 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" />
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>
+      Worked
+  </title>
+  <script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script>
+<style>
+
+</style>
+  <script type="text/javascript">
+    window.onload = function() {
+      settings = {
+          tl: { radius: 10 },
+          tr: { radius: 10 },
+          bl: { radius: 10 },
+          br: { radius: 10 },
+          antiAlias: true,
+          autoPad: true,
+          validTags: ["div"]
+      }
+      var versionBox = new curvyCorners(settings, document.getElementById("version"));
+      versionBox.applyCornersToAll();
+    }
+  </script>
+</head>
+<body>
+<div id="main">
+
+    <h1>Worked</h1>
+    <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/worked"; return false'>
+      <p>Get Version</p>
+      <a href="http://rubyforge.org/projects/worked" class="numbers">0.2.0</a>
+    </div>
+    <ul>
+	<li>http://worked.rubyforge.org/</li>
+</ul>
+<p>The easiest time recording application imagineable.</p>
+<h2><span class="caps">DESCRIPTION</span>:</h2>
+<p>Worked is really the simplest time recording (or tracking, whatever term you<br />
+prefer) application that does all you need and nothing more (only `date &gt;&gt; file` is easier).</p>
+<p>It simply takes a time or a time range and an activity and appends it to a<br />
+hidden file in the current directory. The use case is, that you have &#8216;.worked&#8217;<br />
+files in the root directories of your projects, and before you finish your<br />
+current work period, you probably commit something and you also record your time.</p>
+<p>Right now, the times are just recorded, no report generation yet.</p>
+<h2><span class="caps">FEATURES</span>:</h2>
+<ul>
+	<li>Appends a time range and an activity to a file.</li>
+	<li>Create a graph from the collected data, showing hours/week.</li>
+</ul>
+<h2><span class="caps">SYNOPSIS</span>:</h2>
+<p>The syntax is quite flexible, and if you&#8217;d like to have it extended, just drop<br />
+me an email. The input consists of: &lt;time&gt; on &lt;activity&gt;. So for example, you<br />
+can write &#8216;5 hours on documentation&#8217;. The following formats for the &lt;time&gt; part<br />
+are recognized:</p>
+<ul>
+	<li>5 hours</li>
+	<li>5h</li>
+	<li>or simply &#8216;5&#8217;</li>
+</ul>
+<p>Minutes can be added or standing alone as well:</p>
+<ul>
+	<li>5 h 10 minutes</li>
+	<li>5 hours 10 m</li>
+	<li>30 minutes</li>
+	<li>or simply &#8216;5:10&#8217;</li>
+</ul>
+<p>Stored is not the absolute time, but the point &lt;time&gt; hours ago and the current<br />
+time.</p>
+<p>Of course you can also specify both start- and end time of an activity with the<br />
+following syntax:</p>
+<ul>
+	<li>13 to 17</li>
+	<li>1 pm to 5 pm</li>
+	<li>13:30 to 17:40</li>
+</ul>
+<p>If you just want to record an activity from a certain point upto now, you can<br />
+write:</p>
+<ul>
+	<li>from 5pm</li>
+	<li>from 11:30</li>
+</ul>
+<p>Specifying dates is not supported right now, but you can of course edit the file<br />
+directly if necessary.</p>
+<p>Since version 0.2, worked also has the ability to generate a graph from the<br />
+collected data, using the -g argument. [<span class="caps">TODO</span>: Add image here.]</p>
+<h2><span class="caps">STORY</span>:</h2>
+<p>The week before my new semester started, I promised to myself to do better (or,<br />
+to do it at all) time recording to get a better feeling for how much I actually<br />
+worked. I used to write my time into a wiki, but that was still too tedious to<br />
+do so I often neglected it and had to record it from memory some days later. So I<br />
+needed a tool and a few hours later, &#8216;worked&#8217; was born.</p>
+<h2><span class="caps">REQUIREMENTS</span>:</h2>
+<ul>
+	<li>Uses the really great Treetop for the input parser.</li>
+</ul>
+<h2><span class="caps">INSTALL</span>:</h2>
+<ul>
+	<li>sudo gem install worked</li>
+</ul>
+<h2><span class="caps">TODO</span>:</h2>
+<ul>
+	<li>Simple report generation.</li>
+	<li>Investigate if it can be used together with git (e.g. with hooks), so I can, for example, use the last line in a commit message to make my &#8216;worked&#8217; statement.</li>
+</ul>
+    <p class="coda">
+      <a href="me@misto.ch">Mirko Stocker</a>, 12th June 2009<br>
+      Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>,
+      by Daniel Cadenas via <a href="http://depgraph.rubyforge.org/">DepGraph</a>
+    </p>
+</div>
+
+<!-- insert site tracking codes here, like Google Urchin -->
+
+</body>
+</html>