timekeeper 0.1.0 → 0.2.0

data/bin/tk

@@ -1,68 +1,7 @@
 #!/usr/bin/env ruby 
-# == Synopsis
-#
-# Timekeeper. Keeping track of your time.
-#
-# == Usage
-#
-# tk [OPTIONS]
-#
-# -h, --help:
-#    show help
-#
-# --config [file]
-#     Location of your configuration file
-#
-# --title [title], -t [title]:
-#     What do you want to register
-#
-# --target [target], -c [target]:
-#     Who is going to pay?
-#
-# --time [time], -s [time]:
-#     How long did it take?
-#
-# --description [description], -m [description]
-#     More? You want to be more specific?
-#
-# --date [date], -d [date]
-#     When exactly did it happen?
-#
-# --remove [id]
-#     Remove a record.
-#
-require File.expand_path(File.dirname(__FILE__) + "/../lib/timekeeper")
+require 'rubygems'
 
-require "getoptlong"
-require "rdoc/usage"
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'timekeeper'
 
-opts = GetoptLong.new(
-      [ "--help",       "-h", GetoptLong::NO_ARGUMENT ],
-      [ "--title",      "-t", GetoptLong::REQUIRED_ARGUMENT ],
-      [ "--target",     "-c", GetoptLong::REQUIRED_ARGUMENT ],
-      [ "--time",       "-s", GetoptLong::REQUIRED_ARGUMENT ],
-      [ "--description","-m", GetoptLong::REQUIRED_ARGUMENT ],
-      [ "--date",       "-d", GetoptLong::REQUIRED_ARGUMENT ],
-      [ "--remove"          , GetoptLong::REQUIRED_ARGUMENT ],
-      [ "--config"          , GetoptLong::REQUIRED_ARGUMENT ]   
-    )
-
-if ARGV.length == 0
-  puts "Please provide some options, type --help"
-  exit 0
-end
-
-tk = Timekeeper.new
-
-attributes = {}
-opts.each do |opt, arg|
-  case opt
-  when "--help": RDoc::usage
-  when "--config": tk.config arg
-  when "--remove": tk.delete(arg); exit 0
-  else 
-    attributes.store(opt.gsub("-",""), arg)
-  end
-end
-
-tk.store(attributes)
+Timekeeper::Runner.tk(ARGV)

data/bin/tv

@@ -1,74 +1,7 @@
 #!/usr/bin/env ruby 
-# == Synopsis
-#
-# Timeviewer. Keeping an eye on your tracked time.
-#
-# == Usage
-#
-# tv [OPTIONS]
-#
-# -h, --help:
-#    show help
-#
-# --config [file]
-#     Location of your configuration file
-#
-# --name [name], -n [name]:
-#    Query by name
-#
-# --title [title], -t [title]:
-#     Query by title
-#
-# --target [target], -c [target]:
-#     Query by target
-#
-# --description [description], -m [description]
-#     Query by description
-#
-# --date [date], -d [date]
-#     Query by date
-#
-require File.dirname(__FILE__) + '/../lib/timekeeper'
- 
-require "getoptlong"
-require "rdoc/usage"
-require "fastercsv"
+require 'rubygems'
 
-opts = GetoptLong.new(
-      [ "--help",       "-h", GetoptLong::NO_ARGUMENT ],
-      [ "--csv"             , GetoptLong::NO_ARGUMENT ],
-      [ "--all"             , GetoptLong::NO_ARGUMENT ],        
-      [ "--name",       "-n", GetoptLong::REQUIRED_ARGUMENT ],
-      [ "--title",      "-t", GetoptLong::REQUIRED_ARGUMENT ],
-      [ "--target",     "-c", GetoptLong::REQUIRED_ARGUMENT ],
-      [ "--time",       "-s", GetoptLong::REQUIRED_ARGUMENT ],
-      [ "--description","-m", GetoptLong::REQUIRED_ARGUMENT ],
-      [ "--date",       "-d", GetoptLong::REQUIRED_ARGUMENT ],
-      [ "--config"          , GetoptLong::REQUIRED_ARGUMENT ] 
-    )
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'timekeeper'
 
