wlog 1.1.7 → 1.2.0

data/lib/wlog/domain/git_commit.rb

@@ -0,0 +1,11 @@
+module Wlog
+# A git commit message
+# @author Simon Symeonidis
+class GitCommit 
+  def initialize
+    @commit = @author = @shortlog = @message = ""
+  end
+
+  attr_accessor :commit, :author, :shortlog, :message
+end
+end

data/lib/wlog/domain/issue.rb

@@ -12,6 +12,7 @@ module Wlog
 class Issue < ActiveRecord::Base
 
   has_many :log_entries, dependent: :delete_all
+  has_many :attachments, as: :attachable
 
   StatusNew       = 0
   StatusStarted   = 1
@@ -40,7 +41,9 @@ class Issue < ActiveRecord::Base
 	 "#{@strmaker.yellow('Summary')} #{$/}"\
     "  #{description}#{$/ + $/}"\
 	 "#{@strmaker.yellow('Description')} #{$/}"\
-    "  #{Helpers.break_string(long_description, 80)}#{$/ + $/}"
+    "  #{Helpers.break_string(long_description, 80)}#{$/ + $/}"\
+    "#{@strmaker.yellow('Files')}#{$/}"\
+    "#{attachments_s}"
   end
 
   # Mark issue as started
@@ -65,6 +68,16 @@ private
     StatusFinished => "finished", 
     StatusArchived => "archived"}
 
+  # Stringify attachments for terminal output
+  def attachments_s
+    str = ''
+    self.attachments.each do |att| 
+      str.concat(att.to_s)
+    end
+    str = @strmaker.red("  N/A#{$/}") if str == '' # no attachments
+    str.concat($/)
+  str end
+
 private_class_method
 
 end # class  Issue

data/lib/wlog/domain/key_value.rb

@@ -19,7 +19,7 @@ class KeyValue < ActiveRecord::Base
       ret = KeyValue.new(:key => key, :value => value)
     end
     ret.save
-  end
+  nil end
 
   # Get a certain value by key
   # @return the value given the key. nil if not found

data/lib/wlog/domain/template_helper.rb

@@ -0,0 +1,21 @@
+require 'wlog/domain/key_value'
+require 'wlog/domain/static_configurations'
+
+module Wlog
+# Bunlde helper functions for templates here
+# @author Simon Symeonidis 
+class TemplateHelper
+  include StaticConfigurations     
+  # @return absolute path to the template the user has set
+  def self.template_file
+    num = KeyValue.get('template') || 1
+    Dir[TemplateDir + '*'][num.to_i - 1]
+  end
+
+  # @return template contents of the current selected template
+  def self.template_s
+    File.read(TemplateHelper.template_file)
+  end
+
+end
+end

data/lib/wlog/migrations/fix_attachments_polymorphic_table.rb

@@ -0,0 +1,15 @@
+require 'active_record'
+
+module Wlog
+# Add type, id polymorphic fields
+# @author Simon Symeonidis
+# @date Sun Oct  5 22:43:12 EDT 2014
+class FixAttachmentsPolymorphicTable < ActiveRecord::Migration
+
+  def change
+    add_column :attachments, :attachable_id, :integer
+    add_column :attachments, :attachable_type, :text
+  end
+
+end
+end

data/lib/wlog/migrations/make_standard_tables.rb

@@ -44,16 +44,3 @@ class MakeStandardTables < ActiveRecord::Migration
 end
 end 
 
-
-=begin
-TODO
--- A polymorphic relationship for attachments. So pretty much anything that
--- wants to have something attached, uses the discriminator in order to 
--- specify itself, as well as its id. 
-CREATE TABLE polymorphic_attachments (
-  discriminator    TEXT, 
-  discriminator_id INTEGER, 
-  attachment_id    INTEGER
-);
-
-=end

data/lib/wlog/tech/git_commit_parser.rb

