crisp 0.0.5 → 0.0.7

data/CHANGELOG.md

@@ -1,6 +1,14 @@
-## 0.0.6 (2010-xx-xx)
+## 0.0.8 (2010-xx-xx)
 
-* todo
+* ...
+
+## 0.0.6/0.0.7 (2010-12-17)
+
+* if else statements
+* compare functions
+* basic support for ruby method invokation (thanks to invadersmustdie)
+* supplied first examples
+* refactored internals and specs
 
 ## 0.0.5 (2010-11-29)
 

data/README.md

@@ -8,6 +8,7 @@ The main purpose of the language is to deal with the issues and problems when cr
 
 ### Example
 
+        # crisp
         >> (* 2 3)
         => 6
         >> (def foo 4)
@@ -21,7 +22,7 @@ The main purpose of the language is to deal with the issues and problems when cr
 
 ### Installation
 
-gem is coming soon.
+        gem install crisp
 
 ### Usage
 

data/Rakefile

@@ -14,8 +14,8 @@ begin
     gem.email = "github@mgsnova.de"
     gem.homepage = "http://github.com/mgsnova/crisp"
     gem.authors = ['Markus Gerdes']
-    gem.add_dependency 'treetop', '~> 1.4.0'
-    gem.add_development_dependency 'rspec', '~> 2.2.0'
+    gem.add_dependency 'treetop', '~> 1.4.9'
+    gem.add_development_dependency 'rspec', '~> 2.3.0'
   end
 
   Jeweler::GemcutterTasks.new

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { 'rspec2' }

data/crisp.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{crisp}
-  s.version = "0.0.5"
+  s.version = "0.0.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Markus Gerdes"]
-  s.date = %q{2010-11-29}
+  s.date = %q{2010-12-17}
   s.default_executable = %q{crisp}
   s.email = %q{github@mgsnova.de}
   s.executables = ["crisp"]
@@ -22,23 +22,43 @@ Gem::Specification.new do |s|
     "LICENSE",
     "README.md",
     "Rakefile",
+    "autotest/discover.rb",
     "bin/crisp",
     "crisp.gemspec",
+    "examples/fibonacci.crisp",
     "lib/crisp.rb",
     "lib/crisp/chained_env.rb",
     "lib/crisp/crisp.treetop",
     "lib/crisp/env.rb",
     "lib/crisp/errors.rb",
     "lib/crisp/function.rb",
+    "lib/crisp/function_runner.rb",
     "lib/crisp/functions.rb",
     "lib/crisp/functions/arithmetic.rb",
     "lib/crisp/functions/core.rb",
+    "lib/crisp/native_call_invoker.rb",
     "lib/crisp/nodes.rb",
+    "lib/crisp/nodes/array_literal.rb",
+    "lib/crisp/nodes/base.rb",
+    "lib/crisp/nodes/block.rb",
+    "lib/crisp/nodes/false_literal.rb",
+    "lib/crisp/nodes/float_literal.rb",
+    "lib/crisp/nodes/integer_literal.rb",
+    "lib/crisp/nodes/nil_literal.rb",
+    "lib/crisp/nodes/operation.rb",
+    "lib/crisp/nodes/primitive.rb",
+    "lib/crisp/nodes/string_literal.rb",
+    "lib/crisp/nodes/symbol_literal.rb",
+    "lib/crisp/nodes/true_literal.rb",
     "lib/crisp/parser.rb",
     "lib/crisp/runtime.rb",
     "lib/crisp/shell.rb",
     "spec/crisp/arithmetics_spec.rb",
     "spec/crisp/basic_spec.rb",
+    "spec/crisp/core_spec.rb",
+    "spec/crisp/function_spec.rb",
+    "spec/crisp/internal_spec.rb",
+    "spec/crisp/native_call_invoker_spec.rb",
     "spec/crisp/string_spec.rb",
     "spec/spec_helper.rb"
   ]
@@ -49,6 +69,10 @@ Gem::Specification.new do |s|
   s.test_files = [
     "spec/crisp/arithmetics_spec.rb",
     "spec/crisp/basic_spec.rb",
+    "spec/crisp/core_spec.rb",
+    "spec/crisp/function_spec.rb",
+    "spec/crisp/internal_spec.rb",
+    "spec/crisp/native_call_invoker_spec.rb",
     "spec/crisp/string_spec.rb",
     "spec/spec_helper.rb"
   ]