-if ARGV.length == 0
-  puts "Please provide some options, type --help"
-  exit 0
-end
-
-tv = Timeviewer.new
-output = nil
-
-attributes = {}
-opts.each do |opt, arg|
-  case opt
-  when "--help": RDoc::usage
-  when "--csv" : output = :csv
-  when "--config": tv.config arg
-  else
-    attributes.store(opt.gsub("-",""), arg)
-  end
-end
-
-records = tv.all
-if output
-  Timeviewer.export(records, "export", output)
-else
-  puts records.collect{|r| Keep.new(r) }
-end
+Timekeeper::Runner.tv(ARGV)

data/lib/timekeeper.rb

@@ -1,6 +1,10 @@
-require "rubygems"
 require "rufus/tokyo"
+require "fastercsv"
+require "optparse"
 
-require File.dirname(__FILE__) + "/timekeeper/keep"
-require File.dirname(__FILE__) + "/timekeeper/timekeeper"
-require File.dirname(__FILE__) + "/timekeeper/timeviewer"
+require "timekeeper/keep"
+require "timekeeper/keeper"
+require "timekeeper/viewer"
+require "timekeeper/runner"
+require "timekeeper/keeper_options"
+require "timekeeper/viewer_options"

data/lib/timekeeper/keep.rb

@@ -1,72 +1,65 @@
-class Keep
-  YES = ["YES", "Y", "y", "yes", "true", true]
-  NO = ["NO", "N", "n", "no", "false", false, nil]
+module Timekeeper
+
+  class Keep
   
-  attr_accessor :name, :time, :title, :description, :target, :date, :pk, :track
+    attr_accessor :name, :time, :title, :description, :target, :date, :pk
   
-  def initialize(attributes)
-    set_attributes(attributes)
-  end
+    def initialize(attributes)
+      set_attributes(attributes)
+    end
   
-  def update(attributes)
-    set_attributes(attributes)
-  end  
+    def update(attributes)
+      set_attributes(attributes)
+    end  
   
-  def date=(value)
-    if value
-      if value.is_a?(Date)
-        @date = value
-      else
-        @date = parse_date(value.to_s)
+    def date=(value)
+      if value
+        if value.is_a?(Date)
+          @date = value
+        else
+          @date = parse_date(value.to_s)
+        end
       end
     end
-  end
+    
+    def validate
+      mandatory(%w(name target title date time))
+    end      
   
-  def track=(value)
-    if YES.include?(value)
-      @track = true
-    elsif NO.include?(value)
-      @track = false
+    def to_hash
+      {:name => name, :time => time, :title => title, :description => description,
+        :target => target, :date => date}
     end
-  end
-  
-  def validate
-    mandatory(%w(name target title date time))
-  end      
-  
-  def to_hash
-    {:name => name, :time => time, :title => title, :description => description,
-      :target => target, :date => date, :track => track}
-  end
   
-  def to_s
-    "#{pk}|#{name}|#{target}|#{title}|#{description}|#{date}|#{time}|#{track}"
-  end
+    def to_s
+      "#{pk}|#{name}|#{target}|#{title}|#{description}|#{date}|#{time}"
+    end
   
-  private
+    private
     
-    def set_attributes(attributes)
-      attributes.each do |key, value|
-        respond_to?("#{key}=") ? send("#{key}=", value) : raise(StandardError, "unknown attribute: #{key}")
+      def set_attributes(attributes)
+        attributes.each do |key, value|
+          respond_to?("#{key}=") ? send("#{key}=", value) : raise(StandardError, "unknown attribute: #{key}")
+        end
+        validate
+        self
       end
-      validate
-      self
-    end
     
-    def parse_date(value)
-      case value
-      when "today"    : Date.today
-      when "yesterday": Date.today - 1
-      when "tomorrow" : Date.today + 1
-      else
-        Date.parse(value)
+      def parse_date(value)
+        case value
+        when "today"    : Date.today
+        when "yesterday": Date.today - 1
+        when "tomorrow" : Date.today + 1
+        else
+          Date.parse(value)
+        end
       end
-    end
     
-    def mandatory(attributes)
-      attributes.each do |attribute|
-        raise(StandardError, "#{attribute} is mandatory") unless send(attribute)
+      def mandatory(attributes)
+        attributes.each do |attribute|
+          raise(StandardError, "#{attribute} is mandatory") unless send(attribute)
+        end
       end
-    end
   
-end
+  end
+end

data/lib/timekeeper/keeper.rb

