omghax-einstein 0.1.0

data/tasks/deployment.rake

@@ -0,0 +1,34 @@
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+desc 'Install the package as a gem, without generating documentation(ri/rdoc)'
+task :install_gem_no_doc => [:clean, :package] do
+  sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"
+end
+
+namespace :manifest do
+  desc 'Recreate Manifest.txt to include ALL files'
+  task :refresh do
+    `rake check_manifest | patch -p0 > Manifest.txt`
+  end
+end

data/tasks/environment.rake

@@ -0,0 +1,7 @@
+task :ruby_env do
+  RUBY_APP = if RUBY_PLATFORM =~ /java/
+    "jruby"
+  else
+    "ruby"
+  end unless defined? RUBY_APP
+end

data/tasks/website.rake

@@ -0,0 +1,17 @@
+desc 'Generate website files'
+task :website_generate => :ruby_env do
+  (Dir['website/**/*.txt'] - Dir['website/version*.txt']).each do |txt|
+    sh %{ #{RUBY_APP} script/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  host = "#{rubyforge_username}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{PATH}/"
+  local_dir = 'website'
+  sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload, :publish_docs]

data/test/test_evaluate.rb

@@ -0,0 +1,119 @@
+require File.dirname(__FILE__) + "/test_helper"
+require "logger"
+
+class TestEvaluate < Test::Unit::TestCase
+  def setup
+    @parser = Einstein::Parser.new
+    @parser.logger = Logger.new(STDERR)
+  end
+
+  def test_parentheses
+    assert_equal((5 + 2) * (10 - 5), parse("(5 + 2) * (10 - 5)").evaluate)
+  end
+
+  def test_order_of_operations
+    assert_equal(3 + 4 * 2, parse("3 + 4 * 2").evaluate)
+    assert_equal(7 + 9 * 2 - 16 / 8, parse("7 + 9 * 2 - 16 / 8").evaluate)
+  end
+
+  def test_resolve_should_raise_on_undefined_variable
+    assert_raises(Einstein::ResolveError) { parse("x").evaluate }
+  end
+
+  def test_resolve
+    assert_equal(5, parse("x").evaluate(:x => 5))
+    assert_equal(5 + 5, parse("x + 5").evaluate(:x => 5))
+    assert_equal(4 * 4, parse("x * 4").evaluate(:x => 4))
+  end
+
+  def test_bitwise_or
+    assert_equal(0b1100 | 0b1111, parse("0b1100 | 0b1111").evaluate)
+  end
+
+  def test_bitwise_xor
+    assert_equal(0b1100 ^ 0b1111, parse("0b1100 ^ 0b1111").evaluate)
+  end
+
+  def test_bitwise_and
+    assert_equal(0b1100 & 0b1111, parse("0b1100 & 0b1111").evaluate)
+  end
+
+  def test_subtraction
+    assert_equal(10 - 5, parse("10 - 5").evaluate)
+    assert_equal(5 - 10, parse("5 - 10").evaluate)
+  end
+
+  def test_addition
+    assert_equal(1 + 2, parse("1 + 2").evaluate)
+    assert_equal(1.0 + 2.0, parse("1.0 + 2.0").evaluate)
+  end
+
+  def test_modulus
+    assert_equal(5 % 10, parse("5 % 10").evaluate)
+    assert_equal(10 % 5, parse("10 % 5").evaluate)
+  end
+
+  def test_division_should_raise_on_divide_by_zero
+    assert_raises(Einstein::ZeroDivisionError) { parse("1 / 0").evaluate }
+  end
+
+  def test_division
+    assert_equal(10 / 5, parse("10 / 5").evaluate)
+    assert_equal(10.0 / 5.0, parse("10.0 / 5.0").evaluate)
+  end
+
+  def test_multiplication
+    assert_equal(5 * 10, parse("5 * 10").evaluate)
+    assert_equal(5.0 * 10.0, parse("5.0 * 10.0").evaluate)
+  end
+
+  def test_exponent
+    assert_equal(5 ** 2, parse("5 ** 2").evaluate)
+  end
+
+  def test_float
+    assert_equal(1.1, parse("1.1").evaluate)
+  end
+
+  def test_number_base2
+    assert_equal(0b0, parse("0b0").evaluate)
+    assert_equal(0b1111, parse("0b1111").evaluate)
+    assert_equal(0B1010, parse("0B1010").evaluate)
+
+    assert_equal(+0b1111, parse("+0b1111").evaluate)
+    assert_equal(+0B1010, parse("+0B1010").evaluate)
+
+    assert_equal(-0b1111, parse("-0b1111").evaluate)
+    assert_equal(-0B1010, parse("-0B1010").evaluate)
+  end
+
+  def test_number_base16
+    assert_equal(0x0, parse("0x0").evaluate)
+    assert_equal(0xff, parse("0xff").evaluate)
+    assert_equal(0XFF, parse("0XFF").evaluate)
+
+    assert_equal(+0xff, parse("+0xff").evaluate)
+    assert_equal(+0XFF, parse("+0XFF").evaluate)
+
+    assert_equal(-0xff, parse("-0xff").evaluate)
+    assert_equal(-0XFF, parse("-0XFF").evaluate)
+  end
+
+  def test_number_base10
+    assert_equal(0, parse("0").evaluate)
+    assert_equal(1, parse("01").evaluate)
+    assert_equal(10, parse("10").evaluate)
+
+    assert_equal(+1, parse("+1").evaluate)
+    assert_equal(+10, parse("+10").evaluate)
+
+    assert_equal(-1, parse("-1").evaluate)
+    assert_equal(-10, parse("-10").evaluate)
+  end
+
+  private
+
+  def parse(stmt)
+    @parser.parse(stmt)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/einstein'

