excel_functions 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!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=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+script: bundle exec rspec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in excel_functions.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Karthik T
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,36 @@
+# ExcelFunctions
+
+**Reverse engineered versions of some Excel functions**
+This gem can be used if you need to reverse engineer any excel spreadsheets. Use the functions here to convert excel formulae into ruby code easily
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'excel_functions'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install excel_functions
+
+## Usage
+
+This gem can be used in 2 ways.
+
+1. Include `ExcelFunctions` module in the class that needs it and use its functions
+2. Use the `Excel.<function>` style anywhere.
+
+#TODO 
+- more docs about the functions themselves, for now, you can take a look at the code
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/excel_functions.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'excel_functions/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "excel_functions"
+  spec.version       = ExcelFunctions::VERSION
+  spec.authors       = ["Karthik T"]
+  spec.email         = ["karthikt.holmes+github@gmail.com"]
+  spec.description   = %q{Reverse engineered versions of some Excel functions}
+  spec.summary       = %q{This gem can be used if you need to reverse engineer any excel spreadsheets.}
+  spec.homepage      = "https://github.com/ktaragorn/excel_functions"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/excel_functions.rb

@@ -0,0 +1,10 @@
+require "excel_functions/version"
+require "excel_functions/financial"
+require "excel_functions/lookup"
+module ExcelFunctions
+
+end
+
+class Excel
+  extend ExcelFunctions
+end

data/lib/excel_functions/financial.rb

@@ -0,0 +1,30 @@
+#file containing the financial functions
+module ExcelFunctions  
+  # attempt to implement http://office.microsoft.com/en-sg/excel-help/npv-HP005209199.aspx
+  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
+  def pmt(rate,nper,pv,fv =0,type = 0)
+    #- pv/((1 - (1 / (1 + rate)**nper )) / rate)
+    pv = -pv
+
+    k = [1,1+rate][type]
+
+    -(pv + (pv - fv)/((1+rate) ** nper - 1))* -rate/k #added some extra neg signs to get it to work
+  end
+end

data/lib/excel_functions/lookup.rb

@@ -0,0 +1,25 @@
+#file containing the lookup based functions
+module ExcelFunctions
+  #attempt to implement http://www.techonthenet.com/excel/formulas/lookup.php
+  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
+  end
+end

data/lib/excel_functions/version.rb

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

data/spec/excelfunctions_spec.rb

@@ -0,0 +1,40 @@
+require "excel_functions"
+describe Excel do
+  describe "Financial" do
+    it "calculates npv correctly" do
+      expect(Excel.npv(0.5, 50, 45,34)).to be_within(0.01).of(63.41)
+      expect(Excel.npv(0.2,15,53,23,64,23)).to be_within(0.01).of(102.72)
+    end
+
+    it "calculates pmt correctly" do
+      # examples from http://office.microsoft.com/en-sg/excel-help/pmt-HP005209215.aspx?CTT=1
+      expect(Excel.pmt(0.08/12, 10,10000)).to be_within(0.01).of(-1037.03)
+      expect(Excel.pmt(0.08/12, 10,10000,0,1)).to be_within(0.01).of(-1030.16)
+      expect(Excel.pmt(0.06/12, 18*12,0,50000)).to be_within(0.01).of(-129.08)
+    end
+  end
+  describe "Lookup" do
+    #should this be 3 it blocks?
+    it "performs lookup correctly" do
+      input_arr =  [0,0.05,0.1,0.15]
+      output_arr = ["a","b","c","d"]
+      tests = [
+        [0, "a"],
+        [0.1, "c"],
+        [0.12, "c"],
+        [1, "d"],
+        [-1, nil]
+      ]
+      #2 arrays
+      tests.each do |(value, result)|
+        expect(Excel.lookup(value,input_arr, output_arr)).to be_eql(result)
+      end
+      #single array
+      tests.each do |(value, result)|
+        expect(Excel.lookup(value,input_arr.zip(output_arr))).to be_eql(result)
+      end
+
+      expect{Excel.lookup(0.1,input_arr.reverse,output_arr)}.to raise_error
+    end
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: excel_functions
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Karthik T
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Reverse engineered versions of some Excel functions
+email:
+- karthikt.holmes+github@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- excel_functions.gemspec
+- lib/excel_functions.rb
+- lib/excel_functions/financial.rb
+- lib/excel_functions/lookup.rb
+- lib/excel_functions/version.rb
+- spec/excelfunctions_spec.rb
+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
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.5
+signing_key: 
+specification_version: 4
+summary: This gem can be used if you need to reverse engineer any excel spreadsheets.
+test_files:
+- spec/excelfunctions_spec.rb