wlog 1.0.0 → 1.0.5

data/lib/wlog/domain/template_engine.rb

@@ -0,0 +1,55 @@
+module Wlog
+# A very simple templating engine that supports generating text files in order
+# for them to be, in turn parsed by some other tool in order to generate nice
+# invoices. The 'other' tool I have in mind is pandoc; this somewhat defeats
+# the purpose of 'lightweight' in the sense that we indirectly need that tool,
+# but on the other hand writing a more complex templating engine might prove
+# too costly for now. 
+# 
+# @author Simon Symeonidis
+class TemplateEngine
+
+  # These can either be atomic elements, or arrays of two. In the former, they
+  # just join entries by adding the separator. The latter makes the two a 
+  # prefix, and postfix.
+  # @param issue_sep is what to separate issues with
+  # @param log_entry_sep is what to separate log entries with
+  def initialize(issue_sep, log_entry_sep, issues, invoice_id)
+    @issue_sep, @log_entry_sep, @issues, @invoice_id = \
+      issue_sep, log_entry_sep, issues, invoice_id
+  end
+
+  def generate(filename)
+    contents = File.open(filename).read
+    contens.gsub(InvoiceId, @invoice_id)
+  end
+
+  # What to separate issues with
+  attr_accessor :issue_sep
+
+  # What to separate log entries with
+  attr_accessor :log_entry_sep
+
+  # An issue list
+  attr_accessor :issues
+
+private
+
+  # The tag to look for in order to add the issue info
+  IssueTag = '<issue-sep>'
+
+  # The log entry tag to add the log entries
+  LogEntrySep = '<log-entry-sep>'
+
+  InvoiceId = '<id>'
+
+  DateFrom = '<date-from>'
+
+  DateTo = '<date-to>'
+
+  StartSegment = '[segment]'
+  EndSegment = '[/segment]'
+
+end
+end
+

data/lib/wlog/domain/timelog_helper.rb

@@ -0,0 +1,53 @@
+module Wlog
+# Helper class that reads in a string in the form of eg: 4h20m and should be
+# able to extract time in seconds.
+# @author Simon Symeonidis
+class TimelogHelper
+  # Parse a timelog string
+  def self.parse(str)
+    loggings = str.scan(/\d+[A-Za-z]/)
+    self.calculate_time(loggings)
+  end
+
+  # @param time is time in seconds 
+  # @return in nice format (2d 1h 20m)
+  def self.time_to_s(time)
+    str = ""
+    TimesArr.each do |interval|
+      rem = time % interval
+      occ = (time - rem) / interval
+      str.concat("#{occ}#{TimesRev[interval]} ") if occ > 0
+      time = rem
+    end
+  str end
+
+private_class_method
+  # Calculate time interface (get an array of time entries, and calculate)
+  def self.calculate_time(time_arr)
+    time_arr.inject(0){|sum,el| sum += self.calculate_item(el)}
+  end
+
+  # Calculate one time entry
+  def self.calculate_item(time_item)
+    magnitude = Times[time_item[-1]]
+    time_item.to_i * magnitude
+  end
+
+  def self.count_occurences(time, step)
+  end
+
+  Times = {
+    'h' => 60 * 60,
+    's' => 1,
+    'm' => 60,
+    'd' => 8 * 60 * 60, # We assume logging a day = 8 hours
+    'w' => 8 * 60 * 60 * 7
+  }
+
+  # Reverse format for times
+  TimesRev = Hash[Times.to_a.collect{|arr| arr.reverse}]
+
+  # For a format to output a given int to time (1221 => 20m 21s)
+  TimesArr = Times.to_a.sort{|x1,x2| x2[1] <=> x1[1]}.collect{|e| e[1]}
+end
+end

data/lib/wlog/sql/seq/2.sql

@@ -0,0 +1,4 @@
+--$ Add time logging for log_entries for version 1.0.5
+
+ALTER TABLE issues ADD COLUMN timelog BIGINT;
+

data/lib/wlog/{domain → tech}/ansi_colors.rb

