formol 0.0.4

data/config/routes.rb

@@ -0,0 +1,31 @@
+Formol::Engine.routes.draw do
+  resources :categories, :only => [:index, :show]
+  
+  resources :forums, :only => [:show] do
+    resources :topics, :except => [:index]
+  end
+  
+  resources :topics do
+    resources :posts,       :except => [:index]
+    resources :poll_votes,  :only   => [:create]
+    
+    post    '/subscriptions' => 'subscriptions#create'
+    delete  '/subscriptions' => 'subscriptions#destroy'
+  end
+  
+  resource :preference, :only => [:show, :update]
+  
+  root :to => 'categories#index'
+  
+  namespace :admin do
+    resources :categories, :except => [:show] do
+      put :sort, :on => :collection
+      
+      resources :forums, :except => [:index, :show] do
+        put :reorganize, :on => :collection
+      end
+    end
+    
+    root :to => 'categories#index'
+  end
+end

data/db/migrate/20111221101158_create_formol_categories.rb

@@ -0,0 +1,7 @@
+class CreateFormolCategories < ActiveRecord::Migration
+  def change
+    create_table :formol_categories do |t|
+      t.string      :label,   :limit => 64
+    end
+  end
+end

data/db/migrate/20111221111417_create_formol_forums.rb

@@ -0,0 +1,10 @@
+class CreateFormolForums < ActiveRecord::Migration
+  def change
+    create_table :formol_forums do |t|
+      t.belongs_to  :category
+      t.string      :label,           :limit => 32
+      t.text        :description
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20111221121010_create_formol_topics.rb

@@ -0,0 +1,9 @@
+class CreateFormolTopics < ActiveRecord::Migration
+  def change
+    create_table :formol_topics do |t|
+      t.belongs_to  :forum
+      t.string      :title,  :limit => 48
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20111221123515_create_formol_posts.rb

@@ -0,0 +1,9 @@
+class CreateFormolPosts < ActiveRecord::Migration
+  def change
+    create_table :formol_posts do |t|
+      t.belongs_to  :topic
+      t.text        :content
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20111221151653_add_index_on_tables.rb

@@ -0,0 +1,15 @@
+class AddIndexOnTables < ActiveRecord::Migration
+  def change
+    change_table :formol_posts do |t|
+      t.index :topic_id
+    end
+    
+    change_table :formol_topics do |t|
+      t.index :forum_id
+    end
+    
+    change_table :formol_forums do |t|
+      t.index :category_id
+    end
+  end
+end

data/db/migrate/20120103163438_add_user_to_models.rb

@@ -0,0 +1,13 @@
+class AddUserToModels < ActiveRecord::Migration
+  def change
+    change_table :formol_posts do |t|
+      t.belongs_to :user
+      t.index :user_id
+    end
+    
+    change_table :formol_topics do |t|
+      t.belongs_to :user
+      t.index :user_id
+    end
+  end
+end

data/db/migrate/20120104132631_add_counter_cache_to_models.rb

@@ -0,0 +1,12 @@
+class AddCounterCacheToModels < ActiveRecord::Migration
+  def change
+    change_table :formol_forums do |t|
+      t.integer :topics_count
+      t.integer :posts_count
+    end
+    
+    change_table :formol_topics do |t|
+      t.integer :posts_count
+    end
+  end
+end

data/db/migrate/20120104163741_add_pinned_to_topics.rb

@@ -0,0 +1,7 @@
+class AddPinnedToTopics < ActiveRecord::Migration
+  def change
+    change_table :formol_topics do |t|
+      t.boolean :pinned,  :default => false
+    end
+  end
+end

data/db/migrate/20120105133522_add_position_to_categories.rb

@@ -0,0 +1,7 @@
+class AddPositionToCategories < ActiveRecord::Migration
+  def change
+    change_table :formol_categories do |t|
+      t.integer :position
+    end
+  end
+end

data/db/migrate/20120105190708_add_position_to_forums.rb

@@ -0,0 +1,7 @@
+class AddPositionToForums < ActiveRecord::Migration
+  def change
+    change_table :formol_forums do |t|
+      t.integer :position
+    end
+  end
+end

data/db/migrate/20120105212559_add_lock_to_topics.rb

