simple_forum 0.0.1

data/Gemfile

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+
+gem "rails", "3.1.0"
+#gem "rails", :git => "git://github.com/rails/rails.git"
+#gem "arel", :git => "git://github.com/rails/arel.git"
+#gem "rack", :git => "git://github.com/rack/rack.git"
+
+gem "devise"
+
+gem "sqlite3"
+
+#group :development, :test do
+  gem "capybara", ">= 0.4.0"
+  gem "rspec-rails", ">= 2.0.0.beta"
+  gem "factory_girl"
+#end
+
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 YOURNAME
+
+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,49 @@
+= SimpleForum
+
+### Instalation
+
+Make sure you have model representing user. Default is User class. You can change this.
+User model must respond to 'name'.
+
+Add simple_forum to your Rails 3 Gemfile
+
+    gem "simple_forum", :git => "git@github.com:galdomedia/mountable_forum.git"
+
+    bundle install
+
+Install the initializer
+
+    rails g simple_forum:install
+
+Edit the initializer located in `config/initializers/simple_forum.rb` to satisfy your needs.
+
+Copy assets & migrations
+    rake simple_forum_engine:install
+
+    or rake simple_forum:install if rake simple_forum_engine:install doesn't work(rails version < 3.1)
+
+Run migrations
+    rake db:migrate
+
+
+moderator can:
+  - close/open topics
+  - edit posts
+  - delete(mark as deleted) posts
+TODO:
+  - edit topics
+  - delete topics (?)
+
+signed in user can:
+  - create posts
+  - edit own posts(in specified period of time)
+  - delete(mark as deleted) own posts(in specified period of time)
+
+When you are using friendly_id forums and topics will be automatically using it.
+If not to_param method return something like "#{id}-#{name.parameterize}".
+
+TODO:
+  - add generator or rake task to copy views to user application
+
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+require 'rake/rdoctask'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SimpleForum'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks

data/app/controllers/simple_forum/application_controller.rb

@@ -0,0 +1,27 @@
+module SimpleForum
+  class ApplicationController < ::ApplicationController #::ActionController::Base
+    protect_from_forgery
+
+    layout SimpleForum.layout
+
+    helper_method :authenticated_user, :user_authenticated?
+
+    private
+
+    def authenticated_user
+      instance_eval &AbstractAuth.invoke(:authenticated_user)
+    end
+
+    def user_authenticated?
+      instance_eval &AbstractAuth.invoke(:user_authenticated?)
+    end
+
+    def authenticate_user
+      redirect_to :back, :alert => "You have to be logged in" unless user_authenticated?
+    end
+  end
+
+end
+
+
+

data/app/controllers/simple_forum/forums_controller.rb

@@ -0,0 +1,29 @@
+module SimpleForum
+  class ForumsController < ApplicationController
+    respond_to :html
+
+    before_filter :find_forum, :except => [:index]
+
+    def index
+      @categories = SimpleForum::Category.default_order.includes({:forums => [{:recent_post => [:user, :topic]}, :moderators]})
+
+      respond_to :html
+    end
+
+    def show
+      @forum.bang_recent_activity(authenticated_user)
+
+      scope = @forum.topics.includes([:user, {:recent_post => :user}])
+      @topics = scope.respond_to?(:paginate) ? scope.paginate(:page => params[:page], :per_page => params[:per_page]) : scope.all
+
+      respond_to :html
+    end
+
+    private
+
+    def find_forum
+      @forum = SimpleForum::Forum.find params[:id]
+    end
+
+  end
+end

data/app/controllers/simple_forum/posts_controller.rb

@@ -0,0 +1,114 @@
+module SimpleForum
+  class PostsController < ApplicationController
+
+    before_filter :authenticate_user, :except => [:index, :show]
+
+    before_filter :find_forum
+    before_filter :find_topic
+    before_filter :find_post, :except => [:index, :new, :create, :preview]
+    before_filter :build_post, :only => [:new, :create, :preview]
+    before_filter :post_must_be_editable_by_authenticate_user, :only => [:edit, :update]
+
+    def index
+
+      respond_to do |format|
+        format.html do
+          redirect_to simple_forum_forum_topic_url(@forum, @topic), :status => :moved_permanently
+        end
+      end
+    end
+
+    def show
+
+      respond_to do |format|
+        format.html { redirect_to simple_forum_forum_topic_url(@forum, @topic, :page => @post.on_page, :anchor => "post-#{@post.id}") }
+      end
+    end
+
+    def create
+      success = @post.save
+
+      respond_to do |format|
+        format.html do
+          if success
+            redirect_to simple_forum_forum_topic_url(@forum, @topic, :page => @post.on_page, :anchor => "post-#{@post.id}"),
+                        :notice => t('simple_forum.controllers.posts.post_created')
+          else
+            redirect_to simple_forum_forum_topic_url(@forum, @topic, :page => @topic.last_page, :anchor => (@topic.recent_post ? "post-#{@topic.recent_post.id}" : nil)),
+                        :alert => @post.errors.full_messages.join(', ')
+          end
+        end
+      end
+    end
+
+    def preview
+      @post.created_at, @post.updated_at = Time.now
+
+      respond_to do |format|
+        format.js { render :partial => 'simple_forum/topics/post', :locals => {:post => @post, :preview => true} }
+      end
+    end
+
+    def edit
+
+      respond_to :html
+    end
+
+    def update
+      @post.edited_by = authenticated_user
+      @post.edited_at = Time.now
+      success = @post.update_attributes(params[:post])
+
+      respond_to do |format|
+        format.html do
+          if success
+            redirect_to simple_forum_forum_topic_url(@forum, @topic, :page => @post.on_page, :anchor => "post-#{@post.id}"),
+                        :notice => t('simple_forum.controllers.posts.post_updated')
+          else
+            redirect_to :back, :alert => @post.errors.full_messages.join(', ')
+          end
+        end
+      end
+    end
+
+
+    def delete
+      success = @post.mark_as_deleted_by(authenticated_user) #check if post is deletable by authenticated_user in mark_as_deleted_by method
+
+      respond_to do |format|
+        format.html do
+          if success
+            redirect_to :back, :notice => t('simple_forum.controllers.posts.post_deleted')
+          else
+            redirect_to :back, :alert => t('simple_forum.controllers.posts.post_cant_be_deleted')
+          end
+        end
+      end
+    end
+
+    private
+
+    def find_forum
+      @forum = SimpleForum::Forum.find params[:forum_id]
+    end
+
+    def find_topic
+      @topic = @forum.topics.find params[:topic_id]
+    end
+
+    def find_post
+      @post = @topic.posts.find params[:id]
+    end
+
+    def build_post
+      @post = @topic.posts.new params[:post] do |post|
+        post.user = authenticated_user
+      end
+    end
+
+    def post_must_be_editable_by_authenticate_user
+      redirect_to :back, :alert => t('simple_forum.controllers.posts.post_cant_be_edited') unless @post.editable_by?(authenticated_user, nil)
+    end
+
+  end
+end

