muck-shares 0.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+coverage
+rdoc
+pkg
+log/*

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,30 @@
+= MuckShares
+
+Add sharing functionality to your muck application.
+
+== Setup
+Install the gem:
+  sudo gem install muck-shares
+This should also install other required muck gems.  Items are shared into the user's activity feed as well as the 
+dashboard activity feed of any users that following or friends with the current user.
+
+== Usage
+
+=== Share model
+Create a model called share in your project and add the following:
+  
+  class Share < ActiveRecord::Base
+    acts_as_muck_share
+  end
+This let's you add any other methods to the share model that you see fit.
+
+=== User model
+You will need a user model that will do the sharing:
+  class User < ActiveRecord::Base
+    acts_as_muck_sharer
+  end
+
+MuckShares will look for 'current_user' when adding new shares.
+
+
+Copyright (c) 2009 Muck your app, released under the MIT license

data/Rakefile

@@ -0,0 +1,91 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test muck-shares.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test/rails_root/test'
+  t.pattern = 'test/rails_root/test/**/*_test.rb'
+  t.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |t|
+    #t.libs << 'lib'
+    t.libs << 'test/rails_root/lib'
+    t.pattern = 'test/rails_root/test/**/*_test.rb'
+    t.verbose = true
+    t.output_dir = 'coverage'
+    t.rcov_opts << '--exclude "gems/*"'
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+desc 'Generate documentation for the muck-shares gem.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MuckShares'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc 'Translate this gem'
+task :translate do
+  file = File.join(File.dirname(__FILE__), 'locales', 'en.yml')
+  system("babelphish -o -y #{file}")
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "muck-shares"
+    gemspec.summary = "The share engine for the muck system"
+    gemspec.email = "justinball@gmail.com"
+    gemspec.homepage = "http://github.com/jbasdf/muck_shares"
+    gemspec.description = "The share engine for the muck system."
+    gemspec.authors = ["Justin Ball"]
+    gemspec.rubyforge_project = 'muck-shares'
+    gemspec.add_dependency "muck-engine"
+    gemspec.add_dependency "muck-users"
+    gemspec.add_dependency "muck-activities"
+    gemspec.add_dependency "muck-comments"
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+# rubyforge tasks
+begin
+  require 'rake/contrib/sshpublisher'
+  namespace :rubyforge do
+
+    desc "Release gem and RDoc documentation to RubyForge"
+    task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
+
+    namespace :release do
+      desc "Publish RDoc to RubyForge."
+      task :docs => [:rdoc] do
+        config = YAML.load(
+            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+        )
+
+        host = "#{config['username']}@rubyforge.org"
+        remote_dir = "/var/www/gforge-projects/muck-shares/"
+        local_dir = 'rdoc'
+
+        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+      end
+    end
+  end
+rescue LoadError
+  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/app/controllers/muck/shares_controller.rb

@@ -0,0 +1,107 @@
+class Muck::SharesController < ApplicationController
+  unloadable
+  
+  before_filter :login_required, :except => [:index]
+  before_filter :setup_user
+  before_filter :get_share, :only => [:destroy]
+  
+  def index
+    @shares = @user.shares.by_newest
+    respond_to do |format|
+      format.html { render :template => 'shares/index' }
+      format.pjs { render :template => 'shares/index', :layout => false }
+    end
+  end
+  
+  def new
+    @page_title = t('muck.shares.new_share')
+    @share = Share.new(:uri => params[:uri] || params[:u], :title => params[:title] || params[:t], :message => params[:message] || params[:m])
+    respond_to do |format|
+      format.html { render :template => 'shares/new', :layout => 'popup' }
+      format.pjs { render :template => 'shares/new', :layout => false }
+    end
+  end
+  
+  def create
+    @share = current_user.shares.build(params[:share])
+    @share.save!
+    # TODO add UI that will let the user share with specific users
+    share_to = nil
+    @share.add_share_activities(share_to)
+    message = t('muck.shares.create_success')
+    handle_after_create(true, message)
+  rescue ActiveRecord::RecordInvalid => ex
+    if @share
+      errors = @share.errors.full_messages.to_sentence
+    else
+      errors = ex
+    end
+    message = t('muck.shares.create_error', :errors => errors)
+    handle_after_create(false, message)
+  end
+
+  def destroy
+    @share.destroy
+    respond_to do |format|
+      format.html do
+        flash[:notice] = t('muck.shares.share_removed')
+        redirect_back_or_default(current_user)
+      end
+      format.js do
+        render(:update) do |page|
+          page << "jQuery('##{@share.dom_id}').fadeOut();"
+        end
+      end
+      format.json { render :json => { :success => true, :message => t("muck.shares.share_removed"), :share_id => @share.id } }
+    end
+  end
+
+  protected
+
+  def handle_after_create(success, message = '')
+    if success
+      respond_to do |format|
+        format.html { do_after_create_action(success, message) }
+        format.json { render :json => { :success => true, :share => @share, :message => message, :html => get_share_html(@share) } }
+      end
+    else
+      respond_to do |format|
+        format.html { do_after_create_action(success, message) }
+        format.json { render :json => { :success => false, :message => message, :errors => @errors } }
+      end
+    end
+  end
+  
+  def do_after_create_action(success, message)
+    flash[:error] = message if !success
+    if "true" == params[:render_new]
+      flash[:notice] = message if success
+      render :template => 'shares/new'
+    else
+      redirect_back_or_default(user_shares_path(@user))
+    end
+  end
+  
+  def get_share
+    @share = Share.find(params[:id])
+    unless @share.can_edit?(current_user)
+      respond_to do |format|
+        format.html do
+          flash[:notice] = I18n.t('muck.shares.cant_delete_share')
+          redirect_back_or_default(user_shares_path(@user))
+        end
+        format.js { render(:update){|page| page.alert I18n.t('muck.shares.cant_delete_share')}}
+      end
+    end
+  end
+
+  def get_share_html(share)
+    render_as_html do
+      render_to_string(:partial => "shares/share", :object => share)
+    end
+  end
+  
+  def setup_user
+    @user = User.find(params[:user_id]) rescue current_user
+  end
+end

