math_calculator 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Anil Sharma
+
+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.rdoc

@@ -0,0 +1,55 @@
+= math_calculator
+
+Math calculator evaluates expressions containg terms supported bt the Ruby's Math module.
+Although you could do the same with eval, MathCalulator makes sure that only valid Math
+functions are evaluated.
+
+== Install
+
+Install math_calculator like any other ruby gem:
+
+    gem install math_calculator
+
+== Overview of usage
+
+  math_calculator accepts a string containg the expression to be evaluated
+  and returns the value of the expression. It optionally accepts a hash of variable
+  values used in the expression. The options key must be a symbol representing
+  a variable, and the options value must be numeric, which would be used as the
+  value of the variable to evaluate the expression.
+
+== Commands and Usage
+
+Available Command:
+
+  str = "2+4"
+  MathCalculator.calculate(str)  # 6
+
+  MathCalculator.calculate('(x+y)*2', :x => 2, :y => 4)  # 12
+
+  str = "x+y"
+  options = {:x => 2, :y => 4}
+  MathCalculator.calculate(str, options)  # 6
+
+
+== Issues, Suggestions
+
+* https://github.com/aksharma/math_calculator/issues/
+* or email me directly at (sharma.rubyonrails)
+*     this address        (    @             )
+*                         (sharmail_dot_com  )
+
+== Contributing to math_calculator
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Anil Sharma. See LICENSE for further details.
+

data/lib/math_calculator.rb

@@ -0,0 +1,78 @@
+class MathCalculator
+  include Math
+
+  def self.calculate(str='', options={})
+    @@safe_formula = true
+    self.tokenize(str,options)
+    options.each {|k,v| @@safe_formula = false unless (k.is_a? Symbol and v.is_a? Numeric)}
+    if self.safe_formula?
+      options.each do |var, val|
+        str = "#{var.to_s} = #{val}; #{str}"
+      end
+      self.constants_list.each do |const|
+        str = "#{const.to_s.downcase} = #{const}; #{str}"
+      end
+      eval str
+    end
+  end
+
+  private
+
+  def self.tokenize(str, options={})
+    new_str0 = str.gsub(/\s*/,'')
+    new_str1 = new_str0.gsub(/[a-zA-Z]+/,' \0 ')
+    new_str2 = new_str1.gsub(/\d*\.?\d+/,' \0 ')
+    arr1 = new_str2.split(' ')
+    new_arr = []
+    arr1.each do |token|
+      if (self.valid_tokens_list(options).include? token)
+        new_arr << token
+      elsif token.match(/\d*\.?\d+/) &&
+           (token.match(/\d*\.?\d+/)[0] == token)
+        new_arr << token
+      else
+        char_arr = token.split('')
+        char_arr.each do |char|
+          if self.chars_list.include? char
+            new_arr << char
+          else
+            @@safe_formula = false
+          end
+        end
+      end
+    end
+   return new_arr
+  end
+
+  def self.valid_tokens_list(options)
+    (self.public_methods_list +
+     self.constants_list +
+     self.downcase_constants_list +
+     self.user_variables_list(options)
+    ).map{|t| t.to_s}
+  end
+
+  def self.user_variables_list(options)
+    options.keys.map(&:to_s)
+  end
+
+  def self.public_methods_list
+    (Math.public_methods - Object.methods)
+  end
+
+  def self.constants_list
+    (Math.constants - [:DomainError])
+  end
+
+  def self.downcase_constants_list
+    (Math.constants - [:DomainError]).map{|c| c.to_s.downcase}
+  end
+
+  def self.chars_list
+    %w[+ - / * ( ) ]
+  end
+
+  def self.safe_formula?
+    @@safe_formula
+  end
+end

data/spec/math_calculator_spec.rb

@@ -0,0 +1,79 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Simple calculation" do
+  it "should do simple addition" do
+    str = "2+4"
+    MathCalculator.calculate(str).should == 6
+  end
+end
+
+describe "Simple calculation with negative numbers" do
+  it "should do simple addition of negative numbers" do
+    str = "-2+(-4)"
+    MathCalculator.calculate(str).should == -6
+  end
+end
+
+describe "Value of constant PI" do
+  it "should evaluate PI" do
+    str = 'PI'
+    MathCalculator.calculate(str).should == PI
+  end
+end
+
+describe "Value of constant pi" do
+  it "should evaluate pi" do
+    str = 'pi'
+    MathCalculator.calculate(str).should == PI
+  end
+end
+
+describe "Value of constant E" do
+  it "should evaluate E" do
+    str = 'E'
+    MathCalculator.calculate(str).should == E
+  end
+end
+
+
+describe "Value of a single Math function" do
+  it "should evaluate log(2)" do
+    str = 'log 2'
+    MathCalculator.calculate(str).should == log(2)
+  end
+end
+
+describe "Tokenize expression" do
+  it "should create an array of tokens in expressions" do
+    str = 'cos(90)*acos(0.23)*cos(90)'
+    MathCalculator.tokenize(str).should == %w[cos ( 90 ) * acos ( 0.23 ) * cos ( 90 )]
+  end
+end
+
+describe "Tokenize expression" do
+  it "should create an array of tokens in expressions" do
+    str = '(3*exp(t/2)*cos(3*t-PI/2))'
+    MathCalculator.tokenize(str, :t => 2).should == %w[ ( 3 * exp ( t / 2 ) * cos ( 3 * t - PI / 2 ) )]
+  end
+end
+
+describe "Evaluate expression" do
+  it "should evaluate matehematicale expressions" do
+    str = '(3*exp(t/2)*cos(3*t-PI/2))'
+    MathCalculator.calculate(str, :t => 2).should == -2.2785902140319134
+  end
+end
+
+describe "Unsafe expression" do
+  it "should not be evaluated" do
+    str = 'PI*3+xyz'
+    MathCalculator.calculate(str).should == nil
+  end
+end
+
+describe "Unsafe variable" do
+  it "should not be evaluated" do
+    str = '2+2'
+    MathCalculator.calculate(str, :t => 'abc').should == nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'math_calculator'
+include Math
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: math_calculator
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Anil Sharma
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-06-09 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Math calculator evalutaes expressions containg terms supported bt the Ruby's Math module.
+email: sharma.ruby2gem@sharmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/math_calculator.rb
+- spec/spec_helper.rb
+- spec/math_calculator_spec.rb
+- README.rdoc
+- LICENSE
+- spec//spec_helper.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/math_calculator
+licenses: []
+
+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: 1.5.3
+signing_key: 
+specification_version: 3
+summary: Math calculator using the Ruby Math module
+test_files: 
+- spec//spec_helper.rb
+- spec/math_calculator_spec.rb