@@ -3,13 +3,14 @@ module Wlog
 # Store some ansi color codes in a module
 # TODO this is a placeholder, and might not be correct.
 module AnsiColors
-  Red     = 32
-  Blue    = 33
-  Green   = 34
-  Cyan    = 35
-  Magenta = 36
+  Black   = 30
+  Red     = 31
+  Green   = 32
+  Yellow  = 33
+  Blue    = 34
+  Magenta = 35
+  Cyan    = 36
   White   = 37
-  Black   = 38
 end
 end
 

data/lib/wlog/tech/uncolored_string.rb

@@ -0,0 +1,14 @@
+module Wlog
+# Use this if the system does not support colored strings.
+# @author Simon Symeonidis 
+class UncoloredString
+  def self.red(str); str end
+  def self.yellow(str); str end
+  def self.magenta(str); str end
+  def self.green(str); str end
+  def self.blue(str); str end
+  def self.white(str); str end
+  def self.black(str); str end
+  def self.cyan(str); str end
+end
+end

data/lib/wlog/tech/wlog_string.rb

@@ -0,0 +1,23 @@
+require 'wlog/tech/ansi_colors'
+
+module Wlog
+# This should take care of multiplatform color stuff. 
+# @author Simon Symeonidis
+class WlogString
+  include AnsiColors
+
+  def self.red(str); colorize(str,Red) end
+  def self.yellow(str); colorize(str,Yellow) end
+  def self.magenta(str); colorize(str,Magenta) end
+  def self.green(str); colorize(str,Green) end
+  def self.blue(str); colorize(str,Blue) end
+  def self.white(str); colorize(str,White) end
+  def self.black(str); colorize(str,Black) end
+  def self.cyan(str); colorize(str,Cyan) end
+
+private
+  def self.colorize(str,col)
+    "\x1b[#{col};1m#{str}\x1b[0m"
+  end
+end
+end

data/lib/wlog/ui/bootstrap.rb

@@ -0,0 +1,18 @@
+require 'wlog/commands/innit_db'
+require 'wlog/ui/setup_wizard'
+require 'wlog/domain/helpers'
+
+module Wlog
+# This takes care of initialization. Place this class between the main entry
+# point of the application and, the first transaction you require.
+# @author Simon Symeonidis
+class Bootstrap
+  def self.configure!
+    Helpers.make_dirs!
+    InnitDb.new.execute 
+    # Initial setup if first time running
+    SetupWizard.new.run if Helpers.first_setup?
+  end
+end
+end
+

data/lib/wlog/ui/cli_interface.rb

@@ -1,10 +1,15 @@
+require 'readline'
 require 'turntables'
 require 'wlog/domain/issue'
 require 'wlog/domain/static_configurations'
 require 'wlog/domain/sys_config'
 require 'wlog/domain/attachment'
-require 'wlog/commands/innit_db'
+require 'wlog/domain/helpers'
 require 'wlog/ui/commands/create_issue'
+
+require 'wlog/commands/archive_issues'
+require 'wlog/commands/archive_finished_issues'
+require 'wlog/commands/delete_issue'
 require 'wlog/ui/issue_ui'
 
 module Wlog
@@ -16,26 +21,32 @@ class CliInterface
 
   # This is the main entry point of the application. Therefore when we init,
   # we want to trigger the table creation stuff.
-  def initialize; InnitDb.new.execute end
+  def initialize
+    @db = DbRegistry.new(nil)
+    @strmaker = SysConfig.string_decorator
+  end
 
   # Run the interface
   def run
     cmd = "default"
+    label = @strmaker.white('wlog')
     until cmd == "end" do 
-      print "[wlog] "
-      cmd = $stdin.gets || "end"
+      cmd = Readline.readline("[#{label}] ") || "end"
       cmd.chomp!
 
       case cmd
+      when /archive/ then archive cmd
       when /showattach/ then show_attach
       when /outattach/  then output_attach
+      when /generateinvoice/ then generate_invoice
       when /attach/ then attach
       when /focus/  then focus
       when /new/    then new_issue
       when /show/   then show_issues
       when /outcsv/ then outcsv
-      when /delete/ then delete_entry
+      when /delete/ then delete_issue
       when /help/   then print_help
+      when /search/ then search
       end
     end
   end
@@ -51,16 +62,22 @@ class CliInterface
 private 
  
   # Create a new issue
-  def new_issue; CreateIssue.new.execute end
+  def new_issue; CreateIssue.new(@db).execute end
+
+  # Procedure to delete an issue
+  def delete_issue
+    issue_id = Readline.readline('Which issue id to delete? : ').to_i
+    dcmd = DeleteIssue.new(@db, issue_id)
+    dcmd.execute
+    puts "No such issue" unless dcmd.deleted?
+  end
 
   # Wriet out the data contained in the database of the attachment
   def output_attach
-    print "Which attachment to output? : "
-    att_id = $stdin.gets.to_i
-    print "Output where (abs dir) : "
-    loc = $stdin.gets
+    att_id = Readline.readline('Which attachment to output? : ').to_i
+    loc = Readline.readline('Output where (abs dir) ? : ')
     loc.chomp!
-    att = Attachment.find(Issue.name, att_id)
+    att = Attachment.find(@db, Issue.name, att_id)
     
     fh = File.open("#{loc}/#{att.filename}", 'w')
     fh.write(att.data)
@@ -68,30 +85,46 @@ private
   end
 
   def show_attach
-    print "Which issue : "
-    issue_id = $stdin.gets.to_i
-    atts = Attachment.find_all_by_discriminator(Issue.name, issue_id)
+    issue_id = Readline.readline('Which issue id? : ').to_i
+    atts = Attachment.find_all_by_discriminator(@db, Issue.name, issue_id)
     atts.each do |att| 
       printf "[%d] - %s (alias: %s)\n", att.id, att.filename, att.given_name
     end
   end
 
+  # Archive means set status to 3 (arhive status) to the listed issues
+  def archive(cmd)
+    args = cmd.split[1..-1]
+
+    if args.length > 0 
+      if args[0] == 'finished'
+        puts "Archiving finished issues."
+        ArchiveFinishedIssues.new(@db).execute
+      else # gave ids
+        ids = args.map{|sids| sids.to_i}
+        issues = ids.map{|id| Issue.find(@db, id)} - [nil]
+        ArchiveIssues.new(issues).execute
+      end
+    else
+      puts "usage: "
+      puts "  archive finished"
+      puts "  archive <id>+"
+    end
+  end
+
   def attach
-    print "Attach to which issue? : "
-    issue_id = $stdin.gets.to_i
-    print "Absolute file location : "
-    loc = $stdin.gets
-    loc.chomp!
-    print "Alias name for file (optional) :"
-    name_alias = $stdin.gets
-    name_alias.chomp!
+    issue_id = Readline.readline('Attach to issue id: ').to_i
+    loc = Readline.readline('Absolute file location: ')
+    loc.strip!
+    name_alias = Readline.readline('Alias name for file (optional): ')
+    name_alias.strip!
     
     unless loc.nil?
       fh = File.open(loc, "r")
       data = fh.read
       fh.close
 
-      att = Attachment.new(Issue.name, issue_id)
+      att = Attachment.new(@db, Issue.name, issue_id)
       att.data       = data
       att.filename   = loc.split('/').last
       att.given_name = name_alias
@@ -103,11 +136,13 @@ private
   end
 
   def focus
-    puts "Focus on issue: "
-    issue_id = $stdin.gets.to_i
-    issue = Issue.find(issue_id)
-    SysConfig.last_focus = issue.id if issue
-    IssueUi.new(issue).run
+    issue_id = Readline.readline('Focus on issue : ').to_i
+    issue = Issue.find(@db, issue_id)
+    if issue
+      IssueUi.new(@db, issue).run
+    else 
+      puts "No such issue"
+    end
   end
 
   def outcsv
@@ -117,6 +152,7 @@ private
     fh.close
   end
 
