vfwcash 0.3.0

data/lib/models/gcash.rb

@@ -0,0 +1,189 @@
+require "yaml/store"
+
+module Vfwcash
+
+  class Gcash
+    # gcash is the primary interface to the GNUCash database
+    # The initializer sets attributes based on data in the db and from the config file
+    # that is common to all reports.
+
+    # API calls provide informtion needed for specific reports.
+
+    attr_accessor  :balances, :checking, :savings, :checking_funds,:savings_funds,
+    :dates, :bmonth, :checking_acct, :savings_acct, :tmonths, :config
+
+     def initialize(config)
+      @config = config
+      @checking_acct = @config[:checking_acct]
+      @savings_acct = @config[:savings_acct]
+      @checking_funds = CashAccount.find_by(name:@checking_acct).children.pluck(:name)
+      @savings_funds = CashAccount.find_by(name:@savings_acct).children.pluck(:name)
+      @dates = Vfwcash.transaction_range
+      set_tmonths 
+    end
+  # COMMON Methods
+    def set_tmonths
+      @tmonths = []
+      first = @dates.first
+      last = @dates.last
+      curr = first
+      while curr < last do
+        @tmonths << "#{curr.year}#{curr.month.to_s.rjust(2,'0')}"
+        curr += 1.month
+      end
+    end
+
+    def get_fund_balances(bdate,edate)
+      @balances = {}
+      @balances[:checking] =  {bbalance:0,diff:0,debits:0,credits:0,ebalance:0}
+      @balances[:savings] =  {bbalance:0,diff:0,debits:0,credits:0,ebalance:0}
+      accts = @checking_funds + @savings_funds
+      accts.each do |f|
+        acct = CashAccount.find_by(name:f)
+        @balances[f] = acct.balances_between(bdate,edate)
+        if @checking_funds.include?(f)
+          sum_from_to(@balances[f],@balances[:checking])
+        else
+          sum_from_to(@balances[f],@balances[:savings])
+        end
+      end
+      @checking = @balances[:checking]
+      @savings = @balances[:savings]
+    end
+
+    def sum_from_to(ffund,tfund)
+      ffund.each do |k,v|
+        tfund[k] += v
+      end
+    end
+
+    def get_all_balances
+      balances = {checking:{},savings:{}}
+      accts = @checking_funds + @savings_funds
+      accts.each do |f|
+        acct = CashAccount.find_by(name:f)
+        balances[f] = {}
+        tmonths.each do |m|
+          bom = Date.parse(m+"01")
+          eom = bom.end_of_month
+          balances[f][m] = get_fund_balances(bom,eom)
+          balances[:checking][m] = @checking
+          balances[:savings][m] = @savings
+        end
+      end
+      @balances = balances
+      @checking = @balances[:checking]
+      @saving = @balances[:savings]
+    end
+
+  # REPORT Specific Methods
+    def between_balance(from,to)
+      between = {}
+      accts = @checking_funds + @savings_funds
+      accts.each do |f|
+        acct = CashAccount.find_by(name:f)
+        between[f] = acct.balances_between(from,to)
+      end
+      between
+    end
+
+    def audit_api(report_date)
+      date = Vfwcash.set_date(report_date)
+      boq = date.beginning_of_quarter
+      eoq = boq.end_of_quarter
+      if eoq.month >= date.month
+        boq = (boq - 1.month).beginning_of_quarter
+        eoq = boq.end_of_quarter
+      end
+      get_fund_balances(boq,eoq)
+      rbalances = @balances
+      rbalances["Cash"] = {bbalance:100000,ebalance:100000,debits:0,credits:0}
+      rbalances[:dates] = {boq:boq,eoq:eoq, report_date:date}
+      rbalances
+    end
+
+    def split_ledger_api(date)
+      response = {rows:split_ledger(date)}
+      response[:balances] = {checking:@checking}
+      response[:month] = @bmonth
+      return response
+    end
+
+    def split_ledger(date)
+      @bmonth = Vfwcash.yyyymm(date)
+      trans = Tran.month_transactions(date)
+      lines = []
+      b = @checking[:bbalance]
+      trans.each do |t|
+        date = Date.parse(t.post_date)
+        line = {date: date.strftime("%m/%d/%Y"),num:t.num,desc:t.description,
+          checking:{db:0,cr:0},details:[],balance:0, memo:nil,r:nil}
+        t.splits.each do |s|
+          details = s.details
+          if details[:name].include?("#{@checking_acct}:")
+            line[:checking][:db] += details[:db]
+            line[:checking][:cr] += details[:cr]
+            b += (details[:db] - details[:cr])
+            line[:balance] = b
+            line[:r] = details[:r]
+          else
+            line[:balance] = b
+            if line[:memo].nil?
+              line[:memo] = details[:name]
+            else
+              line[:memo] = "- Split Transaction -"
+            end
+          end
+          line[:details] << details
+        end
+        lines << line
+      end
+      lines
+    end
+
+    def month_ledger_api(date)
+      response = {rows:month_ledger(date)}
+      fund_bal = {}
+      @checking_funds.each do |f|
+        fund_bal[f] = @balances[f]
+      end
+      response[:balances] = {savings:@savings,checking:@checking,funds:fund_bal}
+      response[:funds] = {savings:@savings_funds,checking:@checking_funds}
+      response[:month] = @bmonth
+      return response
+    end
+
+    def month_ledger(date)
+      @bmonth = Vfwcash.yyyymm(date)
+      trans = Tran.month_transactions(date)
+      lines = []
+      trans.each do |t|
+        date = Date.parse(t.post_date)
+        line = {date: date.strftime("%m/%d/%Y"),num:t.num,r:nil,desc:t.description,checking:{db:0,cr:0}}
+        @checking_funds.each do |f|
+          line[f] = {db:0,cr:0}
+        end
+        line[:savings] = {db:0,cr:0}
+        t.splits.each do |s|
+          details = s.details
+          if details[:name].include?("#{@checking_acct}:")
+            line[details[:fund]][:db] += details[:db]
+            line[details[:fund]][:cr] += details[:cr]
+            line[:checking][:db] += details[:db]
+            line[:checking][:cr] += details[:cr]
+            line[:r] = details[:r]
+          elsif details[:name].include?("#{@savings_acct}:")
+            line[:savings][:db] += details[:db]
+            line[:savings][:cr] += details[:cr]
+            line[:r] = details[:r]
+          end
+        end
+
+        lines << line
+      end
+      lines
+    end
+
+  end
+
+end

