financial 0.0.1

data/features/support/env.rb

@@ -0,0 +1 @@
+require 'aruba/cucumber'

data/financial.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "financial/version"
+
+Gem::Specification.new do |s|
+  s.name        = "financial"
+  s.version     = Financial::VERSION
+  s.authors     = ["Tomas D'Stefano"]
+  s.email       = ["tomas_stefano@successoft.com"]
+  s.homepage    = "https://github.com/tomas-stefano/financial"
+  s.summary     = %q{Manage your money in the terminal with A Ruby DSL}
+  s.description = %q{Manage your money in the terminal with A Ruby DSL}
+
+  s.rubyforge_project = "financial"
+
+  s.add_dependency(%q<terminal-table>, ["= 1.4.2"])
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/financial.rb

@@ -0,0 +1,39 @@
+require "financial/version"
+require 'date'
+require 'forwardable'
+require 'terminal-table'
+require 'yaml'
+
+module Financial
+  autoload 'Account', 'financial/account'
+  autoload 'AccountManager', 'financial/account_manager'
+  autoload 'Balance', 'financial/balance'
+  autoload 'BalanceCalculation', 'financial/balance_calculation'
+  autoload 'Cost', 'financial/cost'
+  autoload 'Costs', 'financial/costs'
+  autoload 'Deposit', 'financial/deposit'
+  autoload 'Deposits', 'financial/deposits'
+  autoload 'DSL', 'financial/dsl'
+  autoload 'FinancialDate', 'financial/financial_date'
+  autoload 'Locale', 'financial/locale'
+  autoload 'Parcels', 'financial/parcels'
+  autoload 'PerCent', 'financial/per_cent'
+  autoload 'PrintTable', 'financial/print_table'
+  autoload 'Revenue', 'financial/revenue'
+  autoload 'Revenues', 'financial/revenues'
+  autoload 'RSpecMatchers', 'financial/rspec_matchers'
+  autoload 'FinancialTable', 'financial/financial_table'
+  autoload 'Tax', 'financial/tax'
+
+  def self.locale=(locale_name)
+    @locale = Locale.new(locale_name)
+  end
+
+  def self.locale
+    @locale || Locale.new(:en)
+  end
+
+  def self.account_manager
+    AccountManager.instance
+  end
+end

data/lib/financial/account.rb

@@ -0,0 +1,129 @@
+module Financial
+  class Account
+    attr_accessor :name, :banner
+
+    def initialize(*arguments)
+      arguments.flatten!
+      options = arguments.last.is_a?(Hash) ? arguments.pop : {}
+      @name = arguments.shift
+      raise RuntimeError, "Pass a name to account" unless @name
+      @banner = options[:as] || @name.to_s.split('_').join(' ').capitalize
+      @costs = Costs.new
+      @revenues = Revenues.new
+      @deposits = Deposits.new(@name)
+      @balances = []
+      @total = 0
+    end
+
+    def total(value=nil)
+      return @total unless value
+      @total = value
+    end
+
+    def deposits(&block)
+      @deposits.instance_eval(&block) if block_given?
+      @deposits
+    end
+
+    def costs(&block)
+      @costs.instance_eval(&block) if block_given?
+      @costs.replace_parcels_with_costs!
+      @costs
+    end
+
+    def revenues(&block)
+      @revenues.instance_eval(&block) if block_given?
+      @revenues
+    end
+
+    def taxes
+      revenues.collect { |revenue| revenue.tax }.compact
+    end
+
+    def calculate_balances
+      @balances = BalanceCalculation.new(self).calculate!
+    end
+    alias :balances :calculate_balances
+
+    def all_costs
+      [costs, deposits, taxes].flatten.sort_by { |event| event.date }
+    end
+
+    def all_revenues
+      [revenues, received_deposits].flatten
+    end
+
+    def unique_events_dates
+      events.collect { |event| event.date }.uniq.sort
+    end
+
+    def events
+      [all_costs, all_revenues].flatten
+    end
+
+    def events_in_date(date)
+      events.select {|event| event.date == date }
+    end
+
+    def costs_in_date(date)
+      all_costs.select { |cost| cost.date == date }
+    end
+
+    def revenues_in_date(date)
+      all_revenues.select { |revenue| revenue.date == date }
+    end
+
+    def total_costs
+      calculate(:all_costs)
+    end
+
+    def total_revenues
+      calculate(:all_revenues)
+    end
+
+    def calculate(method_name)
+      objects_instances = self.send(method_name)
+      costs_or_revenues_sum = if objects_instances.empty?
+        0
+      else
+        objects_instances.collect { |object_instance| object_instance.value }.inject(:+)
+      end
+      self.instance_variable_set("@#{method_name.to_s.gsub('all', 'total')}", costs_or_revenues_sum)
+    end
+
+    # FIXME: Fix a bug that dups all received_deposits
+    #
+    def received_deposits
+      account_manager.accounts.collect { |account| account.deposits}.flatten.select do |deposit|
+        deposit.account_to_deposit.equal?(@name)
+      end
+    end
+
+    def ==(other_account)
+      name == other_account.name
+    end
+
+    # OPTIMIZE ME: if this have hundreds balances will slow things down :\
+    #
+    def last_balance_in_date(date)
+      all_balances_for_date = balances.select { |balance| balance.date <= date }
+      if all_balances_for_date.empty?
+        total
+      else
+        all_balances_for_date.last.value
+      end
+    end
+
+    def find_balance_in_date(date)
+      balances.find { |balance| balance.date == date }
+    end
+
+    def self.find(options)
+      Financial.account_manager.accounts.find { |account| account.name == options[:name].to_sym}
+    end
+
+    def account_manager
+      Financial.account_manager
+    end
+  end
+end