@@ -0,0 +1,50 @@
+module Timekeeper
+  
+  class Keeper
+  
+    def config(file="timekeeper.yml")
+      @config ||= YAML.load_file(file)
+    end
+  
+    def delete(id)
+      table.delete(id)
+    end
+  
+    def delete_all
+      table.clear
+    end
+  
+    def close
+      table.close
+    end
+    
+    def count
+      table.count
+    end
+  
+    def store(attributes)
+      attributes.store("name", config["name"])
+      attributes.store("date", Date.today) unless attributes["date"]
+      table[table.genuid] = Keep.new(attributes).to_hash
+    end
+  
+    def get(id)
+      if attributes = table.lget(id.to_s).values.first
+        Keep.new(attributes)
+      end
+    end
+  
+    def update(id, attributes_to_update)
+      if attributes = table.lget(id.to_s).values.first
+        table[id] = Keep.new(attributes).update(attributes_to_update).to_hash
+      end
+    end
+    
+    private
+    
+      def table
+        @table ||= Rufus::Tokyo::Table.new(File.join(config["db_path"],"#{config["name"]}-time.tct"))    
+      end
+    
+  end
+end

data/lib/timekeeper/keeper_options.rb

@@ -0,0 +1,59 @@
+module Timekeeper
+  
+  class KeeperOptions < Hash
+    attr_reader :opts
+
+    def initialize(args)
+      super()
+
+      @opts = OptionParser.new do |o|
+        o.banner = "Usage: #{File.basename($0)} [options]"
+
+        o.on("--config FILE", "location of your configuration file - default is ./timekeeper.yml") do |file|
+          self[:config] = file
+        end
+
+        o.on('-t', '--title TITLE', 'What do you want to register?') do |title|
+          self[:title] = title
+        end
+
+        o.on('-c', '--target TARGET', 'Who is going to pay?') do |target|
+          self[:target] = target
+        end
+
+        o.on('-s', '--time TIME', 'How long did it take?') do |time|
+          self[:time] = time
+        end
+
+        o.on('-m', '--description DESCRIPTION', 'More? You want to be more specific?') do |description|
+          self[:description] = description
+        end
+
+        o.on('-d', '--date DATE', 'When exactly did it happen?') do |date|
+          self[:date] = date
+        end
+
+        o.on('--remove ID', 'Remove a record.') do |id|
+          self[:remove] = id
+        end
+        
+        o.on('--update ID', 'Remove a record.') do |id|
+          self[:update] = id
+        end
+        
+        o.on_tail('-h', '--help', 'Display this help and exit') do
+          puts @opts
+          exit
+        end        
+
+      end
+
+      begin
+        @opts.parse!(args)
+      rescue OptionParser::InvalidOption => e
+        self[:invalid_argument] = e.message
+      end
+    end
+    
+  end
+end

data/lib/timekeeper/runner.rb

@@ -0,0 +1,37 @@
+module Timekeeper
+  
+  class Runner
+    
+    def self.tk(args)
+      options = KeeperOptions.new(args)
+      if options.any?
+        tk = Keeper.new
+        tk.config(options.delete(:config)) if options[:config]
+        
+        if id = options[:remove]
+          tk.delete(id)
+        elsif id = options.delete(:update)
+          tk.update(id, options)
+        else        
+          tk.store(options)          
+        end
+      else
+        puts options.opts
+      end
+    end
+    
+    def self.tv(args)
+      options = ViewerOptions.new(args)
+      tv = Viewer.new
+      tv.config(options.delete(:config)) if options[:config]      
+      records = tv.all
+      if output = options.delete(:output)
+        Viewer.export(records, output[0], output[1])
+      else
+        puts records
+      end
+    end
+    
+  end
+  
+end

data/lib/timekeeper/viewer.rb

@@ -0,0 +1,38 @@
+module Timekeeper
+  
+  class Viewer
+  
+    def config(file="timekeeper.yml")
+      @config ||= YAML.load_file(file)
+    end
+
+    def all
+      tables.collect{|table| table.query.collect{|attrs| Keep.new(attrs)}}.flatten!
+    end
+  
+    def close
+      tables.each {|table| table.close}
+    end
+  
+    def self.export(records, name="timekeeper", type= :csv)
+      if records.any?
+        case type.to_s
+        when "csv"
+          FasterCSV.open("#{name}.#{type}", "w") do |csv|    
+            csv << records[0].keys
+            records.each do |record|
+              csv << record.values
+            end
+          end
+        end
+      end
+    end
+      
+    private
+  
+      def tables
+        @tables ||= config["team"].collect{|t| Rufus::Tokyo::Table.new(File.join(config["db_path"],"#{t}-time.tct"))}   
+      end
+      
+  end    
+end

