wlog 0.0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b808a1daa10b7f6cb1f1998ce32b99557b2c5c3
-  data.tar.gz: f3617644d86f9bc7e9dac4527d061b298e849cbe
+  metadata.gz: 5f836fd871076bafbd84142635212cf9e375ab42
+  data.tar.gz: bafc3472bdff32399995f256d52b3ad7fe47ebe2
 SHA512:
-  metadata.gz: 25837321ff609d5ebd0206a010ae4bc25858f09d9cd3782b44a6f7043dd32dcc80bd43ae970576d19a5e080ec0204adc2a6019e131094a57345b7eb2669efbb7
-  data.tar.gz: 5239206cd3ffa64dc979acf86ceadc42b7f8704eae1c89d719051584b7e433076ee9855aab219d46b4d57f2e66e3b7177673ac35f75c7890d49a0c98b6d2a6d2
+  metadata.gz: 0fe3b1b4222f094092869ece6b7b82b54a6e83ae1be3b1f74b560f70e0e7c08a0885d4de802b7dbe718c29659340a893ee38931e217ab56d986ef39859cd1802
+  data.tar.gz: e991c87b690f1e472c871c681bc66f0edc2122359dbe5cc9d4648fda6097e848c2f3d7069a2f6ee0f7892514dae0a7a078c1ad070bf624bc76d9fe023dd81403

data/.gitignore

@@ -1,3 +1,4 @@
+*.db
 *.swp
 *.gem
 *.rbc
@@ -16,3 +17,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+vendor/

data/Gemfile

@@ -2,3 +2,4 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in wlog.gemspec
 gemspec
+

data/README.md

@@ -1,11 +1,21 @@
-# wlog
+# wlog ![Code Climate](https://codeclimate.com/github/psyomn/wlog.png)
 
 wlog (worklog) is a small utility to track tasks in command line. I use this
 for things I work on and need to submit a list of stuff done on a particular 
 day.
 