data/lib/models/ledger.rb

@@ -0,0 +1,109 @@
+class Pdf::Ledger < Prawn::Document
+  attr_accessor :response, :date, :cwidths
+
+  def initialize(date,cash)
+    super( top_margin: 35, page_layout: :landscape)
+    @date = Vfwcash.set_date(date).beginning_of_month
+    @config = cash.config
+    cash.get_fund_balances(@date,@date.end_of_month)
+    @response = cash.month_ledger_api(@date)
+
+    make_pdf
+    number_pages "#{Date.today}   -   Page <page> of <total>", { :start_count_at => 0, :page_filter => :all, :at => [bounds.right - 100, 0], :align => :right, :size => 6 }
+  end
+
+  def header
+    arr = ["Date", "Num","R", "Description", {content: "+ Checking -",colspan:2, align: :center}]
+    @cwidths = [36, 22,8,108,32,32]
+    @response[:funds][:checking].each do |f|
+      arr << {content:"+ #{f} -",colspan:2, align: :center}
+      @cwidths << 30
+      @cwidths << 30
+    end
+    arr << {content:"+ Savings -",colspan:2, align: :center}
+    @cwidths << 30
+    @cwidths << 30
+    arr
+  end
+
+  def bbalance_row
+    cntnt = "Beginning balance #{@response[:month]}: "
+    cntnt += "Total Current Assets #{money(@response[:balances][:savings][:bbalance] + @response[:balances][:checking][:bbalance])}"
+
+    arr = [{content: cntnt,colspan:4,font_style: :bold}]
+    arr << {content: money(@response[:balances][:checking][:bbalance]),colspan:2, align: :center,font_style: :bold}
+    @response[:funds][:checking].each do |f|
+      arr << { content: money(@response[:balances][:funds][f][:bbalance]),colspan:2, align: :center,font_style: :bold}
+    end
+    arr << {content: money(@response[:balances][:savings][:bbalance]),colspan:2, align: :center,font_style: :bold}
+    arr
+  end
+
+  def ebalance_row
+    cntnt = "Ending balance #{@response[:month]}: "
+    cntnt += "Total Current Assets #{money(@response[:balances][:savings][:ebalance] + @response[:balances][:checking][:ebalance])}"
+
+    arr = [{content: cntnt,colspan:4,font_style: :bold}]
+    arr << {content: money(@response[:balances][:checking][:ebalance]),colspan:2, align: :center,font_style: :bold}
+    @response[:funds][:checking].each do |f|
+      arr << { content: money(@response[:balances][:funds][f][:ebalance]),colspan:2, align: :center,font_style: :bold}
+    end
+    arr << {content: money(@response[:balances][:savings][:ebalance]),colspan:2, align: :center,font_style: :bold}
+    arr
+  end
+
+  def summary_row
+    cntnt = "Debits/Credits Summary #{@response[:month]}: "
+    arr = [{content: cntnt,colspan:4,font_style: :bold}]
+    arr << {content: money(@response[:balances][:checking][:debits]), align: :right}
+    arr << {content: money(@response[:balances][:checking][:credits]), align: :right}
+    @response[:funds][:checking].each do |f|
+      arr << {content: money(@response[:balances][:funds][f][:debits]), align: :right}
+      arr << {content: money(@response[:balances][:funds][f][:credits]), align: :right}
+    end
+    arr << {content: money(@response[:balances][:savings][:debits]), align: :right}
+    arr << {content: money(@response[:balances][:savings][:credits]), align: :right}
+    arr
+  end
+
+  def make_pdf
+    font_size 6
+    build_table
+    draw_table
+  end
+
+  def build_table
+    @rows = [header]
+    @rows << bbalance_row
+    @response[:rows].each do |r|
+      arr = []
+      r.each do |k,v|
+        if v.class == Hash
+          arr << (v[:db].zero? ? nil :{content: (money(v[:db])), align: :right})
+          arr << (v[:cr].zero? ? nil :{content: (money(v[:cr])), align: :right})
+        else
+          arr << v
+        end
+      end
+      @rows << arr
+    end
+    @rows << summary_row
+    @rows << ebalance_row
+  end
+
+  def draw_table
+    text "#{@config[:post][:post]} General Ledger - #{@date}", style: :bold, align: :center
+    move_down(2)
+    e = make_table @rows,row_colors: ["F8F8F8", "FFFFFF"],:cell_style => {:padding => [1, 2, 2, 1],border_color:"E0E0E0"}, 
+      :column_widths => @cwidths, header:true do
+      
+      row(0).font_style = :bold
+    end
+    e.draw
+  end
+
+  def money(int)
+    Vfwcash.money(int)
+  end
+
+end

