rubyless 0.2.0 → 0.3.0

data/History.txt

@@ -1,9 +1,23 @@
+== 0.3.0 2009-10-03
+
+* 1 major enhancement
+  * Moved from ParseTree to RubyParser
+
+* 1 minor enhancement:
+  * Using Mr Bones to generate gems
+
+== 0.2.1 2009-07-01
+
+* 2 minor enhancements:
+  * :[] method is now treated as in conventional ruby (foo[:bar], not foo.[](:bar))
+  * Better error reporting in case of signature mismatch
+
 == 0.2.0 2009-06-02
 
 * 1 major enhancement:
   * Added support for ActiveRecord attributes
 
-* 2 minor enhancement:
+* 2 minor enhancements:
   * Better documentation
   * Removed eval (this means safe methods are globally declared)
 

data/{README.rdoc → README.txt}

@@ -5,16 +5,19 @@
 == DESCRIPTION:
 
 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. The goals:
+ruby, eventually rewriting some variables or methods.
+
+
+== GOALS:
 
  1. give ruby scripting access to users without any security risk
  2. rewrite variable names depending on compilation context
- 3. never raise runtime errors through compile time type checking and powerful nil handling 
+ 3. never raise runtime errors through compile time type checking and powerful nil handling
 
 This library is based on Ruby2Ruby by Ryan Davis, thanks to him for sharing his work.
 
 == SYNOPSIS:
-  
+
 For every class that will be involved in your RubyLess scripts, you need to declare safe methods with the 'safe_method' macro if
 you want to enable methods from this class. You have to specify the return type of the method. If you have some methods that
 return 'nil' instead of the declared output, you need to wrap your final ruby 'eval' with a rescue clause.
@@ -22,17 +25,17 @@ return 'nil' instead of the declared output, you need to wrap your final ruby 'e
  # signature is made of [method, arg_class, arg_class, ...]
  class Node
    include RubyLess::SafeClass
-   safe_method [:ancestor?, Node] => RubyLess::Boolean
+   safe_method [:ancestor?, Node] => Boolean
  end
- 
+
  # methods defined in helper
- 
+
  # global methods
  include RubyLess::SafeClass
  safe_method :prev => {:class => Dummy, :method => 'previous', :nil => true}
  safe_method :node => lambda {|h| {:class => h.context[:node_class], :method => h.context[:node]}}
  safe_method [:strftime, Time, String] => String
- safe_method_for String, [:==, String] => RubyLess::Boolean
+ safe_method_for String, [:==, String] => Boolean
  safe_method_for String, [:to_s] => String
 
 You can also redefine 'safe_method_type' for any class or for the main helper in order to do some more complicated renaming. Note
@@ -48,20 +51,20 @@ You can now parse some ruby code:
 
  RubyLess.translate("!prev.ancestor?(main) && !node.ancestor?(main)", self)
  => "(not previous.ancestor?(@node) and not var1.ancestor?(@node))"
- 
+
  RubyLess.translate("id > 45 and (3 > -id or 3+3)", self)
  => "(var1.zip>45 and ((3>-var1.zip) or (3+3)))"
- 
+
  RubyLess.translate("strftime(now, '%Y')", self)
  => "strftime(Time.now, \"%Y\")"
- 
+
  RubyLess.translate("log_info(spouse, spouse.name)", self)
  => "(var1.spouse ? log_info(var1.spouse, var1.spouse.name) : nil)"
 
 You can look at the tests for an idea of how to declare things. If you have more questions, ask on zena's mailing list:
 
 http://zenadmin.org/community
-  
+
 == REQUIREMENTS:
 
 * parse_tree

data/Rakefile

@@ -1,7 +1,5 @@
 require "rubygems"
-require "rake/gempackagetask"
 require "rake/rdoctask"
-require "lib/rubyless"
 
 task :default => :test
 
@@ -12,113 +10,39 @@ Rake::TestTask.new do |t|
   t.verbose = true
 end
 
