finmodeling 0.1 → 0.2

data/lib/finmodeling/float_helpers.rb

@@ -1,17 +1,23 @@
 class Fixnum
-  def to_nearest_million
-    return (self/1000000.0).round.to_f
+  def to_nearest_million(num_decimals=1)
+    return (self/1000000.0*(10.0**num_decimals)).round.to_f/(10.0**num_decimals)
   end
-  def to_nearest_thousand
-    return (self/1000.0).round.to_f
+  def to_nearest_thousand(num_decimals=1)
+    return (self/1000.0*(10.0**num_decimals)).round.to_f/(10.0**num_decimals)
+  end
+  def to_nearest_dollar(num_decimals=1)
+    return ((self*(10.0**num_decimals)).round/(10.0**num_decimals)).to_f
   end
 end
 
 class Float
-  def to_nearest_million
-    return (self/1000000.0).round.to_f
+  def to_nearest_million(num_decimals=1)
+    return (self/1000000.0*(10.0**num_decimals)).round.to_f/(10.0**num_decimals)
+  end
+  def to_nearest_thousand(num_decimals=1)
+    return (self/1000.0*(10.0**num_decimals)).round.to_f/(10.0**num_decimals)
   end
-  def to_nearest_thousand
-    return (self/1000.0).round.to_f
+  def to_nearest_dollar(num_decimals=1)
+    return ((self*(10.0**num_decimals)).round/(10.0**num_decimals)).to_f
   end
 end

data/lib/finmodeling/forecasted_reformulated_balance_sheet.rb

@@ -0,0 +1,55 @@
+module FinModeling
+  class ForecastedReformulatedBalanceSheet < ReformulatedBalanceSheet
+    def initialize(period, noa, nfa, cse)
+      @period = period
+      @noa = noa
+      @nfa = nfa
+      @cse = cse
+
+      @minority_interest = FinModeling::CalculationSummary.new
+    end
+
+    def operating_assets
+      nil
+    end
+
+    def financial_assets
+      nil
+    end
+
+    def operating_liabilities
+      nil
+    end
+
+    def financial_liabilities
+      nil
+    end
+
+    def net_operating_assets
+      cs = FinModeling::CalculationSummary.new
+      cs.title = "Net Operational Assets"
+      cs.rows = [ CalculationRow.new( :key => "NOA", :vals => [@noa] ) ]
+      return cs
+    end
+
+    def net_financial_assets
+      cs = FinModeling::CalculationSummary.new
+      cs.title = "Net Financial Assets"
+      cs.rows = [ CalculationRow.new( :key => "NFA", :vals => [@nfa] ) ]
+      return cs
+    end
+
+    def common_shareholders_equity
+      cs = FinModeling::CalculationSummary.new
+      cs.title = "Common Shareholders' Equity"
+      cs.rows = [ CalculationRow.new( :key => "CSE", :vals => [@cse] ) ]
+      return cs
+    end
+ 
+    def analysis(prev)
+      analysis = super(prev)
+      analysis.header_row.vals[0] += "E" # for estimated
+      return analysis
+    end
+  end
+end

data/lib/finmodeling/forecasted_reformulated_income_statement.rb