data/lib/models/register.rb

@@ -0,0 +1,54 @@
+class Pdf::Register < Prawn::Document
+  attr_accessor :response, :date
+
+  def initialize(date,cash)
+    super( top_margin: 35)
+    @date = Vfwcash.set_date(date).beginning_of_month
+    @config = cash.config
+    cash.get_fund_balances(@date,@date.end_of_month)
+    @response = cash.split_ledger_api(@date)
+    make_pdf
+    number_pages "#{Date.today}   -   Page <page> of <total>", { :start_count_at => 0, :page_filter => :all, :at => [bounds.right - 100, 0], :align => :right, :size => 6 }
+  end
+
+  def header
+    arr = ["Date", "Num","Description","Account","R","Debits","Credits", "Balance"]
+  end
+
+  def balance_row
+    [{content:'',colspan: 2},"Beginning Balance",nil,nil,nil,nil,{content: money(@response[:balances][:checking][:bbalance]),align: :right}]
+  end
+
+  def make_pdf
+    font_size 7
+    build_table
+    draw_table
+  end
+
+  def build_table
+    @rows = [header]
+    @rows << balance_row
+    @response[:rows].each do |row|
+      arr =  [row[:date],row[:num],row[:desc],row[:memo],row[:r]]
+      arr << (row[:checking][:db].zero? ? nil : {content: money(row[:checking][:db]), align: :right})
+      arr << (row[:checking][:cr].zero? ? nil : {content: money(row[:checking][:cr]), align: :right})
+      arr << (row[:balance].zero? ? nil : {content: money(row[:balance]), align: :right})
+      @rows << arr
+    end
+  end
+
+  def draw_table
+    text "#{@config[:post][:post]} Checkbook Register - #{@date}", style: :bold, align: :center
+    move_down(2)
+    e = make_table @rows,row_colors: ["F8F8F8", "FFFFFF"],:cell_style => {:padding => [1, 2, 2, 1],border_color:"E0E0E0"}, 
+      :column_widths => [40, 24, 150,110,10,40,40,40,40], header:true do
+      row(0).font_style = :bold
+    end
+    e.draw
+  end
+
+ def money(int)
+   Vfwcash.money(int)
+ end
+
+end