data/test/test_parser.rb

@@ -0,0 +1,122 @@
+require File.dirname(__FILE__) + "/test_helper"
+require "logger"
+
+class TestParser < Test::Unit::TestCase
+  def setup
+    @parser = Einstein::Parser.new
+    @parser.logger = Logger.new(STDERR)
+  end
+
+  def test_parentheses
+    assert_equal \
+      [:multiply, 
+        [:add, [:lit, 5], [:lit, 2]],
+        [:subtract, [:lit, 10], [:lit, 5]]
+      ],
+      parse("(5 + 2) * (10 - 5)").to_sexp
+  end
+
+  def test_order_of_operations
+    assert_equal \
+      [:subtract,
+        [:add,
+          [:divide, [:lit, 6], [:lit, 3]],
+          [:multiply, [:lit, 4], [:lit, 2]]],
+        [:lit, 5]
+      ],
+      parse("6 / 3 + 4 * 2 - 5").to_sexp
+  end
+
+  def test_resolve
+    assert_equal [:resolve, "x"], parse("x").to_sexp
+  end
+
+  def test_bitwise_or
+    assert_equal [:bitwise_or, [:lit, 5], [:lit, 10]], parse("5 | 10").to_sexp
+  end
+
+  def test_bitwise_xor
+    assert_equal [:bitwise_xor, [:lit, 5], [:lit, 10]], parse("5 ^ 10").to_sexp
+  end
+
+  def test_bitwise_and
+    assert_equal [:bitwise_and, [:lit, 5], [:lit, 10]], parse("5 & 10").to_sexp
+  end
+
+  def test_rshift
+    assert_equal [:rshift, [:lit, 2], [:lit, 3]], parse("2 >> 3").to_sexp
+  end
+
+  def test_lshift
+    assert_equal [:lshift, [:lit, 2], [:lit, 3]], parse("2 << 3").to_sexp
+  end
+
+  def test_subtraction
+    assert_equal [:subtract, [:lit, 2], [:lit, 1]], parse("2 - 1").to_sexp
+  end
+
+  def test_addition
+    assert_equal [:add, [:lit, 1], [:lit, 2]], parse("1 + 2").to_sexp
+  end
+
+  def test_modulus
+    assert_equal [:modulus, [:lit, 10], [:lit, 5]], parse("10 % 5").to_sexp
+  end
+
+  def test_division
+    assert_equal [:divide, [:lit, 10], [:lit, 5]], parse("10 / 5").to_sexp
+  end
+
+  def test_multiplication
+    assert_equal [:multiply, [:lit, 5], [:lit, 10]], parse("5 * 10").to_sexp
+  end
+
+  def test_exponent
+    assert_equal [:raise, [:lit, 5], [:lit, 2]], parse("5 ** 2").to_sexp
+    assert_equal [:raise, [:lit, 3], [:u_minus, [:lit, 6]]], parse("3 ** -6").to_sexp
+    assert_equal [:raise, [:lit, 18], [:bitwise_not, [:lit, 4]]], parse("18 ** ~4").to_sexp
+  end
+
+  def test_unary_bitwise_not
+    assert_equal [:bitwise_not, [:lit, 10]], parse("~10").to_sexp
+  end
+
+  def test_unary_minus
+    assert_equal [:u_minus, [:lit, 10]], parse("-10").to_sexp
+  end
+
+  def test_unary_plus
+    assert_equal [:u_plus, [:lit, 10]], parse("+10").to_sexp
+  end
+
+  def test_float_scientific
+    assert_equal [:lit, 10.10e-3], parse("10.10e-3").to_sexp
+  end
+
+  def test_float
+    assert_equal [:lit, 10.10], parse("10.10").to_sexp
+  end
+
+  def test_number_base2
+    assert_equal [:lit, 0b1010], parse("0b1010").to_sexp
+  end
+
+  def test_number_base8
+    assert_equal [:lit, 011], parse("011").to_sexp
+  end
+
+  def test_number_base16
+    assert_equal [:lit, 0xdeadbeef], parse("0xdeadbeef").to_sexp
+    assert_equal [:lit, 0xCAFEBABE], parse("0xCAFEBABE").to_sexp
+  end
+
+  def test_number_base10
+    assert_equal [:lit, 15], parse("15").to_sexp
+  end
+
+  private
+
+  def parse(stmt)
+    @parser.parse(stmt)
+  end
+end

