wlog 1.0.0 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f836fd871076bafbd84142635212cf9e375ab42
-  data.tar.gz: bafc3472bdff32399995f256d52b3ad7fe47ebe2
+  metadata.gz: f4675d5ea8306d4dc0cc233a7a10a33ba4eb75b5
+  data.tar.gz: 84bb925bc393f021267b20ea3e9c0c944daf87fc
 SHA512:
-  metadata.gz: 0fe3b1b4222f094092869ece6b7b82b54a6e83ae1be3b1f74b560f70e0e7c08a0885d4de802b7dbe718c29659340a893ee38931e217ab56d986ef39859cd1802
-  data.tar.gz: e991c87b690f1e472c871c681bc66f0edc2122359dbe5cc9d4648fda6097e848c2f3d7069a2f6ee0f7892514dae0a7a078c1ad070bf624bc76d9fe023dd81403
+  metadata.gz: 3fdf0f23d629a0e4a599daa732113d8e90a39653f2ebece0343301115f8cdc3deacc2f8d6a1a663d5ea5f8aae8e51e45dc99be340ecdd67711a322b5a81fddb9
+  data.tar.gz: 9376a739b679b3f1931f8dbba6a6d9a73018c03f9601c3c1874ba9dcb961ed11d069369d479528742c1e077bb4a6a46b288e5f154ac872b1f886fb2e3189b7b1

data/.rspec

@@ -0,0 +1 @@
+--color

data/README.md

@@ -1,4 +1,4 @@
-# wlog ![Code Climate](https://codeclimate.com/github/psyomn/wlog.png)
+# wlog [![Code Climate](https://codeclimate.com/github/psyomn/wlog.png)](https://codeclimate.com/github/psyomn/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 
@@ -75,12 +75,12 @@ potential of this application.
 
 You can list the available databases by running the following command:
 
-  wlog --list
+    wlog --list
 
 If for some reason you need to check out where the application stores the 
 databases, you can do the following: 
 
-  wlog --where
+    wlog --where
 
 That will print the absolute path to that directory. 
 
@@ -95,9 +95,11 @@ So when you start the application this is what you see:
 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
+    started work 2
+      [6] Fix colors for wlog and make it pretty
+      [4] Weird bug crash when pressing ctrl+d
+    new 1
+      [3] Need to check out templating system
 
 Now we want to focus on a particular issue. We type in `focus`
 
@@ -109,11 +111,51 @@ Now we want to focus on a particular issue. We type in `focus`
 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] 
+    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] 
 