@@ -0,0 +1,110 @@
+module FinModeling
+  class ForecastedReformulatedIncomeStatement < ReformulatedIncomeStatement
+    def initialize(period, operating_revenues, income_from_sales_after_tax, net_financing_income, comprehensive_income)
+      @period = period
+      @orev = operating_revenues
+      @income_from_sales_after_tax = income_from_sales_after_tax
+      @net_financing_income = net_financing_income
+      @comprehensive_income = comprehensive_income
+    end
+
+    def -(ris2)
+      raise RuntimeError.new("not implmeneted")
+    end
+
+    def operating_revenues
+      cs = FinModeling::CalculationSummary.new
+      cs.title = "Operating Revenues"
+      cs.rows = [ CalculationRow.new(:key => "Operating Revenues (OR)", :vals => [@orev] ) ]
+      return cs
+    end
+
+    def cost_of_revenues
+      nil
+    end
+
+    def gross_revenue
+      nil
+    end
+
+    def operating_expenses
+      nil
+    end
+
+    def income_from_sales_before_tax
+      nil
+    end
+
+    def income_from_sales_after_tax
+      cs = FinModeling::CalculationSummary.new
+      cs.title = "Operating Income from sales, after tax (OISAT)"
+      cs.rows = [ CalculationRow.new(:key => "Operating income from sales (after tax)", :vals => [@income_from_sales_after_tax] ) ]
+      return cs
+    end
+
+    def operating_income_after_tax
+      income_from_sales_after_tax # this simplified version assumes no non-sales operating income
+    end
+
+    def net_financing_income
+      cs = FinModeling::CalculationSummary.new
+      cs.title = "Net financing income, after tax (NFI)"
+      cs.rows = [ CalculationRow.new(:key => "Net financing income", :vals => [@net_financing_income] ) ]
+      return cs
+    end
+
+    def comprehensive_income
+      cs = FinModeling::CalculationSummary.new
+      cs.title = "Comprehensive Income (CI)"
+      cs.rows = [ CalculationRow.new(:key => "Comprehensive income", :vals => [@comprehensive_income] ) ]
+      return cs
+    end
+
+    def analysis(re_bs, prev_re_is, prev_re_bs, expected_cost_of_capital)
+      analysis = CalculationSummary.new
+      analysis.title = ""
+      analysis.rows = []
+  
+      if re_bs.nil?
+        analysis.header_row = CalculationHeader.new(:key => "",   :vals => ["Unknown..."])
+      else
+        analysis.header_row = CalculationHeader.new(:key => "",   :vals => [re_bs.period.to_pretty_s + "E"])
+      end
+  
+      analysis.rows << CalculationRow.new(:key => "Revenue ($MM)",   :vals => [operating_revenues.total.to_nearest_million])
+      if Config.income_detail_enabled?
+        analysis.rows << CalculationRow.new(:key => "COGS ($MM)",    :vals => [nil])
+        analysis.rows << CalculationRow.new(:key => "GM ($MM)",      :vals => [nil])
+        analysis.rows << CalculationRow.new(:key => "OE ($MM)",      :vals => [nil])
+        analysis.rows << CalculationRow.new(:key => "OISBT ($MM)",   :vals => [nil])
+      end
+      analysis.rows << CalculationRow.new(:key => "Core OI ($MM)",   :vals => [income_from_sales_after_tax.total.to_nearest_million])
+      analysis.rows << CalculationRow.new(:key => "OI ($MM)",        :vals => [nil])
+      analysis.rows << CalculationRow.new(:key => "FI ($MM)",        :vals => [net_financing_income.total.to_nearest_million])
+      analysis.rows << CalculationRow.new(:key => "NI ($MM)",        :vals => [comprehensive_income.total.to_nearest_million])
+      analysis.rows << CalculationRow.new(:key => "Gross Margin",    :vals => [nil])
+      analysis.rows << CalculationRow.new(:key => "Sales PM",        :vals => [sales_profit_margin])
+      analysis.rows << CalculationRow.new(:key => "Operating PM",    :vals => [nil])
+      analysis.rows << CalculationRow.new(:key => "FI / Sales",      :vals => [fi_over_sales])
+      analysis.rows << CalculationRow.new(:key => "NI / Sales",      :vals => [ni_over_sales])
+
+      if !prev_re_bs.nil? && !prev_re_is.nil?
+        analysis.rows << CalculationRow.new(:key => "Sales / NOA",   :vals => [sales_over_noa(prev_re_bs)])
+        analysis.rows << CalculationRow.new(:key => "FI / NFA",      :vals => [fi_over_nfa(   prev_re_bs)])
+        analysis.rows << CalculationRow.new(:key => "Revenue Growth",:vals => [revenue_growth(prev_re_is)])
+        analysis.rows << CalculationRow.new(:key => "Core OI Growth",:vals => [core_oi_growth(prev_re_is)])
+        analysis.rows << CalculationRow.new(:key => "OI Growth",     :vals => [nil])
+        analysis.rows << CalculationRow.new(:key => "ReOI ($MM)",    :vals => [re_oi(prev_re_bs, expected_cost_of_capital).to_nearest_million])
+      else
+        analysis.rows << CalculationRow.new(:key => "Sales / NOA",   :vals => [nil])
+        analysis.rows << CalculationRow.new(:key => "FI / NFA",      :vals => [nil])
+        analysis.rows << CalculationRow.new(:key => "Revenue Growth",:vals => [nil])
+        analysis.rows << CalculationRow.new(:key => "Core OI Growth",:vals => [nil])
+        analysis.rows << CalculationRow.new(:key => "OI Growth",     :vals => [nil])
+        analysis.rows << CalculationRow.new(:key => "ReOI ($MM)",    :vals => [nil])
+      end
+  
+      return analysis
+    end
+  end
+end

