social_connections 0.0.9 → 0.0.10

data/README.md

@@ -7,8 +7,7 @@ Enables
 * Activities on those things which are recorded for later processing
 * Digest mechanism to digest those activities, e.g. for daily digest emails.
 
-This gem is work in progress and my playground, and currently my playground, don't use it!
-
+This gem is work in progress and my playground, use at own risk.
 
 Setup
 -----
@@ -25,7 +24,6 @@ and run
 
 	bundle install
 
-
 Next, you need to add the migration by using the install generator of the gem:
 
 	rails g social_connections:install
@@ -102,6 +100,37 @@ The view (e.g. `app/views/books/show.html.erb`) may then contain the following '
 	<%= link_to('I like this', current_user_likes_book_path(@book) %>
 
 
+Views
+-----
+
+A list of social activities can be rendered by 
+
+	<%= render @social_activities %>
+
+in a view. Thereby, '@social_activities' could have been assigned in a controller like this:
+
+	def show
+	  @user = User.find(params[:id])
+	  @social_activities = SocialConnections.aggregate(@user).activities
+	end
+
+Rendering uses a generic partial (part of the gem) which in turn renders the subject and
+target as partial, and the verb as text.
+If the subject is of type 'User', then
+you have to provide a partial in 'app/views/users/_user.html.erb' (if
+using erb). Check [Rails Guides on partials](http://guides.rubyonrails.org/layouts_and_rendering.html#using-partials)
+on details for this. A simple example for a '_user.html.erb' file is:
+
+	User <%= link_to user.name, user %>
+
+If you want to use your own template for rendering the SocialActivity, you can
+pass a reference to your template as an option when creating the activity:
+
+	u.comments(b, :comment => 'awesome book!', :template => 'social_activities/user_comments_user')
+
+For this, provide a partial at 'app/views/social_activities/_user_comments_user.html.erb'.
+
+
 How to run the Tests (in the gem itself, not in your Rails app)
 --------------------
 

data/lib/app/views/social_activities/_social_activity.html.erb

@@ -0,0 +1,23 @@
+<li>
+<% if social_activity.options['template'].blank? %>
+  <div class="social-activity">
+    <% if social_activity.subject.nil? %>
+      (gone)
+    <% else %>
+      <%= render social_activity.subject %>
+    <% end %>
+    <%= social_activity.verb %>
+    <% if social_activity.target.blank? %>
+      (gone)>
+    <% else %>
+      <%= render social_activity.target %>
+    <% end %>
+    <div class="when">
+      <%= time_ago_in_words social_activity.created_at %>
+    </div>
+  </div>
+<% else %>
+  <%= render :partial => social_activity.options['template'],
+    :locals => { :social_activity => social_activity } %>
+<% end %>
+</li>

data/lib/social_connections/version.rb

@@ -1,3 +1,3 @@
 module SocialConnections
-  VERSION = "0.0.9"
+  VERSION = "0.0.10"
 end

data/lib/social_connections.rb

@@ -18,5 +18,11 @@ end
   ActiveSupport::Dependencies.autoload_once_paths.delete(path)
 end
 
+module SocialConnections
+  class Engine < Rails::Engine
+    paths["app/views"] = "lib/app/views"
+  end
+end
+
 path = File.join(File.dirname(__FILE__), 'tasks')
 ActiveSupport::Dependencies.autoload_paths << path

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: social_connections
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-29 00:00:00.000000000Z
+date: 2011-08-31 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2161466220 !ruby/object:Gem::Requirement
+  requirement: &2161391360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2161466220
+  version_requirements: *2161391360
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &2161465640 !ruby/object:Gem::Requirement
+  requirement: &2161390780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2161465640
+  version_requirements: *2161390780
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &2152510600 !ruby/object:Gem::Requirement
+  requirement: &2152319520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152510600
+  version_requirements: *2152319520
 - !ruby/object:Gem::Dependency
   name: turn
-  requirement: &2152510200 !ruby/object:Gem::Requirement
+  requirement: &2152319120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152510200
+  version_requirements: *2152319120
 - !ruby/object:Gem::Dependency
   name: factory_girl_rails
-  requirement: &2152509800 !ruby/object:Gem::Requirement
+  requirement: &2152318720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152509800
+  version_requirements: *2152318720
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &2152509400 !ruby/object:Gem::Requirement
+  requirement: &2152318320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152509400
+  version_requirements: *2152318320
 - !ruby/object:Gem::Dependency
   name: actionmailer
-  requirement: &2152509000 !ruby/object:Gem::Requirement
+  requirement: &2152317920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152509000
+  version_requirements: *2152317920
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &2152508600 !ruby/object:Gem::Requirement
+  requirement: &2152317520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152508600
+  version_requirements: *2152317520
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &2152508200 !ruby/object:Gem::Requirement
+  requirement: &2152317120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,7 +109,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152508200
+  version_requirements: *2152317120
 description: The idea is to provide pluggable social connections, activities and a
   method to digest those activities (e.g. in daily emails).
 email:
@@ -133,6 +133,7 @@ files:
 - lib/app/models/social_activity.rb
 - lib/app/models/social_connection.rb
 - lib/app/views/digest_mailer/digest.html.erb
+- lib/app/views/social_activities/_social_activity.html.erb
 - lib/db/migrate/20110516181115_create_social_connections.rb
 - lib/generators/social_connections/install/install_generator.rb
 - lib/generators/social_connections/install/templates/create_mute_and_curious_guests.rb