RubyGems - distributed_rails - Versions diffs - 0.0.1 - Mend

distributed_rails 0.0.1

Files changed (53) hide show

data/MIT-LICENSE +20 -0
data/Rakefile +40 -0
data/app/assets/javascripts/distributed_rails/application.js +15 -0
data/app/assets/javascripts/distributed_rails/distribute.js.erb +52 -0
data/app/assets/javascripts/distributed_rails/json2.js +487 -0
data/app/assets/javascripts/distributed_rails/tasks.js +2 -0
data/app/assets/stylesheets/distributed_rails/application.css +13 -0
data/app/controllers/distributed_rails/application_controller.rb +4 -0
data/app/controllers/distributed_rails/tasks_controller.rb +19 -0
data/app/helpers/distributed_rails/application_helper.rb +4 -0
data/app/helpers/distributed_rails/tasks_helper.rb +4 -0
data/app/models/distributed_rails/task.rb +90 -0
data/app/views/distributed_rails/tasks/distributed_task.js +7 -0
data/app/views/layouts/distributed_rails/application.html.erb +14 -0
data/config/routes.rb +6 -0
data/db/migrate/20121004155021_create_distributed_rails_tasks.rb +15 -0
data/lib/distributed_rails/engine.rb +5 -0
data/lib/distributed_rails/version.rb +3 -0
data/lib/distributed_rails.rb +4 -0
data/lib/tasks/distributed_rails_tasks.rake +64 -0
data/readme.md +85 -0
data/test/distributed_rails_test.rb +7 -0
data/test/dummy/README.rdoc +261 -0
data/test/dummy/Rakefile +7 -0
data/test/dummy/app/assets/javascripts/application.js +15 -0
data/test/dummy/app/assets/stylesheets/application.css +13 -0
data/test/dummy/app/controllers/application_controller.rb +3 -0
data/test/dummy/app/helpers/application_helper.rb +2 -0
data/test/dummy/app/views/layouts/application.html.erb +14 -0
data/test/dummy/config/application.rb +59 -0
data/test/dummy/config/boot.rb +10 -0
data/test/dummy/config/database.yml +25 -0
data/test/dummy/config/environment.rb +5 -0
data/test/dummy/config/environments/development.rb +37 -0
data/test/dummy/config/environments/production.rb +67 -0
data/test/dummy/config/environments/test.rb +37 -0
data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/test/dummy/config/initializers/inflections.rb +15 -0
data/test/dummy/config/initializers/mime_types.rb +5 -0
data/test/dummy/config/initializers/secret_token.rb +7 -0
data/test/dummy/config/initializers/session_store.rb +8 -0
data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
data/test/dummy/config/locales/en.yml +5 -0
data/test/dummy/config/routes.rb +4 -0
data/test/dummy/config.ru +4 -0
data/test/dummy/public/404.html +26 -0
data/test/dummy/public/422.html +26 -0
data/test/dummy/public/500.html +25 -0
data/test/dummy/public/favicon.ico +0 -0
data/test/dummy/script/rails +6 -0
data/test/integration/navigation_test.rb +10 -0
data/test/test_helper.rb +15 -0
metadata +161 -0

data/app/models/distributed_rails/task.rb ADDED Viewed

@@ -0,0 +1,90 @@
+module DistributedRails
+  class Task < ActiveRecord::Base
+    attr_accessible :distributed, :filename, :finished
+    attr_accessible :name, :parameters, :result, :verified
+    before_create :default_values
+    def self.distribute_task
+      # 10% of the time, verify an already completed task
+      if Random.rand(10) == 0
+        task = self.next_verification_task
+        # the other 90% of the time, take a task from the queue
+      else
+        task = self.next_ready_task
+        if !task
+          task = self.next_verification_task
+        else
+          task.distributed = true
+          task.save
+        end
+      end
+      return task
+    end
+    def parameters=(parameters)
+      write_attribute(:parameters, "[#{parameters}]")
+    end
+    def result=(result)
+      if result and self.result
+        verify_result(result)
+      elsif result
+        add_new_result(result)
+      end
+    end
+    def add_new_result(result)
+      # Can't call result= because it will call this function'
+      write_attribute(:result, result)
+      self.finished = true
+      save
+    end
+    def verify_result(result)
+      if result == self.result
+        self.verified = true
+        save
+      else
+        self.finished = false
+        self.distributed = false
+        self.verified = false
+        # Can't call result= because it will call this function'
+        write_attribute(:result, nil)
+        save
+      end
+    end
+    private
+    def self.next_ready_task
+      clean_up_tasks
+      task = Task.where(:distributed => false).first
+    end
+    def self.next_verification_task
+      q = Task.where(:distributed => true,
+                     :finished => true,
+                     :verified => false)
+      return q.offset(rand(q.count)).first || self.next_ready_task
+    end
+    def default_values
+      self.distributed = false
+      self.finished = false
+      self.result = nil
+    end
+    def self.clean_up_tasks
+      unfinished_tasks =
+        Task.where("updated_at <= ?",
+                   Time.now - 15.minutes).where(
+                                                :distributed => true,
+                                                :finished => false)
+      for task in unfinished_tasks
+        task.finished = false
+        task.distributed = false
+        task.save
+      end
+    end
+  end
+end