data/test/test_pretty_print.rb

@@ -0,0 +1,111 @@
+require File.dirname(__FILE__) + "/test_helper"
+require "logger"
+
+class TestPrettyPrint < Test::Unit::TestCase
+  def setup
+    @parser = Einstein::Parser.new
+    @parser.logger = Logger.new(STDERR)
+  end
+
+  def test_parentheses
+    assert_equal "((5 + 2) * (10 - 5))", parse("(5 + 2) * (10 - 5)").inspect
+  end
+
+  def test_order_of_operations
+    assert_equal "(3 + (4 * 2))", parse("3 + 4 * 2").inspect
+    assert_equal "((7 + (9 * 2)) - (16 / 8))", parse("7 + 9 * 2 - 16 / 8").inspect
+  end
+
+  def test_resolve
+    assert_equal "x", parse("x").inspect
+    assert_equal "(x + 5)", parse("x + 5").inspect
+    assert_equal "(x * 4)", parse("x * 4").inspect
+  end
+
+  def test_bitwise_or
+    assert_equal "(12 | 15)", parse("0b1100 | 0b1111").inspect
+  end
+
+  def test_bitwise_xor
+    assert_equal "(12 ^ 15)", parse("0b1100 ^ 0b1111").inspect
+  end
+
+  def test_bitwise_and
+    assert_equal "(12 & 15)", parse("0b1100 & 0b1111").inspect
+  end
+
+  def test_subtraction
+    assert_equal "(10 - 5)", parse("10 - 5").inspect
+    assert_equal "(5 - 10)", parse("5 - 10").inspect
+  end
+
+  def test_addition
+    assert_equal "(1 + 2)", parse("1 + 2").inspect
+    assert_equal "(1.0 + 2.0)", parse("1.0 + 2.0").inspect
+  end
+
+  def test_modulus
+    assert_equal "(5 % 10)", parse("5 % 10").inspect
+    assert_equal "(10 % 5)", parse("10 % 5").inspect
+  end
+
+  def test_division
+    assert_equal "(10 / 5)", parse("10 / 5").inspect
+    assert_equal "(10.0 / 5.0)", parse("10.0 / 5.0").inspect
+  end
+
+  def test_multiplication
+    assert_equal "(5 * 10)", parse("5 * 10").inspect
+    assert_equal "(5.0 * 10.0)", parse("5.0 * 10.0").inspect
+  end
+
+  def test_exponent
+    assert_equal "(5 ** 2)", parse("5 ** 2").inspect
+  end
+
+  def test_float
+    assert_equal "1.1", parse("1.1").inspect
+  end
+
+  def test_number_base2
+    assert_equal "0", parse("0b0").inspect
+    assert_equal "15", parse("0b1111").inspect
+    assert_equal "10", parse("0B1010").inspect
+
+    assert_equal "+15", parse("+0b1111").inspect
+    assert_equal "+10", parse("+0B1010").inspect
+
+    assert_equal "-15", parse("-0b1111").inspect
+    assert_equal "-10", parse("-0B1010").inspect
+  end
+
+  def test_number_base16
+    assert_equal "0", parse("0x0").inspect
+    assert_equal "255", parse("0xff").inspect
+    assert_equal "255", parse("0XFF").inspect
+
+    assert_equal "+255", parse("+0xff").inspect
+    assert_equal "+255", parse("+0XFF").inspect
+
+    assert_equal "-255", parse("-0xff").inspect
+    assert_equal "-255", parse("-0XFF").inspect
+  end
+
+  def test_number_base10
+    assert_equal "0", parse("0").inspect
+    assert_equal "1", parse("01").inspect
+    assert_equal "10", parse("10").inspect
+
+    assert_equal "+1", parse("+1").inspect
+    assert_equal "+10", parse("+10").inspect
+
+    assert_equal "-1", parse("-1").inspect
+    assert_equal "-10", parse("-10").inspect
+  end
+
+  private
+
+  def parse(stmt)
+    @parser.parse(stmt)
+  end
+end