-# This builds the actual gem. For details of what all these options
-# mean, and other ones you can add, check the documentation here:
-#
-#   http://rubygems.org/read/chapter/20
-#
-spec = Gem::Specification.new do |s|
-  
-  # Change these as appropriate
-  s.name              = "rubyless"
-  s.version           = RubyLess::VERSION
-  s.summary           = %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.author            = "Gaspard Bucher"
-  s.email             = "gaspard@teti.ch"
-  s.homepage          = "http://zenadmin.org/546"
 
-  s.has_rdoc          = true
-  s.extra_rdoc_files  = %w(README.rdoc)
-  s.rdoc_options      = %w(--main README.rdoc)
+# BONES gem management
 
-  # Add any extra files to include in the gem
-  s.files             = %w(History.txt Rakefile README.rdoc rubyless.gemspec) + Dir.glob("{test,lib}/**/*")
-   
-  s.require_paths     = ["lib"]
-  
-  # If you want to depend on other gems, add them here, along with any
-  # relevant versions
-  # s.add_dependency("some_other_gem", "~> 0.1.0")
-  
-  # If your tests use any gems, include them here
-  # s.add_development_dependency("mocha")
-
-  # If you want to publish automatically to rubyforge, you'll may need
-  # to tweak this, and the publishing task below too.
-  s.rubyforge_project = "rubyless"
-end
-
-# This task actually builds the gem. We also regenerate a static 
-# .gemspec file, which is useful if something (i.e. GitHub) will
-# be automatically building a gem for this project. If you're not
-# using GitHub, edit as appropriate.
-Rake::GemPackageTask.new(spec) do |pkg|
-  pkg.gem_spec = spec
-  
-  # Generate the gemspec file for github.
-  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
-  File.open(file, "w") {|f| f << spec.to_ruby }
-end
-
-# Generate documentation
-Rake::RDocTask.new do |rd|
-  rd.main = "README.rdoc"
-  rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
-  rd.rdoc_dir = "rdoc"
-end
-
-desc 'Clear out RDoc and generated packages'
-task :clean => [:clobber_rdoc, :clobber_package] do
-  rm "#{spec.name}.gemspec"
-end
-
-# If you want to publish to RubyForge automatically, here's a simple 
-# task to help do that. If you don't, just get rid of this.
-# Be sure to set up your Rubyforge account details with the Rubyforge
-# gem; you'll need to run `rubyforge setup` and `rubyforge config` at
-# the very least.
 begin
-  require "rake/contrib/sshpublisher"
-  namespace :rubyforge do
-    
-    desc "Release gem and RDoc documentation to RubyForge"
-    task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
-    
-    namespace :release do
-      desc "Release a new version of this gem"
-      task :gem => [:package] do
-        require 'rubyforge'
-        rubyforge = RubyForge.new
-        rubyforge.configure
-        rubyforge.login
-        rubyforge.userconfig['release_notes'] = spec.summary
-        path_to_gem = File.join(File.dirname(__FILE__), "pkg", "#{spec.name}-#{spec.version}.gem")
-        puts "Publishing #{spec.name}-#{spec.version.to_s} to Rubyforge..."
-        rubyforge.add_release(spec.rubyforge_project, spec.name, spec.version.to_s, path_to_gem)
-      end
-    
-      desc "Publish RDoc to RubyForge."
-      task :docs => [:rdoc] do
-        config = YAML.load(
-            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
-        )
- 
-        host = "#{config['username']}@rubyforge.org"
-        remote_dir = "/var/www/gforge-projects/rubyless/" # Should be the same as the rubyforge project name
-        local_dir = 'rdoc'
- 
-        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
-      end
-    end
-  end
+  require 'bones'
+  Bones.setup
 rescue LoadError
-  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
+  begin
+    load 'tasks/setup.rb'
+  rescue LoadError
+    raise RuntimeError, '### please install the "bones" gem ###'
+  end
 end
 
