moxie_forum 0.2.4

data/README.rdoc

@@ -0,0 +1,47 @@
+== Overview
+
+There is lots of great forum software for PHP yet I've struggled to find great forums for Rails. With Moxieforum I set out to fix that.
+
+This is my first plugin/gem for rails but I'm trying to take advantage of all the rails 3 goodness to make this a fantastic plugin. I want it to be effortless to install and integrate with your existing app. When MoxieForum is done, I hope the days of rewriting forum functionality for every rails app are over.
+
+Note: this forum is a rails engine, it's not designed to run stand-alone. Instead, it assumes you have an existing rails application, with an existing user model and a mechanism for users to register and login. If that is not the case, you may want: http://github.com/krschacht/moxieforum_standalone
+
+P.S. I've extracted a lot of useful Rails Engine stuff for other engine builders: http://github.com/krschacht/rails_3_engine_demo
+
+== Installation
+
+Technically all you need to do is "sudo gem install moxie_forum", but I'll walk you through the basics of integration:
+
+Requirement: Rails v3
+
+* sudo gem install moxie_forum
+* [ edit your app's 'Gemfile' and add: ] gem 'moxie_forum'
+* rails generate moxie_forum
+* rails db:migrate
+* rails server
+
+You can now visit: http://localhost:3000/forums
+
+At this point the basic forum setup is done, you can click around, however it's not actually integrated with your user model and authentication system yet so you won't be able to post. To complete that:
+
+* Edit config/initializers/moxie_forum.rb, change :user to reflect your user model
+* Edit your ActiveRecord user model and add 'acts_as_moxie_user' inside the class near the top
+* Also in your user model, MoxieForum will call the following instance methods, you should override these: profile_pic, display_name, admin?, moderator?
+
+== Features
+
+* #1 feature - Easy integration with your existing rails app including tight integration with your existing user model and 'admin' designation for users
+* Administrative interface to create multiple forums
+
+== Future Features
+
+Topics:
+* sticky
+* locked
+* merge
+* split
+* figure out how to destroy all posts in one query instead of individual
+
+Forum:
+* allow admin-only forums
+

data/app/controllers/moxie/admin/forums_controller.rb

@@ -0,0 +1,71 @@
+module Moxie
+  class Admin::ForumsController < ApplicationController
+
+    unloadable
+
+    def index
+      @forums = Forum.all
+
+      respond_to do |format|
+        format.html # index.html.erb
+        format.xml  { render :xml => @forums }
+      end
+    end
+
+    def show
+      @forum = Forum.find(params[:id])
+
+      respond_to do |format|
+        format.html # show.html.erb
+        format.xml  { render :xml => @forum }
+      end
+    end
+
+    def new
+      @forum = Forum.new
+
+      respond_to do |format|
+        format.html # new.html.erb
+        format.xml  { render :xml => @forum }
+      end
+    end
+
+    def edit
+      @forum = Forum.find(params[:id])
+    end
+
+    def create
+      @forum = Forum.new(params[:moxie_forum])
+
+      respond_to do |format|
+        if @forum.save
+          format.html { redirect_to( admin_moxie_forums_path, 
+                                :notice => 'Forum was successfully created.') }
+        else
+          format.html { render :action => "new" }
+        end
+      end
+    end
+
+    def update
+      @forum = Forum.find(params[:id])
+
+      respond_to do |format|
+        if @forum.update_attributes(params[:moxie_forum])
+          format.html { redirect_to( admin_moxie_forums_path, :notice => 'Forum was successfully updated.') }
+        else
+          format.html { render :action => "edit" }
+        end
+      end
+    end
+
+    def destroy
+      @forum = Forum.find(params[:id])
+      @forum.destroy
+
+      respond_to do |format|
+        format.html { redirect_to( admin_moxie_forums_path ) }
+      end
+    end
+  end
+end

data/app/controllers/moxie/admin_controller.rb

@@ -0,0 +1,10 @@
+module Moxie
+  class AdminController < ApplicationController
+
+    unloadable
+    
+    def index
+    end
+    
+  end
+end

data/app/controllers/moxie/forums_controller.rb

@@ -0,0 +1,29 @@
+module Moxie
+  class ForumsController < ApplicationController
+
+    layout 'forums'
+    
+    unloadable
+
+    def index
+      @forums = Forum.all
+
+      respond_to do |format|
+        format.html # index.html.erb
+        format.xml  { render :xml => @forums }
+      end
+    end
+
+    def show
+      @forum = Forum.find( params[:id] )
+      @topic = Topic.new
+      @topic.posts.build      
+
+      respond_to do |format|
+        format.html # show.html.erb
+        format.xml  { render :xml => @forum }
+      end
+    end
+
+  end
+end

data/app/controllers/moxie/posts_controller.rb

@@ -0,0 +1,52 @@
+module Moxie
+  class PostsController < ApplicationController
+    before_filter :require_user, :only => [ :new, :create ]
+
+    layout 'forums'
+
+    unloadable
+
+    def show
+      @post = Post.find( params[:id] )
+
+      respond_to do |format|
+        format.html # show.html.erb
+        format.xml  { render :xml => @post }
+      end
+    end
+  
+    def new
+      @post = Post.new
+
+      respond_to do |format|
+        format.html # new.html.erb
+        format.xml  { render :xml => @post }
+      end
+    end
+    
+    def create
+      post_params = params[:moxie_post]
+      post_params[:author_id] = current_user.id
+      
+      @post = Post.new( post_params )
+
+      respond_to do |format|
+        if @post.save
+          format.html { redirect_to( moxie_topic_path( @post.topic ), 
+                                :notice => 'Post was successfully created.') }
+        else
+          format.html { render :action => "new" }
+        end
+      end
+    end
+  end    
+
+
+  private
+  
+  def require_user
+    redirect_to moxie_authorization_error_path
+  end
+
+end
+

data/app/controllers/moxie/topics_controller.rb

@@ -0,0 +1,63 @@
+module Moxie
+  class TopicsController < ApplicationController
+    before_filter :require_user, :only => [ :new, :create, :show_postable ]
+
+    layout 'forums'
+
+    unloadable
+
+    def show_postable
+      @topic = Topic.find( params[:topic_id] )
+      @post = Post.new
+
+      render :action => :show
+    end
+    
+    def show
+      @topic = Topic.find( params[:id] )
+      @post = Post.new
+
+      respond_to do |format|
+        format.html # show.html.erb
+        format.xml  { render :xml => @topic }
+      end
+    end
+  
+    def new
+      @topic = Topic.new
+      @topic.posts.build
+      @forum = Forum.find( params[:forum_id] )
+
+      respond_to do |format|
+        format.html # new.html.erb
+        format.xml  { render :xml => @topic }
+      end
+    end
+    
+    def create
+      topic_params = params[:moxie_topic]
+      topic_params[:author_id] = current_user.id
+      topic_params[:posts_attributes]['0'][:author_id] = current_user.id
+            
+      @topic = Topic.new( topic_params )
+      @forum = Forum.find( params[:moxie_topic][:forum_id] )
+
+      respond_to do |format|
+        if @topic.save
+          format.html { redirect_to( moxie_forum_path( @topic.forum ), 
+                                :notice => 'Topic was successfully created.') }
+        else
+          format.html { render :new }
+        end
+      end
+    end
+  end
+  
+  
+  private
+  
+  def require_user
+    redirect_to moxie_authorization_error_path
+  end
+
+end

data/app/helpers/moxie/application_helper.rb

@@ -0,0 +1,3 @@
+## Look in lib/application_helper.rb
+## And look in engine.rb
+## I can't figure out how to get it included unless I put it there

data/app/helpers/moxie/forums_helper.rb

@@ -0,0 +1,5 @@
+module Moxie
+  module ForumsHelper
+        
+  end
+end

data/app/models/moxie/forum.rb

@@ -0,0 +1,16 @@
+module Moxie
+  class Forum < ActiveRecord::Base
+    set_table_name "moxie_forums"
+
+    has_many :topics
+    before_destroy :remove_topics
+
+    validates :title, :presence => true
+    
+    def remove_topics
+      topics.each { |t| t.destroy }
+    end
+    
+  end
+  
+end

data/app/models/moxie/post.rb

@@ -0,0 +1,34 @@
+module Moxie
+  class Post < ActiveRecord::Base
+    set_table_name "moxie_posts"
+    
+    begin
+      user_model = MoxieForum::Engine.config.user_model_name
+    rescue
+      user_model = "user"
+    end
+    
+    belongs_to :topic
+    belongs_to :author, :class_name => user_model
+    
+    validates :body, :presence => true
+    
+    after_create    :increment_topic_post_count
+    before_destroy  :decrement_topic_post_count
+    
+    def increment_topic_post_count
+      return  if topic.nil?
+
+      topic.post_count += 1
+      topic.save
+    end
+
+    def decrement_topic_post_count
+      return  if topic.nil?
+
+      topic.post_count -= 1
+      topic.save
+    end
+    
+  end
+end

data/app/models/moxie/topic.rb

@@ -0,0 +1,39 @@
+module Moxie
+  class Topic < ActiveRecord::Base
+    set_table_name "moxie_topics"
+
+    begin
+      user_model = MoxieForum::Engine.config.user_model_name
+    rescue
+      user_model = "user"
+    end
+    
+    belongs_to    :forum
+    belongs_to    :author,           :class_name => user_model
+    belongs_to    :last_post_author, :class_name => user_model
+    has_many      :posts
+    accepts_nested_attributes_for :posts
+
+    validates :title, :presence => true
+    
+    after_create    :increment_forum_topic_count
+    before_destroy  :decrement_forum_topic_count
+    after_destroy   :remove_posts
+    
+    def increment_forum_topic_count
+      forum.topic_count += 1
+      forum.save
+    end
+
+    def decrement_forum_topic_count
+      forum.topic_count -= 1
+      forum.save      
+    end
+    
+    def remove_posts
+      posts.each { |p| p.destroy }
+    end
+    
+  end
+
+end

data/app/views/layouts/forums.html.erb

@@ -0,0 +1,14 @@
+
+<% content_for :content do %>
+
+<%= stylesheet_link_tag("moxie_forum") %>
+
+<div class="mfw">
+
+  <%= yield %>
+
+</div>
+
+<% end -%>
+
+<%= render :file => 'layouts/application' %>

data/app/views/moxie/admin/forums/_form.html.erb

@@ -0,0 +1,28 @@
+<%= form_for [ :admin, @forum ] do |f| %>
+  <% if @forum.errors.any? %>
+  <div id="errorExplanation">
+    <h2><%= pluralize(@forum.errors.count, "error") %> prohibited this forum from being saved:</h2>
+    <ul>
+    <% @forum.errors.full_messages.each do |msg| %>
+      <li><%= msg %></li>
+    <% end %>
+    </ul>
+  </div>
+  <% end %>
+
+  <div class="field">
+    <%= f.label :title %><br />
+    <%= f.text_field :title %>
+  </div>
+  <div class="field">
+    <%= f.label :description %><br />
+    <%= f.text_field :description %>
+  </div>
+  <div class="field">
+    <%= f.label :topic_count %><br />
+    <%= f.text_field :topic_count %>
+  </div>
+  <div class="actions">
+    <%= f.submit %>
+  </div>
+<% end %>

data/app/views/moxie/admin/forums/edit.html.erb

@@ -0,0 +1,6 @@
+<h1>Editing forum</h1>
+
+<%= render 'form' %>
+
+<%= link_to 'Show', @forum %> |
+<%= link_to 'Back', moxie_forums_path %>

data/app/views/moxie/admin/forums/index.html.erb

@@ -0,0 +1,28 @@
+<h1>Listing forums</h1>
+
+<table>
+  <tr>
+    <th>Title</th>
+    <th>Description</th>
+    <th>Num topics</th>
+    <th></th>
+    <th></th>
+    <th></th>
+  </tr>
+
+<% @forums.each do |forum| %>
+  <tr>
+    <td><%= forum.title %></td>
+    <td><%= forum.description %></td>
+    <td><%= forum.topic_count %></td>
+    <td><%= link_to 'Show', admin_moxie_forum_path( forum ) %></td>
+    <td><%= link_to 'Edit', edit_admin_moxie_forum_path( forum ) %></td>
+    <td><%= link_to 'Destroy', admin_moxie_forum_path( forum ), 
+                              :confirm => 'Are you sure?', :method => :delete %></td>
+  </tr>
+<% end %>
+</table>
+
+<br />
+
+<%=  link_to 'New Forum', new_admin_moxie_forum_path %>

data/app/views/moxie/admin/forums/new.html.erb

@@ -0,0 +1,5 @@
+<h1>New forum</h1>
+
+<%= render 'form' %>
+
+<%= link_to 'Back', admin_moxie_forums_path %>

data/app/views/moxie/admin/forums/show.html.erb

@@ -0,0 +1,20 @@
+<p class="notice"><%= notice %></p>
+
+<p>
+  <b>Title:</b>
+  <%= @forum.title %>
+</p>
+
+<p>
+  <b>Description:</b>
+  <%= @forum.description %>
+</p>
+
+<p>
+  <b>Num topics:</b>
+  <%# @forum.num_topics %>
+</p>
+
+
+<%# link_to 'Edit', edit_moxie_forum_path(@forum) %> |
+<%= link_to 'Back', admin_moxie_forums_path %>

data/app/views/moxie/admin/index.html.erb

@@ -0,0 +1,3 @@
+<h1>admin</h1>
+
+<%= link_to "forums", admin_moxie_forums_path %>

data/app/views/moxie/forums/authorization_error.html.erb

@@ -0,0 +1,4 @@
+<div class="m_error_msg">
+  Setup Problem
+  <p>You just tried to access a page that requires a user to be logged in. The controller had a before_filter :require_user. You need to add a require_user method to your application_controller.rb that does whatever checks necessary to determine that a user is logged in. You will also need a current_user helper method within application_controller.rb that returns the logged in user. The forum will not work correctly until you have both of these.</p>
+</div>

data/app/views/moxie/forums/index.html.erb

@@ -0,0 +1,20 @@
+<% @forums.each do |forum| %>
+
+  <div class="m_forum clearfix">
+      
+    <div class="m_name">
+      <div class="m_title"><%= link_to forum.title, moxie_forum_path( forum ) %></div>
+      <div class="m_description">
+        <span class="m_topic_count"><%= pluralize forum.topic_count, moxie_topic_name %>.</span>
+        <%= forum.description %>
+      </div>
+    </div>
+
+    <div class="m_info">
+      <div class="m_topic_count"><%= pluralize forum.topic_count, moxie_topic_name %></div>
+    </div>
+
+  </div>
+    
+<% end %>
+

data/app/views/moxie/forums/show.html.erb

@@ -0,0 +1,38 @@
+<div class="m_nav">< <%= link_to  "All #{moxie_forum_name.titleize.pluralize}", 
+                                  moxie_forums_path, 
+                                  :class => "always_underlined "%>
+</div>
+
+<div class="m_header">
+  <%= @forum.title %>  
+</div>
+
+<div class="m_header_links">
+  <%= link_to "Start a new #{moxie_topic_name}", 
+              forum_new_moxie_topic_path( @forum ),
+              :class => "always_underlined action" %>
+</div>
+
+<div>
+<% @forum.topics.each do |topic| %>
+
+  <div class="m_topic clearfix">
+      
+    <div class="m_name">
+      <div class="m_title"><%= link_to topic.title, moxie_topic_path( topic ) %></div>
+      <div class="m_description">
+        <span class="m_topic_count"><%= pluralize topic.post_count, moxie_post_name %>.</span>
+        Started by <%= topic.author.full_name  if topic.author %>
+      </div>
+    </div>
+
+    <div class="m_info">
+      <div class="m_topic_count"><%# pluralize forum.topic_count, "topic" %></div>
+    </div>
+
+  </div>
+    
+<% end %>
+</div>
+
+

data/app/views/moxie/posts/_form.html.erb

@@ -0,0 +1,51 @@
+<%= form_for [ @post ] do |f| %>
+
+  <% if @post.errors.any? %>
+  <div id="errorExplanation">
+    <h2><%= pluralize(@post.errors.count, "error") %> prohibited this forum from being saved:</h2>
+    <ul>
+    <% @post.errors.full_messages.each do |msg| %>
+      <li><%= msg %></li>
+    <% end %>
+    </ul>
+  </div>
+  <% end %>
+
+  <% if current_user %>
+
+    <div class="m_post clearfix m_newpost">
+      <div class="m_user">
+        <%= current_user.profile_pic %>
+      </div>
+
+      <div class="m_contents">
+
+        <div class="m_body">
+          <div class="m_prompt field"><%= f.label :body, "Add a reply #{moxie_post_name}" %></div>
+            <%= f.text_area :body %>
+        </div>
+            
+        <%= hidden_field_tag 'moxie_post[topic_id]', @topic.id %>
+
+        <div class="m_actions"><%= f.submit "Create #{moxie_post_name.titleize}" %></div>
+      
+      </div> <!-- contents -->
+    </div>   <!-- post -->
+  
+  <% else %>
+
+    <div class="m_post clearfix m_newpost">
+
+      <div class="m_contents">
+      
+        <div class="m_body">
+          <div class="m_prompt field">Add a reply <%= moxie_post_name %></div>
+          
+          <%= link_to "Login", topic_show_postable_moxie_topic_path( @topic ) %> to post a reply.
+        </div>
+      </div>
+    </div>
+  
+  <% end %>
+
+<% end %>

data/app/views/moxie/posts/_post.html.erb

@@ -0,0 +1,23 @@
+<div class="m_post clearfix">
+    
+  <div class="m_user">
+    <%= post.author.profile_pic  if post.author %>
+  </div>
+  
+  <div class="m_contents">
+    <div class="m_meta">
+      <span class="m_author"><%= post.author.display_name  if post.author %></span>
+      <span class="m_datetime"><%= time_ago_in_words( post.created_at ) %></span>
+    </div>
+
+    <div class="m_body">
+      <%= auto_link( h( post.body ).
+          gsub(/\n/, '<br>').
+          gsub(/\[b\](.*?)\[\/b\]/, "<b>\\1</b>").
+          gsub(/\[i\](.*?)\[\/i\]/, "<i>\\1</i>").
+          gsub(/\[u\](.*?)\[\/u\]/, "<u>\\1</u>").
+          gsub(/\?last_post_at=\d+/, "") , :all ) %>
+    </div>
+  </div>
+
+</div>