Do a little bit more documenting.

2011-06-13 16:31:40 -07:00 · 2011-06-13 16:31:40 -07:00 · 7171aa05ed
commit 7171aa05ed
parent 4815482354
10 changed files with 215 additions and 21 deletions
--- a/.yardoc/checksums
+++ b/.yardoc/checksums
@ -1 +1,144 @@
-app/models/post.rb 1c52c0a1c26a882c609379b7fcf48db582a89e2f
+app/models/jobs/process_photo.rb 07bf353232233eabbeeac1410d971630420e2e24
+app/models/conversation_visibility.rb c3c3f3ea3cbf8f9ce75821eb99edccab068ae816
+app/models/notifications/request_accepted.rb 17bf0a5bde9fa1172392a0bf981e7e926418231f
+app/helpers/aspects_helper.rb 8bf0e66d7d304e01b6e49cdc68b8afc5b61e1e25
+app/models/jobs/mail_mentioned.rb e468499ccc0bbefde48e4824dc3d8cdd8a272b26
+lib/diaspora/user.rb 2bfd74896a7a0846d69a35b656e3fc71ae59a164
+app/controllers/comments_controller.rb d9483663a26d6d5966eabe8ca5c924ac2312592c
+app/models/like.rb e3ad7863591358109b7f4e5bfa53bd87759b42b1
+app/models/jobs/mail_comment_on_post.rb 86b2b719a7bdbe45d6c7106c83b73ce663213533
+app/models/jobs/mail_started_sharing.rb 3bf07022266acbd487ba7ae57f5ea6bef1564f14
+app/helpers/language_helper.rb 7499b66eef413a4edc41bfc7aa11e10a5f98734d
+lib/fake.rb 55d535ce2bfaef8ca63c6f92a959f543866c67af
+app/models/jobs/receive_salmon.rb 778b38c4c38d8cc0338b298466b880478cba7d3b
+lib/hcard.rb 9afd5c6c628f3d6ab05114be01ca93fcbcddc3a0
+lib/diaspora/guid.rb 0831c36a234e4a67b041a5bcb0ef0c0b8fcaeb3e
+lib/webfinger.rb 2b41dbed8d2304f66793281886f847b5641a3e39
+lib/collect_user_photos.rb 9850815c569d450f93c37af2b5af2ac395aa7566
+app/controllers/invitations_controller.rb ceed71a32e35a980ae74c5d8dea46c2ffe8effdd
+app/models/comment.rb 2b3400756f3dfae2b217c14c141f01e5d97e639e
+app/controllers/tags_controller.rb 58c67c894f053908bdc24be53c6ab4eec27611f9
+app/models/user.rb 08ffea5fc5044e8baad97dc055f5cf2352b99a10
+app/models/notifications/liked.rb d38ed71e1638a6d2e1f339b21d47f02619bf596b
+app/controllers/tokens_controller.rb a810569f631fb8feadd53a7d8862fa078563f8a5
+app/models/notifications/also_commented.rb b9c1dc5cd1a333f5983d9dd9e995f1ec7b7afaf8
+app/models/service_user.rb fbb47f76a189e11d23664e691c732ecee14454a1
+app/controllers/messages_controller.rb 8400298e3a5bf49234092e3729dfb246c10d61e6
+lib/development_mail_interceptor.rb 129f13c43f0c4bcd273312000ab2befbc91a60ab
+app/models/post.rb 4f8b6ee1c04e72539ed26f12b6aa56b140d4853e
+app/models/aspect_visibility.rb 3edc84d7f2b88a21f6455617d76f613524d7c8c4
+lib/diaspora/user/querying.rb ae17ed4bde5597b68ad006e883e946355d81da69
+app/helpers/layout_helper.rb 9ea5941a1b6c88687018dbc13a8696d31995c60b
+lib/splunk_logging.rb 47f9b5db8b32c6da921d360992c976770e04098f
+lib/chrome_frame.rb bfa3a5d0e60edf00716724f8e41682fe80040d1c
+app/controllers/aspects_controller.rb a1d388f76b63ceeb7a6bfca489180a3c8d8147d5
+app/helpers/markdownify_helper.rb 144de1c8e41cd9ea62b9f2bfd5e01d3e270db2b7
+app/helpers/publics_helper.rb 391ae86656d7542f99057baf4e54384e98fc5976
+lib/rake_helpers.rb 6dcf44ace70c72350ed647e35a97ce89fd90f975
+lib/diaspora/encryptable.rb 2222d77333b74fa18fd34baf1434c84aa138ad3c
+app/mailers/notifier.rb 1a98e17916d3a63b1cee8cd2c13174e303521157
+lib/diaspora/parser.rb cfb7f7f797b43fa57ae507527f32fc96801dda1c
+app/models/request.rb 6ba9fafc1eed807fc9bb70f1eb80c44485c78128
+lib/diaspora.rb 404e72b8e03cf9a3bb1dd97540375608f1b26edc
+app/models/user_preference.rb 3f38fcd2f1da6292f2877f1598126eb50f793af5
+app/controllers/likes_controller.rb 4079f53539ab9ff24b7509d431cbdba8bf2f5742
+app/uploaders/unprocessed_image.rb 55a574a606795c76d86c0dcb4007fc2e9caeed98
+app/helpers/status_messages_helper.rb 82fa934ff00a6a00af03e7ba0258c829661f7be3
+app/controllers/services_controller.rb 03369201b2ce5ae7113adc7b375a8ecc5b0edd35
+app/models/jobs/mail_liked.rb f9575abef93b17f37b7368c0037b500c5b965dc9
+app/controllers/apis_controller.rb 6197b2ba581f8ec5cb08f2ba8a71e99b333c6a67
+app/helpers/application_helper.rb f660726b7bf19d2e39138219fdc734d31ee418c2
+app/controllers/posts_controller.rb 37900577192f332cbbe8fd49f6fe9142e8e0f32c
+app/helpers/error_messages_helper.rb 9062b5b36b2df5d97a4afc67274512bea3bd746b
+app/controllers/status_messages_controller.rb 9db3bd7c597a8b42eda4d81afd22f4043df8d1b2
+app/models/jobs/receive.rb 49b602779318ad7b41e6c12c082d651c7661e2c5
+app/models/profile.rb 6a151c0f31bcbdc6207cad3ad090e6eac982283a
+app/models/activity_streams/photo.rb b8e9ce3c1bde805ce064454db213e377c8b4392b
+app/models/relayable_retraction.rb 7521197d0ba57495f431af93bf0dff1b9b3636c2
+app/helpers/stream_helper.rb 1e3d0f97465b581cb9f0499207d89c06d0b4d69f
+app/models/aspect.rb c335d5779cf6e077efe625c679bada8af4e1230c
+app/controllers/conversation_visibilities_controller.rb fd91f231add57aeba7384527d2276f7370194562
+app/models/jobs/base.rb 3124c3c0624f5a0ab223415ce09e3ab4a76e0759
+lib/diaspora/web_socket.rb a36225354db4e3715369935ef57e66c293d92d1c
+lib/diaspora/user/connecting.rb 6f81cdfcd461e5b7b448399ebce7e00fac148a18
+app/models/invitation.rb d4ea320bd3dc3772c788aafa90b7982deb59e3fd
+app/models/notifications/started_sharing.rb 583e1ccb9ed908e07ffc4a0f6dc43bed3878255a
+app/helpers/aspect_global_helper.rb 9a4e6228057af7b1131f688c3bdc11294a2098be
+lib/youtube_titles.rb e8b728d8f2a39b8df271130b795a898983c30573
+app/models/jobs/receive_local_batch.rb 883d9546eac5a0b212102a44711d4970e8b7e96d
+app/controllers/post_visibilities_controller.rb 7a52e9a7185548f2bd3ec377b97d7b8b387326bb
+app/controllers/admins_controller.rb e9bbfecb0a2f636830acefa59995678df6341869
+app/controllers/people_controller.rb 7563bc524a08fe294a94b02865ad7e9e0a51ae69
+app/helpers/sockets_helper.rb 4d98677751262dc2d52315b1cd80832c5c1d53e9
+app/models/message.rb cd9162d6cac3df3b25a164d4aea9f6de4e617c1f
+app/models/jobs/http_multi.rb 20e960fa80a3a5fa7306364d5ab93a811767d913
+lib/webfinger_profile.rb 37dca32719312bc3d3a47b58eb0fa1716081b577
+app/controllers/publics_controller.rb c6f444d66aa2422e9a73e0e9e670b2276a322ef6
+lib/encryptor.rb 90365ba2ec1051d050273181d57f8583dae96ff4
+app/controllers/sockets_controller.rb 676e60737df103f9653afc050b2ad97540cdb033
+app/controllers/application_controller.rb 2d65af8fef391b50280286daffca6f608cea7ed6
+lib/postzord.rb 91155a42f013f68cad3fe44037d97766c4459e46
+app/models/notification_actor.rb 5b6fe651b341e3c2c1d56e1fc55fa74ac09c7d05
+app/models/jobs/mail_private_message.rb d28db317cf4738d1036284b329e8fee13f9534cb
+app/controllers/users_controller.rb 69840f7d491bdc507e648884739543ae8f41eea3
+app/models/services/twitter.rb 3db64d3870e8960ed826663d3b21670a6ab1302a
+app/helpers/users_helper.rb bdab0e9c1f2158460a0426e5d260a331cf7acde3
+app/models/mention.rb ecdb144f9213cdd9e81972fc603c5db0da6e6ee6
+app/models/person.rb 8facc2c7e56c95c14151978032fc9bcf5794496e
+lib/diaspora/webhooks.rb abd3613c592790c2c375c91d36e8af82eb7492bf
+app/models/jobs/delete_account.rb 712442380ddb73761b235908e33d5fa0ac681753
+app/models/notifications/mentioned.rb 9f15f72210a305d08d480670f3833d6c6a03188f
+app/models/conversation.rb 5886762a03434f2c9fc744f25c12cc397c489a59
+app/controllers/profiles_controller.rb 2c439988db06ac4dee45e6e72cdf5d24abc51528
+app/helpers/likes_helper.rb d0c91fba653ae44ee4bd9862cbc0d6221cc64ae9
+app/helpers/mobile_helper.rb d146b4d30af80e370df75c5454a823c981ae73de
+lib/direction_detector.rb 80ae6454c9d11cc8cfe76d7f3d4f65d903562a62
+app/models/aspect_membership.rb c9195f714c5a51555b180e50b13bdabc73f8b716
+lib/pubsubhubbub.rb 17ceaa27d14b1cac0b40dff0a5ceebc332dc1b5d
+lib/postzord/receiver.rb c38b6bd8a6389210b7e5ea7a611014b07b505149
+app/controllers/photos_controller.rb 853274a36afb4a8232b2dc1eb20b7a2dcbaa10f8
+app/models/notifications/comment_on_post.rb 00c05f15683458ae8b37023c51f9f7bbea28bfa4
+lib/cruise/build.rb 82ff59377ba3ad2a11e9a52940ebb1aac2ffea52
+app/helpers/people_helper.rb 0350106a67127dbb05231d6880d5517399de96e3
+app/models/jobs/post_to_service.rb 406fcf6091c07bd59d06db1b015336f50b165f87
+lib/diaspora/exporter.rb dc61617c690ff6b8f6e9474a7c73810c1075c58b
+app/models/status_message.rb f623f4f969e02a9ec089205ba88f442e486ca521
+app/models/contact.rb f16d247b6ec0c4497e3ba90a1b0a4ff4eb4db814
+app/uploaders/processed_image.rb c16375b00e6589505ed48fab14c0291bca19342d
+app/controllers/aspect_memberships_controller.rb c09c52883c63951c7af4bd52cedae134ae7ee344
+lib/log_overrider.rb 8efa54a42e32b2493cbec0d6f622da54c1d76e57
+app/models/jobs/resend_invitation.rb 955d43f984d42d6a49c3a270ef0e22ae6baff8b7
+app/models/notifications/private_message.rb 423dd184873141fbf65320026772f9c2a6763f2c
+app/controllers/sessions_controller.rb 3435dafb115375e406e71f0b1abc527ccb6744ca
+app/models/notification.rb e63f02dedc4828606b58668c9a1cf2f6cc04ceb5
+app/models/services/tumblr.rb cf17a8c6935ed1c2817d312b73b7cd5040124261
+app/controllers/notifications_controller.rb c0d117950c8578b6f3d2f303bb8d93e9b22b90b9
+app/controllers/registrations_controller.rb 9f1c6bb886cafcb17e3e85bafe238c1004007f16
+app/models/jobs/update_service_users.rb 87d8fb174d9a3f2402b76dff098af30c9e62c6bb
+app/controllers/contacts_controller.rb 6e51e74f08eb8d476d0252ff68b8aa9c0d6a7847
+app/helpers/comments_helper.rb e4bb2ef4b1d4abba48c792f4f2ae245d8b958a8b
+app/models/jobs/notify_local_users.rb f1a552240566e61912b276d964ce907fcb97c5d0
+lib/diaspora/relayable.rb be1958fee031be5ba9a985976aac36d62e71ea9f
+lib/diaspora/ostatus_builder.rb e19d782a0f9776a1758f87dd17c5d589e176a9e1
+app/models/jobs/socket_webfinger.rb 4c3a50bff8c51007108dcb4ffd277a1f20b05a36
+app/models/services/facebook.rb 289d3f2c968bb9d4d6a4183b4fd71816d7e2b680
+lib/postzord/dispatch.rb 1dab04be068e01ae73de632f358660ee156dfb75
+app/models/app_config.rb 89900ef69a85706b353a8d34ed9d6aef90d20713
+app/helpers/tags_helper.rb 6ffe96fd4d7da104244cd58801e7e4b4c16a7c4a
+app/controllers/conversations_controller.rb 8a335ecf35080fca8c13eaa84178f7cf32dd46cf
+app/models/jobs/invite_user_by_email.rb 0620f53733c346b7a7bc7d01f6dcc9d5ab10c562
+lib/salmon/salmon.rb 879c2ee468b9118c22792f73aef13b867c7002b5
+app/models/post_visibility.rb f6d320b1c4b35c9307e59b1e37cf46bd855375fd
+app/models/photo.rb 98ec70c45f51445f00f667a843c0d4e82baa97fa
+app/models/retraction.rb 3265e0ac2cf98081a49d80377473a0c299480b7a
+app/models/jobs/mail_also_commented.rb 105042cfa879bcd1de321e560e2145e0f27cd52c
+lib/resque_job_logging.rb 1df39084b3fdfd73c73537855a7388bd8ab8ac29
+app/controllers/activity_streams/photos_controller.rb ab58bb90489997f7fee6ffe40330729ab40dc741
+app/models/jobs/http_post.rb 2560c6b08be06020c87bf60e4be63add4073a48a
+lib/active_record_instantiation_logs.rb d9e1817a755b39e4fa7f9c54f2e4c26882855721
+app/models/jobs/publish_to_hub.rb bdd97083b596c30e08b24689e78c85322b875204
+app/models/service.rb ab3c000da614959247b924d6dc0c91f7e7439336
+app/controllers/home_controller.rb d2e3453c670f71f1c51e7863b7b8c061c3abaca1
+lib/diaspora/taggable.rb 7e82aa7a9f7460568aca6f911e42289d6332c6e8
+app/controllers/apps_controller.rb 447d557f9cc265de6ee672d1ef01fba060f0d2cd
+app/helpers/notifications_helper.rb 93cdba1161e88b83fad57b68892af216164588d7
--- a/.yardoc/objects/root.dat
+++ b/.yardoc/objects/root.dat
--- a/.yardoc/proxy_types
+++ b/.yardoc/proxy_types
--- a/app/models/post.rb
+++ b/app/models/post.rb
@ -26,12 +26,10 @@ class Post < ActiveRecord::Base

  belongs_to :author, :class_name => 'Person'

