excel_functions 0.0.2 → 0.0.3

data/README.md

@@ -25,7 +25,7 @@ This gem can be used in 2 ways.
 2. Use the `Excel.<function>` style anywhere.
 
 #TODO 
-- more docs about the functions themselves, for now, you can take a look at the code
+- more docs about the functions themselves, for now, you can take a look at the code, or the [Yard Documentation](http://rubydoc.info/gems/excel_functions/)
 
 ## Contributing
 

data/lib/excel_functions/financial.rb

@@ -1,24 +1,30 @@
 #file containing the financial functions
 module ExcelFunctions  
-  # attempt to implement http://office.microsoft.com/en-sg/excel-help/npv-HP005209199.aspx
+  #Calculates the net present value of an investment by using a discount rate and a series of future payments (negative values) and income (positive values).
+  # @param rate     is the rate of discount over the length of one period.
+  # @param *values      are 1 to 29 arguments representing the payments and income.
+  # @return net present value of an investment
+  # @see http://office.microsoft.com/en-sg/excel-help/npv-HP005209199.aspx Specification
   def npv(rate,*values)
     #If n is the number of cash flows in the list of values, the formula for NPV is: 
     # sum upto n (values[i]/(1+rate)^i)
     values.each_with_index.inject(0){|sum,(val, index)| sum + val/((1.0+rate)**(index+1))}
   end
 
-  #http://office.microsoft.com/en-sg/excel-help/pmt-HP005209215.aspx
   #Calculates the payment for a loan based on constant payments and a constant interest rate.
-  # Rate     is the interest rate for the loan.
-  # Nper     is the total number of payments for the loan.
-  # Pv     is the present value, or the total amount that a series of future payments is worth now; also known as the principal.
-  # Fv     is the future value, or a cash balance you want to attain after the last payment is made. If fv is omitted, it is assumed to be 0 (zero), that is, the future value of a loan is 0.
-  # Type     is the number 0 (zero) or 1 and indicates when payments are due.
-  # Set type equal to   If payments are due
-  # 0 or omitted  At the end of the period
-  # 1   At the beginning of the period
-  # full formula at http://www.getobjects.com/Components/Finance/TVM/formulas.html
-  #first 3 params at http://answers.yahoo.com/question/index?qid=20080822070859AAY94ZT
+  # @param  rate     is the interest rate for the loan.
+  # @param nper     is the total number of payments for the loan.
+  # @param pv     is the present value, or the total amount that a series of future payments is worth now; also known as the principal.
+  # @param fv     is the future value, or a cash balance you want to attain after the last payment is made. If fv is omitted, it is assumed to be 0 (zero), that is, the future value of a loan is 0.
+  # @param type     is the number 0 (zero) or 1 and indicates when payments are due.
+  # 
+  #   Set type equal to   
+  #   0 or omitted  If payments are due At the end of the period or 
+  #   1  If payments are due At the beginning of the period
+  # @return [Float] payment for a loan based on the inputs
+  # @see http://office.microsoft.com/en-sg/excel-help/pmt-HP005209215.aspx Specification
+  # @see http://answers.yahoo.com/question/index?qid=20080822070859AAY94ZT  formula using first 3 params
+  # @see http://www.getobjects.com/Components/Finance/TVM/formulas.html   Full Formula
   def pmt(rate,nper,pv,fv =0,type = 0)
     #- pv/((1 - (1 / (1 + rate)**nper )) / rate)
     pv = -pv

data/lib/excel_functions/lookup.rb

@@ -1,23 +1,30 @@
 #file containing the lookup based functions
 module ExcelFunctions
-  #attempt to implement http://www.techonthenet.com/excel/formulas/lookup.php
+  #The LOOKUP function searches for the value in the lookup_range and returns the value from the same position in the result_range. 
+  #If this parameter is omitted, the LOOKUP function will return the first column of data.
+  #In Syntax #2, the LOOKUP function searches for the value in the first row or column of the array and returns the corresponding value in the last row or column of the array.
+  #@param value the value to be searched for 
+  #@param [Array] lookup_array the array in which the value is looked for, and possibly the result is fetched from
+  #@param [Array] output_array If given, the result is fetched from this array
+  # @return Returns the value in the output_array or the last column of the lookup_array from the same position in the result_range
+  # @return   If the LOOKUP function can not find an exact match, it chooses the largest value in the lookup_range that is less than or equal to the value.
+  # @return   If the value is smaller than all of the values in the lookup_range, then the LOOKUP function will return #N/A(nil in our case).
+  # @return If the values in the LOOKUP_range are not sorted in ascending order, the LOOKUP function will return the incorrect value (raise error in our case).
+  # @see http://www.techonthenet.com/excel/formulas/lookup.php Specification
   def lookup(value, lookup_array, output_array = nil)
-    #The LOOKUP function searches for the value in the lookup_range and returns the value from the same position in the result_range. If this parameter is omitted, the LOOKUP function will return the first column of data.
-    #In Syntax #2, the LOOKUP function searches for the value in the first row or column of the array and returns the corresponding value in the last row or column of the array.
     #combining both syntaxes here by taking 1st col of lookup_array to lookup
     # and the output_array or the last column of the lookup_array to output
     output_array = output_array || lookup_array.map{|arr| Array(arr)[-1]}
 
     lookup_array = lookup_array.map{|arr| Array(arr)[0]}
 
-    #If the values in the LOOKUP_range are not sorted in ascending order, the LOOKUP function will return the incorrect value.
+    
     raise "lookup_array must be sorted" unless lookup_array.sort == lookup_array #better way to check sorted?
 
     index = lookup_array.find_index(value)
     return output_array[index] if index
 
-    # If the LOOKUP function can not find an exact match, it chooses the largest value in the lookup_range that is less than or equal to the value.
-    # If the value is smaller than all of the values in the lookup_range, then the LOOKUP function will return #N/A.
+    
     first_greater_index = lookup_array.find_index{|look| look > value} || lookup_array.count 
     less_than_index = first_greater_index - 1
     less_than_index >=0 ? output_array[less_than_index] : nil

data/lib/excel_functions/version.rb

@@ -1,3 +1,3 @@
 module ExcelFunctions
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/excel_functions.rb

@@ -1,10 +1,13 @@
 require "excel_functions/version"
 require "excel_functions/financial"
 require "excel_functions/lookup"
+
+#module to be included in a client class
 module ExcelFunctions
 
 end
 
+#class which provides all the methods as class methods
 class Excel
   extend ExcelFunctions
 end

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: excel_functions
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
+  prerelease: 
 platform: ruby
 authors:
 - Karthik T
@@ -13,6 +14,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -20,6 +22,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -27,6 +30,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -34,6 +38,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -41,6 +46,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -48,6 +54,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -74,26 +81,28 @@ files:
 homepage: https://github.com/ktaragorn/excel_functions
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.5
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: This gem can be used if you need to reverse engineer any excel spreadsheets.
 test_files:
 - spec/excelfunctions_spec.rb
+has_rdoc: 

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    OTg4NmNlZDk3MmNhODRhYzZkM2IyOTc1NjAxZTU3MjQ2MzNhYTIzYQ==
-  data.tar.gz: !binary |-
-    MTNjYjhkNmJiMThlYWIwYTU3N2U3ZTBiYTBlZGNhZDI2MWI2NmVlOA==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    YzUzNTE4ZDNjZGZmN2U5ZjAxZjFlN2I2ZThkZWIyYzFlZjhhOGU5YTdjOTIw
-    NTg4YTkxYjZhYzQ3OGEwZDAxMGQzN2MxZDk4NTE2NTFmYjFjNTRhNDUxNTU5
-    NTlkZDhhZGEzNmY1ZTYwMzM3ZDMzNzA2ODU3NjllNDYzNTQzYTk=
-  data.tar.gz: !binary |-
-    MTQxZGI5YzZlOGE2ZjMxYzRjYWFmODUxMDlmZWI0NTBmMzNlOGYyN2ZjMmZi
-    MGIzZGY1NTM0YmM4NTQxMmUzNTZhMWQyZTFiYjdlMzhhYjg2Y2Y2MGE0NWIw
-    NjJjNTFkOWVlZTZjMzk0M2M0MzI5YjAxYTYzOWU2YzkwNzUyYjI=