rVM 0.0.14 → 0.0.17

data/lib/rvm/functions/association/assoc_get.rb

@@ -1,5 +1,39 @@
+=begin
+The MIT License
+
+Copyright (c) 2008 Heinz N. 'Licenser' Gies
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Ruby Mush"), 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.
+=end
+
+
 module RVM
   module Functions
+    
+    # The AssocGet function is the Association (hash) equivalent to At function
+    # from the List. It get a Association as first argument and a index as the
+    # second. This index can be any kind of Class.
+    #
+    # It can also be called with two arguments if :self is set as a variable
+    # and :self is a Association - in this case it is concidered a object
+    # function. The first passed parameter will be the key, the second the
+    # value.
     class AssocGet < RVM::Functions::Function
       class << self
         def execute params, env

data/lib/rvm/functions/association/assoc_set.rb

@@ -1,5 +1,37 @@
+=begin
+The MIT License
+
+Copyright (c) 2008 Heinz N. 'Licenser' Gies
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Ruby Mush"), 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.
+=end
+
 module RVM
   module Functions
+    
+    # The AssocSet function is used to set elements of a Association, it takes
+    # the Association as first argument, the key as second and the valuse as
+    # third.
+    #
+    # It can also be called with two arguments, a key and a value if the :self
+    # variable is set and a Association - thus it is in object context of a
+    # Association.
     class AssocSet < RVM::Functions::Function
       class << self
         def execute params, env

data/lib/rvm/functions/bitwise.rb

@@ -0,0 +1,3 @@
+Dir[File.dirname(__FILE__) + '/bitwise/*.rb'].each do |c|
+  require c
+end

data/lib/rvm/functions/bitwise/bitwise_and.rb

@@ -0,0 +1,41 @@
+=begin
+The MIT License
+
+Copyright (c) 2007 Heinz N. 'Licenser' Gies
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Ruby Mush"), 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.
+=end
+
+module RVM
+  module Functions
+    class BitwiseAnd < Function
+      
+      register_for :bitwise_and
+      
+      def self.execute params, env
+        params.shift.to_i & params.shift.to_i
+      end
+      
+      def self.signature
+        [:number, :number]
+      end
+      
+    end
+  end
+end

data/lib/rvm/functions/bitwise/bitwise_or.rb

@@ -0,0 +1,41 @@
+=begin
+The MIT License
+
+Copyright (c) 2007 Heinz N. 'Licenser' Gies
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Ruby Mush"), 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.
+=end
+
+module RVM
+  module Functions
+    class BitwiseOr < Function
+      
+      register_for :bitwise_or
+      
+      def self.execute params, env
+        params.shift.to_i | params.shift.to_i
+      end
+      
+      def self.signature
+        [:number, :number]
+      end
+      
+    end
+  end
+end

data/lib/rvm/functions/bitwise/bitwise_xor.rb

@@ -0,0 +1,41 @@
+=begin
+The MIT License
+
+Copyright (c) 2007 Heinz N. 'Licenser' Gies
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Ruby Mush"), 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.
+=end
+
+module RVM
+  module Functions
+    class BitwiseXor < Function
+      
+      register_for :bitwise_xor
+      
+      def self.execute params, env
+        params.shift.to_i ^ params.shift.to_i
+      end
+      
+      def self.signature
+        [:number, :number]
+      end
+      
+    end
+  end
+end

data/lib/rvm/functions/collection/get.rb

@@ -1,12 +1,45 @@
-require File.dirname(__FILE__) +'/../array/at'
-require File.dirname(__FILE__) +'/../association/assoc_get'
+=begin
+The MIT License
+
+Copyright (c) 2008 Heinz N. 'Licenser' Gies
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Ruby Mush"), 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.
+=end
+
+require 'rvm/functions/array/at'
+require 'rvm/functions/association/assoc_get'
 module RVM
   module Functions
+    
+    # The Get function is a generalized function for getting elements of classes
+    # that store collections of more then one element. Currently List
+    # and Associations are supported.
+    #
+    # It takes two or one argument, if only one argument it passed it is used
+    # as the key to get, and the :sefl variable must be set. If two arguments
+    # are passed the first is expected to be the collection and the second
+    # to be the key.
     class Get < RVM::Functions::Function
       class << self
         FUNCTION_MAP = {
           RVM::Classes::List => RVM::Functions::At,
-          Classes::Association => RVM::Functions::AssocGet
+          RVM::Classes::Association => RVM::Functions::AssocGet
         }
         def execute params, env
           if params.length == 2
@@ -15,7 +48,7 @@ module RVM
             else
               RVM::Classes[:error].new(1, "FUNCTION (#{self.class}) does not accept #{params.first.class}")
             end
-          elsif params.length == 1 and (this = env.read_var_val(:self)).is_a?(RVM::Classes[:association]) 
+          elsif params.length == 1 and FUNCTION_MAP.include?((this = env.read_var_val(:self)).class)
             if fun = FUNCTION_MAP[this]
               fun.execute(params, env)
             else

data/lib/rvm/functions/collection/set.rb

@@ -1,7 +1,41 @@
-require File.dirname(__FILE__) +'/../array/set_at'
-require File.dirname(__FILE__) +'/../association/assoc_set'
+=begin
+The MIT License
+
+Copyright (c) 2008 Heinz N. 'Licenser' Gies
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Ruby Mush"), 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.
+=end
+
+require 'rvm/functions/array/set_at'
+require 'rvm/functions/association/assoc_set'
 module RVM
   module Functions
+    
+    # The Set function is a generalized function for setting elements of classes
+    # that store collections of more then one element. Currently List
+    # and Associations are supported.
+    #
+    # It takes trhee or two argument, if only two argument it passed the first 
+    # is used as the key, the second as value, and the :sefl variable must be
+    # set. If three arguments are passed the first is expected to be the
+    # collection, the second to be the key and the thrid is used as value to
+    # set
     class Set < RVM::Functions::Function
       class << self
         FUNCTION_MAP = {
@@ -15,7 +49,7 @@ module RVM
             else
               RVM::Classes[:error].new(1, "FUNCTION (#{self.class}) does not accept #{params.first.class}")
             end
-          elsif params.length == 1 and (this = env.read_var_val(:self)).is_a?(RVM::Classes[:association]) 
+          elsif params.length == 1 and FUNCTION_MAP.include?((this = env.read_var_val(:self)).class)
             if fun = FUNCTION_MAP[this]
               fun.execute(params, env)
             else

data/lib/rvm/functions/collection/size.rb

@@ -1,5 +1,37 @@
+=begin
+The MIT License
+
+Copyright (c) 2008 Heinz N. 'Licenser' Gies
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Ruby Mush"), 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.
+=end
+
 module RVM
   module Functions
+    
+    # The Size function is a generalized function for determin the number
+    # of elements for classes that store collections of more then one element.
+    # Currently List and Associations are supported.
+    #
+    # It takes one or no arguments, if no arguments are passed it expects :self
+    # to be set to a valid class, otherwis the first argument is queried for
+    # it's size.
     class Size < Function
       class << self
         COLLECTION_CLASSES = [
@@ -19,7 +51,7 @@ module RVM
           [:any]
         end
       end
-      register_for :size
+      register_for :size, :length
     end
   end
 end

data/lib/rvm/functions/general/cmp.rb

@@ -1,19 +1,47 @@
+=begin
+The MIT License
+
+Copyright (c) 2008 Heinz N. 'Licenser' Gies
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Ruby Mush"), 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.
+=end
+
 module RVM
   module Functions
-		class Cmp < RVM::Functions::Function
+    
+    # The Cmp (compare) function is prett stight fowards, it takes two
+    # arguments, not less nor more and compares them using the <=> opperator.
+    #
+    # Returned is a Number.
+    class Cmp < RVM::Functions::Function
       class << self
         def execute params, env
           if params.length == 2
-					  return RVM::Classes[:number].new(params[0] <=> params[1])
-					else
-					end
+            return RVM::Classes[:number].new(params[0] <=> params[1])
+          end
         end
-				
+        
         def signature
           [:any] 
         end
       end
       register_for :cmp
-		end
-	end
+    end
+  end
 end

data/lib/rvm/functions/general/eq.rb

@@ -1,5 +1,34 @@
+=begin
+The MIT License
+
+Copyright (c) 2008 Heinz N. 'Licenser' Gies
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Ruby Mush"), 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.
+=end
+
 module RVM
   module Functions
+    
+    # The Eq function tests if the two passed parameters are equal, using the 
+    # == opperator.
+    #
+    # It returns a Boolean.
     class Eq < RVM::Functions::Function
       class << self
         def execute params, env