parchemin 1.0.0 → 1.1.0

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/bin/articles/azerty.markdown

@@ -0,0 +1,7 @@
+<!-- title : "Cillum facilisis" -->
+<!-- created_at : Date.civil(2010, 3, 26) -->
+<!-- abstract : "Cillum facilisis metus turpis wisi interdum rutrum, pharetra aenean feugiat velit facilisi penatibus deserunt nonummy praesent blandit. Quisque augue adipiscing penatibus sociosqu eros torquent curabitur, vel praesent consequat aliquet sapien quam adipisicing. A dolore elit luctus scelerisque suspendisse pretium, commodo fringilla mus tellus nulla mollis suspendisse justo enim tempor congue cursus mus." -->
+<!-- tags : %w(editorial rails) -->
+Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+Cillum facilisis metus turpis wisi interdum rutrum, pharetra aenean feugiat velit facilisi penatibus deserunt nonummy praesent blandit. Quisque augue adipiscing penatibus sociosqu eros torquent curabitur, vel praesent consequat aliquet sapien quam adipisicing. A dolore elit luctus scelerisque suspendisse pretium, commodo fringilla mus tellus nulla mollis suspendisse justo enim tempor congue cursus mus.

data/bin/articles/curae.markdown

@@ -0,0 +1,15 @@
+<!-- title : "Curae molestie ullamco felis" -->
+<!-- created_at : Date.civil(2010, 3, 10) -->
+<!-- abstract : "Curae molestie ullamco felis proin tempor proident, nostra rutrum vitae varius in sapien. Facilisis nullam nam consectetuer netus blandit laboris nonummy nam dolor et, gravida ea ex volutpat non lectus imperdiet nascetur stevirota sociis. Fames velit nunc cupidatat viverra, imperdiet magnis nullam adipiscing imperdiet mi morbi. Vivamus nascetur litora dictumst ad proident facilisi, nullam eros ligula blandit elementum fugiat mollis leo semper. Incididunt etiam interdum eiusmod dolore non lobortis dictum magna odio est, suspendisse laoreet ex sint volutpat bibendum hac reprehenderit." -->
+<!-- tags : %w(tutorial rdiscount) -->
+Curae molestie ullamco felis proin tempor proident, nostra rutrum vitae varius in sapien. Facilisis nullam nam consectetuer netus blandit laboris nonummy nam dolor et, gravida ea ex volutpat non lectus imperdiet nascetur stevirota sociis. Fames velit nunc cupidatat viverra, imperdiet magnis nullam adipiscing imperdiet mi morbi. Vivamus nascetur litora dictumst ad proident facilisi, nullam eros ligula blandit elementum fugiat mollis leo semper. Incididunt etiam interdum eiusmod dolore non lobortis dictum magna odio est, suspendisse laoreet ex sint volutpat bibendum hac reprehenderit.
+
+Adipisicing tellus in wisi culpa aliquam hymenaeos facilisi commodo faucibus potenti quisque sit, vel penatibus dignissim aliquet cras justo non mollis aliquam. Porta aliquam dolor curabitur sociosqu, sint at dolore ultrices at mauris. Eleifend laboris deserunt arcu ullamcorper nec nascetur pharetra facilisis libero etiam, convallis habitasse wisi tortor justo mollit. Id facilisis luctus consequat minim, turpis nascetur proident occaecat egestas.
+
+Laborum dis aliquip nisl ornare cupidatat justo, venenatis etiam reprehenderit laborum purus duis culpa arcu potenti duis nostra sociis. Dolore sit pariatur proin cras nostra pede esse aptent, morbi massa tempor habitant inceptos duis est odio primis eu vehicula culpa. Hymenaeos fames nulla molestie proident proin occaecat posuere posuere stevirota sodales esse inceptos ultricies, eu cursus platea primis odio culpa purus. Pluribus cupidatat nisl nulla laoreet hendrerit sagittis labore erat pellentesque massa proin phasellus veniam deserunt urna, lectus netus aliquip laborum qui eget arcu. Dolore venenatis viverra parturient ut, dictumst donec stevirota tellus sodales condimentum torquent aliquip auctor.
+
+Nam in voluptate nam tempus fugiat sit arcu sit fugiat, auctor euismod aptent volutpat ut nunc culpa bibendum. Fermentum consectetuer potenti aute rutrum bibendum, eget blandit inceptos faucibus reprehenderit aliquet dictumst qui consectetur vivamus laoreet luctus. Fermentum class donec vivamus molestie velit wisi varius ligula, convallis interdum proin venenatis dapibus stevirota. Pariatur tortor do ante conubia molestie dignissim, libero do eget malesuada pede laboris ligula parturient venenatis leo ac praesent mus magnis potenti litora. Penatibus porttitor nonummy vulputate nibh curae id fusce penatibus, fusce nibh enim do.
+
+Eu hac auctor donec proin blandit class consequat fringilla pede tristique tincidunt phasellus, voluptate risus aptent leo dolor nam phasellus porta adipiscing leo nec nec. Luctus incididunt sociis aliqua ullamco magnis nam facilisi, vivamus ante tempor tempus gravida pellentesque voluptate cursus. Amet fusce qui habitant parturient tempus malesuada at, blandit unum iaculis ullamcorper nisi.
+
+Praesent justo scelerisque convallis quam feugiat, ornare mattis curabitur hendrerit nostra nisi wisi nostrud hac nullam ac gravida litora dui incididunt lectus. Leo ligula pellentesque aenean fringilla cupidatat rhoncus minim conubia fermentum, stevirota do a curabitur. At vehicula officia cupidatat odio dis per feugiat labore mollis officia consequat maecenas sociis pharetra, etiam enim tellus accumsan enim deserunt sem ante velit. Varius adipiscing laborum augue fusce, lectus nascetur pharetra quam pluribus tristique rutrum. Elit augue volutpat cursus metus semper, felis aliqua euismod ac magnis morbi. Cupidatat qui neque blandit torquent dolore elit litora nullam condimentum accumsan hymenaeos ligula, iaculis ligula mattis diam vestibulum lectus hendrerit occaecat dictumst sint.

