wlog 0.0.3 → 1.0.0

data/lib/wlog/domain/helpers.rb

@@ -0,0 +1,42 @@
+require 'wlog/domain/static_configurations'
+
+module Wlog
+# This contains a few helper methods that may be used by any part in the 
+# application.
+# @author Simon Symeonidis
+class Helpers
+  include StaticConfigurations
+  # Break the string to a different line 
+  # @param string is the string that we want processed.
+  # @param numchars is the amount of characters max per line.
+  def self.break_string(string,numchars)
+    desc , cl = "", 0
+    string.split.each do |word|
+      wlength = word.length
+      if cl + wlength + 1 > numchars
+        cl = 0
+        desc.concat($/)
+      end
+      desc.concat(word).concat(" ")
+      cl += wlength + 1
+    end
+    desc.chomp!
+  desc end
+
+  # Check to see if the database exists in the DataDirectory
+  # @return true if exists, otherwise false
+  def self.database_exits?
+    File.exists? "#{DataDirectory}#{ARGV[0] || DefaultDb}"
+  end
+
+  # Check to see if DataDirectory exists
+  # Create the data directory if it does not exist.
+  def self.make_dirs!
+    # Does the data dir path not exist?
+    unless File.exists? DataDirectory
+      FileUtils.mkdir_p DataDirectory
+    end
+  nil end
+end
+end # module Wlog
+

data/lib/wlog/domain/issue.rb

@@ -0,0 +1,100 @@
+require 'wlog/db_registry'
+require 'wlog/domain/sql_modules/issue_sql'
+require 'wlog/domain/log_entry'
+
+module Wlog
+# This aggregates log entries. The total time spent on this issue is
+# calculated from checking out said log entries.
+# @author Simon Symeonidis 
+class Issue
+  include IssueSql
+
+  def initialize
+    @reported_date = Time.now
+    @log_entries   = Array.new
+    @status        = 0
+  end
+
+  def self.find(id)
+    issue = Issue.new
+    ret = DbRegistry.instance.execute(SelectSql, id).first
+    issue.quick_assign! ret
+  issue end
+
+  def self.find_all
+    arr = Array.new
+    DbRegistry.instance.execute(SelectAllSql).each do |row|
+      issue = Issue.new
+      issue.quick_assign! row
+      arr.push issue
+    end
+  arr end
+
+  def self.delete(id); DbRegistry.instance.execute(DeleteSql, id) end
+
+  def insert
+    DbRegistry.instance
+      .execute(InsertSql, @description, 
+        @reported_date.to_i, @due_date.to_i, @status)
+  end
+
+  def delete; DbRegistry.instance.execute(DeleteSql, @id) end
+
+  def update
+    DbRegistry.instance
+      .execute(UpdateSql, @description, @reported_date.to_i, 
+               @due_date.to_i, @status, @id)
+  end
+
+  # Add a log entry object to the issue
+  def add_log_entry(le)
+    @log_entries.push le
+  end
+
+  def quick_assign!(row)
+    @id, @description, @reported_date, @due_date , @status =\
+      row[0], row[1], Time.at(row[2]), Time.at(row[3]), row[4]
+  nil end
+
+  def to_s
+    "+ Issue ##{@id}#{$/}"\
+    "  - Reported : #{@reported_date}#{$/}"\
+    "  - Due      : #{@due_date}#{$/}"\
+    "  - Entries  : #{@log_entries.count}#{$/}"\
+    "  - Status   : "\
+    "#{$/}"\
+    "  - #{@description}"
+  end
+
+  def mark_started!; @status = 0 end
+  def mark_working!; @status = 1 end
+  def mark_finished!; @status = 2 end
+  def status_s; Statuses[@status] end
+
+  # [String] Description of the issue at hand
+  attr_accessor :description
+
+  # [Time] The due date of the issue
+  attr_accessor :due_date
+  
+  # [Time] The reported date of the issue
+  attr_accessor :reported_date
+  
+  # [Array<LogEntry>] an array containing the log entries that are specific
+  # to this issue
+  attr_accessor :log_entries
+
+  # [Fixnum] is the identifier of this object
+  attr_accessor :id
+
+  # [Fixnum] Status of the current issue (0 is for not started, 1 working on, 
+  # 2 for finished)
+  attr_accessor :status
+
+private
+
+  Statuses = {0 => "new", 1 => "started work", 2 => "finished"}
+
+end # class  Issue
+end # module Wlog
+

data/lib/wlog/domain/key_value.rb