data/app/controllers/simple_forum/topics_controller.rb

@@ -0,0 +1,116 @@
+module SimpleForum
+  class TopicsController < ApplicationController
+    respond_to :html
+
+    before_filter :authenticate_user, :only => [:new, :create, :open, :close]
+
+    before_filter :find_forum
+    before_filter :find_topic, :except => [:index, :new, :create]
+    before_filter :build_topic, :only => [:new, :create]
+
+    before_filter :moderator_required, :only => [:open, :close]
+
+    def index
+
+      respond_to do |format|
+        format.html do
+          redirect_to simple_forum_forum_url(@forum), :status => :moved_permanently
+        end
+      end
+    end
+
+    def show
+      @topic.bang_recent_activity(authenticated_user)
+      @topic.increment_views_count
+
+      @posts_search = @topic.posts.includes([:user, :deleted_by, :edited_by])
+      @posts = @posts_search.respond_to?(:paginate) ?
+          @posts_search.paginate(:page => params[:page], :per_page => params[:per_page] || SimpleForum::Post.per_page) :
+          @posts_search.all
+
+      @post = SimpleForum::Post.new
+
+      respond_with(@topic)
+    end
+
+    def new
+
+      respond_with(@topic)
+    end
+
+    def create
+      success = @topic.save
+
+      respond_to do |format|
+        format.html do
+          if success
+            flash[:notice] = t('simple_forum.controllers.topics.topic_created')
+            redirect_to simple_forum_forum_topic_url(@forum, @topic)
+          else
+            flash.now[:alert] = @topic.errors.full_messages.join(' ')
+            render :new
+          end
+        end
+      end
+    end
+
+    def open
+      success = if @topic.is_open?
+                  false
+                else
+                  @topic.open!
+                  true
+                end
+
+      respond_to do |format|
+        format.html do
+          if success
+            redirect_to :back, :notice => t('simple_forum.controllers.topics.topic_opened')
+          else
+            redirect_to :back, :alert => t('simple_forum.controllers.topics.topic_already_opened')
+          end
+        end
+      end
+    end
+
+    def close
+      success = if @topic.is_open?
+                  @topic.close!
+                  true
+                else
+                  false
+                end
+
+      respond_to do |format|
+        format.html do
+          if success
+            redirect_to :back, :notice => t('simple_forum.controllers.topics.topic_closed')
+          else
+            redirect_to :back, :alert => t('simple_forum.controllers.topics.topic_already_closed')
+          end
+        end
+      end
+    end
+
+    private
+
+    def find_forum
+      @forum = SimpleForum::Forum.find params[:forum_id]
+    end
+
+    def find_topic
+      @topic = @forum.topics.find params[:id]
+    end
+
+    def build_topic
+      @topic = @forum.topics.new params[:topic] do |topic|
+        topic.user = authenticated_user
+      end
+    end
+
+    def moderator_required
+      redirect_to :back, :alert => t('simple_forum.controllers.you_are_not_permitted_to_perform_this_action') unless @forum.moderated_by?(authenticated_user)
+    end
+
+  end
+end

data/app/models/simple_forum.rb

@@ -0,0 +1,6 @@
+module SimpleForum
+  def self.table_name_prefix
+    'simple_forum_'
+  end
+
+end

data/app/models/simple_forum/category.rb

@@ -0,0 +1,28 @@
+module SimpleForum
+  class Category < ::ActiveRecord::Base
+
+    set_table_name 'simple_forum_categories' #should work table_name_prefix in SimpleForum module but it's not!'
+
+    has_many :forums,
+             :order => "#{SimpleForum::Forum.quoted_table_name}.position ASC",
+             :dependent => :nullify,
+             :class_name => "SimpleForum::Forum"
+
+
+    scope :default_order, order("#{quoted_table_name}.position ASC")
+
+    validates :name, :presence => true
+    validates :position, :presence => true, :numericality => {:only_integer => true, :allow_nil => true}
+
+    attr_accessible :name, :body, :position
+
+    if respond_to?(:has_friendly_id)
+      has_friendly_id :name, :use_slug => true, :approximate_ascii => true
+    else
+      def to_param
+        "#{id}-#{name.to_s.parameterize}"
+      end
+    end
+
+  end
+end