@@ -0,0 +1,7 @@
+class AddLockToTopics < ActiveRecord::Migration
+  def change
+    change_table :formol_topics do |t|
+      t.boolean :locked,  :default => false
+    end
+  end
+end

data/db/migrate/20120106130944_add_first_post_and_last_post_to_topics.rb

@@ -0,0 +1,8 @@
+class AddFirstPostAndLastPostToTopics < ActiveRecord::Migration
+  def change
+    change_table :formol_topics do |t|
+      t.belongs_to :first_post
+      t.belongs_to :last_post
+    end
+  end
+end

data/db/migrate/20120106192951_change_forum_description_to_string.rb

@@ -0,0 +1,9 @@
+class ChangeForumDescriptionToString < ActiveRecord::Migration
+  def up
+    change_column :formol_forums, :description, :string, :limit => 128
+  end
+
+  def down
+    change_column :formol_forums, :description, :text
+  end
+end

data/db/migrate/20120107012517_add_last_post_to_forum.rb

@@ -0,0 +1,7 @@
+class AddLastPostToForum < ActiveRecord::Migration
+  def change
+    change_table :formol_forums do |t|
+      t.belongs_to :last_post
+    end
+  end
+end

data/db/migrate/20120107122921_add_missing_indexes.rb

@@ -0,0 +1,12 @@
+class AddMissingIndexes < ActiveRecord::Migration
+  def change
+    change_table :formol_forums do |t|
+      t.index :last_post_id
+    end
+    
+    change_table :formol_topics do |t|
+      t.index :first_post_id
+      t.index :last_post_id
+    end
+  end
+end

data/db/migrate/20120107123654_add_default_on_forum_counters.rb

@@ -0,0 +1,10 @@
+class AddDefaultOnForumCounters < ActiveRecord::Migration
+  def up
+    change_column_default :formol_forums, :topics_count,  0
+    change_column_default :formol_forums, :posts_count,   0
+  end
+
+  def down
+    #no need to rollback this migration
+  end
+end

data/db/migrate/20120108114030_add_views_to_topics.rb

@@ -0,0 +1,7 @@
+class AddViewsToTopics < ActiveRecord::Migration
+  def change
+    change_table :formol_topics do |t|
+      t.integer :views_count, :default => 0
+    end
+  end
+end

data/db/migrate/20120108131533_create_formol_topic_tracks.rb

@@ -0,0 +1,13 @@
+class CreateFormolTopicTracks < ActiveRecord::Migration
+  def change
+    create_table :formol_topic_tracks do |t|
+      t.belongs_to  :user
+      t.belongs_to  :forum
+      t.belongs_to  :topic
+      t.datetime    :marked_at
+    end
+    
+    add_index :formol_topic_tracks, :user_id
+    add_index :formol_topic_tracks, [:user_id, :forum_id]
+  end
+end

data/db/migrate/20120109115141_create_formol_topic_subscriptions.rb

@@ -0,0 +1,10 @@
+class CreateFormolTopicSubscriptions < ActiveRecord::Migration
+  def change
+    create_table :formol_topic_subscriptions do |t|
+      t.belongs_to  :topic
+      t.belongs_to  :subscriber
+    end
+    
+    add_index :formol_topic_subscriptions, [:topic_id, :subscriber_id], :unique => true
+  end
+end

data/db/migrate/20120109220633_create_formol_user_preferences.rb

@@ -0,0 +1,11 @@
+class CreateFormolUserPreferences < ActiveRecord::Migration
+  def change
+    create_table :formol_user_preferences do |t|
+      t.belongs_to  :user
+      t.string      :signature,       :limit => 120
+      t.boolean     :use_signature,                   :default => true
+    end
+    
+    add_index :formol_user_preferences, :user_id, :unique => true
+  end
+end

data/db/migrate/20120109223624_add_display_signature_to_posts.rb

@@ -0,0 +1,7 @@
+class AddDisplaySignatureToPosts < ActiveRecord::Migration
+  def change
+    change_table :formol_posts do |t|
+      t.boolean :display_signature
+    end
+  end
+end

data/db/migrate/20120109233054_add_display_signatures_and_avatars_to_user_preferences.rb

