billtrap 0.0.2

data/lib/billtrap/cli.rb

@@ -0,0 +1,73 @@
+# encoding: UTF-8
+module BillTrap
+  module CLI
+    extend Helpers
+    extend self
+    attr_accessor :args
+
+    def invoke
+      require 'cmd/usage'
+
+      case args.first when '-h', '--help', '--usage', '-?', 'help', nil
+        puts BillTrap::CLI.usage
+        exit 0
+      when '-v', '--version'
+        puts "BillTrap version #{BillTrap::VERSION}"
+        exit 0
+      end
+
+      # Grab global options, then stop
+      flags = Trollop::options args do
+        opt :debug
+        stop_on_unknown
+      end
+
+      command = args.shift
+      # Complete command
+      available = commands.select{ |key| key.match(/^#{command}/) }
+      if available.size == 1
+        require "cmd/#{available[0]}"
+        send available[0]
+      elsif available.size > 1
+        warn "Error: Ambiguous command '#{command}'"
+        warn "Matching commands are: #{available.join(", ")}"
+      else
+        warn "Error: Invalid command #{command.inspect}"
+      end
+    rescue StandardError, LoadError => e
+      raise e if flags && flags[:debug]
+      warn e.message
+    end
+
+    def commands
+      BillTrap::CLI.usage.scan(/\* \w+/).map{|s| s.gsub(/\* /, '')}
+    end
+
+    private
+
+    def confirm question
+      print "#{question} ? "
+      $stdin.gets =~ /\Aye?s?\Z/i
+    rescue Interrupt
+      # Avoid ugly trace
+      warn "\nCaught Interrupt. Exiting"
+      exit 1
+    end
+
+    def ask_value name, multiline=false
+      print "#{name}: "
+      if multiline
+        puts "(Multiline input, type Ctrl-D or insert END and return to exit)"
+        val = ($stdin.gets("END") || '').chomp("END")
+        puts
+      else
+        val = ($stdin.gets || '').chomp
+      end
+      return val
+    rescue Interrupt
+      # Avoid ugly trace
+      warn "\nCaught Interrupt. Exiting"
+      exit 1
+    end
+  end
+end

data/lib/billtrap/cmd/client.rb

@@ -0,0 +1,50 @@
+module BillTrap
+  module CLI
+    def client
+      opts = Trollop::options(args) do
+        opt :add, "Add a new ID, reading from STDIN", :short => '-a'
+        opt :delete, "Delete the client by ID", :type => Integer, :short => '-d'
+      end
+
+      if opts[:add]
+        firstname = ask_value "First name"
+        surname = ask_value "Surname"
+        company = ask_value "Company"
+        address = ask_value "Address", true
+        mail = ask_value "Mail"
+        rate = ask_value "Hourly rate"
+        currency = ask_value "Use non-standard Currency? [Leave empty for #{BillTrap::Config['currency']}]"
+
+        currency = currency.empty? ? BillTrap::Config['currency'] : currency
+        puts "'#{currency}'"
+
+        client = Client.create(
+          :firstname => firstname, 
+          :surname => surname, 
+          :company => company,
+          :address => address,
+          :mail => mail,
+          :rate => Money.parse(rate, currency).cents,
+          :currency => currency
+        )
+          puts "Client #{firstname} #{surname} was created with id #{client.id}"
+      elsif id = opts[:delete]
+        if e = Client.get(id)
+          if confirm "Are you sure you want to delete Client #{e.name} (##{e.id})"
+            begin
+              e.destroy
+              puts "Client has been removed."
+            rescue Sequel::ForeignKeyConstraintViolation
+              warn 'Error: Client is still in use. Refusing to delete client'
+            end
+          else
+            puts "Client has NOT been removed."
+          end
+        else
+          warn "Can't find Client with id '#{id}'"
+        end
+      end
+    end
+    
+  end
+end

data/lib/billtrap/cmd/configure.rb

@@ -0,0 +1,8 @@
+module BillTrap
+  module CLI
+    def configure
+      BillTrap::Config.configure!
+      puts "Config file written to: #{BillTrap::Config::CONFIG_PATH.inspect}"
+    end
+  end
+end

data/lib/billtrap/cmd/entry.rb

@@ -0,0 +1,45 @@
+module BillTrap
+  module CLI
+    def entry
+      opts = Trollop::options args do
+        opt :add, "Manually add entry to current invoice", :short => '-a'
+        opt :delete, "Delete entry from current invoice by ID", :type => :int, :short => '-d'
+      end
+      current = Invoice.current
+      if opts[:add]
+        title = ask_value 'Entry title'
+        date  = ask_value 'Entry date (YYYY-MM-DD)'
+        unit  = ask_value "Displayed unit (Defaults to 'h' for hours)" || 'h'
+        count = ask_value "Quantity (Numeric)"
+        price = ask_value "Price in #{current.currency} per unit (Numeric)"
+        notes = ask_value 'Optional Notes', true
+
+        e = InvoiceEntry.create(
+          :invoice_id => current.id,
+          :title => title,
+          :date => Date.parse(date),
+          :unit => unit,
+          :count => count,
+          :notes => notes,
+          :cents => Money.parse(price).cents
+        ) 
+
+        puts "Added entry (##{e.id}) to current invoice (ID #{current.id})"
+      elsif name = opts[:name]
+        Invoice.current.update(:name => name)
+        puts "Set current invoice (##{Invoice.current.id}) name to: #{name}"
+      elsif id = opts[:delete]
+        if e = InvoiceEntry[id]
+          if confirm "Are you sure you want to delete InvoiceEntry ##{e.id}"
+            e.destroy
+            puts "Entry has been removed."
+          else
+            puts "Entry has NOT been removed."
+          end
+        else
+          warn "Can't find entry with id '#{id}'"
+        end
+      end
+    end
+  end
+end

data/lib/billtrap/cmd/export.rb

@@ -0,0 +1,32 @@
+module BillTrap
+  module CLI
+    def export
+      opts = Trollop::options args do
+        opt :adapter, "Set adapter", :type => :string, :short => '-a'
+      end
+      adapter = opts[:adapter] || 'ooffice'
+      begin
+        # Replace invoice number placeholders
+        arg = {
+          # Unique, auto-incremented invoice id (from database)
+          :invoice_id => Invoice.current.id,
+          # Unique, auto-incremented client id
+          :client_id => Invoice.current.client_id
+        }
+
+        # Replace above parameters, then strfime parameters
+        invoice_number = Invoice.current.created.strftime(Config['invoice_number_format'].gsub(/%\{(.*?)\}/) { arg[$1.to_sym] })
+
+        attributes = {
+          :invoice => Invoice.current,
+          :invoice_number => invoice_number,
+        }
+
+        BillTrap::Adapters.load_adapter(adapter).new(attributes).generate
+      rescue LoadError
+        warn "Couldn't load adapter named #{adapter}.rb"
+      end
+
+    end
+  end
+end

data/lib/billtrap/cmd/import.rb

@@ -0,0 +1,47 @@
+module BillTrap
+  module CLI
+    def import
+      opts = Trollop::options args do
+        opt :clear, "Clear entries before import", :short => '-c'
+        opt :entry, "Import entries by ID", :type => :strings, :multi => true, :short => '-e'
+        opt :round, "Round imported entries", :short => '-r'
+        opt :sheet, "Import sheet by name", :type => :string, :short => '-s'
+      end
+      
+      # Clear entries if --clear given
+      if opts[:clear]
+        InvoiceEntry.where(:invoice_id => Invoice.current.id).destroy
+      end
+
+      entries = 
+      if opts[:sheet]
+        Entry.filter(:sheet => opts[:sheet]).all
+      elsif opts[:entry_given]
+        Entry.where(:id => opts[:entry].first).all
+      else 
+        []
+      end
+
+      unless entries.length > 0
+        warn "No matching entries found."
+        return
+      end
+
+      entries.each do |e|
+        Entry.round = opts[:round]
+        # Ignore entry if (rounded) is empty
+        next if e.duration == 0
+        imported = InvoiceEntry.create(
+          :invoice_id => Invoice.current.id,
+          :title => e.sheet,
+          :date => e.start.to_date,
+          :unit => 'h',
+          :count => (e.duration.to_f / 3600).round(2),
+          :notes => e.note,
+          :cents => Invoice.current.rate.cents
+        ) 
+        puts "Imported #{imported.count} hours from sheet #{e.sheet} as entry ##{imported.id}"
+      end
+    end
+  end
+end

data/lib/billtrap/cmd/in.rb

@@ -0,0 +1,16 @@
+module BillTrap
+  module CLI
+     def in
+      key = args.shift || raise('Error: No ID/Name given')
+      invoice = Invoice.get key
+
+      if invoice
+        puts "Activating invoice ##{invoice.id}"
+        # set current id
+        Invoice.current = invoice.id
+      else
+        puts "No Invoice found for input '#{key}'"
+      end
+    end 
+  end
+end

data/lib/billtrap/cmd/new.rb

@@ -0,0 +1,28 @@
+module BillTrap
+  module CLI
+    def new
+      opts = Trollop::options args do
+        opt :client, "Optional Client ID", :type => :string, :short => '-c'
+        opt :date, "Optional invoice date", :type => :string, :short => '-d'
+        opt :name, "Optional invoice name", :type => :string, :short => '-n'
+      end
+
+      date =
+        if opts[:date]
+          Chronic.parse(opts[:date])
+        else
+          Date.today
+        end
+
+
+      invoice = Invoice.create(
+        :name => opts[:name],
+        :created => date,
+        :client => Client.get(opts[:client])
+      )
+      # Make active
+      Invoice.current = invoice.id
+      puts "Created invoice ##{invoice.id}"
+    end
+  end
+end

data/lib/billtrap/cmd/payment.rb

@@ -0,0 +1,45 @@
+module BillTrap
+  module CLI
+    def payment
+      opts = Trollop::options args do
+        opt :add, "Add payment to current invoice", :type => :strings, :multi => true, :short => '-a'
+        opt :delete, "Delete payment by ID from current invoice", :type => :int, :short => '-d'
+      end
+      if opts[:add_given] && opts[:add][0].length > 1
+        # If the invoice has no total
+        if Invoice.current.total.cents == 0
+          warn "Can't add payment. Invoice ##{Invoice.current.id} has no total"
+          return
+        end
+
+        # Test if payment would add more than the remaining amount
+        payment = Money.parse(opts[:add][0].shift, Invoice.current.currency)
+        if (Invoice.current.received_amount + payment > Invoice.current.total)
+          warn 'With this payment, the received amount surpasses its total.'
+          cropped = Invoice.current.total - Invoice.current.received_amount
+          if ask_value "Do you want to add the remaining payment of #{format_money(cropped)}"
+            payment = cropped
+          else
+            puts "Payment has NOT been added."
+            return
+          end
+        end
+        Invoice.current.add_payment(:cents => payment.cents, :note => opts[:add][0].shift)
+        puts "Added #{format_money(payment)} to current invoice"
+      elsif opts[:delete]
+        if e = Payment[opts[:delete]]
+          if confirm "Are you sure you want to delete Payment ##{e.id}"
+            e.destroy
+            puts "Payment has been removed."
+          else
+            puts "Payment has NOT been removed."
+          end        
+        else
+          warn "Error: No Payment found for id ##{opts[:delete]}"
+        end
+      else
+        warn "Error: Invalid command"
+      end
+    end
+  end
+end

data/lib/billtrap/cmd/set.rb

@@ -0,0 +1,46 @@
+module BillTrap
+  module CLI
+    def set
+      # Grab subcommand
+      k = args.shift
+      case
+      when k == 'client'
+        id = args.shift
+        if e = Client.get(id)
+          Invoice.current.update(:client_id => e.id)
+          puts "SET client to #{e.name} (##{e.id})"
+        else
+          warn "Error: Can't find Client with id '#{id}'"
+        end
+      when k == 'date'
+        if d = args.shift
+          new_date = Date.parse d
+        else
+          new_date = Date.today
+        end
+        Invoice.current.update(:created => new_date)
+        puts "SET created date to #{format_date(new_date)}"
+      when k == 'name'
+        if n = args.shift
+          Invoice.current.update(:name => n)
+          puts "SET name to '#{n}'"
+        else
+          warn "Error: Missing required attributed for token 'name'"
+        end
+      when k == 'sent'
+        if d = args.shift
+          Invoice.current.update(:sent => Date.parse(d))
+          puts "SET invoice sent date to #{d}"
+        else
+          Invoice.current.update(:sent => nil)
+          puts "UNSET invoice sent date"
+        end
+      when k.respond_to?(:to_s)
+        Invoice.current.set_attr(k.to_str, args.shift)
+        puts "Setting attribute #{k}"
+      else
+        warn "Error: Missing / unrecognized TOKEN #{k}"
+      end
+    end
+  end
+end

data/lib/billtrap/cmd/show.rb

@@ -0,0 +1,87 @@
+module BillTrap
+  module CLI
+    def show
+      opts = Trollop::options args do
+        opt :completed, "Show only completed (i.e., sent and paid) invoices", :short => '-c'
+        opt :detail, "Show details (including entries) of a particular invoice", :type => :string, :short => '-d'
+      end
+      if opts[:detail]
+        # Display details of invoice with id/name from args
+        if invoice = Invoice.get(opts[:detail])
+
+          puts "%-12s%s" % ["Invoice: ", "#{invoice.name || 'unnamed'} (##{invoice.id})"]
+          puts "%-12s%s" % ["Created on: ", format_date(invoice.created)]
+          if invoice.sent
+            puts "%-12s%s" % ["Sent on: ", format_date(invoice.sent)]
+          end
+
+          puts '-' * 22
+          if invoice.invoice_entries.size > 0
+            puts 'Invoice entries'
+            # Determine length of entry titles
+            width = invoice.invoice_entries.sort_by{|inv| inv.title.to_s.length }.last.title.to_s.length + 4
+            width = 12 if width < 12
+            puts "  %-#{width}s%-12s%-12s%-12s%s" % ["Title", "Date", "Quantity", "Price", "Notes"]
+            invoice.invoice_entries.each do |e|
+              puts "  %-#{width}s%-12s%-12s%-12s%s" % [
+                e.title,
+                e.date,
+                e.typed_amount,
+                format_money(e.total),
+                e.notes
+              ]
+            end
+          else
+            puts 'No InvoiceEntries'
+          end
+
+          if invoice.payments.size > 0
+            puts '-' * 22
+            puts 'Received payments'
+            puts "  %12s    %s" % ["Payment", "Notes"]
+            invoice.payments.each do |e|
+              puts "  %12s    %s" % [
+                format_money(e.amount),
+                e.note
+              ]
+            end
+          else
+          end
+
+        else
+          puts "No Invoice found for input '#{detail_id}'"
+        end
+      elsif opts[:completed]
+        puts 'Showing only completed invoices'
+        print_invoices Invoice.completed
+      else
+        puts 'Showing open invoices'
+        print_invoices Invoice.open
+      end
+    end
+
+    private
+    def print_invoices invoices
+      if invoices.empty?
+        warn 'No matching invoices found'
+        return
+      end
+
+      # Determine length of invoice names
+      width = invoices.sort_by{|inv| inv.name.to_s.length }.last.name.to_s.length + 4
+      width = 12 if width < 12
+      puts " %-6s%-#{width}s%-24s%-16s%s" % ["ID", "Name", "Client", "Created", "Payments / Total"]
+      invoices.each do |i|
+        active = (Invoice.current.id == i.id) ? '>>' : ''
+        puts " %-6s%-#{width}s%-24s%-16s%s" % [
+          "#{active}#{i.id}",
+          i.name || ' - ',
+          i.client ? i.client.name : ' - ',
+          i.created,
+          "#{format_money(i.received_amount)} / #{format_money(i.total)}"
+          ]
+      end
+    end
+
+  end
+end