rbinvoice 0.2.3 → 0.2.4

data/README.html

@@ -0,0 +1,43 @@
+<h1>rbinvoice</h1>
+
+<p>rbinvoice lets you generate PDF invoices from a Google Spreadsheet.
+It's pretty obscure; you probably haven't heard of it.</p>
+
+<h2>Input</h2>
+
+<p>RbInvoice reads your hours from a Google Spreadsheet, which should be formatted like this:</p>
+
+<table>
+  <tr>
+    <td colspan="7"><b style="font-size:120%">My Time Tracking</b></td>
+  </tr>
+  <tr>
+    <td><b>Weekday</b></td>
+    <td><b>Day</b></td>
+    <td><b>Task</b></td>
+    <td><b>Notes</b></td>
+    <td><b>Start</b></td>
+    <td><b>Stop</b></td>
+    <td><b>Total</b></td>
+  </tr>
+  <tr>
+    <td>T</td>
+    <td>3/20/2012</td>
+    <td>BigCorp</td>
+    <td>API</td>
+    <td>8:00</td>
+    <td>12:15</td>
+    <td>4:15</td>
+  </tr>
+  <tr>
+    <td>T</td>
+    <td>3/20/2012</td>
+    <td>SmallCorp</td>
+    <td>Shopping Cart</td>
+    <td>13:00</td>
+    <td>17:15</td>
+    <td>4:00</td>
+  </tr>
+</table>
+
+<p>Columns B, E, F, and G should have a Date format. </p>

data/README.md

@@ -1,6 +1,57 @@
 rbinvoice
 =========
 
-rbinvoice lets you generate PDF invoices from a Google Spreadsheet.
+RbInvoice lets you generate PDF invoices from a Google Spreadsheet.
 It's pretty obscure; you probably haven't heard of it.
 
+
+
+Disclaimer
+----------
+
+RbInvoice is not production-ready code! I keep it on Github more for my own convenience than anything else. I do use it myself to bill clients, but lots of things are hard-coded, like my company address. If you use it, you do so at your own risk! I don't guarantee anything, and I don't promise any support. If you tell your clients to write checks to Paul Jungwirth and send them to my address, that's too bad for you. :-)
+
+Perhaps someday I'll get this code into a shareable state; it's inching there a little bit each month. But right now you should find a real invoicing solution somewhere else. All documentation here is purely in expectation of an eventual release. Things may be broken and may change, so please don't take it as a promise of anything.
+
+
+
+Input
+-----
+
+RbInvoice reads your hours from a Google Spreadsheet, which should be formatted like this:
+
+<table>
+  <tr>
+    <td colspan="7"><b style="font-size:120%">My Time Tracking</b></td>
+  </tr>
+  <tr>
+    <td><b>Weekday</b></td>
+    <td><b>Day</b></td>
+    <td><b>Task</b></td>
+    <td><b>Notes</b></td>
+    <td><b>Start</b></td>
+    <td><b>Stop</b></td>
+    <td><b>Total</b></td>
+  </tr>
+  <tr>
+    <td>T</td>
+    <td>3/20/2012</td>
+    <td>BigCorp</td>
+    <td>API</td>
+    <td>8:00</td>
+    <td>12:15</td>
+    <td>4:15</td>
+  </tr>
+  <tr>
+    <td>T</td>
+    <td>3/20/2012</td>
+    <td>SmallCorp</td>
+    <td>Shopping Cart</td>
+    <td>13:00</td>
+    <td>17:15</td>
+    <td>4:00</td>
+  </tr>
+</table>
+
+Columns B, E, F, and G should have a Date format. I calculate G automatically by saying `=max(0, F3 - E3)`, but if you do that, make sure you enter times in 24-hour format, because if you work through lunch (e.g. 11:00 to 1:30) your total column will be 0:00.
+

data/Rakefile

@@ -58,3 +58,6 @@ task :run, [] => [] do |t, args|
   RbInvoice::write_invoice(*RbInvoice::Options::parse_command_line(%w{okvenue}))
 end
 
+task :readme => [] do |task|
+  `markdown README.md >README.html`
+end

data/TODO

@@ -8,5 +8,6 @@
 - more tests
 - print the pdflatex results to std{out,err} only if the user gives a --verbose flag.
 - Fix LaTeX escaping for double quotes.
+- Add an option to redo the last invoice for the given client.
 
 

data/VERSION

@@ -1 +1 @@
-0.2.3
+0.2.4

data/lib/rbinvoice.rb

@@ -15,6 +15,8 @@ module RbInvoice
   COL_START_TIME = 'E'
   COL_END_TIME   = 'F'
   COL_TOTAL_TIME = 'G'
+  COL_MONDAY     = 'H'
+  COL_NOTES      = 'I'
 
   # TODO:
   #   - Figure out the next invoice_number.
@@ -43,7 +45,7 @@ module RbInvoice
       earliest_date = if last_invoice
                      last_invoice[:end_date] + 1
                    else
-                     parse_date(earliest_task_date)
+                     parse_date(earliest_task_date(hours))
                    end
       start_date, end_date = RbInvoice::Options::find_invoice_bounds(earliest_date, freq)
       tasks = hourly_breakdown(client, start_date, end_date, opts)