-  cattr_reader :per_page
-  @@per_page = 10
-
  def diaspora_handle
    read_attribute(:diaspora_handle) || self.author.diaspora_handle
  end
+
  def user_refs
    if AspectVisibility.exists?(:post_id => self.id)
      self.post_visibilities.count + 1
@ -63,6 +61,7 @@ class Post < ActiveRecord::Base
    }
  end

+  # @return Returns true if this Post will accept updates (i.e. updates to the caption of a photo).
  def mutable?
    false
  end
@ -79,6 +78,9 @@ class Post < ActiveRecord::Base
    end
  end

+  # @param [User] user The user that is receiving this post.
+  # @param [Person] person The person who dispatched this post to the
+  # @return [void]
  def receive(user, person)
    #exists locally, but you dont know about it
    #does not exsist locally, and you dont know about it
--- a/doc/Post.html
+++ b/doc/Post.html
@ -287,7 +287,7 @@ Copyright &#169; 2010, Diaspora Inc. This file is
        <li class="public ">
  <span class="summary_signature">
    
-      <a href="#receive-instance_method" title="#receive (instance method)">- (Object) <strong>receive</strong>(user, person) </a>
+      <a href="#receive-instance_method" title="#receive (instance method)">- (void) <strong>receive</strong>(user, person) </a>
    

    
@ -443,12 +443,12 @@ The list of people that should receive this Post.
      <pre class="lines">


