sexpistol 0.0.6 → 0.1.2

data/README.rdoc

@@ -1,73 +0,0 @@
-= Sexpistol
-
-Sexpistol is a simple library for parsing S-Expressions in Ruby. Sexpistol takes an S-Expression and turns it into a native Ruby data structure made up of nested sets of arrays.
-
-=== Example
-
-  (define test (lambda () (
-    (print "Hello world!\n")
-    (print 1)
-    (print 9.01)
-    (print 2.0e10)
-    (print (+ 10 12 13))
-  )))
-  
-would be parsed by Sexpistol like so:
-
-  [:define, :test, [:lambda, [], [
-    [:print, "Hello world!\n"],
-    [:print, 1],
-    [:print, 9.01],
-    [:print, 2.0e10],
-    [:print, [:+, 10, 12, 13]]
-  ]]]
-  
-=== Type mappings
-
-Sexpistol supports all of the standard datatypes and converts them directly to their Ruby equivalents:
-
-* Lists (a b c)
-* Integers (1 2 3)
-* Floats (1.0 2.0 42.9 3e6 1.2e2)
-* Strings ("\t\"Hello world!\"\n")
-* Symbols (symbol Symbol ____symbol____ symbo_l symbol? symbol! + - / ++ a+ e$, etc...)
-
-Sexpistol also supports mapping the Ruby keyword literals (nil, true, false) to their native Ruby types, although this is disabled by default for compatibility. To enable it use `@parser.ruby_keyword_literals = true`, eg:
-  
-  @parser = Sexpistol.new
-  @parser.parse_string("nil false true")
-  #=> [:nil, :false, :true]
-  
-  @parser.ruby_keyword_literals = true
-  @parser.parse_string("nil false true")
-  #=> [nil, false, true]
-  
-=== Installation
-
-For convenience Sexpistol is packaged as a RubyGem, to install it simply enter the following at your command line:
-
-  gem install sexpistol
-  
-=== Usage
-
-  # Create a new parser instance
-  @parser = Sexpistol.new
-  
-  # Parse a string
-  ast = @parser.parse_string("(string (to (parse)))")
-  #=> [:string, [:to, [:parse]]]
-  
-  # Change the representation
-  ast[1][0] = :is
-  ast[1][1][0] = :parsed
-  #=> [:string, [:is, [:parsed]]]
-  
-  # Turn the array structure back into an S-Expression
-  @parser.to_sexp( ast )
-  #=> "( string ( is ( parsed ) ) )"
-  
-=== Author & Credits
-
-Author:: {Aaron Gough}[mailto:aaron@aarongough.com]
-
-Copyright (c) 2010 {Aaron Gough}[http://thingsaaronmade.com/] ({thingsaaronmade.com}[http://thingsaaronmade.com/]), released under the MIT license

data/Rakefile

@@ -1,42 +0,0 @@
-require 'rake'
-require 'rake/testtask'
-require 'rake/rdoctask'
-
-desc 'Default: run unit tests.'
-task :default => :test
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gemspec|
-    gemspec.name = "sexpistol"
-    gemspec.summary = "An S-Expression Parser Library for Ruby"
-    gemspec.description = "Sexpistol is an easy-to-use S-Expression parser for Ruby. It is fast and has no dependencies."
-    gemspec.email = "aaron@aarongough.com"
-    gemspec.homepage = "http://github.com/aarongough/sexpistol"
-    gemspec.authors = ["Aaron Gough"]
-    gemspec.rdoc_options << '--line-numbers' << '--inline-source'
-    gemspec.extra_rdoc_files = ['README.rdoc', 'MIT-LICENSE']
-  end
-rescue LoadError
-  puts "Jeweler not available. Install it with: gem install jeweler"
-end
-
-
-desc 'Test sexpistol.'
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib/*.rb'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = true
-end
-
-
-desc 'Generate documentation for sexpistol.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Koi'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-  rdoc.rdoc_files.include('app/**/*.rb')
-end

data/VERSION

@@ -1 +0,0 @@
-0.0.6

data/lib/sexpistol/sexpistol.rb

@@ -1,154 +0,0 @@
-# This class contains our logic for parsing
-# S-Expressions. They are turned into a 
-# native Ruby representation like:
-#   [:def, :something [:lambda, [:a], [:do_something]]]
-class Sexpistol
-
-  attr_accessor :ruby_keyword_literals
-
-  def initialize
-    @ruby_keyword_literals = false
-    
-    # Setup all of our token patterns as instance variables
-    # so they don't have to be re-instantiated for each
-    # run & match
-    @string_literal_pattern = /"([^"\\]|\\.)*"/
-    @integer_literal_pattern = /[\-\+]?[0-9]+/
-    @float_literal_pattern = /[\-\+]?[0-9]+\.[0-9]+(e[0-9]+)?/
-    @symbol_pattern = /[^\"\'\,\(\)]+/
-    
-    @string_replacement_token = "__++STRING_LITERAL++__"
-  end
-
-  # Parse a string containing an S-Expression into a
-  # nested set of Ruby arrays
-  def parse_string( string )
-    string_array = split_outside_strings(string)
-    tokens = process_tokens( string_array )
-    structure( tokens )[1]
-  end
-
-  # Iterate over an array of strings and turn each
-  # item into it's relevant token. ie: "string" -> :string, "1" -> 1
-  def process_tokens( token_array )
-    tokens = []
-    token_array.each do |t|
-      if(@ruby_keyword_literals)
-        tokens << nil and next if(t == "nil")
-        tokens << true and next if(t == "true")
-        tokens << false and next if(t == "false")
-      end
-      tokens << "'" and next if(t == "'")
-      tokens << t and next if(t == "(" || t == ")")
-      tokens << t.to_f and next if( is_float?(t))
-      tokens << t.to_i and next if( is_integer?(t))
-      tokens << t.to_sym and next if( is_symbol?(t))
-      tokens << eval(t) and next if( is_string_literal?(t))
-      raise "\nUnrecognized token: #{t}\n"
-    end
-    return tokens
-  end
-
-  # Iterate over a flat array of tokens and turn it
-  # a nested set of arrays by detecting '(' and ')'
-  def structure( token_array, offset = 0, internal = false )
-    program = []
-    while(offset < token_array.length)
-      if( token_array[offset] == "(" )
-        offset, array = structure( token_array, offset + 1, true )
-        program << array
-      elsif( token_array[offset] == "'" )  
-        offset, array = structure( token_array, offset + 1, true )
-        program << array.unshift( :quote )
-      elsif( token_array[offset] == ")" )
-        break  
-      else
-        program << token_array[offset]
-      end
-      offset += 1
-    end
-    return [offset, program]
-  end
-  
-  # Split up a string into an array where delimited by whitespace,
-  # except inside string literals
-  def split_outside_strings( string )
-    # Find and extract all the string literals
-    string_literals = []
-    string = string.gsub(@string_literal_pattern) do |x| 
-      string_literals << x
-      @string_replacement_token
-    end
-    # Make sure the s-expression is valid
-    unless( string.count("(") == string.count(")") )
-      raise Exception, "Invalid S-Expression. The number of opening and closing parentheses does not match."
-    end
-    # Split the string up on whitespace and parentheses
-    array = string.gsub("(", " ( ").gsub(")", " ) ").split(" ")
-    # replace the special string token with the original string literals
-    array.collect! do |x|
-      if( x == @string_replacement_token)
-        string_literals.shift
-      else
-        x
-      end
-    end
-    return array
-  end
-
-  # Test to see whether or not a string represents an integer
-  def is_integer?( string )
-    is_match?( string, @integer_literal_pattern )
-  end
-  
-  # Test to see whether or not a string represents a float
-  def is_float?( string )
-    is_match?( string, @float_literal_pattern )
-  end
-
-  # Test to see whether or not a string represents a symbol
-  def is_symbol?( string )
-    is_match?( string, @symbol_pattern )
-  end
-  
-  # Test to see whether or not a string represents a string literal
-  def is_string_literal?( string )
-    is_match?( string, @string_literal_pattern )
-  end
-  
-  # Convert a set of nested arrays back into an S-Expression
-  def to_sexp( data )
-    if( data.is_a?(Array))
-      mapped = data.map do |item|
-        if( item.is_a?(Array))
-          to_sexp(item)
-        else
-          if(item === false)
-            "#f"
-          elsif(item === true)
-            "#t"
-          else
-            item.to_s
-          end
-        end
-      end
-      "(" + mapped.join(" ") + ")"
-    else
-      if(data === false)
-        "#f"
-      elsif(data === true)
-        "#t"
-      else
-        data.to_s
-      end
-    end
-  end
-
-  private
-
-    def is_match?( string, pattern )
-      match = string.match(pattern)
-      return false unless match
-      match[0].length == string.length
-    end
-end

data/test/performance/benchmark_test.rb

@@ -1,34 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'test_helper.rb'))
-
-class BenchmarkTest < Test::Unit::TestCase
-
-  require 'benchmark'
-
-  test "benchmark sexpistol" do
-    puts "\nRunning performance test...\n"
-    parser = Sexpistol.new
-    parser.ruby_keyword_literals = true
-    Benchmark.bmbm do |b|
-      b.report do
-        5000.times do
-          parser.parse_string <<-EOD
-          
-            (display "This is a test string!")
-            
-            (define test (lambda () (begin
-              (display (== 1 1))
-              (display (== true true))
-              (display (== false false))
-              (display (== nil nil))
-              (display (== 2.09 1.08))
-              (display (== 2e6 2e12))
-            )))
-            
-          EOD
-        end
-      end
-    end
-    puts
-  end    
-    
-end

