wlog 0.0.3

checksums.yaml

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

data/.gitignore

@@ -0,0 +1,18 @@
+*.swp
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/README.md

@@ -0,0 +1,67 @@
+# wlog
+
+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. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'wlog'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wlog
+
+## Usage
+
+On command line write
+
+    wlog
+
+When you specify nothing, the default database is used. If you want to store 
+tasks in different databases (lets say you have project1, project2), then execute
+the following line: 
+
+    wlog project2
+
+The databases are located here: 
+
+    $HOME/.config/wlog/data/
+
+And you should be in a command line interface. In the interface you can type in
+
+    help
+
+To see a list of actions that you can do. 
+
+Usually you'll just need to write:
+
+    new
+
+And enter the work description that you wish. You can add tags like this too
+in order to tag units of work:
+
+    new
+
+    Enter work description:
+      I did something very productive today. #bugfix #completed #feature
+
+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.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/wlog

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require 'wlog/cli_interface.rb'
+
+include Wlog
+
+puts "Worktime logger"
+
+if ARGV.size > 0
+  case ARGV[0]
+    when "list"
+      CliInterface.list_databases_command 
+
+  end
+else
+  CliInterface.new.run
+end

data/lib/wlog/cli_interface.rb

@@ -0,0 +1,149 @@
+require 'wlog/log_entry.rb'
+
+module Wlog
+# Author :: Simon Symeonidis
+class CliInterface
+
+  # Run the interface
+  def run
+    cmd = "default"
+    until cmd == "end" do 
+      print "[wlog::] "
+      cmd = $stdin.gets
+      cmd ||= "end"
+      cmd.chomp!
+
+      case cmd
+      when "new"
+        puts "Enter work description:"
+        print "  "
+        new_entry_command
+        puts "ok"
+
+      when "show"
+        puts "Showing latest log entries" 
+        show_entries_command
+
+      when "outcsv"
+        puts "Exporting to CSV."
+        fh = File.open("out.csv", "w")
+        fh.write(make_csv)
+        fh.close
+
+      when "delete"
+        print "Remove task with id: "
+        delete_entry_command
+
+      when "search"
+        search_term
+
+      when "concat" 
+        concat_description
+
+      when "replace"
+        replace_pattern
+
+      when "help"
+        print_help
+      end
+    end
+  end
+
+  # TODO the commands should be factored out
+  def self.list_databases_command
+    puts "Available Worklog databases: "
+    Dir["#{StaticConfigurations::DATA_DIRECTORY}*"].each do |n|
+      print "[%8d bytes]" % File.size(n)
+      print "  "
+      print n
+      puts
+    end
+  end
+
+private 
+
+  # Print the help of the cli app
+  def print_help
+    ["new",   "Create a new log entry", 
+    "outcsv", "Export everything to CSV",
+    "help",   "print this dialog",
+    "concat", "Add a string at the end of a previous entry",
+    "end",    "Exit the progam",
+    "search", "Search for a string in the log description text",
+    "delete", "Remove the task with a given id"].each_with_index do |el,ix| 
+      print "  " if 1 == ix % 2
+      puts el
+    end
+  end
+
+  # new entry command
+  def new_entry_command
+    description = $stdin.gets.chomp!
+    log_entry = LogEntry.new
+    log_entry.description = description
+    log_entry.insert
+  end
+
+  def show_entries_command
+    print_entries(LogEntry.find_all)
+  end
+
+  def print_entries(entries_arr)
+    date_collections = entries_arr.group_by{|le| le.date.strftime("%Y-%m-%d")}
+    date_collections.each_key do |k|
+    print "\x1b[32;1m#{k}\x1b[0m - "
+    print "\x1b[33;1m#{date_collections[k].first.date.strftime("%A")}\x1b[0m "
+    puts "[\x1b[35;1m#{date_collections[k].count}\x1b[0m]"
+      date_collections[k].each do |le|
+        puts "  #{le}"
+      end
+    end
+  end
+
+  def search_term
+    print "Term to search: "
+    term = $stdin.gets.chomp!
+    print_entries(LogEntry.search_descriptions(term))
+  end
+
+  def delete_entry_command
+    LogEntry.delete($stdin.gets.to_i)
+  end
+
+  def make_csv
+    str = String.new
+    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(",\"#{entry.description}\"")
+      end
+    end
+    str
+  end
+
+  # Concatenate an aggregate description to a previous item
+  def concat_description
+    print "ID of task to concatenate to: "
+    id = $stdin.gets.to_i
+    log_entry = LogEntry.find(id)
+    print "Information to concatenate: "
+    str = $stdin.gets.chomp!
+    log_entry.description.concat(str)
+    log_entry.update
+  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 : "
+    pattern1 = $stdin.gets.chomp!
+    print "with    : "
+    pattern2 = $stdin.gets.chomp!
+
+    log_entry = LogEntry.find(id)
+    log_entry.description.gsub!(pattern1,pattern2)
+    log_entry.update
+  end
+end
+end # module Wlog

data/lib/wlog/db_registry.rb

@@ -0,0 +1,52 @@
+require 'singleton'
+require 'sqlite3'
+require 'fileutils'
+
+require 'wlog/static_configurations.rb'
+
+module Wlog
+# Author :: Simon Symeonidis
+#  The db registry, using sqlite3
+class DbRegistry
+  include Singleton
+
+  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
+  end
+
+  def execute(*sql)
+    @db_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
+  end
+
+  def database_exists?
+    File.exists?\
+      "#{StaticConfigurations::DATA_DIRECTORY}#{ARGV[0]\
+      || StaticConfigurations::DEFAULT_DATABASE}"
+  end
+
+  @@log_entry_sql =\
+    "CREATE TABLE log_entries (id INTEGER PRIMARY KEY AUTOINCREMENT,"\
+    "description TEXT, date DATETIME);"
+end
+end # module Wlog

