omghax-einstein 0.1.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.1.0 2008-04-30
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Dray Lacy
+
+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/Manifest.txt

@@ -0,0 +1,31 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/einstein.rb
+lib/einstein/generated_parser.rb
+lib/einstein/nodes.rb
+lib/einstein/parser.rb
+lib/einstein/tokenizer.rb
+lib/einstein/version.rb
+lib/einstein/visitors.rb
+lib/parser.y
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_evaluate.rb
+test/test_helper.rb
+test/test_parser.rb
+test/test_pretty_print.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml

data/README.txt

@@ -0,0 +1,60 @@
+= Einstein
+
+== Description
+
+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 was built as an excercise in language parsing in Ruby. I'm releasing
+it in the hopes that someone will find the code useful, or learn something
+from it...or, better yet, teach me a thing or two about writing parsers :-P
+
+== Examples
+
+To parse an arithmetic expression:
+
+  >> Einstein.evaluate("3 + 4")
+  => 7
+
+You can also use variables:
+
+  >> Einstein.evaluate("x * 3", :x => 2)
+  => 6
+
+You can also have Einstein parse the expression and return the syntax tree:
+
+  >> ast = Einstein.parse("x ** 2")
+  => (x ** 2)
+
+You can then evaluate this tree for different values of x:
+
+  >> ast.evaluate(:x => 2)
+  => 4
+  >> ast.evaluate(:x => 3)
+  => 9
+
+Or you can return an s-expression representation of the tree:
+
+  >> ast.to_sexp
+  => [:raise, [:resolve, "x"], [:lit, 2]]
+
+== Authors
+
+Copyright (c) 2008 by Dray Lacy
+
+== Acknowledgements
+
+Large portions of the parser were taken from the RKelly project by Aaron
+Patterson, which was itself derived from rbnarcissus by Paul Sowden.
+
+Thanks Aaron and Paul!
+
+== License
+
+Einstein is licensed under the MIT License.
+
+:include:License.txt

data/Rakefile

@@ -0,0 +1,20 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }
+
+GENERATED_PARSER = "lib/einstein/generated_parser.rb"
+
+file GENERATED_PARSER => "lib/parser.y" do |t|
+  if ENV['DEBUG']
+    sh "racc -g -v -o #{t.name} #{t.prerequisites.first}"
+  else
+    sh "racc -o #{t.name} #{t.prerequisites.first}"
+  end
+end
+
+task :parser => GENERATED_PARSER
+
+# make sure the parser's up-to-date when we test
+Rake::Task[:test].prerequisites << :parser
+Rake::Task[:check_manifest].prerequisites << :parser

data/config/hoe.rb

@@ -0,0 +1,62 @@
+require 'einstein/version'
+
+AUTHOR = 'Dray Lacy'
+EMAIL = "dray@izea.com"
+DESCRIPTION = "Safe arithmetic parser for Ruby apps"
+GEM_NAME = 'einstein'
+RUBYFORGE_PROJECT = 'einstein'
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+VERS = Einstein::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'einstein documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'einstein'

data/lib/einstein/generated_parser.rb