data/test/setup/test_unit_extensions.rb

@@ -1,21 +0,0 @@
-module Test::Unit
-  # Used to fix a minor minitest/unit incompatibility in flexmock
-  AssertionFailedError = Class.new(StandardError)
-  
-  class TestCase
-   
-    def self.test(name, &block)
-      test_name = "test_#{name.gsub(/\s+/,'_')}".to_sym
-      defined = instance_method(test_name) rescue false
-      raise "#{test_name} is already defined in #{self}" if defined
-      if block_given?
-        define_method(test_name, &block)
-      else
-        define_method(test_name) do
-          flunk "No implementation provided for #{name}"
-        end
-      end
-    end
-
-  end
-end

data/test/test_helper.rb

@@ -1,10 +0,0 @@
-require 'rubygems'
-require 'test/unit'
-
-require_files = []
-require_files << File.join(File.dirname(__FILE__), '..', 'lib', 'sexpistol.rb')
-require_files.concat Dir[File.join(File.dirname(__FILE__), 'setup', '*.rb')]
-
-require_files.each do |file|
-  require File.expand_path(file)
-end

data/test/unit/float_literal_test.rb

@@ -1,35 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'test_helper.rb'))
-
-class FloatLiteralTest < Test::Unit::TestCase
-
-  def setup
-    @parser = Sexpistol.new
-  end
-
-  test "should parse sexp containing an implicitly positive float literal" do
-    ast = @parser.parse_string("10.00")
-    assert_equal [10.00], ast
-  end
-  
-  test "should parse sexp containing an explicitly positive float literal" do
-    ast = @parser.parse_string("+910.00")
-    assert_equal [910.00], ast
-  end
-  
-  test "should parse sexp containing an explicitly negative float literal" do
-    ast = @parser.parse_string("-10.00")
-    assert_equal [-10.00], ast
-  end
-  
-  test "should parse sexp containing a large float literal" do
-    ast = @parser.parse_string("1.0000127829")
-    assert_equal [1.0000127829], ast
-  end
-  
-  test "should parse sexp containing a float defined in scientific notation" do
-    ast = @parser.parse_string("1.0e6")
-    assert_equal [1.0e6], ast
-  end
-    
-    
-end