-118
-119
-120</pre>
+121
+122
+123</pre>
    </td>
    <td>
-      <pre class="code"><span class="info file"># File 'app/models/post.rb', line 118</span>
+      <pre class="code"><span class="info file"># File 'app/models/post.rb', line 121</span>

 <span class='def def kw'>def</span> <span class='activity_streams? fid id'>activity_streams?</span>
  <span class='false false kw'>false</span>
@ -611,19 +611,62 @@ The list of people that should receive this Post.
      <div class="method_details ">
  <p class="signature " id="receive-instance_method">
  
-    - (<tt>Object</tt>) <strong>receive</strong>(user, person) 
+    - (<tt>void</tt>) <strong>receive</strong>(user, person) 
  

  
-</p><table class="source_code">
+</p><div class="docstring">
+  <div class="discussion">
+    <p class="note returns_void">This method returns an undefined value.</p>
+
+  </div>
+</div>
+<div class="tags">
+  <h3>Parameters:</h3>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>user</span>
+      
+      
+        <span class='type'>(<tt>User</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>
+The user that is receiving this post.
+</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>person</span>
+      
+      
+        <span class='type'>(<tt>Person</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>
+The person who dispatched this post to the
+</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


-82
-83
-84
 85
 86
 87
@ -655,10 +698,13 @@ The list of people that should receive this Post.
 113
 114
 115
-116</pre>
+116
+117
+118
+119</pre>
    </td>
    <td>
-      <pre class="code"><span class="info file"># File 'app/models/post.rb', line 82</span>
+      <pre class="code"><span class="info file"># File 'app/models/post.rb', line 85</span>

 <span class='def def kw'>def</span> <span class='receive identifier id'>receive</span><span class='lparen token'>(</span><span class='user identifier id'>user</span><span class='comma token'>,</span> <span class='person identifier id'>person</span><span class='rparen token'>)</span>
  <span class='comment val'>#exists locally, but you dont know about it</span>
@ -831,7 +877,7 @@ The list of subscribers to this post
 </div>
    
    <div id="footer">
-  Generated on Mon Jun 13 16:11:16 2011 by 
+  Generated on Mon Jun 13 16:23:47 2011 by 
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  0.7.1 (ruby-1.8.7).
 </div>
--- a/doc/_index.html
+++ b/doc/_index.html
@ -97,7 +97,7 @@
 </div>
    
    <div id="footer">
-  Generated on Mon Jun 13 16:11:15 2011 by 
+  Generated on Mon Jun 13 16:23:47 2011 by 
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  0.7.1 (ruby-1.8.7).
 </div>
--- a/doc/file.README.html
+++ b/doc/file.README.html
@ -134,7 +134,7 @@ find, you can email
 <a href="mailto:exploits@joindiaspora.com">exploits@joindiaspora.com</a>, <a href="http://pgp.mit.edu:11371/pks/lookup?op=vindex&amp;search=0xCC6CAED977485064">corresponding public key (keyID: 77485064)</a>.</p></div></div>
    
    <div id="footer">
-  Generated on Mon Jun 13 16:11:15 2011 by 
+  Generated on Mon Jun 13 16:23:47 2011 by 
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  0.7.1 (ruby-1.8.7).
 </div>
--- a/doc/index.html
+++ b/doc/index.html
@ -134,7 +134,7 @@ find, you can email
 <a href="mailto:exploits@joindiaspora.com">exploits@joindiaspora.com</a>, <a href="http://pgp.mit.edu:11371/pks/lookup?op=vindex&amp;search=0xCC6CAED977485064">corresponding public key (keyID: 77485064)</a>.</p></div></div>
    
    <div id="footer">
-  Generated on Mon Jun 13 16:11:15 2011 by 
+  Generated on Mon Jun 13 16:23:47 2011 by 
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  0.7.1 (ruby-1.8.7).
 </div>
--- a/doc/top-level-namespace.html
+++ b/doc/top-level-namespace.html
@ -94,7 +94,7 @@
 </div>
    
    <div id="footer">
-  Generated on Mon Jun 13 16:11:16 2011 by 
+  Generated on Mon Jun 13 16:23:47 2011 by 
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  0.7.1 (ruby-1.8.7).
 </div>
--- a/lib/diaspora/guid.rb
+++ b/lib/diaspora/guid.rb
@ -1,10 +1,13 @@
 module Diaspora::Guid
+  # Creates a before_create callback which calls #set_guid and makes the guid serialize in to_xml
  def self.included(model)
    model.class_eval do
      before_create :set_guid
      xml_attr :guid
    end
  end
+
+  # @return [String] The model's guid.
  def set_guid
    self.guid ||= ActiveSupport::SecureRandom.hex(8)
  end