data/bin/articles/lorem.markdown

@@ -0,0 +1,11 @@
+<!-- title : "Lorem ipsum" -->
+<!-- created_at : Date.civil(2010, 3, 23) -->
+<!-- abstract : "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum." -->
+<!-- tags : %w(news sinatra) -->
+Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+Curae molestie ullamco felis proin tempor proident, nostra rutrum vitae varius in sapien. Facilisis nullam nam consectetuer netus blandit laboris nonummy nam dolor et, gravida ea ex volutpat non lectus imperdiet nascetur stevirota sociis. Fames velit nunc cupidatat viverra, imperdiet magnis nullam adipiscing imperdiet mi morbi. Vivamus nascetur litora dictumst ad proident facilisi, nullam eros ligula blandit elementum fugiat mollis leo semper. Incididunt etiam interdum eiusmod dolore non lobortis dictum magna odio est, suspendisse laoreet ex sint volutpat bibendum hac reprehenderit.
+
+Adipisicing tellus in wisi culpa aliquam hymenaeos facilisi commodo faucibus potenti quisque sit, vel penatibus dignissim aliquet cras justo non mollis aliquam. Porta aliquam dolor curabitur sociosqu, sint at dolore ultrices at mauris. Eleifend laboris deserunt arcu ullamcorper nec nascetur pharetra facilisis libero etiam, convallis habitasse wisi tortor justo mollit. Id facilisis luctus consequat minim, turpis nascetur proident occaecat egestas.
+
+Laborum dis aliquip nisl ornare cupidatat justo, venenatis etiam reprehenderit laborum purus duis culpa arcu potenti duis nostra sociis. Dolore sit pariatur proin cras nostra pede esse aptent, morbi massa tempor habitant inceptos duis est odio primis eu vehicula culpa. Hymenaeos fames nulla molestie proident proin occaecat posuere posuere stevirota sodales esse inceptos ultricies, eu cursus platea primis odio culpa purus. Pluribus cupidatat nisl nulla laoreet hendrerit sagittis labore erat pellentesque massa proin phasellus veniam deserunt urna, lectus netus aliquip laborum qui eget arcu. Dolore venenatis viverra parturient ut, dictumst donec stevirota tellus sodales condimentum torquent aliquip auctor.

data/bin/articles/tellus.markdown