data/test/unit/integer_literal_test.rb

@@ -1,24 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'test_helper.rb'))
-
-class IntegerLiteralTest < Test::Unit::TestCase
-
-  def setup
-    @parser = Sexpistol.new
-  end
-
-  test "should parse sexp containing an implicitly positive integer literal" do
-    ast = @parser.parse_string("10")
-    assert_equal [10], ast
-  end
-  
-  test "should parse sexp containing an explicitly positive integer literal" do
-    ast = @parser.parse_string("+910")
-    assert_equal [910], ast
-  end
-  
-  test "should parse sexp containing an explicitly negative integer literal" do
-    ast = @parser.parse_string("-10")
-    assert_equal [-10], ast
-  end
-    
-end

data/test/unit/ruby_keyword_literals_test.rb

@@ -1,45 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'test_helper.rb'))
-
-class RubyKeywordLiteralsTest < Test::Unit::TestCase
-
-  def setup
-    @parser = Sexpistol.new
-  end
-
-  test "should parse nil as literal" do
-    @parser.ruby_keyword_literals = true
-    ast = @parser.parse_string('nil')
-    assert_equal [nil], ast
-  end
-  
-  test "should not parse nil as literal" do
-    @parser.ruby_keyword_literals = false
-    ast = @parser.parse_string('nil')
-    assert_equal [:nil], ast
-  end
-  
-  test "should parse true as literal" do
-    @parser.ruby_keyword_literals = true
-    ast = @parser.parse_string('true')
-    assert_equal [true], ast
-  end
-  
-  test "should not parse true as literal" do
-    @parser.ruby_keyword_literals = false
-    ast = @parser.parse_string('true')
-    assert_equal [:true], ast
-  end
-  
-  test "should parse false as literal" do
-    @parser.ruby_keyword_literals = true
-    ast = @parser.parse_string('false')
-    assert_equal [false], ast
-  end
-  
-  test "should notparse false as literal" do
-    @parser.ruby_keyword_literals = false
-    ast = @parser.parse_string('false')
-    assert_equal [:false], ast
-  end
-    
-end