data/lib/finmodeling/forecasts.rb

@@ -23,16 +23,16 @@ module FinModeling
       return @balance_sheet_analyses
     end
   
-    def income_statement_analyses(filings)
+    def income_statement_analyses(filings, expected_rate_of_return)
       if !@income_statement_analyses
         prev_filing = filings.last
         prev_re_bs = prev_filing.balance_sheet.reformulated(prev_filing.balance_sheet.periods.last)
         prev_prev_is = (filings.length > 2) ? filings[-2].income_statement : nil
-        prev_re_is = prev_filing.income_statement.latest_quarterly_reformulated(prev_prev_is)
+        prev_re_is = prev_filing.income_statement.latest_quarterly_reformulated(prev_cis=nil, prev_prev_is, prev_prev_cis=nil)
       
         @reformulated_income_statements.zip(@reformulated_balance_sheets).each do |re_is, re_bs|
-          next_analysis = FinModeling::ReformulatedIncomeStatement.empty_analysis if !re_is
-          next_analysis = re_is.analysis(re_bs, prev_re_is, prev_re_bs)           if  re_is
+          next_analysis = FinModeling::ReformulatedIncomeStatement.empty_analysis                if !re_is
+          next_analysis = re_is.analysis(re_bs, prev_re_is, prev_re_bs, expected_rate_of_return) if  re_is
         
           @income_statement_analyses = @income_statement_analyses + next_analysis if  @income_statement_analyses
           @income_statement_analyses =                              next_analysis if !@income_statement_analyses

data/lib/finmodeling/income_statement_analyses.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module FinModeling
 
   class IncomeStatementAnalyses < CalculationSummary
@@ -11,41 +13,45 @@ module FinModeling
       @totals_row_enabled = false
     end
 
-    def print_extras
-      if operating_pm_row && operating_pm_row.valid_vals.any?
-        lr = operating_pm_row.valid_vals.linear_regression
-        puts "\t\toperating pm: "+
+    def print_regressions
+      if revenue_growth_row && revenue_growth_row.valid_vals.any?
+        lr = revenue_growth_row.valid_vals.linear_regression
+        puts "\t\trevenue growth: "+
              "a:#{lr.a.to_s.cap_decimals(4)}, "+
              "b:#{lr.b.to_s.cap_decimals(4)}, "+
-             "r:#{lr.r.to_s.cap_decimals(4)}, "+
-             "var:#{operating_pm_row.valid_vals.variance.to_s.cap_decimals(4)}"
+             "r²:#{lr.r2.to_s.cap_decimals(4)}, "+
+             "σ²:#{revenue_growth_row.valid_vals.variance.to_s.cap_decimals(4)}, " +
+             ( (lr.r2 > 0.6) ? "strong fit" : ( (lr.r2 < 0.2) ? "weak fit [**]" : "avg fit") )
       end
 
       if sales_over_noa_row && sales_over_noa_row.valid_vals.any?
         lr = sales_over_noa_row.valid_vals.linear_regression
-        puts "\t\tsales / noa: "+
+        puts "\t\tsales / noa:    "+
              "a:#{lr.a.to_s.cap_decimals(4)}, "+
              "b:#{lr.b.to_s.cap_decimals(4)}, "+
-             "r:#{lr.r.to_s.cap_decimals(4)}, "+
-             "var:#{sales_over_noa_row.valid_vals.variance.to_s.cap_decimals(4)}"
+             "r²:#{lr.r2.to_s.cap_decimals(4)}, "+
+             "σ²:#{sales_over_noa_row.valid_vals.variance.to_s.cap_decimals(4)}, " +
+             ( (lr.r2 > 0.6) ? "strong fit" : ( (lr.r2 < 0.2) ? "weak fit [**]" : "avg fit") )
       end
 
-      if revenue_growth_row && revenue_growth_row.valid_vals.any?
-        lr = revenue_growth_row.valid_vals.linear_regression
-        puts "\t\trevenue growth: "+
+      if operating_pm_row && operating_pm_row.valid_vals.any?
+        lr = operating_pm_row.valid_vals.linear_regression
+        puts "\t\toperating pm:   "+
              "a:#{lr.a.to_s.cap_decimals(4)}, "+
              "b:#{lr.b.to_s.cap_decimals(4)}, "+