@@ -0,0 +1,13 @@
+<!-- title : "Adipisicing tellus in wisi culpa" -->
+<!-- created_at : Date.civil(2010, 2, 2) -->
+<!-- abstract : "Adipisicing tellus in wisi culpa aliquam hymenaeos facilisi commodo faucibus potenti quisque sit, vel penatibus dignissim aliquet cras justo non mollis aliquam. Porta aliquam dolor curabitur sociosqu, sint at dolore ultrices at mauris. Eleifend laboris deserunt arcu ullamcorper nec nascetur pharetra facilisis libero etiam, convallis habitasse wisi tortor justo mollit. Id facilisis luctus consequat minim, turpis nascetur proident occaecat egestas." -->
+<!-- tags : %w(tutorial haml) -->
+Adipisicing tellus in wisi culpa aliquam hymenaeos facilisi commodo faucibus potenti quisque sit, vel penatibus dignissim aliquet cras justo non mollis aliquam. Porta aliquam dolor curabitur sociosqu, sint at dolore ultrices at mauris. Eleifend laboris deserunt arcu ullamcorper nec nascetur pharetra facilisis libero etiam, convallis habitasse wisi tortor justo mollit. Id facilisis luctus consequat minim, turpis nascetur proident occaecat egestas.
+
+Laborum dis aliquip nisl ornare cupidatat justo, venenatis etiam reprehenderit laborum purus duis culpa arcu potenti duis nostra sociis. Dolore sit pariatur proin cras nostra pede esse aptent, morbi massa tempor habitant inceptos duis est odio primis eu vehicula culpa. Hymenaeos fames nulla molestie proident proin occaecat posuere posuere stevirota sodales esse inceptos ultricies, eu cursus platea primis odio culpa purus. Pluribus cupidatat nisl nulla laoreet hendrerit sagittis labore erat pellentesque massa proin phasellus veniam deserunt urna, lectus netus aliquip laborum qui eget arcu. Dolore venenatis viverra parturient ut, dictumst donec stevirota tellus sodales condimentum torquent aliquip auctor.
+
+Nam in voluptate nam tempus fugiat sit arcu sit fugiat, auctor euismod aptent volutpat ut nunc culpa bibendum. Fermentum consectetuer potenti aute rutrum bibendum, eget blandit inceptos faucibus reprehenderit aliquet dictumst qui consectetur vivamus laoreet luctus. Fermentum class donec vivamus molestie velit wisi varius ligula, convallis interdum proin venenatis dapibus stevirota. Pariatur tortor do ante conubia molestie dignissim, libero do eget malesuada pede laboris ligula parturient venenatis leo ac praesent mus magnis potenti litora. Penatibus porttitor nonummy vulputate nibh curae id fusce penatibus, fusce nibh enim do.
+
+Eu hac auctor donec proin blandit class consequat fringilla pede tristique tincidunt phasellus, voluptate risus aptent leo dolor nam phasellus porta adipiscing leo nec nec. Luctus incididunt sociis aliqua ullamco magnis nam facilisi, vivamus ante tempor tempus gravida pellentesque voluptate cursus. Amet fusce qui habitant parturient tempus malesuada at, blandit unum iaculis ullamcorper nisi.
+
+Praesent justo scelerisque convallis quam feugiat, ornare mattis curabitur hendrerit nostra nisi wisi nostrud hac nullam ac gravida litora dui incididunt lectus. Leo ligula pellentesque aenean fringilla cupidatat rhoncus minim conubia fermentum, stevirota do a curabitur. At vehicula officia cupidatat odio dis per feugiat labore mollis officia consequat maecenas sociis pharetra, etiam enim tellus accumsan enim deserunt sem ante velit. Varius adipiscing laborum augue fusce, lectus nascetur pharetra quam pluribus tristique rutrum. Elit augue volutpat cursus metus semper, felis aliqua euismod ac magnis morbi. Cupidatat qui neque blandit torquent dolore elit litora nullam condimentum accumsan hymenaeos ligula, iaculis ligula mattis diam vestibulum lectus hendrerit occaecat dictumst sint.

data/bin/parchemin

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 
-require 'haml'
-require 'fileutils'
+require File.join(File.dirname(__FILE__), "../lib/parchemin/utils")
 
 #############################################
 # create the parchemin-based blog directory #