-desc 'Generate the gemspec to serve this Gem from Github'
-task :github do
-  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
-  File.open(file, 'w') {|f| f << spec.to_ruby }
-  puts "Created gemspec: #{file}"
-end
+ensure_in_path 'lib'
+require 'rubyless'
+
+PROJ.name = 'rubyless'
+PROJ.authors = 'Gaspard Bucher'
+PROJ.email = 'gaspard@teti.ch'
+PROJ.url = 'http://zenadmin.org/546'
+PROJ.version = RubyLess::VERSION
+PROJ.rubyforge.name = 'rubyless'
+
+PROJ.spec.opts << '--color'
+PROJ.gem.files = (
+  ['History.txt', 'README.txt', 'Rakefile', 'rubyless.gemspec'] +
+  ['lib', 'test'].map do |d|
+    Dir.glob("#{d}/**/*").reject {|path| File.basename(path) =~ /^\./ }
+  end
+).flatten
+
+PROJ.gem.dependencies << ['ruby_parser', '>= 2.0.4']
+PROJ.gem.dependencies << ['sexp_processor', '>= 3.0.1']
+PROJ.gem.development_dependencies << ['yamltest', '>= 0.5.3']
+

data/lib/basic_types.rb

@@ -1,39 +1,15 @@
 require 'safe_class'
 
-module RubyLess
-  
-  class Boolean
-  end
-  
-  class Number
-    include SafeClass
-    safe_method( [:==, Number] => Boolean, [:< , Number] => Boolean, [:> , Number] => Boolean, [:<=, Number] => Boolean, [:>=, Number] => Boolean,
-                 [:- , Number] => Number,  [:+ , Number] => Number,  [:* , Number] => Number,  [:/ , Number] => Number,
-                 [:% , Number] => Number,  [:"-@"]       => Number )
-  end
-  
-  
-  class Missing
-    [:==, :< , :> , :<=, :>=, :"?"].each do |sym|
-      define_method(sym) do |arg|
-        false
-      end
-    end
-    
-    def to_s
-      ''
-    end
-    
-    def nil?
-      true
-    end
-    
-    def method_missing(*meth)
-      self
-    end
-  end
-  
-  Nil = Missing.new
 
-  
-end
+class Boolean
+end
+
+class Number
+end
+
+
+RubyLess::SafeClass.safe_method_for( Number,
+             [:==, Number] => Boolean, [:< , Number] => Boolean, [:> , Number] => Boolean, [:<=, Number] => Boolean, [:>=, Number] => Boolean,
+             [:- , Number] => Number,  [:+ , Number] => Number,  [:* , Number] => Number,  [:/ , Number] => Number,
+             [:% , Number] => Number,  [:"-@"]       => Number )
+             

data/lib/processor.rb

@@ -1,11 +1,14 @@
 require 'rubygems'
-require 'parse_tree'
+require 'ruby_parser'
+require 'sexp_processor'
 
 require 'basic_types'
 require 'typed_string'
 require 'safe_class'
+require 'ruby-debug'
+Debugger.start
 
-module RubyLess  
+module RubyLess
   class RubyLessProcessor < SexpProcessor
     attr_reader :ruby
 
@@ -13,19 +16,25 @@ module RubyLess
     PREFIX_OPERATOR   = [:"-@"]
 
     def self.translate(string, helper)
-      sexp = ParseTree.translate(string)
+      sexp = RubyParser.new.parse(string)
       self.new(helper).process(sexp)
     end
 
     def initialize(helper)
       super()
-      @helper     = helper
-      @indent     = "  "
+      @helper = helper
+      @indent = "  "
       self.auto_shift_type = true
       self.strict = true
       self.expected = TypedString
     end
 
+    #def process(exp)
+    #  return nil if exp.nil?
+    #  method = exp.shift
+    #  send("process_#{method}", exp)
+    #end
+
     def process_and(exp)
       t "(#{process(exp.shift)} and #{process(exp.shift)})", Boolean
     end
@@ -37,12 +46,12 @@ module RubyLess
     def process_not(exp)
       t "not #{process(exp.shift)}", Boolean
     end