data/website/index.html

@@ -0,0 +1,120 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" />
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>
+      einstein
+  </title>
+  <script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script>
+<style>
+
+</style>
+  <script type="text/javascript">
+    window.onload = function() {
+      settings = {
+          tl: { radius: 10 },
+          tr: { radius: 10 },
+          bl: { radius: 10 },
+          br: { radius: 10 },
+          antiAlias: true,
+          autoPad: true,
+          validTags: ["div"]
+      }
+      var versionBox = new curvyCorners(settings, document.getElementById("version"));
+      versionBox.applyCornersToAll();
+    }
+  </script>
+</head>
+<body>
+<div id="main">
+
+    <h1>einstein</h1>
+    <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/einstein"; return false'>
+      <p>Get Version</p>
+      <a href="http://rubyforge.org/projects/einstein" class="numbers">0.1.0</a>
+    </div>
+    <h2>What</h2>
+
+
+	<p>The Einstein library provides a simple arithmetic parser for Ruby apps. Sure,
+you could just use eval, but then you&#8217;re opening yourself up to a world of
+hurt when you accept code from untrusted sources (ie. your users). With
+Einstein, you get a safe, &#8220;locked-down&#8221; arithmetic parser and evaluator that
+can&#8217;t run system commands or otherwise hose your server in the event of a
+malicious code snippet.</p>
+
+
+	<p>Einstein is a fun little exercise in building a parser, and I&#8217;m releasing it
+in the hopes that someone will find it useful.</p>
+
+
+	<h2>Installing</h2>
+
+
+<pre>sudo gem install einstein</pre>
+
+	<h2>The basics</h2>
+
+
+	<p>If you&#8217;re only interested in evaluating expressions, you can simply call
+Einstein.evaluate:</p>
+
+
+	<p><pre class='syntax'><span class="constant">Einstein</span><span class="punct">.</span><span class="ident">evaluate</span><span class="punct">(&quot;</span><span class="string">1 + 2 + 3</span><span class="punct">&quot;)</span> <span class="comment"># =&gt; 6</span></pre></p>
+
+
+	<p>You can use variables as well, but you must supply their values:</p>
+
+
+	<p><pre class='syntax'>
+<span class="constant">Einstein</span><span class="punct">.</span><span class="ident">evaluate</span><span class="punct">(&quot;</span><span class="string">x * 4</span><span class="punct">&quot;,</span> <span class="symbol">:x</span> <span class="punct">=&gt;</span> <span class="number">5</span><span class="punct">)</span> <span class="comment"># =&gt; 20</span>
+<span class="constant">Einstein</span><span class="punct">.</span><span class="ident">evaluate</span><span class="punct">(&quot;</span><span class="string">x + y + z</span><span class="punct">&quot;,</span> <span class="symbol">:x</span> <span class="punct">=&gt;</span> <span class="number">3</span><span class="punct">,</span> <span class="symbol">:y</span> <span class="punct">=&gt;</span> <span class="number">4</span><span class="punct">,</span> <span class="symbol">:z</span> <span class="punct">=&gt;</span> <span class="number">5</span><span class="punct">)</span> <span class="comment"># =&gt; 12</span>
+</pre></p>
+
+
+	<h2>How to submit patches</h2>
+
+
+	<p>First, if you haven&#8217;t already, read the <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/">8 steps for fixing other people&#8217;s
+code</a></p>
+
+
+	<p>The best way to submit a patch is to fork the project on
+<a href="http://github.com">GitHub</a> and make your changes. When you&#8217;ve finished, issue
+a pull request to let me know about the changes you&#8217;ve made.</p>
+
+
+	<h2>Repository access</h2>
+
+
+	<p>The repository is <code>git://github.com/omghax/einstein.git</code> for
+anonymous access. <a href="http://github.com/omghax/einstein/tree/master">GitHub</a> also
+offers a .tgz file download for those of you who don&#8217;t have git installed
+(shame on you).</p>
+
+
+	<h2>License</h2>
+
+
+	<p>This code is free to use under the terms of the <span class="caps">MIT</span> license.</p>
+
+
+	<h2>Contact</h2>
+
+
+	<p>Comments are welcome. Send a message to omghax on
+<a href="http://github.com/omghax">GitHub</a>. Better yet, create your own fork of
+Einstein and take it to crazy new places. If I like your changes, I&#8217;ll merge
+them into the master branch.</p>
+    <p class="coda">
+      <a href="http://github.com/omghax">Dray Lacy</a>, 29th April 2008<br>
+      Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
+    </p>
+</div>
+
+<!-- insert site tracking codes here, like Google Urchin -->
+
+</body>
+</html>

