formol 0.0.4 → 0.0.5

data/README.md

@@ -58,14 +58,60 @@ When I would have read travis documentation, I'll test it on more platforms / db
 
 ## Installation
 
-As long as formol is in pre-alpha version, it won't be packaged as a gem.
-It should be installable as a rails plugin but I didn't try it.
+You can now install formol as a gem.
+
+To install 0.0.4 (actual gem pushed)
+
+```ruby
+#in your Gemfile
+
+gem 'formol'
+```
+
+To install 0.0.5 (actual master revision)
+
+```ruby
+#in your Gemfile
+
+gem 'formol', :git => 'https://github.com/mulasse/formol'
+```
+
+then, execute `rails g formol:install`
+
+You could have an issue saying that you're call method 'user class' on nil. That's because I load an observer in Formol::Engine.
+I have no solution against this at the moment. Every tip is welcome.
+
+Once `formol:install` has run, you should do the following things:
+
+* run `rake db:migrate`
+* add `<%= include_formol_javascripts %>` and `<%= include_formol_stylesheets %>` in the head section of your application layout
+* add `include Formol::Integration::User` in your `User` model
+* add one or more text-formatter gems into your gemfile (actually, only 'formol-markdown')
+* edit initializer file and change `config.text_formatter` if you want something else than markdown
+
+Formol expect your 'User' model to provide a method/property called `display_name`.
+If your model hasn't it already, create this method and return whatever you want (nickname, firstname + lastname ...)
+
+If you want to use syntax-highlighting, add a `stylesheet_link_tag` with `pygments/one_of_pyments_stylesheets` as param in your application layout.
+You can find all pygments stylesheets in `app/assets/pygments`. This will be improved in the future.
+
+Formol relies on jquery, jquery-ui and jquery_ujs.
+You should have them in your application.css or application layout.
+
+Without jquery-ui, sort categories / forums and change forum's categories won't be available in admin.
+
+NOTICE:
+
+0.0.4 & 0.0.5 are unstable. Almost all functionalities are tested BUT application is not complete.
+You should not use Formol in production for now.
 
 ## Features
 
 * Administration
   * categories
   * forums
+* Forums
+  * mark all topics as read
 * Topics
   * locking topics
   * viewing all topics for a forum
@@ -81,9 +127,10 @@ It should be installable as a rails plugin but I didn't try it.
   * quoting
   * display user's signature
   * RTE