@@ -0,0 +1,8 @@
+class AddDisplaySignaturesAndAvatarsToUserPreferences < ActiveRecord::Migration
+  def change
+    change_table :formol_user_preferences do |t|
+      t.boolean :display_signatures,  :default => true
+      t.boolean :display_avatars,     :default => true
+    end
+  end
+end

data/db/migrate/20120110152548_create_formol_polls.rb

@@ -0,0 +1,14 @@
+class CreateFormolPolls < ActiveRecord::Migration
+  def change
+    create_table :formol_polls do |t|
+      t.belongs_to  :topic
+      t.string      :question,    :limit => 64
+      t.integer     :duration
+      t.integer     :max_options
+      t.integer     :votes_count
+      t.datetime    :created_at
+    end
+    
+    add_index :formol_polls,  :topic_id, :unique => true
+  end
+end

data/db/migrate/20120110152618_create_formol_poll_options.rb

@@ -0,0 +1,11 @@
+class CreateFormolPollOptions < ActiveRecord::Migration
+  def change
+    create_table :formol_poll_options do |t|
+      t.belongs_to  :poll
+      t.string      :answer,        :limit => 32
+      t.integer     :votes_count
+    end
+    
+    add_index :formol_poll_options, :poll_id
+  end
+end

data/db/migrate/20120110152632_create_formol_poll_votes.rb

@@ -0,0 +1,12 @@
+class CreateFormolPollVotes < ActiveRecord::Migration
+  def change
+    create_table :formol_poll_votes do |t|
+      t.belongs_to  :option
+      t.belongs_to  :voter
+      t.datetime    :created_at
+    end
+    
+    add_index :formol_poll_votes, :voter_id
+    add_index :formol_poll_votes, :option_id
+  end
+end

data/lib/formol/config.rb

@@ -0,0 +1,12 @@
+module Formol
+  class Config < Struct.new(:user_class, 
+                            :current_user_helper_method,
+                            :formatter,
+                            :email_from,
+                            :text_formatter)
+
+    def user
+      @user ||= user_class.constantize
+    end
+  end
+end

data/lib/formol/controllers/auth.rb

@@ -0,0 +1,9 @@
+module Formol
+  module Controllers
+    module Auth
+      def current_formol_user
+        send(Formol.config.current_user_helper_method.to_sym)
+      end
+    end
+  end
+end

data/lib/formol/controllers/nested/has_parent_category.rb

@@ -0,0 +1,11 @@
+module Formol
+  module Controllers
+    module Nested
+      module HasParentCategory
+        def category
+          @category ||= Formol::Category.find(params[:category_id])
+        end
+      end
+    end
+  end
+end

data/lib/formol/controllers/nested/has_parent_forum.rb

@@ -0,0 +1,11 @@
+module Formol
+  module Controllers
+    module Nested
+      module HasParentForum
+        def forum
+          @forum ||= Formol::Forum.ready_for_breadcrumb.find(params[:forum_id])
+        end
+      end
+    end
+  end
+end

data/lib/formol/controllers/nested/has_parent_topic.rb

@@ -0,0 +1,11 @@
+module Formol
+  module Controllers
+    module Nested
+      module HasParentTopic
+        def topic
+          @topic ||= Formol::Topic.ready_for_breadcrumb.find(params[:topic_id])
+        end
+      end
+    end
+  end
+end

data/lib/formol/controllers.rb

@@ -0,0 +1,5 @@
+require "formol/controllers/auth"
+
+require "formol/controllers/nested/has_parent_category"
+require "formol/controllers/nested/has_parent_forum"
+require "formol/controllers/nested/has_parent_topic"

data/lib/formol/engine.rb

@@ -0,0 +1,18 @@
+module Formol
+  class Engine < Rails::Engine
+    isolate_namespace Formol
+    
+    engine_name 'formol'
+    
+    config.generators do |g|
+      g.test_framework = :rspec
+    end
+    
+    config.i18n.railties_load_path = []
+    
+    config.active_record.observers = [:'formol/post_observer']
+    
+    #Needed to have proper locales organization
+    paths['config/locales'] << 'config/locales/**/'
+  end
+end

data/lib/formol/formatters/redcarpet/formatter.rb