@@ -0,0 +1,55 @@
+require 'wlog/db_registry'
+require 'wlog/domain/sql_modules/key_value_sql'
+module Wlog
+# An active record that stores keys with values. Keys and values are strings.
+# convert as you need them.
+#
+# Note the behaviour on this; it's exactly like a ruby hash, so if you store
+# a string 'jon' as a key with value '12', and then you store 'jon' with value
+# '42', when looking up 'jon' you will retrieve only the latter (42).
+#
+# @author Simon Symeonidis
+class KeyValue
+  include KeyValueSql
+
+  # Insert a key in the storage. If exists, replace the value with new one
+  # @return nil
+  def self.put!(key, value)
+    if self.get(key).nil?
+      self.create!(key, value)
+    else 
+      self.update(key, value)
+    end
+  nil end
+
+  # Get a certain value by key
+  # @return the value given the key. nil if not found
+  def self.get(key)
+    ret = DbRegistry.instance.execute(Select, key)
+    ret = ret.empty? ? nil : ret.first
+  end
+
+  # destroy by key
+  def self.destroy!(key)
+    DbRegistry.instance.execute(DeleteSql, key)
+  nil end
+
+private
+
+  # We want to provide a simple interface to the kv store, so the user should
+  # not really care about updates
+  def self.update(key,value)
+    DbRegistry.instance.execute(UpdateSql, value, key)
+  end
+
+  # Create a pair... ;)
+  def self.create!(key, value)
+    DbRegistry.instance.execute(InsertSql, key, value)
+  end
+
+  class << self
+    private :new, :allocate
+  end
+end 
+end # module Wlog
+

data/lib/wlog/domain/log_entry.rb