@@ -0,0 +1,48 @@
+require 'wlog/domain/git_commit'
+module Wlog
+# Parses git text from a `git log` command invocation
+# @author Simon Symeonidis
+class GitCommitParser
+  # @param log_s is the string obtained from running a `git log` command
+  # @return a list of GitCommit objects
+  def self.parse(log_s)
+    cur = nil 
+    inmessage = false 
+    gitlogs = [] 
+     
+    log_s.lines.each do |line| 
+      case line
+      when /^commit/i
+        inmessage = false 
+        gitlogs.push cur if cur
+        cur = GitCommit.new
+        cur.commit = line.split[1].strip
+                            
+      when /^author/i
+        next unless cur
+        cur.author = line.split[1].strip
+                                   
+      when /^date/i, /^\n$/
+        next
+                                          
+      else 
+        next unless cur
+        if inmessage
+          cur.message.concat(line)
+          cur.message.strip!
+        else
+          cur.shortlog = line
+          cur.shortlog.strip! 
+          inmessage = true
+        end 
+      end
+    
+    end
+    
+    # if commits have no hash, discard them
+    gitlogs.reject! { |e| e.commit == "" }
+    gitlogs.push cur if cur
+  gitlogs end
+
+end
+end

data/lib/wlog/tech/git_commit_printer.rb

@@ -0,0 +1,19 @@
+require 'wlog/domain/sys_config'
+module Wlog
+# Cute printer for git commit logs
+# @author Simon Symeonidis
+module GitCommitPrinter
+
+  def print_git_commits(commit_a)
+    sm = SysConfig.string_decorator 
+    
+    commit_a.each do |commit| 
+      print '  '
+      print sm.blue(commit.commit)
+      print ' ' 
+      puts  sm.green(commit.shortlog[0..50] + ' ...')
+    end
+  nil end
+
+end
+end

data/lib/wlog/tech/uncolored_string.rb

@@ -1,7 +1,7 @@
 module Wlog
 # Use this if the system does not support colored strings.
 # @author Simon Symeonidis 
-class UncoloredString
+class UncoloredString # :nodoc:
   def self.red(str); str end
   def self.yellow(str); str end
   def self.magenta(str); str end

data/lib/wlog/ui/bootstrap.rb

@@ -7,6 +7,7 @@ module Wlog
 # point of the application and, the first transaction you require.
 # @author Simon Symeonidis
 class Bootstrap
+  # make $HOME/.config/wlog standard dirs, and pull up database
   def self.configure!
     Helpers.make_dirs!
     InnitDb.new.execute 

data/lib/wlog/ui/cli_interface.rb

@@ -2,7 +2,6 @@ require 'readline'
 require 'wlog/domain/issue'
 require 'wlog/domain/static_configurations'
 require 'wlog/domain/sys_config'
-require 'wlog/domain/attachment'
 require 'wlog/domain/helpers'
 
 require 'wlog/commands/create_issue'
@@ -14,6 +13,7 @@ require 'wlog/commands/delete_issue'
 require 'wlog/ui/issue_ui'
 require 'wlog/ui/template_ui'
 require 'wlog/ui/invoice_ui'
+require 'wlog/ui/git_ui'
 
 module Wlog
 # @author Simon Symeonidis
@@ -38,9 +38,6 @@ class CliInterface
 
       case cmd
       when /^archive/ then archive cmd
-      when /^showattach/ then show_attach
-      when /^outattach/  then output_attach
-      when /^attach/ then attach
       when /^focus/  then focus(cmd)
       when /new/    then new_issue
       when /^(ls|show)/   then show_issues
@@ -49,6 +46,7 @@ class CliInterface
       when /^help/   then print_help
       when /^search/ then search
       when /^config/ then config
+      when /^git/ then GitUi.new.run
       when /^templates/ then TemplateUi.new.run
       when /^invoices/ then InvoiceUi.new.run
       end
@@ -93,32 +91,6 @@ private
 
     puts "No such issue" unless dcmd.deleted?
   end
