ledger_web 1.2

data/.gitignore

@@ -0,0 +1,10 @@
+.bundle
+db/*.sqlite3
+log/*.log
+tmp/
+.sass-cache/
+env.sh
+.DS_Store
+\#*
+.\#*
+*.gem

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2011 Peter Keen <pete@bugsplat.info>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,140 @@
+Ledger Web
+----------
+
+Ledger Web is a web-based, postgresql-backed reporting system for the [Ledger](http://www.ledger-cli.org) command-line accounting system.
+It is intended to be completely flexible, allowing you to write whatever reports you want. Note that Ledger Web requires **PostgreSQL version 9.0 or greater**.
+
+To install:
+
+    $ gem install ledger_web
+    $ createdb ledger
+    
+To run:
+
+    $ ledger_web
+    
+From there, open up http://localhost:9090 in your browser and poke around. You'll see a few example reports.
+
+#### Configuration
+
+Configuring Ledger Web is pretty simple. Create a file at `~/.ledger_web/config.rb` that looks something like this:
+
+
+    LedgerWeb::Config.new do |config|
+      config.set :database_url, "postgres://localhost/ledger"
+    end
+
+`:database_url` should point at your database instance. It doesn't have to be local, but the configured user needs to be able to alter the schema. There are a bunch more settings that you can set:
+
+* `:index_report` is the report that Ledger Web will redirect your browser to when you open it up the first time. Defaults to `:help`
+* `:port` is the port that Ledger Web will run on. Defaults to `9090`
+* `:ledger_file` is the file that Ledger Web will read. Defaults to the `LEDGER_FILE` environment variable
+* `:ledger_bin_path` is the path to the ledger binary. Defaults to finding it in the `PATH`
+
+#### Writing Reports
+
+Reports are just HTML ERB files that live in `~/.ledger_web/reports`. Ledger Web provides a few useful helpers that let you easily define SQL queries. Here's an example report:
+
+    <% @query = query do %>
+    select
+        xtn_month,
+        account,
+        sum(amount)
+    from
+        ledger
+    where
+        (account ~ 'Income'
+        or account ~ 'Expenses')
+        and xtn_date between :from and :to
+    group by
+        xtn_month,
+        account
+    <% end %>
+    <%= table @query %>
+
+The `query` helper takes a block of SQL and returns a `LedgerWeb::Report` instance. It can take a few options:
+
+* `:pivot` is the name of a column to pivot the report on. 
+* `:pivot_sort_order` says how to order the resulting pivoted columns. Can be `asc` or `desc`. Defaults to `asc`.
+
+Ledger Web uses [Twitter Bootstrap](http://twitter.github.com/bootstrap) for formatting, so you can use whatever you want to format your reports from there. 
+
+The `table` helper takes a query produced by the `query` helper and some options and builds an HTML table. Also, it can take a `:links` option which will linkify values in the table. Here's an example:
+
+    :links => {"Account" => "/reports/register?account=:1"}
+    
+This says that every value in the `Account` column will be surrounded with an `<a>` tag pointing at `/reports/register?account=:1`, where `:1` will be replaced by the value in column 1 of that particular row. You can also use `:title` in a link template. It will get replaced with the title of the column that is currently getting linked. In this case, `:title` would get replaced with `Account`. 
+
+#### Customizing
+
+Any ruby files in `~/.ledger_web/lib` will be loaded at startup so you can define your own classes, modules, whatever you want. In addition, you can put [Sequel migrations](http://sequel.rubyforge.org/rdoc/files/doc/migration_rdoc.html) in `~/.ledger_web/migrate` and they'll get applied as necessary at startup.
+
+#### Hooks
+
+Ledger Web provides several different hooks that get run during the data load process. 
+
+* `:before_insert_row` gets the Sequel database and the current row immediatley before insertion. Row is to be modified in place.
+* `:after_insert_row` gets the Sequel database and the current row. Row modifications don't matter.
+* `:before_load` gets the Sequel database
+* `:after_load` gets the Sequel database
+
+To define a hook, put something like this in your config file:
+
+    config.add_hook :before_insert_row do |db, row|
+      # modify the row in place
+    end
+    
+#### Schema
+
+The base table is named `ledger`. Here's the DDL:
+
+    create table ledger (
+        xtn_id integer,  -- line number of the first line of the transaction
+        xtn_date date,   -- date of the transaction
+        xtn_month date,  -- month pre-extracted from the date
+        xtn_year date,   -- year pre-extracted from the date
+        checknum text,   -- check number (code)
+        note text,       -- payee
+        account text,    -- account name
+        commodity text,  -- commodity
+        amount number,   -- amount
+        tags text,       -- any tags attached to the transaction
+        virtual boolean, -- if the transaction is virutal or not
+        cleared boolean  -- if the transaction is cleared or not
+    )
+
+In addition, there's a few predefined views:
+
+    create view accounts_months as
+    with
+        _a as (select account from ledger group by account),
+        _m as (select xtn_month from ledger group by xtn_month)
+    select
+        account,
+        xtn_month
+    from
+        _a cross join _m
+    ;
+    
+    create view accounts_days as
+    with
+        _a as (select account from ledger group by account),
+        _d as (select xtn_date from ledger group by xtn_date)
+    select
+        account,
+        xtn_date
+    from
+        _a cross join _d
+    ;
+    
+    create view accounts_years as
+    with
+        _a as (select account from ledger group by account),
+        _y as (select xtn_year from ledger group by xtn_year)
+    select
+        account,
+        xtn_year
+    from
+        _a cross join _y
+    ;
+    

data/Rakefile

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require "ledger_web/version"
+require 'rake'
+ 
+task :build do
+  system "gem build ledger_web.gemspec"
+end
+ 
+task :release => :build do
+  system "gem push ledger_web-#{LedgerWeb::VERSION}.gem"
+end

data/bin/ledger_web

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+begin
+  require 'ledger_web'
+rescue LoadError => e
+  path = File.expand_path '../../lib', __FILE__
+  $:.unshift(path) if File.directory?(path) && !$:.include?(path)
+  require 'ledger_web'
+end
+
+LedgerWeb::Watcher.run!
+LedgerWeb::Application.run!(:port => CONFIG.get(:port))

data/ledger_web.gemspec

@@ -0,0 +1,26 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+require 'ledger_web/version'
+
+Gem::Specification.new do |s|
+  s.name        = "ledger_web"
+  s.version     = LedgerWeb::VERSION
+  s.date        = "2011-12-31"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Pete Keen"]
+  s.email       = ["pete@bugsplat.info"]
+  s.homepage    = "https://github.com/peterkeen/ledger-web"
+  s.summary     = %q{A web-based, sql-backed front-end for the Ledger command-line accounting system}
+  s.description = %q{Allows arbitrary reporting on your ledger using easy-to-write SQL queries}
+
+  s.add_dependency("pg")
+  s.add_dependency("sequel")
+  s.add_dependency("directory_watcher")
+  s.add_dependency("sinatra")
+  s.add_dependency("sinatra-session")
+
+  s.files         = `git ls-files`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end
+

data/lib/ledger_web/app.rb

@@ -0,0 +1,69 @@
+require 'rubygems'
+require 'sinatra/base'
+require 'sinatra/session'
+
+module LedgerWeb
+  class Application < Sinatra::Base
+    register Sinatra::Session
+    set :session_secret, CONFIG.get(:session_secret)
+    set :session_expire, CONFIG.get(:session_expire)
+    set :views, CONFIG.get(:report_directories) + [File.join(File.dirname(__FILE__), 'views')]
+    set :reload_templates, true
+
+    helpers LedgerWeb::Helpers
+
+    def find_template(views, name, engine, &block)
+      Array(views).each { |v| super(v, name, engine, &block) }
+    end
+
+    before do
+      if not session?
+        session_start!
+        today = Date.today
+        session[:from] = Date.new(today.year - 1, today.month, today.day)
+        session[:to] = today
+      end
+      Report.session = session
+      Report.params = params
+
+      @reports = find_all_reports
+    end
+
+    post '/update-date-range' do
+
+      if params[:reset]
+        today = Date.today
+        session[:from] = Date.new(today.year - 1, today.month, today.day).strftime('%Y/%m/%d')
+        session[:to] = today.strftime('%Y/%m/%d')
+      else
+        session[:from] = Date.strptime(params[:from], '%Y/%m/%d').strftime('%Y/%m/%d')
+        session[:to] = Date.strptime(params[:to], '%Y/%m/%d').strftime('%Y/%m/%d')
+      end
+
+      redirect back
+    end
+
+    get '/reports/:name' do
+      begin
+        erb params[:name].to_sym
+      rescue Exception => e
+        @error = e
+        erb :error
+      end
+    end
+
+    get '/' do
+      index_report = CONFIG.get :index_report
+      if index_report
+        redirect "/reports/#{index_report.to_s}"
+      else
+        redirect '/help'
+      end
+    end
+
+    get '/help' do
+      erb :help
+    end
+  end
+
+end

data/lib/ledger_web/config.rb

@@ -0,0 +1,87 @@
+module LedgerWeb
+
+  class Config
+    attr_reader :vars, :hooks
+
+    def initialize
+      @vars = {}
+      @hooks = {}
+
+      if block_given?
+        yield self
+      end
+    end
+
+    def set(key, value)
+      @vars[key] = value
+    end
+
+    def get(key)
+      @vars[key]
+    end
+
+    def add_hook(phase, &block)
+      _add_hook(phase, block)
+    end
+
+    def _add_hook(phase, hook)
+      @hooks[phase] ||= []
+      @hooks[phase] << hook
+    end
+
+    def run_hooks(phase, data)
+      if @hooks.has_key? phase
+        @hooks[phase].each do |hook|
+          hook.call(data)
+        end
+        return data
+      end
+    end
+
+    def override_with(config)
+      config.vars.each do |key, value|
+        set key, value
+      end
+
+      config.hooks.each do |phase, hooks|
+        hooks.each do |hook|
+          _add_hook phase, hook
+        end
+      end
+    end
+
+    def self.from_file(filename)
+      File.open(filename) do |file|
+        return eval(file.read, nil, filename)
+      end
+    end
+  end
+end
+
+CONFIG = LedgerWeb::Config.new do |config|
+  config.set :database_url,       "postgres://localhost/ledger"
+  config.set :port,               "9090"
+  config.set :ledger_file,        ENV['LEDGER_FILE']
+  config.set :report_directories, ["#{File.dirname(__FILE__)}/reports"]
+  config.set :session_secret,     'SomethingSecretThisWayPassed'
+  config.set :session_expire,     60*60
+  config.set :watch_interval,     5
+  config.set :watch_stable_count, 3
+  config.set :ledger_bin_path,    "ledger"
+
+  config.set :ledger_format, "%(quoted(xact.beg_line)),%(quoted(date)),%(quoted(payee)),%(quoted(account)),%(quoted(commodity)),%(quoted(quantity(scrub(display_amount)))),%(quoted(cleared)),%(quoted(virtual)),%(quoted(join(note | xact.note)))\n"
+  
+  ledger_web_dir = "#{ENV['HOME']}/.ledger_web"
+
+  if File.directory? ledger_web_dir
+    if File.directory? "#{ledger_web_dir}/reports"
+      dirs = config.get(:report_directories)
+      dirs.unshift "#{ledger_web_dir}/reports"
+      config.set :report_directories, dirs
+    end
+    
+    if File.exists? "#{ledger_web_dir}/config.rb"
+      config.override_with(LedgerWeb::Config.from_file("#{ledger_web_dir}/config.rb"))
+    end
+  end
+end

data/lib/ledger_web/db/migrate/20111226180900_initial_schema.rb

@@ -0,0 +1,38 @@
+Sequel.migration do
+  up do
+    create_table(:ledger, :ignore_index_errors=>true) do
+      Date :xtn_date
+      String :checknum, :text=>true
+      String :note, :text=>true
+      String :account, :text=>true
+      String :commodity, :text=>true
+      BigDecimal :amount
+      String :tags, :text=>true
+      Date :xtn_month
+      Date :xtn_year
+      TrueClass :virtual
+      Integer :xtn_id
+      TrueClass :cleared
+      
+      index [:account]
+      index [:commodity]
+      index [:note]
+      index [:tags]
+      index [:virtual]
+      index [:xtn_date]
+      index [:xtn_month]
+      index [:xtn_year]
+    end
+    
+    create_table(:schema_info) do
+      String :filename, :text=>true, :null=>false
+      
+      primary_key [:filename]
+    end
+  end
+  
+  down do
+    drop_table(:ledger, :schema_info)
+  end
+end
+    

data/lib/ledger_web/db/migrate/20111231132900_add_views.rb

@@ -0,0 +1,37 @@
+Sequel.migration do
+  change do
+    create_or_replace_view(:accounts_days, <<HERE)
+    with
+        _a as (select account from ledger group by account),
+        _d as (select xtn_date from ledger group by xtn_date)
+    select
+        account,
+        xtn_date
+    from
+        _a cross join _d
+HERE
+
+    create_or_replace_view(:accounts_months, <<HERE)
+    with
+        _a as (select account from ledger group by account),
+        _m as (select xtn_month from ledger group by xtn_month)
+    select
+        account,
+        xtn_month
+    from
+        _a cross join _m
+HERE
+
+    create_or_replace_view(:accounts_years, <<HERE)
+    with
+        _a as (select account from ledger group by account),
+        _y as (select xtn_year from ledger group by xtn_year)
+    select
+        account,
+        xtn_year
+    from
+        _a cross join _y
+HERE
+
+  end
+end

data/lib/ledger_web/db.rb

@@ -0,0 +1,54 @@
+require 'sequel'
+require 'sequel/extensions/migration'
+require 'csv'
+
+DB = Sequel.connect(CONFIG.get(:database_url))
+
+Sequel::Migrator.apply(DB, File.join(File.dirname(__FILE__), "db/migrate"))
+
+home_migrations = File.join(ENV['HOME'], '.ledger_web', 'migrate')
+if File.directory?(home_migrations)
+  Sequel::Migrator.run(DB, home_migrations, :table => "user_schema_changes")
+end
+
+def load_database
+  ledger_format = CONFIG.get :ledger_format
+  ledger_bin_path = CONFIG.get :ledger_bin_path
+  ledger_file = CONFIG.get :ledger_file
+
+  # dump ledger to tempfile
+  print "    dumping ledger to file...."
+  file = Tempfile.new('ledger')
+  system "#{ledger_bin_path} -f #{ledger_file} --format='#{ledger_format}' reg > #{file.path}"
+  puts "done"
+  counter = 0
+  DB.transaction do
+
+    CONFIG.run_hooks(:before_load, DB)
+
+    print "    clearing ledger table...."
+    DB["DELETE FROM ledger"].delete
+    puts "done"
+
+    print "    loading into database...."
+    CSV.foreach(file.path) do |row|
+      counter += 1
+      row = Hash[*[:xtn_id, :xtn_date, :note, :account, :commodity, :amount, :cleared, :virtual, :tags].zip(row).flatten]
+
+      xtn_date = Date.strptime(row[:xtn_date], '%Y/%m/%d')
+
+      row[:xtn_month] = xtn_date.strftime('%Y/%m/01')
+      row[:xtn_year]  = xtn_date.strftime('%Y/01/01')
+
+      row = CONFIG.run_hooks(:before_insert_row, row)
+      DB[:ledger].insert(row)
+      CONFIG.run_hooks(:after_insert_row, row)
+    end
+
+    CONFIG.run_hooks(:after_load, DB)
+  end
+  print "    analyzing ledger table"
+  DB.fetch('VACUUM ANALYZE ledger')
+  puts "done"
+  counter
+end

data/lib/ledger_web/helpers.rb

@@ -0,0 +1,62 @@
+module LedgerWeb
+  module Helpers
+    def partial (template, locals = {})
+      erb(template, :layout => false, :locals => locals)
+    end
+  
+    def table(report, options = {})
+      links = options[:links] || {}
+      partial(:table, :report => report, :links => links)
+    end
+  
+    def query(options={}, &block)
+      q = erb_with_output_buffer block
+      report = LedgerWeb::Report.from_query(q)
+      if options[:pivot]
+        report = report.pivot(options[:pivot], options[:pivot_sort_order])
+      end
+      return report
+    end
+  
+    def erb_with_output_buffer(buf = '', block)
+      @_out_buf, old_buffer = buf, @_out_buf
+      block.call
+      @_out_buf
+    ensure
+      @_out_buf = old_buffer
+    end
+  
+    def expect(expected)
+      not_present = []
+      expected.each do |key|
+        if not params.has_key? key
+          not_present << key
+        end
+      end
+  
+      if not_present.length > 0
+        raise "Missing params: #{not_present.join(', ')}"
+      end
+    end
+  
+    def linkify(links, row, value, display_value)
+      links.each do |key, val|
+        if key.is_a? String
+          key = /^#{key}$/
+        end
+  
+        if key.match(value[1].title.to_s)
+          url = String.new(links[key])
+          row.each_with_index do |v,i|
+            url.gsub!(":#{i}", v[0].to_s)
+          end
+  
+          url.gsub!(':title', value[1].title.to_s)
+          display_value = "<a href='#{url}'>#{display_value}</a>"
+        end
+      end
+      display_value
+    end
+  end
+end
+

data/lib/ledger_web/public/bootstrap-dropdown.js

@@ -0,0 +1,55 @@
+/* ============================================================
+ * bootstrap-dropdown.js v1.4.0
+ * http://twitter.github.com/bootstrap/javascript.html#dropdown
+ * ============================================================
+ * Copyright 2011 Twitter, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============================================================ */
+
+
+!function( $ ){
+
+  "use strict"
+
+  /* DROPDOWN PLUGIN DEFINITION
+   * ========================== */
+
+  $.fn.dropdown = function ( selector ) {
+    return this.each(function () {
+      $(this).delegate(selector || d, 'click', function (e) {
+        var li = $(this).parent('li')
+          , isActive = li.hasClass('open')
+
+        clearMenus()
+        !isActive && li.toggleClass('open')
+        return false
+      })
+    })
+  }
+
+  /* APPLY TO STANDARD DROPDOWN ELEMENTS
+   * =================================== */
+
+  var d = 'a.menu, .dropdown-toggle'
+
+  function clearMenus() {
+    $(d).parent('li').removeClass('open')
+  }
+
+  $(function () {
+    $('html').bind("click", clearMenus)
+    $('body').dropdown( '[data-dropdown] a.menu, [data-dropdown] .dropdown-toggle' )
+  })
+
+}( window.jQuery || window.ender );