@@ -16,18 +15,13 @@ end
 blog_name = ARGV[0]
 author_name = ARGV[1]
 
-# Create the directory structure
-Dir.mkdir(blog_name)
-Dir.mkdir("#{blog_name}/articles")
-Dir.mkdir("#{blog_name}/statics")
-
-# create the statics
-FileUtils.cp File.join(File.dirname(__FILE__), "templates/about.markdown"), "#{blog_name}/statics/about.markdown"
-FileUtils.cp File.join(File.dirname(__FILE__), "templates/abstract.markdown"), "#{blog_name}/statics/abstract.markdown"
+Parchemin::Utils.mkdir("#{blog_name}/articles")
+%w(assets statics views).each do |dir|
+  Parchemin::Utils.cpdir(File.expand_path(File.join(File.dirname(__FILE__), dir)), blog_name)
+end
 
 # Create the rack file
 template = File.read(File.join(File.dirname(__FILE__), "templates/config.ru.haml"))
-haml_engine = Haml::Engine.new(template)
 File.open("#{blog_name}/config.ru", 'w') do |f|
-  f.write(haml_engine.render(Object.new, :blog_name => blog_name, :author_name => author_name, :dirname => `pwd`))
+  f.write Parchemin::Utils.render(template, :blog_name => blog_name, :author_name => author_name, :dirname => `pwd`)
 end

data/bin/{templates → statics}/about.markdown

@@ -1,3 +1,5 @@
+# A propos #
+
 Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
 
 Curae molestie ullamco felis proin tempor proident, nostra rutrum vitae varius in sapien. Facilisis nullam nam consectetuer netus blandit laboris nonummy nam dolor et, gravida ea ex volutpat non lectus imperdiet nascetur stevirota sociis. Fames velit nunc cupidatat viverra, imperdiet magnis nullam adipiscing imperdiet mi morbi. Vivamus nascetur litora dictumst ad proident facilisi, nullam eros ligula blandit elementum fugiat mollis leo semper. Incididunt etiam interdum eiusmod dolore non lobortis dictum magna odio est, suspendisse laoreet ex sint volutpat bibendum hac reprehenderit.

data/bin/templates/config.ru.haml

@@ -3,7 +3,7 @@ require 'parchemin'
 Parchemin::Config.blog_name = "#{blog_name}"
 Parchemin::Config.author_name = "#{author_name}"
 Parchemin::Config.host = "www.#{blog_name}.com"
-Parchemin::Config.project_path = "#{dirname.strip}/#{blog_name}"
+Parchemin::Config.root_path = "#{dirname.strip}/#{blog_name}"
 Parchemin::Config.db_name = "#{blog_name}"
 
 run Parchemin::Application

data/{app → bin}/views/_base.sass

@@ -83,6 +83,7 @@ body
   +sans-family
   color: $font_color
   line-height: 1.5em
+  font-size: 0.9em
 
 /* @group links */
 

data/{app → bin}/views/layout.sass

@@ -30,15 +30,14 @@ body
   color: $font_color
 
 #header
-  +columns(11)
-  +prefix(1)
+  +columns(12)
   +full
   +title-family
   margin-bottom: 2em
   margin-top: 2em
   
   .brand
-    font-size: 4em
+    font-size: 3em
     font-weight: bold
     a
       &:hover
@@ -65,8 +64,7 @@ body
     margin-top: 1em
     
   #flash
-    +columns(7, 9)
-    +prefix(1, 9)
+    +columns(8, 9)
     margin-top: 1em
     margin-bottom: 1em
     .flash
@@ -79,8 +77,7 @@ body
       background-color: #bc3739
       
   .article
-    +columns(7, 9)
-    +prefix(1, 9)
+    +columns(8, 9)
     .title
       +title-family
       font-size: 2em
@@ -108,12 +105,12 @@ body
           color: black
           
       .comment
-        +columns(7, 7)
+        +columns(8,8)
         +full
         margin-bottom: 1em
         
         .infos
-          +columns(2, 7)
+          +columns(2,8)
           text-align: right
           
           .author
@@ -125,18 +122,18 @@ body
             color: #aaaaaa
             
         .content
