wlog 1.1.5 → 1.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2050581ce02c72f62ceee213cb8b10a7abaeafa
-  data.tar.gz: edb367143269344a076ac8470e55ff07c65dbb96
+  metadata.gz: 927ff5dc0487a5b1a77551c62e722b5465da5ca3
+  data.tar.gz: e3d49fb7ed7233b91709ca04df26d06618ea814e
 SHA512:
-  metadata.gz: 3145857f03f3a6049bdc06ac393d44643973728e2da54f9a678acd9a04701f154ae6312f7b13e6605df169dca19762131b45abec00ff399abf9cf2f650f6f68d
-  data.tar.gz: c7f451d8b41d134adb47767229336848b93cd1922196298ce078c93949fdb14bbfb9d417d01f0aa466867d4b544b471cd931905f8f877cc2a5538c2061f745a8
+  metadata.gz: 6a880d8230ddce74c868ba4c6ea5dec4016a00792604e177b1d19c9b6408bf5d9ac3c0035e7969afd26dfeeea45858469441065e30db5e30bbb3df6dbe4bf86a
+  data.tar.gz: 1e677504858659be29cf7ce0f861c18ca62b4e179d458df62df129da97714577b5db969da0d881f1b7110d13223bcf76708f153e50cc18453e99c2e34e9c618c

data/README.md

@@ -64,15 +64,16 @@ databases, you can do the following:
 
 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: 
+# Main Interface
 
     [wlog]
 
-Enter the command `show` to list the issues
+Enter the command `new` to create a new issue: 
+
+    [wlog] new
+
+Follow the on screen queries in order to create the issue.
+Enter the command `show` or `ls` to list the issues:
 
     [wlog] ls
     started work 2
@@ -81,7 +82,7 @@ Enter the command `show` to list the issues
     new 1
       [3] Need to check out templating system
 
-Now we want to focus on a particular issue. We type in `focus`
+Now we want to focus on a particular issue. We type in `focus`:
 
     [wlog] focus 1
     [issue #1] 
@@ -94,10 +95,8 @@ And now we can show all the logged work with `ls` or `show`:
       [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] 
+And commands you execute apply to the scope of only that issue. You can type in
+`help` for more info.
 
 While in the scope of an issue, you can display its full description by invoking
 the command `desc`.
@@ -117,6 +116,50 @@ the command `desc`.
     Description 
       But this is an ever longer desc 
 
+## Logging Time
+
+It's possible to log time within issue scope with the following commands:
+
+    lt 10m
+
+To log 10 minutes 
+
+    lt 1h20m
+
+To log 1 hour 20 minutes
+
+    lt 1d 1s
+
+To log one day, one second. (A day is 8 hours). The total time is stored on the
+issue.
+
+## Inside issues
+
+You can run these commands in this 'sub-shell' of the issues: 
+are `search`, `replace`, `delete`, and `concat`.
+
+    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.
+
+## Escape Scope 
+
+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):
@@ -142,39 +185,68 @@ And then you can output them to a location:
     Which attachment to output? : 1
     Output where (abs dir) : /tmp/
 
-## Inside issues
-
-You can run these commands in this 'sub-shell' of the issues: 
-are `show`, `search`, `replace`, `delete`, and `concat`.
-
-`show` lists the latest work log entries.
+# Generating Invoices
 
-`search` searches the database for a pattern that you specify.
+You can generate invoices. You need to create an invoice first. To do that,
+enter the command `invoices` in the `wlog` shell:
 
-`replace` searches and replaces a pattern that you specify.
+    [wlog] invoices
+    [invoices]
 
-`delete` removes an entry from the database.
+You can create a new invoice with the `new` command. Enter the two dates which
+correspond the date range you want to bill. For example, let's enter the whole
+month of September:
 
-`concat` appends a string to the specified log entry.
+    [invoice] new
+    From (dd-mm-yyyy) 01-09-2014
+    To   (dd-mm-yyyy) 30-09-2014
+    I did many things this month
+    It is very very true
+    And I can write all of this in multiline
+    
+    And I can break into another paragraph.
+    
+    And another.
+    
+    But you need to press enter a few more times until you
+    break you of the input for the invoice.
+    
+    
+    
+    
+    
+    
+    [invoice] 
 
-All of these will modify the entries of those issues.
+So now you should have your first invoice:
 
-## Logging Time
+    [invoice] show
+      [1] 01-09-2014 -> 30-09-2014 I
 
-It's possible to log time now with the following commands:
+And now you can generate your invoice with the following command:
 
-    lt 10m
+    [invoice] generate 1
 
-To log 10 minutes 
+This will write the output in `~/Documents/wlog/`. Will create dirs if not
+exist.
 
-    lt 1h20m
+## Templates
 
-To log 1 hour 20 minutes
+To generate invoices templates are used. Templates are _erb_ templates. They are
+stored in `~/.config/wlog/templates/`. You can write your own as well. If you
+write your own, you need to tell wlog to use them. Do so with the following
+commands:
 
