RubyGems - muck-activity - Versions diffs - 0.1.1 → 0.1.2 - Mend

muck-activity 0.1.1 → 0.1.2

Files changed (52) hide show

data/Rakefile +3 -3
data/VERSION +1 -1
data/locales/ar.yml +23 -0
data/locales/bg.yml +23 -0
data/locales/ca.yml +23 -0
data/locales/cs.yml +23 -0
data/locales/da.yml +23 -0
data/locales/de.yml +23 -0
data/locales/el.yml +23 -0
data/locales/es.yml +23 -0
data/locales/fr.yml +23 -0
data/locales/it.yml +23 -0
data/locales/iw.yml +23 -0
data/locales/ja.yml +23 -0
data/locales/ko.yml +23 -0
data/locales/lt.yml +23 -0
data/locales/lv.yml +23 -0
data/locales/nl.yml +23 -0
data/locales/no.yml +24 -0
data/locales/pl.yml +23 -0
data/locales/pt.yml +23 -0
data/locales/ro.yml +23 -0
data/locales/ru.yml +23 -0
data/locales/sk.yml +23 -0
data/locales/sl.yml +23 -0
data/locales/sr.yml +23 -0
data/locales/sv.yml +23 -0
data/locales/tl.yml +23 -0
data/locales/uk.yml +23 -0
data/locales/vi.yml +23 -0
data/locales/zh-CN.yml +23 -0
data/locales/zh-TW.yml +23 -0
data/locales/zh.yml +23 -0
data/muck-activity.gemspec +182 -0
data/pkg/muck-activity-0.1.2.gem +0 -0
data/rdoc/classes/ActionController.html +107 -0
data/rdoc/classes/ActionController/Routing.html +107 -0
data/rdoc/classes/ActionController/Routing/RouteSet.html +148 -0
data/rdoc/classes/MuckActivity/ActMethods.html +189 -0
data/rdoc/classes/MuckActivity/InstanceMethods.html +244 -0
data/rdoc/classes/MuckActivity/Tasks.html +146 -0
data/rdoc/created.rid +1 -0
data/rdoc/files/README_rdoc.html +204 -0
data/rdoc/files/lib/muck_activity/initialize_routes_rb.html +101 -0
data/rdoc/files/lib/muck_activity/tasks_rb.html +110 -0
data/rdoc/files/lib/muck_activity_rb.html +108 -0
data/rdoc/fr_class_index.html +32 -0
data/rdoc/fr_file_index.html +30 -0
data/rdoc/fr_method_index.html +33 -0
data/rdoc/index.html +24 -0
data/rdoc/rdoc-style.css +208 -0
metadata +51 -2

data/rdoc/classes/MuckActivity/InstanceMethods.html ADDED Viewed