-             "r:#{lr.r.to_s.cap_decimals(4)}, "+
-             "var:#{revenue_growth_row.valid_vals.variance.to_s.cap_decimals(4)}"
+             "r²:#{lr.r2.to_s.cap_decimals(4)}, "+
+             "σ²:#{operating_pm_row.valid_vals.variance.to_s.cap_decimals(4)}, " +
+             ( (lr.r2 > 0.6) ? "strong fit" : ( (lr.r2 < 0.2) ? "weak fit [**]" : "avg fit") )
       end
 
       if fi_over_nfa_row && fi_over_nfa_row.valid_vals.any?
         lr = fi_over_nfa_row.valid_vals.linear_regression
-        puts "\t\tfi / nfa: "+
+        puts "\t\tfi / nfa:       "+
              "a:#{lr.a.to_s.cap_decimals(4)}, "+
              "b:#{lr.b.to_s.cap_decimals(4)}, "+
-             "r:#{lr.r.to_s.cap_decimals(4)}, "+
-             "var:#{fi_over_nfa_row.valid_vals.variance.to_s.cap_decimals(4)}"
+             "r²:#{lr.r2.to_s.cap_decimals(4)}, "+
+             "σ²:#{fi_over_nfa_row.valid_vals.variance.to_s.cap_decimals(4)}, " +
+             ( (lr.r2 > 0.6) ? "strong fit" : ( (lr.r2 < 0.2) ? "weak fit [**]" : "avg fit") )
       end
     end
 

data/lib/finmodeling/income_statement_calculation.rb

@@ -1,66 +1,69 @@
 module FinModeling
   class IncomeStatementCalculation < CompanyFilingCalculation
+    include CanChooseSuccessivePeriods
 
+    NI_GOAL        = "net income"
+    NI_LABELS      = [ /^(|consolidated )net (|income loss|loss income|income|loss|)(| net of tax)(| attributable to parent)/,
+                       /^profit loss$/, # I have a feeling this is from the misguided attempt to parse CI here. Get rid of it...
+                       /^allocation.*of.*undistributed.*earnings/ ]
+    NI_ANTI_LABELS = [ ]
+    NI_IDS         = [ /^(|Locator_|loc_)(|us-gaap_)NetIncomeLoss[_0-9a-z]+/,
+                       /^(|Locator_|loc_)(|us-gaap_)NetIncomeLossAvailableToCommonStockholdersBasic[_0-9a-z]+/,
+                       /^(|Locator_|loc_)(|us-gaap_)ProfitLoss[_0-9a-z]+/ ]
     def net_income_calculation
-      if @ni.nil?
-        friendly_goal = "net income"
-        label_regexes = [ /^net (income|loss|loss income)/,
-                          /^profit loss$/,
-                          /^allocation.*of.*undistributed.*earnings/ ]
-        id_regexes    = [ /^(|Locator_|loc_)(|us-gaap_)NetIncomeLoss[_0-9a-z]+/,
-                          /^(|Locator_|loc_)(|us-gaap_)NetIncomeLossAvailableToCommonStockholdersBasic[_0-9a-z]+/,
-                          /^(|Locator_|loc_)(|us-gaap_)ProfitLoss[_0-9a-z]+/ ]
-        calc = find_and_verify_calculation_arc(friendly_goal, label_regexes, id_regexes)
-        @ni = NetIncomeCalculation.new(calc)
+      begin
+        @ni ||= NetIncomeCalculation.new(find_calculation_arc(NI_GOAL, NI_LABELS, NI_ANTI_LABELS, NI_IDS))
+      rescue FinModeling::InvalidFilingError => e
+        pre_msg = "calculation tree:\n" + self.calculation.sprint_tree
+        raise e, pre_msg+e.message, e.backtrace
       end
-      return @ni
     end
 
     def is_valid?