data/lib/models/split.rb

@@ -0,0 +1,26 @@
+class Split < SqliteBase
+  self.primary_key = 'guid'
+  belongs_to :tran, foreign_key: 'tx_guid'
+  belongs_to :cash_account, foreign_key: 'account_guid'
+
+  def amount
+    return "#{self.value_num / self.value_denom}.#{self.value_num % self.value_denom}"
+  end
+
+  def details
+    acct = self.cash_account
+    fund = acct.name
+    parent = acct.parent
+    acct_name = parent.present? ? "#{parent.name}:#{acct.name}" : acct.name
+
+    amt = self.value_num
+    if amt.to_f < 0
+      credit = amt * -1
+      debit = 0
+    else
+      credit = 0
+      debit = amt
+    end
+    return {fund:fund,name:acct_name,cr:credit,db:debit, memo:self.memo, r:self.reconcile_state}
+  end
+end

data/lib/models/split_ledger.rb

@@ -0,0 +1,69 @@
+class Pdf::SplitLedger < Prawn::Document
+  attr_accessor :response, :date
+
+  def initialize(date,cash)
+    super( top_margin: 35)
+    @date = Vfwcash.set_date(date).beginning_of_month
+    @config = cash.config
+    cash.get_fund_balances(@date,@date.end_of_month)
+    @response = cash.split_ledger_api(@date)
+    make_pdf
+    number_pages "#{Date.today}   -   Page <page> of <total>", { :start_count_at => 0, :page_filter => :all, :at => [bounds.right - 100, 0], :align => :right, :size => 6 }
+  end
+
+  def header
+    arr = ["Date", "Num","Description","Account","R","Debits","Credits", "Balance"]
+  end
+
+  def balance_row
+    [{content:'',colspan: 2},"Beginning Balance",nil,nil,nil,nil,{content: money(@response[:balances][:checking][:bbalance]),align: :right}]
+  end
+
+  def make_pdf
+    font_size 7
+    build_table
+    draw_table
+  end
+
+  def build_table
+    @rows = [header]
+    @rows << balance_row
+    @response[:rows].each do |row|
+      arr =  [row[:date],row[:num],row[:desc],nil,nil]
+      arr << (row[:checking][:db].zero? ? nil : {content: money(row[:checking][:db]), align: :right})
+      arr << (row[:checking][:cr].zero? ? nil : {content: money(row[:checking][:cr]), align: :right})
+      arr << (row[:balance].zero? ? nil : {content: money(row[:balance]), align: :right})
+      @rows << arr
+      row[:details].each do |d|
+        arr = [{content:'',colspan: 2},d[:memo], d[:name],d[:r],
+          (d[:db].zero? ? nil : {content: money(d[:db]), align: :right}),
+          (d[:cr].zero? ? nil : {content: money(d[:cr]), align: :right}),
+          nil
+        ]
+        @rows << arr
+      end
+    end
+  end
+
+  def draw_table
+    text "#{@config[:post][:post]} Split Ledger - #{@date}", style: :bold, align: :center
+    move_down(2)
+    e = make_table @rows,:cell_style => {:padding => [1, 2, 2, 1],border_color:"E0E0E0"}, 
+      :column_widths => [40, 24, 150,100,10,40,40,40,40], header:true do
+      row(0).font_style = :bold
+      i = row_length - 1
+      0.upto(i) do |j|
+        if cells[j,0].content.blank?
+          row(j).style(:background_color => 'F8F8F8')
+        end
+      end
+    end
+    e.draw
+  end
+
+  def money(int)
+    Vfwcash.money(int)
+  end
+
+
+end

data/lib/models/sqlite_base.rb