data/lib/financial/account_manager.rb

@@ -0,0 +1,26 @@
+require 'singleton'
+
+module Financial
+  class AccountManager
+    include Singleton
+    attr_accessor :accounts
+
+    def initialize
+      @accounts = []
+    end
+
+    def new_account(args)
+      account = Account.new(args)
+      @accounts.push(account)
+      account
+    end
+
+    def find_account(account_name)
+      if account_name == :all or account_name == :todas
+        @accounts
+      else
+        @accounts.select { |a_account| a_account.name.equal?(account_name) }
+      end
+    end
+  end
+end

data/lib/financial/balance.rb

@@ -0,0 +1,11 @@
+module Financial
+  class Balance
+    attr_accessor :value, :date, :name
+
+    def initialize(balance_value, balance_date)
+      @name = Financial.locale.balance_name
+      @value = balance_value
+      @date = balance_date.is_a?(Date) ? balance_date : Financial::FinancialDate.new(balance_date).date
+    end
+  end
+end

data/lib/financial/balance_calculation.rb

@@ -0,0 +1,35 @@
+module Financial
+  class BalanceCalculation
+    attr_accessor :balances, :account, :revenues, :costs, :unique_events_dates
+
+    def initialize(account_instance)
+      @balances = []
+      @account = account_instance
+      @costs = @account.all_costs
+      @revenues = @account.revenues
+      @unique_events_dates = account.unique_events_dates
+      @total = account.total
+    end
+
+    def calculate!
+      unique_events_dates.collect do |date|
+        @date = date
+        @total -= calculate_costs
+        @total += calculate_revenues
+        Balance.new(@total, date)
+      end
+    end
+
+    def calculate_costs
+      costs_in_date = account.costs_in_date(@date)
+      return 0 if costs_in_date.empty?
+      costs_in_date.collect { |cost| cost.value }.inject(:+)
+    end
+
+    def calculate_revenues
+      revenues_in_date = account.revenues_in_date(@date)
+      return 0 if revenues_in_date.empty?
+      revenues_in_date.collect {|event| event.value }.inject(:+)
+    end
+  end
+end

data/lib/financial/cost.rb

@@ -0,0 +1,34 @@
+module Financial
+  class Cost
+    attr_accessor :name, :method_name, :value, :date
+
+    def initialize(cost_name, *arguments)
+      arguments.flatten!
+      @name = cost_name.to_s.split('_').join(' ').capitalize
+      @method_name = cost_name
+      @value = arguments.shift
+      @date = Date.today
+    end
+
+    def in_date(user_date=nil)
+      @date = Financial::FinancialDate.new(user_date).date
+      self
+    end
+
+    def format_value
+      "- #{Financial.locale.format_coin(value)}"
+    end
+
+    def +(cost)
+      self.value + cost.value
+    end
+
+    def is_a_received_deposit?(account)
+      false
+    end
+
+    def ==(cost)
+      self.value == cost.value and self.method_name == cost.method_name
+    end
+  end
+end

data/lib/financial/costs.rb

@@ -0,0 +1,30 @@
+module Financial
+  class Costs < Array
+    def parcels(number)
+      parcels = Parcels.new(number)
+      self.push(parcels)
+      parcels
+    end
+
+    def replace_parcels_with_costs!
+      costs = self.select { |cost| cost.is_a?(Parcels) }.collect do |parcels|
+        self.delete(parcels)
+        parcels.to_cost
+      end
+      costs.flatten.each { |cost| self.push(cost) }
+    end
+
+    def method_missing(meth, *args, &blk)
+      unless args.empty?
+        cost = Cost.new(meth, args)
+        self.push(cost)
+        cost
+      else
+        raise CostWithoutValue, "Cost: #{meth} don't have a value. Pass a value!"
+      end
+    end
+  end
+
+  class CostWithoutValue < StandardError
+  end
+end

data/lib/financial/deposit.rb