-      has_revenue_item = false
-      has_tax_item     = false
-      net_income_calculation.leaf_items.each do |leaf|
-        if !has_revenue_item and leaf.name.downcase.matches_regexes?([/revenue/, /sales/])
-          has_revenue_item = true
-        end
-        if !has_tax_item and leaf.name.downcase.matches_regexes?([/tax/])
-          has_tax_item     = true
+      puts "income statement's net income calculation lacks tax item"           if !net_income_calculation.has_tax_item?
+      puts "income statement's net income calculation lacks sales/revenue item" if !net_income_calculation.has_revenue_item?
+      if !net_income_calculation.has_tax_item? || !net_income_calculation.has_revenue_item?
+        if net_income_calculation
+          puts "summary:"
+          net_income_calculation.summary(:period => periods.last).print
         end
+        puts "calculation tree:\n" + self.calculation.sprint_tree(indent_count=0, simplified=true)
       end
-
-      puts "income statement's net income calculation lacks tax item" if !has_tax_item 
-      puts "income statement's net income calculation lacks sales/revenue item" if !has_revenue_item 
-      return (has_revenue_item and has_tax_item)
+      return (net_income_calculation.has_revenue_item? && net_income_calculation.has_tax_item?)
     end
 
-    def reformulated(period)
+    def reformulated(period, comprehensive_income_calculation)
       return ReformulatedIncomeStatement.new(period, 
-                                             net_income_calculation.summary(:period=>period))
+                                             net_income_calculation.summary(:period=>period),
+                                             comprehensive_income_calculation ? comprehensive_income_calculation.summary(:period=>period) : nil)
     end
 
-    def latest_quarterly_reformulated(prev_income_statement)
-      if (net_income_calculation.periods.quarterly.any?) &&
-         (reformulated(net_income_calculation.periods.quarterly.last).operating_revenues.total.abs > 1.0) && # FIXME: make an is_valid here?
-         (reformulated(net_income_calculation.periods.quarterly.last).cost_of_revenues.total.abs > 1.0) # FIXME: make an is_valid here?
-        return reformulated(net_income_calculation.periods.quarterly.last)
+    def latest_quarterly_reformulated(cur_ci_calc, prev_is, prev_ci_calc)
+      if net_income_calculation.periods.quarterly.any?
+        period = net_income_calculation.periods.quarterly.last
+        lqr = reformulated(period, cur_ci_calc)
 
-      elsif !prev_income_statement
-        return nil
+        if (lqr.operating_revenues.total.abs > 1.0) && # FIXME: make an is_valid here?
+           (lqr.cost_of_revenues  .total.abs > 1.0)    # FIXME: make an is_valid here?
+          return lqr
+        end
+      end
 
-      elsif net_income_calculation.periods.yearly.any? &&
-            prev_income_statement.net_income_calculation.periods.threequarterly.any?
-        is_period = net_income_calculation.periods.yearly.last
-        re_is     = reformulated(is_period)
-  
-        period_1q_thru_3q = prev_income_statement.net_income_calculation.periods.threequarterly.last
-        prev3q  = prev_income_statement.reformulated(period_1q_thru_3q)
-        re_is   = re_is - prev3q
-        return re_is 
+      return nil if !prev_is
+
+      cur_period, prev_period = choose_successive_periods(net_income_calculation, prev_is.net_income_calculation)
+      if cur_period && prev_period
+        new_re_is = reformulated(cur_period, cur_ci_calc) - prev_is.reformulated(prev_period, prev_ci_calc)
+        # the above subtraction doesn't know what period you want. So let's patch the result to have
+        # a quarterly period with the right end-points
+        new_re_is.period = Xbrlware::Context::Period.new({"start_date"=>prev_period.value["end_date"], 
+                                                          "end_date"  =>cur_period.value["end_date"]})
+        return new_re_is
       end
-  
+
       return nil
     end
- 
+
     def write_constructor(file, item_name)
       item_calc_name = item_name + "_calc"
       @calculation.write_constructor(file, item_calc_name)

data/lib/finmodeling/income_statement_item.rb

@@ -3,7 +3,7 @@ module FinModeling
     include HasStringClassifier
 
     BASE_FILENAME = File.join(FinModeling::BASE_PATH, "classifiers/isi_")
-    TYPES         = [ :or, :cogs, :oe, :oibt, :fibt, :tax, :ooiat, :fiat ]
+    TYPES         = [ :or, :cogs, :oe, :oibt, :fibt, :tax, :ooiat, :ooiat_nci, :fiat ]
 
     has_string_classifier(TYPES, IncomeStatementItem)
 

