radiant-forum-extension 0.6.0

data/db/migrate/008_first_posts.rb

@@ -0,0 +1,13 @@
+class FirstPosts < ActiveRecord::Migration
+  
+  def self.up
+    Topic.find(:all).each do |topic|
+      topic.first_post = topic.posts.first
+      topic.save
+    end
+  end
+
+  def self.down
+    
+  end
+end

data/db/migrate/20090824111005_import_helpers.rb

@@ -0,0 +1,15 @@
+class ImportHelpers < ActiveRecord::Migration
+  def self.up
+    add_column :readers, :old_id, :integer
+    add_column :forums, :old_id, :integer
+    add_column :topics, :old_id, :integer
+    add_column :posts, :old_id, :integer
+  end
+
+  def self.down
+    remove_column :readers, :old_id
+    remove_column :forums, :old_id
+    remove_column :topics, :old_id
+    remove_column :posts, :old_id
+  end
+end

data/forum_extension.rb

@@ -0,0 +1,44 @@
+require_dependency 'application_controller'
+
+class ForumExtension < Radiant::Extension
+  version "0.4"
+  description "Nice clean forums and page comments for inclusion in your radiant site. Derived long ago from beast. Requires the reader extension and share_layouts."
+  url "http://spanner.org/radiant/forum"
+
+  def activate
+    Reader.send :include, ForumReader
+    ReaderNotifier.send :include, ForumReaderNotifier
+    ReadersController.send :include, ForumReadersController
+    Page.send :include, ForumPage
+    UserActionObserver.instance.send :add_observer!, Forum
+    UserActionObserver.instance.send :add_observer!, Topic
+    UserActionObserver.instance.send :add_observer!, Post
+    Page.send :include, ForumTags
+    Admin::ReaderSettingsController.make_settable 'forum.editable_period' => 15, 'forum.public?' => true, 'forum.layout' => '', 'forum.allow_page_comments?' => true
+    
+    unless defined? admin.forum # UI is a singleton
+      Radiant::AdminUI.send :include, ForumAdminUI
+      admin.forum = Radiant::AdminUI.load_default_forum_regions
+      admin.pages.edit.add :parts_bottom, "edit_commentability", :after => "edit_layout_and_type"
+      admin.reader_settings.index.add :settings, "forum", :after => "sender"
+      if defined? Site && admin.sites
+        Site.send :include, ForumSite
+      end
+    end
+    
+    if defined? RedCloth::DEFAULT_RULES     # identifies redcloth 3
+      RedCloth.send :include, ForumRedCloth3
+      RedCloth::DEFAULT_RULES.push(:smilies)
+    else
+      RedCloth::TextileDoc.send :include, ForumRedCloth4
+    end
+    
+    ApplicationHelper.send :include, ForumHelper
+
+    tab("Readers") do
+      add_item 'Forum', '/admin/readers/forums', :before => 'Settings'
+    end
+  end
+  
+end
+

data/lib/forum_admin_ui.rb

@@ -0,0 +1,37 @@
+module ForumAdminUI
+
+ def self.included(base)
+   base.class_eval do
+
+      attr_accessor :forum
+      alias_method :forums, :forum
+
+      def load_default_regions_with_forum
+        load_default_regions_without_forum
+        @forum = load_default_forum_regions
+      end
+      alias_method_chain :load_default_regions, :forum
+
+      protected
+
+        def load_default_forum_regions
+          returning OpenStruct.new do |forum|
+            forum.edit = Radiant::AdminUI::RegionSet.new do |edit|
+              edit.main.concat %w{edit_header edit_form}
+              edit.form.concat %w{edit_name edit_description}
+              edit.form_bottom.concat %w{edit_timestamp edit_buttons}
+            end
+            forum.index = Radiant::AdminUI::RegionSet.new do |index|
+              index.thead.concat %w{title_header latest_header modify_header}
+              index.tbody.concat %w{title_cell latest_cell modify_cell}
+              index.bottom.concat %w{new_button}
+            end
+            forum.remove = forum.index
+            forum.new = forum.edit
+          end
+        end
+      
+    end
+  end
+end
+

data/lib/forum_helper.rb