+To exit the scope of an issue, you can use the `forget` command:
+
+    [issue #1] forget
+    [wlog] 
+
+If you forgot what you are doing, you can do
+
+    [issue #1] desc
+    + Issue #6
+      - Reported : 2013-10-26 15:01:45 -0400
+      - Due      : 1969-12-31 19:00:00 -0500
+      - Entries  : 0
+      - Status   : started work
+      - Time     : 3h 
+
+      - Whatever description you wrote for issue 1
+
+You can also attach files to issues
+
+    [wlog] attach
+    Attach to which issue? : 1
+    Absolute file location : /tmp/derp.txt
+    Alias name for file (optional) :
+    Attached file.
+
+And then you can output them to a location: 
+
+    [wlog] show
+    finished [1]
+    [2] This is yet another issue
+    started work [1]
+    [1] This is my issue
+    [wlog] showattach
+    Which issue : 1
+    [1] - derp.txt (alias: )
+    [2] - derp.txt (alias: )
+    [wlog] outattach
+    Which attachment to output? : 1
+    Output where (abs dir) : /tmp/
+
 You can run these commands in this 'sub-shell': 
 are `show`, `search`, `replace`, `delete`, and `concat`.
 
@@ -134,3 +176,9 @@ are `show`, `search`, `replace`, `delete`, and `concat`.
 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
+
+### For newcommers
+
+Look at the github issues, for things marked as 'Up for Grabs'. Feel free to 
+message me to ask anything. I'll be more than happy to answer.
+

data/Rakefile

@@ -10,8 +10,19 @@ YARD::Rake::YardocTask.new do |t|
   t.options = ['--title', 'Wlog: the friendly worktime logger!', '-o', 'doc/']
 end
 
+# Anything that has to do with the stuff of this gem in .config/wlog
+namespace :data do
+  desc "Remove all configuration data of wlog"
+  task :rm do 
+    include Wlog::StaticConfigurations
+    print "You sure you want to remove #{AppDirectory}? [y/n] :"
+    FileUtils.rm_rf AppDirectory if $stdin.gets.match(/^y/i)
+  end
+end
+
 namespace :db do
   # Remove data directory. This will remove all your data
+  desc "Remove All the databases"
   task :rm do 
     include Wlog::StaticConfigurations
     puts "Removing data directories from #{DataDirectory}"
@@ -26,6 +37,19 @@ namespace :db do
   end
 end
 
+namespace :reek do
+  desc "Run reek at lib/"
+  task :all do
+    sh "reek lib/"
+  end
+
+  desc "Grep long parameter list" 
+  task :lparam do
+    sh "reek 2>&1 lib/ | grep -i param"
+  end
+
+end
+
 namespace :test do 
   task :all => :spec
 end 

data/bin/wlog

@@ -2,22 +2,32 @@
 
 require 'wlog/version'
 require 'wlog/domain/static_configurations'
+require 'wlog/ui/bootstrap'
 require 'wlog/ui/cli_interface'
 
 include Wlog
+    
 
 if ARGV.size > 0
   case ARGV[0]
   when "--list"
+    # TODO FIXME
     CliInterface.list_databases
   when '--where'
     puts StaticConfigurations::DataDirectory
+  when '--version', '-v'
+    print "wlog "
+    puts Wlog::VERSION
   when /--/
     puts "Unknown command."
   else
+    # Make overall configurations
+    Bootstrap.configure!
     CliInterface.new.run
   end
 else
+  # Make overall configurations
+  Bootstrap.configure!
   CliInterface.new.run
 end
 

data/lib/wlog/commands/archive_finished_issues.rb

@@ -0,0 +1,20 @@
+require 'wlog/commands/commandable'
+require 'wlog/commands/archive_issues'
+require 'wlog/domain/issue'
+
+module Wlog
+# MacroCommand that archives finished issues
+# @author Simon Symeonidis
+class ArchiveFinishedIssues < Commandable
+
+  def initialize(db)
+    @issues = Issue.find_all_finished(db)
+    @arch_command = ArchiveIssues.new(@issues)
+  end
+
+  def execute
+    @arch_command.execute
+  end
+
+end
+end

data/lib/wlog/commands/archive_issues.rb

@@ -0,0 +1,22 @@
+require 'wlog/commands/commandable'
+require 'wlog/domain/issue'
+
+module Wlog
+# Command. Given a list of issues, mark them as archived.
+# @author Simon Symeonidis
+class ArchiveIssues < Commandable
+
+  def initialize(issues)
+    @issues = issues
+  end
+
+  # Update the issues to be marked as archived
+  def execute
+    @issues.each do |issue|
+      issue.archive!
+      issue.update
+    end
+  end
+
+end
+end

data/lib/wlog/commands/concat_description.rb

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

data/lib/wlog/commands/delete_issue.rb

@@ -0,0 +1,31 @@
+require 'wlog/commands/commandable'
+require 'wlog/domain/issue'
+
+module Wlog
+# Command for deleting issues
+# @author Simon Symeonidis
+class DeleteIssue
+  # Init with the db handle, and issue id
+  def initialize(db, id)
+    @db = db
+    @issue_id = id
+    @deleted = false
+  end
+
+  # delete the issue
+  def execute
+    issue = Issue.find(@db, @issue_id)
+    if issue
+      issue.delete
+      @deleted = true
+    end
+  end
+
+  def deleted?
+    @deleted
+  end
+
+  attr :deleted
+end
+end
+

data/lib/wlog/commands/innit_db.rb

@@ -3,7 +3,6 @@ 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
@@ -11,7 +10,6 @@ module Wlog
 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)

data/lib/wlog/commands/make_csv.rb

@@ -6,9 +6,15 @@ module Wlog
 # Create a Csv report with this command
 # @author Simon Symeonidis
 class MakeCsv < Commandable
+
+  def initialize(db)
+    @db = db
+  end
+
+  # TODO refactor me. Because I feel like a horrible piece of code.
   def execute
     str = ""
-    LogEntry.find_all.group_by{|el| el.date.strftime("%Y-%m-%d")}.each_pair do |key,value|
+    LogEntry.find_all(@db).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)}\"#{$/}")

data/lib/wlog/commands/new_entry.rb

@@ -2,12 +2,17 @@ require 'wlog/commands/commandable'
 require 'wlog/domain/log_entry'
 
 module Wlog
+# Command to create a log entry given an issue id, and a string
+# @author Simon Symeonidis
 class NewEntry < Commandable
 