@@ -0,0 +1,36 @@
+require 'redcarpet'
+require 'pygments.rb'
+
+module Formol
+  module Formatters
+    module Redcarpet
+      class Formatter
+        def initialize
+          @renderer = SyntaxHighlighter.new(:hard_wrap    => true,
+                                            :filter_html  => true)
+          @processor = ::Redcarpet::Markdown.new(@renderer, :fenced_code_blocks   => true,
+                                                            :no_intra_emphasis    => true,
+                                                            :autolink             => true,
+                                                            :space_after_headers  => false,
+                                                            :superscript          => false)
+        end
+        
+        def to_html(text)
+          @processor.render(text).html_safe
+        end
+        
+        def quote(text)
+          quoted_text = ""
+          
+          text.split("\n").each_with_index do |l|
+            quoted_text << '> ' if (l.strip.blank? || l.start_with?('>'))
+            quoted_text << l
+            quoted_text << "\n"
+          end
+          
+          quoted_text
+        end
+      end
+    end
+  end
+end

data/lib/formol/formatters/redcarpet/syntax_highlighter.rb

@@ -0,0 +1,23 @@
+require 'redcarpet'
+require 'pygments.rb'
+
+module Formol
+  module Formatters
+    module Redcarpet
+      class SyntaxHighlighter < ::Redcarpet::Render::XHTML
+        def block_code(code, language)
+           title_block(language) + Pygments.highlight(code, :lexer    => language,
+                                                            :options  => {
+                                                              :linenos  => 'inline'
+                                                            })
+        end
+        
+        private
+        
+        def title_block(language)
+          %{<div class="highlight_title #{language.downcase}">#{language.downcase.capitalize}</div>}
+        end
+      end
+    end
+  end
+end

data/lib/formol/formatters.rb

@@ -0,0 +1,2 @@
+require 'formol/formatters/redcarpet/formatter'
+require 'formol/formatters/redcarpet/syntax_highlighter'

data/lib/formol/generators/install/install_generator.rb

@@ -0,0 +1,94 @@
+require 'rails/generators'
+
+module Formol
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      attr_accessor :user_class, :current_user_helper
+      
+      source_root File.expand_path('../templates', __FILE__)
+      
+      desc 'Formol installation...'
+      
+      def get_user_class
+        self.user_class = ask("What is you user model called? [User]")
+        self.user_class = 'user' if user_class.blank?
+        
+        self.user_class = user_class.classify
+      end
+      
+      def get_current_user_helper
+        self.current_user_helper = ask("What is the 'current_user' helper called in your main app? [current_user]")
+        self.current_user_helper = 'current_user' if current_user_helper.blank?
+      end
+      
+      def install_migrations
+        rake 'formol:install:migrations'
+      end
+      
+      def install_formol_user_migrations
+        template 'migrations/add_formol_profile_to_users.rb.erb', "#{Rails.root}/db/migrate/#{next_migration_number}_add_formol_profile_to_user.rb"
+        template 'migrations/add_posts_count_to_user.rb.erb',     "#{Rails.root}/db/migrate/#{next_migration_number}_add_posts_count_to_user.rb"
+      end
+      
+      def install_formol_initializer
+        template 'initializer/formol.rb.erb', "#{Rails.root}/config/initializers/formol.rb"
+      end
+      
+      def copy_formol_config_yml
+        template 'config/formol.yml', "#{Rails.root}/config/formol.yml"
+      end
+      
+      def copy_special_rights
+        template 'lib/permissions/special_rights.rb', "#{Rails.root}/lib/formol/permissions/special_rights.rb"
+      end
+      
+      def mount_engine
+        inject_into_file("#{Rails.root}/config/routes.rb", %{  mount Formol::Engine => "/forums", :as => :formol\n}, :after => /routes.draw.do\n/)
+      end
+      
+      def finished
+        puts <<END
+#{'=' * 90}
+Formol is now installed into your application
+You can access it with http://yourhost/forums
+
+* Formol migrations were copied into db/migrate and there was also two migrations for #{user_class} created.
+* A new initializer called formol has been added to 'config/initializers'
+* A yaml file wich contains profiles and permissions has been added to 'config'
+* A module to define special rights has been added to 'lib/formol/permissions/special_rights'
+* The formol engine was mounted in 'config/routes.rb'
+
+What you need to do if you wanna formol work:
+
+* run 'rake db:migrate'
+* add '<%= include_formol_javascripts %>' in the head section of your application layout
+* add 'include Formol::Integration::User' in your #{user_class} model
+
+If you want to change where the forums are located, just change the "forums" path in 'config/routes.rb'.
+
+Formol is delivered with no warranty under MIT license.
+However, if you have any question, suggestion or issue, you can post them on our github repository, at the following address: https://github.com/mulasse/formol/issues
+
+Thank your for using Formol.
+#{'=' * 90}
+
+END
+      end
+      
+      private
+      
+      def next_migration_number
+        @prev_migration_number = if @prev_migration_number.blank?
+          last_migration = Dir[Rails.root.join('db/migrate/*.rb')].sort.last.split("/").last
+          last_migration_number = last_migration.split('_').first
+          
+          last_migration_number.to_i + 1
+        else
+          @prev_migration_number + 1
+        end
+        
+        @prev_migration_number.to_s
+      end
+    end
+  end
+end

data/lib/formol/generators/install/templates/config/formol.yml

@@ -0,0 +1,29 @@
+formol:
+  profiles:
+    admin:
+      rights:
+        - administrate
+        #administrate right grants all rights
+
+    #default profile is used for unregistered users
+    default:
+      rights: 
+        - read_category
+        - read_forum
+        - read_topic
+
+    registered:
+      extends: default
+      rights:
+        - create_topic
+        - create_post
+        - vote_poll
+        - subscribe_topic
+
+    moderator:
+      extends: registered
+      rights:
+        - edit_topic
+        - edit_post 
+        - lock_topic
+        - pin_topic

data/lib/formol/generators/install/templates/initializer/formol.rb.erb

@@ -0,0 +1,21 @@
+Formol.configure do
+  # formol needs to know what is your User class
+  # almost everything (topics, posts, votes ...) is attached to a user
+  # this params must be a string, not a constant
+  config.user_class = '<%= user_class %>'
+  
+  # formol need to know how to access to authenticated user
+  # usually, helper method is called 'current_user'
+  config.current_user_helper_method = :<%= current_user_helper %>
+  
+  # choose what text formatter you need
+  # actually only :markdown is available
+  # we will add :bbcode in a near future
+  config.text_formatter = :markdown
+  
+  # you need to provide an email adress wich will be used as sender adress in all
+  # email that formol will send
+  #
+  # actually, only subscriptions send emails
+  config.email_from = 'noreply@example.com'
+end

data/lib/formol/generators/install/templates/lib/permissions/special_rights.rb

@@ -0,0 +1,24 @@
+module Formol
+  module Permissions
+    # add methods to this module to define some rights that acts
+    # differently than just checking if user has right for his profile.
+    # 
+    # For instance, a user can edit a post without having 'edit_post' right
+    # if he wrotes it, he's able to edit it
+    module SpecialRights
+      # a user can edit a topic if he wrotes it
+      def able_to_edit_topic?(topic)
+        has_right?(:edit_topic) || (!topic.locked? && topic.user_id == user.id)
+      end
+      
+      # a user can edit a post if he wrotes it
+      def able_to_edit_post?(post)
+        has_right?(:edit_post) || (!post.topic.locked? && post.user_id == user.id)
+      end
+      
+      def able_to_create_post?(topic)
+        has_right?(:create_post) && !topic.locked?
+      end
+    end
+  end
+end

data/lib/formol/generators/install/templates/migrations/add_formol_profile_to_users.rb.erb

@@ -0,0 +1,7 @@
+class AddFormolProfileToUser < ActiveRecord::Migration
+  def change
+    change_table :<%= user_class.constantize.table_name %> do |t|
+      t.string :formol_profile,   :limit => 16
+    end
+  end
+end

data/lib/formol/generators/install/templates/migrations/add_posts_count_to_user.rb.erb

@@ -0,0 +1,7 @@
+class AddPostsCountToUser < ActiveRecord::Migration
+  def change
+    change_table :<%= user_class.constantize.table_name %> do |t|
+      t.integer :formol_posts_count, :default => 0
+    end
+  end
+end

data/lib/formol/generators.rb

@@ -0,0 +1 @@
+require 'formol/generators/install/install_generator'