+  * gravatars (based on User#email with default avatar)
+  * avatars (bringed by your own)
 * Text formatting
-  * markdown
-  * syntax highlighting
+  * markdown + syntax highlighting (gem 'formol-markdown')
 * User preferences
   * display signatures
   * display avatars
@@ -93,7 +140,27 @@ It should be installable as a rails plugin but I didn't try it.
 * Misc
   * install generator
   * gemspec
-  * basic styles
+  * basic style
+
+## Help on avatars
+
+If you provide your own system of avatar storage, you'll need to provide `avatar_url` in your User model.
+
+An example, with paperclip:
+
+```ruby
+class User < ActiveRecord::Base
+  has_attached_file :avatar, :styles => { :thumb => '100x100>' }
+
+  def avatar_url
+    avatar.url(:thumb)
+  end
+end
+```
+
+Formol works well with 100x100 avatars (according to basic style)
+
+NOTICE: formol will look first for `avatar_url`, then for `email` and then fallback to default avatar
 
 ## Preview
 
@@ -127,7 +194,6 @@ Others:
 
 ## Coming next
 
-* Mark all topics as read (actually have no scaling solution)
 * Soft delete topics (i'm not sure now since all tests failed because soft deletion doesn't trigger destroy callbacks)
 * Theme support
 * Generator (devise views)
@@ -135,8 +201,6 @@ Others:
 * Selenium tests
 * More translations (french of course and more)
 * Permissions management (by admin)
-* Gravatars
-* Avatar uploading
 
 ## Boring legal stuff
 

data/app/controllers/formol/forums_controller.rb

@@ -10,6 +10,14 @@ module Formol
       respond_with(forum)
     end
     
+    def mark_as_read
+      formol_authorize!(current_formol_user, :read_forum)
+      
+      forum.mark_as_read(current_formol_user) if current_formol_user
+      
+      respond_with(forum)
+    end
+    
     protected
     
     def forum

data/app/controllers/formol/topics_controller.rb

@@ -72,6 +72,38 @@ module Formol
       
       respond_with(topic, :location => forum)
     end
+    
+    def pin
+      formol_authorize!(current_formol_user, :pin_topic)
+      
+      topic.pin_topic!
+      
+      respond_with(topic, :location => [forum, topic])
+    end
+    
+    def unpin
+      formol_authorize!(current_formol_user, :pin_topic)
+      
+      topic.unpin_topic!
+      
+      respond_with(topic, :location => [forum, topic])
+    end
+    
+    def lock
+      formol_authorize!(current_formol_user, :lock_topic)
+      
+      topic.lock_topic!
+      
+      respond_with(topic, :location => [forum, topic])
+    end
+    
+    def unlock
+      formol_authorize!(current_formol_user, :lock_topic)
+      
+      topic.unlock_topic!
+      
+      respond_with(topic, :location => [forum, topic])
+    end
   
     protected
     

data/app/helpers/formol/forums_helper.rb

@@ -15,5 +15,9 @@ module Formol
       
       klasses.join(' ')
     end
+    
+    def display_mark_as_read?(user, forum)
+      formol_authorized?(user, :read_forum) && (user && !forum.read?(user))
+    end
   end
 end

data/app/helpers/formol/posts_helper.rb

@@ -23,5 +23,28 @@ module Formol
       
       (s && user ? user.preference.display_signatures? : s)
     end
+    
+    def avatar_for(user)
+      img = if user.respond_to?(:avatar_url) && user.avatar_url.present?
+        user.avatar_url
+      elsif user.respond_to?(:email) && user.email.present?
+        require 'digest/md5' unless defined?(Digest::MD5)
+        
+        email_h = Digest::MD5.hexdigest(user.email.to_s.strip.downcase)
+        options = { :s => 100, :d => default_avatar }
+        
+        "http://www.gravatar.com/avatar/#{email_h}?#{options.to_param}"
+      else
+        default_avatar
+      end
+      
+      image_tag(img, :alt => user.display_name)
+    end
+    
+    def default_avatar
+      img = Formol.config.default_avatar
+      
+      img && URI(img).absolute? ? img : request.protocol + request.host_with_port + path_to_image(img)
+    end
   end
 end

data/app/helpers/formol/topics_helper.rb

@@ -23,5 +23,33 @@ module Formol
       formol_authorized?(user, :vote_poll, topic) && 
       !poll.voted?(user)
     end
+    
+    def display_edit_topic?(user, topic)
+      !topic.locked? && formol_authorized?(user, :edit_topic, topic)
+    end
+    
+    def display_subscribe_topic?(user, topic)
+      !topic.locked? && formol_authorized?(user, :subscribe_topic, topic)
+    end
+    
+    def display_reply_topic?(user, topic)
+      !topic.locked? && formol_authorized?(user, :create_post, topic)
+    end
+    
+    def display_pin_topic?(user, topic)
+      !topic.locked? && !topic.pinned? && formol_authorized?(user, :pin_topic)
+    end
+    
+    def display_unpin_topic?(user, topic)
+      !topic.locked? && topic.pinned? && formol_authorized?(user, :pin_topic)
+    end
+    
+    def display_lock_topic?(user, topic)
+      !topic.locked? && formol_authorized?(user, :lock_topic)
+    end
+    
+    def display_unlock_topic?(user, topic)
+      topic.locked? && formol_authorized?(user, :lock_topic)
+    end
   end
 end

data/app/models/formol/forum.rb

@@ -73,5 +73,16 @@ module Formol
     def unregister_last_post
       update_attributes!(:last_post => posts.order('formol_posts.id').last)
     end
+    
+    # Mark all unread topics as read for a given user
+    def mark_as_read(user)
+      topics.unread(user).each do |unread|
+        unread.track_for_user!(user)
+      end
+    end
+    
+    def read?(user)
+      topics.unread(user).blank?
+    end
   end
 end

data/app/models/formol/post.rb

@@ -119,13 +119,8 @@ module Formol
       return true if quote_id.blank?
       
       q = topic.posts.find(quote_id)
-      formatter = Formol.config.formatter.new
-
-      # Extract and agnostize it
-      content_with_quote = "> **#{q.user.display_name} #{I18n.t('.wrote')}:**\n>\n"
-      content_with_quote << formatter.quote(q.content)
       
-      self.content = content_with_quote
+      self.content = Formol.config.formatter.new.quote(q.user.display_name, q.content)
       self.content << "\n\n" #use '<<' to skip normalize_attribute
       self.content
     end

data/app/models/formol/topic.rb

@@ -5,7 +5,7 @@ module Formol
     
     #Security
     attr_protected  :forum_id, :user_id, :first_post_id, :last_post_id, 
-                    :posts_count, :views_count
+                    :posts_count, :views_count, :pinned, :locked
                   
     #Virtual attributes
     attr_accessor :attach_poll
@@ -38,6 +38,8 @@ module Formol
     validates :posts,       :presence   => true
     validates :first_post,  :presence   => true
     
+    validate :validates_not_locked
+    
     #Normalization
     normalize_attribute :title, :with => [:squish, :blank]
     
@@ -80,6 +82,22 @@ module Formol
     
     #Business methods
     
+    def pin_topic!
+      update_attribute(:pinned, true)
+    end
+    
+    def unpin_topic!
+      update_attribute(:pinned, false)
+    end
+    
+    def lock_topic!
+      update_attribute(:locked, true)
+    end
+    
+    def unlock_topic!
+      update_attribute(:locked, false)
+    end
+    
     # Increments views counter
     def view!
       # Use class method instead of instance to avoid concurrence problems
@@ -181,5 +199,10 @@ module Formol
     def reject_poll_if_needed
       self.poll = nil if poll && !attach_poll
     end
+    
+    # add an error on base if topic is locked
+    def validates_not_locked
+      errors[:base] << I18n.t(:'activerecord.attributes.topic.base.locked') if locked?
+    end
   end
 end

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

@@ -10,6 +10,9 @@
     <% if formol_authorized?(current_formol_user, :create_topic) %>
       <li class="new_topic"><%= link_to t('.new'), new_forum_topic_path(@forum) %></li>
     <% end %>
+    <% if display_mark_as_read?(current_formol_user, @forum) %>
+      <li class="mark_as_read"><%= link_to t('.mark_as_read'), mark_as_read_forum_path(@forum), :method => :put %></li>
+    <% end %>
   </ul>
 
   <%= render 'formol/topics/list', :forum => @forum, :topics => @topics %>

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

@@ -12,7 +12,7 @@
       <span class="display_name"><%= post.user.display_name %></span>
       <% if display_avatars?(current_formol_user) %>
         <figure>
-          <img alt="<%= post.user.display_name %>" src="/images/emule.png" />
+          <%= avatar_for(post.user) %>
         </figure>
       <% end %>
       <span class="posts_count"><%= t('.user_posts') %>: <%= post.user.formol_posts_count %></span>

data/app/views/formol/topics/_form.html.erb

@@ -1,4 +1,5 @@
 <%= semantic_form_for [@forum, @topic] do |form| %>
+  <%= form.semantic_errors :base %>
   <%= form.inputs do %>
     <%= form.input :title %>
   <% end %>
@@ -10,10 +11,6 @@
       <%= render 'formol/polls/form', :form => poll_form, :topic => @topic %>
     <% end %>
   <% end %>
-  <%= form.inputs :name => t('.options') do %>
-    <%= form.input :pinned %>
-    <%= form.input :locked %>
-  <% end %>
   <%= form.buttons do %>
     <%= form.commit_button %>
   <% end %>

data/app/views/formol/topics/show.html.erb

@@ -4,15 +4,27 @@
   <h2><%= t('.topic') %>: <%= @topic.title %></h2>
   
   <ul class="topic_tools">
-    <% if formol_authorized?(current_formol_user, :edit_topic, @topic) %>
+    <% if display_edit_topic?(current_formol_user, @topic) %>
       <li class="edit"><%= link_to t('.edit'), edit_forum_topic_path(@forum, @topic) %></li>
     <% end %>
-    <% if formol_authorized?(current_formol_user, :subscribe_topic, @topic) %>
+    <% if display_subscribe_topic?(current_formol_user, @topic) %>
       <li class="subscribe"><%= link_to_subscription(@topic, current_formol_user) %></li>
     <% end  %>
-    <% if formol_authorized?(current_formol_user, :create_post, @topic) %>
+    <% if display_reply_topic?(current_formol_user, @topic) %>
       <li class="new_post"><%= link_to t('.new_post'), new_topic_post_path(@topic) %></li>
     <% end %>
+    <% if display_pin_topic?(current_formol_user, @topic) %>
+      <li class="pin_topic"><%= link_to t('.pin_topic'), pin_forum_topic_path(@forum, @topic), :method => :put %></li>
+    <% end %>  
+    <% if display_unpin_topic?(current_formol_user, @topic) %>
+      <li class="unpin_topic"><%= link_to t('.unpin_topic'), unpin_forum_topic_path(@forum, @topic), :method => :delete %></li>
+    <% end %>
+    <% if display_lock_topic?(current_formol_user, @topic) %>
+      <li class="lock_topic"><%= link_to t('.lock_topic'), lock_forum_topic_path(@forum, @topic), :method => :put %></li>
+    <% end %>  
+    <% if display_unlock_topic?(current_formol_user, @topic) %>
+      <li class="unlock_topic"><%= link_to t('.unlock_topic'), unlock_forum_topic_path(@forum, @topic), :method => :delete %></li>
+    <% end %>
   </ul>
   
   <% if @topic.poll %>

data/config/locales/formol/views/forums/en.yml

@@ -10,4 +10,5 @@ en:
         
       show:
         forum: forum
-        new: new topic
+        new: new topic
+        mark_as_read: mark all as read

data/config/locales/formol/views/posts/en.yml

@@ -1,6 +1,8 @@
 en:
   formol:
     posts:
+      wrote: wrote
+      
       last_post:
         go_to_last: go to last message
         by: by

data/config/locales/formol/views/topics/en.yml

@@ -7,6 +7,10 @@ en:
         edit: edit topic
         subscribe: subscribe
         unsubscribe: unsubscribe
+        pin_topic: pin
+        unpin_topic: unpin
+        lock_topic: lock
+        unlock_topic: unlock
         
       topic:
         created_by: created by

data/config/routes.rb

@@ -2,7 +2,18 @@ Formol::Engine.routes.draw do
   resources :categories, :only => [:index, :show]
   
   resources :forums, :only => [:show] do
-    resources :topics, :except => [:index]
+    member do
+      put 'mark_as_read'
+    end
+    
+    resources :topics, :except => [:index] do
+      member do
+        put 'lock'
+        put 'pin'
+        delete 'unlock'
+        delete 'unpin'
+      end
+    end
   end
   
   resources :topics do

data/lib/formol.rb

@@ -3,6 +3,9 @@ require 'formol_'
 
 module Formol
   mattr_reader    :config
+  mattr_reader    :formatters
+  
+  @@formatters = {}
   
   class << self
     def configure(&block)
@@ -29,7 +32,14 @@ module Formol
     
     # set formatter
     def set_formatter
-      config.formatter = Formol::Formatters::Redcarpet::Formatter
+      unless formatters.has_key?(config.text_formatter)
+        raise <<STR
+You have chosen an invalid text formatter (#{config.text_formatter}).
+When setting a text_formatter, don't forget to add the corresponding gem to your Gemfile.
+STR
+      end
+      
+      config.formatter = formatters[config.text_formatter]
     end
 
     # load config.yml located inside main app

data/lib/formol/config.rb

@@ -3,10 +3,15 @@ module Formol
                             :current_user_helper_method,
                             :formatter,
                             :email_from,
-                            :text_formatter)
+                            :text_formatter,
+                            :default_avatar)
 
     def user
       @user ||= user_class.constantize
     end