data/test/unit/scheme_compatability_test.rb

@@ -1,29 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'test_helper.rb'))
-
-class SchemeCompatabilityTest < Test::Unit::TestCase
-
-  def setup
-    @parser = Sexpistol.new
-  end
-
-  test "should parse #t as true" do
-    ast = @parser.parse_string('#t')
-    assert_equal [:"#t"], ast
-  end
-  
-  test "should parse #f as false" do
-    ast = @parser.parse_string('#f')
-    assert_equal [:"#f"], ast
-  end
-  
-  test "should allow comma quoting" do
-    ast = @parser.parse_string("(this is '( a test))")
-    assert_equal [[:this, :is, [:quote, [:a, :test]]]], ast
-  end
-  
-  test "should allow complicated comma quoting" do
-    ast = @parser.parse_string("(this is '( a test (also)))")
-    assert_equal [[:this, :is, [:quote, [:a, :test, [:also]]]]], ast
-  end
-    
-end

data/test/unit/string_literal_test.rb

@@ -1,39 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'test_helper.rb'))
-
-class StringLiteralTest < Test::Unit::TestCase
-
-  def setup
-    @parser = Sexpistol.new
-  end
-
-  test "should parse empty string literal" do
-    ast = @parser.parse_string('""')
-    assert_equal [""], ast
-  end
-
-  test "should parse string literal" do
-    ast = @parser.parse_string('"test"')
-    assert_equal ["test"], ast
-  end
-  
-  test "should parse string literal containing escaped quotes" do
-    ast = @parser.parse_string('"te\"st"')
-    assert_equal ["te\"st"], ast
-  end
-  
-  test "should parse string literal containing escaped characters" do
-    ast = @parser.parse_string('"\n\t\r"')
-    assert_equal ["\n\t\r"], ast
-  end
-  
-  test "should parse string literal containing spaces" do
-    ast = @parser.parse_string('"blah foo"')
-    assert_equal ["blah foo"], ast
-  end
-  
-  test "should parse string literal containing newlines" do
-    ast = @parser.parse_string('"blah' + "\n" + 'foo"')
-    assert_equal ["blah\nfoo"], ast
-  end
-    
-end

data/test/unit/structure_test.rb

@@ -1,30 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'test_helper.rb'))
-
-class StructureTest < Test::Unit::TestCase
-
-  def setup
-    @parser = Sexpistol.new
-  end
-  
-  test "should create nested set of arrays from s-expression" do
-    ast = @parser.parse_string('(this (is (an (s_expression) (also) blah) foo) (test))')
-    assert_equal [[:this, [:is, [:an, [:s_expression], [:also], :blah], :foo], [:test]]], ast
-  end
-  
-  test "should create nested set of arrays from s-expression with string literals" do
-    ast = @parser.parse_string('(this (is (an ("s_expression"))))')
-    assert_equal [[:this, [:is, [:an, ["s_expression"]]]]], ast
-  end
-  
-  test "should raise error on broken s-expression" do
-    assert_raises Exception do
-      ast = @parser.parse_string('(this (is (an (s_expression) too)')
-    end
-  end
-  
-  test "should parser () as empty list" do
-    ast = @parser.parse_string('()')
-    assert_equal [[]], ast
-  end
-    
-end

data/test/unit/symbol_test.rb