@@ -59,20 +61,25 @@ module RbInvoice
 
   def self.make_pdf(tasks, start_date, end_date, filename, opts)
     write_latex(tasks, end_date, filename, opts)
-    system("cd \"#{File.dirname(filename)}\" && pdflatex \"#{File.basename(filename, '.pdf')}\"")
+    result = system("cd \"#{File.dirname(filename)}\" && pdflatex \"#{File.basename(filename, '.pdf')}\"")
+    raise "Problem running LaTeX: $?" unless result
     RbInvoice::Options::add_invoice_to_data(tasks, start_date, end_date, filename, opts) unless opts[:no_data_file]
   end
 
   def self.escape_for_latex(str)
-    str.gsub('&', '\\\\&').   # tricky b/c '\&' has special meaning to gsub.
+    (str || '').gsub('&', '\\\\&').   # tricky b/c '\&' has special meaning to gsub.
       gsub('"', '\texttt{"}').
       gsub('$', '\$').
-      gsub('+', '$+$')
+      gsub('+', '$+$').
+      gsub("\n", " \\\\\\\\ \n")
   end
 
   def self.write_latex(tasks, invoice_date, filename, opts)
     template = File.open(opts[:template]) { |f| f.read }
     rate = opts[:rate]    # TODO: Support per-task rates
+    full_name = RbInvoice::Options::full_name_for_client(opts[:data], opts, opts[:client])
+    address = RbInvoice::Options::address_for_client(opts[:data], opts, opts[:client])
+    description = RbInvoice::Options::description_for_client(opts[:data], opts, opts[:client])
     items = tasks.map{|task, details|
       task_total_hours = details.inject(0) {|t, row| t + row[2]}
       {
@@ -92,6 +99,10 @@ module RbInvoice
         line_items: items,
         total_duration: decimal_to_interval(items.inject(0) {|t, item| t + item['duration_decimal']}),
         total_price: "%0.02f" % items.inject(0) {|t, item| t + item['price_decimal']},
+        dba: escape_for_latex(opts[:dba]),
+        client_full_name: escape_for_latex(full_name),
+        client_address: escape_for_latex(address),
+        client_description: escape_for_latex(description),
       }.map{|k, v| [k.to_s, v]}
     ]
     latex = Liquid::Template.parse(template).render args
@@ -127,8 +138,12 @@ module RbInvoice
       to_client_key(ss.cell(row, COL_CLIENT) || '') == client
     }.map { |row|
       raise "Invalid task times: #{ss.cell(row, COL_START_TIME)}-#{ss.cell(row, COL_END_TIME)}" if ss.cell(row, COL_START_TIME) && ss.cell(row, COL_END_TIME) && ss.cell(row, COL_TOTAL_TIME) == '0:00:00'
-      [ss.cell(row, COL_DATE), ss.cell(row, COL_TASK), interval_to_decimal(ss.cell(row, COL_TOTAL_TIME))]
-    }
+      if ss.cell(row, COL_NOTES) == 'FREE'
+        nil
+      else
+        [ss.cell(row, COL_DATE), ss.cell(row, COL_TASK), interval_to_decimal(ss.cell(row, COL_TOTAL_TIME))]
+      end
+    }.compact
   end
 
   def self.interval_to_decimal(time)

data/lib/rbinvoice/options.rb

@@ -195,6 +195,22 @@ module RbInvoice
       key_for_client(data, client, :frequency)
     end
 
+    def self.dba_for_client(data, opts, client)
+      key_for_client(data, client, :dba) || opts[:dba] || 'Illuminated Computing Inc.'
+    end
+
+    def self.full_name_for_client(data, opts, client)
+      key_for_client(data, client, :full_name)
+    end
+
+    def self.address_for_client(data, opts, client)
+      key_for_client(data, client, :address)
+    end
+
+    def self.description_for_client(data, opts, client)
+      key_for_client(data, client, :description)
+    end
+
     def self.parse_command_line(argv)
       opts = Trollop::options(argv) do
         version "rbinvoice 0.1.0 (c) 2012 Paul A. Jungwirth"
@@ -243,6 +259,7 @@ module RbInvoice
       opts[:start_date] = Date.strptime(opts[:start_date], "%Y-%m-%d")  if opts[:start_date]
       opts[:end_date]   = Date.strptime(opts[:end_date], "%Y-%m-%d")    if opts[:end_date]
 
+      opts[:dba] = dba_for_client(opts[:data], opts, opts[:client])
       # Read the list of past invoices.
       # If there are none, assume there is only one invoice to do.
 

data/rbinvoice.gemspec

@@ -5,16 +5,17 @@
 
 Gem::Specification.new do |s|
   s.name = "rbinvoice"
-  s.version = "0.2.3"
+  s.version = "0.2.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Paul A. Jungwirth"]
-  s.date = "2012-08-23"
+  s.date = "2013-03-15"
   s.description = "      Reads hours from a Google Spreadsheet and generates a PDF invoice.\n"
   s.email = "pj@illuminatedcomputing.com"
   s.executables = ["rbinvoice", "rbinvoice"]
   s.extra_rdoc_files = [
     "LICENSE.txt",
+    "README.html",
     "README.md",
     "TODO"
   ]