-
-  # Wriet out the data contained in the database of the attachment
-  def output_attach
-    puts "Migration of implementation pending" 
-    return
-
-    att_id = Readline.readline('Which attachment to output? : ').to_i
-    loc = Readline.readline('Output where (abs dir) ? : ')
-    loc.chomp!
-    att = Attachment.find(@db, Issue.name, att_id)
-    
-    fh = File.open("#{loc}/#{att.filename}", 'w')
-    fh.write(att.data)
-    fh.close
-  end
-
-  def show_attach
-    puts "Migration of implementation pending" 
-    return
-    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]
@@ -139,32 +111,6 @@ private
     end
   end
 
-  def attach
-    puts "Migration of implementation pending" 
-    return
-
-    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(@db, Issue.name, issue_id)
-      att.data       = data
-      att.filename   = loc.split('/').last
-      att.given_name = name_alias
-      att.insert
-      puts 'Attached file.'
-    else
-      puts 'You need to provide a proper path.'
-    end
-  end
-
   # Focus on an issue to log work etc
   def focus(cmd)
     issue_id = cmd.split[1]
@@ -200,8 +146,6 @@ private
     'end',    'Exit the progam',
     'delete', 'Remove the issue with a given id',
     'archive', 'Archive a file into a specific issue',
-    'showattach', 'Show what files have been attached to an issue',
-    'outattach', 'Extract a file from the database',
     'invoices', 'Go to invoices interface',
     'templates', 'Go to template interface, and set templates',
     'focus', 'Focus on a particular ',

data/lib/wlog/ui/edit_handler.rb

@@ -1,6 +1,8 @@
 require 'wlog/domain/sys_config'
 
 module Wlog
+# Provides a bunch of edit helping functions for altering already inserted
+# information about issues.
 # @author Simon Symeonidis
 class EditHandler
 
@@ -36,7 +38,9 @@ class EditHandler
     end
   end
   
+  # Small helper to parse the due date when editing the dates of issues.
   # @param time is the date-time in string format (eg Oct 28)
+  # @return nothing - we're just setting if the data format is ok
   def edit_time(time)
     date_time = time_handle(time)
     @issue.update(:due_date => date_time)
@@ -46,6 +50,9 @@ class EditHandler
       "Invalid date/time format. Try format like 'Oct 28'"
   end
 
+  # Edit the reported date of an issue, given a date string in the format of
+  #   'Oct 28'.
+  # @param time_str is the time in string format
   def edit_reported_time(time_str)
     date_time = time_handle(time_str)
     @issue.reported_date = date_time.to_time

data/lib/wlog/ui/git_ui.rb

@@ -0,0 +1,47 @@
+require 'wlog/domain/sys_config'
+module Wlog
+# Interface to setup git stuff.
+# @author Simon Symeonidis
+class GitUi
+  
+  def initialize
+    @strmaker = SysConfig.string_decorator
+  end
+
+  def run 
+    cmd = "default" 
+
+    until cmd == "end" do 
+      cmd = Readline.readline("[#{@strmaker.blue('git')}] ")
+
+      case cmd 
+      when /^set/
+        path = Readline.readline("Path to git repo (eg: project/.git/): ")
+        
+        unless File.directory? path
+          puts @strmaker.red("That doesn't look like a git repo. Nothing done")
+          next
+        end
+
+        author = Readline.readline("git author: ")
+ 
+        # Set the git repo in the db (so one git repo per db)
+        KeyValue.put!("git", path)
+        KeyValue.put!("author", author)
+
+      when /^unset/
+        KeyValue.put!("git", "")
+
+      when /^(ls|show)/
+        print '  repo: '
+        puts @strmaker.green(KeyValue.get("git"))
+        print '  auth: '
+        puts @strmaker.yellow(KeyValue.get("author"))
+
+      end
+    end
+  end
+
+end
+end
+

data/lib/wlog/ui/invoice_ui.rb

@@ -2,6 +2,11 @@ require 'readline'
 require 'wlog/domain/invoice'
 require 'wlog/domain/sys_config'
 require 'wlog/domain/static_configurations'