data/lib/finmodeling/income_statement_item_vectors.rb

@@ -19,6 +19,17 @@ module FinModeling
                          {:klass=>:cogs, :item_string=>"Fulfillment Expense"},
                          {:klass=>:cogs, :item_string=>"Fulfillment Expense"},
   
+                         {:klass=>:or, :item_string=>"Net Sales"}, 
+                         {:klass=>:cogs, :item_string=>"Cost of products sold"}, 
+                         {:klass=>:oe, :item_string=>"Marketing, selling and administrative"}, 
+                         {:klass=>:oe, :item_string=>"Advertising and product promotion"}, 
+                         {:klass=>:oe, :item_string=>"Research and development"}, 
+                         {:klass=>:oibt, :item_string=>"Provision for restructuring"}, 
+                         {:klass=>:oibt, :item_string=>"Litigation expense, net"}, 
+                         {:klass=>:oibt, :item_string=>"Equity in net income of affiliates"}, 
+                         {:klass=>:oibt, :item_string=>"Other (income)/expense"}, 
+                         {:klass=>:tax, :item_string=>"Provision for income taxes"}, 
+
                          {:klass=>:or, :item_string=>"Subscription Revenue"}, 
                          {:klass=>:or, :item_string=>"Sales Revenue Net"}, 
                          {:klass=>:cogs, :item_string=>"Cost Of Goods Sold Subscription"}, 
@@ -40,7 +51,7 @@ module FinModeling
                          {:klass=>:fibt, :item_string=>"Interest Expense"}, 
                          {:klass=>:fibt, :item_string=>"Other Nonoperating Income Expense"}, 
                          {:klass=>:tax, :item_string=>"Income Tax Expense Benefit"}, 
-                         {:klass=>:fiat, :item_string=>"Net Income Loss Attributable To Noncontrolling Interest"}, 
+                         {:klass=>:ooiat_nci, :item_string=>"Net Income Loss Attributable To Noncontrolling Interest"}, 
   
                          {:klass=>:or, :item_string=>"Sales Revenue Goods Net"}, 
                          {:klass=>:or, :item_string=>"Sales Revenue Services Net"}, 
@@ -80,9 +91,9 @@ module FinModeling
                          {:klass=>:oibt, :item_string=>"Restructuring Charges"}, 
                          {:klass=>:fibt, :item_string=>"Interest Expense"}, 
                          {:klass=>:fibt, :item_string=>"Nonoperating Income Expense"}, 
-                         {:klass=>:fibt, :item_string=>"Gain Loss On Sale Of Equity Investments"}, 
+                         {:klass=>:oibt, :item_string=>"Gain Loss On Sale Of Equity Investments"}, 
                          {:klass=>:tax, :item_string=>"Income Tax Expense Benefit"}, 
-                         {:klass=>:fiat, :item_string=>"Income Loss From Discontinued Operations Net Of Tax Attributable To Reporting Entity"}, 
+                         {:klass=>:ooiat, :item_string=>"Income Loss From Discontinued Operations Net Of Tax Attributable To Reporting Entity"}, 
   
                          {:klass=>:or, :item_string=>"Sales Revenue Net"}, 
                          {:klass=>:cogs, :item_string=>"Cost Of Goods And Services Sold"}, 
@@ -133,7 +144,7 @@ module FinModeling
                          {:klass=>:oibt, :item_string=>"Restructuring Charges"}, 
                          {:klass=>:fibt, :item_string=>"Nonoperating Income Expense"}, 
                          {:klass=>:tax, :item_string=>"Income Tax Expense Benefit"}, 
-                         {:klass=>:fiat, :item_string=>"Income Loss From Discontinued Operations Net Of Tax"}, 
+                         {:klass=>:ooiat, :item_string=>"Income Loss From Discontinued Operations Net Of Tax"}, 
   
                          {:klass=>:or, :item_string=>"Sales Revenue Goods Net"}, 
                          {:klass=>:or, :item_string=>"Sales Revenue Services Net"}, 
@@ -197,7 +208,7 @@ module FinModeling
                          {:klass=>:fibt, :item_string=>"Interest Expense"}, 
                          {:klass=>:fibt, :item_string=>"Other Nonoperating Income Expense"}, 
                          {:klass=>:tax, :item_string=>"Income Tax Expense Benefit"}, 