data/app/views/distributed_rails/tasks/distributed_task.js ADDED Viewed

@@ -0,0 +1,7 @@
+var distributed_task_id = <%= @task.id %>;
+<% if @task.parameters %>
+distributed_parameters = <%= raw @task.parameters %>;
+<% end %>
+<%= render file:@task.filename %>

data/app/views/layouts/distributed_rails/application.html.erb ADDED Viewed

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>DistributedRails</title>
+  <%= stylesheet_link_tag    "distributed_rails/application", :media => "all" %>
+  <%= javascript_include_tag "distributed_rails/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+<%= yield %>
+</body>
+</html>

data/config/routes.rb ADDED Viewed

@@ -0,0 +1,6 @@
+DistributedRails::Engine.routes.draw do
+  match 'tasks/next' => 'tasks#next', :as => :task
+  match 'tasks/result' => 'tasks#result', :as => :result
+end

data/db/migrate/20121004155021_create_distributed_rails_tasks.rb ADDED Viewed

@@ -0,0 +1,15 @@
+class CreateDistributedRailsTasks < ActiveRecord::Migration
+  def change
+    create_table :distributed_rails_tasks do |t|
+      t.string :filename
+      t.string :name
+      t.boolean :distributed
+      t.boolean :finished
+      t.boolean :verified
+      t.text :result
+      t.text :parameters
+      t.timestamps
+    end
+  end
+end

data/lib/distributed_rails/engine.rb ADDED Viewed

@@ -0,0 +1,5 @@
+module DistributedRails
+  class Engine < ::Rails::Engine
+    isolate_namespace DistributedRails
+  end
+end

data/lib/distributed_rails/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module DistributedRails
+  VERSION = "0.0.1"
+end

data/lib/distributed_rails.rb ADDED Viewed

@@ -0,0 +1,4 @@
+require "distributed_rails/engine"
+module DistributedRails
+end

data/lib/tasks/distributed_rails_tasks.rake ADDED Viewed

@@ -0,0 +1,64 @@
+TASK_ROOT = "#{Rails.root}/app/tasks"
+namespace :tasksjs do
+  directory "app/tasks"
+  desc "Collect tasks in app/tasks and add them to db"
+  task :add_all_to_db => [:environment, "app/tasks"] do
+    get_all_tasks_from_folder
+  end
+  desc "Delete tasks db and add all tasks from app/tasks"
+  task :init => [:environment, "app/tasks"] do
+    DistributedRails::Task.delete_all
+    get_all_tasks_from_folder
+  end
+  desc "Repeatedly insert tasks :arg times\
+      (pass verified = true if you're doing a random operation')"
+  task :repeated, [:times, :verified] => [:environment, "app/tasks"] do |t, args|
+    DistributedRails::Task.delete_all
+    args.with_defaults(:times => 100, :verified => false)
+    args[:verified] = true if args[:verified]
+    puts "Running #{args[:times]} times"
+    repeat = Integer(args[:times])
+    repeat.times do
+      get_all_tasks_from_folder(args[:verified])
+    end
+  end
+  desc "Mark unfinished tasks as new"
+  task :cleanup => :environment do
+    DistributedRails::Task.clean_up_tasks
+  end
+end
+def get_all_tasks_from_folder(verified=false)
+  js_tasks = Dir.glob("#{TASK_ROOT}/task*.js*")
+  for js_task in js_tasks
+    add_task_and_get_parameters(js_task, verified)
+  end
+end
+def add_task_and_get_parameters(js_task, verified=false)
+  parameters = get_parameters_for_js_task(js_task)
+  begin
+    DistributedRails::Task.create!( name: js_task,
+                                    filename: js_task,
+                                    parameters: parameters.pop,
+                                    verified: verified)
+  end while !parameters.empty?
+end
+def get_parameters_for_js_task(js_task)
+  base_name = File.basename(js_task, ".*")
+  parameters_files = Dir.glob("#{TASK_ROOT}/parameters_#{base_name}.*")
+  parameters = []
+  for filename in parameters_files
+    file = File.open(filename, 'r')
+    file.each do |line|
+      parameters << line.squish
+    end
+  end
+  return parameters
+end