-  def initialize(desc,issue_id); @desc, @iid = desc, issue_id end
+  def initialize(db, desc, issue_id) 
+    @desc, @iid = desc, issue_id 
+    @db = db
+  end
 
   def execute
-    log_entry = LogEntry.new
+    log_entry = LogEntry.new(@db)
     log_entry.description = @desc
     log_entry.issue_id = @iid
     log_entry.insert

data/lib/wlog/commands/replace_pattern.rb

@@ -5,17 +5,15 @@ 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
+  def initialize(db, id, oldpat, newpat)
+    @db, @id, @oldpat, @newpat = db, id, oldpat, newpat
   end
 
   def execute
-    log_entry = LogEntry.find(id)
-    log_entry.description.gsub!(old_pattern, new_pattern)
+    log_entry = LogEntry.find(@db, @id)
+    log_entry.description.gsub!(@oldpat, @newpat)
     log_entry.update
   end
-
-  attr_reader :id, :oldpat, :newpat
 end
 end
 

data/lib/wlog/commands/taint_setup.rb

@@ -0,0 +1,18 @@
+require 'fileutils'
+require 'wlog/commands/commandable'
+require 'wlog/domain/static_configurations'
+
+module Wlog
+# This touches a file in wlog config: .config/wlog/tainted. That file is used
+# later on to see if this is the first setup or not.
+class TaintSetup
+  include StaticConfigurations
+  def initialize
+  end
+
+  def execute
+    FileUtils.touch TaintFile
+  end
+end
+end
+

data/lib/wlog/db_registry.rb

@@ -1,18 +1,16 @@
-require 'singleton'
 require 'sqlite3'
 require 'fileutils'
 
 require 'wlog/domain/static_configurations.rb'
 
 module Wlog
+# The db registry, using sqlite3
 # @author Simon Symeonidis
-#  The db registry, using sqlite3
 class DbRegistry
-  include Singleton
   include StaticConfigurations
 
-  def initialize
-    @handle = SQLite3::Database.new("#{DataDirectory}#{ARGV[0] || DefaultDb}")
+  def initialize(dbname)
+    @handle = SQLite3::Database.new(dbname || "#{DataDirectory}#{ARGV[0] || DefaultDb}")
   end
 
   # execute a sql with varargs parameters

data/lib/wlog/domain.rb

@@ -0,0 +1,13 @@
+# Quickhand to include the rest of the domain objects
+
+require 'wlog/domain/attachment.rb'
+require 'wlog/domain/helpers.rb'
+require 'wlog/domain/issue.rb'
+require 'wlog/domain/key_value.rb'
+require 'wlog/domain/log_entry.rb'
+require 'wlog/domain/session.rb'
+require 'wlog/domain/static_configurations.rb'
+require 'wlog/domain/sys_config.rb'
+require 'wlog/domain/template_engine.rb'
+require 'wlog/domain/timelog_helper.rb'
+

data/lib/wlog/domain/attachment.rb

@@ -11,46 +11,51 @@ class Attachment
 
   # 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
+  def initialize(dbhandle, caller_name, caller_id)
+    @caller_name, @caller_id, @db = caller_name, caller_id, dbhandle
   end
 
   # Find an attachment given an id
   # @param id is the attachment id to find
-  def self.find_all_by_discriminator(name, id)
+  def self.find_all_by_discriminator(db, name, id)
     arr = Array.new
-    rows = DbRegistry.instance.execute(
+    rows = db.execute(
       PolymorphicAttachmentsSql::SelectSql, name, id)
 
     rows.each do |row| 
-      arr.push self.find(name, row[2])
+      arr.push self.find(db, 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)
+  def delete_by_discriminator(name, id)
+    @db.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)
+  def self.find(db, name, id)
+    row = db.execute(AttachmentSql::SelectSql, id).first
+    att = nil
+    if row && !row.empty?
+      att = Attachment.new(db, name, id)
+      att.quick_assign!(row)
+    end
   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)
+    unless @id
+      @db.execute(
+        AttachmentSql::InsertSql, @filename, @given_name, @data)
+      ret = @db.last_row_from(AttachmentSql::TableName)
+      @id = ret.first[0].to_i
+      @db.execute(
+        PolymorphicAttachmentsSql::InsertSql, @caller_name, @caller_id, @id)
+    end
   end
 
   # Assign a row of data to self
@@ -75,6 +80,9 @@ class Attachment
   
   # The caller id of the calling object
   attr_accessor :caller_id
+
+  # The database handle for the active record
+  attr_accessor :db
 end
 end # module Wlog