@@ -0,0 +1,244 @@
+<?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: MuckActivity::InstanceMethods</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">MuckActivity::InstanceMethods</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/muck_activity_rb.html">
+                lib/muck_activity.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+   </div>
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+      <div class="name-list">
+      <a href="#M000004">add_activity</a>&nbsp;&nbsp;
+      <a href="#M000006">can_view?</a>&nbsp;&nbsp;
+      <a href="#M000005">status</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-M000004" class="method-detail">
+        <a name="M000004"></a>
+        <div class="method-heading">
+          <a href="#M000004" class="method-signature">
+          <span class="method-name">add_activity</span><span class="method-args">(feed_to, source, item, template, title = '', content = '', check_method = nil)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+<tt><a href="InstanceMethods.html#M000004">add_activity</a></tt> adds an
+activity to all activites feeds that belong to the objects found in
+feed_to.
+</p>
+<ul>
+<li><tt>feed_to</tt>: an array of objects that have <tt>has_activities</tt>
+declared on them. The generated activity will be pushed into the feed of
+each of these objects.
+</li>
+<li><tt>source</tt>: the object that peformed the activity ie a user or group
+</li>
+<li><tt>item</tt>: an object that will be used to generated the entry in an
+activity feed
+</li>
+<li><tt>template</tt>: name of an partial that will be used to generated the
+entry in the activity feed. Place templates in
+/app/views/activity_templates
+</li>
+<li><tt>title</tt>: optional title that can be used in the template
+</li>
+<li><tt>content</tt>: option content that can be used in the template. Useful
+for activities that might not have
+<pre>
+ an item but instead might have a message or other text.
+</pre>
+</li>
+<li><tt>check_method</tt>: method that will be called on each item in the
+feed_to array. If the method evaluates to false the activity won&#8216;t be
+added to the object&#8216;s activity feed. An example usage would be
+letting users configure which items they want to have in their activity
+feed.
+</li>
+</ul>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000004-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000004-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/muck_activity.rb, line 47</span>
+47:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_activity</span>(<span class="ruby-identifier">feed_to</span>, <span class="ruby-identifier">source</span>, <span class="ruby-identifier">item</span>, <span class="ruby-identifier">template</span>, <span class="ruby-identifier">title</span> = <span class="ruby-value str">''</span>, <span class="ruby-identifier">content</span> = <span class="ruby-value str">''</span>, <span class="ruby-identifier">check_method</span> = <span class="ruby-keyword kw">nil</span>)
+48:       <span class="ruby-identifier">feed_to</span> = [<span class="ruby-identifier">feed_to</span>] <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">feed_to</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Array</span>)
+49:       <span class="ruby-identifier">activity</span> = <span class="ruby-constant">Activity</span>.<span class="ruby-identifier">create</span>(<span class="ruby-identifier">:item</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">item</span>, <span class="ruby-identifier">:source</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">source</span>, <span class="ruby-identifier">:template</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">template</span>, <span class="ruby-identifier">:title</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">title</span>, <span class="ruby-identifier">:content</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">content</span>)
+50:       <span class="ruby-identifier">feed_to</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ft</span><span class="ruby-operator">|</span>
+51:         <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">check_method</span>
+52:           <span class="ruby-identifier">ft</span>.<span class="ruby-identifier">activities</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">activity</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">ft</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">check_method</span>)
+53:         <span class="ruby-keyword kw">else</span>
+54:           <span class="ruby-identifier">ft</span>.<span class="ruby-identifier">activities</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">activity</span>
+55:         <span class="ruby-keyword kw">end</span>
+56:       <span class="ruby-keyword kw">end</span>
+57:     <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000006" class="method-detail">
+        <a name="M000006"></a>
+        <div class="method-heading">
+          <a href="#M000006" class="method-signature">
+          <span class="method-name">can_view?</span><span class="method-args">(check_object)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000006-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000006-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/muck_activity.rb, line 65</span>
+65:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">can_view?</span>(<span class="ruby-identifier">check_object</span>)
+66:       <span class="ruby-keyword kw">self</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">check_object</span>
+67:     <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <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">status</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+<tt><a href="InstanceMethods.html#M000005">status</a></tt> returns the
+first activity item from the user&#8216;s activity feed that is a <a
+href="InstanceMethods.html#M000005">status</a> update. Used for displaying
+the last <a href="InstanceMethods.html#M000005">status</a> update the user
+made
+</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/muck_activity.rb, line 61</span>
+61:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">status</span>
+62:       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">activities</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">:first</span>, <span class="ruby-identifier">:conditions</span> =<span class="ruby-operator">&gt;</span> [<span class="ruby-value str">'is_status_update = true'</span>], <span class="ruby-identifier">:order</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">'created_at DESC'</span>)
+63:     <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/rdoc/classes/MuckActivity/Tasks.html ADDED Viewed

@@ -0,0 +1,146 @@
+<?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: MuckActivity::Tasks</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">MuckActivity::Tasks</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/muck_activity/tasks_rb.html">
+                lib/muck_activity/tasks.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                ::Rake::TaskLib
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+   </div>
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+      <div class="name-list">
+      <a href="#M000007">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-M000007" class="method-detail">
+        <a name="M000007"></a>
+        <div class="method-heading">
+          <a href="#M000007" class="method-signature">
+          <span class="method-name">new</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000007-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000007-source">
+<pre>
+   <span class="ruby-comment cmt"># File lib/muck_activity/tasks.rb, line 7</span>
+7:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
+8:       <span class="ruby-identifier">define</span>
+9:     <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/rdoc/created.rid ADDED Viewed

	@@ -0,0 +1 @@
1	+ Thu, 11 Jun 2009 23:59:14 -0600

data/rdoc/files/README_rdoc.html ADDED Viewed

@@ -0,0 +1,204 @@
+<?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>File: README.rdoc</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="fileHeader">
+    <h1>README.rdoc</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>README.rdoc
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Thu Jun 11 23:20:30 -0600 2009</td>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <h1>MuckActivity</h1>
+<h2>Installation</h2>
+<p>
+The muck activity engine is part of the muck framework and relies upon the
+muck_engine. The main engine can be found here: <a
+href="http://github.com/jbasdf/muck_engine">github.com/jbasdf/muck_engine</a>
+</p>
+<p>
+The easiest way to get started with muck is to generate your application
+using a template:
+</p>
+<pre>
+  $ rails &lt;your-app&gt; -m http://github.com/jbasdf/rails-templates/raw/master/muck.rb
+</pre>
+<p>
+Add optional functionality with the following command:
+</p>
+<pre>
+  $ rake rails:template LOCATION=http://github.com/jbasdf/rails-templates/raw/master/mucktoo.rb
+</pre>
+<h2>Usage</h2>
+<p>
+This engine implements simple activity tracking.
+</p>
+<p>
+Models that can have activity feed should call &#8216;has_activities&#8216;
+</p>
+<pre>
+  Example:
+    class User
+      has_activities
+    end
+</pre>
+<p>
+Adding an item to the activity feed requires
+&#8216;acts_as_activity_source&#8217; which then profiles the method
+&#8216;add_activity&#8216;
+</p>
+<pre>
+  add_activity(feed_to, actor, item, template, check_method)
+  feed_to - contains an array of objects (typically users) that have use acts_as_activity_user
+  actor - the user performing the action
+  item - a reference to the object that
+  template - the template (partial) to use to render the activity
+  check_method - and optional method to call on each object in the feed_to array that determines whether or not to add the activity
+  Example:
+    add_activity(user.feed_to, user, comment, 'comment')
+</pre>
+<h3>Authorization</h3>
+<p>
+By default &#8216;has_activities&#8217; will add a simple
+&#8216;can_view?&#8217; method:
+</p>
+<pre>
+  def can_view?(check_object)
+    self == check_object
+  end
+</pre>
+<p>
+This method determines whether or not the check_object has access to the
+current object&#8216;s activity feeds. For example, if the intent is to
+recover the activities for a given user where the user is
+&#8217;@parent&#8217; thus:
+</p>
+<pre>
+  @parent.can_view?(current_user)
+</pre>
+<p>
+The can view method will determine whether or not the current_user has the
+right to view the activity feed.
+</p>
+<p>
+In most instances you will need to override this method to implement proper
+security. For example, for a group that has an activity feed you might add
+a can_view? method like this:
+</p>
+<pre>
+  def can_view?(check_object)
+    self.member?(check_object) || (check_object.is_a?(User) &amp;&amp; check_object.admin?)
+  end
+</pre>
+<h2>Live Updates</h2>
+<p>
+If you would like to add live updates to the user&#8216;s activity feed you
+can do so by adding an entry to GlobalConfig.yml (configuration file added
+by muck)
+</p>
+<pre>
+  enable_live_activity_updates: true
+  live_activity_update_interval: 5
+</pre>
+<p>
+Note that this will poll the server every 5 seconds and so will increase
+server load and bandwidth usage.
+</p>
+<p>
+Copyright (c) 2009 Justin Ball, released under the MIT license
+</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>