data/spec/options_spec.rb

@@ -56,20 +56,20 @@ describe RbInvoice::Options do
 
   it "should compute the semimonth start date" do
     RbInvoice::Options::semimonth_start(Date.new(2011, 3, 5)).should == Date.new(2011, 3, 1)
-    RbInvoice::Options::semimonth_start(Date.new(2011, 3,21)).should == Date.new(2011, 3,15)
-    RbInvoice::Options::semimonth_start(Date.new(2011, 3,31)).should == Date.new(2011, 3,15)
+    RbInvoice::Options::semimonth_start(Date.new(2011, 3,21)).should == Date.new(2011, 3,16)
+    RbInvoice::Options::semimonth_start(Date.new(2011, 3,31)).should == Date.new(2011, 3,16)
     RbInvoice::Options::semimonth_start(Date.new(2011, 3, 1)).should == Date.new(2011, 3, 1)
     RbInvoice::Options::semimonth_start(Date.new(2011, 4, 8)).should == Date.new(2011, 4, 1)
-    RbInvoice::Options::semimonth_start(Date.new(2011, 2,28)).should == Date.new(2011, 2,15)
-    RbInvoice::Options::semimonth_start(Date.new(2012, 2,28)).should == Date.new(2012, 2,15)
-    RbInvoice::Options::semimonth_start(Date.new(2012, 2,29)).should == Date.new(2012, 2,15)
-    RbInvoice::Options::semimonth_start(Date.new(2011, 2,19)).should == Date.new(2011, 2,15)
-    RbInvoice::Options::semimonth_start(Date.new(2012, 2,19)).should == Date.new(2012, 2,15)
+    RbInvoice::Options::semimonth_start(Date.new(2011, 2,28)).should == Date.new(2011, 2,16)
+    RbInvoice::Options::semimonth_start(Date.new(2012, 2,28)).should == Date.new(2012, 2,16)
+    RbInvoice::Options::semimonth_start(Date.new(2012, 2,29)).should == Date.new(2012, 2,16)
+    RbInvoice::Options::semimonth_start(Date.new(2011, 2,19)).should == Date.new(2011, 2,16)
+    RbInvoice::Options::semimonth_start(Date.new(2012, 2,19)).should == Date.new(2012, 2,16)
     RbInvoice::Options::semimonth_start(Date.new(2012, 1, 5)).should == Date.new(2012, 1, 1)
     RbInvoice::Options::semimonth_start(Date.new(2011,12, 1)).should == Date.new(2011,12, 1)
     RbInvoice::Options::semimonth_start(Date.new(2011,12, 5)).should == Date.new(2011,12, 1)
     RbInvoice::Options::semimonth_start(Date.new(2011,12,15)).should == Date.new(2011,12, 1)
-    RbInvoice::Options::semimonth_start(Date.new(2011,12,25)).should == Date.new(2011,12,15)
+    RbInvoice::Options::semimonth_start(Date.new(2011,12,25)).should == Date.new(2011,12,16)
   end
 
   it "should compute the previous semimonth" do

data/templates/invoice.tex.liquid

@@ -8,7 +8,7 @@
 
 \noindent
 \begin{minipage}[t]{3in}
-Paul Jungwirth \\
+{{ dba }} \\
 2520 SW Edgemoor Ave. \\
 Beaverton, OR 97005 \\
 909 557-0421 \\
@@ -25,13 +25,13 @@ Beaverton, OR 97005 \\
 {% endraw %}
 
 \noindent {\sc to}: \\
-OK Venue LLC \\
-116 W 23rd St. \\
-New York, NY 10011 \\
+{{ client_full_name }} \\
+{% if client_address %}{{ client_address }} \\
+{% endif %}
 \smallskip
 
 \noindent {\sc for}: \\
-Consulting and programming for the okvenue.com website and related projects. \\
+{{ client_description }} \\
 \linebreak[4]
 
 \begin{tabular}{lrr}
@@ -45,8 +45,8 @@ Consulting and programming for the okvenue.com website and related projects. \\
 \bigskip
 
 \noindent
-Please make all checks payable to Paul Jungwirth. \\
-Payment due net 30 days. \\
+Please make all checks payable to {{ dba }}. \\
+Payment due upon receipt. \\
 
 \begin{center}
 \textbf{Thank you for your business!}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rbinvoice
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-23 00:00:00.000000000 Z
+date: 2013-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
@@ -148,6 +148,7 @@ executables:
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
+- README.html
 - README.md
 - TODO
 files:
@@ -166,6 +167,7 @@ files:
 - rbinvoice.gemspec
 - spec/options_spec.rb
 - templates/invoice.tex.liquid
+- README.html
 homepage: http://github.com/pjungwir/rbinvoice
 licenses:
 - MIT
@@ -181,7 +183,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1152283729066738972
+      hash: 2995707456041748597
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: