vfwcash 0.3.0

data/lib/vfwcash/api.rb

@@ -0,0 +1,48 @@
+
+module Vfwcash
+  class Api
+    attr_accessor  :config, :cash
+    def initialize(date=nil)
+      @date = date
+      require_relative '../models/sqlite_base'
+      @config = Vfwcash::Config
+      Dir.glob(File.join(LibPath,'models/*')).each do |file|
+        require file
+      end
+      @cash = Gcash.new(@config)
+      unless @cash.dates.include?(@date)
+        puts "No transactions exist for #{@date.beginning_of_month}"
+        exit(0)
+      end
+    end
+
+    def between(from,to)
+      pdf = Pdf::Between.new(@date,@cash,from,to)
+    end
+
+    def ledger
+      pdf = Pdf::Ledger.new(@date,@cash)
+    end
+
+    def summary
+      pdf = Pdf::Summary.new(@cash)
+    end
+
+    def register
+      pdf = Pdf::Register.new(@date,@cash)
+    end
+
+    def split
+      pdf = Pdf::SplitLedger.new(@date,@cash)
+    end
+
+    def audit
+      pdf = Pdf::Audit.new(@date,@cash)
+    end
+
+    def balance
+      pdf = Pdf::Balance.new(@date,@cash)
+    end
+
+  end
+end

data/lib/vfwcash/cli.rb