data/website/index.txt

@@ -0,0 +1,58 @@
+h1. einstein
+
+h2. What
+
+The Einstein library provides a simple arithmetic parser for Ruby apps. Sure,
+you could just use eval, but then you're opening yourself up to a world of
+hurt when you accept code from untrusted sources (ie. your users). With
+Einstein, you get a safe, "locked-down" arithmetic parser and evaluator that
+can't run system commands or otherwise hose your server in the event of a
+malicious code snippet.
+
+Einstein is a fun little exercise in building a parser, and I'm releasing it
+in the hopes that someone will find it useful.
+
+h2. Installing
+
+<pre>sudo gem install einstein</pre>
+
+h2. The basics
+
+If you're only interested in evaluating expressions, you can simply call
+Einstein.evaluate:
+
+<pre syntax="ruby">Einstein.evaluate("1 + 2 + 3") # => 6</pre>
+
+You can use variables as well, but you must supply their values:
+
+<pre syntax="ruby">
+Einstein.evaluate("x * 4", :x => 5) # => 20
+Einstein.evaluate("x + y + z", :x => 3, :y => 4, :z => 5) # => 12
+</pre>
+
+h2. How to submit patches
+
+First, if you haven't already, read the "8 steps for fixing other people's
+code":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/
+
+The best way to submit a patch is to fork the project on
+"GitHub":http://github.com and make your changes. When you've finished, issue
+a pull request to let me know about the changes you've made.
+
+h2. Repository access
+
+The repository is <code>git://github.com/omghax/einstein.git</code> for
+anonymous access. "GitHub":http://github.com/omghax/einstein/tree/master also
+offers a .tgz file download for those of you who don't have git installed
+(shame on you).
+
+h2. License
+
+This code is free to use under the terms of the MIT license. 
+
+h2. Contact
+
+Comments are welcome. Send a message to omghax on
+"GitHub":http://github.com/omghax. Better yet, create your own fork of
+Einstein and take it to crazy new places. If I like your changes, I'll merge
+them into the master branch.