-    lt 1d 1s
+    [templates] show
+       [  1] /home/psyomn/.config/wlog/templates/default.erb
+     * [  2] /home/psyomn/.config/wlog/templates/mine.erb.html
+    [templates] set 1
+    [templates] show
+     * [  1] /home/psyomn/.config/wlog/templates/default.erb
+       [  2] /home/psyomn/.config/wlog/templates/mine.erb.html
 
-To log one day, one second. (A day is 8 hours). The total time is stored on the
-issue.
+Also, worth to note that you should verify any template you get off the
+internet to use as your own.
 
 ## Contributing
 
@@ -184,8 +256,6 @@ issue.
 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.
+# Developers
 
+Check issue tracker - thanks.

data/lib/wlog/{ui/commands → commands}/create_issue.rb

@@ -1,12 +1,12 @@
 require 'active_record'
 require 'readline'
-require 'wlog/ui/commands/ui_command'
+require 'wlog/commands/commandable'
 require 'wlog/domain/issue'
 
 module Wlog
 # Creational logic for issues
 # @author Simon Symeonidis
-class CreateIssue < UiCommand
+class CreateIssue < Commandable
   # Execute create issue transaction
   def execute
     desc = Readline.readline("Small issue description :") || "None."

data/lib/wlog/ui/cli_interface.rb

@@ -5,7 +5,7 @@ require 'wlog/domain/sys_config'
 require 'wlog/domain/attachment'
 require 'wlog/domain/helpers'
 
-require 'wlog/ui/commands/create_issue'
+require 'wlog/commands/create_issue'
 require 'wlog/ui/configuration_ui'
 
 require 'wlog/commands/archive_issues'
@@ -40,7 +40,6 @@ class CliInterface
       when /^archive/ then archive cmd
       when /^showattach/ then show_attach
       when /^outattach/  then output_attach
-      when /^generateinvoice/ then generate_invoice
       when /^attach/ then attach
       when /^focus/  then focus(cmd)
       when /new/    then new_issue
@@ -76,6 +75,7 @@ private
     if !issue_id
       puts 'usage:'
       puts '  delete <id>'
+      return
     else 
       issue_id = issue_id.to_i
     end
@@ -202,7 +202,8 @@ private
     'archive', 'Archive a file into a specific issue',
     'showattach', 'Show what files have been attached to an issue',
     'outattach', 'Extract a file from the database',
-    'generateinvoice', 'todo',
+    'invoices', 'Go to invoices interface',
+    'templates', 'Go to template interface, and set templates',
     'focus', 'Focus on a particular ',
     'show', 'List all the issues',
     'help', 'Show this information',
@@ -245,17 +246,6 @@ private
     cmd.ret
   end
 
-  def generate_invoice
-    require 'time'
-    puts "Eg: valid input is Oct 2013 15"
-    from = Readline.readline("From: ")
-    to   = Readline.readline("To  : ")
-
-    from_time = Time.parse(from).to_i
-    to_time = Time.parse(to).to_i
-    issues = Issue.find_in_time_range(@db, from_time, to_time)
-  end
-
   # Search for an issue
   def search
     term = Readline.readline("search issues for term : ")

data/lib/wlog/ui/edit_handler.rb

@@ -1,31 +1,31 @@
+require 'wlog/domain/sys_config'
 
 module Wlog
 # @author Simon Symeonidis
 class EditHandler
 
-  def initialize(issue); @issue = issue end
+  def initialize(issue)
+    @issue = issue 
+    @strmaker = SysConfig.string_decorator
+  end
 
   # Command comes in as edit <...>. This definition will check what comes
   # next and invoke the proper method to execute.
   def edit_what(terms_a)
+    param = (terms_a.drop 1).join ' '
+
     case terms_a[0]
     when /^title/
-      title = (terms_a.drop 1).join ' '
-      @issue.description = title
-      @issue.update
+      @issue.update(:description => param)
 
     when /^desc/
-      long = (terms_a.drop 1).join ' '
-      @issue.long_description = long
-      @issue.update 
+      @issue.update(:long_description => param)
 
     when /^due/
-      date_time = terms_a.drop 1
-      edit_time(date_time.join(' '))
+      edit_time(param)
 
     when /^reported/
-      date_time = terms_a.drop 1
-      edit_reported_time(date_time.join(' '))
+      edit_reported_time(param)
 
     else 
       $stdout.puts "Usage: "
@@ -33,15 +33,13 @@ class EditHandler
       $stdout.puts "  edit desc  - to edit the long description"
       $stdout.puts "  edit due   - to edit the due date"
       $stdout.puts "  edit time  - to edit the time"
-
     end
   end
   
   # @param time is the date-time in string format (eg Oct 28)
   def edit_time(time)
     date_time = time_handle(time)