+    
+    def default_avatar
+      @default_avatar || 'formol/default_avatar.png'
+    end
   end
 end

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

@@ -18,4 +18,11 @@ Formol.configure do
   #
   # actually, only subscriptions send emails
   config.email_from = 'noreply@example.com'
+  
+  # Formol relies on gravatar for avatars
+  # <%= user_class %> needs to respond to 'email' method for that
+  # Formol provides a default avatar but you could not like it
+  # If you wanna change it, uncomment the following line
+  # you can set a relative path as you used it in image_tag() or an absolute path
+  # config.default_avatar = 'formol/default_avatar.png'
 end

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

@@ -8,16 +8,12 @@ module Formol
     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)
+        has_right?(:edit_topic) || 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?
+        has_right?(:edit_post) || post.user_id == user.id
       end
     end
   end

data/lib/formol/version.rb

@@ -2,7 +2,7 @@ module Formol
   module VERSION
     MAJOR = 0
     MINOR = 0
-    TINY  = 4
+    TINY  = 5
     PRE   = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')

data/lib/formol/view_helpers/assets_helper.rb

@@ -6,6 +6,12 @@ module Formol
         
         javascript_include_tag path if path.start_with?('formol')
       end
+      
+      def include_formol_stylesheets
+        path = controller.controller_path
+        
+        stylesheet_link_tag path if path.start_with?('formol')
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: formol
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-16 00:00:00.000000000Z
+date: 2012-01-17 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: formtastic
-  requirement: &85011220 !ruby/object:Gem::Requirement
+  requirement: &79556670 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *85011220
+  version_requirements: *79556670
 - !ruby/object:Gem::Dependency
   name: attribute_normalizer