@@ -0,0 +1,10 @@
+class SqliteBase < ActiveRecord::Base
+  self.logger = Logger.new(STDERR)
+  self.logger.level = 3
+
+  establish_connection(
+          :adapter => 'sqlite3',
+          :database => Vfwcash::Config[:database]
+        )
+  self.abstract_class = true
+end

data/lib/models/summary.rb

@@ -0,0 +1,98 @@
+class Pdf::Summary < Prawn::Document
+  attr_accessor :cash, :date, :cwidths
+
+  def initialize(cash)
+    super( top_margin: 35, page_layout: :landscape)
+    @cash = cash
+    @cash.get_all_balances
+    @config = @cash.config
+    make_pdf
+    number_pages "#{Date.today}   -   Page <page> of <total>", { :start_count_at => 0, :page_filter => :all, :at => [bounds.right - 100, 0], :align => :right, :size => 6 }
+  end
+
+  def header
+    arr = ["General Ledger Summary for #{@cash.dates}", {content: "+ Checking -",colspan:2, align: :center}]
+    @cwidths = [160,32,32]
+    @cash.checking_funds.each do |f|
+      arr << {content:"+ #{f} -",colspan:2, align: :center}
+      @cwidths << 30
+      @cwidths << 30
+    end
+    arr << {content:"+ Savings -",colspan:2, align: :center}
+    @cwidths << 30
+    @cwidths << 30
+    arr
+  end
+
+  def bbalance_row(m)
+    tca = @cash.balances[:savings][m][:bbalance] + @cash.balances[:checking][m][:bbalance]
+    cntnt = " #{m} Beginning Balance (Current Assets #{money(tca)} )"
+    arr = [{content: cntnt,font_style: :bold}]
+    arr << {content: money(@cash.balances[:checking][m][:bbalance]),colspan:2, align: :center,font_style: :bold}
+    @cash.checking_funds.each do |f|
+      arr << { content: money(@cash.balances[f][m][:bbalance]),colspan:2, align: :center,font_style: :bold}
+    end
+    arr << {content: money(@cash.balances[:savings][m][:bbalance]),colspan:2, align: :center,font_style: :bold}
+    arr
+  end
+
+  def ebalance_row(m)
+    tca = @cash.balances[:savings][m][:bbalance] + @cash.balances[:checking][m][:bbalance]
+    cntnt = " #{m} Current Balance (Current Assets #{money(tca)} )"
+    arr = [{content: cntnt,font_style: :bold}]
+    arr << {content: money(@cash.balances[:checking][m][:ebalance]),colspan:2, align: :center,font_style: :bold}
+    @cash.checking_funds.each do |f|
+      arr << { content: money(@cash.balances[f][m][:ebalance]),colspan:2, align: :center,font_style: :bold}
+    end
+    arr << {content: money(@cash.balances[:savings][m][:ebalance]),colspan:2, align: :center,font_style: :bold}
+    arr
+  end
+
+  def summary_row(m)
+    pl = @cash.balances[:savings][m][:diff] + @cash.balances[:checking][m][:diff]
+    cntnt = "Total Debits/Credits (Profit/Loss: #{money(pl)})"
+    arr = [{content: cntnt,font_style: :bold}]
+    arr << {content: money(@cash.balances[:checking][m][:debits]), align: :right}
+    arr << {content: money(@cash.balances[:checking][m][:credits]), align: :right}
+    @cash.checking_funds.each do |f|
+      arr << {content: money(@cash.balances[f][m][:debits]), align: :right}
+      arr << {content: money(@cash.balances[f][m][:credits]), align: :right}
+    end
+    arr << {content: money(@cash.balances[:savings][m][:debits]), align: :right}
+    arr << {content: money(@cash.balances[:savings][m][:credits]), align: :right}
+    arr
+  end
+
+ 
+  def make_pdf
+    font_size 6
+    build_table
+    draw_table
+  end
+
+  def build_table
+    @rows = [header]
+    @cash.tmonths.each do |m|
+      @rows << bbalance_row(m)
+      @rows << summary_row(m)
+    end
+    m = @cash.tmonths.last
+    @rows << ebalance_row(m)
+  end
+
+  def draw_table
+    text "#{@config[:post][:post]} General Ledger Summary", style: :bold, align: :center
+    move_down(2)
+    e = make_table @rows,row_colors: ["F8F8F8", "FFFFFF"],:cell_style => {:padding => [1, 2, 2, 1],border_color:"E0E0E0"}, 
+      :column_widths => @cwidths, header:true do
+      
+      row(0).font_style = :bold
+    end
+    e.draw
+  end
+
+  def money(int)
+    Vfwcash.money(int)
+  end
+
+end