-    
+
     def process_if(exp)
       cond      = process(exp.shift)
       true_res  = process(exp.shift)
       false_res = process(exp.shift)
-      
+
       if true_res && false_res && true_res.klass != false_res.klass
         raise "Error in conditional expression: '#{true_res}' and '#{false_res}' do not return results of same type (#{true_res.klass} != #{false_res.klass})."
       end
@@ -90,7 +99,8 @@ module RubyLess
     end
 
     def process_lit(exp)
-      t exp.shift.to_s, Number
+      lit = exp.shift
+      t lit.inspect, lit.class == Symbol ? Symbol : Number
     end
 
     def process_str(exp)
@@ -114,7 +124,7 @@ module RubyLess
         end
         TypedString.new(content, opts)
       end
-      
+
       def t_if(cond, true_res, opts)
         if cond != []
           if cond.size > 1
@@ -122,7 +132,7 @@ module RubyLess
           else
             condition = cond.join('')
           end
-          
+
           # we can append to 'raw'
           if opts[:nil]
             # applied method could produce a nil value (so we cannot concat method on top of 'raw' and only check previous condition)
@@ -138,9 +148,14 @@ module RubyLess
 
       def method_call(receiver, exp)
         method = exp.shift
-        if args = exp.shift rescue nil
-          args = process args || []
-          signature = [method] + [args.klass].flatten ## FIXME: error prone !
+        arg_sexp = args = exp.shift # rescue nil
+        if arg_sexp
+          args = process(arg_sexp)
+          if args == ''
+            signature = [method]
+          else
+            signature = [method] + [args.klass].flatten
+          end
           # execution conditional
           cond = args.cond || []
         else
@@ -148,12 +163,12 @@ module RubyLess
           signature = [method]
           cond = []
         end
-        
+
         if receiver
           if receiver.could_be_nil?
             cond += receiver.cond
           end
-          raise "'#{receiver}' does not respond to '#{method}(#{args.raw})'." unless opts = get_method(signature, receiver.klass)
+          raise "'#{receiver}' does not respond to '#{method}(#{signature[1..-1].join(', ')})'." unless opts = get_method(signature, receiver.klass)
           method = opts[:method] if opts[:method]
           if method == :/
             t_if cond, "(#{receiver.raw}#{method}#{args.raw} rescue nil)", opts.merge(:nil => true)
@@ -161,14 +176,16 @@ module RubyLess
             t_if cond, "(#{receiver.raw}#{method}#{args.raw})", opts
           elsif PREFIX_OPERATOR.include?(method)
             t_if cond, "#{method.to_s[0..0]}#{receiver.raw}", opts
+          elsif method == :[]
+            t_if cond, "#{receiver.raw}[#{args.raw}]", opts
           else
-            args = "(#{args.raw})" if args != []
+            args = "(#{args.raw})" if args != ''
             t_if cond, "#{receiver.raw}.#{method}#{args}", opts
           end
         else
           raise "Unknown method '#{method}(#{args.raw})'." unless opts = get_method(signature, @helper, false)
           method = opts[:method] if opts[:method]
-          args = "(#{args.raw})" if args != []
+          args = "(#{args.raw})" if args != ''
           t_if cond, "#{method}#{args}", opts
         end
       end
@@ -192,7 +209,7 @@ module RubyLess
         res.gsub!(/\//, '\/') if in_regex
         res
       end
-      
+
       def get_method(signature, receiver, is_method = true)
         res = receiver.respond_to?(:safe_method_type) ? receiver.safe_method_type(signature) : SafeClass.safe_method_type_for(receiver, signature)
         res = res.call(@helper) if res.kind_of?(Proc)

data/lib/rubyless.rb

@@ -6,8 +6,8 @@ require 'processor'
 =begin rdoc
 =end
 module RubyLess
-  VERSION = '0.2.0'
-  
+  VERSION = '0.3.0'
+
   def self.translate(string, helper)
     RubyLessProcessor.translate(string, helper)
   end