-                         {:klass=>:fiat, :item_string=>"Income Loss From Equity Method Investments"},
+                         {:klass=>:ooiat, :item_string=>"Income Loss From Equity Method Investments"},
   
                          {:klass=>:or, :item_string=>"Licenses Revenue"}, 
                          {:klass=>:or, :item_string=>"Maintenance Revenue"}, 
@@ -244,7 +255,7 @@ module FinModeling
                          {:klass=>:fibt, :item_string=>"Gain Loss On Sale Of Business"}, 
                          {:klass=>:fibt, :item_string=>"Other Nonoperating Income Expense"}, 
                          {:klass=>:tax, :item_string=>"Income Tax Expense Benefit"}, 
-                         {:klass=>:fiat, :item_string=>"Net Income Loss Attributable To Noncontrolling Interest"}, 
+                         {:klass=>:ooiat_nci, :item_string=>"Net Income Loss Attributable To Noncontrolling Interest"}, 
   
                          {:klass=>:or, :item_string=>"Licenses Revenue"}, 
                          {:klass=>:or, :item_string=>"Maintenance Revenue"}, 
@@ -297,10 +308,10 @@ module FinModeling
                          {:klass=>:oe, :item_string=>"Amortization Of Intangible Assets"}, 
                          {:klass=>:fibt, :item_string=>"Investment Income Interest"}, 
                          {:klass=>:fibt, :item_string=>"Interest Expense"}, 
-                         {:klass=>:fibt, :item_string=>"Income Loss From Equity Method Investments"}, 
+                         {:klass=>:oibt, :item_string=>"Income Loss From Equity Method Investments"}, 
                          {:klass=>:fibt, :item_string=>"Other Nonoperating Expense"}, 
                          {:klass=>:tax, :item_string=>"Income Tax Expense Benefit"}, 
-                         {:klass=>:fiat, :item_string=>"Net Income Loss Attributable To Noncontrolling Interest"}, 
+                         {:klass=>:ooiat_nci, :item_string=>"Net Income Loss Attributable To Noncontrolling Interest"}, 
   
                          {:klass=>:or, :item_string=>"Revenues"}, 
                          {:klass=>:cogs, :item_string=>"Cost Of Revenue"}, 
@@ -356,7 +367,7 @@ module FinModeling
                          {:klass=>:fibt, :item_string=>"Other Nonoperating Income Expense"}, 
                          {:klass=>:fibt, :item_string=>"Impairment Of Investments"}, 
                          {:klass=>:tax, :item_string=>"Income Tax Expense Benefit"}, 
-                         {:klass=>:fiat, :item_string=>"Net Income Loss Attributable To Noncontrolling Interest"}, 
+                         {:klass=>:ooiat_nci, :item_string=>"Net Income Loss Attributable To Noncontrolling Interest"}, 
   
                          {:klass=>:or, :item_string=>"Sales Revenue Goods Net"}, 
                          {:klass=>:or, :item_string=>"Sales Revenue Services Net"}, 
@@ -504,7 +515,7 @@ module FinModeling
                          {:klass=>:oe, :item_string=>"Research And Development In Process"}, 
                          {:klass=>:oe, :item_string=>"Goodwill And Acquisition Related Intangible Assets Impairment"}, 
                          {:klass=>:fibt, :item_string=>"Gain Loss On Disposition Of Assets"}, 
-                         {:klass=>:fibt, :item_string=>"Equity Method Investment Other Than Temporary Impairment"}, 
+                         {:klass=>:oibt, :item_string=>"Equity Method Investment Other Than Temporary Impairment"}, 
                          {:klass=>:fibt, :item_string=>"Interest Income And Other Expense Net"}, 
                          {:klass=>:tax, :item_string=>"Income Tax Expense Benefit"}, 
   
@@ -522,7 +533,7 @@ module FinModeling
                          {:klass=>:fibt, :item_string=>"Interest Expense"}, 
                          {:klass=>:fibt, :item_string=>"Other Nonoperating Income Expense"}, 
                          {:klass=>:tax, :item_string=>"Income Tax Expense Benefit"}, 
-                         {:klass=>:fiat, :item_string=>"Income Loss From Equity Method Investments Net Of Tax"}, 
+                         {:klass=>:ooiat, :item_string=>"Income Loss From Equity Method Investments Net Of Tax"}, 
   
                          {:klass=>:or, :item_string=>"Sales Revenue Net"}, 
                          {:klass=>:cogs, :item_string=>"Cost Of Revenue"}, 
