wlog 1.1.7 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae992bd7858ce2e08c6ad8e42d87f9473ff97eac
-  data.tar.gz: 891ee5f0589a579dcdb31da227acb6ed8a89871c
+  metadata.gz: 71f501411d645d7b66bba721986ff8e913fa649c
+  data.tar.gz: 50a272c8617ad7c0258d765f4dd52cb586224e3e
 SHA512:
-  metadata.gz: bb4a653989d05da8a524e19d72ad8948eb7e3c9c980934459d5ffd52fb261a24a4a2bfeacbc9300d9141a8602b3d021707652a1f15691a247e47b49712006e10
-  data.tar.gz: 56611ff5b80c771185646b24ccb9594945c3bf17c6283a33b9dfb5d07db5eed75b5e828218d3bad162067850574ff93e6c7a8a30ecc7614b76c9e91366a73a69
+  metadata.gz: ccca541ffc78b943ca4736db5c7bd1cc4c4024dee7a830cd431405e9536b5e1f0831f6ca8a9fb774ef67caa57f1c6bb89eff116fed6feb578f7e9871d28b38b7
+  data.tar.gz: 9e0cc96690d82932c28ebb6a85f80c5413f23ef71fcbee516b3ae34bfc785c94b3bf51a5dc91fb2da94d91c39302f407b1bc7b4f2e420494fbe2cd253c8b6567

data/README.md

@@ -1,4 +1,4 @@
-# wlog [![Code Climate](https://codeclimate.com/github/psyomn/wlog.png)](https://codeclimate.com/github/psyomn/wlog) [![Build Status](https://travis-ci.org/psyomn/wlog.png?branch=v1.1.0)](https://travis-ci.org/psyomn/wlog)
+# wlog [![Code Climate](https://codeclimate.com/github/psyomn/wlog.png)](https://codeclimate.com/github/psyomn/wlog) [![Build Status](https://travis-ci.org/psyomn/wlog.png?branch=v1.1.0)](https://travis-ci.org/psyomn/wlog) [![Inline docs](http://inch-ci.org/github/psyomn/wlog.svg?branch=master)](http://inch-ci.org/github/psyomn/wlog) [![Gem Version](https://badge.fury.io/rb/wlog.svg)](http://badge.fury.io/rb/wlog) [![Coverage Status](https://img.shields.io/coveralls/psyomn/wlog.svg)](https://coveralls.io/r/psyomn/wlog?branch=v1.2.0)
 
 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 
@@ -116,19 +116,48 @@ the command `desc`.
     Description 
       But this is an ever longer desc 
 