data/app/helpers/muck_shares_helper.rb

@@ -0,0 +1,23 @@
+module MuckSharesHelper
+
+  def show_shares(shares)
+    render :partial => 'shares/share', :collection => shares
+  end
+
+  # parent is the object to which the shares will be attached
+  # share is the optional parent share for the new share.
+  def share_form(share = nil, render_new = false)
+    share ||= Share.new
+    render :partial => 'shares/form', :locals => { :share => share, :render_new => render_new }
+  end
+
+  # Renders a delete button for a share item
+  def delete_share(share, button_type = :button, button_text = t("muck.general.delete"))
+    render :partial => 'shared/delete', :locals => { :delete_object => share,
+                                                     :button_type => button_type,
+                                                     :button_text => button_text,
+                                                     :form_class => 'comment-delete',
+                                                     :delete_path => share_path(share, :format => 'js') }
+  end
+
+end

data/app/views/activity_templates/_share.html.erb

@@ -0,0 +1,3 @@
+<% activity_for(activity, :activity_css_class => 'activity-share') do -%>
+  shared <%= link_to activity.item.title, activity.item.uri %>.  <%= activity.item.message %>
+<% end -%>

data/app/views/shares/_form.html.erb

@@ -0,0 +1,22 @@
+<div id="<%= share.dom_id %>_new_share" class="share-form-wrapper">
+  <% custom_form_for(share, :url => user_shares_path(current_user), :html => { :id => "#{share.dom_id}_share_form", :class => "share-form"} ) do |f| -%>
+    <% if defined?(include_share_to) -%>
+      <div id="share_to">
+        <%= f.text_field :to %>
+      </div>
+    <% end -%>
+    <div id="share_information">
+      <%= f.text_field :title, { :label => t('muck.shares.title') } -%>
+      <%= f.text_field :uri, { :label => t('muck.shares.uri') } -%>
+    </div>
+    <div id="share_message">
+      <%= f.text_area :message, { :label => t('muck.shares.message'),
+                                  :class => 'min' } %>
+    </div>
+    <%= hidden_field_tag :render_new, render_new ? true : false -%>
+    <div class="button form-row">
+      <%= f.submit t('muck.shares.add_share_button'), :class => "button share-submit", :id => "share_submit_#{share.dom_id}" %>
+      <%= f.submit t('muck.shares.cancel_share_button'), :class => "button share-submit", :id => "cancel_submit_#{share.dom_id}" %>
+    </div>
+  <% end -%>
+</div>

data/app/views/shares/_share.html.erb

@@ -0,0 +1,9 @@
+<div id="<%= share.dom_id %>" class="share_holder delete-container">
+  <div class="shareor-icon"><%= icon share.shared_by %></div>
+  <p><span class="sharer"><%= link_to share.shared_by.try(:display_name), share.shared_by %></span>
+    <div class="share-uri"><%= link_to h(share.title), share.uri %></div>
+    <div class="share-message"><%= h share.message %></div>
+  </p>
+  <%= delete_share(share, :image) if share.can_edit?(current_user) %>
+  <span class="share-time"><%= t("muck.general.time_ago", :time_in_words => time_ago_in_words(share.created_at)) %></span></p>
+</div>

