wlog 1.1.1 → 1.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 881927105d2ad4db3a54716d36003cd94e2ce6fc
-  data.tar.gz: 9b5f72a05d2924b8bfb3c0c669502abfc3bb0f98
+  metadata.gz: b2050581ce02c72f62ceee213cb8b10a7abaeafa
+  data.tar.gz: edb367143269344a076ac8470e55ff07c65dbb96
 SHA512:
-  metadata.gz: 2c12ef90cef5b096c659415f4cb250a0953e3b345a94886fcf9a20db0b790a03ad745906bc796d61650005613e5e96592f187076a4b7c2a4136e8caf72601b6e
-  data.tar.gz: 37da1bc3b3da242d01ddc7caaa506b8b782d0a950d4e086f397056c259327eb8bc29dc65f63b856889ee444540a78e9b71ff246106eb6726b56ad57c1265db38
+  metadata.gz: 3145857f03f3a6049bdc06ac393d44643973728e2da54f9a678acd9a04701f154ae6312f7b13e6605df169dca19762131b45abec00ff399abf9cf2f650f6f68d
+  data.tar.gz: c7f451d8b41d134adb47767229336848b93cd1922196298ce078c93949fdb14bbfb9d417d01f0aa466867d4b544b471cd931905f8f877cc2a5538c2061f745a8

data/README.md

@@ -19,17 +19,13 @@ You can find the sources on github:
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Install it with:
 
-    gem 'wlog'
-
-And then execute:
-
-    $ bundle
+    $ gem install wlog
 
-Or install it yourself as:
+Run with:
 
-    $ gem install wlog
+    $ wlog
 
 ## Usage
 
@@ -47,32 +43,16 @@ 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:
+The next section will talk about this a little more.
 
-    new
+When you're in the command line interface, you can always run
 
-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
+    help
 
-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.
+in order to list the possible commands you can use.
 
 ### 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
@@ -94,7 +74,7 @@ So when you start the application this is what you see:
 
 Enter the command `show` to list the issues
 
-    [wlog] show
+    [wlog] ls
     started work 2
       [6] Fix colors for wlog and make it pretty
       [4] Weird bug crash when pressing ctrl+d
@@ -103,14 +83,12 @@ Enter the command `show` to list the issues
 
 Now we want to focus on a particular issue. We type in `focus`
 
