wlog 1.1.1 → 1.1.5

data/lib/wlog/domain/issue.rb

@@ -1,5 +1,5 @@
-require 'wlog/db_registry'
-require 'wlog/domain/sql_modules/issue_sql'
+require 'active_record' 
+
 require 'wlog/domain/log_entry'
 require 'wlog/domain/timelog_helper'
 require 'wlog/domain/sys_config'
@@ -9,164 +9,64 @@ 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(db_handle)
-    @reported_date = Time.now
-    @log_entries   = Array.new
-    @status = @seconds = 0
-    @db = db_handle
-    @strmaker = SysConfig.string_decorator
-  end
-
-  # Calculate the total time that someone has wasted on all the
-  # issues in the current database
-  def self.total_time
-    # issues = Issue.find_all
-  end
-
-  def self.find(db, id)
-    issue = Issue.new(db)
-    ret = db.execute(SelectSql, id).first
-    if ret.nil? || ret.empty?
-      issue = nil
-    else 
-      issue.quick_assign! ret
-    end
-  issue end
-
-  def self.find_all(db)
-    self.generic_find_all(db, SelectAllSql)
-  end
-
-  def self.find_all_finished(db)
-    self.generic_find_all(db, SelectFinishedSql)
-  end
-
-  def self.find_in_time_range(db, from, to)
-    arr = Array.new
-    db.execute(SelectTimeRange, from, to).each do |row|
-      tmp = Issue.new(@db)
-      tmp.quick_assign!(row)
-      arr.push tmp
-    end
-  arr end
-
-  def self.delete_by_id(db, id); db.execute(DeleteSql, id) end
-
-  # inserts the entry into the database if it has not been stored before.
-  def insert
-    unless @id
-      @db.execute(InsertSql, @description, 
-        @reported_date.to_i, @due_date.to_i, @status, @long_description)
-      @id = @db.last_row_from(TableName).first[0]
-    end
-  end
+class Issue < ActiveRecord::Base
 
-  def delete; @db.execute(DeleteSql, @id) end
+  has_many :log_entries, dependent: :delete_all
 
-  def update
-    @db.execute(UpdateSql, @description, @reported_date.to_i, 
-                @due_date.to_i, @status, @seconds, @id)
-  end
-
-  # Add a log entry object to the issue
-  # TODO this does nothing / used for nothing yet
-  def add_log_entry(le)
-    @log_entries.push le
-  end
+  StatusNew       = 0
+  StatusStarted   = 1
+  StatusFinished  = 2
+  StatusArchived  = 3
 
-  def quick_assign!(row)
-    @id, @description, @reported_date, @due_date, @status, @seconds,
-    @long_description =\
-      row[0], row[1], Time.at(row[2]), Time.at(row[3]), row[4], 
-      row[5] || 0, row[6]
-  nil end
+  # Anything which is not archived (eg: new, started work, finished)
+  def self.find_not_archived; where("status NOT IN (?)", StatusArchived) end
 
   # Log the seconds into the issue
-  def log_time(seconds)
-    @seconds += seconds
-    update
+  def log_time(sec)
+    self.timelog += sec
+    save
   end
 
   def to_s
-    "#{@strmaker.yellow('Issue')} ##{@id}#{$/}"\
-    "  #{@strmaker.blue('Reported')} : #{@reported_date.asctime}#{$/}"\
-    "  #{@strmaker.blue('Due')}      : #{@due_date.asctime}#{$/}"\
-    "  #{@strmaker.blue('Entries')}  : #{@log_entries.count}#{$/}"\
-    "  #{@strmaker.blue('Status')}   : #{Statuses[@status]}#{$/}"\
-    "  #{@strmaker.blue('Time')}     : #{TimelogHelper.time_to_s(@seconds)}#{$/}"\
+    le_count = self.log_entries.count
+    @strmaker = SysConfig.string_decorator
+    "#{@strmaker.yellow('Issue')} ##{id}#{$/}"\
+    "  #{@strmaker.blue('Reported')} : #{created_at.asctime}#{$/}"\
+    "  #{@strmaker.blue('Due')}      : #{due_date.asctime}#{$/}"\
+    "  #{@strmaker.blue('Entries')}  : #{le_count} #{$/}"\
+    "  #{@strmaker.blue('Status')}   : #{Statuses[status]}#{$/}"\
+    "  #{@strmaker.blue('Time')}     : #{TimelogHelper.time_to_s(timelog)}#{$/}"\
     "#{$/}"\
 	 "#{@strmaker.yellow('Summary')} #{$/}"\