data/readme.md ADDED Viewed

@@ -0,0 +1,85 @@
+# DistributedRails
+## Distributes tasks to multiple browsers
+Inspired by projects like folding@home and SETI@home, this is a
+plugin for Rails that allows the server to distribute tasks
+to its clients (browsers). This is best suited for highly
+parallelizeable tasks such as monte-carlo simulations or other
+[embarassingly parallel problems](http://en.wikipedia.org/wiki/Embarrassingly_parallel).
+Original (read: deprecated) project: ciniglio/distributed
+## Usage
+#### Install with bundler
+`gem 'distributed_rails', :git =>
+'git://github.com/ciniglio/distributedrails.git'`
+#### Then in your routes.rb:
+`mount DistributedRails::Engine, :at => '/tasks'`
+#### Finally, in whichever template you'd like this to run from
+##### e.g. `layouts/application.html.erb`
+Add the line
+`<%= javascript_include_tag "distributed_rails/application" %>`
+#### Now we're ready to get cooking!
+- Provide tasks.js files in app/tasks
+- task*.js must define `var nextTask = main_function_name`
+- The result of `main_function_name` will be saved in the db
+## Notes
+### Verification
+Already completed tasks will run again on a new machine and the
+results will be compared (about 10% of the time). This gives some
+additional confidence in the results, but is by no means a security
+guarantee.
+Some tasks (e.g. random generations) are not well suited for
+verification. For these tasks, the `rake tasksjs:repeated` command
+takes an additional argument to omit verification.
+### Rakefile
+A Rakefile has been provided to make some common tasks easier. The
+namespace is `tasksjs`.
+*Note:* For rake operations that add tasks to the database, rake will
+ also look for a parameters file `parameters_task*.txt` in the same
+ location, and will use parameters on a single line. See more at
+ [parameters](#parameters)
+- `rake tasksjs:init` will clear all tasks from the database, then go
+  through all the tasks in app/tasks and add them to the database
+- `rake tasksjs:repeated` will take an argument `num` and add all the tasks
+  in app/tasks `num` times.
+- as noted above `rake tasksjs:repeated` will take an additional
+  argument to disable verification. If you want verification to be
+  disabled, you should pass "true".
+#### Parameters
+The `parameters_task*.txt` file is expected to have
+all the needed comma separated parameters on one line. This will then
+be applied to the function in `task*.txt`, once for every line.
+A `parameters_task*.txt` like the following:
+```
+0, "james", "sally"
+5, "john", "jerry"
+```
+will result in two tasks being added to the queue:
+- `task*.js` with args `0, "james", "sally"`
+- `task*.js` with args `5, "john", "jerry"`
+### Initial Goals
+- browsers execute arbitrary tasks and return results to browser
+- server manages queue from db
+- things are added to queue only by the server (clients adding tasks
+  is a non-goal for now)

data/test/distributed_rails_test.rb ADDED Viewed

@@ -0,0 +1,7 @@
+require 'test_helper'
+class DistributedRailsTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, DistributedRails
+  end
+end

data/test/dummy/README.rdoc ADDED Viewed

@@ -0,0 +1,261 @@
+== Welcome to Rails
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+== Getting Started
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+== Debugging Rails
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+The result will be a message in your log file along the lines of:
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+== Debugger
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+...and even better, you can examine how your runtime objects actually work:
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+Finally, when you're ready to resume execution, you can enter "cont".
+== Console
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+To start the console, run <tt>rails console</tt> from the application
+directory.
+Options:
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+== dbconsole
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+== Description of Contents
+The default directory structure of a generated Ruby on Rails application:
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+app
+  Holds all the code that's specific to this particular application.
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+script
+  Helper scripts for automation and generation.
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/test/dummy/Rakefile ADDED Viewed

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+require File.expand_path('../config/application', __FILE__)
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js ADDED Viewed

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css ADDED Viewed

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/test/dummy/app/controllers/application_controller.rb ADDED Viewed

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy/app/helpers/application_helper.rb ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ module ApplicationHelper
2	+ end

data/test/dummy/app/views/layouts/application.html.erb ADDED Viewed

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", :media => "all" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+<%= yield %>
+</body>
+</html>