data/lib/models/tran.rb

@@ -0,0 +1,12 @@
+class Tran < SqliteBase
+	self.table_name = "transactions"
+	self.primary_key = 'guid'
+
+	has_many :splits, foreign_key: 'tx_guid'
+
+  def self.month_transactions(date)
+    month = Vfwcash.yyyymm(date)
+    trans = Tran.where('transactions.post_date BETWEEN ? and ?',month+"00",month+"32").order(:post_date,:num)
+  end
+
+end

data/lib/templates/vfwcash.yml

@@ -0,0 +1,95 @@
+---
+# path to you exported or saved sqlite3 GnuCash database
+:database: "/Users/salex/Work/vfwcash/config/vfwcash.gnucash"
+# GnuCash parent account names for Checking and Savings accounts
+:checking_acct: Checking Account
+:savings_acct: Savings Account
+# Balance from bank statement and GnuCash on last Bank Balance reconciliation
+# GnuCash stores all amounts (money) as integers or Pennies in US Dollars
+# to be consistent, follow that convention in the config file
+:checking:
+  :balance: 1783700
+  :outstanding: 20000
+  :date: 
+# The rest of the configuration data is used to format the Trustee' Report of Audit
+:qm:
+  :name: Steven V Quartermaster
+  :address: 405 Somestreet Hls
+  :city: Sometown AL, 35901
+:post:
+  :name: Some name
+  :post: VFW Post 66666
+  :numb: 66666
+  :address: 817 somestreet Dr
+  :city: Sometown AL, 35901
+  :department: Alabama
+# Questions and Answers from the operations section
+:operations:
+  :a:
+    :ques: a. Have required payroll deductions been made?
+    :answ: 'Yes'
+  :b:
+    :ques: b. Have payments been made to the proper State & Federal agencies this
+      quarter?
+    :answ: 'Yes'
+  :c:
+    :ques: c. Have Sales Taxes been collected and paid?
+    :answ: 'Yes'
+  :d:
+    :ques: d. Are Club employees bonded?
+    :answ: 'Yes'
+  :e:
+    :ques: e. Amount of outstanding bills?
+    :answ: 0
+  :f:
+    :ques: f. Value of Real Estate?
+    :answ: 58850000
+  :g:
+    :ques: g. Amount of Liability Insurance?
+    :answ: 30000000
+  :h:
+    :ques: h. Owed on Mortgages and Loans?
+    :answ: 0
+  :i:
+    :ques: i. Value of Personal Property?
+    :answ: 4680000
+  :j:
+    :ques: j. Amount of Property Insurance?
+    :answ: 31350000
+# Date Audit report signed or submitted
+:date: '2015-07-14'
+:bond:
+  :name: Tallman Insurance Agency
+  :amount: 8000000
+  :to: '2016-09-30'
+# a cross reference to your fund names in GnuCash
+:funds:
+  1:
+    :fund: Dues
+    :text: 1. National and Department Dues (Per Capitia Tax)
+  2:
+    :fund: Fee
+    :text: 2. Admission or Application Fees (Department)
+  3:
+    :fund: General
+    :text: 3. Post General Fund
+  4:
+    :fund: Relief
+    :text: 4. Post Relief Fund (Poppy Profits, Donations, etc.)
+  5:
+    :fund: Reserve
+    :text: 5. Post Dues Reserve Fund (See Sec. 218, Manual of Procedure)
+  6:
+    :fund: Building
+    :text: 6. Post Home Building Fund (Including Savings but Not Real Estate)
+  7:
+    :fund: Cash
+    :text: 7. Post Canteen or Club Fund
+  8:
+    :fund: Temporary
+    :text: 8. Temporary Fund
+  9:
+    # Savings is not a real fund, but is computed as sum of all funds that are not
+    # a child of 'Checking Account'. The symbol ':savings' is used to access that sum
+    :fund: :savings
+    :text: 9. Bonds and Investments Not Credited to Funds