@@ -58,15 +82,15 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<treetop>, ["~> 1.4.0"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.2.0"])
+      s.add_runtime_dependency(%q<treetop>, ["~> 1.4.9"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
     else
-      s.add_dependency(%q<treetop>, ["~> 1.4.0"])
-      s.add_dependency(%q<rspec>, ["~> 2.2.0"])
+      s.add_dependency(%q<treetop>, ["~> 1.4.9"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
     end
   else
-    s.add_dependency(%q<treetop>, ["~> 1.4.0"])
-    s.add_dependency(%q<rspec>, ["~> 2.2.0"])
+    s.add_dependency(%q<treetop>, ["~> 1.4.9"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
   end
 end
 

data/examples/fibonacci.crisp

@@ -0,0 +1,6 @@
+(def fib (
+  fn [n]
+  (if (< n 2)
+    n
+    (+ (fib (- n 1)) (fib (- n 2))))))
+(println "fibonacci for 10 is" (fib 10))

data/lib/crisp.rb

@@ -3,7 +3,7 @@ require "treetop"
 require "pp"
 
 module Crisp
-  VERSION = '0.0.5'
+  VERSION = '0.0.7'
 end
 
 require 'crisp/errors'
@@ -13,5 +13,7 @@ require 'crisp/chained_env'
 require 'crisp/env'
 require 'crisp/nodes'
 require 'crisp/function'
+require 'crisp/function_runner'
 require 'crisp/functions'
 require 'crisp/shell'
+require 'crisp/native_call_invoker'

data/lib/crisp/chained_env.rb

@@ -1,10 +1,22 @@
 module Crisp
+  # The ChainedEnv combines to given environments.
+  # This is useful to combine a global and a local environment for easy access
+  #
   class ChainedEnv
+    # creates new chained env with given envs
+    # It is used that the 'first' is the local and the 'second' the global env
     def initialize(first, second)
       @first = first
       @second = second
     end
 
+    # Returns boolean for existence of given key in one of the environments.
+    def has_key?(key)
+      @first.has_key?(key) or @second.has_key?(key)
+    end
+
+    # Read access is performed preferred on the 'first' env.
+    # If the 'first' env is not holding a value for the key, the 'second' will be requested.
     def [](key)
       if @first.has_key?(key)
         @first[key]
@@ -13,6 +25,7 @@ module Crisp
       end
     end
 
+    # Storing a value for a key will always be performed on the 'second' env.
     def []=(key, val)
       @second[key] = val
     end

data/lib/crisp/crisp.treetop

@@ -1,47 +1,55 @@
 grammar Crisp
 
   rule block
-    (operation)* <Block>
+    (func_identifier / element)* <Nodes::Block>
   end
 
   rule operation
-    space paren_start space func_identifier element_list:(space element)* space paren_end space <Operation>
+    space paren_start space func_identifier element_list:(space element)* space paren_end space <Nodes::Operation>
   end
 
   rule array
-    array_paren_start element_list:(space element)* space array_paren_end <ArrayLiteral>
+    array_paren_start element_list:(space element)* space array_paren_end <Nodes::ArrayLiteral>
   end
 
   rule element
-    operation / float / number / symbol / string / array
+    true / false / nil / operation / float / integer / symbol / string / array
   end
 
   rule func_identifier
     symbol
     /
-    '+'
+    [/=*<>\-+\.]
     /
-    '-'
-    /
-    '*'
-    /
-    '/'
+    operation
+  end
+
+  rule true
+    'true' <Nodes::TrueLiteral>
+  end
+
+  rule false
+    'false' <Nodes::FalseLiteral>
+  end
+
+  rule nil
+    'nil' <Nodes::NilLiteral>
   end
 
   rule symbol
-    [a-z] [a-z0-9]* <Symbol>
+    [a-z] [a-z0-9]* <Nodes::SymbolLiteral>
   end
 
-  rule number
-    '-'? ([1-9] [0-9]* / '0') <Number>
+  rule integer
+    '-'? ([1-9] [0-9]* / '0') <Nodes::IntegerLiteral>
   end
 
   rule float
-    number '.' [0-9]* <Float>
+    integer '.' [0-9]* <Nodes::FloatLiteral>
   end
 
   rule string
-    '"' [^"]* '"' <StringLiteral>
+    '"' [^"]* '"' <Nodes::StringLiteral>
   end
 
   rule space

data/lib/crisp/env.rb

@@ -1,17 +1,24 @@
 module Crisp
+  # The Crisp environment is basically a key/value store.
+  # The value for each key is immutable, so you can only store one time for each key
   class Env
+    # create a new internal hash
     def initialize
       @map = {}
     end
 
+    # Returns boolean for existence of given key in the environment.
     def has_key?(key)
       @map.has_key?(key.to_sym)
     end
 
+    # Returns the value for the given key.
     def [](key)
       @map[key.to_sym]
     end
 
+    # Store the key/value pair.
+    # It is only possible to store a value for a key once, otherwise a error will be raised.
     def []=(key, val)
       key = key.to_sym
       raise EnvironmentError, "#{key} already binded" if @map.has_key?(key)

data/lib/crisp/function.rb

@@ -1,59 +1,23 @@
 module Crisp
+  # The Crisp function
   class Function
     attr_reader :name
 
+    # create new function by calling new with a code block
     def initialize(&blk)
       @name = nil
       @blk = blk
     end
 
+    # bind the function to the given name in the given environment
     def bind(name, env)
       @name = name.to_sym
       env[name] = self
     end
 
-    def eval(env, params = [])
-      @env = env
-      @params = params
-      self.instance_eval(&@blk)
-    end
-
-    protected
-
-    def validate_params_count(expected, got)
-      if expected != got
-        raise ArgumentError, "wrong number of arguments for '#{name}' (#{got} for #{expected})"
-      end
-    end
-
-    def params_values
-      params.map do |param|
-        param.eval(env)
-      end
-    end
-
-    def params_evaled
-      params_values.map do |param|
-        if param.class.to_s == 'Symbol'
-          if env[param].respond_to?(:eval)
-            env[param].eval(env)
-          else
-            env[param]
-          end
-        else
-          param
-        end
-      end
-    end
-
-    private
-
-    def env
-      @env
-    end
-
-    def params
-      @params
+    # evaluate the function by using the given environment and argument list
+    def eval(env, args = [])
+      FunctionRunner.run(@blk, env, args, name)
     end
   end
 end

data/lib/crisp/function_runner.rb

@@ -0,0 +1,37 @@
+module Crisp
+  # The FunctionRunner can eval function calls by instance_eval the function block
+  class FunctionRunner
+    attr_reader :name, :args, :env
+
+    # run the blk
+    def self.run(blk, env, args, name)
+      runner = new(env, args, name)
+      runner.instance_eval(&blk)
+    end
+
+    # save name, environment and arguments on creation
+    def initialize(env, args, name)
+      @name = name
+      @env = env
+      @args = args
+    end
+
+    protected
+    # following methods are used for calling from the function block
+
+    # raise an error if argument count got does not match the expected
+    def validate_args_count(expected, got)
+      if (expected.is_a?(Numeric) and expected != got) or
+         (expected.is_a?(Range) and !(expected === got))
+        raise ArgumentError, "wrong number of arguments for '#{name}' (#{got} for #{expected})"
+      end
+    end
+
+    # returns the resolved/evaled argument list
+    def args_evaled
+      args.map do |arg|
+        arg.resolve_and_eval(env)
+      end
+    end
+  end
+end

data/lib/crisp/functions.rb

@@ -1,8 +1,10 @@
-require 'crisp/functions/core'
-require 'crisp/functions/arithmetic'
-
 module Crisp
   module Functions
+    # require all files that are defining functions
+    require 'crisp/functions/core'
+    require 'crisp/functions/arithmetic'
+
+    # Load all defined function to the given environment
     def self.load(env)
       Core.load(env)
       Arithmetic.load(env)

data/lib/crisp/functions/arithmetic.rb

@@ -1,23 +1,78 @@
 module Crisp
   module Functions
+    # Defining arithemtic crisp functions
     class Arithmetic
-      def self.load(env)
+      # load the functions and bind them into the given environment
+      def self.load(current_env)
 
+        # +
+        # sum up all arguments
+        #
+        #  (+ 1 2 3)
+        #  => 6
         Function.new do
-          params_evaled.inject(:+)
-        end.bind('+', env)
+          args_evaled.inject(:+)
+        end.bind('+', current_env)
 
+        # -
+        # substract all arguments
+        #
+        #  (- 5 2 1)
+        #  => 2
         Function.new do
-          params_evaled.inject(:-)
-        end.bind('-', env)
+          args_evaled.inject(:-)
+        end.bind('-', current_env)
 
+        # *
+        # multiply all arguments
+        #
+        #  (* 2 3 4)
+        #  => 24
         Function.new do
-          params_evaled.inject(:*)
-        end.bind('*', env)
+          args_evaled.inject(:*)
+        end.bind('*', current_env)
 
+        # /
+        # divide all arguments
+        #
+        #  (/ 20 2 2)
+        #  => 5
         Function.new do
-          params_evaled.inject(:/)
-        end.bind('/', env)
+          args_evaled.inject(:/)
+        end.bind('/', current_env)
+
+        # =
+        # compare 2 arguments for equality
+        #
+        #  (= 1 2)
+        #  => false
+        Function.new do
+          validate_args_count(2, args.size)
+          values = args_evaled
+          values[0] == values[1]
+        end.bind('=', current_env)
+
+        # >
+        # compare 2 arguments for being greater than the other
+        #
+        #  (> 2 1)
+        #  => true
+        Function.new do
+          validate_args_count(2, args.size)
+          values = args_evaled
+          values[0] > values[1]
+        end.bind('>', current_env)
+
+        # <
+        # compare 2 arguments for being less than the other
+        #
+        #  (< 2 1)
+        #  => false
+        Function.new do
+          validate_args_count(2, args.size)
+          values = args_evaled
+          values[0] < values[1]
+        end.bind('<', current_env)
 
       end
     end