data/lib/timekeeper/viewer_options.rb

@@ -0,0 +1,55 @@
+module Timekeeper
+  
+  class ViewerOptions < Hash
+    attr_reader :opts
+
+    def initialize(args)
+      super()
+
+      @opts = OptionParser.new do |o|
+        o.banner = "Usage: #{File.basename($0)} [options]"
+
+        o.on("--config FILE", "location of your configuration file - default is ./timekeeper.yml") do |file|
+          self[:config] = file
+        end
+        
+        o.on("--csv [FILE]", "export to csv") do |file|
+          self[:output] = [(file || "timekeeper"), :csv]
+        end        
+        
+        o.on('-n', '--name NAME', 'Query on name') do |title|
+          self[:title] = title
+        end        
+
+        o.on('-t', '--title TITLE', 'Query on title') do |title|
+          self[:title] = title
+        end
+
+        o.on('-c', '--target TARGET', 'Query on target') do |target|
+          self[:target] = target
+        end
+
+        o.on('-m', '--description DESCRIPTION', 'Query on description') do |description|
+          self[:description] = description
+        end
+
+        o.on('-d', '--date DATE', 'Query on date') do |date|
+          self[:date] = date
+        end
+
+        o.on_tail('-h', '--help', 'Display this help and exit') do
+          puts @opts
+          exit
+        end        
+
+      end
+
+      begin
+        @opts.parse!(args)
+      rescue OptionParser::InvalidOption => e
+        self[:invalid_argument] = e.message
+      end
+    end
+    
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: timekeeper
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - atog
@@ -55,8 +55,11 @@ extra_rdoc_files:
 files: 
 - lib/timekeeper.rb
 - lib/timekeeper/keep.rb
-- lib/timekeeper/timekeeper.rb
-- lib/timekeeper/timeviewer.rb
+- lib/timekeeper/keeper.rb
+- lib/timekeeper/keeper_options.rb
+- lib/timekeeper/runner.rb
+- lib/timekeeper/viewer.rb
+- lib/timekeeper/viewer_options.rb
 - LICENSE
 - README.rdoc
 has_rdoc: true

data/lib/timekeeper/timekeeper.rb

@@ -1,37 +0,0 @@
-class Timekeeper
-  
-  def config(file="timekeeper.yml")
-    @config ||= YAML.load_file(file)
-  end
-  
-  def delete(id)
-    table.delete(id)
-  end
-  
-  def delete_all
-    table.clear
-  end
-  
-  def store(attributes)
-    attributes.store("name", config["name"])
-    attributes.store("date", Date.today) unless attributes["date"]
-    table[table.genuid] = Keep.new(attributes).to_hash
-  end
-  
-  def get(id)
-    if attributes = table.lget(id.to_s).values.first
-      Keep.new(attributes)
-    end
-  end
-  
-  def update(id, attributes_to_update)
-    if attributes = table.lget(id.to_s).values.first
-      table[id] = Keep.new(attributes).update(attributes_to_update).to_hash
-    end
-  end
-    
-  def table
-    @table ||= Rufus::Tokyo::Table.new(File.join(config["db_path"],"#{config["name"]}-time.tct"))    
-  end
-    
-end

data/lib/timekeeper/timeviewer.rb

@@ -1,31 +0,0 @@
-class Timeviewer
-  
-  def config(file="timekeeper.yml")
-    @config ||= YAML.load_file(file)
-  end
-
-  def all
-    tables.collect{|table| table.query}.flatten!
-  end
-  
-  def self.export(records, name="export", type= :csv)
-    if records.any?
-      case type
-      when :csv
-        FasterCSV.open("#{name}.#{type}", "w") do |csv|    
-          csv << records[0].keys
-          records.each do |record|
-            csv << record.values
-          end
-        end
-      end
-    end
-  end
-      
-  private
-  
-    def tables
-      @tables ||= config["team"].collect{|t| Rufus::Tokyo::Table.new(File.join(config["db_path"],"#{t}-time.tct"))}   
-    end
-    
-end