mack-distributed 0.7.0

data/README

@@ -0,0 +1,106 @@
+=== Setup
+
+Using distributed functionality with Mack is incredibly easy. The first thing we need to do is start the Mack ring server.
+
+  mack_ring_server start
+  
+That's the glue that holds everything together. The ring server acts a registry/lookup agent so applications know where to find the services they are looking for.
+
+In order to use the distributed functionality, you really need two applications. The first application will be serving the distributed object(s), routes, etc... and the second application will be using the distributed functionality. Both applications will need the mack-distributed gem. In the config/initializers/gems.rb add the following to both applications:
+
+  gem.add "mack-distributed", :libs => "mack-distributed"
+
+== Using Distributed Objects (Models)
+
+Distributed objects are an easy way to share functionality across many different Mack applications. Whether it's a database model, or a bit of library code, it's easy to share and re-use.
+
+=== Application #1 (Server)
+
+Let's configure our 'server' application. This is where pretty much all the 'heavy lifting' is done. First we need setup our configuration file:
+
+config/app_config/default.yml:
+  # All distributed applications need to have a unique name so they can easily be identified for lookup.
+  mack::distributed_app_name: my_cool_app
+  # Turn object sharing on
+  mack::share_objects: true
+
+Let's assume that we have a simple User DataMapper model that looks something like this:
+
+  class User
+    include DataMapper::Resource
+
+    property :id, Serial
+    property :username, String
+  end
+
+It takes only one line of code to make that into a distributed object. We just need to include Mack::Distributable into the User class, like such:
+
+  class User
+    include Mack::Distributable
+    include DataMapper::Resource
+
+    property :id, Serial
+    property :username, String
+  end
+
+Now, start your server:
+
+  rake server
+
+=== Application #2 (Client)
+
+Here's where things get really cool. We don't have to do anything else to our second application to get it find and use our User model from the first application. When we add the mack-distributed gem, we've given it all the magic it needs to run.
+
+Let's start up our console:
+
+  rake console
+
+Now, in our console we can do the following:
+
+  user = Mack::Distributed::User.new
+  user.username = "foobar"
+  user.save
+
+In the first application you'll see an insert into the users table in the logs. If you look in the database, you'll see that we've successfully created a new user.
+
+=== How does it work?
+
+When you include Mack::Distributable into a class it registers a proxy of that class with ring server. When another application makes a call to Mack::Distributed::<class_name> it looks up and finds that class in the ring server and returns the proxy object to you. 
+
+=== Using Distributed Views
+With distributed views, you can easily share views and layouts among different Mack Applications.
+  
+== Application #1 (Server)
+config/app_config/default.yml:
+mack::distributed_site_domain: http://localhost:3001
+mack::distributed_app_name: my_cool_app
+# Turn view sharing on
+mack::share_views: true
+# and all the model sharing settings...
+
+That's it.  When the server is started, the distributed view module will register a proxy with rinda ready for use by the client.
+
+== Application #2 (Client)
+To use distributed view, you need to specify a fully qualified distributed URI in the form of:
+    distributed://app_name/path
+so, let's say I want to render a page using a layout in application 1, I'd do:
+    render(:action, "index", :layout => "distributed://my_cool_app/application")
+The above code will render the index page using application.html layout that lives in the application #1 space.
+
+You can also specify the distributed layout globally in the controller.  Example:
+
+    class MyController
+        include Mack::Controller
+        
+        layout "distributed://my_cool_app/application"
+    end
+
+All the actions in MyController will use the distributed layout
+
+Now, to render a distributed view, you'd do the following:
+
+    render(:distributed, "distributed://my_cool_app/admin/index")
+
+---------
+
+Enjoy!

data/bin/mack_ring_server

@@ -0,0 +1,33 @@
+#!/usr/local/bin/ruby
+require 'rubygems'
+require 'daemons'
+require 'rinda/ring'
+require 'rinda/tuplespace'
+require 'fileutils' 
+require 'optparse'
+require 'optparse/time'
+require 'ostruct'
+
+options = OpenStruct.new
+opts = OptionParser.new do |opts|
+  opts.banner = <<-BANNER
+Usage: mack_ring_server <command>
+Available commands are:
+
+- start
+- stop
+- restart
+
+BANNER
+end
+
+opts.parse!(ARGV)
+
+FileUtils.mkdir_p(File.join("tmp", "pids"))
+
+Daemons.run_proc('mack_ring_server', {:dir_mode => :normal, :dir => File.join("tmp", "pids"), :monitor => true, :multiple => false}) do
+  puts 'Starting mack_ring_server...'
+  DRb.start_service
+  Rinda::RingServer.new(Rinda::TupleSpace.new)
+  DRb.thread.join
+end

data/doc/classes/Mack/Distributable.html

@@ -0,0 +1,137 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Module: Mack::Distributable</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Module</strong></td>
+          <td class="class-name-in-header">Mack::Distributable</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/mack-distributed/distributable_rb.html">
+                lib/mack-distributed/distributable.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+Include this module into any class it will instantly register that class
+with the mack_ring_server. The class will be registered with the name of
+the class and the mack.distributed_app_name configured in your
+config/app_config/*.yml file. If the mack.distributed_app_name
+configuration parameter is nil it will raise an <a
+href="Distributed/Errors/ApplicationNameUndefined.html">Mack::Distributed::Errors::ApplicationNameUndefined</a>
+exception.
+</p>
+<p>
+Example:
+</p>
+<pre>
+ class User
+   include Mack::Distributable
+   def name
+     &quot;mark&quot;
+   end
+ end
+
+ Mack::Distributed::User.new.name # =&gt; &quot;mark&quot;
+</pre>
+
+    </div>
+
+
+   </div>
+
+
+  </div>
+
+
+    <!-- if includes -->
+    <div id="includes">
+      <h3 class="section-bar">Included Modules</h3>
+
+      <div id="includes-list">
+        <span class="include-name">::DRbUndumped</span>
+      </div>
+    </div>
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>

data/doc/classes/Mack/Distributed/Errors/ApplicationNameUndefined.html

@@ -0,0 +1,118 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: Mack::Distributed::Errors::ApplicationNameUndefined</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">Mack::Distributed::Errors::ApplicationNameUndefined</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../../../files/lib/mack-distributed/errors/errors_rb.html">
+                lib/mack-distributed/errors/errors.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                StandardError
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+Raised when an application doesn&#8216;t declare it&#8216;s application
+name for use in a distributed system.
+</p>
+
+    </div>
+
+
+   </div>
+
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>

data/doc/classes/Mack/Distributed/Errors/InvalidAddressableURIFormat.html

@@ -0,0 +1,152 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: Mack::Distributed::Errors::InvalidAddressableURIFormat</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">Mack::Distributed::Errors::InvalidAddressableURIFormat</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../../../files/lib/mack-distributed/errors/errors_rb.html">
+                lib/mack-distributed/errors/errors.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                StandardError
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+Raised when the distributed path is not a well formed addressable format
+</p>
+
+    </div>
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000003">inititalize</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000003" class="method-detail">
+        <a name="M000003"></a>
+
+        <div class="method-heading">
+          <a href="#M000003" class="method-signature">
+          <span class="method-name">inititalize</span><span class="method-args">(msg)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000003-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000003-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mack-distributed/errors/errors.rb, line 27</span>
+27:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">inititalize</span>(<span class="ruby-identifier">msg</span>)
+28:           <span class="ruby-keyword kw">super</span>(<span class="ruby-node">&quot;Invalid addressable format: #{msg}&quot;</span>)
+29:         <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+
+    </div>
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>

data/doc/classes/Mack/Distributed/Errors/UnknownApplication.html

@@ -0,0 +1,155 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: Mack::Distributed::Errors::UnknownApplication</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">Mack::Distributed::Errors::UnknownApplication</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../../../files/lib/mack-distributed/errors/errors_rb.html">
+                lib/mack-distributed/errors/errors.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                StandardError
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+Raised when an unknown distributed application is referenced.
+</p>
+
+    </div>
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000005">new</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+
+      <div id="method-M000005" class="method-detail">
+        <a name="M000005"></a>
+
+        <div class="method-heading">
+          <a href="#M000005" class="method-signature">
+          <span class="method-name">new</span><span class="method-args">(app_name)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Takes the application name.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000005-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000005-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mack-distributed/errors/errors.rb, line 8</span>
+ 8:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">app_name</span>)
+ 9:           <span class="ruby-keyword kw">super</span>(<span class="ruby-node">&quot;APPLICATION: #{app_name} is not a known/registered distributed application.&quot;</span>)
+10:         <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+
+    </div>
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>