@@ -0,0 +1,195 @@
+require 'thor'
+# require 'vfwcash/cli/register'
+require 'chronic'
+require 'active_support'
+
+
+module Vfwcash
+
+  class Checkbook < Thor
+    map %w[--dates -d] => :__print_date_help
+
+    desc "--dates, -d", "print date format options"
+    def __print_date_help
+      puts <<-DATE_HELP
+        The DATE parameter is optional on all reports requiring a date and will default to the current date if not present.
+
+        All dates will be converted to the first of the month requardless of the date entered.
+
+        Entered dates are parsed using Chronic (https://github.com/mojombo/chronic).
+        Chronic provide a wide range options.
+
+        Probably the easiest option is the yyyy-mm format (again day is optional) but you can do stuff like:
+          last-may
+          last-October
+          'oct 2014'
+        DATE_HELP
+    end
+
+  desc "between date1 date2", "Get balances between two dates"
+  long_desc <<-HELLO_WORLD
+
+  Produces a Fund Balance summary between two dates (beginning balance, debits, credits, ending balance) in a compact format.
+
+  HELLO_WORLD
+
+  def between(first, last)
+    sdate = get_date(first)
+    edate = get_date(last)
+    bom = sdate - sdate.day + 1
+    Controller.new(bom).between(sdate,edate)
+  end
+
+
+  ######### VERSION
+    map %w[--version -v] => :__print_version
+
+     desc "--version, -v", "print the version"
+     def __print_version
+       puts "Version: #{Vfwcash::VERSION}"
+     end
+
+  ######### INSTALL
+    desc "install [--dir --db]", "Install config files and optional test DB in pwd or pwd/--dir"
+    long_desc <<-HELLO_WORLD
+
+    Install will create two directories [config,pdf]in your current working directory.
+    The PDF directory will contain copies of the generated PDF reports.
+    The config directory will contain a vfwcash.yml file that contains post information, 
+    path to sqlit3 database
+    and other configuration data needed to generate a Trustees' Report of Audit.
+
+    -- dir='dirname' will create a new directory in the working directory before the copies
+
+    -- db will copy a GnuCash test sqlite3 database into the config directory
+
+    HELLO_WORLD
+    method_option :dir, type: :string,
+                           desc: "Create a new directory",
+                           required: false
+    method_option :db, type: :boolean,
+                           default: false,
+                           desc: "Copy a Test GnuCash Database to the config directory"
+
+
+    def install
+      Vfwcash.install(options)
+    end
+
+  ######### REGISTER
+    desc "register [DATE]", "Checkbook register report"
+    long_desc <<-HELLO_WORLD
+
+    Produces a PDF reports of the checkbook register by month. All tranasaction for the month
+    are displayed, ordered by date and check number. A running balance is displayed starting with the
+    beginning balance. There is one line per transaction. Savings account transactions are displayed
+    but the amount is not added to the running balance.
+
+    The --split option displays the same information, but lines are added for each transaction showing 
+    the amount of each split by fund or income/expense account
+
+
+    HELLO_WORLD
+    def register( date=nil )
+      bom = get_date(date)
+      Controller.new(bom).register
+    end
+
+  ######### SPLIT
+    desc "split [DATE]", "Checkbook split register report"
+    long_desc <<-HELLO_WORLD
+
+    Produces a PDF reports of the checkbook register by month. All tranasaction for the month
+    are displayed, ordered by date and check number. A running balance is displayed starting with the
+    beginning balance. Savings account transactions are displayed
+    but the amount is not added to the running balance.
+
+    Each transaction will have multiple lines displaying 
+    the amount of each split by fund or income/expense account
+
+
+    HELLO_WORLD
+    def split( date=nil )
+      bom = get_date(date)
+      Controller.new(bom).split
+    end
+
+  ######### LEDGER
+    desc "ledger [DATE]", "General Ledger report by month"
+    long_desc <<-HELLO_WORLD
+
+    Produces a PDF report of the Post's General Ledger formated much like the VFW Ledger book.
+
+    Each transaction displays tranaction information along with each fund distribution. Balances include
+    the beginning balance, total debits(increases) and credits(decreases) and ending balance.
+
+    HELLO_WORLD
+
+    option :summary
+    def ledger( date=nil )
+      bom = get_date(date)
+      Controller.new(bom).ledger
+    end
+
+  ######### SUMMARY
+    desc "summary [DATE]", "General Ledger Summary Report"
+    long_desc <<-HELLO_WORLD
+
+    Produces a PDF report containing only a monthly summary of Post's General Ledger.
+
+    The report displays all months in the checkbook but only contains balances, debits and credits sums.
+
+    HELLO_WORLD
+
+    option :summary
+    def summary( date=nil )
+      bom = get_date(date)
+      Controller.new(bom).summary
+    end
+
+  ######### Audit
+    desc "audit [DATE]", "Trustee Audit Report "
+     long_desc <<-HELLO_WORLD
+
+     Productes a Trustee Audit Report for the ending quarter that ended before
+     the date enter. If date is not ended, it will be the last report.
+
+     HELLO_WORLD
+
+    def audit( date=nil )
+      bom = get_date(date)
+      Controller.new(bom).audit
+    end
+
+  ######### Balance
+    desc "balance [DATE]", "Monthly Fund Balance Summary "
+    long_desc <<-HELLO_WORLD
+
+    Produces a Monthly Fund Balance summary (beginning balance, debits, credits, ending balance) for only one month in a compact format.
+
+    HELLO_WORLD
+    def balance( date=nil )
+      bom = get_date(date)
+      Controller.new(bom).balance
+    end
+
+    private
+
+    def get_date(date)
+      if  date.nil?
+        bom = Date.today
+      else
+        bom = Chronic.parse(date)
+        if bom.nil?
+          puts "Invalid date #{date}"
+          exit(0)
+        else
+          bom = bom.to_date
+        end
+      end
+      bom
+    end
+
+
+  end
+end

data/lib/vfwcash/controller.rb

@@ -0,0 +1,83 @@
+require 'active_record'
+require 'sqlite3'
+require "prawn/table"
+require "prawn"
+require 'yaml'
+
+module Vfwcash
+  class Controller
+    attr_accessor  :config, :cash
+    def initialize(date)
+      require_relative '../models/sqlite_base'
+      @config = Vfwcash::Config
+      @date = date
+      Dir.glob(File.join(LibPath,'models/*')).each do |file|
+        require file
+      end
+      @cash = Gcash.new(@config)
+      unless @cash.dates.include?(@date)
+        puts "No transactions exist for #{@date.beginning_of_month}"
+        exit(0)
+      end
+    end
+
+    def between(from,to)
+      pdf = Pdf::Between.new(@date,@cash,from,to)
+      filename = "#{PWD}/pdf/between_#{from}_#{to}.pdf"
+      pdf.render_file(filename)
+      open_pdf(filename)
+    end
+
+    def ledger
+      pdf = Pdf::Ledger.new(@date,@cash)
+      filename = "#{PWD}/pdf/ledger_#{Vfwcash.yyyymm(@date)}.pdf"
+      pdf.render_file(filename)
+      open_pdf(filename)
+    end
+
+    def summary
+      pdf = Pdf::Summary.new(@cash)
+      filename = "#{PWD}/pdf/ledger_summary.pdf"
+      pdf.render_file(filename)
+      open_pdf(filename)
+    end
+
+
+    def register
+      pdf = Pdf::Register.new(@date,@cash)
+      filename = "#{PWD}/pdf/register_#{Vfwcash.yyyymm(@date)}.pdf"
+      pdf.render_file(filename)
+      open_pdf(filename)
+    end
+
+    def split
+      pdf = Pdf::SplitLedger.new(@date,@cash)
+      filename = "#{PWD}/pdf/split_#{Vfwcash.yyyymm(@date)}.pdf"
+      pdf.render_file(filename)
+      open_pdf(filename)
+    end
+
+    def audit
+      pdf = Pdf::Audit.new(@date,@cash)
+      filename = "#{PWD}/pdf/audit_#{Vfwcash.yyyymm(@date.beginning_of_quarter)}.pdf"
+      pdf.render_file(filename)
+      open_pdf(filename)
+    end
+
+    def balance
+      pdf = Pdf::Balance.new(@date,@cash)
+      filename = "#{PWD}/pdf/balance_#{Vfwcash.yyyymm(@date)}.pdf"
+      pdf.render_file(filename)
+      open_pdf(filename)
+    end
+
+    def open_pdf(filename)
+      if Gem::Platform.local.os == 'darwin'
+        `open #{filename}`
+      else
+        `start #{filename}`
+      end
+    end
+
+  end
+end

data/lib/vfwcash/version.rb

@@ -0,0 +1,3 @@
+module Vfwcash
+  VERSION = "0.3.0"
+end

data/lib/vfwcash.rb

@@ -0,0 +1,90 @@
+require "vfwcash/version"
+require 'vfwcash/cli'
+require 'vfwcash/controller'
+require 'vfwcash/api'
+
+module Vfwcash
+  # Define constants to define where your are and location of config file
+  LibPath = File.expand_path(File.dirname(__FILE__))
+  PWD = Dir.pwd
+  Config =  YAML.load_file(File.join(PWD,'config/vfwcash.yml'))
+
+  def self.yyyymm(date=nil)
+    date = Vfwcash.set_date(date)
+    yyyymm = date.strftime('%Y%m') # "#{date.year}#{date.month.to_s.rjust(2,'0')}"
+  end
+
+  def self.transaction_range
+    t = Tran.order(:post_date)
+    first = Date.parse(t.first.post_date).beginning_of_month
+    last = Date.parse(t.last.post_date).end_of_month
+    first..last
+  end
+
+  def self.set_date(date=nil)
+    if date.nil? || date == ""
+      date = Date.today
+    elsif date.class == Date
+    else
+      if date.length == 6
+        date += '01'
+      end
+      date = Date.parse(date)
+    end
+    date
+  end
+
+  def self.money(int)
+    dollars = int / 100
+    cents = (int % 100) / 100.0
+    amt = dollars + cents
+    set_zero = sprintf('%.2f',amt) # now have a string to 2 decimals
+    set_zero.gsub(/(\d)(?=(\d{3})+(?!\d))/, "\\1,") # add commas
+  end
+
+  def self.valid_root?
+    unless Dir.exist?(PWD+'/config') && Dir.exist?(PWD+'/pdf') && File.exist?(PWD+"/config/"+"vfwcash.yml")
+      puts "Error: vfwcash must be run from a diectory containing valid  configuration files"
+      exit(0)
+    end
+  end
+
+  def self.install(options)
+    wd = PWD
+    ok = true
+    if options['dir'].present?
+      unless Dir.exist?(wd+options['dir'])
+        Dir.mkdir(wd+'/'+options['dir'])
+        puts "Created a new directory in #{wd}"
+        ok = false
+        Dir.chdir(wd+'/'+options['dir'])
+        wd = Dir.pwd
+      end
+    end
+    unless Dir.exist?(wd+'/config')
+      Dir.mkdir(wd+'/config')
+      puts "Created config directory in #{wd}"
+      ok = false
+    end
+    unless Dir.exist?(wd+'/pdf')
+      Dir.mkdir(wd+'/pdf')
+      puts "Created pdf directory in #{wd}"
+      ok = false
+    end
+    unless File.exist?(wd+"/config/"+"vfwcash.yml")
+      FileUtils.cp((LibPath+"/templates/vfwcash.yml"),(wd+"/config/"+"vfwcash.yml"))
+      puts "Created vfwcash.yml file in config directory, must be edited for your post."
+      ok = false
+    end
+     if options['db']
+      unless File.exist?(wd+"/config/"+"vfwcash.gnucash")
+        FileUtils.cp((LibPath+"/templates/vfwcash.gnucash"),(wd+"/config/"+"vfwcash.gnucash"))
+        puts "Created vfwcash.gnucash db in config directory."
+        ok = false
+      end
+    end
+
+    puts "No installation required" if ok
+    puts "Installation complete. Edit your vfwcash.yml file to set your post information." if !ok
+  end
+end