added variable checking in logic

Author: jpslav

Gemfile

@@ -51,6 +51,7 @@ group :development, :test do
    gem 'faker'
    gem 'factory_girl_rails', '<2.0'
    gem 'timecop'
+   gem 'single_test'
 end
 
 group :production do

Gemfile.lock

@@ -134,6 +134,7 @@ GEM
       ruby-debug-base19 (>= 0.11.19)
     ruby_core_source (0.1.5)
       archive-tar-minitar (>= 0.5.2)
+    single_test (0.4.4)
     sqlite3 (1.3.4)
     sqlite3 (1.3.4-x86-mingw32)
     sqlite3-ruby (1.3.3)
@@ -177,6 +178,7 @@ DEPENDENCIES
   recaptcha
   ruby-debug19
   saferjs!
+  single_test
   sqlite3-ruby
   therubyracer
   timecop

Rakefile

@@ -6,5 +6,8 @@
 
 require File.expand_path('../config/application', __FILE__)
 require 'rake'
+require 'single_test'
+
+SingleTest.load_tasks
 
 Quadbase::Application.load_tasks

app/models/logic.rb

@@ -3,44 +3,28 @@
 class Logic < ActiveRecord::Base
   belongs_to :logicable, :polymorphic => true
 
-  
+  validate :variable_parse_succeeds
   validate :code_runs_safely
 
   before_save :cache_code
 
+  serialize :variables_array
+  
   attr_reader :results
 
-  def run
-
-
-    # TODO on save variables, split into array (serialized in class)
-    # TODO cache this code
-
-
-    # wrapped_code = ERB.new <<-CODE
-    #   var wrapper = {
-    #     runCode: function() {
-    #       <%= code %>
-    #       test = "hi";
-    #       results = {};
-    #       <% variables.each do |variable| %>
-    #         results['<%= variable %>'] = <%= variable %>
-    #       <% end %>
-    #       return results;                  
-    #     }
-    #   }
-    # CODE
-    # 
-    # 
-    # 
-    # ready_code = wrapped_code.result(binding)
-    # # logger.debug(ready_code)
-    # 
-    # debugger
-    
-    c = SaferJS.compile(get_cached_code)
-    
-    @results = c.call('wrapper.runCode') # TODO is here the place to pass in values from prior logic?
+  JS_RESERVED_WORDS_REGEX = /^(do|if|in|for|let|new|try|var|case|else|enum|eval|
+                               false|null|this|true|void|with|break|catch|class|
+                               const|super|throw|while|yield|delete|export|
+                               import|public|return|static|switch|typeof|
+                               default|extends|finally|package|private|continue|
+                               debugger|function|arguments|interface|protected|
+                               implements|instanceof)$/
+                               
+  VARIABLE_REGEX = /^[_a-zA-Z]{1}\w*$/
+  
+  def run(seed = rand(2e9))
+    context = SaferJS.compile(get_cached_code)
+    @results = context.call('wrapper.runCode') # TODO is here the place to pass in values from prior logic?
 
     return @results
   end
@@ -60,7 +44,7 @@ def cache_code
         runCode: function() {
           <%= code %>
           results = {};
-          <% variables.each do |variable| %>
+          <% variables_array.each do |variable| %>
             results['<%= variable %>'] = <%= variable %>
           <% end %>
           return results;                  
@@ -70,4 +54,35 @@ def cache_code
 
     self.cached_code = erb_code.result(binding)
   end
+  
+  def variable_parse_succeeds
+    
+    self.variables_array = variables.split(/[\s,]+/)
+    
+    if !self.variables_array.all?{|v| VARIABLE_REGEX =~ v}    
+      errors.add(:variables, "can only contain letter, numbers and 
+                              underscores.  Additionally, the first character 
+                              must be a letter or an underscore.")
+    end
+
+    reserved_vars = self.variables_array.collect do |v| 
+      match = JS_RESERVED_WORDS_REGEX.match(v)
+      match.nil? ? nil : match[0]
+    end
+    
+    reserved_vars.compact!
+    
+    reserved_vars.each do |v|
+      errors.add(:variables, "cannot contain the reserved word '#{v}'.")
+    end
+
+    if !self.variables_array.all?{|v| JS_RESERVED_WORDS_REGEX =~ v}
+      errors.add(:variables, "")
+    end
+
+    self.variables = self.variables_array.join(", ")
+
+    errors.any?
+  end
+  
 end

db/migrate/20120313200004_add_variables_array_to_logic.rb

@@ -0,0 +1,9 @@
+class AddVariablesArrayToLogic < ActiveRecord::Migration
+  def self.up
+    add_column :logics, :variables_array, :string
+  end
+
+  def self.down
+    remove_column :logics, :variables_array
+  end
+end

db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20120313182705) do
+ActiveRecord::Schema.define(:version => 20120313200004) do
 
   create_table "announcements", :force => true do |t|
     t.integer  "user_id"
@@ -100,6 +100,7 @@
     t.datetime "updated_at"
     t.integer  "predecessor_logic_id"
     t.text     "cached_code"
+    t.string   "variables_array"
   end
 
   create_table "messages", :force => true do |t|

notes.txt

@@ -40,6 +40,7 @@ rake db:test:purge 	Empty the test database.
 rake db:test:load 	Recreate the test database from the current schema.rb
 rake db:test:prepare 	Check for pending migrations and load the test schema
 rake db:test:purge; rake db:test:load; rake db:test:prepare
+be rake db:test:purge db:test:load db:test:prepare
 
 -------
 git rm --cached <file>       removes that file from version control but leaves it in the working copy

test/factories.rb

@@ -266,3 +266,8 @@ def make_project(options = {})
   f.association :deputizer, :factory => :user
   f.association :deputy, :factory => :user
 end
+
+Factory.define :logic do |f|
+  f.code "x = 2"
+  f.variables "x"
+end

test/unit/logic_test.rb

@@ -1,8 +1,16 @@
 require 'test_helper'
 
 class LogicTest < ActiveSupport::TestCase
-  # Replace this with your real tests.
-  test "the truth" do
-    assert true
+
+  test "basic" do
+    assert_nothing_raised{Factory.create(:logic)}
+  end
+
+  test "reserved words not allowed" do
+    assert_raise(ActiveRecord::RecordInvalid) {Factory.create(:logic, :variables => 'x, y, continue')}
+  end
+  
+  test "start with letter or underscore" do
+    assert_raise(ActiveRecord::RecordInvalid) {Factory.create(:logic, :variables => '9x')}
   end
 end