-    @issue.due_date = date_time.to_time 
-    @issue.update
+    @issue.update(:due_date => date_time)
     puts @strmaker.green('Updated due date')
   rescue ArgumentError
     $stderr.puts @strmaker.red \
@@ -63,8 +61,8 @@ class EditHandler
   # @return a Time object which is set to 9am on that day if no time 
   #   is provided
   def time_handle(time_str)
-    date_time = DateTime.parse(time)
-    date_time = DateTime.parse(time + ' 9:00') if date_time.hour == 0
+    date_time = DateTime.parse(time_str)
+    date_time = DateTime.parse(time_str + ' 9:00') if date_time.hour == 0
   end
 
   # Pass the issue from the previous ui to this one. This ui modifies

data/lib/wlog/ui/invoice_ui.rb

@@ -18,7 +18,7 @@ class InvoiceUi
     cmd = "default"
 
     while cmd != 'end'
-      cmd = Readline.readline("[#{@strmaker.red('invoice')}] ") || ""
+      cmd = Readline.readline("[#{@strmaker.red('invoices')}] ") || ""
       case cmd
       when /^new/       then make_invoice
       when /^(ls|show)/ then ls
@@ -36,10 +36,10 @@ private
   # TODO maybe separate this in the future for better testing.
   def generate(rest)
     num = rest.first || 1
-    invoice = Invoice.find(num.to_i)
+    @invoice = Invoice.find(num.to_i)
     
     # NOTE: these need to be instance vars, so we expose them to ERB later on
-    @les = invoice.log_entries_within_dates
+    @les = @invoice.log_entries_within_dates
     @issues = [Issue.find(*(@les.collect(&:issue_id).uniq))].compact.flatten
     
     # Get the template
@@ -52,7 +52,7 @@ private
 
     FileUtils.mkdir_p TemplateOutputDir
     template_ext = tpath.split(File::SEPARATOR).last.split('.').last
-    filename = TemplateOutputDir + "#{invoice.id}-invoice.#{template_ext}"
+    filename = TemplateOutputDir + "#{@invoice.id}-invoice.#{template_ext}"
 
     File.write(filename, output)
 
@@ -75,7 +75,7 @@ private
       print @strmaker.yellow(invoice.from.strftime("%d-%m-%Y"))
       print @strmaker.blue(" -> ")
       print @strmaker.yellow(invoice.to.strftime("%d-%m-%Y"))
-      puts " #{invoice.description.split.first}"
+      puts " #{invoice.description.lines.first.gsub(/(\r|\n)/, "")[0..49]}..."
     end
   end
 

data/lib/wlog/version.rb

@@ -1,3 +1,3 @@
 module Wlog
-  VERSION = "1.1.5"
+  VERSION = "1.1.6"
 end

data/wlog.gemspec

@@ -28,5 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "yard"
   spec.add_runtime_dependency "sqlite3", ">= 1.3.7"
   spec.add_runtime_dependency "rake", ">= 10.3.2"
-  spec.add_runtime_dependency 'activerecord', ">= 4.1.6"
+  spec.add_runtime_dependency 'activerecord', "4.1.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wlog
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 1.1.6
 platform: ruby
 authors:
 - psyomn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-30 00:00:00.000000000 Z
+date: 2014-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -98,14 +98,14 @@ dependencies:
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
         version: 4.1.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
         version: 4.1.6
 description: Track tasks and time on the command line.
@@ -129,6 +129,7 @@ files:
 - lib/wlog/commands/bootstrap_templates.rb
 - lib/wlog/commands/commandable.rb
 - lib/wlog/commands/concat_description.rb
+- lib/wlog/commands/create_issue.rb
 - lib/wlog/commands/delete_issue.rb
 - lib/wlog/commands/innit_db.rb
 - lib/wlog/commands/make_csv.rb
@@ -158,8 +159,6 @@ files:
 - lib/wlog/tech/wlog_string.rb
 - lib/wlog/ui/bootstrap.rb
 - lib/wlog/ui/cli_interface.rb
-- lib/wlog/ui/commands/attach_to_log_entry.rb
-- lib/wlog/ui/commands/create_issue.rb
 - lib/wlog/ui/commands/ui_command.rb
 - lib/wlog/ui/configuration_ui.rb
 - lib/wlog/ui/edit_handler.rb
@@ -205,7 +204,7 @@ rubyforge_project:
 rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
-summary: 'A light ruby script to help track tasks and time  commit: e10bdee'
+summary: 'A light ruby script to help track tasks and time  commit: 176c67c'
 test_files:
 - spec/domain/attachment_spec.rb
 - spec/domain/commands/concat_desc_spec.rb

data/lib/wlog/ui/commands/attach_to_log_entry.rb

@@ -1,11 +0,0 @@
-require 'wlog/ui/commands/ui_command'
-require 'wlog/domain/attachment'
-module Wlog
-# Attaching a file to a log entry procedural logic
-# @author Simon Symeonidis
-class AttachToLogEntry < UiCommand
-  def execute
-  end
-end
-end
-