Class: FinModeling::NetIncomeCalculation

Inherits:
CompanyFilingCalculation show all
Includes:
CanCacheClassifications, CanCacheSummaries, CanClassifyRows
Defined in:
lib/finmodeling/net_income_calculation.rb

Constant Summary collapse

BASE_FILENAME = 
File.join(FinModeling::BASE_PATH, "summaries/net_income_")
ALL_STATES = 
[ :or, :cogs, :oe, :oibt, :fibt, :tax, :ooiat, :ooiat_nci, :fiat ]
NEXT_STATES = 
{ nil        => [ :or                                                            ],
:or        => [ :or, :cogs, :oe, :oibt, :fibt                                  ],
:cogs      => [      :cogs, :oe, :oibt, :fibt, :tax                            ],
:oe        => [             :oe, :oibt, :fibt, :tax                            ],
:oibt      => [                  :oibt, :fibt, :tax                            ], # obit/fibt can cycle back/forth
:fibt      => [                  :obit, :fibt, :tax                            ], # obit/fibt can cycle back/forth
:tax       => [                                      :ooiat, :ooiat_nci, :fiat ], # tax can't go to itself. only 1 such item.
:ooiat     => [                                      :ooiat, :ooiat_nci, :fiat ], # other operating income after taxes
:ooiat_nci => [                                      :ooiat, :ooiat_nci, :fiat ], # ooiat related to non-controlling interest
:fiat      => [                                      :ooiat, :ooiat_nci, :fiat ] }

Instance Attribute Summary

Attributes inherited from CompanyFilingCalculation

#calculation

Instance Method Summary collapse

Methods inherited from CompanyFilingCalculation

#initialize, #label, #leaf_items, #leaf_items_sum, #periods, #write_constructor

Constructor Details

This class inherits a constructor from FinModeling::CompanyFilingCalculation

Instance Method Details

#has_revenue_item? ⇒ Boolean

Returns:

  • (Boolean) 


41
42
43
44
45
 
# File 'lib/finmodeling/net_income_calculation.rb', line 41

def has_revenue_item?
  @has_revenue_item ||= leaf_items.any? do |leaf|
    leaf.name.matches_any_regex?([/revenue/i, /sales/i])
  end
end

#has_tax_item? ⇒ Boolean

Returns:

  • (Boolean) 


47
48
49
50
51
 
# File 'lib/finmodeling/net_income_calculation.rb', line 47

def has_tax_item?
  @has_tax_item ||= leaf_items.any? do |leaf|
    leaf.name.matches_any_regex?([/tax/i])
  end
end

#summary(args) ⇒ Object 



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/finmodeling/net_income_calculation.rb', line 21

def summary(args)
  summary_cache_key = args[:period].to_pretty_s
  thesummary = lookup_cached_summary(summary_cache_key)
  return thesummary if !thesummary.nil?
 
  mapping = Xbrlware::ValueMapping.new
  mapping.policy[:debit] = :flip

  thesummary = super(:period => args[:period], :mapping => mapping) # FIXME: flip_total should == true!
  if !lookup_cached_classifications(BASE_FILENAME, thesummary.rows)
    lookahead = [4, thesummary.rows.length-1].min
    classify_rows(ALL_STATES, NEXT_STATES, thesummary.rows, FinModeling::IncomeStatementItem, lookahead)
    save_cached_classifications(BASE_FILENAME, thesummary.rows)
  end

  save_cached_summary(summary_cache_key, thesummary)

  return thesummary
end