-          +columns(4, 7)
-          +suffix(1, 7)
-          +omega(7)
+          +columns(5,8)
+          +suffix(1,8)
+          +omega(8)
           
       .add
-        +columns(7, 7)
+        +columns(8,8)
         +full
         padding-top: 1em
         
         form
-          +columns(5, 7)
-          +prefix(1, 7)
+          +columns(5,8)
+          +prefix(1,8)
           label
             font-weight: bold
           textarea
@@ -147,12 +144,11 @@ body
             text-align: right
             
   .abstract
-    +columns(7, 9)
-    +prefix(1, 9)
+    +columns(8, 9)
     margin-bottom: 2em
     
     .created_at
-      +columns(1, 7)
+      +columns(1,8)
       +rounded
       background-color: black
       color: white
@@ -161,8 +157,8 @@ body
       font-weight: bold
       
     .content
-      +columns(6, 7)
-      +omega(7)
+      +columns(7,8)
+      +omega(8)
       .title
         +title-family
         font-size: 1.5em
@@ -176,12 +172,15 @@ body
 #sidebar
   +columns(3)
   +omega
+  font-size: 0.9em
+  line-height: 1.4em
+  
   dt
     margin-bottom: $px2em * 5px
   img
     +rounded
     float: left
-    margin-right: $px2em * 5px
+    margin-right: $px2em * 20px
 
 #footer
   +columns(12)

data/{app → bin}/views/new_comment.haml

@@ -18,6 +18,6 @@
     %textarea{:name => 'comment[body]', :value => @comment.body}
     .hint (Obligatoire)
   
-    %input{:type => 'hidden', :name => 'comment[article]', :value => @article.filename}
+    %input{:type => 'hidden', :name => 'comment[article]', :value => @article.id}
   
     %input{:type => 'submit', :value => 'Envoyer'}

data/lib/parchemin/application.rb

@@ -3,10 +3,12 @@
 require File.join(File.dirname(__FILE__), "config/config")
 
 module Parchemin
+  
+  # The entire blog is based on this rack application
   class Application < Sinatra::Base
     
-    set :public, File.expand_path(File.join(File.dirname(__FILE__), "../../app/public"))
-    set :views, File.expand_path(File.join(File.dirname(__FILE__), "../../app/views"))
+    set :public, Proc.new { Parchemin::Config.assets_path }
+    set :views, Proc.new { Parchemin::Config.views_path }
     
     require File.join(File.dirname(__FILE__), "config/environment")
     
@@ -26,8 +28,8 @@ module Parchemin
       haml :index
     end
 
-    get '/articles/:article' do |filename|
-      @article = Parchemin::Article.new("#{Parchemin::Config.articles_path}/#{filename}.markdown")
+    get '/articles/:article' do |article|
+      @article = Parchemin::Article.new(article)
       @comments = @article.comments
       @comment = Parchemin::Comment.new
       haml :show
@@ -51,7 +53,7 @@ module Parchemin
     end
 
     post '/comment' do
-      @article = Parchemin::Article.new("#{params[:comment][:article]}.markdown")
+      @article = Parchemin::Article.new("#{params[:comment][:article]}")
       @comments = @article.comments
 
       @comment = Parchemin::Comment.new(params[:comment])

data/lib/parchemin/config/config.rb

@@ -1,60 +1,95 @@
 # coding: utf-8
 
 module Parchemin
+  
+  # This class holds all the configuration variables of the application
   module Config
     
+    # sets the blog'a author name
     def self.author_name=(name)
       @author_name = name
     end
     
+    # returns the blog's author name
     def self.author_name
       raise "The author_name configuration variable has not been set" if @author_name.nil?
       @author_name
     end
     
+    # sets the name of the blog
     def self.blog_name=(name)
       @blog_name = name
     end
     
+    # return the name of the blog
     def self.blog_name
       raise "The blog_name configuration variable has not been set" if @blog_name.nil?
       @blog_name
     end
     
+    # sets the host of the application. This variable is useful for define the RSS feed
     def self.host=(host)
       @host = host
     end
     
+    # returns the host of the application
     def self.host
       raise "The host configuration variable has not been set" if @host.nil?
       @host
     end
     
-    def self.project_path=(path)
-      @project_path = path
+    # sets the application's root directory
+    def self.root_path=(path)
+      @root_path = path
     end
     