@@ -533,7 +544,7 @@ module FinModeling
                          {:klass=>:fibt, :item_string=>"Interest Expense"}, 
                          {:klass=>:fibt, :item_string=>"Other Nonoperating Expense"}, 
                          {:klass=>:tax, :item_string=>"Income Tax Expense Benefit"}, 
-                         {:klass=>:fiat, :item_string=>"Net Income Loss Attributable To Noncontrolling Interest"}, 
+                         {:klass=>:ooiat_nci, :item_string=>"Net Income Loss Attributable To Noncontrolling Interest"}, 
   
                          {:klass=>:or, :item_string=>"Sales Revenue Net"}, 
                          {:klass=>:cogs, :item_string=>"Cost Of Revenue"}, 
@@ -614,7 +625,7 @@ module FinModeling
                          {:klass=>:oe, :item_string=>"Research And Development Expense Software Excluding Acquired In Process Cost"}, 
                          {:klass=>:oe, :item_string=>"Selling And Marketing Expense"}, 
                          {:klass=>:oe, :item_string=>"General And Administrative Expense"}, 
-                         {:klass=>:fibt, :item_string=>"Income Loss From Equity Method Investments"}, 
+                         {:klass=>:oibt, :item_string=>"Income Loss From Equity Method Investments"}, 
                          {:klass=>:oibt, :item_string=>"Amortization Of Intangible Assets"}, 
                          {:klass=>:oibt, :item_string=>"Other Restructuring Costs"}, 
                          {:klass=>:fibt, :item_string=>"Other Nonoperating Income Expense"}, 

data/lib/finmodeling/invalid_filing_error.rb

@@ -0,0 +1,4 @@
+module FinModeling
+  class InvalidFilingError < StandardError
+  end
+end

data/lib/finmodeling/liabs_and_equity_calculation.rb

@@ -6,20 +6,18 @@ module FinModeling
 
     BASE_FILENAME = File.join(FinModeling::BASE_PATH, "summaries/liabs_and_equity_")
 
-    ALL_STATES  =           [ :ol, :fl, :cse ]
-    NEXT_STATES = { nil  => [ :ol, :fl, :cse ],
-                    :ol  => [ :ol, :fl, :cse ],
-                    :fl  => [ :ol, :fl, :cse ],
-                    :cse => [      :fl, :cse ] }
+    ALL_STATES  =           [ :ol, :fl, :cse, :mi ]
+    NEXT_STATES = { nil  => [ :ol, :fl, :cse, :mi ],
+                    :ol  => [ :ol, :fl, :cse, :mi ],  # operating liabilities
+                    :fl  => [ :ol, :fl, :cse, :mi ],  # financial liabilities
+                    :cse => [ :ol, :fl, :cse, :mi ],  # common shareholder equity
+                    :mi  => [      :fl, :cse, :mi ] } # minority interest
 
     def summary(args)
       summary_cache_key = args[:period].to_pretty_s
       summary = lookup_cached_summary(summary_cache_key)
       return summary if !summary.nil?
 
-      mapping = Xbrlware::ValueMapping.new
-      mapping.policy[:debit] = :flip
-
       summary = super(:period => args[:period], :mapping => mapping) # FIXME: flip_total should == true!
       if !lookup_cached_classifications(BASE_FILENAME, summary.rows)
         lookahead = [4, summary.rows.length-1].min
@@ -32,5 +30,17 @@ module FinModeling
       return summary
     end
 
+    def mapping
+      m = Xbrlware::ValueMapping.new
+      m.policy[:debit] = :flip
+      m
+    end
+
+    def has_equity_item
+      @has_equity_item ||= leaf_items.any? do |leaf|
+        leaf.name.downcase.matches_any_regex?([/equity/, /stock/])
+      end
+    end
+
   end
 end

data/lib/finmodeling/liabs_and_equity_item.rb

@@ -3,7 +3,7 @@ module FinModeling
     include HasStringClassifier
 
     BASE_FILENAME = File.join(FinModeling::BASE_PATH, "classifiers/laei_")
-    TYPES         = [ :ol, :fl, :cse ]
+    TYPES         = [ :ol, :fl, :cse, :mi ]
 
     has_string_classifier(TYPES, LiabsAndEquityItem)