@@ -1,74 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'test_helper.rb'))
-
-class SymbolTest < Test::Unit::TestCase
-
-  def setup
-    @parser = Sexpistol.new
-  end
-
-  test "should parse simple symbol" do
-    ast = @parser.parse_string("test")
-    assert_equal [:test], ast
-  end
-  
-  test "should parse symbol with trailing exclamation mark" do
-    ast = @parser.parse_string("test!")
-    assert_equal [:test!], ast
-  end
-  
-  test "should parse symbol with trailing question mark" do
-    ast = @parser.parse_string("test?")
-    assert_equal [:test?], ast
-  end
-  
-  test "should parse symbol containing underscores" do
-    ast = @parser.parse_string("te__st")
-    assert_equal [:te__st], ast
-  end
-  
-  test "should parse symbol with leading underscores" do
-    ast = @parser.parse_string("__test")
-    assert_equal [:__test], ast
-  end
-  
-  test "should parse symbol with trailing underscores" do
-    ast = @parser.parse_string("test__")
-    assert_equal [:test__], ast
-  end
-    
-  test "should parse CamelCase symbol" do
-    ast = @parser.parse_string("TestSymbol")
-    assert_equal [:TestSymbol], ast
-  end
-  
-  test "should parse complex symbol" do
-    ast = @parser.parse_string("__TestSymbol_TEST__?")
-    assert_equal [:__TestSymbol_TEST__?], ast
-  end
-  
-  test "should parse symbol containing addition operators" do
-    ast = @parser.parse_string("+")
-    assert_equal [:+], ast
-  end
-  
-  test "should parse symbol containing multiplication operators" do
-    ast = @parser.parse_string("*")
-    assert_equal [:*], ast
-  end
-  
-  test "should parse symbol containing subtraction operators" do
-    ast = @parser.parse_string("-")
-    assert_equal [:-], ast
-  end
-  
-  test "should parse symbol containing division operators" do
-    ast = @parser.parse_string("/")
-    assert_equal [:"/"], ast
-  end
-  
-  test "should parse symbol containing any character except single and double quotes, backquote, parentheses and comma" do
-    ast = @parser.parse_string("~1!2@3#4$%5^6&7*890-_+=|\]}[{poiuytrewqasdfghjklmnbvcxzZXCVBNMLKJHGFDSAQWERTYUIOP:;/?><")
-    assert_equal [:"~1!2@3#4$%5^6&7*890-_+=|\]}[{poiuytrewqasdfghjklmnbvcxzZXCVBNMLKJHGFDSAQWERTYUIOP:;/?><"], ast
-  end
-    
-end

data/test/unit/to_sexp_test.rb

@@ -1,51 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'test_helper.rb'))
-
-class ToSexpTest < Test::Unit::TestCase
-
-  def setup
-    @parser = Sexpistol.new
-  end
-
-  test "should convert nested arrays back into an S-Expression" do
-    ast = [:string, [:is, [:parsed]]]
-    sexp = @parser.to_sexp(ast)
-    assert_equal "(string (is (parsed)))", sexp
-  end
-  
-  test "should structure containing integers and strings back into an S-Expression" do
-    ast = ["String!", [1, [2, "Other string."]]]
-    sexp = @parser.to_sexp(ast)
-    assert_equal "(String! (1 (2 Other string.)))", sexp
-  end
-  
-  test "should output true and false using scheme notation" do
-    ast = [true, [false, [true, false]]]
-    sexp = @parser.to_sexp(ast)
-    assert_equal "(#t (#f (#t #f)))", sexp
-  end
-  
-  test "when not passed array to_sexp should print value (integer)" do
-    ast = 1
-    sexp = @parser.to_sexp(ast)
-    assert_equal "1", sexp
-  end
-  
-  test "when not passed array to_sexp should print value (string)" do
-    ast = "test"
-    sexp = @parser.to_sexp(ast)
-    assert_equal "test", sexp
-  end
-  
-  test "when not passed array to_sexp should print value (symbol)" do
-    ast = :test
-    sexp = @parser.to_sexp(ast)
-    assert_equal "test", sexp
-  end
-  
-  test "lists passed to to_sexp should have not extraneous spaces" do
-    ast = [1, 2, 3]
-    sexp = @parser.to_sexp(ast)
-    assert_equal "(1 2 3)", sexp
-  end
-    
-end