-    def self.project_path
-      raise "The project_path configuration variable has not been set" if @project_path.nil?
-      @project_path
+    # returns the application's root directory
+    def self.root_path
+      raise "The root_path configuration variable has not been set" if @root_path.nil?
+      @root_path
     end
     
+    # sets the directory where to find the views. By defaut it is sets to ROOT_PATH/views
+    def self.views_path=(path)
+      @views_path = path
+    end
+    
+    # return the directory where to find the views
+    def self.views_path
+      @views_path ||= "#{root_path}/views"
+    end
+    
+    # sets the directory where to find the assets. By defaut it is sets to ROOT_PATH/assets
+    def self.assets_path=(path)
+      @assets_path = path
+    end
+    
+    # return the directory where to find the assets
+    def self.assets_path
+      @assets_path ||= "#{root_path}/assets"
+    end
+    
+    # sets the directory where to find the articles. By defaut it is sets to ROOT_PATH/articles
     def self.articles_path=(path)
       @articles_path = path
     end
     
+    # return the directory where to find the articles
     def self.articles_path
-      @articles_path ||= "#{project_path}/articles"
+      @articles_path ||= "#{root_path}/articles"
     end
     
+    # sets the directory where to find the static content such as about page. By defaut it is sets to ROOT_PATH/statics
     def self.statics_path=(path)
       @statics_path = path
     end
     
+    # returns the directory where to find the static content such as about page.
     def self.statics_path
-      @statics_path ||= "#{project_path}/statics"
+      @statics_path ||= "#{root_path}/statics"
     end
        
+    # sets the name of the MongoDB database where the comments are stored
     def self.db_name=(name)
       Mongoid.configure do |config|
         config.allow_dynamic_fields = false

data/lib/parchemin/config/environment.rb

@@ -17,8 +17,8 @@ module Parchemin
       request.params.replace new_params
     end
 
-    # Partial implementation
     helpers do
+      # Partial rendering implementation
       def partial(template, *args)
         options = args.last.is_a?(::Hash) ? args.pop : {}
         options.merge!(:layout => false)
@@ -32,14 +32,16 @@ module Parchemin
       end
     end
 
-    # Flash implementation
+
     use Rack::Session::Cookie
 
     helpers do
+      # Flash implementation
       def flash
         @_flash ||= {}
       end
 
+      # Redefine redirect() to add flash support
       def redirect(uri, *args)
         session[:_flash] = flash unless flash.empty?
         status 302

data/lib/parchemin/models/article.rb

@@ -3,61 +3,59 @@
 require 'date'
 
 module Parchemin
+  
+  # This class represent an article
   class Article
-    attr_reader :title, :created_at, :abstract, :body, :filename, :tags
+    attr_reader :id, :title, :created_at, :abstract, :body, :filename, :tags
 
     MONTHS = %w(janv fevr mars avr mai juin juill aout sept oct nov dec)
 
-    def initialize(filename)
-      @filename = filename.split('.').first
-      parse_attributes(filename)
-    end
-
-    def parse_attributes(filename)
-      body = ""
-      File.open(filename) do |f|
-        f.lines.each do |line|
-          if line.match /<!--\s(.*)\s-->/
-            $1.match /(.*)\s:\s(.*)/
-            eval "@#{$1} = #{$2}"
-          else
-            body += line
-          end
-        end
+    # initializes the article with its name
+    def initialize(id)
+      if id =~ /(.*)\.markdown$/
+        @id = $1
+      else
+        @id = id
       end
-
-      @body = RDiscount.new(body).to_html
+      parse_attributes(filename)
     end
     
-    def id
-      File.basename(filename)
+    # returns the expanded path of the article
+    def filename
+      "#{Parchemin::Config.articles_path}/#{@id}.markdown"
     end
 
+    # returns the month of the article's creation date
     def month
       MONTHS[@created_at.month-1]
     end
 
+    # returns the day of the article's creation date
     def day
       @created_at.day
     end
 
+    # returns the year of the article's creation date
     def year
       @created_at.year
     end
 
+    # returns a well formatted date
     def date
       "#{day} #{month.capitalize} #{year}"
     end
 