+  # FIXME (update the command stuff)
   # Print the help of the cli app
   def print_help
     ["new",   "Create a new log entry", 
@@ -129,24 +165,48 @@ private
     end
   end
 
-  # TODO might need refactoring
   def show_issues
-    entries_arr = Issue.find_all
+    entries_arr = Issue.find_all(@db)
+    print_list(entries_arr)
+  end
+
+  # TODO might need refactoring
+  def print_list(entries_arr)
     issue_collections = entries_arr.reverse.group_by{|iss| iss.status_s}
     issue_collections.each_key do |stat|
-      print "\x1b[32;1m#{stat}\x1b[0m"
-      puts " [\x1b[35;1m#{issue_collections[stat].count}\x1b[0m]"
+      print @strmaker.green("#{stat}")
+      puts @strmaker.magenta(" #{issue_collections[stat].count}")
       issue_collections[stat].each do |iss|
-        puts "  [#{iss.id}] #{iss.description}"
+        print @strmaker.red("  [#{iss.id}] ")
+        puts "#{iss.description}"
       end
     end
   end
 
   def make_csv
-    cmd = MakeCsv.new
+    cmd = MakeCsv.new(@db)
     cmd.execute
     cmd.ret
   end
+
+  def generate_invoice
+    require 'time'
+    puts "Eg: valid input is Oct 2013 15"
+    from = Readline.readline("From: ")
+    to   = Readline.readline("To  : ")
+
+    from_time = Time.parse(from).to_i
+    to_time = Time.parse(to).to_i
+    issues = Issue.find_in_time_range(@db, from_time, to_time)
+  end
+
+  # Search for an issue
+  def search
+    term = Readline.readline("search issues for term : ")
+    issues = Issue.find_all(@db).select{|el| el.description.match(/#{term}/)}
+    print_list(issues)
+  end
+
 end
 end # module Wlog
 

data/lib/wlog/ui/commands/create_issue.rb

@@ -1,3 +1,4 @@
+require 'readline'
 require 'wlog/ui/commands/ui_command'
 require 'wlog/domain/issue'
 
@@ -5,14 +6,17 @@ module Wlog
 # Creational logic for issues
 # @author Simon Symeonidis
 class CreateIssue < UiCommand
+  def initialize(db)
+    @db = db
+  end
+
+  # Execute create issue transaction
   def execute
-    @ret = Issue.new
-    print "Small issue description :"
-    desc = $stdin.gets || "None."
+    @ret = Issue.new(@db)
+    desc = Readline.readline("Small issue description :") || "None."
     @ret.description = desc.chomp
     @ret.insert
   end
-
   attr_accessor :ret
 end
 end

data/lib/wlog/ui/issue_ui.rb

@@ -1,38 +1,43 @@
+require 'readline'
+
 require 'wlog/commands/replace_pattern'
 require 'wlog/commands/new_entry'
 require 'wlog/commands/make_csv'
 require 'wlog/commands/innit_db'
 require 'wlog/commands/concat_description'
+require 'wlog/domain/sys_config'
+require 'wlog/domain/timelog_helper'
 
 module Wlog
 # The interface when focusing on an issue
 # @author Simon
 class IssueUi
-  def initialize(issue)
+  def initialize(db, issue)
     @issue = issue
+    @db = db
+    @strmaker = SysConfig.string_decorator
   end
 
   # Start up the interface
   def run
     cmd = "default"
     until cmd == "end" do
-      print "[issue ##{@issue.id}] "
-      cmd = $stdin.gets || ""
+      cmd = Readline.readline("[issue ##{@issue.id}] ") || ""
       cmd.chomp!
 
       case cmd
-      when /attach/  then attach
-      when /new/     then new_entry
-      when /show/    then show_entries
-      when /desc/    then describe_issue
-      when /delete/  then delete_entry
-      when /search/  then search_term
-      when /concat/  then concat_description
-      when /replace/ then replace_pattern
-      when /search/  then search_term
-      when /forget/  then cmd = "end"
-      when /finish/  then finish.nil? ? nil : cmd = "end"
-      when /help/    then print_help
+      when /^new/     then new_entry
+      when /^show/    then show_entries
+      when /^desc/    then describe_issue
+      when /^delete/  then delete_entry
+      when /^search/  then search_term
+      when /^concat/  then concat_description
+      when /^replace/ then replace_pattern
+      when /^search/  then search_term
+      when /^lt/      then time(cmd.split.drop 1) # lt for log time
+      when /^forget/  then cmd = "end"
+      when /^finish/  then finish.nil? ? nil : cmd = "end"
+      when /^help/    then print_help
       else puts "Type 'help' for help"
       end
     end
@@ -43,6 +48,13 @@ class IssueUi
 
 private 
 
+  # Time logging command
+  def time(rest)
+    time = TimelogHelper.parse(rest.join) 
+    @issue.log_time(time)
+    puts @strmaker.green('logged time!')
+  end
+
   # Print the description of the issue
   def describe_issue; puts @issue end
 
@@ -61,8 +73,8 @@ private
 
   # Exit the issue, mark as finished
   def finish
-    print "Are you done with this task? [yes/no] : "
-    if ret = !!$stdin.gets.match(/^yes/i)
+    question = 'Are you done with this task? [yes/no] :'
+    if ret = !! Readline.readline(question).match(/^yes/i)
       @issue.mark_finished!
       @issue.update
     end
@@ -70,52 +82,46 @@ private
  
   # new entry command
   def new_entry
-    print "Enter new issue:#{$/}  "
-    description = $stdin.gets.chomp!
+    description = Readline.readline("Enter new issue:#{$/}  ")
+    description.chomp!
     @issue.mark_working!
     @issue.update
-    NewEntry.new(description, @issue.id).execute
+    NewEntry.new(@db, description, @issue.id).execute
   end
 
   def delete_entry
-    print "Remove task with id: "
-    LogEntry.delete($stdin.gets.to_i)
+    id = Readline.readline('Remove task log with id : ').to_i
+    LogEntry.delete_by_id(@db, id)
   end
 
   # Concatenate an aggregate description to a previous item
   def concat_description
-    print "ID of task to concatenate to: "
-    id = $stdin.gets.to_i
-    print "Information to concatenate: "
-    str = $stdin.gets.chomp!
-    ConcatDescription.new(id, str).execute
+    id = Readline.readline("ID of task to concatenate to: ").to_i
+    str = Readline.readline("Information to concatenate: ").chomp
+    ConcatDescription.new(@db, id, str).execute
   end
 
   # Replace a pattern from a description of a log entry
   def replace_pattern
-    print "ID of task to perform replace: "
-    id       = $stdin.gets.to_i
-    print "replace : "
-    old_pattern = $stdin.gets.chomp!
-    print "with    : "
-    new_pattern = $stdin.gets.chomp!
-    ReplacePattern.new(id, old_pattern, new_pattern).execute
+    id = Readline.readline("ID of task to perform replace: ").to_i
+    old_pattern = Readline.readline('replace : ').chomp
+    new_pattern = Readline.readline('with    : ').chomp
+    ReplacePattern.new(@db, id, old_pattern, new_pattern).execute
   end
 
   def search_term
-    print "Term to search: "
-    term = $stdin.gets.chomp!
-    print_entries(LogEntry.search_descriptions(term))
+    term = Readline.readline('search : ').chomp!
+    print_entries(LogEntry.search_descriptions(@db, term))
   end
 
   # TODO might need refactoring
   def show_entries
-    entries_arr = LogEntry.find_all_by_issue_id @issue.id
+    entries_arr = LogEntry.find_all_by_issue_id(@db, @issue.id)
     date_collections = entries_arr.group_by{|le| le.date.strftime("%Y-%m-%d")}
     date_collections.each_key do |date_c|
-    print "\x1b[32;1m#{date_c}\x1b[0m - "
-    print "\x1b[33;1m%9s\x1b[0m " % [date_collections[date_c].first.date.strftime("%A")]
-    puts "[\x1b[35;1m#{date_collections[date_c].count}\x1b[0m]"
+    print @strmaker.green("#{date_c} - ")
+    print @strmaker.yellow(date_collections[date_c].first.date.strftime("%A"))
+    puts " [#{@strmaker.magenta(date_collections[date_c].count.to_s)}]"
       date_collections[date_c].each do |le|
         puts "  #{le}"
       end