data/app/views/shares/index.html.erb

@@ -0,0 +1,2 @@
+<%= output_errors(t('muck.shares.problem_adding_share'), {:class => 'help-box'}, @share) %>
+<%= show_shares(@shares) unless @shares.blank? %>

data/app/views/shares/new.html.erb

@@ -0,0 +1,5 @@
+<div id="add_share">
+  <h2><%= @page_title %><h2>
+  <%= output_errors(t('muck.shares.problem_adding_share'), {:class => 'help-box'}, @share) %>
+  <%= share_form(@share, false) %>
+</div>

data/config/muck_shares_routes.rb

@@ -0,0 +1,8 @@
+ActionController::Routing::Routes.draw do |map|
+  map.resources :shares, :controller => 'muck/shares'
+  map.resources :users, :controller => 'muck/users' do |users|
+    # have to map into the muck/shares controller or rails can't find the shares
+    users.resources :shares, :controller => 'muck/shares'
+  end
+  
+end

data/db/migrate/20090803185323_create_shares.rb

@@ -0,0 +1,16 @@
+class CreateShares < ActiveRecord::Migration
+  def self.up
+    create_table :shares, :force => true do |t|
+      t.string  :uri,               :limit => 2083, :default => "", :null => false
+      t.string  :title
+      t.text    :message
+      t.integer :shared_by_id,                                      :null => false
+      t.timestamps
+    end
+    add_index :shares, :shared_by_id
+  end
+
+  def self.down
+    drop_table :shares
+  end
+end

data/db/migrate/20090804184247_add_comment_count_to_shares.rb

@@ -0,0 +1,9 @@
+class AddCommentCountToShares < ActiveRecord::Migration
+  def self.up
+    add_column :shares, :comment_count, :integer, :default => 0
+  end
+
+  def self.down
+    remove_column :shares, :comment_count
+  end
+end

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/active_record/acts/muck_share.rb

@@ -0,0 +1,58 @@
+module ActiveRecord
+  module Acts #:nodoc:
+    module MuckShare #:nodoc:
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+
+        def acts_as_muck_share(options = {})
+
+          belongs_to :shared_by, :class_name => "User" , :foreign_key => :shared_by_id
+          validates_presence_of :uri
+          validates_presence_of :title
+          
+          acts_as_activity_item
+          acts_as_commentable
+          
+          named_scope :by_newest, :order => "created_at DESC"
+          named_scope :by_oldest, :order => "created_at ASC"
+          named_scope :recent, lambda { { :conditions => ['created_at > ?', 1.week.ago] } }
+                            
+          class_eval <<-EOV
+            # prevents a user from submitting a crafted form that bypasses activation
+            attr_protected :created_at, :updated_at
+          EOV
+
+          include ActiveRecord::Acts::MuckShare::InstanceMethods
+          extend ActiveRecord::Acts::MuckShare::SingletonMethods
+          
+        end
+      end
+
+      # class methods
+      module SingletonMethods
+
+      end
+      
+      # All the methods available to a record that has had <tt>acts_as_muck_share</tt> specified.
+      module InstanceMethods
+
+        def add_share_activities(share_to = nil)
+          share_to ||= self.shared_by.feed_to
+          share_to = [share_to] unless share_to.is_a?(Array)
+          share_to << self.shared_by unless share_to.include?(self.shared_by) # make sure the person doing the sharing is included
+          add_activity(share_to, self.shared_by, self, 'share', '', '')
+        end
+        
+        # override this method to change the way permissions are handled on shares
+        def can_edit?(user)
+          return true if check_sharer(user)
+          false
+        end
+
+      end
+    end
+  end
+end

data/lib/active_record/acts/muck_sharer.rb

@@ -0,0 +1,28 @@
+module ActiveRecord
+  module Acts #:nodoc:
+    module MuckSharer #:nodoc:
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+
+        def acts_as_muck_sharer(options = {})
+          has_many :shares, :dependent => :destroy, :order => 'created_at ASC', :foreign_key => :shared_by_id
+          include ActiveRecord::Acts::MuckSharer::InstanceMethods
+          extend ActiveRecord::Acts::MuckSharer::SingletonMethods
+        end
+      end
+
+      # class methods
+      module SingletonMethods
+
+      end
+      
+      # All the methods available to a record that has had <tt>acts_as_muck_share</tt> specified.
+      module InstanceMethods
+
+      end
+    end
+  end
+end