+require 'wlog/domain/template_helper'
+require 'wlog/commands/write_template'
+require 'wlog/commands/fetch_git_commits'
+require 'wlog/commands/fetch_git_commits_standard'
+require 'wlog/tech/git_commit_printer'
 require 'erb'
 
 module Wlog
@@ -9,6 +14,7 @@ module Wlog
 # @author Simon Symeonidis
 class InvoiceUi
   include StaticConfigurations
+  include GitCommitPrinter
 
   def initialize
     @strmaker = SysConfig.string_decorator
@@ -24,6 +30,8 @@ class InvoiceUi
       when /^(ls|show)/ then ls
       when /^delete/    then delete(cmd.split.drop 1)
       when /^generate/  then generate(cmd.split.drop 1)
+      when /^commits/   then commits(cmd.split.drop 1)
+      when 'help'       then print_help
       when /^end/       then next
       else 
         puts "type 'help' for a list of options"
@@ -36,25 +44,19 @@ private
   # TODO maybe separate this in the future for better testing.
   def generate(rest)
     num = rest.first || 1
+
     @invoice = Invoice.find(num.to_i)
-    
-    # NOTE: these need to be instance vars, so we expose them to ERB later on
-    @les = @invoice.log_entries_within_dates
-    @issues = [Issue.find(*(@les.collect(&:issue_id).uniq))].compact.flatten
-    
-    # Get the template
-    num        = SysConfig.get_config('template') || 1
-    tpath      = Dir[TemplateDir + '*'][num.to_i - 1]
-    template_s = File.read(tpath)
+    cmd = FetchGitCommitsStandard.new(@invoice.from, @invoice.to)
+    cmd.execute
 
-    renderer = ERB.new(template_s)
+    @log_entries = @invoice.log_entries_within_dates
+    @issues = [Issue.find(*(@log_entries.collect(&:issue_id).uniq))].compact.flatten
+    @commits = cmd.commits
+    
+    renderer = ERB.new(TemplateHelper.template_s)
     output = renderer.result(binding)
 
-    FileUtils.mkdir_p TemplateOutputDir
-    template_ext = tpath.split(File::SEPARATOR).last.split('.').last
-    filename = TemplateOutputDir + "#{@invoice.id}-invoice.#{template_ext}"
-
-    File.write(filename, output)
+    WriteTemplate.new(output, @invoice).execute
 
   rescue ActiveRecord::RecordNotFound
     puts 'No such invoice'
@@ -105,29 +107,44 @@ private
   # TODO: this would have to be factored out at some point. Also I think the
   # implementation is crappy. I have to recheck at some point.
   def longtext
-    times = 3
-    str = ""
-    count = 0
-
-    while times != 0 do
-      cur = Readline.readline()
-      str.concat(cur)
-      str.concat($/)
-      if ["", nil].include? cur
-        str.concat($/)
-        count += 1
-        if count == 2
-          times -= 1
-          count = 0
-        end
-      else 
-        # reset blank line count. The user will have to hammer enter a few times
-        # to escape from this menu
-        count = 0
-      end
-    end
+   count = 0 
+   status = nil
+   str = ""
+   
+   until status == :end_text do 
+     line = Readline.readline(@strmaker.blue('> ')).strip
+     count += 1 if line == ""
+     count  = 0 if line != ""
+
+     str.concat(line).concat($/)
+   
+     status = :end_text and next if count == 2
+   end 
   str end
 
+  def commits(invoice_id)
+    inv = Invoice.find_by_id(invoice_id) 
+    repo = KeyValue.get('git')
+    author = KeyValue.get('author')
+
+    unless repo 
+      puts @strmaker.red("You need to set a git repo first")
+      return
+    end
+
+    command = FetchGitCommits.new(inv.from, inv.to, repo, author)
+    command.execute
+
+    puts
+    print '  '
+    puts "git commits for #{@strmaker.yellow(author)}"
+    puts
+    print_git_commits(command.commits)
+    
+  rescue ActiveRecord::RecordNotFound
+    puts @strmaker.red("No such invoice")
+  end
+
 end
 end