formol 0.0.5 → 0.0.6

data/README.md

@@ -1,49 +1,6 @@
 # Formol
 
-Formol is a Rails 3.1 forum engine until Rails 3.2 is out for good.
-
-## Why an engine?
-
-Because I needed it. And because a forum is rarely a standalone app in a professional context.
-
-In a near future, formol engine will be packaged in an independent and standalone application for those who need it.
-
-## Why writing a forum in rails?
-
-Customers often ask for a forum inside their app. They think about phpBB or vBulletin like forum but it doesn't exist in rails.
-Developping one is really too expensive for a single project and:
-
-* bridge users between a phpBB and a rails app is very tricky (I just don't wanna try it).
-* phpBB / vBulletin is hard (or impossible) to embed into an application layout, especially a rails one.
-* Rails app and php forum won't share their sessions
-
-## Why don't use an existing solution?
-
-Existing solutions are:
-
-* [Beast](https://github.com/courtenay/altered_beast)
-* [Forem](https://github.com/radar/forem)
-* [Rails3-forums](https://github.com/smholloway/Rails3-forum)
-
-Beast has been inactive for 2 years. It's rails 2.2 and ruby 1.8. Don't need to say more.
-
-Rails3-forums has been inactive for 8 months. It does less than formol after 1.5 weeks of development.
-
-Forem is the most complete solution you can find in rails.
-Unfortunatly, it doesn't suit my needs.
-
-In addition, I had to "come back" to ruby (was programming Java for 1.5 year) and I've never written an engine, never used rails 3.1 for a real project.
-
-I decided then to write my own, with the best test coverage I can get (actually 99.3%).
-
-## Scaling
-
-I do my best to think about everything that could make this engine scale for devils:
-
-* every non 'eager-loadable' association (like first and last on has_many) is heavily cached with belongs_to.
-* there's counters cache everywhere
-* I'll introduce caching (or try to in any case) for very high scaling when the app is stable.
-* I use a lot of indexes
+Formol is a Rails 3.1 forum engine until Rails 3.2 is out for good. [read more...](https://github.com/mulasse/formol/wiki/00.Introducing-Formol)
 
 ## Compatibility
 
@@ -54,13 +11,11 @@ Actually, formol is only tested with following parameters:
 * Ubuntu
 * Mysql
 
-When I would have read travis documentation, I'll test it on more platforms / db / rails versions (rails 3.2, ruby 1.9.3 & jruby, postgreSQL)
-
 ## Installation
 
 You can now install formol as a gem.
 
-To install 0.0.4 (actual gem pushed)
+To install 0.0.6 (actual gem pushed)
 
 ```ruby
 #in your Gemfile
@@ -68,41 +23,13 @@ To install 0.0.4 (actual gem pushed)
 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.
+then, run `rails g formol:install` (problem with observer solved in 0.0.6)
 
-Without jquery-ui, sort categories / forums and change forum's categories won't be available in admin.
+[more...](https://github.com/mulasse/formol/wiki/02.Install-&-configure)
 
 NOTICE:
 
-0.0.4 & 0.0.5 are unstable. Almost all functionalities are tested BUT application is not complete.
+Until 1.0.0, Formol is unstable. Almost all functionalities are tested BUT application is not complete.
 You should not use Formol in production for now.
 
 ## Features
@@ -142,66 +69,12 @@ You should not use Formol in production for now.
   * gemspec
   * 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
 
 Find other screenshots in /previews
 
 ![Topic content](https://github.com/mulasse/formol/raw/master/preview/topic_show.png)
 
-## Dependencies
-
-At the moment, formol is independent from any auth system, but I still recommend [Devise](http://github.com/plataformatec/devise).
-Formol is highly coupled with will_paginate, you can't use it without will_paginate.
-
-Maybe I'll change this with something more flexible in the future.
-It's not planned for the moment because I don't know other solutions than will_paginate.
-
-Others:
-
-* JavaScript
-  * [jQuery](http://jquery.com)
-* Assets
-  * [Scss](http://sass-lang.com/)
-  * [CoffeeScript](http://coffeescript.org/)
-* Rails
-  * [Will_paginate](https://github.com/mislav/will_paginate)
-  * [Formtastic](https://github.com/justinfrench/formtastic)
-  * [Attribute normalizer](https://github.com/mdeering/attribute_normalizer)
-  * [Pygment.rb](https://github.com/tmm1/pygments.rb)
-  * [Redcarpet](https://github.com/tanoku/redcarpet)
-  * [Ranked-model](https://github.com/harvesthq/ranked-model) #=> want to abandon it for something simpler like act_as_list but for rails 3
-  * [Default_value_for](https://github.com/FooBarWidget/default_value_for)
-
-## Coming next
-
-* 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)
-* Demo app
-* Selenium tests
-* More translations (french of course and more)
-* Permissions management (by admin)
-
 ## Boring legal stuff
 
 Copyright 2011 Florian DUTEY

data/app/assets/javascripts/formol/admin/categories.js.coffee

@@ -25,6 +25,7 @@
     $('.formol_category_forums').sortable({
       connectWith: '.formol_category_forums'
       items: '> li:not(.empty)',
+      placeholder: 'ui-state-highlight',
       axis: 'y',
       receive: (event, ui) -> 
         self = $(this)

data/app/assets/javascripts/formol/posts.js.coffee

@@ -1,6 +1,4 @@
 #= require lib/jquery.prevent_double_submit
-#= require markitup/jquery.markitup.js
-#= require markitup/sets/markdown/set.js
 
 (($) ->
   $ ->

data/app/assets/javascripts/formol/topics.js.coffee

@@ -1,7 +1,5 @@
 #= require lib/jquery.prevent_double_submit
 #= require formol/subscriptions
-#= require markitup/jquery.markitup.js
-#= require markitup/sets/markdown/set.js
 
 (($) ->
   $ ->
@@ -22,33 +20,32 @@
     poll_options = $('.answers li.input')
     index = poll_options.length
     
-    if index > 0
-      $('a.add_poll_option').click ->
-        id_replacement = [/_(\d)_/, '_' + index + '_']
-        name_replacement = [/\[(\d)\]/, '[' + index + ']']
-        replacement_meth  = String.prototype.replace
-      
-        new_line  = poll_options.eq(0).clone()
-        new_id    = replacement_meth.apply(new_line.attr('id'), id_replacement)
-        
-        new_line.attr('id', new_id)
-        
-        new_line.appendTo(poll_options.parent())
-        
-        new_input = new_line.find('input')
-        
-        new_id = replacement_meth.apply(new_input.attr('id'), id_replacement)
-        new_name  = replacement_meth.apply(new_input.attr('name'), name_replacement)
-        
-        new_input.attr('id', new_id)
-        new_input.attr('name', new_name)
-        new_input.val('')
-        
-        new_label = new_line.find('label')
-        
-        new_label.attr('for', new_id)
-        
-        index += 1
-        
-        false
+    $('a.add_poll_option').click ->
+      id_replacement = [/_(\d)_/, '_' + index + '_']
+      name_replacement = [/\[(\d)\]/, '[' + index + ']']
+      replacement_meth  = String.prototype.replace
+
+      new_line  = poll_options.eq(0).clone()
+      new_id    = replacement_meth.apply(new_line.attr('id'), id_replacement)
+
+      new_line.attr('id', new_id)
+
+      new_line.insertBefore($(this).parent())
+
+      new_input = new_line.find('input')
+
+      new_id = replacement_meth.apply(new_input.attr('id'), id_replacement)
+      new_name  = replacement_meth.apply(new_input.attr('name'), name_replacement)
+
+      new_input.attr('id', new_id)
+      new_input.attr('name', new_name)
+      new_input.val('')
+
+      new_label = new_line.find('label')
+
+      new_label.attr('for', new_id)
+
+      index += 1
+
+      false
 )(jQuery)

data/app/assets/javascripts/markitup/sets/bbcode/set.js

@@ -0,0 +1,39 @@
+// ----------------------------------------------------------------------------
+// markItUp!
+// ----------------------------------------------------------------------------
+// Copyright (C) 2008 Jay Salvat
+// http://markitup.jaysalvat.com/
+// ----------------------------------------------------------------------------
+// BBCode tags example
+// http://en.wikipedia.org/wiki/Bbcode
+// ----------------------------------------------------------------------------
+// Feel free to add more tags
+// ----------------------------------------------------------------------------
+mySettings = {
+	previewParserPath:	'', // path to your BBCode parser
+	markupSet: [
+		{name:'Bold', key:'B', openWith:'[b]', closeWith:'[/b]'},
+		{name:'Italic', key:'I', openWith:'[i]', closeWith:'[/i]'},
+		{name:'Underline', key:'U', openWith:'[u]', closeWith:'[/u]'},
+		{separator:'---------------' },
+		{name:'Picture', key:'P', replaceWith:'[img][![Url]!][/img]'},
+		{name:'Link', key:'L', openWith:'[url=[![Url]!]]', closeWith:'[/url]', placeHolder:'Your text to link here...'},
+		{separator:'---------------' },
+		{name:'Size', key:'S', openWith:'[size=[![Text size]!]]', closeWith:'[/size]',
+		dropMenu :[
+			{name:'Big', openWith:'[size=200]', closeWith:'[/size]' },
+			{name:'Normal', openWith:'[size=100]', closeWith:'[/size]' },
+			{name:'Small', openWith:'[size=50]', closeWith:'[/size]' }
+		]},
+		{separator:'---------------' },
+		{name:'Bulleted list', openWith:'[list]\n', closeWith:'\n[/list]'},
+		{name:'Numeric list', openWith:'[list=[![Starting number]!]]\n', closeWith:'\n[/list]'}, 
+		{name:'List item', openWith:'[*] '},
+		{separator:'---------------' },
+		{name:'Quotes', openWith:'[quote]', closeWith:'[/quote]'},
+		{name:'Code', openWith:'[code=[![Language]!]]', closeWith:'[/code]'}, 
+		{separator:'---------------' },
+		{name:'Clean', className:"clean", replaceWith:function(markitup) { return markitup.selection.replace(/\[(.*?)\]/g, "") } }//,
+		//{name:'Preview', className:"preview", call:'preview' }
+	]
+}

data/app/assets/javascripts/markitup/sets/markdown/set.js

@@ -34,9 +34,9 @@ mySettings = {
 		{separator:'---------------'},	
 		{name:'Quotes', openWith:'> '},
 		{name:'Code Block', openBlockWith:'```[![Language]!]\n', closeBlockWith:'\n```', multiline: false },
-                {name:'Code', openWith: '`', closeWith: '`' },
-		{separator:'---------------'},
-		{name:'Preview', call:'preview', className:"preview"}
+                {name:'Code', openWith: '`', closeWith: '`' }//,
+		//{separator:'---------------'},
+		//{name:'Preview', call:'preview', className:"preview"}
 	]
 }
 

data/app/assets/stylesheets/formol/admin.css.scss

@@ -0,0 +1,146 @@
+ul, ol {
+  list-style-type: none;
+  padding: 0;
+}
+
+.categories_tools {
+  li {
+    display: inline-block;
+    font-family: Arial, Helvetica, sans-serif;
+    font-size: 14px;
+    padding: 7px 10px;
+    background: -moz-linear-gradient(
+            top,
+            #ffffff 0%,
+            #b5b5b5);
+    background: -webkit-gradient(
+            linear, left top, left bottom, 
+            from(#ffffff),
+            to(#b5b5b5));
+    border-radius: 5px;
+    -moz-border-radius: 5px;
+    -webkit-border-radius: 5px;
+    border: 1px solid #949494;
+    -moz-box-shadow:
+            0px 1px 3px rgba(000,000,000,0.5),
+            inset 0px 0px 2px rgba(255,255,255,1);
+    -webkit-box-shadow:
+            0px 1px 3px rgba(000,000,000,0.5),
+            inset 0px 0px 2px rgba(255,255,255,1);
+    text-shadow:
+            0px -1px 0px rgba(000,000,000,0.2),
+            0px 1px 0px rgba(255,255,255,1);
+
+    &:first-letter {
+      text-transform: capitalize;
+    }
+            
+    a {
+      color: #050505;
+      text-decoration: none;
+    }
+    
+    &.new a {
+      padding-left: 20px;
+      background: transparent url(icons/add.png) no-repeat scroll left top;
+    }
+  }  
+}
+
+.formol_categories {
+  width: 700px;
+
+  .formol_category > .label {
+    cursor: move;
+    background-color: #FFFBD3;
+    border-left: 3px solid yellow;
+    padding: 3px 6px;
+  }
+  
+  li {
+    position: relative;
+  }
+  
+  .actions {
+    display: none;
+    position: absolute;
+    right: 5px;
+    top: 5px;
+    z-index: 100;
+    padding: 0;
+
+    li {
+      display: inline-block;
+      height: 16px;
+      
+      a {
+        float: left;
+        height: 16px;
+        width: 16px;
+        background-attachment: scroll;
+        background-color: transparent;
+        background-repeat: no-repeat;
+        background-position: top left;
+        color: transparent;
+        font-size: 0;
+      }
+      
+      &.edit {
+        background-image: url(icons/page_white_edit.png);
+      }
+      
+      &.destroy a {
+        background-image: url(icons/delete.png);
+      }
+      
+      &.new_forum a {
+        background-image: url(icons/application_add.png);
+      }
+    }
+  }
+  
+  .label:hover,
+  .formol_forum:hover {
+    .actions {
+      display: inline-block;
+    }
+  }
+      
+  .formol_category_forums {
+    padding: 5px 10px;
+    padding-right: 0;
+    
+    .ui-state-highlight {
+      height: 1.5em;
+      border: 1px dashed orange;
+      visibility: visible;
+      background-color: #ffee96;
+    }
+    
+    .empty {
+      text-align: center;
+      background-color: #eee;
+      color: #aaa;
+      border-left: 3px solid #aaa;
+      border-bottom: 1px solid #aaa;
+    }
+    
+    .formol_forum {
+      background-color: #dbffb4;
+      border-left: 4px solid #65C400;
+      border-bottom: 1px solid #65C400;
+      padding: 3px;
+      margin: 2px 0;
+      cursor: move;
+      
+      > div {
+        display: inline-block;
+      }
+      
+      .description {
+        color: #aaa;
+        font-style: italic;
+      }
+    }
+  }
+}

data/app/assets/stylesheets/formol/posts.css.scss

@@ -1,5 +1,3 @@
-//= require markitup/skins/simple/style
-//= require markitup/sets/markdown/style
 //= require formol/partials/posts/post
 //= require formol/partials/breadcrumb
 

data/app/assets/stylesheets/formol/topics.css.scss

@@ -2,8 +2,7 @@
 //= require formol/partials/posts/post
 //= require formol/partials/breadcrumb
 //= require formol/partials/polls/poll
-//= require "markitup/skins/simple/style"
-//= require "markitup/sets/markdown/style"
+
 
 h2 {
   &:first-letter {

data/app/assets/stylesheets/markitup/sets/bbcode/style.css

@@ -0,0 +1,47 @@
+/* -------------------------------------------------------------------
+// markItUp!
+// By Jay Salvat - http://markitup.jaysalvat.com/
+// ------------------------------------------------------------------*/
+.markItUp .markItUpButton1 a	{
+	background-image:url(images/bold.png);
+}
+.markItUp .markItUpButton2 a	{
+	background-image:url(images/italic.png);
+}
+.markItUp .markItUpButton3 a	{
+	background-image:url(images/underline.png);
+}
+
+.markItUp .markItUpButton4 a	{
+	background-image:url(images/picture.png);
+}
+.markItUp .markItUpButton5 a	{
+	background-image:url(images/link.png);
+}
+
+.markItUp .markItUpButton6 a	{
+	background-image:url(images/fonts.png);
+}
+.markItUp .markItUpButton7 a	{
+	background-image:url(images/list-bullet.png);
+}
+.markItUp .markItUpButton8 a	{
+	background-image:url(images/list-numeric.png);
+}
+.markItUp .markItUpButton9 a	{
+	background-image:url(images/list-item.png);
+}
+
+.markItUp .markItUpButton10 a	{
+	background-image:url(images/quotes.png);
+}
+.markItUp .markItUpButton11 a	{
+	background-image:url(images/code.png);
+}
+	
+.markItUp .clean a {
+	background-image:url(images/clean.png);
+}
+.markItUp .preview a {
+	background-image:url(images/preview.png);
+}

data/app/models/formol/post_observer.rb

@@ -1,5 +1,9 @@
 module Formol
   class PostObserver < ActiveRecord::Observer
+    def self.instance
+      super if Formol.config && Formol.config.user_class
+    end
+    
     def after_create(post)
       post.topic.subscribers.each do |subscriber|
         SubscriptionMailer.topic_reply(post, subscriber).deliver

data/app/views/formol/admin/categories/_category.html.erb

@@ -1,9 +1,17 @@
 <%= content_tag_for(:li, category) do %>
-  <%= category.label %>
-  <%= link_to t('.new_forum'), new_admin_category_forum_path(category) %>
-  <%= link_to t('.edit'), edit_admin_category_path(category) %>
-  <%= link_to t('.destroy'), [:admin, category], :method => :delete %>
+  <div class="label">
+    <%= category.label %>
+    <ul class="actions">
+      <li class="new_forum"><%= link_to t('.new_forum'), new_admin_category_forum_path(category) %></li>
+      <li class="edit"><%= link_to t('.edit'), edit_admin_category_path(category) %></li>
+      <li class="destroy"><%= link_to t('.destroy'), [:admin, category], :method => :delete %></li>
+    </ul>
+  </div>
   <ol class="formol_category_forums" id="formol_category_<%= category.id %>_forums">
-    <%= render category.forums, :category => category %>
+    <% if category.forums.blank? %>
+      <li class="empty">no forums</li>
+    <% else %>
+      <%= render category.forums, :category => category %>
+    <% end %>
   </ol>
 <% end %>

data/app/views/formol/admin/categories/index.html.erb

@@ -1,3 +1,7 @@
+<ul class="categories_tools">
+  <li class="new"><%= link_to t('.new'), new_admin_category_path %></li>
+</ul>
+
 <ol class="formol_categories">
   <%= render @categories %>
 </ol>

data/app/views/formol/admin/forums/_forum.html.erb

@@ -6,7 +6,7 @@
     <%= forum.description %>
   </div>
   <ul class="actions">
-    <li><%= link_to t('.edit_forum'), edit_admin_category_forum_path(category, forum) %></li>
-    <li><%= link_to t('.destroy_forum'), admin_category_forum_path(category, forum), :method => :delete %></li>
+    <li class="edit"><%= link_to t('.edit_forum'), edit_admin_category_forum_path(category, forum) %></li>
+    <li class="destroy"><%= link_to t('.destroy_forum'), admin_category_forum_path(category, forum), :method => :delete %></li>
   </ul>
 <% end %>

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

@@ -3,12 +3,10 @@
   <%= form.input :duration %>
   <%= form.input :max_options %>
 
-  <li class="answers">
-    <%= form.inputs :name => t('.answers'), :class => 'inputs answers' do %>
-      <%= form.semantic_fields_for :options do |option_form| %>
-        <%= render 'formol/poll/options/form', :form => option_form %>
-      <% end %>
+  <%= form.inputs :name => t('.answers'), :class => 'inputs answers' do %>
+    <%= form.semantic_fields_for :options do |option_form| %>
+      <%= render 'formol/poll/options/form', :form => option_form %>
     <% end %>
-    <a href="#" class="add_poll_option">[+]</a>
-  </li>
+    <li class="helpers_add"><%= link_to '[+]', '#', :class => 'add_poll_option', :title => t('.add_poll_options') %></li>
+  <% end %>
 <% end %>

data/config/locales/formol/views/admin/categories/en.yml

@@ -0,0 +1,11 @@
+en:
+  formol:
+    admin:
+      categories:
+        index:
+          new: new category
+        
+        category:
+          new_forum: new forum
+          edit: edit
+          destroy: destroy

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

@@ -0,0 +1,7 @@
+en:
+  formol:
+    admin:
+      forums:
+        forum:
+          edit_forum: edit
+          destroy_forum: destroy

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

@@ -2,4 +2,9 @@ en:
   formol:
     polls:
       poll:
-        vote: vote
+        vote: vote
+        
+      form:
+        attach_poll: attach poll
+        answers: available answers
+        add_poll_options: add one more poll option

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

@@ -24,4 +24,5 @@ en:
       list:
         topics: topics
         posts: posts
-        last_post: last post
+        last_post: last post
+        views: views

data/lib/formol.rb

@@ -2,13 +2,16 @@
 require 'formol_'
 
 module Formol
-  mattr_reader    :config
-  mattr_reader    :formatters
+  mattr_reader  :config
+  mattr_reader  :formatters
+  mattr_reader  :pygment_stylesheets
   
   @@formatters = {}
   
   class << self
     def configure(&block)
+      load_pygment_stylesheets
+      
       @@config = Config.new
 
       class_eval &block
@@ -21,6 +24,15 @@ module Formol
 
     private
     
+    # load pygment stylesheets
+    def load_pygment_stylesheets
+      assets_stylesheets = File.join(File.expand_path('../../app/assets/stylesheets/pygments', __FILE__), '**', '*.css')
+      
+      @@pygment_stylesheets = Dir[assets_stylesheets].collect do |s|
+        s.split('/').last.split('.css').first.to_sym
+      end
+    end
+    
     # load formol libs located inside main app
     def load_formol_libs
       Dir[Rails.root.join('lib', 'formol', '**', '*.rb')].each do |f|
@@ -64,6 +76,10 @@ end
 
 require 'formol/engine'
 
+# here and not in 'formol_.rb' because it requires Formol module to have @@formatters
+require 'formol-markdown'
+require 'formol-bbcode'
+
 ActionController::Base.send(:include, Formol::Controllers::Auth)
 ActionController::Base.send(:include, Formol::Permissions::Controllers)
 

data/lib/formol/config.rb

@@ -4,7 +4,8 @@ module Formol
                             :formatter,
                             :email_from,
                             :text_formatter,
-                            :default_avatar)
+                            :default_avatar,
+                            :default_pygment_theme)
 
     def user
       @user ||= user_class.constantize
@@ -13,5 +14,15 @@ module Formol
     def default_avatar
       @default_avatar || 'formol/default_avatar.png'
     end
+    
+    def default_pygment_theme
+      @default_pygment_theme || :pastie
+    end
+    
+    def default_pygment_theme=(theme)
+      raise "pygments theme '#{theme}' does not exists. Please provide one of the following list:\n#{Formol.pygment_stylesheets.join(', ')}" unless Formol.pygment_stylesheets.include?(theme.to_sym)
+      
+      @default_pygment_theme = theme
+    end
   end
 end

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

@@ -61,11 +61,13 @@ You can access it with http://yourhost/forums
 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_javascripts %>' and '<%= include_formol_stylesheets %>' 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'.
 
+By default, Formol will use markdown as text formatting language. You can change it in 'config/initializer/formol.rb' (other option is :bbcode)
+
 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
 

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

@@ -8,9 +8,7 @@ Formol.configure do
   # 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
+  # choose what text formatter you need (:bbcode or :markdown)
   config.text_formatter = :markdown
   
   # you need to provide an email adress wich will be used as sender adress in all
@@ -25,4 +23,9 @@ Formol.configure do
   # 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'
+  
+  # change default pygment theme (syntax highlighting)
+  # if you don't provide a pygment_theme, :pastie will be used as default
+  # you can choose one in [:autumn, :borland, :bw, :colorful, :default, :emacs, :friendly, :fruity, :manni, :murphy, :native, :pastie, :perldoc, :tango, :trac, :vim, :vs]
+  # config.default_pygment_theme = :pastie
 end

data/lib/formol/version.rb

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

data/lib/formol/view_helpers/assets_helper.rb

@@ -3,14 +3,31 @@ module Formol
     module AssetsHelper
       def include_formol_javascripts
         path = controller.controller_path
+      
+        return unless path.start_with?('formol')
+        
+        js_files = []
+        
+        js_files << "markitup/jquery.markitup.js"
+        js_files << "markitup/sets/#{Formol.config.text_formatter}/set.js"
+        js_files << path
         
-        javascript_include_tag path if path.start_with?('formol')
+        js_files.collect{ |j| javascript_include_tag j }.join("\n").html_safe
       end
       
       def include_formol_stylesheets
         path = controller.controller_path
         
-        stylesheet_link_tag path if path.start_with?('formol')
+        return unless path.start_with?('formol')
+        
+        stylesheets = []
+        
+        stylesheets << "pygments/#{Formol.config.default_pygment_theme}"
+        stylesheets << "markitup/skins/simple/style"
+        stylesheets << "markitup/sets/#{Formol.config.text_formatter}/style"
+        stylesheets << (path.start_with?('formol/admin') ? "formol/admin" : path)
+        
+        stylesheets.collect{ |s| stylesheet_link_tag s }.join("\n").html_safe
       end
     end
   end

data/lib/formol_.rb

@@ -4,10 +4,8 @@ require 'attribute_normalizer'
 require 'will_paginate'
 require 'ranked-model'
 require 'default_value_for'
-require 'pygments.rb'
-require 'redcarpet'
 
 #libs
 %w(config controllers formatters generators integration permissions rails view_helpers will_paginate).each do |lib|
   require "formol/#{lib}"
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: formol
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-17 00:00:00.000000000Z
+date: 2012-01-19 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: formtastic
-  requirement: &79556670 !ruby/object:Gem::Requirement
+  requirement: &74971140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *79556670
+  version_requirements: *74971140
 - !ruby/object:Gem::Dependency
   name: attribute_normalizer
-  requirement: &79556380 !ruby/object:Gem::Requirement
+  requirement: &74967900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *79556380
+  version_requirements: *74967900
 - !ruby/object:Gem::Dependency
   name: will_paginate
-  requirement: &79555940 !ruby/object:Gem::Requirement
+  requirement: &74960560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *79555940
+  version_requirements: *74960560
 - !ruby/object:Gem::Dependency
   name: ranked-model
-  requirement: &79555500 !ruby/object:Gem::Requirement
+  requirement: &74958950 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *79555500
+  version_requirements: *74958950
 - !ruby/object:Gem::Dependency
   name: default_value_for
-  requirement: &79555040 !ruby/object:Gem::Requirement
+  requirement: &74956910 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,29 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *79555040
+  version_requirements: *74956910
+- !ruby/object:Gem::Dependency
+  name: formol-markdown
+  requirement: &74955210 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *74955210
+- !ruby/object:Gem::Dependency
+  name: formol-bbcode
+  requirement: &74954420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *74954420
 description: Formol is a forum engine for rails 3.1. It provides most of common features
   you can wait from a forum.
 email:
@@ -77,6 +99,10 @@ files:
 - app/assets/images/formol/default_avatar.png
 - app/assets/images/formol/unread.png
 - app/assets/images/formol/read.png
+- app/assets/images/formol/icons/add.png
+- app/assets/images/formol/icons/application_add.png
+- app/assets/images/formol/icons/page_white_edit.png
+- app/assets/images/formol/icons/delete.png
 - app/assets/stylesheets/formol/topics.css.scss
 - app/assets/stylesheets/formol/categories.css.scss
 - app/assets/stylesheets/formol/forums.css.scss
@@ -89,6 +115,7 @@ files:
 - app/assets/stylesheets/formol/partials/posts/post.css.scss
 - app/assets/stylesheets/formol/partials/polls/poll.css.scss
 - app/assets/stylesheets/formol/partials/breadcrumb.css.scss
+- app/assets/stylesheets/formol/admin.css.scss
 - app/assets/stylesheets/formol/mixins/after_clear.css.scss
 - app/assets/stylesheets/formol/development.css
 - app/assets/stylesheets/markitup/skins/markitup/images/bg-editor-markdown.png
@@ -109,6 +136,21 @@ files:
 - app/assets/stylesheets/markitup/skins/simple/images/submenu.png
 - app/assets/stylesheets/markitup/skins/simple/images/menu.png
 - app/assets/stylesheets/markitup/skins/simple/style.css
+- app/assets/stylesheets/markitup/sets/bbcode/images/clean.png
+- app/assets/stylesheets/markitup/sets/bbcode/images/list-bullet.png
+- app/assets/stylesheets/markitup/sets/bbcode/images/quotes.png
+- app/assets/stylesheets/markitup/sets/bbcode/images/italic.png
+- app/assets/stylesheets/markitup/sets/bbcode/images/stroke.png
+- app/assets/stylesheets/markitup/sets/bbcode/images/fonts.png
+- app/assets/stylesheets/markitup/sets/bbcode/images/preview.png
+- app/assets/stylesheets/markitup/sets/bbcode/images/list-numeric.png
+- app/assets/stylesheets/markitup/sets/bbcode/images/underline.png
+- app/assets/stylesheets/markitup/sets/bbcode/images/picture.png
+- app/assets/stylesheets/markitup/sets/bbcode/images/code.png
+- app/assets/stylesheets/markitup/sets/bbcode/images/link.png
+- app/assets/stylesheets/markitup/sets/bbcode/images/list-item.png
+- app/assets/stylesheets/markitup/sets/bbcode/images/bold.png
+- app/assets/stylesheets/markitup/sets/bbcode/style.css
 - app/assets/stylesheets/markitup/sets/markdown/images/h4.png
 - app/assets/stylesheets/markitup/sets/markdown/images/list-bullet.png
 - app/assets/stylesheets/markitup/sets/markdown/images/quotes.png
@@ -155,6 +197,7 @@ files:
 - app/assets/javascripts/formol/topics.js.coffee
 - app/assets/javascripts/formol/preferences.js
 - app/assets/javascripts/markitup/jquery.markitup.js
+- app/assets/javascripts/markitup/sets/bbcode/set.js
 - app/assets/javascripts/markitup/sets/markdown/set.js
 - app/assets/javascripts/lib/jquery.prevent_double_submit.js.coffee
 - app/mailers/formol/subscription_mailer.rb
@@ -232,6 +275,8 @@ files:
 - config/locales/formol/views/topics/fr.yml
 - config/locales/formol/views/posts/en.yml
 - config/locales/formol/views/posts/fr.yml
+- config/locales/formol/views/admin/forums/en.yml
+- config/locales/formol/views/admin/categories/en.yml
 - config/locales/formol/views/polls/en.yml.yml
 - config/locales/formol/views/poll_votes/en.yml
 - config/locales/en.yml