uur 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA1: 
+  metadata.gz: 9685f20a21111d9c19d91982f06c6ca324330596
+  data.tar.gz: 6f415d51d2642ef46be4f15326a4b41360761d06
+SHA512: 
+  metadata.gz: 9ccd7cd9337d558499c3558b6bda2fc22f457bb6c1767c41cdbc39924789c7d351a05e444c49317688026211121ab320dc14e0281595a1bc7a3a5c7caddebe59
+  data.tar.gz: 47a3ea9fbb6e846c925681c97d0b3e76401d6046e686cfbe5adfb596c8a37a89356f66a60dfe427f86939b51bf24db515743097adf682a652fe269e15be82340

data/Changelog

@@ -0,0 +1,5 @@
+0.0.2 (July 17, 2013)
+  Enabled the "uur" executable.
+
+0.0.1 (July 17, 2013)
+  Initial release.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Jacek Mikrut
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,116 @@
+uur
+===
+
+**uur** is a command-line tool that reads time log entries from a text file and then generates simple reports.
+
+Workflow
+--------
+1. One adds time entries to `~/.uur/entries` file using one's favourite text editor.
+2. Then at any time one can use **uur** to print reports.
+
+Entries file
+------------
+
+The entries file should be created at `~/.uur/entries` by the user. 
+
+Each line in this file corresponds to one time entry and has the following format:
+```
+YYYY-MM-DD hh:mm - hh:mm Project name  Entry description.
+```
+- the above data fields should be separated by at least one whitespace character; 
+- the project name should be separated from the entry description by at least two whitespace characters.
+
+An example: 
+```
+2013-07-17 10:15 - 10:45 Uur  Writing README file content.
+```
+
+Blank lines and those that start with `#` (hash) sign are ignored.
+
+Reports
+-------
+
+There are two types of reports: entry lists and entry summaries.
+
+#### Entries list report
+
+Simply prints the entries within the specified period, grouped by day.
+
+An example:
+```
+> uur --list --within last-month
+Mon, 10 June 2013
+09:15 - 11:45 2h30m Project A Working on task A1
+11:45 - 12:15   30m Project B Working on task B1
+15:00 - 16:00 1h00m Project B Completed task A1
+       Total: 4h00m
+
+Tue, 11 June 2013
+08:45 - 12:00 3h15m Project A Completed task B1
+       Total: 3h15m
+       
+...
+```
+
+#### Entries summary report
+
+Prints the sum of hours spent on each of the projects within the specified period grouped by the specified interval.
+
+An example:
+```
+> uur --summary monthly --within this-year
+January 2013
+Project A  12h15m
+Project B 120h30m
+Project C   6h00m
+Total:    138h45m
+
+February 2013
+Project B 140h00m
+Project C   8h30m
+Total:    148h30m
+
+...
+```
+
+Usage
+-----
+
+```
+uur [options]
+
+Reports:
+  -l, --list                                         List entries
+  -s, --summary [daily|weekly|monthly|yearly|all]    Print summary
+
+Filtering:
+  -w, --within today|yesterday|this-week|            Time period (default: today)
+               last-week|this-month|last-month|
+               this-year|last-year
+    
+Common options:
+  -d, --duration-format hours-minutes|hours-decimal  Duration time format (default: hours-minutes)
+
+Others:
+  -h, --help      Show this help message
+      --version   Show version
+```
+
+Installation
+------------
+
+```
+  gem install uur
+  mkdir ~/.uur
+  touch ~/.uur/entries
+```
+
+Author
+------
+
+[Jacek Mikrut](https://github.com/jacekmikrut)
+
+License
+-------
+
+License is included in the LICENSE file.

data/bin/uur

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'uur'
+
+Uur::App.new.run

data/lib/uur.rb

@@ -0,0 +1,24 @@
+require "uur/version"
+
+require "uur/mixins/integer_mixin"
+require "uur/mixins/time_mixin"
+require "uur/time_mapper"
+require "uur/duration_formatters/hours_and_minutes_duration_formatter"
+require "uur/duration_formatters/hours_in_decimal_notation_duration_formatter"
+require "uur/entry"
+require "uur/entries"
+require "uur/entries_file_reader"
+require "uur/entries_parser"
+require "uur/table_printing/table"
+require "uur/table_printing/table_printer"
+require "uur/table_printing/tables_printer"
+require "uur/printers/printer"
+require "uur/printers/entries_printer"
+require "uur/printers/summary_printer"
+require "uur/printers/no_entries_message_printer"
+require "uur/args_parser"
+require "uur/action_executor"
+require "uur/app"
+
+module Uur
+end

data/lib/uur/action_executor.rb

@@ -0,0 +1,39 @@
+module Uur
+  class ActionExecutor
+
+    def initialize(options, entries)
+      @options = options
+      @entries = entries
+    end
+
+    def execute
+      if selected_entries.none?
+        Printers::NoEntriesMessagePrinter.new(@options[:within]).print
+
+      elsif @options[:print_summary]
+        Printers::SummaryPrinter.new(duration_formatter).print(selected_entries, @options[:summary_interval])
+
+      elsif @options[:print_list]
+        Printers::EntriesPrinter.new(duration_formatter).print(selected_entries)
+
+      end
+    end
+
+    private
+
+    def selected_entries
+      @selected_entries ||= @entries.within(@options[:since], @options[:to])
+    end
+
+    def duration_formatter
+      case @options[:duration_format]
+      when "hours-minutes"
+        DurationFormatters::HoursAndMinutesDurationFormatter.new
+      when "hours-decimal"
+        DurationFormatters::HoursInDecimalNotationDurationFormatter.new
+      else
+        DurationFormatters::HoursAndMinutesDurationFormatter.new
+      end
+    end
+  end
+end

data/lib/uur/app.rb

@@ -0,0 +1,27 @@
+module Uur
+  class App
+
+    def run
+      ActionExecutor.new(ArgsParser.new.parse(ARGV), entries).execute
+    rescue EntriesFileReader::CannotReadException => exception
+      $stdout.puts exception.message
+      $stdout.puts "Please make sure the file exists and is readable."
+    end
+
+    def data_dir
+      @data_dir ||= File.expand_path("~/.uur")
+    end
+
+    def entries_file_path
+      @entries_file_path ||= File.join(data_dir, "entries")
+    end
+
+    def entries_file_content
+      @entries_file_content ||= EntriesFileReader.new(entries_file_path).read
+    end
+
+    def entries
+      @entries ||= EntriesParser.new.parse(entries_file_content.lines)
+    end
+  end
+end

data/lib/uur/args_parser.rb

@@ -0,0 +1,83 @@
+require "optparse"
+
+module Uur
+  class ArgsParser
+
+    def parse(args)
+      options = {}
+
+      OptionParser.new do |opts|
+        opts.banner = "Usage: uur [options]"
+
+        opts.separator ""
+        opts.separator "Reports:"
+
+        opts.on "-l", "--list", "List entries" do
+          options[:print_list] = true
+        end
+
+        opts.on "-s", "--summary [daily|weekly|monthly|yearly|all]", "Print summary" do |value|
+          options[:print_summary] = true
+          options[:summary_interval] = value
+        end
+
+        opts.separator ""
+        opts.separator "Filtering:"
+
+        opts.on "-w", "--within today|yesterday|this-week|last-week|this-month|last-month|this-year|last-year", String, "Time period (default: today)" do |value|
+          options[:within] = value
+        end
+
+        opts.separator ""
+        opts.separator "Common options:"
+
+        opts.on "-d", "--duration-format hours-minutes|hours-decimal", String, "Duration time format (default: hours-minutes)" do |value|
+          options[:duration_format] = value
+        end
+
+        opts.separator ""
+        opts.separator "Others:"
+
+        opts.on_tail "-h", "--help", "Show this help message" do
+          puts opts
+          exit
+        end
+
+        opts.on_tail "--version", "Show version" do
+          puts "uur version #{Uur::VERSION}"
+          exit
+        end
+
+      end.parse!(args)
+
+      options[:within         ] ||= "today" if options[:summary_interval].nil?
+      options[:duration_format] ||= "hours-minutes"
+      options[:print_list     ]   = true if !options[:print_list] && !options[:print_summary]
+
+      set_default_summary_interval(options) if options[:print_summary] && options[:summary_interval].nil?
+
+      if options[:within]
+        time_mapper = TimeMapper.new(Time.now)
+        options[:since] = time_mapper.since(options[:within])
+        options[:to   ] = time_mapper.to(   options[:within])
+      end
+
+      options
+    end
+
+    private
+
+    def set_default_summary_interval(options)
+      options[:summary_interval] = case options[:within]
+                                   when "today", "yesterday"
+                                     "daily"
+                                   when "this-week", "last-week"
+                                     "weekly"
+                                   when "this-month", "last-month"
+                                     "monthly"
+                                   when "this-year", "last-year"
+                                     "yearly"
+                                   end
+    end
+  end
+end

data/lib/uur/duration_formatters/hours_and_minutes_duration_formatter.rb

@@ -0,0 +1,12 @@
+module Uur
+  module DurationFormatters
+    class HoursAndMinutesDurationFormatter
+
+      def format(duration)
+        hours   = duration / 3600
+        minutes = duration / 60 % 60
+        hours > 0 ? "%dh%02dm" % [hours, minutes] : "%2dm" % [minutes]
+      end
+    end
+  end
+end

data/lib/uur/duration_formatters/hours_in_decimal_notation_duration_formatter.rb

@@ -0,0 +1,10 @@
+module Uur
+  module DurationFormatters
+    class HoursInDecimalNotationDurationFormatter
+
+      def format(duration)
+        "%0.2f" % (duration / 3600.0)
+      end
+    end
+  end
+end

data/lib/uur/entries.rb

@@ -0,0 +1,16 @@
+module Uur
+  class Entries < Array
+
+    def within(since, to)
+      self.class.new(select { |entry| (since.nil? || entry.starts_at >= since) && (to.nil? || entry.ends_at <= to) })
+    end
+
+    def group_by(&block)
+      each_with_object(Hash.new { |hash, key| hash[key] = Entries.new }) { |entry, grouped| grouped[block.call(entry)] << entry }
+    end
+
+    def duration
+      inject(0) { |total, entry| total + entry.duration }
+    end
+  end
+end

data/lib/uur/entries_file_reader.rb

@@ -0,0 +1,16 @@
+module Uur
+  class EntriesFileReader
+
+    CannotReadException = Class.new(Exception)
+
+    def initialize(entries_file_path)
+      @entries_file_path = entries_file_path
+    end
+
+    def read
+      File.read(@entries_file_path)
+    rescue
+      raise CannotReadException, "Cannot read the entries file: #{@entries_file_path}"
+    end
+  end
+end

data/lib/uur/entries_parser.rb

@@ -0,0 +1,31 @@
+require "time"
+
+module Uur
+  class EntriesParser
+
+    REGEXP = /^\s*(?<date>[\d-]+)\s+(?<start_time>[\d:]+)\s*-\s*(?<end_time>[\d:]+)\s+(?<project_name>.*?)(?=\s\s|$)(?:\s\s+(?<description>.+)$)?/
+
+    def parse(lines)
+      reject_blank_or_commented_lines(lines).each_with_object(Entries.new) do |line, entries|
+        entries << map_data_to_entry(line.match(REGEXP))
+      end
+    end
+
+    private
+
+    def reject_blank_or_commented_lines(lines)
+      lines.reject do |line|
+        line.strip == "" or line =~ /^\s*#/
+      end
+    end
+
+    def map_data_to_entry(data)
+      Entry.new(
+           starts_at: Time.strptime("#{data[:date]} #{data[:start_time]}", '%Y-%m-%d %H:%M'),
+             ends_at: Time.strptime("#{data[:date]} #{data[  :end_time]}", '%Y-%m-%d %H:%M'),
+        project_name: data[:project_name],
+         description: (data[:description] || "").rstrip,
+      )
+    end
+  end
+end

data/lib/uur/entry.rb

@@ -0,0 +1,26 @@
+require "ostruct"
+
+module Uur
+  class Entry < OpenStruct
+
+    def day
+      starts_at.beginning_of_day
+    end
+
+    def week
+      starts_at.beginning_of_week
+    end
+
+    def month
+      starts_at.beginning_of_month
+    end
+
+    def year
+      starts_at.beginning_of_year
+    end
+
+    def duration
+      (ends_at - starts_at).to_i
+    end
+  end
+end

data/lib/uur/mixins/integer_mixin.rb

@@ -0,0 +1,14 @@
+module Uur
+  module Mixins
+    module IntegerMixin
+
+      def day
+        self * 3600 * 24
+      end
+
+      alias_method :days, :day
+    end
+  end
+end
+
+Integer.send(:include, Uur::Mixins::IntegerMixin)

data/lib/uur/mixins/time_mixin.rb

@@ -0,0 +1,72 @@
+module Uur
+  module Mixins
+    module TimeMixin
+
+      def beginning_of_day
+        Time.new(year, month, day)
+      end
+
+      def end_of_day
+        Time.new(year, month, day, 23, 59, 59)
+      end
+
+      def beginning_of_previous_day
+        beginning_of_day - 1.day
+      end
+
+      def end_of_previous_day
+        end_of_day - 1.day
+      end
+
+      def beginning_of_week
+        beginning_of_day - (wday == 0 ? 6 : wday - 1).days
+      end
+
+      def end_of_week
+        (beginning_of_week + 7.days) - 1
+      end
+
+      def beginning_of_previous_week
+        beginning_of_week - 7.days
+      end
+
+      def end_of_previous_week
+        end_of_week - 7.days
+      end
+
+      def beginning_of_month
+        Time.new(year, month)
+      end
+
+      def end_of_month
+        Time.new(year + (month == 12 ? 1 : 0), month % 12 + 1) - 1
+      end
+
+      def beginning_of_previous_month
+        Time.new(end_of_previous_month.year, end_of_previous_month.month)
+      end
+
+      def end_of_previous_month
+        Time.new(year, month) - 1
+      end
+
+      def beginning_of_year
+        Time.new(year)
+      end
+
+      def end_of_year
+        Time.new(year + 1) - 1
+      end
+
+      def beginning_of_previous_year
+        Time.new(year - 1)
+      end
+
+      def end_of_previous_year
+        Time.new(year) - 1
+      end
+    end
+  end
+end
+
+Time.send(:include, Uur::Mixins::TimeMixin)

data/lib/uur/printers/entries_printer.rb

@@ -0,0 +1,22 @@
+module Uur
+  module Printers
+    class EntriesPrinter < Printer
+
+      def print(entries)
+        print_tables entries, :day, proc { |time| time.strftime("%a, %d %B %Y") }
+      end
+
+      private
+
+      def alignments
+        [:left, :right, :left, :left]
+      end
+
+      def rows(entries)
+        entries.map do |entry|
+          ["#{entry.starts_at.strftime("%H:%M")} - #{entry.ends_at.strftime("%H:%M")}", "#{duration(entry.duration)}", "#{entry.project_name}", "#{entry.description}"]
+        end.push(["       Total:", duration(entries.duration), "", ""])
+      end
+    end
+  end
+end

data/lib/uur/printers/no_entries_message_printer.rb

@@ -0,0 +1,21 @@
+module Uur
+  module Printers
+    class NoEntriesMessagePrinter
+
+      def initialize(within_option, out=$stdout)
+        @within_option = within_option
+        @out = out
+      end
+
+      def print
+        @out.puts "No entries within #{within}."
+      end
+
+      private
+
+      def within
+        @within ||= @within_option.gsub(/-/, " ")
+      end
+    end
+  end
+end

data/lib/uur/printers/printer.rb

@@ -0,0 +1,25 @@
+module Uur
+  module Printers
+    class Printer
+
+      def initialize(duration_formatter, out=$stdout)
+        @duration_formatter = duration_formatter
+        @out = out
+      end
+
+      private
+
+      def duration(duration)
+        @duration_formatter.format(duration)
+      end
+
+      def print_tables(entries, interval, header_proc)
+        Uur::TablePrinting::TablesPrinter.new(tables(entries, interval, header_proc), alignments, @out).print
+      end
+
+      def tables(entries, interval, header_proc)
+        entries.group_by(&interval).map { |date, entries| Uur::TablePrinting::Table.new(header_proc.call(date), rows(entries)) }
+      end
+    end
+  end
+end

data/lib/uur/printers/summary_printer.rb

@@ -0,0 +1,39 @@
+module Uur
+  module Printers
+    class SummaryPrinter < Printer
+
+      def print(entries, interval=nil)
+
+        case interval
+        when "daily"
+          print_tables entries, :day,   proc { |time| time.strftime("%a, %d %B %Y") }
+
+        when "weekly"
+          print_tables entries, :week,  proc { |time| "#{time.beginning_of_week.strftime("%d %B %Y")} - #{time.end_of_week.strftime("%d %B %Y")}" }
+
+        when "monthly"
+          print_tables entries, :month, proc { |time| time.strftime("%B %Y") }
+
+        when "yearly"
+          print_tables entries, :year,  proc { |time| time.strftime("Year %Y") }
+
+        else
+          print_tables entries, :nil,   proc { nil }
+
+        end
+      end
+
+      private
+
+      def alignments
+        [:left, :right]
+      end
+
+      def rows(entries)
+        entries.group_by(&:project_name).sort.map do |project_name, project_entries|
+          [project_name, duration(project_entries.duration)]
+        end.push(["Total:", duration(entries.duration)])
+      end
+    end
+  end
+end

data/lib/uur/table_printing/table.rb

@@ -0,0 +1,21 @@
+module Uur
+  module TablePrinting
+    class Table < Array
+
+      def initialize(header, *args)
+        @header = header
+        super(*args)
+      end
+
+      attr_accessor :header
+
+      def ==(other)
+        header == other.header && super
+      end
+
+      def inspect
+        "Header: #{header.inspect}, content: #{super}"
+      end
+    end
+  end
+end

data/lib/uur/table_printing/table_printer.rb

@@ -0,0 +1,31 @@
+module Uur
+  module TablePrinting
+    class TablePrinter
+
+      def initialize(table, widths, alignments, out=$stdout)
+        @table      = table
+        @widths     = widths
+        @alignments = alignments
+        @out        = out
+      end
+
+      def print
+        @out.puts formatted_table.header unless formatted_table.header.nil?
+        @out.puts formatted_table.map { |row_cells| row_cells.join(' ').rstrip }
+      end
+
+      private
+
+      attr_reader :table, :widths, :alignments
+
+      def formatted_table
+        @formatted_table ||=
+          Table.new(table.header, table.map do |cells_in_row|
+            cells_in_row.each_with_index.map do |cell, column_index|
+              cell.send({ :left => :ljust, :right => :rjust }[alignments[column_index] || :left], widths[column_index] || 0)
+            end
+          end)
+      end
+    end
+  end
+end

data/lib/uur/table_printing/tables_printer.rb

@@ -0,0 +1,27 @@
+module Uur
+  module TablePrinting
+    class TablesPrinter
+
+      def initialize(tables, alignments, out=$stdout)
+        @tables     = tables
+        @alignments = alignments
+        @out        = out
+      end
+
+      def print
+        tables.each do |table|
+          TablePrinter.new(table, widths, alignments, @out).print
+          @out.puts
+        end
+      end
+
+      private
+
+      attr_reader :tables, :alignments
+
+      def widths
+        @widths ||= tables.flatten(1).transpose.map { |rows_in_column| rows_in_column.map(&:length).max }
+      end
+    end
+  end
+end

data/lib/uur/time_mapper.rb

@@ -0,0 +1,34 @@
+module Uur
+  class TimeMapper
+
+    def initialize(now)
+      @now = now
+    end
+
+    def since(time)
+      case time
+      when "today"      then @now.beginning_of_day
+      when "yesterday"  then @now.beginning_of_previous_day
+      when "this-week"  then @now.beginning_of_week
+      when "last-week"  then @now.beginning_of_previous_week
+      when "this-month" then @now.beginning_of_month
+      when "last-month" then @now.beginning_of_previous_month
+      when "this-year"  then @now.beginning_of_year
+      when "last-year"  then @now.beginning_of_previous_year
+      end
+    end
+
+    def to(time)
+      case time
+      when "today"      then @now.end_of_day
+      when "yesterday"  then @now.end_of_previous_day
+      when "this-week"  then @now.end_of_week
+      when "last-week"  then @now.end_of_previous_week
+      when "this-month" then @now.end_of_month
+      when "last-month" then @now.end_of_previous_month
+      when "this-year"  then @now.end_of_year
+      when "last-year"  then @now.end_of_previous_year
+      end
+    end
+  end
+end

data/lib/uur/version.rb

@@ -0,0 +1,3 @@
+module Uur
+  VERSION = "0.0.2"
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: uur
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Jacek Mikrut
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-07-17 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.0"
+  type: :development
+  version_requirements: *id001
+description: Generates simple reports from time log entries stored in human-readable text file.
+email: jacekmikrut.software@gmail.com
+executables: 
+- uur
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/uur/args_parser.rb
+- lib/uur/entries_file_reader.rb
+- lib/uur/action_executor.rb
+- lib/uur/app.rb
+- lib/uur/duration_formatters/hours_in_decimal_notation_duration_formatter.rb
+- lib/uur/duration_formatters/hours_and_minutes_duration_formatter.rb
+- lib/uur/mixins/integer_mixin.rb
+- lib/uur/mixins/time_mixin.rb
+- lib/uur/time_mapper.rb
+- lib/uur/entries.rb
+- lib/uur/entries_parser.rb
+- lib/uur/entry.rb
+- lib/uur/table_printing/table_printer.rb
+- lib/uur/table_printing/table.rb
+- lib/uur/table_printing/tables_printer.rb
+- lib/uur/printers/summary_printer.rb
+- lib/uur/printers/entries_printer.rb
+- lib/uur/printers/no_entries_message_printer.rb
+- lib/uur/printers/printer.rb
+- lib/uur/version.rb
+- lib/uur.rb
+- README.md
+- LICENSE
+- Changelog
+- bin/uur
+homepage: http://github.com/jacekmikrut/uur
+licenses: []
+
+metadata: {}
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - &id002 
+    - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id002
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 2.0.5
+signing_key: 
+specification_version: 4
+summary: Command line time log reporting tool.
+test_files: []
+