RealEstateFinance
Installation
Add this line to your application's Gemfile:
gem 'real_estate_finance'
And then execute:
$ bundle
Or install it yourself as:
$ gem install real_estate_finance
Usage
Functions Available
All inputs are meant to be in their specifc order listed below and all inputs are meant to be Numbers, not Strings or Floats!
Most outputs are Floats...
gross_potential_income
RealEstateFinance::GrossPotentialIncome.new(monthly_income).gross_potential_income
net_operating_income
RealEstateFinance::NetOperatingIncome.new( monthly_income, vacancies, non_payments, taxes, mortgage_interest, marketing, advertising, management, legal, accounting, utilities, repairs, maintenance, acquisition, sale_costs ).net_operating_income
gross_rental_multiplier
RealEstateFinance::GrossRentalMultiplier.new( marketValue, monthly_income ).gross_rental_multiplier
estimated_property_value_from_grm
RealEstateFinance::EstimatedPropertyValueFromGRM.new( market_value, monthly_income ).estimated_property_value_from_grm
gross_operating_income
RealEstateFinance::GrossOperatingIncome.new( monthly_income, estimated_loss_percentage ).gross_operating_income
capitalization_rate
RealEstateFinance::CapitalizationRate.new( monthly_income, vacancies, non_payments, taxes, marketing, advertising, management, legal, accouting, utilities, repairs, maintenance, acquisition, sale_costs, sale_earned ).capitalization_rate
estimated_property_value_from_cap_rate
RealEstateFinance::EstimatedPropertyValueFromCapRate.new( monthly_income, vacancies, non_payments, taxes, mortgage_interest, marketing, advertising, management, legal, accounting, utilities, repairs, maintenance, acquisition, sale_costs, sale_earned ).estimated_property_value_from_cap_rate
cash_flow_before_taxes
RealEstateFinance::CashFlowBeforeTaxes.new( monthly_income, vacancies, non_payments, taxes, mortgage_interest, marketing, advertising, management, legal, accounting, utilities, repairs, maintenance, acquisition, sale_costs, interest_rate, loan_principle, capital_expenditures, capital_expenditure_loans, earned_interest ).cash_flow_before_taxes
cash_flow_after_taxes
RealEstateFinance::CashFlowAfterTaxes.new( monthly_income, vacancies, non_payments, taxes, mortgage_interest, marketing, advertising, management, legal, accounting, utilities, repairs, maintenance, acquisition, sale_costs, interest_rate, loan_principle, capital_expenditures, capital_expenditure_loans, earned_interest, state_income_tax, federal_income_tax ).cash_flow_after_taxes
break_even_ratio
RealEstateFinance::BreakEvenRatio.new( interest_rate, loan_principle, marketing, advertising, management, legal, accounting, utilities, repairs, maintenance, monthly_income, estimated_loss_percentage ).break_even_ratio
return_on_equity
RealEstateFinance::ReturnOnEquity.new( monthly_income, vacancies, non_payments, taxes, mortgage_interest, marketing, advertising, management, legal, accounting, utilities, repairs, maintenance, acquisition, sale_costs, interest_rate, loan_principle, capital_expenditures, capital_expenditure_loans, earned_interest, state_income_tax, federal_income_tax, principle_invested ).return_on_equity
Development
After checking out the repo, run bin/setup
to install dependencies. Then, run rake spec
to run the tests. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
, which will create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/real_estate_finance.
License
The gem is available as open source under the terms of the MIT License.