data/lib/wlog/helpers.rb

@@ -0,0 +1,28 @@
+module Wlog
+# @author Simon Symeonidis
+# @date Wed Jul 10 17:37:24 EDT 2013
+# This contains a few helper methods that may be used by any part in the 
+# application.
+class Helpers
+
+  # 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|
+      if cl + word.length + 1 > numchars
+        cl = 0
+        desc.concat($/)
+      end
+      desc.concat(word).concat(" ")
+      cl += word.length + 1
+    end
+
+    desc.chomp!
+    desc
+  end
+
+end
+end # module Wlog

data/lib/wlog/log_entry.rb

@@ -0,0 +1,102 @@
+require 'wlog/db_registry.rb'
+require 'wlog/helpers.rb'
+
+module Wlog
+# Author :: Simon Symeonidis 
+#  Active Record Domain object for a log entry
+class LogEntry
+
+  def initialize
+    @date = Time.new
+  end
+
+  def self.find(id)
+    row = DbRegistry.instance.execute(@@select,id).first
+    le = LogEntry.new
+    le.id = row[0]
+    le.description = row[1]
+    le.date = Time.at(row[2])
+    le
+  end
+
+  def self.find_all
+    all = Array.new
+    DbRegistry.instance.execute(@@select_all).each do |row|
+      le = LogEntry.new
+      le.id = row[0]
+      le.description = row[1]
+      le.date = Time.at(row[2])
+      all.push le
+    end
+    all
+  end
+
+  def self.delete(id)
+    DbRegistry.instance.execute(@@delete_sql,id)
+  end
+
+  # TODO this shouldn't be here
+  def self.create_table
+    DbRegistry.instance.execute(@@create_sql)
+  end
+
+  # update the entry
+  def update
+    DbRegistry.instance.execute(@@update_sql,@description,@id)
+  end
+
+  # Search by string to find a matching description with 'LIKE'.
+  def self.search_descriptions(term)
+    all = Array.new
+    DbRegistry.instance.execute(@@select_description_like,"%#{term}%").each do |row|
+      le = LogEntry.new
+      le.id = row[0]
+      le.description = row[1]
+      le.date = Time.at(row[2])
+      all.push le
+    end
+    all
+  end
+
+  def insert
+    DbRegistry.instance.execute(@@insert_sql,@description,@date.to_i)
+  end
+
+  # Delete the loaded log entry currently in memory, by passing its id
+  def delete
+    self.delete(self.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   = Wlog::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
+
+  ## SQL ## 
+  @@table_name = "log_entries"
+  @@insert_sql = "INSERT INTO #{@@table_name} (description,date) values (?,?);"
+  @@delete_sql = "DELETE FROM #{@@table_name} WHERE id = ? ;"
+  @@select_all = "SELECT * FROM #{@@table_name} ORDER BY date ASC;"
+  @@update_sql = "UPDATE #{@@table_name} SET description=? WHERE id=?;"
+  #@@select_all = "SELECT * FROM #{@@table_name} WHERE date >=#{Time.now.to_i - 604800 - 24 * 60 * 60} ORDER BY date ASC"
+  @@select     = "SELECT * FROM #{@@table_name} WHERE id = ? ;"
+  @@select_description_like = "SELECT * FROM #{@@table_name} WHERE description LIKE ?;"
+
+end
+end # module Wlog

data/lib/wlog/static_configurations.rb

@@ -0,0 +1,21 @@
+module Wlog
+# Author   :: Simon Symeonidis 
+# Licenses :: GPL v3.0 
+# Static path data.
+module StaticConfigurations
+  # The application name
+  APPLICATION_NAME        = "wlog"
+  
+  # Absolute path to the configuration directory
+  CONFIGURATION_DIRECTORY = "#{ENV['HOME']}/.config/"
+
+  # Absolute path to the application directory
+  APPLICATION_DIRECTORY   = "#{CONFIGURATION_DIRECTORY}#{APPLICATION_NAME}/"
+
+  # Absolute path to the data directory
+  DATA_DIRECTORY          = "#{APPLICATION_DIRECTORY}data/"
+
+  # Default database name (when unspecified)
+  DEFAULT_DATABASE        = "default"
+end
+end # module Wlog

data/lib/wlog/version.rb

@@ -0,0 +1,3 @@
+module Wlog
+  VERSION = "0.0.3"
+end

data/lib/wlog.rb

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

data/wlog.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wlog/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wlog"
+  spec.version       = Wlog::VERSION
+  spec.authors       = ["psyomn"]
+  spec.email         = ["lethaljellybean@gmail.com"]
+  spec.description   = %q{Track tasks and time on the command line.}
+  spec.summary       = %q{A light ruby script to help track tasks and time}
+  spec.homepage      = "http://github.com/psyomn/wlog"
+  spec.license       = "GPL v3.0"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_runtime_dependency "sqlite3", ">= 1.3.7"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: wlog
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- psyomn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.7
+description: Track tasks and time on the command line.
+email:
+- lethaljellybean@gmail.com
+executables:
+- wlog
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- bin/wlog
+- lib/wlog.rb
+- lib/wlog/cli_interface.rb
+- lib/wlog/db_registry.rb
+- lib/wlog/helpers.rb
+- lib/wlog/log_entry.rb
+- lib/wlog/static_configurations.rb
+- lib/wlog/version.rb
+- wlog.gemspec
+homepage: http://github.com/psyomn/wlog
+licenses:
+- GPL v3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A light ruby script to help track tasks and time
+test_files: []
+has_rdoc: