rubyless 0.3.5 → 0.4.0

data/lib/{typed_string.rb → ruby_less/typed_string.rb}

@@ -26,14 +26,14 @@ module RubyLess
     
     # Condition that could yield a nil result in the whole expression.
     # For example in the following expression:
-    #  var1.spouse.name == ''
-    # "var1.spouse" would be the condition that could yield 'nil'.
+    #  node.spouse.name == ''
+    # "node.spouse" would be the condition that could yield 'nil'.
     def cond
       @opts[:cond]
     end
     
     # raw result without nil checking:
-    # "var1.spouse.name" instead of "(var1.spouse ? var1.spouse.name : nil)"
+    # "node.spouse.name" instead of "(node.spouse ? node.spouse.name : nil)"
     def raw
       @opts[:raw] || self.to_s
     end

data/lib/ruby_less.rb

@@ -0,0 +1,27 @@
+=begin rdoc
+=end
+require 'ruby_less/info'
+require 'ruby_less/basic_types'
+require 'ruby_less/signature_hash'
+require 'ruby_less/error'
+require 'ruby_less/no_method_error'
+require 'ruby_less/syntax_error'
+require 'ruby_less/typed_string'
+require 'ruby_less/safe_class'
+require 'ruby_less/processor'
+
+module RubyLess
+  def self.translate(string, helper)
+    RubyLessProcessor.translate(string, helper)
+  end
+
+  def self.translate_string(string, helper)
+    if string =~ /\#\{/
+      ::RubyLess.translate("%Q{#{string}}", helper)
+    else
+      string.inspect
+    end
+  rescue => err
+    raise ::RubyLess::Error.new("Error parsing string \"#{string}\": #{err.message.strip}")
+  end
+end

data/lib/rubyless.rb

@@ -1,14 +1 @@
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
-
-require 'processor'
-
-=begin rdoc
-=end
-module RubyLess
-  VERSION = '0.3.5'
-
-  def self.translate(string, helper)
-    RubyLessProcessor.translate(string, helper)
-  end
-end
+require 'ruby_less'

data/rails/init.rb

@@ -0,0 +1 @@
+require 'rubyless'

data/rubyless.gemspec

@@ -1,24 +1,66 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{rubyless}
-  s.version = "0.3.5"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Gaspard Bucher"]
-  s.date = %q{2009-11-08}
-  s.description = %q{RubyLess is an interpreter for "safe ruby". The idea is to transform some "unsafe" ruby code into safe, type checked
-ruby, eventually rewriting some variables or methods.}
+  s.date = %q{2010-03-21}
+  s.description = %q{RubyLess is an interpreter for "safe ruby". The idea is to transform some "unsafe" ruby code into safe, type checked ruby, eventually rewriting some variables or methods.}
   s.email = %q{gaspard@teti.ch}
-  s.extra_rdoc_files = ["History.txt", "README.txt"]
-  s.files = ["History.txt", "README.txt", "Rakefile", "rubyless.gemspec", "lib/basic_types.rb", "lib/processor.rb", "lib/rubyless.rb", "lib/safe_class.rb", "lib/typed_string.rb", "test/mock", "test/mock/active_record_mock.rb", "test/mock/dummy_class.rb", "test/RubyLess", "test/RubyLess/active_record.yml", "test/RubyLess/basic.yml", "test/RubyLess/errors.yml", "test/RubyLess_test.rb", "test/test_helper.rb"]
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "History.txt",
+     "README.rdoc",
+     "Rakefile",
+     "lib/ruby_less.rb",
+     "lib/ruby_less/basic_types.rb",
+     "lib/ruby_less/error.rb",
+     "lib/ruby_less/info.rb",
+     "lib/ruby_less/no_method_error.rb",
+     "lib/ruby_less/processor.rb",
+     "lib/ruby_less/safe_class.rb",
+     "lib/ruby_less/signature_hash.rb",
+     "lib/ruby_less/syntax_error.rb",
+     "lib/ruby_less/typed_string.rb",
+     "lib/rubyless.rb",
+     "rails/init.rb",
+     "rubyless.gemspec",
+     "test/RubyLess/active_record.yml",
+     "test/RubyLess/basic.yml",
+     "test/RubyLess/errors.yml",
+     "test/RubyLess/string.yml",
+     "test/RubyLess_test.rb",
+     "test/mock/active_record_mock.rb",
+     "test/mock/dummy_class.rb",
+     "test/mock/dummy_module.rb",
+     "test/mock/property_column.rb",
+     "test/safe_class_test.rb",
+     "test/signature_hash_test.rb",
+     "test/test_helper.rb"
+  ]
   s.homepage = %q{http://zenadmin.org/546}
-  s.rdoc_options = ["--main", "README.txt"]
+  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubyforge_project = %q{rubyless}
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{RubyLess is an interpreter for "safe ruby"}
-  s.test_files = ["test/test_helper.rb"]
+  s.test_files = [
+    "test/mock/active_record_mock.rb",
+     "test/mock/dummy_class.rb",
+     "test/mock/dummy_module.rb",
+     "test/mock/property_column.rb",
+     "test/RubyLess_test.rb",
+     "test/safe_class_test.rb",
+     "test/signature_hash_test.rb",
+     "test/test_helper.rb"
+  ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
@@ -27,18 +69,19 @@ ruby, eventually rewriting some variables or methods.}
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<ruby_parser>, [">= 2.0.4"])
       s.add_runtime_dependency(%q<sexp_processor>, [">= 3.0.1"])
-      s.add_development_dependency(%q<bones>, [">= 2.5.1"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<yamltest>, [">= 0.5.3"])
     else
       s.add_dependency(%q<ruby_parser>, [">= 2.0.4"])
       s.add_dependency(%q<sexp_processor>, [">= 3.0.1"])
-      s.add_dependency(%q<bones>, [">= 2.5.1"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<yamltest>, [">= 0.5.3"])
     end
   else
     s.add_dependency(%q<ruby_parser>, [">= 2.0.4"])
     s.add_dependency(%q<sexp_processor>, [">= 3.0.1"])
-    s.add_dependency(%q<bones>, [">= 2.5.1"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<yamltest>, [">= 0.5.3"])
   end
 end
+

data/test/RubyLess/active_record.yml

@@ -1,19 +1,19 @@
 time_type_from_columns:
   src: 'log_at.strftime("%Y")'
-  tem: "(var1.log_at ? var1.log_at.strftime(\"%Y\") : nil)"
+  tem: "(node.log_at ? node.log_at.strftime(\"%Y\") : nil)"
 
 text_type_from_columns:
   src: 'birth.strftime(format)'
-  tem: "Date.parse('2009-06-02 18:44').strftime(var1.format)"
+  tem: "Date.parse('2009-06-02 18:44').strftime(node.format)"
   res: '02.06.2009'
 
 number_type_from_columns:
   src: "age + 15"
-  tem: "(var1.age+15)"
+  tem: "(node.age+15)"
   res: "20"
 
 number_type_from_columns_no_default:
   src: "friend_id + 15"
-  tem: "(var1.friend_id ? (var1.friend_id+15) : nil)"
+  tem: "(node.friend_id ? (node.friend_id+15) : nil)"
   res: ""
 

data/test/RubyLess/basic.yml

@@ -4,7 +4,7 @@ empty:
 
 numbers:
   src: "id > 45 and (3 > -id or 3+3)"
-  tem: "((var1.zip>45) and ((3>-var1.zip) or (3+3)))"
+  tem: "((node.zip>45) and ((3>-node.zip) or (3+3)))"
 
 global_method:
   src: "now.strftime('%Y')"
@@ -12,11 +12,11 @@ global_method:
 
 dynamic_string:
   src: "now.strftime(\"#{name}\")"
-  tem: "Time.now.strftime(\"#{var1.name}\")"
+  tem: "Time.now.strftime(\"#{node.name}\")"
 
 dynamic_string_again:
   src: "now.strftime(\"#{name}\")"
-  tem: "Time.now.strftime(\"#{var1.name}\")"
+  tem: "Time.now.strftime(\"#{node.name}\")"
 
 symbol:
   src: ":foobar"
@@ -28,34 +28,34 @@ hash_access:
 
 rewrite_variables:
   src: "!prev.ancestor?(main) && !node.ancestor?(main)"
-  tem: "(not previous.ancestor?(@node) and not var1.ancestor?(@node))"
+  tem: "(not previous.ancestor?(@node) and not node.ancestor?(@node))"
 
 method_can_return_nil:
   src: "spouse.name"
-  tem: "(var1.spouse ? var1.spouse.name : nil)"
+  tem: "(node.spouse ? node.spouse.name : nil)"
 
 method_on_method_can_return_nil:
   src: "spouse.name == 'yo'"
-  tem: "(var1.spouse ? (var1.spouse.name==\"yo\") : nil)"
+  tem: "(node.spouse ? (node.spouse.name==\"yo\") : nil)"
   res: ""
 
 nil_greater_then:
   src: "spouse.id > 1"
-  tem: "(var1.spouse ? (var1.spouse.zip>1) : nil)"
+  tem: "(node.spouse ? (node.spouse.zip>1) : nil)"
 
 nil_ternary_op:
   src: "spouse ? 'foo' : 'bar'"
-  tem: "var1.spouse ? \"foo\" : \"bar\""
+  tem: "node.spouse ? \"foo\" : \"bar\""
   res: 'bar'
 
 nested_ternary_op:
   src: "spouse.name == 'Adam' ? 'man' : 'not a man'"
-  tem: "(var1.spouse ? (var1.spouse.name==\"Adam\") : nil) ? \"man\" : \"not a man\""
+  tem: "(node.spouse ? (node.spouse.name==\"Adam\") : nil) ? \"man\" : \"not a man\""
   res: "not a man"
 
 method_on_method:
   src: "project.name.to_s"
-  tem: "var1.project.name.to_s"
+  tem: "node.project.name.to_s"
   res: 'project'
 
 comp_ternary_op:
@@ -65,24 +65,24 @@ comp_ternary_op:
 
 method_ternary_op:
   src: "id > 2 ? 'foo' : 'bar'"
-  tem: "(var1.zip>2) ? \"foo\" : \"bar\""
+  tem: "(node.zip>2) ? \"foo\" : \"bar\""
   res: "foo"
 
 method_argument_can_be_nil:
   src: "vowel_count(spouse.name)"
-  tem: "(var1.spouse ? vowel_count(var1.spouse.name) : nil)"
+  tem: "(node.spouse ? vowel_count(node.spouse.name) : nil)"
 
 multi_arg_method_argument_can_be_nil:
   src: "log_info(spouse, 'foobar')"
-  tem: "(var1.spouse ? log_info(var1.spouse, \"foobar\") : nil)"
+  tem: "(node.spouse ? log_info(node.spouse, \"foobar\") : nil)"
 
 multi_arg_method_arguments_can_be_nil:
   src: "log_info(husband, spouse.name)"
-  tem: "((var1.husband && var1.spouse) ? log_info(var1.husband, var1.spouse.name) : nil)"
+  tem: "((node.husband && node.spouse) ? log_info(node.husband, node.spouse.name) : nil)"
 
 multi_arg_method_arguments_can_be_nil_same_condition:
   src: "log_info(spouse, spouse.name)"
-  tem: "(var1.spouse ? log_info(var1.spouse, var1.spouse.name) : nil)"
+  tem: "(node.spouse ? log_info(node.spouse, node.spouse.name) : nil)"
 
 literal_argument_for_method:
   src: "vowel_count('ruby')"
@@ -94,10 +94,48 @@ safe_method_defined_as_symbol:
 
 optional_arguments:
   src: "width(:mode => 'pv')"
-  tem: "var1.width({:mode => \"pv\"})"
+  tem: "node.width({:mode => \"pv\"})"
   res: "mode: pv, type: none"
 
+optional_arguments:
+  src: "width"
+  tem: "node.width"
+  res: "mode: none, type: none"
+
 optional_arguments_string:
   src: "width('nice' => 1 == 1)"
-  tem: "var1.width({\"nice\" => (1==1)})"
-  res: "nice!"
+  tem: "node.width({\"nice\" => (1==1)})"
+  res: "nice!"
+
+module_method:
+  src: "maze"
+  tem: "node.mazette"
+  res: "Mazette !"
+
+regexp:
+  src: "maze.gsub(/ette/,'o')"
+  tem: "node.mazette.gsub(/ette/, \"o\")"
+  res: "Mazo !"
+
+instance_variable:
+  src: "@foo.maze"
+  tem: "node.mazette"
+  res: "Mazette !"
+
+prepend_arg:
+  src: "prepend_test(4)"
+  tem: "add(10, 4)"
+  res: "14"
+
+safe_property:
+  src: "dog_name"
+  tem: "node.prop['dog_name']"
+  res: "Biscotte"
+
+match_on_subclass:
+  src: "log_info(sub, 'hello')"
+  tem: "log_info(sub, \"hello\")"
+
+optional_argument_subclass:
+  src: "width(:mode => str)"
+  tem: "node.width({:mode => str})"

data/test/RubyLess/errors.yml

@@ -1,39 +1,39 @@
 unknown_global_method:
   src: "system('echo date')"
-  res: "Unknown method 'system(\"echo date\")'."
+  res: "(RubyLessTest): unknown method 'system(String)'."
 
 bad_argument_types:
   src: "strftime(34,'ffoo')"
-  res: "Unknown method 'strftime(34, \"ffoo\")'."
+  res: "(RubyLessTest): unknown method 'strftime(Number, String)'."
 
 zero_div:
   src: "1/(id-10)"
-  tem: "(1/(var1.zip-10) rescue nil)"
+  tem: "(1/(node.zip-10) rescue nil)"
   res: ""
 
 looping:
   src: "while(true) do puts 'flood' end"
-  res: 'Bug! Unknown node-type :while to RubyLess::RubyLessProcessor'
+  res: "'while' not available in RubyLess."
 
 add_two_strings:
   src: "name + 14"
-  res: "'var1.name' does not respond to '+(Number)'."
+  res: "node.name (String): unknown method '+(Number)'."
 
 two_arguments_in_hash:
   src: "dictionary[:one, :two]"
-  res: "'get_dict' does not respond to '[](Symbol, Symbol)'."
+  res: "get_dict (StringDictionary): unknown method '[](Symbol, Symbol)'."
 
 number_argument:
   src: "dictionary[43]"
-  res: "'get_dict' does not respond to '[](Number)'."
+  res: "get_dict (StringDictionary): unknown method '[](Number)'."
 
 string_argument:
   src: "dictionary[spouse.name]"
-  res: "'get_dict' does not respond to '[](String)'."
+  res: "get_dict (StringDictionary): unknown method '[](String)'."
 
 symbol_type_not_used_out_of_helper:
   src: "node.foo"
-  tem: "'var1' does not respond to 'foo()'."
+  tem: "node (Dummy): unknown method 'foo()'."
 
 optional_arguments_with_dynamic_string:
   src: "spouse.width(\"nice#{spouse.name}\" => 'pv')"
@@ -42,8 +42,8 @@ optional_arguments_with_dynamic_string:
 
 optional_arguments_bad_type:
   src: "width(:mode => 12)"
-  res: "Unknown method 'width({:mode => 12})'."
+  res: "(RubyLessTest): unknown method 'width(:mode=>Number)'."
 
 optional_arguments_bad_argument:
   src: "width(:xyz => 'pv')"
-  res: "Unknown method 'width({:xyz => \"pv\"})'."
+  res: "(RubyLessTest): unknown method 'width(:xyz=>String)'."

data/test/RubyLess/string.yml

@@ -0,0 +1,11 @@
+empty:
+  str: ""
+  tem: '""'
+
+text:
+  str: "hello"
+  tem: '"hello"'
+
+dynamic_string:
+  str: 'one #{name} two'
+  tem: '"one #{node.name} two"'

data/test/RubyLess_test.rb

@@ -1,5 +1,5 @@
 require 'date'
-require File.dirname(__FILE__) + '/test_helper.rb'
+require 'test_helper'
 
 class StringDictionary
   include RubyLess::SafeClass
@@ -7,6 +7,10 @@ class StringDictionary
   disable_safe_read
 end
 
+# Used to test sub-classes in optional arguments
+class SubString < String
+end
+
 class RubyLessTest < Test::Unit::TestCase
   attr_reader :context
   yamltest :src_from_title => false
@@ -22,13 +26,19 @@ class RubyLessTest < Test::Unit::TestCase
   safe_method :foo => :contextual_method, :bar => :contextual_method
   safe_method_for String, [:==, String] => Boolean
   safe_method_for String, [:to_s] => String
+  safe_method_for String, [:gsub, Regexp, String] => String
   safe_method_for Time, [:strftime, String] => String
+  safe_method :@foo => {:class => Dummy, :method => "node"}
+  safe_method :sub => SubDummy
+  safe_method :str => SubString
 
   # Example to dynamically rewrite method calls during compilation
   def safe_method_type(signature)
     unless res = super
-      # try to execute method in the current var "var.method"
-      if res = context[:node_class].safe_method_type(signature)
+      if signature == ['prepend_test', Number]
+        res ={:class => Number, :prepend_args => RubyLess::TypedString.new('10', :class => Number), :method => 'add'}
+      elsif res = context[:node_class].safe_method_type(signature)
+        # try to execute method in the current var "var.method"
         res = res.call(self, signature) if res.kind_of?(Proc)
         res = res.merge(:method => "#{context[:node]}.#{res[:method] || signature[0]}")
       end
@@ -40,10 +50,22 @@ class RubyLessTest < Test::Unit::TestCase
     {:method => "contextual_#{signature[0]}", :class => String}
   end
 
-  def var1
+  def node
     Dummy.new
   end
 
+  def sub
+    SubDummy.new
+  end
+
+  def str
+    "str"
+  end
+
+  def add(a,b)
+    a+b
+  end
+
   def vowel_count(str)
     str.tr('^aeiouy', '').size
   end
@@ -70,28 +92,40 @@ class RubyLessTest < Test::Unit::TestCase
 
   def yt_do_test(file, test, context = yt_get('context',file,test))
     @@test_strings[file][test].keys.each do |key|
-      next if ['src', 'context'].include?(key)
+      next if ['src', 'context', 'str'].include?(key)
       yt_assert yt_get(key,file,test), parse(key, file, test, context)
     end
   end
 
   def parse(key, file, test, opts)
-    @context = {:node => 'var1', :node_class => Dummy}
-    source = yt_get('src', file, test)
-    case key
-    when 'tem'
-      source ? RubyLess.translate(source, self) : yt_get('tem', file, test)
-    when 'res'
-      res = RubyLess.translate(source, self)
-      eval(source ? RubyLess.translate(source, self) : yt_get('tem', file, test)).to_s
-    when 'sxp'
-      RubyParser.new.parse(source).inspect
-    else
-      "Unknown key '#{key}'. Should be 'tem' or 'res'."
+    @context = {:node => 'node', :node_class => Dummy}
+    if source = yt_get('str', file, test)
+      case key
+      when 'tem'
+        source ? RubyLess.translate_string(source, self) : yt_get('tem', file, test)
+      when 'res'
+        eval(source ? RubyLess.translate_string(source, self) : yt_get('tem', file, test)).to_s
+      when 'sxp'
+        RubyParser.new.parse(source).inspect
+      else
+        "Unknown key '#{key}'. Should be 'tem' or 'res'."
+      end
+    elsif source = yt_get('src', file, test)
+      case key
+      when 'tem'
+        source ? RubyLess.translate(source, self) : yt_get('tem', file, test)
+      when 'res'
+        res = RubyLess.translate(source, self)
+        eval(source ? RubyLess.translate(source, self) : yt_get('tem', file, test)).to_s
+      when 'sxp'
+        RubyParser.new.parse(source).inspect
+      else
+        "Unknown key '#{key}'. Should be 'tem' or 'res'."
+      end
     end
-  rescue => err
-    #puts "\n\n#{err.message}"
-    #puts err.backtrace
+  rescue RubyLess::Error => err
+    # puts "\n\n#{err.message}"
+    # puts err.backtrace
     err.message
   end
 

data/test/mock/dummy_class.rb

@@ -1,9 +1,13 @@
 require File.dirname(__FILE__) + '/active_record_mock'
+require File.dirname(__FILE__) + '/dummy_module'
+require File.dirname(__FILE__) + '/property_column'
 
 class Dummy < RubyLess::ActiveRecordMock
-  attr_reader :name
+  include DummyModule
   include RubyLess::SafeClass
 
+  attr_reader :name
+
   safe_method  [:ancestor?, Dummy]  => Boolean
   safe_method  :parent              => {:class => 'Dummy', :special_option => 'foobar'},
                :children            => ['Dummy'],
@@ -12,7 +16,8 @@ class Dummy < RubyLess::ActiveRecordMock
                :id                  => {:class => Number, :method => :zip},
                :name                => String,
                :foo                 => :bar,
-               [:width, {:mode => String, :type => String, 'nice' => Boolean}]       => String
+               [:width, {:mode => String, :type => String, 'nice' => Boolean}] => String,
+               [:width]             => String
   safe_context :spouse  => 'Dummy',
                :husband => {:class => 'Dummy', :context => {:clever => 'no'}}
 
@@ -22,6 +27,23 @@ class Dummy < RubyLess::ActiveRecordMock
     @name = name
   end
 
+  # Mock Property ================= [
+  def self.schema; self; end
+  def self.columns
+    {
+      'dog_name' => MockPropertyColumn.new('dog_name', nil, :string),
+      'dog_age'  => MockPropertyColumn.new('dog_age', 0, :number),
+    }
+  end
+  def prop
+    {
+      'dog_name' => 'Biscotte',
+      'dog_age' => 6,
+    }
+  end
+  # Mock Property ================= ]
+  safe_property  :dog_name, :dog_age
+
   def width(opts = {})
     return 'nice!' if opts['nice']
     "mode: #{(opts[:mode] || 'none')}, type: #{(opts[:type] || 'none')}"
@@ -48,4 +70,7 @@ class Dummy < RubyLess::ActiveRecordMock
   def zip
     10
   end
-end
+end
+
+class SubDummy < Dummy
+end

data/test/mock/dummy_module.rb

@@ -0,0 +1,8 @@
+module DummyModule
+  include RubyLess::SafeClass
+  safe_method :maze => {:class => String, :method => 'mazette'}
+
+  def mazette
+    "Mazette !"
+  end
+end

data/test/mock/property_column.rb

@@ -0,0 +1,21 @@
+class MockPropertyColumn
+  attr_reader :name, :default, :klass
+  def initialize(name, default, type)
+    case type
+    when :string
+      @klass = String
+    when :number
+      @klass = Number
+    end
+    @name = name
+    @default = default
+  end
+
+  def number?
+    @klass == Number
+  end
+
+  def text?
+    @klass == String
+  end
+end

data/test/safe_class_test.rb

@@ -0,0 +1,16 @@
+require 'test_helper'
+
+class SafeClassTest < Test::Unit::TestCase
+  class SubString < String
+  end
+
+  context 'A safe model' do
+    subject do
+      Dummy
+    end
+
+    should 'have an associated SignatureHash for safe methods' do
+      assert_kind_of RubyLess::SignatureHash, Dummy.safe_methods
+    end
+  end
+end