@@ -0,0 +1,100 @@
+require 'wlog/db_registry'
+require 'wlog/domain/helpers'
+require 'wlog/domain/attachment'
+require 'wlog/domain/sql_modules/log_entry_sql'
+
+module Wlog
+# Author :: Simon Symeonidis 
+#  Active Record Domain object for a log entry
+class LogEntry
+  include LogEntrySql
+
+  def initialize
+    @date = Time.new
+  end
+
+  def self.find(id)
+    row = DbRegistry.instance.execute(Select,id).first
+    le = LogEntry.new
+    le.quick_assign!(row[0], row[1], Time.at(row[2]))
+  le end
+
+  def self.find_all
+    self.generic_find_all(SelectAll)
+  end
+
+  def self.find_all_by_issue_id(id)
+    self.generic_find_all(SelectAllByIssue, id)
+  end
+
+  # Delete a log entry with a given id. 
+  # @example Simple usage
+  #   # Since this is a class method:
+  #   LogEntry.delete(12)
+  def self.delete(id)
+    DbRegistry.instance.execute(DeleteSql,id)
+  end
+
+  # update the entry
+  def update
+    DbRegistry.instance.execute(UpdateSql,@description,@id)
+  end
+
+  # Search by string to find a matching description with 'LIKE'.
+  def self.search_descriptions(term)
+    all = Array.new
+    DbRegistry.instance.execute(SelectDescriptionLike,"%#{term}%").each do |row|
+      le = LogEntry.new
+      le.quick_assign!(row[0], row[1], Time.at(row[2]))
+      all.push le
+    end
+  all end
+
+  def insert
+    DbRegistry.instance.execute(InsertSql, @description, @date.to_i, @issue_id)
+  end
+
+  # Delete the loaded log entry currently in memory, by passing its id
+  def delete
+    self.delete(self.id)
+  end
+
+  def quick_assign!(id,desc,date,issue_id)
+    @id, @description, @date, @issue_id = id, desc, date, issue_id
+  end
+
+  # Print things nicely formmated no more than 80 cars (well, unless you stick
+  # the time in the end which is not counted for).
+  def to_s
+    str    = "[#{id}] "
+    tmp    = @description + " [#{@date.strftime("%H:%M:%S")}]"
+    desc   = Helpers.break_string(tmp,80)
+    indent = " " * (id.to_s.split('').count + 5)
+    desc.gsub!(/#{$/}/, "#{$/}#{indent}")
+    str.concat(desc)
+  str end
+
+  # The identity field for the log entry DO
+  attr_accessor :id
+
+  # Text description for the log entry 
+  attr_accessor :description
+
+  # Date the entry was created
+  attr_accessor :date
+
+  # The issue id (parent of this log entry)
+  attr_accessor :issue_id
+ 
+private
+  def self.generic_find_all(sql, *params)
+    all = Array.new
+    DbRegistry.instance.execute(sql, *params).each do |row|
+      le = LogEntry.new
+      le.quick_assign!(row[0], row[1], Time.at(row[2]), row[3])
+      all.push le
+    end
+  all end
+end
+end # module Wlog
+

data/lib/wlog/domain/sql_modules/attachment_sql.rb

@@ -0,0 +1,21 @@
+module Wlog
+# The sql for attachments
+# @author Simon Symeonidis
+module AttachmentSql
+  # The table name 
+  TableName = "attachments"
+
+  # Insert the file data into the database (NOTE wondering if small/big endian
+  # will be affecting this...)
+  InsertSql = "INSERT INTO #{TableName} (filename, given_name, data) "\
+    "values (?, ?, ?); "
+
+  # Delete by id
+  DeleteSql = "DELETE FROM #{TableName} WHERE discriminator = ? AND "\
+    "discriminator_id = ?;" 
+
+  # Select an attachment given an id
+  SelectSql = "SELECT * FROM #{TableName} WHERE id = ? "
+end
+end
+

data/lib/wlog/domain/sql_modules/issue_sql.rb

@@ -0,0 +1,28 @@
+module Wlog
+# Issue SQL 
+# @author Simon Symeonidis
+module IssueSql
+  # The table name of the log entries table
+  TableName = "issues"
+
+  # Standard insert
+  InsertSql = \
+    "INSERT INTO #{TableName} "\
+    "(description, reported_date, due_date, status) "\
+    "values (?,?,?,?);"
+  # Standard delete
+  DeleteSql = "DELETE FROM #{TableName} WHERE id = ? ;"
+
+  # Standard update
+  UpdateSql = "UPDATE #{TableName} SET "\
+    "description = ? , reported_date = ? , due_date = ? , status = ?"\
+    "WHERE id = ?;"
+  
+  # Select by id
+  SelectSql = "SELECT * FROM #{TableName} WHERE id = ? ;"
+
+  # Select all the issues
+  SelectAllSql = "SELECT * FROM #{TableName}; "
+end
+end
+

data/lib/wlog/domain/sql_modules/key_value_sql.rb

@@ -0,0 +1,20 @@
+module Wlog
+# Encapsulate the sql in only one part.
+# @author Simon Symeonidis
+module KeyValueSql
+  # The table name of the log entries table
+  TableName = "key_values"
+
+  # Standard insert
+  InsertSql = \
+    "INSERT INTO #{TableName} (key,value) values (?,?);"
+  # Standard delete
+  DeleteSql = "DELETE FROM #{TableName} WHERE key = ? ;"
+
+  # Standard update
+  UpdateSql = "UPDATE #{TableName} SET value = ? WHERE key = ?;"
+  
+  # Select by key
+  Select = "SELECT * FROM #{TableName} WHERE key = ? ;"
+end
+end

data/lib/wlog/domain/sql_modules/log_entry_sql.rb

@@ -0,0 +1,35 @@
+module Wlog
+# Encapsulate the sql in only one part.
+# @author Simon Symeonidis
+module LogEntrySql
+  # The table name of the log entries table
+  TableName = "log_entries"
+
+  # Standard insert
+  InsertSql = \
+    "INSERT INTO #{TableName} (description,date,issue_id) values (?,?,?);"
+  # Standard delete
+  DeleteSql = "DELETE FROM #{TableName} WHERE id = ? ;"
+
+  # Standard select all
+  SelectAll = "SELECT * FROM #{TableName} ORDER BY date ASC;"
+  
+  # Standard update
+  UpdateSql = "UPDATE #{TableName} SET description = ? WHERE id = ?;"
+  
+  # select all with a limit
+  SelectAllLimit = \
+    "SELECT * FROM #{TableName} WHERE date >="\
+    " #{Time.now.to_i - 604800 - 24 * 60 * 60} ORDER BY date ASC"
+  
+  # Select by id
+  Select = "SELECT * FROM #{TableName} WHERE id = ? ;"
+  
+  # Select by id
+  SelectAllByIssue = "SELECT * FROM #{TableName} WHERE issue_id = ? ;"
+
+  # Select by a regex like /.../i
+  SelectDescriptionLike = \
+    "SELECT * FROM #{TableName} WHERE description LIKE ?;"
+end
+end

data/lib/wlog/domain/sql_modules/polymorphic_attachments_sql.rb

@@ -0,0 +1,24 @@
+module Wlog
+# Sql for polymorphic attachments
+# @author Simon Symeonidis
+module PolymorphicAttachmentsSql
+
+  # The table name
+  TableName = "polymorphic_attachments"
+
+  # Select entries by discriminator name, and id
+  SelectSql = "SELECT * FROM #{TableName} WHERE "\
+    "discriminator = ? AND discriminator_id = ? "
+
+  # Insert an attachment given the current thing in hand
+  InsertSql = "INSERT INTO #{TableName} "\
+    "(discriminator, discriminator_id, attachment_id) values "\
+    "(? , ? , ?)"
+
+  # Delete an attachment from the attached thing
+  DeleteSql = "DELETE FROM #{TableName} WHERE "\
+   "discriminator = ? AND discriminator_id = ?"
+
+end
+end
+

data/lib/wlog/domain/static_configurations.rb

@@ -0,0 +1,24 @@
+module Wlog
+# Static path data.
+#
+# Please follow the convention that if vars are dirs, then they end with '/'
+#
+# @author  Simon Symeonidis 
+module StaticConfigurations
+  # The application name
+  AppName = "wlog"
+  
+  # Absolute path to the configuration directory
+  ConfigDirectory = "#{ENV['HOME']}/.config/"
+
+  # Absolute path to the application directory
+  AppDirectory = "#{ConfigDirectory}#{AppName}/"
+
+  # Absolute path to the data directory
+  DataDirectory = "#{AppDirectory}data/"
+
+  # Default database name (when unspecified)
+  DefaultDb = "default"
+end
+end # module Wlog
+