+    # defines the comparison of two articles
     def <=>(article)
       created_at <=> article.created_at
     end
 
+    # returns all the available articles. The articles starting by a '.' are not loaded
     def self.all(conditions={})
       articles = []
       Dir.foreach(Parchemin::Config.articles_path) do |entry|
         next if entry.match /^\./
-        article = Article.new("#{Parchemin::Config.articles_path}/#{entry}")
+        article = Article.new(entry)
 
         if conditions.count == 0
           articles << article
@@ -68,17 +66,37 @@ module Parchemin
       articles.sort.reverse
     end
 
+    # a rudimentary search engine
     def self.search(search)
       output = `grep -Hi '#{search}' #{Parchemin::Config.articles_path}/* | cut -d: -f1`
-      articles = output.split("\n").uniq.map { |filename| Article.new(filename) }
+      articles = output.split("\n").uniq.map do |filename|
+        Article.new(File.basename(filename))
+      end
       articles.sort.reverse
     end
     
+    # returns all the comments available for an article
     def comments
-      Comment.where(:article => @filename)
+      Comment.where(:article => @id)
     end
 
     protected
+    
+    def parse_attributes(filename)
+      body = ""
+      File.open(filename) do |f|
+        f.lines.each do |line|
+          if line.match /<!--\s(.*)\s-->/
+            $1.match /(.*)\s:\s(.*)/
+            eval "@#{$1} = #{$2}"
+          else
+            body += line
+          end
+        end
+      end
+
+      @body = RDiscount.new(body).to_html
+    end
 
     def self.filtered?(article, conditions)
       filtered = true

data/lib/parchemin/models/comment.rb

@@ -1,6 +1,8 @@
 # coding: utf-8
 
 module Parchemin
+  
+  # This class represents an article's comment
   class Comment
     include Mongoid::Document
     include Mongoid::Timestamps

data/lib/parchemin/models/static.rb

@@ -1,14 +1,18 @@
 # coding: utf-8
 
 module Parchemin
+  
+  # This class represents a static content such as an about page
   class Static
     attr_reader :filename, :id
     
+    # initializes the static content with its name
     def initialize(id)
       @id = id
       @filename = "#{Parchemin::Config.statics_path}/#{@id}.markdown"
     end
     
+    # return the body of the static content. It is possible to prevent the markup's interpretation by passing false to the method. It is useful when you only have a paragraph and don't want to see <p></p> around it.
     def body(interpret_markdown=true)
       raise "#{@filename} doesn't exist." if not File.exist?(@filename)
       if interpret_markdown

data/lib/parchemin/utils.rb

@@ -0,0 +1,38 @@
+require 'haml'
+require 'fileutils'
+
+module Parchemin
+  
+  # This class contains useful tools.
+  class Utils
+    
+    # Creates a directory.
+    def self.mkdir(name)
+      FileUtils.mkdir_p(name)
+    end
+    
+    # Copies an entire directory into another.
+    def self.cpdir(src, dest)
+      new_dir = "#{dest}/#{File.basename(src)}"
+      mkdir(new_dir)
+      
+      Dir.foreach(src) do |file|
+        next if %w(. ..).include? file
+        filename = "#{src}/#{file}"
+        
+        if File.directory?(filename)
+          cpdir(filename, new_dir)
+        else
+          FileUtils.copy filename, new_dir
+        end
+      end
+    end
+    
+    # Renders an HAML template.
+    def self.render(template, locals = {})
+      haml_engine = Haml::Engine.new(template)
+      haml_engine.render(Object.new, locals)
+    end
+    
+  end
+end

data/spec/parchemin_spec.rb

@@ -27,10 +27,10 @@ describe "Parchemin" do
   end
   
   it "renders an article" do
-    article = Parchemin::Article.new(File.expand_path(File.dirname(__FILE__) + '/bin/articles/lorem.markdown'))
-    Parchemin::Comment.create(:article => article.filename, :author => 'Rawane', :body => 'test')
-    Parchemin::Comment.create(:article => article.filename, :author => 'Rawane', :body => 'test')
-    Parchemin::Comment.create(:article => article.filename, :author => 'Rawane', :body => 'test')
+    article = Parchemin::Article.new('lorem')
+    Parchemin::Comment.create(:article => article.id, :author => 'Rawane', :body => 'test')
+    Parchemin::Comment.create(:article => article.id, :author => 'Rawane', :body => 'test')
+    Parchemin::Comment.create(:article => article.id, :author => 'Rawane', :body => 'test')
     
     get 'articles/lorem'
     