+    File
+      N/A
+
+### Attachments
+
+You can also attach files to issues while being within issue scope:
+
+    [issue #1] attach
+    Attach to which issue? : 1
+    Absolute file location : /tmp/derp.txt
+    Alias name for file (optional) :
+    Attached file.
+    
+There's two commands you can use to list attachments within issue scope:
+`attachls`, `desc`. `desc` will print all the issue information, and show
+the attachments in the end.
+
+You can output attachments to a location: 
+
+    [issue #1] attachls 
+    [1] - become-a-killer-cook.pdf
+    [2] - very-boring-doc.pdf 
+    [issue #1] attachout
+    Which attachment to output? : 1
+    Output where (abs dir) ? : /tmp/
+
+*Warn*: This is a somewhat nice feature, though it might be axed in the future
+if storing files is too problematic.
+
 ## Logging Time
 
 It's possible to log time within issue scope with the following commands:
 
-    lt 10m
+    [issue #1] lt 10m
 
 To log 10 minutes 
 
-    lt 1h20m
+    [issue #1] lt 1h20m
 
 To log 1 hour 20 minutes
 
-    lt 1d 1s
+    [issue #1] lt 1d 1s
 
 To log one day, one second. (A day is 8 hours). The total time is stored on the
 issue.
@@ -157,34 +186,6 @@ To exit the scope of an issue, you can use the `forget` command:
     [issue #1] forget
     [wlog] 
 
-*NOTE*: Attachments don't currently work in v1.1.5 - they might be back in the
-future.
-
-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
-    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/
-
 # Generating Invoices
 
 You can generate invoices. You need to create an invoice first. To do that,
@@ -212,23 +213,41 @@ month of September:
     break you of the input for the invoice.
     
     
-    
-    
-    
-    
-    [invoice] 
+
+    [invoices] new
+    From (dd-mm-yyyy) 01-09-2014
+    To   (dd-mm-yyyy) 30-09-2014
+    > I start writing this it is a 
+    > very nice paragraph. I can break
+    > lines and do whatever. And continue
+    > writing and do whatever.
+    > 
+    > Two lines can separate a paragraph
+    > And if you notice you can have many
+    > paragraphs in the invoice.
+    > 
+    > And another. But if we hit return 3
+    > times, then it will stop recording
+    > our lines.
+    > 
+    > 
+    [invoices] 
 
 So now you should have your first invoice:
 
     [invoice] show
-      [1] 01-09-2014 -> 30-09-2014 I
+      [1] 01-10-2014 -> 30-10-2014 This is some text I'm currently writing and I'm no...
+
+    [invoice] ls
+      [1] 01-10-2014 -> 30-10-2014 This is some text I'm currently writing and I'm no...
 
 And now you can generate your invoice with the following command:
 
     [invoice] generate 1
 
 This will write the output in `~/Documents/wlog/`. Will create dirs if not
-exist.
+exist. The outputs are generated from templates which exist in
+_$HOME/.config/wlog/templates_. You can write your own.
 
 ## Templates
 
@@ -248,6 +267,48 @@ commands:
 Also, worth to note that you should verify any template you get off the
 internet to use as your own.
 
+Templates are set per database. So if you want to use different templates (1 at
+a time) per database, it's possible. You can take a look at an example template
+that exploits all the currently available template variables [here]().
+
+## Git Integration
+
+There's some very loose (and probably crappy) integration with git repos. What
+you do is point `wlog` to your project directory + .git/. So for example, if we
+were tracking this repo with `wlog`, we would do the following:
+
+    [wlog] git
+    [git] ls
+      repo: 
+      auth: 
+    [git] set
+    Path to git repo (eg: project/.git/): /home/psyomn/programming/ruby/wlog/.git/
+    git author: psyomn
+    [git] ls
+      repo: /home/psyomn/programming/ruby/wlog/.git/
+      auth: psyomn
+
+So now, when you're generating invoices, you can add your commits as well. If
+you want to simply list a bunch of commits for a particular invoice, you can
+invoke the `commits` command. The commits between the two dates of that invoice 
+will be printed on screen.
+
+    [invoices] ls
+      [1] 01-10-2014 -> 30-10-2014 This is some text I'm currently writing and I'm no...
+      [2] 01-09-2014 -> 30-09-2014 I start writing this it is a...
+    [invoices] commits 2 
+
+      git commits for psyomn
+
+      5a46cf61dd6471f22731b7cbf1d21d1d0f79f7a2 wlog.gemspec: set version of AR to 4.1.6 ...
+      8ca561e3412fde1828f983b79ee47a158d16bbf6 README.md: update usage instructions ...
+      fcb5adbba04c22ef931147b8acbf641d9d26bb33 template/ui: niceify template selection ...
+      e10bdee3cd8ae2f12ae55aef5cef249433459397 invoices/issues/entries: fix timezone issue ...
+      8ef9a823da2d80bba510838dd591703baad2c9ac invoices: generating works. ...
+      cf1627259cc7d278084f90559efa75d1fe4f60ba staticconfig: add template output dir ...
+      22d760f881e613a30d3b722dd9b26f4f46c1cf4c domain/log_entry: add belongs_to issue ...
+      79d1e3393587b02c328a454d5cfe301d3f80aee8 invoices: select date range for log entries ...
+
 ## Contributing
 
 1. Fork it

data/lib/wlog/commands/bootstrap_templates.rb

@@ -26,6 +26,11 @@ private
   def write_default_template!
     fh = File.open(TemplateSampleFile, 'w')
     data = "A list of issues:
+<p> Invoice: <%= @invoice.description %> </p>
+<p> From: <%= @invoice.from.strftime(\"%A %d %B \") %>  </p>
+<p> To: <%= @invoice.to.strftime(\"%A %d %B\") %> </p>
+<p> Work Items to report: <%= @log_entries.count %> </p>
+
 <% @issues.each do |issue| %>
   <%= \"\#{issue.id}  \#{issue.description}\" %>
 <% end %>"

data/lib/wlog/commands/delete_attachment.rb

@@ -0,0 +1,17 @@
+require 'wlog/commands/commandable'
+module Wlog
+# Delete an attachment, given its id (in the context of an issue)
+# @author Simon Symeonidis
+class DeleteAttachment < Commandable
+  def initialize(issue, att_id)
+    @issue  = issue
+    @att_id = att_id
+  end
+
+  def execute
+  end
+
+private
+end
+end
+

data/lib/wlog/commands/fetch_git_commits.rb

@@ -0,0 +1,45 @@
+require 'wlog/commands/commandable'
+require 'wlog/tech/git_commit_parser'
+module Wlog
+# Given two dates, extract the git commits.
+# @author Simon Symeonidis
+class FetchGitCommits < Commandable
+
+  # Configuration to query the git repo for the required commits. You can
+  # specify a date range and an author. You need to provide a path to the
+  # git repository.
+  # @param from   date start
+  # @param to     date end
+  # @param repo   location to the git repo
+  # @param author only show logs of that author. If none is given, fetch all
+  #   authors
+  # @example 
+  #   from_date = DateTime.now - 15
+  #   to_date   = DateTime.now + 5
+  #   repo      = '/home/jon/wlog/.git/'
+  #   cmd = FetchGitCommits.new(from_date, to_date, repo, 'jon')
+  def initialize(from, to, repo, author=nil)
+    @from, @to, @repo, @author = from, to, repo, author
+  end
+
+  # Run the parser on the repo; yield commits
+  def execute
+    result = `#{run_git_cmd}`
+    @commits = GitCommitParser.parse(result)
+  nil end
+
+  attr_accessor :commits
+
+private
+
+  # git --git-dir <thedir> log --since=... --until=... --author=...
+  def run_git_cmd
+    base = "git --git-dir #{@repo} log "
+    base.concat("--since=\"#{@from}\" ")
+    base.concat("--until=\"#{@to}\" ")
+    base.concat("--author=\"#{@author}\"") if @author
+  base end
+
+end
+end
+

data/lib/wlog/commands/fetch_git_commits_standard.rb

@@ -0,0 +1,29 @@
+require 'wlog/commands/commandable'
+require 'wlog/commands/fetch_git_commits'
+require 'wlog/tech/git_commit_parser'
+module Wlog
+# We don't set the repo and author - get it directly from keyvalue
+# Use the other git fetcher if you want something more configurable
+# @author Simon Symeonidis
+class FetchGitCommitsStandard < Commandable
+
+  # @param from   date start
+  # @param to     date end
+  #   authors
+  def initialize(from, to)
+    @from, @to = from, to
+    @author = KeyValue.get('author')
+    @repo   = KeyValue.get('git')
+  end
+
+  # Run the parser on the repo; yield commits
+  def execute
+    cmd = FetchGitCommits.new(@from, @to, @repo, @author)
+    cmd.execute
+    @commits = cmd.commits
+  nil end
+
+  attr_accessor :commits
+end
+end
+

data/lib/wlog/commands/innit_db.rb

@@ -2,6 +2,7 @@ require 'wlog/commands/commandable'
 require 'wlog/domain/static_configurations'
 
 require 'wlog/migrations/make_standard_tables'
+require 'wlog/migrations/fix_attachments_polymorphic_table'
 
 require 'active_record'
 require 'sqlite3'
@@ -35,7 +36,7 @@ class InnitDb < Commandable
   # 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]
+    migrations = [MakeStandardTables, FixAttachmentsPolymorphicTable]
     existing = SchemaMigration.all.collect{ |el| el.version }
 
     migrations.reject!{ |e| existing.include? e.to_s}
@@ -51,12 +52,12 @@ private
 
   # Checks to see if versioning table is there. Create if not.
   def make_schema_migrations! 
+    ActiveRecord::Migration.verbose = false 
     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

data/lib/wlog/commands/write_template.rb

@@ -0,0 +1,22 @@
+require 'wlog/domain/static_configurations'
+require 'wlog/commands/commandable'
+module Wlog
+# After the template is processed, write out the results to standard file.
+# @author Simon Symeonidis
+class WriteTemplate < Commandable
+  include StaticConfigurations
+
+  def initialize(template_output, invoice)
+    @template_output = template_output
+    @invoice = invoice
+  end
+
+  def execute
+    FileUtils.mkdir_p TemplateOutputDir
+    template_ext = File.extname TemplateHelper.template_file || '.txt'
+    filename = TemplateOutputDir + "#{@invoice.id}-invoice#{template_ext}"
+    File.write(filename, @template_output)
+  nil end
+
+end
+end

data/lib/wlog/domain/attachment.rb

@@ -1,62 +1,34 @@
 require 'active_record'
+require 'zlib'
+require 'wlog/domain/sys_config'
+
 module Wlog
 # Following the Active Record pattern
 # OO way of handling blobs of data, to be stored in memory or in db.
 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
-
-  # 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
+  before_save :compress_string
+  after_initialize :uncompress_string
+  belongs_to :attachable, polymorphic: true
+
+  def to_s
+    @strmaker = SysConfig.string_decorator
+    str = ''
+    str.concat("  [").concat(@strmaker.green(self.id)).concat("] ")
+    str.concat(@strmaker.red(self.filename)).concat($/)
+  str end
+
+private
+
+  def compress_string
+    self.data = Zlib::Deflate.deflate self.data
+  end
+
+  def uncompress_string
+    if self.data
+      # did we just init something with previous data? yes; we can uncompress
+      self.data = Zlib::Inflate.inflate self.data
+    end
+  end
 
 end
 end # module Wlog