-    "  #{@description}#{$/ + $/}"\
+    "  #{description}#{$/ + $/}"\
 	 "#{@strmaker.yellow('Description')} #{$/}"\
-    "  #{Helpers.break_string(@long_description, 80)}#{$/ + $/}"
+    "  #{Helpers.break_string(long_description, 80)}#{$/ + $/}"
   end
 
   # Mark issue as started
-  def mark_started!; @status = 0 end
+  def mark_started!; self.status = 0 end
   
   # Mark the issue as working
-  def mark_working!; @status = 1 end
+  def mark_working!; self.status = 1 end
   
   # Mark the issue as finished
-  def mark_finished!; @status = 2 end
+  def mark_finished!; self.status = 2 end
 
   # Archive the issue
-  def archive!; @status = 3 end
+  def archive!; self.status = 3 end
 
   # Get the status as a string
-  def status_s; Statuses[@status] end
-
-  # [String] Description of the issue at hand
-  attr_accessor :description
-
-  # A longer description that can provide more details as opposed to a simple
-  # title as suggested by @description.
-  attr_accessor :long_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
-
-  # The seconds that you have wasted your life on in order to get something
-  # done
-  attr_accessor :seconds
-
-  # The database handle for this AR
-  attr_accessor :db
+  def status_s; Statuses[status] end
 
 private
-
   Statuses = {
-    0 => "new", 1 => "started work", 
-    2 => "finished", 3 => "archived"}
+    StatusNew      => "new", 
+    StatusStarted  => "started work", 
+    StatusFinished => "finished", 
+    StatusArchived => "archived"}
 
 private_class_method
 
-  def self.generic_find_all(db, sql)
-    arr = Array.new
-    db.execute(sql).each do |row|
-      issue = Issue.new(db)
-      issue.quick_assign! row
-      arr.push issue
-    end
-  arr end
-
 end # class  Issue
 end # module Wlog
 

data/lib/wlog/domain/key_value.rb

@@ -1,5 +1,4 @@
-require 'wlog/db_registry'
-require 'wlog/domain/sql_modules/key_value_sql'
+require 'active_record'
 module Wlog
 # An active record that stores keys with values. Keys and values are strings.
 # convert as you need them.
@@ -9,51 +8,27 @@ module Wlog
 # '42', when looking up 'jon' you will retrieve only the latter (42).
 #
 # @author Simon Symeonidis
-class KeyValue
-  include KeyValueSql
-
-  def initialize(db_handle)
-    @db = db_handle
-  end
+class KeyValue < ActiveRecord::Base
 
   # Insert a key in the storage. If exists, replace the value with new one
   # @return nil
-  def put!(key, value)
-    if get(key).nil?
-      create!(key, value)
+  def self.put!(key, value)
+    if ret = KeyValue.find_by_key(key)
+      ret.value = value
     else 
-      update(key, value)
+      ret = KeyValue.new(:key => key, :value => value)
     end
+    ret.save
   end
 
   # Get a certain value by key
   # @return the value given the key. nil if not found
-  def get(key)
-    ret = @db.execute(Select, key)
-    ret = ret.empty? ? nil : ret.first[1]
+  def self.get(key)
+    ret = find_by_key(key)
+    ret = ret ? ret.value : nil
   end
 
-  # destroy by key
-  def destroy!(key)
-    @db.execute(DeleteSql, key)
-  nil end
-
-  # The db handle
-  attr_accessor :db
-
 private
-
-  # We want to provide a simple interface to the kv store, so the user should
-  # not really care about updates
-  def update(key,value)
-    @db.execute(UpdateSql, value, key)
-  end
-
-  # Create a pair... ;)
-  def create!(key, value)
-    @db.execute(InsertSql, key, value)
-  end
-
 end 
 end # module Wlog
 

data/lib/wlog/domain/log_entry.rb

@@ -1,114 +1,37 @@
-require 'wlog/db_registry'
+require 'active_record'
+
 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(db_handle)
