calc 1.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+.idea
+*.gem
+.bundle

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,14 @@
+PATH
+  remote: .
+  specs:
+    calc (1.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  calc!

data/README.md

@@ -0,0 +1,49 @@
+# Calc
+
+Calc is safe, simple, pure Ruby mathematical expressions evaluator (calculator) library.
+
+Although based on Ruby 'eval', it takes special care to sanitize the expression.
+
+Calc supports all basic mathematical operations +, -, \*, / and the power function (through ** operator).
+Calc also supports parenthesis and nesting.
+Calc does NOT support advanced mathematical functions like trigonometry, logarithm, etc.
+
+Calc plays well with Rails ActiveModel::Validations.
+If the supplied expression is invalid (nil, blank, or syntax error),
+it returns the expression itself verbatim,
+thus allowing to handle errors via Rails validations.
+
+## Usage
+
+    require 'calc'
+
+    Calc.evaluate( "2 + 2" )  # => 4
+
+    Calc.evaluate( "2 * (1 + 9)" )  # => 20
+
+    Calc.evaluate( "2 ** (1.0 / 2)" )  # => 1.4142135623730951  (the square of two)
+
+    Calc.evaluate( "( ( 2 - 3 ) / 13 * ( 50 + 325.843 ) ) ** 3" )  # => -53090815.704202116
+
+## Installation
+
+    gem install calc
+
+## Using Bundler?
+
+Add the following to your Gemfile:
+
+    gem 'calc'
+
+Then run as usual:
+
+    bundle
+
+## Calc is safe
+
+Calc defines a white list of characters allowed in the expression to prevent code injection attacks.
+All letters are outlawed as well as majority of other characters. Calc comes with tests.
+
+## License
+
+Copyright (C) 2010 Piotr 'Qertoip' Włodarek. Distributed under the MIT License.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/calc.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "calc/version"
+
+Gem::Specification.new do |s|
+  s.name        = "calc"
+  s.version     = Calc::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Piotr 'Qertoip' Włodarek"]
+  s.email       = ["qertoip@gmail.com"]
+  s.homepage    = "http://github.com/qertoip/calc"
+  s.summary     = %q{Calculator (mathematical expressions evaluator) library for Ruby}
+  s.description = %q{Calc is safe, simple, pure-ruby mathematical expressions evaluator (calculator) library. Although based on Ruby 'eval', it takes special care to sanitize the expression.}
+
+  s.rubyforge_project = "calc"
+  
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/calc.rb

@@ -0,0 +1,35 @@
+module Calc
+  
+  def self.evaluate( unsafe_expression )
+    return nil if unsafe_expression.nil?
+
+    safe_expression = sanitize( unsafe_expression )
+    
+    return unsafe_expression if blank?( safe_expression )
+    
+    begin
+      return eval( safe_expression )
+    rescue SyntaxError
+      # return expression verbatim so ActiveModel::Validations could take care of this
+      return unsafe_expression
+    end
+  end
+
+  def self.evaluate_to_int( unsafe_expression )
+    return nil if unsafe_expression.nil?
+    return unsafe_expression if unsafe_expression.blank?
+    return evaluate( unsafe_expression ).to_i
+  end
+
+  private
+
+    def self.sanitize( unsafe_expression )
+      allowed_characters = Regexp.escape( '+-*/.()' )
+      return unsafe_expression.gsub( /[^\d#{allowed_characters}]/, '' )
+    end
+
+    def self.blank?( s )
+      s =~ /^\s*$/
+    end
+
+end

data/lib/calc/version.rb

@@ -0,0 +1,3 @@
+module Calc
+  VERSION = "1.0.0"
+end

data/test/calc.rb

@@ -0,0 +1,47 @@
+require File.expand_path( "../../lib/calc", __FILE__ )
+require 'test/unit'
+
+class CalcTest < Test::Unit::TestCase
+
+  # .evaluate()
+
+  def test_evaluate_returns_correct_value_when_given_valid_expression
+    assert_equal( 2, Calc.evaluate( "1+1" ) )
+    assert_equal( 6, Calc.evaluate( " 3  *  2 " ) )
+    assert_equal( 10, Calc.evaluate( "5 * ( 1 + 1 )" ) )
+    assert_equal( 25, Calc.evaluate( "5 ** ( 1 + 1 )" ) )
+    assert_equal( 0, Calc.evaluate( "5 ** ( 1 + 1 ) / 5 - 5" ) )
+    assert_in_delta( 0.5, Calc.evaluate( "1.0/2" ), 0.0000001 )
+  end
+
+  def test_evaluate_returns_nil_when_given_nil
+    assert_nil( Calc.evaluate( nil ) )
+  end
+
+  def test_evaluate_returns_expression_verbatim_when_given_blank_expression
+    blank_expression = " \r  \n "
+    assert_equal( blank_expression, Calc.evaluate( blank_expression ) )
+    assert_equal( "", Calc.evaluate( "" ) )
+  end
+
+  def test_evaluate_returns_expression_verbatim_when_given_invalid_expression
+    invalid_expression_1 = "2//3"
+    assert_equal( invalid_expression_1, Calc.evaluate( invalid_expression_1 ) )
+    invalid_expression_2 = "2 * (5 + 4"
+    assert_equal( invalid_expression_2, Calc.evaluate( invalid_expression_2 ) )
+  end
+
+  def test_evaluate_is_code_injection_proof
+    payload_1 = "raise 'evil'"
+    assert_nothing_raised do
+      Calc.evaluate( payload_1 )
+    end
+
+    payload_2 = "binding"
+    assert_equal( "binding", Calc.evaluate( payload_2 ) )  # returned verbatim - not evaled
+
+    payload_3 = "__FILE__"
+    assert_equal( "__FILE__", Calc.evaluate( payload_3 ) )
+  end
+
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: calc
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- "Piotr 'Qertoip' W\xC5\x82odarek"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-26 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Calc is safe, simple, pure-ruby mathematical expressions evaluator (calculator) library. Although based on Ruby 'eval', it takes special care to sanitize the expression.
+email: 
+- qertoip@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- calc.gemspec
+- lib/calc.rb
+- lib/calc/version.rb
+- test/calc.rb
+has_rdoc: true
+homepage: http://github.com/qertoip/calc
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: calc
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Calculator (mathematical expressions evaluator) library for Ruby
+test_files: []
+