@@ -0,0 +1,337 @@
+#
+# DO NOT MODIFY!!!!
+# This file is automatically generated by Racc 1.4.5
+# from Racc grammer file "".
+#
+
+require 'racc/parser.rb'
+
+  require "einstein/nodes"
+
+module Einstein
+  class GeneratedParser < Racc::Parser
+
+module_eval(<<'...end parser.y/module_eval...', 'parser.y', 79)
+  include Einstein::Nodes
+...end parser.y/module_eval...
+##### State transition tables begin ###
+
+racc_action_table = [
+     8,    10,    12,    19,    14,    16,     1,     8,    10,    12,
+    19,    14,    16,     1,     8,    10,    12,    45,    14,    16,
+     1,     8,    10,    12,    19,    14,    16,     1,     8,    10,
+    12,    19,    14,    16,     1,     8,    10,    12,    44,    14,
+    16,     1,     8,    10,    12,    32,    14,    16,     1,     8,
+    10,    12,    27,    14,    16,     1,     8,    10,    12,    28,
+    14,    16,     1,     8,    10,    12,    30,    14,    16,     1,
+     8,    10,    12,    27,    14,    16,     1,     8,    10,    12,
+    28,    14,    16,     1,     8,    10,    12,   nil,    14,    16,
+     1,     8,    10,    12,   nil,    14,    16,     1,     8,    10,
+    12,   nil,    14,    16,     1,     8,    10,    12,   nil,    14,
+    16,     1,    20,    21,    22,    20,    21,    22,    20,    21,
+    22,    23,    24,    23,    24,    23,    24,    25,    26,    25,
+    26 ]
+
+racc_action_check = [
+     0,     0,     0,    35,     0,     0,     0,     1,     1,     1,
+     4,     1,     1,     1,    32,    32,    32,    30,    32,    32,
+    32,    28,    28,    28,    36,    28,    28,    28,    27,    27,
+    27,    37,    27,    27,    27,    26,    26,    26,    29,    26,
+    26,    26,    25,    25,    25,    15,    25,    25,    25,    21,
+    21,    21,     9,    21,    21,    21,    12,    12,    12,    11,
+    12,    12,    12,    23,    23,    23,    13,    23,    23,    23,
+    14,    14,    14,    43,    14,    14,    14,    22,    22,    22,
+    46,    22,    22,    22,    16,    16,    16,   nil,    16,    16,
+    16,    19,    19,    19,   nil,    19,    19,    19,    20,    20,
+    20,   nil,    20,    20,    20,    24,    24,    24,   nil,    24,
+    24,    24,    38,    38,    38,     5,     5,     5,    39,    39,
+    39,    40,    40,    41,    41,     6,     6,    42,    42,     7,
+     7 ]
+
+racc_action_pointer = [
+    -5,     2,   nil,   nil,     6,   103,   116,   127,   nil,    37,
+   nil,    43,    51,    66,    65,    28,    79,   nil,   nil,    86,
+    93,    44,    72,    58,   100,    37,    30,    23,    16,    30,
+    17,   nil,     9,   nil,   nil,    -1,    20,    27,   100,   106,
+   112,   114,   125,    58,   nil,   nil,    64 ]
+
+racc_action_default = [
+   -28,   -28,    -6,   -10,   -12,   -16,   -19,   -22,    -2,   -24,
+    -4,   -26,   -28,   -28,   -28,    -1,   -28,    -5,    -9,   -28,
+   -28,   -28,   -28,   -28,   -28,   -28,   -28,   -28,   -28,   -28,
+   -28,    -7,   -28,    -8,   -11,   -13,   -14,   -15,   -17,   -18,
+   -20,   -21,   -23,   -25,    -3,    47,   -27 ]
+
+racc_goto_table = [
+    18,    42,    13,    35,    36,    37,    38,    39,    40,    41,
+    43,    46,   nil,    31,    29,    33,   nil,   nil,    34 ]
+
+racc_goto_check = [
+     5,     9,     1,     6,     6,     6,     7,     7,     8,     8,
+    10,    11,   nil,     5,     1,     5,   nil,   nil,     5 ]
+
+racc_goto_pointer = [
+   nil,     2,   nil,   nil,   nil,    -1,   -17,   -17,   -17,   -26,
+   -18,   -21 ]
+
+racc_goto_default = [
+   nil,   nil,    15,    17,     2,     3,     4,     5,     6,     7,
+     9,    11 ]
+
+racc_reduce_table = [
+  0, 0, :racc_error,
+  1, 19, :_reduce_none,
+  1, 21, :_reduce_2,
+  3, 22, :_reduce_3,
+  1, 22, :_reduce_4,
+  1, 22, :_reduce_none,
+  1, 23, :_reduce_none,
+  2, 23, :_reduce_7,
+  2, 23, :_reduce_8,
+  2, 23, :_reduce_9,
+  1, 24, :_reduce_none,
+  3, 24, :_reduce_11,
+  1, 25, :_reduce_none,
+  3, 25, :_reduce_13,
+  3, 25, :_reduce_14,
+  3, 25, :_reduce_15,
+  1, 26, :_reduce_none,
+  3, 26, :_reduce_17,
+  3, 26, :_reduce_18,
+  1, 27, :_reduce_none,
+  3, 27, :_reduce_20,
+  3, 27, :_reduce_21,
+  1, 28, :_reduce_none,
+  3, 28, :_reduce_23,
+  1, 29, :_reduce_none,
+  3, 29, :_reduce_25,
+  1, 20, :_reduce_none,
+  3, 20, :_reduce_27 ]
+
+racc_reduce_n = 28
+
+racc_shift_n = 47
+
+racc_token_table = {
+  false => 0,
+  :error => 1,
+  :LSHIFT => 2,
+  :RSHIFT => 3,
+  :RAISE => 4,
+  :NUMBER => 5,
+  :IDENT => 6,
+  "(" => 7,
+  ")" => 8,
+  "+" => 9,
+  "-" => 10,
+  "~" => 11,
+  "*" => 12,
+  "/" => 13,
+  "%" => 14,
+  "&" => 15,
+  "^" => 16,
+  "|" => 17 }
+
+racc_nt_base = 18
+
+racc_use_result_var = true
+
+Racc_arg = [
+  racc_action_table,
+  racc_action_check,
+  racc_action_default,
+  racc_action_pointer,
+  racc_goto_table,
+  racc_goto_check,
+  racc_goto_default,
+  racc_goto_pointer,
+  racc_nt_base,
+  racc_reduce_table,
+  racc_token_table,
+  racc_shift_n,
+  racc_reduce_n,
+  racc_use_result_var ]
+
+Racc_token_to_s_table = [
+  "$end",
+  "error",
+  "LSHIFT",
+  "RSHIFT",
+  "RAISE",
+  "NUMBER",
+  "IDENT",
+  "\"(\"",
+  "\")\"",
+  "\"+\"",
+  "\"-\"",
+  "\"~\"",
+  "\"*\"",
+  "\"/\"",
+  "\"%\"",
+  "\"&\"",
+  "\"^\"",
+  "\"|\"",
+  "$start",
+  "Statement",
+  "BitwiseOrExpr",
+  "Literal",
+  "PrimaryExpr",
+  "UnaryExpr",
+  "ExponentExpr",
+  "MultiplicativeExpr",
+  "AdditiveExpr",
+  "ShiftExpr",
+  "BitwiseAndExpr",
+  "BitwiseXorExpr" ]
+
+Racc_debug_parser = false
+
+##### State transition tables end #####
+
+# reduce 0 omitted
+
+# reduce 1 omitted
+
+module_eval(<<'.,.,', 'parser.y', 19)
+  def _reduce_2(val, _values, result)
+     result = NumberNode.new(val.first) 
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.y', 23)
+  def _reduce_3(val, _values, result)
+     result = val[1] 
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.y', 24)
+  def _reduce_4(val, _values, result)
+     result = ResolveNode.new(val.first) 
+    result
+  end
+.,.,
+
+# reduce 5 omitted
+
+# reduce 6 omitted
+
+module_eval(<<'.,.,', 'parser.y', 30)
+  def _reduce_7(val, _values, result)
+     result = UnaryPlusNode.new(val[1]) 
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.y', 31)
+  def _reduce_8(val, _values, result)
+     result = UnaryMinusNode.new(val[1]) 
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.y', 32)
+  def _reduce_9(val, _values, result)
+     result = BitwiseNotNode.new(val[1]) 
+    result
+  end
+.,.,
+
+# reduce 10 omitted
+
+module_eval(<<'.,.,', 'parser.y', 37)
+  def _reduce_11(val, _values, result)
+     result = ExponentNode.new(val[0], val[2]) 
+    result
+  end
+.,.,
+
+# reduce 12 omitted
+
+module_eval(<<'.,.,', 'parser.y', 42)
+  def _reduce_13(val, _values, result)
+     result = MultiplyNode.new(val[0], val[2]) 
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.y', 43)
+  def _reduce_14(val, _values, result)
+     result = DivideNode.new(val[0], val[2]) 
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.y', 44)
+  def _reduce_15(val, _values, result)
+     result = ModulusNode.new(val[0], val[2]) 
+    result
+  end
+.,.,
+
+# reduce 16 omitted
+
+module_eval(<<'.,.,', 'parser.y', 49)
+  def _reduce_17(val, _values, result)
+     result = AddNode.new(val[0], val[2]) 
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.y', 50)
+  def _reduce_18(val, _values, result)
+     result = SubtractNode.new(val[0], val[2]) 
+    result
+  end
+.,.,
+
+# reduce 19 omitted
+
+module_eval(<<'.,.,', 'parser.y', 55)
+  def _reduce_20(val, _values, result)
+     result = LeftShiftNode.new(val[0], val[2]) 
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.y', 56)
+  def _reduce_21(val, _values, result)
+     result = RightShiftNode.new(val[0], val[2]) 
+    result
+  end
+.,.,
+
+# reduce 22 omitted
+
+module_eval(<<'.,.,', 'parser.y', 61)
+  def _reduce_23(val, _values, result)
+     result = BitwiseAndNode.new(val[0], val[2]) 
+    result
+  end
+.,.,
+
+# reduce 24 omitted
+
+module_eval(<<'.,.,', 'parser.y', 66)
+  def _reduce_25(val, _values, result)
+     result = BitwiseXorNode.new(val[0], val[2]) 
+    result
+  end
+.,.,
+
+# reduce 26 omitted
+
+module_eval(<<'.,.,', 'parser.y', 71)
+  def _reduce_27(val, _values, result)
+     result = BitwiseOrNode.new(val[0], val[2]) 
+    result
+  end
+.,.,
+
+def _reduce_none(val, _values, result)
+  val[0]
+end
+
+  end   # class GeneratedParser
+  end   # module Einstein