comfy_blog 0.0.0 → 0.1.0

data/README.md

@@ -1,6 +1,6 @@
-# ComfyBlog
+# ComfyBlog [![Build Status](https://secure.travis-ci.org/comfy/comfy-blog.png)](http://travis-ci.org/comfy/comfy-blog) [![Dependency Status](https://gemnasium.com/comfy/comfy-blog.png)](https://gemnasium.com/comfy/comfy-blog)
 
-ComfyBlog is an simple blog management engine for Rails 3.1 apps. As a bonus it integrates seamlessly with [ComfortableMexicanSofa](https://github.com/comfy/comfortable-mexican-sofa) CMS Engine
+ComfyBlog is an simple blog management engine for Rails 3.1 apps. It also integrates with [ComfortableMexicanSofa](https://github.com/comfy/comfortable-mexican-sofa) CMS Engine
 
 ## Installation
 
@@ -13,11 +13,53 @@ Then from the Rails project's root run:
     bundle install
     rails g blog
     rake db:migrate
+    
+Now you should be able to go to `/admin/blog/posts` and add new blog posts.
+
+## Configuration
+
+First thing you want to do is change title and description of the blog.
+For that you need to adjust `comfy_blog` initializer.
+
+    config.title        = 'ComfyBlog'
+    config.description  = 'A Simple Blog'
+
+You'll notice that you can access blog's admin area without any type of authentication.
+This is because ComfyBlog doesn't deal with users, it only knows how to save and show 
+blog posts. You probably want to put blog's admin controllers behind your controller
+that handles authentication. 
+    
+    config.admin_controller = 'YourAdminBaseController'
+    
+If you want blog's controller paths to match your admin path, like `cms-admin`. Change
+the following configuration.
+    
+    config.admin_route_prefix = 'cms-admin'
+    
+By default blog posts are served from the root. If you want to section off blog content
+to a `/blog` path. Adjust this configuration:
+    
+    config.public_route_prefix = 'blog'
+    
+Provided views to display blog posts are pretty basic and you'll probably want to change
+them right away. You can change the layout from the default `application` to something else.
+    
+    config.public_layout = 'blog'
+    
+Since ComfyBlog is an engine, it allows you to completely overwrite views. It's enough to
+create `app/views/blog/posts/index.html.erb` (could be HAML or whatever you want) and structure
+it in any way you want. There's also `show.html.erb` and `_post.html.erb` available.
+    
+You can control number of posts per page by adjusting this config:
+    
+    config.posts_per_page = 10
+    
+Posted comments will be sitting in the queue waiting to be published. You can auto publish them
+by setting this to `true`:
 
-## Usage
+    config.auto_publish_comments = true
 
-TODO
 
-Sofa Blog is released under the [MIT license](https://github.com/comfy/comfy-blog/raw/master/LICENSE) 
+ComfyBlog is released under the [MIT license](https://github.com/comfy/comfy-blog/raw/master/LICENSE) 
 
-Copyright 2011 Oleg Khabarov, [The Working Group Inc](http://www.twg.ca)
+Copyright 2012 Oleg Khabarov, [The Working Group Inc](http://www.twg.ca)

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.1.0

data/app/controllers/admin/blog/base_controller.rb

@@ -0,0 +1,3 @@
+class Admin::Blog::BaseController < ComfyBlog.config.admin_controller.to_s.constantize
+  # ...
+end

data/app/controllers/{blog/admin → admin/blog}/comments_controller.rb

@@ -1,4 +1,4 @@
-class Blog::Admin::CommentsController < Blog::Admin::BaseController
+class Admin::Blog::CommentsController < Admin::Blog::BaseController
   
   before_filter :load_post,     :only => [:index]
   before_filter :load_comment,  :only => [:destroy, :publish]

data/app/controllers/{blog/admin → admin/blog}/posts_controller.rb

@@ -1,4 +1,4 @@
-class Blog::Admin::PostsController < Blog::Admin::BaseController
+class Admin::Blog::PostsController < Admin::Blog::BaseController
   
   before_filter :build_post, :only => [:new, :create]
   before_filter :load_post,  :only => [:edit, :update, :destroy]
@@ -13,11 +13,11 @@ class Blog::Admin::PostsController < Blog::Admin::BaseController
   
   def create
     @post.save!
-    flash.now[:notice] = 'Blog Post created'
-    render :action => :new
+    flash[:notice] = 'Blog Post created'
+    redirect_to :action => :edit, :id => @post
     
   rescue ActiveRecord::RecordInvalid
-    flash.now[:error] = 'Failed to create Blog Post'
+    flash[:error] = 'Failed to create Blog Post'
     render :action => :new
   end
   
@@ -27,11 +27,11 @@ class Blog::Admin::PostsController < Blog::Admin::BaseController
   
   def update
     @post.update_attributes!(params[:post])
-    flash.now[:notice] = 'Blog Post updated'
-    render :action => :edit
+    flash[:notice] = 'Blog Post updated'
+    redirect_to :action => :edit, :id => @post
     
   rescue ActiveRecord::RecordInvalid
-    flash.now[:error] = 'Failed to update Blog Post'
+    flash[:error] = 'Failed to update Blog Post'
     render :action => :edit
   end
   

data/app/controllers/admin/blog/tags_controller.rb

@@ -0,0 +1,56 @@
+class Admin::Blog::TagsController < Admin::Blog::BaseController
+  
+  before_filter :build_tag, :only => [:new, :create]
+  before_filter :load_tag,  :only => [:edit, :update, :destroy]
+
+  def index
+    @tags = Blog::Tag.order('is_category DESC', :name)
+  end
+  
+  def edit
+    render
+  end
+  
+  def new
+    render
+  end
+  
+  def update
+    @tag.update_attributes!(params[:tag])
+    flash[:notice] = 'Blog Tag updated'
+    redirect_to :action => :index
+    
+  rescue ActiveRecord::RecordInvalid
+    flash[:error] = 'Failed to update Blog Tag'
+    render :action => :edit
+  end
+  
+  def create
+    @tag.save!
+    flash[:notice] = 'Blog Tag created'
+    redirect_to :action => :index
+    
+  rescue ActiveRecord::RecordInvalid
+    flash[:error] = 'Failed to create Blog Tag'
+    render :action => :new
+  end
+  
+  def destroy
+    @tag.destroy
+    flash[:notice] = 'Blog Tag removed'
+    redirect_to :action => :index
+  end
+
+protected
+  
+  def build_tag
+    @tag = Blog::Tag.new(params[:tag])
+  end
+  
+  def load_tag
+    @tag = Blog::Tag.find(params[:id])
+  rescue ActiveRecord::RecordNotFound
+    flash[:error] = 'Blog Tag not found'
+    redirect_to :action => :index  
+  end
+end

data/app/controllers/blog/comments_controller.rb

@@ -0,0 +1,35 @@
+class Blog::CommentsController < ApplicationController
+  
+  def create
+    @post = Blog::Post.published.find(params[:post_id])
+    @comment = @post.comments.new(params[:comment])
+    @comment.save!
+    
+    respond_to do |f|
+      f.html do 
+        flash[:notice] = 'Comment created'
+        redirect_to dated_blog_post_path(@post.year, @post.month, @post.slug)
+      end
+      f.js
+    end
+    
+  rescue ActiveRecord::RecordNotFound
+    respond_to do |f|
+      f.html do
+        flash[:error] = 'Blog Post not found'
+        redirect_to blog_posts_path
+      end
+      f.js do
+        render :nothing => true, :status => 404
+      end
+    end
+    
+  rescue ActiveRecord::RecordInvalid
+    respond_to do |f|
+      f.html do
+        render 'blog/posts/show'
+      end
+      f.js
+    end
+  end
+end

data/app/controllers/blog/posts_controller.rb

@@ -14,7 +14,14 @@ class Blog::PostsController < ApplicationController
       Blog::Post.published
     end
     
-    @posts = scope.paginate :per_page => ComfyBlog.config.posts_per_page, :page => params[:page]
+    respond_to do |f|
+      f.html do
+        @posts = scope.paginate :per_page => ComfyBlog.config.posts_per_page, :page => params[:page]
+      end
+      f.rss do
+        @posts = scope.limit(ComfyBlog.config.posts_per_page)
+      end
+    end
   end
   
   def show

data/app/helpers/blog/application_helper.rb

@@ -9,8 +9,11 @@ module Blog::ApplicationHelper
     )
   end
   
-  def blog_post_path(post)
-    
+  # URL helpers for blog_post_(path/url)
+  %w(path url).each do |type|
+    define_method "blog_post_#{type}" do |post|
+      send("dated_blog_post_#{type}", post.year, post.month, post.slug)
+    end
   end
   
 end

data/app/models/blog/comment.rb

@@ -1,6 +1,6 @@
 class Blog::Comment < ActiveRecord::Base
   
-  set_table_name :blog_comments
+  self.table_name = :blog_comments
   
   attr_accessible :author,
                   :email,
@@ -8,6 +8,9 @@ class Blog::Comment < ActiveRecord::Base
   
   # -- Relationships --------------------------------------------------------
   belongs_to :post
+  
+  # -- Callbacks ------------------------------------------------------------
+  before_create :set_publish
     
   # -- Validations ----------------------------------------------------------
   validates :post_id, :content, :author, :email, 
@@ -18,4 +21,11 @@ class Blog::Comment < ActiveRecord::Base
   # -- Scopes ---------------------------------------------------------------
   scope :published, where(:is_published => true)
   
+protected
+  
+  def set_publish
+    self.is_published = ComfyBlog.config.auto_publish_comments
+    return
+  end
+  
 end

data/app/models/blog/post.rb

@@ -1,6 +1,6 @@
 class Blog::Post < ActiveRecord::Base
   
-  set_table_name :blog_posts
+  self.table_name = :blog_posts
 
   # -- Attributes -----------------------------------------------------------
   attr_accessor :tag_names,
@@ -46,6 +46,10 @@ class Blog::Post < ActiveRecord::Base
     @tag_names ||= self.tags.tags.collect(&:name).join(', ')
   end
   
+  def category_ids
+    @category_ids ||= self.tags.categories.inject({}){|h, c| h[c.id.to_s] = '1'; h}
+  end
+  
 protected
   
   def set_slug
@@ -61,16 +65,16 @@ protected
     return unless tag_names
     self.taggings.for_tags.destroy_all
     self.tag_names.split(',').map{ |t| t.strip }.uniq.each do |tag_name|
-      self.tags << Blog::Tag.find_or_create_by_name(tag_name)
+      self.tags << Blog::Tag.find_or_create_by_name(tag_name) rescue nil
     end
   end
   
   def sync_categories
-    (self.category_ids || {}).each do |category_id, flag|
+    self.category_ids.each do |category_id, flag|
       case flag.to_i
       when 1
         if category = Blog::Tag.categories.find_by_id(category_id)
-          category.taggings.create(:post => self)
+          category.taggings.create(:post => self) rescue nil
         end
       when 0
         self.taggings.for_categories.where(:tag_id => category_id).destroy_all

data/app/models/blog/tag.rb

@@ -1,13 +1,13 @@
 class Blog::Tag < ActiveRecord::Base
 
-  set_table_name :blog_tags
+  self.table_name = :blog_tags
 
   # -- Relationships --------------------------------------------------------
   has_many :taggings, :dependent => :destroy
   has_many :posts, :through => :taggings
     
   # -- Validations ----------------------------------------------------------
-  validates_uniqueness_of :name
+  validates_uniqueness_of :name, :case_sensitive => false
   
   # -- Callbacks ------------------------------------------------------------
   before_validation :strip_name
@@ -19,7 +19,7 @@ class Blog::Tag < ActiveRecord::Base
 protected
   
   def strip_name
-    self.name.strip!
+    self.name = self.name.strip if self.name
   end
   
 end

data/app/models/blog/tagging.rb

@@ -1,6 +1,6 @@
 class Blog::Tagging < ActiveRecord::Base
   
-  set_table_name :blog_taggings
+  self.table_name = :blog_taggings
   
   # -- Relationships --------------------------------------------------------
   belongs_to :post

data/app/views/admin/blog/_navigation.html.erb

@@ -0,0 +1,2 @@
+<li><%= active_link_to 'Blog posts', admin_blog_posts_path %></li>
+<li><%= active_link_to 'Blog tags', admin_blog_tags_path %></li>

data/app/views/{blog/admin → admin/blog}/comments/_comment.html.erb

@@ -3,9 +3,9 @@
     <div class='icon' style="background-image:url(http://www.gravatar.com/avatar/<%=Digest::MD5.hexdigest(comment.email.downcase)%>?s=28&d=identicon)"></div>
     <div class='action_links'>
       <% unless comment.is_published? %>
-        <%= link_to 'Publish', publish_admin_comment_path(comment), :remote => true, :method => :put %>
+        <%= link_to 'Publish', publish_admin_blog_comment_path(comment), :remote => true, :method => :put %>
       <% end %>
-      <%= link_to 'Delete', admin_comment_path(comment), :method => 'delete', :confirm => 'Are you sure?' %>
+      <%= link_to 'Delete', admin_blog_comment_path(comment), :method => 'delete', :confirm => 'Are you sure?' %>
     </div>
     <div class='label'>
       <div class='sublabel'>

data/app/views/{blog/admin → admin/blog}/comments/index.html.erb

@@ -6,5 +6,7 @@
 </h1>
 
 <ul class='list comments'>
-  <%= render @comments %>
+  <% @comments.each do |comment| %>
+    <%= render :partial => 'comment', :object => comment %>
+  <% end %>
 </ul>

data/app/views/{blog/admin → admin/blog}/posts/_form.html.erb

@@ -1,5 +1,16 @@
 <%= form.text_field :title %>
 <%= form.text_field :author %>
+<% if Blog::Tag.categories.present? %>
+  <%= form.simple_field 'Categories' do %>
+    <% Blog::Tag.categories.each do |category| %>
+      <%= hidden_field_tag "post[category_ids][#{category.id}]", 0, :id => nil %>
+      <label>
+        <%= check_box_tag "post[category_ids][#{category.id}]", 1, @post.category_ids[category.id.to_s].to_i == 1, :id => nil %>
+        <%= category.name %>
+      </label>
+    <% end %>
+  <% end %>
+<% end %>
 <%= form.text_field :tag_names, :label => 'Tags' %>
 <%= form.text_area :content, :class => 'rich_text' %>
 <%= form.text_field :excerpt %>

data/app/views/{blog/admin → admin/blog}/posts/_post.html.erb

@@ -1,12 +1,12 @@
 <li>
   <div class='item'>
     <div class='action_links'>
-      <%= link_to pluralize(post.comments.count, 'comment'), admin_post_comments_path(post) %>
-      <%= link_to 'Edit', edit_admin_post_path(post) %>
-      <%= link_to 'Delete', admin_post_path(post), :method => :delete, :confirm => 'Are you sure?' %>
+      <%= link_to pluralize(post.comments.count, 'comment'), admin_blog_post_comments_path(post) %>
+      <%= link_to 'Edit', edit_admin_blog_post_path(post) %>
+      <%= link_to 'Delete', admin_blog_post_path(post), :method => :delete, :confirm => 'Are you sure?' %>
     </div>
     <div class='label'>
-      <%= link_to post.title.titleize, edit_admin_post_path(post) %>
+      <%= link_to post.title.titleize, edit_admin_blog_post_path(post) %>
       <div class='sublabel'>
         Published <%= time_ago_in_words(post.updated_at) %> ago
         by <strong><%= post.author %></strong>

data/app/views/admin/blog/posts/index.html.erb

@@ -0,0 +1,11 @@
+<%= link_to 'Add new blog post', new_admin_blog_post_path, :class => 'big button' %>
+
+<h1>Blog Posts</h1>
+
+<ul class='list posts'>
+  <% @posts.each do |post| %>
+    <%= render :partial => 'post', :object => post %>
+  <% end %>
+</ul>
+
+<%= will_paginate @posts %>

data/app/views/admin/blog/tags/_form.html.erb

@@ -0,0 +1,20 @@
+<%= form.text_field :name %>
+<%= form.check_box :is_category %>
+
+<% if defined?(ComfortableMexicanSofa) %>
+  <%= form.simple_field nil, nil, :class => 'submit_element' do %>
+    <% if @tag.is_category %>
+      <%= form.submit @tag.new_record?? 'Create category' : 'Update category', :disable_builder => true %>
+    <% else %>
+      <%= form.submit @tag.new_record?? 'Create tag' : 'Update tag', :disable_builder => true %>
+    <% end %>
+  <% end %>
+  
+<% else %>
+  <% if @tag.is_category %>
+    <%= form.submit @tag.new_record?? 'Create category' : 'Update category' %>
+  <% else %>
+    <%= form.submit @tag.new_record?? 'Create tag' : 'Update tag' %>
+  <% end %>
+<% end %>
+

data/app/views/admin/blog/tags/_tag.html.erb

@@ -0,0 +1,16 @@
+<li>
+  <div class='item'>
+    <div class='action_links'>
+      <%= link_to 'Edit', :action => :edit, :id => tag %>
+      <%= link_to 'Delete', {:action => :destroy, :id => tag}, :method => :delete, :confirm => 'Are you sure you want to delete this tag?' %>
+    </div>
+    <div class='label'>
+      <%= link_to tag.name, :action => :edit, :id => tag %>
+      <div class='sublabel'>
+        <% if tag.is_category? %>
+          Category
+        <% end %>
+      </div>
+    </div>
+  </div>
+</li>

data/app/views/admin/blog/tags/edit.html.erb

@@ -0,0 +1,5 @@
+<h1>Editing <%= @tag.name %></h1>
+
+<%= comfy_blog_form_for @tag, :as => :tag, :url => {:action => :update} do |form| %>
+  <%= render :partial => form %>
+<% end %>

data/app/views/admin/blog/tags/index.html.erb

@@ -0,0 +1,9 @@
+<%= link_to 'Add new blog tag', {:action => :new}, :class => 'big button' %>
+
+<h1>Blog Tags</h1>
+
+<ul class='list categories'>
+  <% @tags.each do |tag| %>
+    <%= render :partial => 'tag', :object => tag %>
+  <% end %>
+</ul>

data/app/views/admin/blog/tags/new.html.erb

@@ -0,0 +1,5 @@
+<h1>New Blog Post</h1>
+
+<%= comfy_blog_form_for @tag, :as => :tag, :url => {:action => :create} do |form| %>
+  <%= render :partial => form %>
+<% end %>

data/app/views/blog/comments/_comment.html.erb

@@ -0,0 +1,4 @@
+<div class='comment' id='<%= dom_id(comment) %>'>
+  <div class='author'><%= comment.author %></div>
+  <div class='content'><%= comment.content %></div>
+</div>

data/app/views/blog/comments/_form.html.erb

@@ -0,0 +1,6 @@
+<%= form_for :comment, :remote => true, :url => blog_post_comments_path(@post), :html => { :id => 'comment' } do |form| %>
+  <%= form.text_field :author %>
+  <%= form.text_field :email %>
+  <%= form.text_area :content %>
+  <%= form.submit 'Submit' %>
+<% end %>

data/app/views/blog/comments/create.js.erb

@@ -0,0 +1,6 @@
+<% if @comment.new_record? %>
+  $('form#comment').replaceWith('<%= escape_javascript(render(:partial => "form")) %>');
+<% else %>
+  $('form#comment')[0].reset();
+  $('#comments').append('<%= escape_javascript(render(:partial => "comment", :object => @comment)) %>');
+<% end %>

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

@@ -1,18 +1,8 @@
 <div class='post'>
-  <h1><%= post.title %></h1>
+  <h1><%= @post ? post.title : link_to(post.title, blog_post_path(post))%></h1>
   <div class='author'><%= post.author %></div>
   <div class='date'><%= post.created_at %></div>
   <div class='content'>
     <%= post.content.html_safe %>
   </div>
-<div>
-  
-<% if @post %>
-  <div class='comments'>
-    <% @post.comments.each do |comment| %>
-      <div class='comment'>
-        <%= comment.content %>
-      </div>
-    <% end %>
-  </div>
-<% end %>
+</div>

data/app/views/blog/posts/index.rss.builder

@@ -0,0 +1,18 @@
+xml.instruct! :xml, :version => '1.0'
+xml.rss :version => '2.0' do
+  xml.channel do
+    xml.title ComfyBlog.config.title
+    xml.description ComfyBlog.config.description
+    xml.link request.url
+    
+    @posts.each do |post|
+      xml.item do
+        xml.title post.title
+        xml.description post.content
+        xml.pubDate post.created_at.to_s(:rfc822)
+        xml.link blog_post_url(post)
+        xml.guid blog_post_url(post)
+      end
+    end
+  end
+end

data/app/views/blog/posts/show.html.erb

@@ -1 +1,9 @@
-<%= render :partial => 'post', :object => @post %>
+<%= render :partial => 'blog/posts/post', :object => @post %>
+
+<div id='comments'>
+  <% @post.comments.each do |comment| %>
+    <%= render :partial => 'blog/comments/comment', :object => comment %>
+  <% end %>
+</div>
+
+<%= render :partial => 'blog/comments/form' %>