@@ -0,0 +1,109 @@
+require 'sanitize'
+module ForumHelper
+
+  def self.included(base)
+    base.module_eval {
+      
+      def home_page_link(options={})
+        home_page = (defined? Site && Site.current) ? Site.current.home_page : Page.find_by_parent_id(nil)
+        link_to home_page.title, home_page.url, options
+      end
+      
+      def feed_tag(text, url, options={})
+        link_to text, url, options.merge(:class => 'floating feedlink')
+      end
+
+      def feed_link(url)
+        link_to image_tag('/images/forum/feed_14.png', :class => 'feedicon', :alt => 'rss feed', :size => '14x20'), url
+      end
+
+      def clean_textilize(text) # adding smilies to the default reader method
+        if text.blank?
+          ""
+        else
+          textilized = RedCloth.new(text, [ :hard_breaks ])
+          textilized.hard_breaks = true if textilized.respond_to?("hard_breaks=")
+          Sanitize.clean(textilized.to_html(:textile, :smilies), Sanitize::Config::RELAXED)
+        end
+      end
+      
+      def watch_tag(topic, label='watching', formclass=nil)
+        if current_user
+          monitoring = current_user.monitoring?(topic)
+        	%{
+        	  <form action="#{monitorship_path(topic.forum, topic)}" method="post" class="#{formclass}"><div>
+        	  <input id="monitor_checkbox_#{topic.id}" name="monitor_checkbox" class="monitor_checkbox" type="checkbox"#{ ' checked="checked"' if monitoring } />
+        	  <label class="monitor_label" for="monitor_checkbox_#{topic.id}">#{label}</label>
+        	  #{hidden_field_tag '_method', monitoring ? 'delete' : ''}
+        	  #{submit_tag :set, :class => 'monitor_submit'}
+        	  </div></form>
+        	}
+        end
+      end
+
+      def paged_post_url(post)
+        if post.first?
+          topic_post_url(post.topic, post, :page => post.topic_page, :anchor => post.dom_id)
+        else
+          topic_post_url(post.topic, post, :page => post.topic_page, :anchor => post.dom_id)
+        end
+      end
+
+      def edit_link(post)
+        link_to 'e', edit_topic_post_url(post.topic, post), :class => 'edit_post', :id => "edit_post_#{post.id}", :title => "edit post"
+      end
+
+      def remove_link(post)
+        link_to 'x', topic_post_url(post.topic, post), :method => 'delete', :class => 'delete_post', :id => "delete_post_#{post.id}", :title => "remove post", :confirm => "Are you sure you want to delete this message?"
+      end
+      
+      def friendly_date(datetime)
+        if datetime
+          date = datetime.to_date
+          if (date == Date.today)
+            format = "today at %l:%M%p"
+          elsif (date == Date.yesterday)
+            format = "yesterday at %l:%M%p"
+          elsif (date.year == Date.today.year)
+            format = "on %B %e"
+          else
+            format = "on %B %e, %Y"
+          end
+          datetime.strftime(format)
+        else 
+          "unknown date"
+        end
+      end
+      
+      def paginate_and_summarise(list, plural='')
+        pagination = will_paginate list, :separator => %{<span class="separator">|</span>}, :container => false
+        %{<div class="pagination">
+            #{pagination}
+            <span class="pagination_summary">
+              showing #{pagination_summary(list, plural)}
+            </span>
+          </div>
+        }
+      end
+        
+      def pagination_summary(list, plural='')
+        total = list.total_entries
+        if total == 1
+          if plural.blank?
+            "one"
+          else
+            %{one #{plural.singularize}}
+          end
+        elsif list.current_page == 1 && total < list.per_page
+          %{all #{total} #{plural}}
+        else
+          start = list.offset + 1
+          finish = ((list.offset + list.per_page) < list.total_entries) ? list.offset + list.per_page : list.total_entries
+          %{#{start} to #{finish} of #{total} #{plural}}
+        end
+      end
+      
+    }
+  end
+  
+end

data/lib/forum_page.rb

@@ -0,0 +1,45 @@
+module ForumPage
+
+  def self.included(base)
+    base.class_eval {
+      has_one :topic
+      include InstanceMethods
+    }
+  end
+
+  module InstanceMethods     
+
+    def find_or_build_topic
+      if self.topic
+        self.topic
+      elsif self.still_commentable?
+        self.build_topic(:name => title, :forum => Forum.find_or_create_comments_forum, :reader => Reader.find_or_create_for_user(created_by))         # posts_controller will do the right thing with a new topic
+      end
+    end
+
+    def posts
+      self.topic ? self.topic.posts : []
+    end
+
+    def has_posts?
+      self.topic && self.topic.has_posts?
+    end
+
+    # def cache?
+    #   !has_posts?
+    # end
+
+    def still_commentable?
+      commentable? && !comments_closed? && (!commentable_period || Time.now - self.created_at < commentable_period)
+    end
+    
+    def commentable_period
+      Radiant::Config['forum.commentable_period'].to_i.days if Radiant::Config['forum.commentable_period']
+    end
+    
+    def locked?
+      !still_commentable?
+    end
+  
+  end
+end

data/lib/forum_reader.rb

@@ -0,0 +1,9 @@
+module ForumReader
+
+  def self.included(base)
+    base.class_eval {
+      has_many :topics, :dependent => :nullify
+      has_many :posts, :order => 'posts.created_at desc', :dependent => :nullify
+    }
+  end
+end

data/lib/forum_reader_notifier.rb

@@ -0,0 +1,9 @@
+module ForumReaderNotifier
+
+  def post(reader, post)
+    setup_email(reader)
+    @subject += "New post under '#{post.topic.name}'"
+    @body[:post] = post
+    @body[:post_url] = url_for(post)
+  end
+end

data/lib/forum_readers_controller.rb

@@ -0,0 +1,15 @@
+module ForumReadersController
+
+  def self.included(base)
+    base.class_eval do
+      alias_method_chain :show, :forum 
+    end
+  end
+
+  def show_with_forum
+    @reader = Reader.find(params[:id])
+    @posts = Post.paginate_by_reader_id(@reader.id, :page => params[:page], :include => :topic, :order => 'posts.created_at desc') if @reader
+    render :template => 'readers/show_with_posts'
+  end
+
+end

data/lib/forum_red_cloth3.rb

@@ -0,0 +1,10 @@
+module ForumRedCloth3
+
+  def smilies(text)
+    %w{angry smile bigsmile confused cool cry devil neutral sad shamed shocked surprised tongue wink }.each do |icon|
+      imgtag = 
+      text.gsub!(/:#{icon}:/, %{<img src="/images/emoticons/#{icon}.gif" alt="(#{icon})" class="smiley" />})
+    end
+  end
+
+end

data/lib/forum_red_cloth4.rb

@@ -0,0 +1,21 @@
+module ForumRedCloth4
+  
+  def self.included(base)
+    # base.extend ClassMethods
+    base.class_eval do
+      def to_html_with_smilies(*rules)
+        rules.push(:smilies) unless rules.include?(:smilies)
+        to_html_without_smilies(*rules)
+      end
+      alias_method_chain :to_html, :smilies unless self.instance_methods.include?("to_html_without_smilies")
+    end
+  end
+  
+  def smilies(text)
+    %w{angry smile bigsmile confused cool cry devil neutral sad shamed shocked surprised tongue wink }.each do |icon|
+      imgtag = 
+      text.gsub!(/:#{icon}:/, %{<img src="/images/emoticons/#{icon}.gif" alt="(#{icon})" title="#{icon}" class="smiley" />})
+    end
+  end
+
+end

data/lib/forum_site.rb

@@ -0,0 +1,12 @@
+module ForumSite
+
+  def self.included(base)
+    base.class_eval %{
+      has_many :forums
+      has_many :topics
+      has_many :posts
+      belongs_to :forum_layout, :class_name => 'Layout'
+    } 
+    super
+  end
+end

data/lib/forum_tags.rb

@@ -0,0 +1,285 @@
+module ForumTags
+  include Radiant::Taggable
+  include ActionView::Helpers::TagHelper
+  include ActionView::Helpers::FormTagHelper
+  include ActionView::Helpers::FormOptionsHelper
+  
+  class TagError < StandardError; end
+
+  tag 'comments' do |tag|
+    raise TagError, "can't have comments without a page" unless page = tag.locals.page
+    if page.commentable?
+      tag.locals.comments = page.posts
+      tag.expand
+    end
+  end
+
+  desc %{
+    Returns a string in the form "x comments" or "no comments yet".
+  
+    *Usage:*
+    <pre><code><r:comments:summary /></code></pre>
+  }
+  
+  tag 'comments:summary' do |tag|
+    if tag.locals.comments.empty?
+      "no comments yet"
+    elsif tag.locals.comments.size == 1
+      "one comment"
+    else
+      "#{tag.locals.comments.size} comments"
+    end
+  end
+
+  desc %{
+    Anything between if_comments tags is displayed only - dramatic pause - if there are comments.
+  
+    *Usage:*
+    <pre><code><r:if_comments>...</r:if_comments></code></pre>
+  }
+  tag 'if_comments' do |tag|
+    raise TagError, "can't have if_comments without a page" unless page = tag.locals.page
+    tag.expand if page.posts.any?
+  end
+
+  desc %{
+    Anything between unless_comments tags is displayed only if there are no comments.
+  
+    *Usage:*
+    <pre><code><r:unless_comments>...</r:unless_comments></code></pre>
+  }
+  tag 'unless_comments' do |tag|
+    raise TagError, "can't have unless_comments without a page" unless page = tag.locals.page
+    tag.expand if page.posts.any?
+  end
+  
+  desc %{
+    If you want more control over the display of page comments, you can spell them out:
+  
+    *Usage:*
+    <pre><code><r:comments:each>
+      <h2><r:comment:reader:name /></h2>
+      <p class="date"><r:comment:date /></p>
+      <r:comment:body_html />
+    </r:comments:each>
+    <r:comment_link />
+    </code></pre>
+  }
+  tag 'comments:each' do |tag|
+    results = []
+    tag.locals.comments.each do |post|
+      tag.locals.comment = post
+      results << tag.expand
+    end
+    results
+  end
+  
+  desc %{
+    To enable page commenting, all you have to do is put this in your layout:
+  
+    *Usage:*
+    <pre><code><r:comments:all /></code></pre>
+  }
+  tag 'comments:all' do |tag|
+    posts = tag.locals.comments
+    results = ""
+    results << %{<div class="page_comments">}
+    results << "<h2>Comments</h2>"
+    results << %{<div id="forum">
+}
+    if posts.empty?
+      results << "<p>None yet.</p>"
+    else
+      posts.each do |post|
+        tag.locals.comment = post
+        results << tag.render('comment')
+      end
+    end
+    results << %{#{tag.render('comment_link', 'class' => 'inline inviting')}}
+    results << "</div></div>"
+    results
+  end
+
+  tag 'comment' do |tag|
+    raise TagError, "can't have r:comment without a post" unless post = tag.locals.comment
+    if tag.double?
+      tag.locals.reader = post.reader
+      tag.expand
+    else
+      %{<div class="post" id="#{post.dom_id}">
+  <div class="post_header">
+    <h2><img src="#{post.reader.gravatar_url(:size => 40)}" width="40" height ="40" class="gravatar" /> #{post.reader.name}</h2>
+    <p class="context">#{friendly_date(post.created_at)}</p>
+  </div>
+  <div class="post_body">#{post.body_html}</div>
+</div>}
+    end
+  end
+
+  tag 'comment:reader' do |tag|
+    raise TagError, "can't have comment:reader without a comment" unless reader = tag.locals.reader
+    tag.expand
+  end
+
+  desc %{
+    The name of the commenter
+  }
+  tag 'comment:reader:name' do |tag|
+    tag.locals.reader.name
+  end
+  
+  desc %{
+    A gravatar for the commenter
+  }
+  tag 'comment:reader:gravatar' do |tag|
+    tag.locals.reader.gravatar
+  end
+
+  desc %{
+    The date of the comment
+  }
+  tag 'comment:date' do |tag|
+    tag.locals.comment.created_at.to_s(:html_date)
+  end
+
+  desc %{
+    The time_ago of the comment
+  }
+  tag 'comment:ago' do |tag|
+    time_ago_in_words(tag.locals.comment.created_at)
+  end
+
+  desc %{
+    The body of the comment as it was entered (but html-escaped)
+  }
+  tag 'comment:body' do |tag|
+    h(tag.locals.comment.body)
+  end
+
+  desc %{
+    The body of the comment rendered into html (and whitelisted, so this ought to be safe)
+  }
+  tag 'comment:body_html' do |tag|
+    tag.locals.comment.body_html
+  end
+
+  desc %{
+    A link to the post-a-comment form. Typically you'll use a bit of remote scripting to replace this with
+    a comment or login form depending on whether a reader is detected, but you can just leave the link too.
+    
+    If text is given, the link will be wrapped around it. The default is just "Add a comment". Any supplied 
+    attributes are passed through, so you can specify class, id and anything else you like.
+
+    *Usage:*
+    <pre><code>
+      <r:if_comments>
+        <r:comment_link />
+      </r:if_comments>
+      <r:unless_comments>
+        <r:comment_link class="how_exciting">Be the first to add a comment!</r:comment_link>
+      </r:unless_comments>
+    </code></pre>
+  }
+  tag 'comment_link' do |tag|
+    raise TagError, "can't have `r:comment_link' without a page." unless tag.locals.page
+    options = tag.attr.dup
+    options['class'] ||= 'newmessage'
+    attributes = options.inject('') { |s, (k, v)| s << %{#{k.to_s.downcase}="#{v}" } }.strip
+    attributes = " #{attributes}" unless attributes.empty?
+    text = tag.double? ? tag.expand : "Add a comment"
+    %{<a href="#{tag.render('comment_url')}"#{attributes}>#{text}</a>}
+  end
+
+  desc %{
+    The address for add-a-comment links
+  }
+  tag 'comment_url' do |tag|
+    raise TagError, "can't have `r:comment_url' without a page." unless tag.locals.page
+    new_page_post_url(tag.locals.page)
+  end
+
+  desc %{
+    Shows the standard block of recent discussion activity.
+  }
+  tag 'forum_latest' do |tag|
+    results = []
+    results << %{<ul class="clean">}
+    Topic.visible.latest(6).each do |topic|
+      tag.locals.topic = topic
+      results << %{<li>#{tag.render('topic:summary')}</li>}
+    end
+    results << %{</ul>}
+    results
+  end
+
+  desc %{
+    Shows the standard forum search form in a reasonably compact and stylable way. 
+    
+    Takes options with_title (set to false to omit the usual heading), by_forum (set to true to show a discussion category dropdown) and by_reader (set to true to show a message-from dropdown) and label (set to the title you would like to display over the main search field).
+  }
+  tag 'forum_search' do |tag|
+    results = []
+    compact = true unless tag.attr['by_forum'] == 'true' || tag.attr['by_reader'] == 'true' 
+    q_label = tag.attr['label']
+    q_label = "Look for this text" if q_label.blank? && !compact
+    results << %{<form class="friendly" action="#{search_posts_url}">}
+    results << %{<h2>Forum Search</h2>} unless tag.attr['with_title'] == 'false'
+    results << %{<p>}
+    results << %{<label for="q">#{q_label}</label><br />} unless q_label.blank?
+    results << %{#{text_field_tag("q", params[:q], :class => 'standard')}}
+    results << %{#{submit_tag "search", :class => 'button'}} if compact
+    results << %{</p>}
+    unless compact
+      results << %{<p><label for="reader_id">From this person</label><br /><select name="reader_id"><option value="">anyone</option>#{options_from_collection_for_select(Reader.all, "id", "name")}</select></p>} if tag.attr['by_reader'] == 'true'
+      results << %{<p><label for="forum_id">In this discussion category</label><br /><select name="forum_id"><option value="">anywhere</option>#{options_from_collection_for_select(Forum.visible, "id", "name")}</select></p>} if tag.attr['by_forum'] == 'true'
+      results << %{<p class="buttons">#{submit_tag "search", :class => 'button'}</p>} 
+    end
+    results << %{</form>}
+    results
+  end
+
+  tag 'topic' do |tag|
+    tag.expand if tag.locals.topic
+  end
+  tag 'topic:summary' do |tag|
+    results = []
+    topic = tag.locals.topic
+    post = topic.last_post
+    results << %{<img src="#{post.reader.gravatar_url(:size => 42)}" width="42" height="42" class="gravatar"> } if tag.attr['gravatar'] == 'true'
+    results << %{<a href="#{forum_topic_path(topic.forum, topic)}">#{topic.name}</a> }
+    results << %{<span class="credit">}
+    if topic.page
+      results << " commented upon by "
+    elsif post.first?
+      results << " started by "
+    else
+      results << " replied to by "
+    end
+    results << "#{post.reader.name} #{friendly_date(post.created_at)}"
+    results << %{</span>}
+    results
+  end
+
+
+
+private
+
+  # copied from forum_helper
+  
+  def friendly_date(datetime)
+    if datetime
+      date = datetime.to_date
+      if (date == Date.today)
+        format = "today at %l:%M%p"
+      elsif (date == Date.yesterday)
+        format = "yesterday at %l:%M%p"
+      elsif (date.year == Date.today.year)
+        format = "on %B %e"
+      else
+        format = "on %B %e, %Y"
+      end
+      datetime.strftime(format)
+    end
+  end
+
+end