@@ -0,0 +1,30 @@
+module Financial
+  class Deposit < Cost
+    attr_accessor :name, :value
+    attr_reader :account_to_deposit, :account_name
+
+    def initialize(value, _account_name)
+      @value = value
+      @date = Date.today
+      @account_to_deposit = :anonymous
+      @account_name = _account_name
+      deposit_name!
+    end
+
+    def in_account(account_name)
+      @account_to_deposit = account_name
+      deposit_name!
+      self
+    end
+
+    def deposit_name!
+      @name = "#{Financial.locale.deposit_name}: #{@account_to_deposit}"
+    end
+
+    # Return true if is a received deposit
+    #
+    def is_a_received_deposit?(account)
+      (not account.deposits.include?(self)) and (account.name.equal?(account_to_deposit))
+    end
+  end
+end

data/lib/financial/deposits.rb

@@ -0,0 +1,15 @@
+module Financial
+  class Deposits < Array
+    attr_reader :account_name
+    def initialize(account_name)
+      @account_name = account_name
+      super()
+    end
+
+    def deposit(value)
+      deposit = Deposit.new(value, @account_name)
+      self.push(deposit)
+      deposit
+    end
+  end
+end

data/lib/financial/dsl.rb

@@ -0,0 +1,16 @@
+module Financial
+  module DSL
+    def account(*args, &block)
+      account = Financial.account_manager.new_account(args)
+      account.instance_eval(&block)
+      account
+    end
+
+    def print_account(name, &block)
+      print_table = PrintTable.new(name)
+      print_table.instance_eval(&block)
+      print_table.print!
+      print_table
+    end
+  end
+end

data/lib/financial/financial_date.rb

@@ -0,0 +1,18 @@
+module Financial
+  class FinancialDate
+    attr_reader :date, :day, :month, :year
+
+    extend ::Forwardable
+    def_delegator :@date, :day, :day
+    def_delegator :@date, :month, :month
+    def_delegator :@date, :year, :year
+
+    def initialize(string_date)
+      if string_date
+        @date = Date.strptime(string_date, Financial.locale.date_format)
+      else
+        @date = Date.today
+      end
+    end
+  end
+end

data/lib/financial/financial_table.rb

@@ -0,0 +1,109 @@
+module Financial
+  class FinancialTable
+    include Terminal::Table::TableHelper
+    attr_reader :header, :account, :print_table, :locale
+
+    extend Forwardable
+
+    def_delegator :@print_table, :initial_date, :initial_date
+    def_delegator :@print_table, :final_date, :final_date
+    def_delegator :@account, :total, :total
+    def_delegator :@account, :events_in_date, :events_in_date
+    def_delegator :@account, :find_balance_in_date, :find_balance_in_date
+    def_delegator :@locale, :table_headings, :headings
+    def_delegator :@locale, :date_to_s, :date_to_s
+    def_delegator :@locale, :to_coin, :to_coin
+
+    def initialize(account_instance, print_table_instance)
+      @account = account_instance
+      @print_table = print_table_instance
+      @locale = Financial.locale
+      @header = @locale.header_for(@account, @print_table.initial_date, @print_table.final_date)
+    end
+
+    def positive?
+      @positive
+    end
+
+    def to_s
+      financial_table = self
+      @financial_table = table do
+        self.headings = financial_table.headings
+        add_row(financial_table.initial_balance)
+        add_separator
+        financial_table.add_rows(self)
+        add_separator
+        add_row(financial_table.final_balance)
+      end
+    end
+
+    def add_rows(terminal_table)
+      initial_date.upto(final_date).each do |date|
+        add_rows_in_date(date, :using => terminal_table)
+      end
+    end
+
+    def add_rows_in_date(date, options)
+      @date = date
+      @terminal_table = options[:using]
+      @events = events_in_date(date)
+      unless @events.empty?
+        add_events_to_table
+        @terminal_table.add_separator
+        add_balance_to_table
+      end
+    end
+
+    def add_events_to_table
+      @events.each_with_index do |event, index|
+        @event = event
+        @index = index
+        @terminal_table.add_row [row_date, row_name, row_value, '']
+      end
+    end
+
+    def add_balance_to_table
+      balance = find_balance_in_date(@date)
+      @terminal_table.add_row ['', balance.name, hifen, locale.format_coin(balance.value)]
+      @terminal_table.add_separator
+    end
+
+    def initial_balance
+      [date_to_s(initial_date), locale.initial_balance, hifen, to_coin(total)]
+    end
+
+    def final_balance
+      [date_to_s(final_date), locale.final_balance, hifen, to_coin(account.last_balance_in_date(final_date))]
+    end
+
+    def hifen
+      '--------'
+    end
+
+    def row_date
+      if @index == 0
+        date_to_s(@event.date)
+      else
+        '' # dont pass nothing if is the same date
+      end
+    end
+
+    def row_name
+      received_deposit.first
+    end
+
+    def row_value
+      received_deposit.last
+    end
+
+    def received_deposit
+      name = @event.name
+      value = @event.format_value
+      if @event.is_a_received_deposit?(@account)
+        name = "#{locale.received_deposit_name}: #{@event.account_name}"
+        value = value.gsub('-', '+')
+      end
+      [name, value]
+    end
+  end
+end