Permalink
Browse files

Miscellaneous updates, in preparation for the v1.0.0 release.

  • Loading branch information...
wkranec committed Jul 20, 2011
1 parent fcce9fe commit 7985144356b6068eac1f2a53ad99686cb6c981e8
Showing with 41 additions and 40 deletions.
  1. +1 −1 .yardopts
  2. +11 −13 HISTORY
  3. +24 −22 README
  4. +5 −4 finance.gemspec
View
@@ -1 +1 @@
-- COPYING COPYING.LESSER HISTORY README
+--no-private lib/**/*.rb - COPYING COPYING.LESSER HISTORY README
View
24 HISTORY
@@ -1,28 +1,26 @@
-# Version 0.2.1
+= Version 1.0.0
+20 Jul 2011
-## Bugs:
-* The amortize Numeric method now accepts a variable number of rates.
-* Lots of additional documentation.
+* Moved to Ruby 1.9.
+* All classes are now contained within the +Finance+ namespace.
+* LOTS of additional documentation and examples.
+* Introduced _shoulda_ for unit tests, to make things a little more readable.
+* Bugfix: The +amortize+ Numeric method now accepts a variable number of rates.
+* Some code refactoring and clean-up for a small performance increase.
-## Performance:
-* Some code refactoring and clean-up to reduce the number of calculations.
-
-# Version 0.2.0
+= Version 0.2.0
28 Jun 2011
-## Features:
* Added support for adjustable rate mortgages.
* Added support for additional payments.
-# Version 0.1.1
+= Version 0.1.1
21 Jun 2011
-## Bugs:
* Code examples in README now display correctly in the online documentation.
-# Version 0.1.0
+= Version 0.1.0
21 Jun 2011
-## Features:
* Support for fixed-rate mortgage amortization.
* NPV, IRR array methods for cash flow analysis.
View
46 README
@@ -1,16 +1,25 @@
-_finance_ - a library for financial calculations in Ruby.
+= FINANCE
-= INSTALL
+a library for financial modelling in Ruby.
+
+== INSTALL
$ sudo gem install finance
-= OVERVIEW
+== OVERVIEW
-== GETTING STARTED
+=== GETTING STARTED
>> require 'finance'
-== AMORTIZATION
+*Note:* As of version 1.0.0, the entire library is contained under the
+Finance namespace. Existing code will not work unless you add:
+
+ >> include Finance
+
+for all of the examples below, we'll assume that you have done this.
+
+=== AMORTIZATION
You are interested in borrowing $250,000 under a 30 year, fixed-rate
loan with a 4.25% APR.
@@ -55,7 +64,7 @@ Since we are looking at an ARM, there is no longer a single "payment" value.
But we can look at the different payments over time.
>> arm.payments.uniq
- => [DecNum('-1229.85'), DecNum('-1360.41'), DecNum('-1475.65'), DecNum('-1571.07'), DecNum('-1641.34'), ... snipped ... ]
+ => [DecNum('-1229.85'), DecNum('-1360.41'), DecNum('-1475.65'), DecNum('-1571.07'), ... snipped ... ]
The other methods previously discussed can be accessed in the same way:
@@ -83,14 +92,11 @@ example. Notice the difference in the results:
>> extra_payments.interest.sum
=> DecNum('150566.24')
-*Note*: you are _not_ allowed to modify a payment to pay _less_ than the
-normally calculated payment.
-
You can also increase your payment to a specific amount:
>> extra_payments_2 = 250000.amortize(rate){ -1500 }
-= ABOUT
+== ABOUT
I started developing _finance_ while analyzing mortgages as a personal
project. Spreadsheets have convenient formulas for doing this type of
@@ -110,29 +116,25 @@ of open, tested tools to fill this gap.
If you have used _finance_ and find it useful, I would enjoy hearing
about it!
-= FEATURES
+== FEATURES
Currently implemented features include:
* Uses the {http://flt.rubyforge.org/ flt} library to ensure precision decimal arithmetic in all calculations.
* Fixed-rate mortgage amortization (30/360).
* Interest rates
-* Various cash flow computations, such as NPV, IRR, and sum.
+* Various cash flow computations, such as NPV and IRR.
* Adjustable rate mortgage amortization.
* Payment modifications (i.e., how does paying an additional $75 per month affect the amortization?)
-= RESOURCES
-
-This gem and related documentation is available through
-{https://rubygems.org/gems/finance RubyGems}.
-
-Source code and bug tracking is available via
-{http://github.com/wkranec/finance github}.
+== RESOURCES
-Additional documentation is available on the
-{https://github.com/wkranec/finance/wiki wiki}.
+[RubyGems Page] {https://rubygems.org/gems/finance}
+[Source Code] {http://github.com/wkranec/finance}
+[Bug Tracker] {https://github.com/wkranec/finance/issues}
+[Google Group] {http://groups.google.com/group/finance-gem/topics?pli=1}
-= COPYRIGHT
+== COPYRIGHT
This library is released under the terms of the LGPL license.
View
@@ -3,17 +3,18 @@ require 'rake'
SPEC = Gem::Specification.new do |s|
s.name = "finance"
- s.version = "0.2.0"
+ s.version = "1.0.0"
s.author = "Bill Kranec"
s.email = "wkranec@gmail.com"
s.platform = Gem::Platform::RUBY
- s.summary = "a library for financial calculations in Ruby."
+ s.summary = "a library for financial modelling in Ruby."
s.description = "The finance library provides a Ruby interface for working with interest rates, mortgage amortization, and cashflows (NPV, IRR, etc.)."
s.homepage = "https://rubygems.org/gems/finance"
+ s.required_ruby_version = '>=1.9'
s.add_dependency 'flt', '>=1.3.0'
- s.files = FileList['README', 'COPYING', 'COPYING.LESSER', 'lib/**/*.rb', 'test/**/*.rb'].to_a
+ s.files = FileList['README', 'COPYING', 'COPYING.LESSER', 'HISTORY', 'lib/**/*.rb', 'test/**/*.rb'].to_a
s.has_rdoc = true
- s.extra_rdoc_files = ["README"]
+ s.extra_rdoc_files = ['README', 'COPYING', 'COPYING.LESSER', 'HISTORY']
end

0 comments on commit 7985144

Please sign in to comment.