-  requirement: &85010740 !ruby/object:Gem::Requirement
+  requirement: &79556380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *85010740
+  version_requirements: *79556380
 - !ruby/object:Gem::Dependency
   name: will_paginate
-  requirement: &85010170 !ruby/object:Gem::Requirement
+  requirement: &79555940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *85010170
+  version_requirements: *79555940
 - !ruby/object:Gem::Dependency
   name: ranked-model
-  requirement: &85009840 !ruby/object:Gem::Requirement
+  requirement: &79555500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *85009840
+  version_requirements: *79555500
 - !ruby/object:Gem::Dependency
   name: default_value_for
-  requirement: &84457580 !ruby/object:Gem::Requirement
+  requirement: &79555040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,29 +65,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *84457580
-- !ruby/object:Gem::Dependency
-  name: pygments.rb
-  requirement: &84457100 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: *84457100
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: &84456660 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: *84456660
+  version_requirements: *79555040
 description: Formol is a forum engine for rails 3.1. It provides most of common features
   you can wait from a forum.
 email:
@@ -96,6 +74,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- app/assets/images/formol/default_avatar.png
 - app/assets/images/formol/unread.png
 - app/assets/images/formol/read.png
 - app/assets/stylesheets/formol/topics.css.scss
@@ -310,8 +289,6 @@ files:
 - lib/formol/controllers/auth.rb
 - lib/formol/rails/engine.rb
 - lib/formol/view_helpers.rb
-- lib/formol/formatters/redcarpet/syntax_highlighter.rb
-- lib/formol/formatters/redcarpet/formatter.rb
 - lib/formol/version.rb
 - lib/formol/integration/user.rb
 - lib/formol/formatters.rb

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

@@ -1,36 +0,0 @@
-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

@@ -1,23 +0,0 @@
-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