-    [wlog] focus
-    Focus on issue: 
-    1
+    [wlog] focus 1
     [issue #1] 
 
-And now we can show all the logged work with `show`: 
+And now we can show all the logged work with `ls` or `show`: 
 
-    [issue #1] show
+    [issue #1] ls
     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] 
@@ -121,20 +99,27 @@ 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
-      - And here there exists an even larger description of the issue
-
-You can also attach files to issues
+While in the scope of an issue, you can display its full description by invoking
+the command `desc`.
+
+    [issue #4] desc
+    
+    Issue #4
+      Reported : Sat Jul 12 00:46:27 2014
+      Due      : Fri Oct 24 05:00:00 2014
+      Entries  : 0
+      Status   : started work
+      Time     : 3w 4d 1h 
+    
+    Summary 
+      This is some impressive work right here
+    
+    Description 
+      But this is an ever longer desc 
+
+You can also attach files to issues (you have to be outside the scope of an
+issue for this - this feature is experimental at the momment so don't rely too
+much on it):
 
     [wlog] attach
     Attach to which issue? : 1

data/Rakefile

@@ -54,3 +54,4 @@ namespace :test do
   task :all => :spec
 end 
 
+

data/lib/wlog/commands/archive_finished_issues.rb

@@ -7,8 +7,8 @@ module Wlog
 # @author Simon Symeonidis
 class ArchiveFinishedIssues < Commandable
 
-  def initialize(db)
-    @issues = Issue.find_all_finished(db)
+  def initialize
+    @issues = Issue.where(:status => 2)
     @arch_command = ArchiveIssues.new(@issues)
   end
 

data/lib/wlog/commands/archive_issues.rb

@@ -14,7 +14,7 @@ class ArchiveIssues < Commandable
   def execute
     @issues.each do |issue|
       issue.archive!
-      issue.update
+      issue.save
     end
   end
 

data/lib/wlog/commands/bootstrap_templates.rb

@@ -0,0 +1,37 @@
+require 'wlog/commands/commandable'
+require 'wlog/domain/static_configurations'
+
+module Wlog
+# To check if template dir exists or not. Make dirs. Add sample template.
+# @author Simon Symeonidis
+class BootstrapTemplates < Commandable
+  include StaticConfigurations
+
+  def initialize
+  end
+
+  def execute
+    unless File.exists? TemplateDir
+      FileUtils.mkdir_p TemplateDir
+    end
+
+    unless File.exists? TemplateSampleFile
+      write_default_template!
+    end
+  end
+
+private
+
+  # Write a default template 
+  def write_default_template!
+    fh = File.open(TemplateSampleFile, 'w')
+    data = "A list of issues:
+<% @issues.each do |issue| %>
+  <%= \"\#{issue.id}  \#{issue.description}\" %>
+<% end %>"
+    fh.write(data)
+    fh.close
+  nil end
+
+end
+end

data/lib/wlog/commands/concat_description.rb

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

data/lib/wlog/commands/delete_issue.rb

@@ -5,20 +5,21 @@ 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
+  # Init with the issue id
+  def initialize(id)
     @issue_id = id
     @deleted = false
   end
 
   # delete the issue
   def execute
-    issue = Issue.find(@db, @issue_id)
+    issue = Issue.find(@issue_id)
     if issue
-      issue.delete
+      issue.destroy
       @deleted = true
     end
+  rescue ActiveRecord::RecordNotFound
+    @deleted = false 
   end
 
   def deleted?

data/lib/wlog/commands/innit_db.rb

@@ -1,20 +1,76 @@
-require 'turntables/turntable'
-
-require 'wlog/db_registry'
 require 'wlog/commands/commandable'
 require 'wlog/domain/static_configurations'
 
+require 'wlog/migrations/make_standard_tables'
+
+require 'active_record'
+require 'sqlite3'
+
 module Wlog
+
+# Only used here
+class MakeSchemaMigration < ActiveRecord::Migration
+  def change
+    create_table :schema_migrations do |t|
+      t.text :version
+    end
+  end
+end
+
+# Only used here
+class SchemaMigration < ActiveRecord::Base
+end
+
 # Command to create the initial database
 # @author Simon Symeonidis
 class InnitDb < Commandable
   include StaticConfigurations
   def execute
     current_dir = "#{File.expand_path File.dirname(__FILE__)}/../sql"
-    turntable   = Turntables::Turntable.new
-    turntable.register(current_dir)
-    turntable.make_at!("#{DataDirectory}#{ARGV[0] || DefaultDb}")
+    make_schema_migrations!
+    execute_migrations!
   end
+
+  # TODO making this public is hacky, but I'm doing this for now for being able
+  # to test. Once tests are ok again, then I'm going to refactor this somewhere
+  # else so it's more sane.
+  def execute_migrations!
+    migrations = [MakeStandardTables]
+    existing = SchemaMigration.all.collect{ |el| el.version }
+
+    migrations.reject!{ |e| existing.include? e.to_s}
+
+    migrations.each do |migration| 
+      ActiveRecord::Migration.run(migration)
+      SchemaMigration.create(:version => migration.name)
+    end
+  end
+
+
+private
+
+  # Checks to see if versioning table is there. Create if not.
+  def make_schema_migrations! 
+    ActiveRecord::Base.configurations = dbconfig
+    ActiveRecord::Base.establish_connection(:development)
+    ActiveRecord::Base.default_timezone = :local
+
+    unless SchemaMigration.table_exists?
+      ActiveRecord::Migration.verbose = false 
+      ActiveRecord::Migration.run(MakeSchemaMigration)
+    end
+  end
+
+  # TODO this should probably be moved
+  def dbconfig
+    dbname = ARGV[0] || DefaultDb
+    {'development' => {
+     :adapter => 'sqlite3',
+     :pool => 5,
+     :database => DataDirectory + dbname,
+     :timeout => 5000 }}
+  end
+
 end
 end
 

data/lib/wlog/commands/make_csv.rb

@@ -7,15 +7,11 @@ module Wlog
 # @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(@db).group_by{|el| el.date.strftime("%Y-%m-%d")}.each_pair do |key,value|
-      str.concat("#{value.first.date.strftime("%A")} #{key}\n")
+    LogEntry.all.group_by{|el| el.created_at.strftime("%Y-%m-%d")}.each_pair do |key,value|
+      str.concat("#{value.first.created_at.strftime("%A")} #{key}\n")
       value.each do |entry|
         str.concat(",\"#{Helpers.break_string(entry.description,80)}\"#{$/}")
       end

data/lib/wlog/commands/new_entry.rb

@@ -1,3 +1,5 @@
+require 'active_record'
+require 'date'
 require 'wlog/commands/commandable'
 require 'wlog/domain/log_entry'
 
@@ -6,16 +8,17 @@ module Wlog
 # @author Simon Symeonidis
 class NewEntry < Commandable
 
-  def initialize(db, desc, issue_id) 
-    @desc, @iid = desc, issue_id 
-    @db = db
+  def initialize(desc, issue) 
+    @desc, @issue = desc, issue
   end
 
   def execute
-    log_entry = LogEntry.new(@db)
-    log_entry.description = @desc
-    log_entry.issue_id = @iid
-    log_entry.insert
+    log_entry = LogEntry.new(
+      :description => @desc, 
+      :created_at => DateTime.now,
+      :updated_at => DateTime.now)
+
+    @issue.log_entries << log_entry
   end
 end
 end

data/lib/wlog/commands/replace_pattern.rb

@@ -5,14 +5,16 @@ module Wlog
 # Command that replaces a string pattern found in an entry, with another string
 # @author Simon Symeonidis
 class ReplacePattern < Commandable
-  def initialize(db, id, oldpat, newpat)
-    @db, @id, @oldpat, @newpat = db, id, oldpat, newpat
+  def initialize(id, oldpat, newpat)
+    @id, @oldpat, @newpat = id, oldpat, newpat
   end
 
   def execute
-    log_entry = LogEntry.find(@db, @id)
-    log_entry.description.gsub!(@oldpat, @newpat)
-    log_entry.update
+    log_entry = LogEntry.find(@id)
+    log_entry.description = log_entry.description.gsub(/#{@oldpat}/, @newpat)
+    log_entry.save
+  rescue ActiveRecord::RecordNotFound
+    false
   end
 end
 end

data/lib/wlog/domain/attachment.rb

@@ -1,88 +1,63 @@
-require 'wlog/db_registry'
-require 'wlog/domain/sql_modules/attachment_sql'
-require 'wlog/domain/sql_modules/polymorphic_attachments_sql'
-
+require 'active_record'
 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
+class Attachment < ActiveRecord::Base
 
   # Can only initialize with a caller name and id, since relations to
   # attachments are polymorphic.
-  def initialize(dbhandle, caller_name, caller_id)
-    @caller_name, @caller_id, @db = caller_name, caller_id, dbhandle
-  end
+  # 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(db, name, id)
-    arr = Array.new
-    rows = db.execute(
-      PolymorphicAttachmentsSql::SelectSql, name, id)
-
-    rows.each do |row| 
-      arr.push self.find(db, name, row[2])
-    end
-  arr end
-
-  # Delete an attachment
-  # @param id the attachment with the id to delete
-  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(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
-    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
-  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
+  # def self.find_all_by_discriminator(db, name, id)
+  #   arr = Array.new
+  #   rows = db.execute(
+  #     PolymorphicAttachmentsSql::SelectSql, name, id)
+
+  #   rows.each do |row| 
+  #     arr.push self.find(db, name, row[2])
+  #   end
+  # arr end
+
+  # # Delete an attachment
+  # # @param id the attachment with the id to delete
+  # 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(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
+  #   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
+  # def quick_assign!(row)
+  #   @id, @filename, @given_name, @data = row[0], row[1], row[2], row[3]
+  # nil end
 
-  # The database handle for the active record
-  attr_accessor :db
 end
 end # module Wlog
 

data/lib/wlog/domain/invoice.rb

@@ -1,9 +1,15 @@
+require 'active_record'
+require 'wlog/domain/log_entry'
+
 module Wlog
 # The invoice domain object - use this to manipulate invoice recordings, or 
 # this along with some renderer and templates in order to create said invoices.
 # @author Simon Symeonidis
-class Invoice
-  def initialize
+class Invoice < ActiveRecord::Base
+
+  def log_entries_within_dates
+    LogEntry.where(created_at: from..to)
   end
+
 end
 end