-    @date = Time.new
-    @db = db_handle
-  end
-
-  def self.find(db, id)
-    row = db.execute(Select,id).first
-    le = nil
-    if row && !row.empty?
-    le = LogEntry.new(db)
-    le.quick_assign!(row[0], row[1], Time.at(row[2]), row[3])
-    end
-  le end
-
-  def self.find_all(db)
-    self.generic_find_all(db, SelectAll)
-  end
-
-  def self.find_all_by_issue_id(db, id)
-    self.generic_find_all(db, 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_by_id(db, id)
-    db.execute(DeleteSql,id)
-  end
-
-  # update the entry
-  def update
-    @db.execute(UpdateSql,@description,@id)
-  end
-
-  # Search by string to find a matching description with 'LIKE'.
-  def self.search_descriptions(db, term)
-    all = Array.new
-    db.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
-    raise 'Need issue_id' unless @issue_id
-    unless @id
-      @db.execute(InsertSql, @description, @date.to_i, @issue_id)
-      @id = @db.last_row_from(TableName).first[0].to_i
-    end
-  end
-
-  # Delete the loaded log entry currently in memory, by passing its id
-  def delete
-    if @id
-      LogEntry.delete_by_id(@db, @id)
-      @id = nil
-    end
-  end
-
-  def quick_assign!(id,desc,date,issue_id)
-    @id, @description, @date, @issue_id = id, desc, date, issue_id
-  end
-
+class LogEntry < ActiveRecord::Base
+
+  belongs_to :issue
+
+    # Search by string to find a matching description with 'LIKE'.
+#   def self.search_descriptions(db, term)
+#     all = Array.new
+#     db.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
+ 
   # 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")}]"
+    str    = "[#{id}] "
+    tmp    = "#{description} [#{created_at.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
- 
-  # The db handle 
-  attr_accessor :db
-
 private
-  def self.generic_find_all(db, sql, *params)
-    all = Array.new
-    db.execute(sql, *params).each do |row|
-      le = LogEntry.new(db)
-      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/static_configurations.rb

@@ -20,6 +20,12 @@ module StaticConfigurations
   # Where the template files exist
   TemplateDir = "#{AppDirectory}templates/"
 
+  # Sample file to provide the user with
+  TemplateSampleFile = "#{TemplateDir}/default.erb"
+
+  # In the future if someone wants to code an alternative, go ahead
+  TemplateOutputDir = "#{ENV['HOME']}/Documents/wlog/"
+
   # Default database name (when unspecified)
   DefaultDb = "default"
 

data/lib/wlog/domain/sys_config.rb

@@ -8,9 +8,8 @@ module Wlog
 # @author Simon Symeonidis
 class SysConfig
 
-  def initialize(db)
-    @db = db
-    @key_value = KeyValue.new(@db)
+  def initialize
+    @key_value = KeyValue
   end
 
   # load the last focused issue
@@ -59,8 +58,6 @@ class SysConfig
     end
   end
 
-  attr_accessor :db
-
   # terms is a hash -> {:a => :b, :c => :d}
   # write each key value to a file like this:
   #   a:b

data/lib/wlog/migrations/make_standard_tables.rb

@@ -0,0 +1,59 @@
+require 'active_record' 
+
+module Wlog
+# Migrations to replace the raw sql from turntables
+# @author Simon Symeonidis
+class MakeStandardTables < ActiveRecord::Migration
+  def change 
+    create_table :issues do |t|
+      t.text :description
+      t.datetime :due_date
+      t.integer :status
+      t.integer :timelog, :limit => 8
+      t.text :long_description
+      t.datetime :created_at
+      t.datetime :updated_at
+    end
+
+    create_table :log_entries do |t|
+      t.text :description
+      t.integer :issue_id
+      t.datetime :created_at
+      t.datetime :updated_at
+    end
+
+    create_table :attachments do |t|
+      t.text :filename 
+      t.text :given_name
+      t.text :data
+      t.datetime :created_at
+      t.datetime :updated_at
+    end
+
+    create_table :key_values do |t|
+      t.text :key
+      t.text :value
+    end
+
+    create_table :invoices do  |t|
+      t.datetime :from
+      t.datetime :to
+      t.text :description
+    end
+  end
+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