@@ -60,9 +60,9 @@ describe "Parchemin" do
   end
   
   it "creates articles comments with valid attributes" do
-    article = Parchemin::Article.new(File.expand_path(File.dirname(__FILE__) + '/bin/articles/azerty.markdown'))
+    article = Parchemin::Article.new('azerty')
     
-    post '/comment', {:comment => {:article => article.filename, :author => 'Rawane', :body => 'test'}}
+    post '/comment', {:comment => {:article => article.id, :author => 'Rawane', :body => 'test'}}
     follow_redirect!
 
     last_request.url.should == "http://example.org/articles/#{article.id}"
@@ -77,9 +77,9 @@ describe "Parchemin" do
   end
   
   it "does not create an article'comment with invalid attributes" do
-    article = Parchemin::Article.new(File.expand_path(File.dirname(__FILE__) + '/bin/articles/tellus.markdown'))
+    article = Parchemin::Article.new('tellus')
     
-    post '/comment', {:comment => {:article => article.filename, :author => 'Rawane'}}
+    post '/comment', {:comment => {:article => article.id, :author => 'Rawane'}}
     
     article.comments.count.should == 0
     

data/spec/spec_helper.rb

@@ -18,5 +18,5 @@ end
 Parchemin::Config.blog_name = "Parchemin Test"
 Parchemin::Config.author_name = "Rawane ZOSSOU"
 Parchemin::Config.host = "http://example.com"
-Parchemin::Config.project_path = File.join(File.dirname(__FILE__), 'bin')
+Parchemin::Config.root_path = File.expand_path(File.join(File.dirname(__FILE__), '../bin'))
 Parchemin::Config.db_name = 'parchemin_test'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: parchemin
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: false
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Rawane ZOSSOU
@@ -121,7 +121,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: -1483030150
+        hash: 252770848
         segments: 
         - 0
         - 7
@@ -160,30 +160,34 @@ files:
 - README.markdown
 - Rakefile
 - VERSION
-- app/public/images/feed-icon.gif
-- app/public/images/feed-icon.png
-- app/public/images/user.png
-- app/views/_base.sass
-- app/views/article_details.haml
-- app/views/index.haml
-- app/views/layout.haml
-- app/views/layout.sass
-- app/views/new_comment.haml
-- app/views/rss.builder
-- app/views/show.haml
-- app/views/static.haml
+- bin/articles/azerty.markdown
+- bin/articles/curae.markdown
+- bin/articles/lorem.markdown
+- bin/articles/tellus.markdown
+- bin/assets/images/feed-icon.gif
+- bin/assets/images/feed-icon.png
+- bin/assets/images/user.png
 - bin/parchemin
-- bin/templates/about.markdown
-- bin/templates/abstract.markdown
+- bin/statics/about.markdown
+- bin/statics/abstract.markdown
 - bin/templates/config.ru.haml
+- bin/views/_base.sass
+- bin/views/article_details.haml
+- bin/views/index.haml
+- bin/views/layout.haml
+- bin/views/layout.sass
+- bin/views/new_comment.haml
+- bin/views/rss.builder
+- bin/views/show.haml
+- bin/views/static.haml
 - lib/parchemin.rb
 - lib/parchemin/application.rb
-- lib/parchemin/config/compass.rb
 - lib/parchemin/config/config.rb
 - lib/parchemin/config/environment.rb
 - lib/parchemin/models/article.rb
 - lib/parchemin/models/comment.rb
 - lib/parchemin/models/static.rb
+- lib/parchemin/utils.rb
 - spec/parchemin_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true

data/lib/parchemin/config/compass.rb

@@ -1,15 +0,0 @@
-# coding: utf-8
-
-module Parchemin
-  class Application
-    configure do
-      Compass.configuration do |config|
-        config.project_path = File.dirname(__FILE__)
-        config.sass_dir = 'views'
-      end
-
-      set :haml, { :format => :html5 }
-      set :sass, Compass.sass_engine_options
-    end
-  end
-end