-Disclaimer: Some of the things in this software assume an ANSI terminal. So you
-might get weird characters if you're not on an ANSI terminal. 
+On the long term, I wish to provide some kind of ability to interface with
+redmine, and synchronize tasks. This way we'd be able to have a git-like 
+utitlity for issue tracking - that is log your work on your computer, and push
+it to the server whenever you're done (or want to update others on your
+progress). 
+
+## Source Location
+
+You can find the sources on github: 
+
+[http://github.com/psyomn/wlog](http://github.com/psyomn/wlog)
+
 
 ## Installation
 
@@ -58,6 +68,65 @@ in order to tag units of work:
 The tags can be pretty much anything you want, and for now are not very 
 important. In the future however they might be used for something more useful.
 
+### More Commands
+
+These are the commands that you can also use in order to exploit the full
+potential of this application.
+
+You can list the available databases by running the following command:
+
+  wlog --list
+
+If for some reason you need to check out where the application stores the 
+databases, you can do the following: 
+
+  wlog --where
+
+That will print the absolute path to that directory. 
+
+At the moment there are two main uis in this application. One of the UI is to
+demonstrate the issues that are currently to be worked on. Then you choose an
+issue, and log your work on that particular issue only. 
+
+So when you start the application this is what you see: 
+
+    [wlog]
+
+Enter the command `show` to list the issues
+
+    [wlog] show
+    1 [started work] - This issue is here to ...
+    2 [finished] - This issue is here to treat you better than the last one
+    3 [new] - this issue just does not belong
+
+Now we want to focus on a particular issue. We type in `focus`
+
+    [wlog] focus
+    Focus on issue: 
+    1
+    [issue #1] 
+
+And now we can show all the logged work with `show`: 
+
+    [issue #1] show
+    2013-10-13 -    Sunday [2]
+    [4] I did some work on this issue [15:34:08] 
+    [5] Some trivial work there too [15:35:32] 
+    [issue #1] 
+
+You can run these commands in this 'sub-shell': 
+are `show`, `search`, `replace`, `delete`, and `concat`.
+
+`show` lists the latest work log entries.
+
+`search` searches the database for a pattern that you specify.
+
+`replace` searches and replaces a pattern that you specify.
+
+`delete` removes an entry from the database.
+
+`concat` appends a string to the specified log entry.
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1 +1,32 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "./lib/wlog/domain/static_configurations"
+require 'yard'
+
+RSpec::Core::RakeTask.new(:spec)
+
+# note: rake yard
+YARD::Rake::YardocTask.new do |t|
+  t.options = ['--title', 'Wlog: the friendly worktime logger!', '-o', 'doc/']
+end
+
+namespace :db do
+  # Remove data directory. This will remove all your data
+  task :rm do 
+    include Wlog::StaticConfigurations
+    puts "Removing data directories from #{DataDirectory}"
+    print "You sure you want to remove it? [y/n] "
+    FileUtils.rm_rf AppDirectory if $stdin.gets.match(/^y/i)
+  end
+
+  desc "Run the sqlite3 console with the default database"
+  task :c do 
+    include Wlog::StaticConfigurations
+    sh "sqlite3 #{DataDirectory}#{DefaultDb}"
+  end
+end
+
+namespace :test do 
+  task :all => :spec
+end 
+

data/bin/wlog

@@ -1,17 +1,23 @@
 #!/usr/bin/env ruby
 
-require 'wlog/cli_interface.rb'
+require 'wlog/version'
+require 'wlog/domain/static_configurations'
+require 'wlog/ui/cli_interface'
 
 include Wlog
 
-puts "Worktime logger"
-
 if ARGV.size > 0
   case ARGV[0]
-    when "list"
-      CliInterface.list_databases_command 
-
+  when "--list"
+    CliInterface.list_databases
+  when '--where'
+    puts StaticConfigurations::DataDirectory
+  when /--/
+    puts "Unknown command."
+  else
+    CliInterface.new.run
   end
 else
   CliInterface.new.run
 end
+

data/lib/wlog.rb

@@ -1,5 +1,4 @@
 require "wlog/version"
 
 module Wlog
-  # Your code goes here...
 end

data/lib/wlog/commands/commandable.rb

@@ -0,0 +1,9 @@
+module Wlog
+# Inherit this for commands
+# @author Simon Symeonidis
+class Commandable
+  def execute
+    throw NotImplementedError
+  end
+end
+end

data/lib/wlog/commands/concat_description.rb

@@ -0,0 +1,21 @@
+require 'wlog/commands/commandable'
+require 'wlog/domain/log_entry'
+
+module Wlog
+# Concatenate a string to an existing log entry
+class ConcatDescription < Commandable
+  def initialize(id, str)
+    @id = id; @str = str
+  end
+
+  # Find and update the log entry
+  def execute
+    log_entry = LogEntry.find(@id)
+    log_entry.description.concat(str)
+    log_entry.update
+  end
+
+  attr_reader :id, :str
+end
+end # end Wlog module
+

data/lib/wlog/commands/innit_db.rb

@@ -0,0 +1,22 @@
+require 'turntables/turntable'
+
+require 'wlog/db_registry'
+require 'wlog/commands/commandable'
+require 'wlog/domain/static_configurations'
+require 'wlog/domain/helpers'
+
+module Wlog
+# Command to create the initial database
+# @author Simon Symeonidis
+class InnitDb < Commandable
+  include StaticConfigurations
+  def execute
+    Helpers.make_dirs!
+    current_dir = "#{File.expand_path File.dirname(__FILE__)}/../sql"
+    turntable   = Turntables::Turntable.new
+    turntable.register(current_dir)
+    turntable.make_at!("#{DataDirectory}#{ARGV[0] || DefaultDb}")
+  end
+end
+end
+

data/lib/wlog/commands/make_csv.rb

@@ -0,0 +1,24 @@
+require 'wlog/commands/commandable'
+require 'wlog/domain/log_entry'
+require 'wlog/domain/helpers'
+
+module Wlog
+# Create a Csv report with this command
+# @author Simon Symeonidis
+class MakeCsv < Commandable
+  def execute
+    str = ""
+    LogEntry.find_all.group_by{|el| el.date.strftime("%Y-%m-%d")}.each_pair do |key,value|
+      str.concat("#{value.first.date.strftime("%A")} #{key}\n")
+      value.each do |entry|
+        str.concat(",\"#{Helpers.break_string(entry.description,80)}\"#{$/}")
+      end
+      str.concat($/)
+    end
+    @ret = str
+  end
+
+  attr_accessor :ret
+end
+end
+

data/lib/wlog/commands/new_entry.rb

@@ -0,0 +1,16 @@
+require 'wlog/commands/commandable'
+require 'wlog/domain/log_entry'
+
+module Wlog
+class NewEntry < Commandable
+
+  def initialize(desc,issue_id); @desc, @iid = desc, issue_id end
+
+  def execute
+    log_entry = LogEntry.new
+    log_entry.description = @desc
+    log_entry.issue_id = @iid
+    log_entry.insert
+  end
+end
+end

data/lib/wlog/commands/replace_pattern.rb

@@ -0,0 +1,21 @@
+require 'wlog/commands/commandable'
+require 'wlog/domain/log_entry'
+
+module Wlog
+# Command that replaces a string pattern found in an entry, with another string
+# @author Simon Symeonidis
+class ReplacePattern < Commandable
+  def initialize(id, oldpat, newpat)
+    @id, @oldpat, @newpat = id, oldpat, newpat
+  end
+
+  def execute
+    log_entry = LogEntry.find(id)
+    log_entry.description.gsub!(old_pattern, new_pattern)
+    log_entry.update
+  end
+
+  attr_reader :id, :oldpat, :newpat
+end
+end
+

data/lib/wlog/db_registry.rb

@@ -2,51 +2,39 @@ require 'singleton'
 require 'sqlite3'
 require 'fileutils'
 
-require 'wlog/static_configurations.rb'
+require 'wlog/domain/static_configurations.rb'
 
 module Wlog
-# Author :: Simon Symeonidis
+# @author Simon Symeonidis
 #  The db registry, using sqlite3
 class DbRegistry
   include Singleton
+  include StaticConfigurations
 
   def initialize
-    make_dirs
-    make_tables = !database_exists? 
-
-    @db_handle = SQLite3::Database.new(
-      "#{StaticConfigurations::DATA_DIRECTORY}"\
-      "#{ARGV[0] || StaticConfigurations::DEFAULT_DATABASE}")
-    
-    if make_tables 
-      execute(@@log_entry_sql)
-    end
+    @handle = SQLite3::Database.new("#{DataDirectory}#{ARGV[0] || DefaultDb}")
   end
 
+  # execute a sql with varargs parameters
+  # @param *sql, first the sql string, then the parameters if the statement is
+  #   to be prepared. 
+  # @example Simple Usage
+  #   DbRegistry.execute("SELECT * FROM table WHERE id = ?", 1)
   def execute(*sql)
-    @db_handle.execute(*sql)
+    @handle.execute(*sql)
   end
 
-  # the database handle
-  attr_accessor :db_handle
-
-private
-  # NOTE this concern could be encapsulated in another class
-  def make_dirs
-    # Does the data dir path not exist?
-    unless File.exists? StaticConfigurations::DATA_DIRECTORY
-      FileUtils.mkdir_p StaticConfigurations::DATA_DIRECTORY
-    end
+  # Get the last row, given a table name. The table needs to have an id
+  def last_row_from(tablename)
+    query = "SELECT * FROM #{tablename} WHERE id =(SELECT MAX(id) FROM"\
+      " #{tablename});"
+    @handle.execute(query)
   end
 
-  def database_exists?
-    File.exists?\
-      "#{StaticConfigurations::DATA_DIRECTORY}#{ARGV[0]\
-      || StaticConfigurations::DEFAULT_DATABASE}"
-  end
+  # the database handle
+  attr_accessor :handle
 
-  @@log_entry_sql =\
-    "CREATE TABLE log_entries (id INTEGER PRIMARY KEY AUTOINCREMENT,"\
-    "description TEXT, date DATETIME);"
+private
 end
 end # module Wlog
+

data/lib/wlog/domain/ansi_colors.rb

@@ -0,0 +1,15 @@
+module Wlog
+# @author Simon Symeonidis
+# 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
+  White   = 37
+  Black   = 38
+end
+end
+

data/lib/wlog/domain/attachment.rb

@@ -0,0 +1,80 @@
+require 'wlog/db_registry'
+require 'wlog/domain/sql_modules/attachment_sql'
+require 'wlog/domain/sql_modules/polymorphic_attachments_sql'
+
+module Wlog
+# Following the Active Record pattern
+# OO way of handling blobs of data, to be stored in memory or in db.
+class Attachment
+  include AttachmentSql
+  include PolymorphicAttachmentsSql
+
+  # Can only initialize with a caller name and id, since relations to
+  # attachments are polymorphic.
+  def initialize(caller_name, caller_id)
+    @caller_name, @caller_id = caller_name, caller_id
+  end
+
+  # Find an attachment given an id
+  # @param id is the attachment id to find
+  def self.find_all_by_discriminator(name, id)
+    arr = Array.new
+    rows = DbRegistry.instance.execute(
+      PolymorphicAttachmentsSql::SelectSql, name, id)
+
+    rows.each do |row| 
+      arr.push self.find(name, row[2])
+    end
+  arr end
+
+  # Delete an attachment
+  # @param id the attachment with the id to delete
+  def self.delete_by_discriminator(name, id)
+    DbRegistry.instance.execute(DeleteSql, id)
+  end
+
+  # Find an attachment by an identifier and polymorphic name
+  # @param id is the identifier of the attachment to find
+  # @param name is the name of the polymorphic thing
+  def self.find(name, id)
+    row = DbRegistry.instance.execute(AttachmentSql::SelectSql, id).first
+    att = Attachment.new(name, id)
+    att.quick_assign!(row)
+  att end
+
+  # Insert an attachment. This also creates the relation in the polymorphic
+  # table.
+  def insert
+    DbRegistry.instance.execute(
+      AttachmentSql::InsertSql, @filename, @given_name, @data)
+    ret = DbRegistry.instance.last_row_from(AttachmentSql::TableName)
+    @id = ret.first[0].to_i
+    DbRegistry.instance.execute(
+      PolymorphicAttachmentsSql::InsertSql, @caller_name, @caller_id, @id)
+  end
+
+  # Assign a row of data to self
+  def quick_assign!(row)
+    @id, @filename, @given_name, @data = row[0], row[1], row[2], row[3]
+  nil end
+
+  # Identifier of the object
+  attr_accessor :id
+
+  # Container for the actual binary data of whatever you're attaching.
+  attr_accessor :data
+
+  # The original filename of the file
+  attr_accessor :filename
+
+  # optional given name for the attachment
+  attr_accessor :given_name
+  
+  # The class name of the calling object
+  attr_accessor :caller_name
+  
+  # The caller id of the calling object
+  attr_accessor :caller_id
+end
+end # module Wlog
+