bcms_blog 1.2.0 → 1.3.0

data/Gemfile

@@ -0,0 +1,10 @@
+source 'http://rubygems.org'
+
+gem 'sqlite3'
+
+group :test do
+	gem 'factory_girl_rails'
+	gem 'mocha', :require=>false
+end
+
+gemspec

data/README.markdown

@@ -15,18 +15,21 @@ A simple blog module that lets users create multiple blogs.
 
 The blog module installs like most other BrowserCMS modules (http://guides.browsercms.org/installing_modules.html)
 
-    gem install bcms_blog
+    $ gem install bcms_blog
     
 ## Set up your application to use the module
 
 ### 1. Install the module 
     
-    rails g cms:install bcms_blog
+    $ rails g cms:install bcms_blog
     
 ### 2. Run the following commands
   
-    rake db:migrate
-  	
+    $ rake db:migrate
+  	$ rake db:seed
+
+For projects with existing databases, you may need to comment out other lines in db/seeds.rb so only the blog seed data runs.
+
 ## Creating a Blog
 
 * To get started, go to the Content Library and choose the Blog module in the left hand menu.
@@ -103,3 +106,6 @@ Special thanks to some amazing folks from the BrowserCMS community for their wor
 * Notifications for Comments - Blogs should have an option to be notified when a new comment is created. This will allow for practical management of comments/spam.
 * Messaging for Moderated comments - If moderation is turned on, users get no feedback about the comment they just left. Ideally, they would get some sort of javascript notice that their comment is awaiting notification.
 
+## 3.5.x Todo 
+
+* Test and release

data/app/assets/javascripts/bcms_blog/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/bcms_blog/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+*/

data/app/controllers/bcms_blog/blog_comments_controller.rb

@@ -0,0 +1,5 @@
+module BcmsBlog
+  class BlogCommentsController < Cms::ContentBlockController
+
+  end
+end

data/app/controllers/bcms_blog/blog_posts_controller.rb

@@ -0,0 +1,37 @@
+module BcmsBlog
+  class BlogPostsController < Cms::ContentBlockController
+    before_filter :show_no_access_if_none_editable
+  
+    def build_block
+      super
+      ensure_blog_editable
+      @block.author = current_user
+    end
+  
+    def load_block
+      super
+      ensure_blog_editable
+    end
+  
+    def load_blocks
+      super
+      @blocks.delete_if { |b| !b.editable_by?(current_user) }
+    end
+  
+    private
+    
+      # If the current user is not able to edit any blog, just show them a page saying so
+      def show_no_access_if_none_editable
+        if Blog.editable_by(current_user).empty?
+          render :action => "no_access"
+        end
+      end
+    
+      # Ensure the current user can actually edit the blog this blog post is associated with
+      def ensure_blog_editable
+        if @block.blog
+          raise Cms::Errors::AccessDenied unless @block.blog.editable_by?(current_user)
+        end
+      end
+  end
+end

data/app/controllers/bcms_blog/blogs_controller.rb

@@ -0,0 +1,13 @@
+module BcmsBlog
+  class BlogsController < Cms::ContentBlockController
+    check_permissions :administrate, :except => :index
+  
+    def index
+      if current_user.able_to?(:administrate)
+        super
+      else
+        render :action => "admin_only"
+      end
+    end
+  end
+end

data/app/controllers/bcms_blog/feeds_controller.rb

@@ -0,0 +1,10 @@
+module BcmsBlog
+  class FeedsController < ApplicationController
+  
+    def index
+      @blog = Blog.find(params[:blog_id])
+      @blog_posts = @blog.posts.published.all(:limit => 10, :order => "published_at DESC")
+    end
+  
+  end
+end

data/app/helpers/bcms_blog/blog_helper.rb

@@ -0,0 +1,27 @@
+module BcmsBlog
+  module BlogHelper
+    # We can't call it 'blog_path' because that would conflict with the actual named route method if there's a blog named "Blog".
+    def _blog_path(blog, route_name, route_params)
+      send("#{blog.name_for_path}_#{route_name}_path", route_params)
+    end
+
+    def _blog_post_path(blog_post)
+      main_app.send("#{blog_post.route_name}_path", blog_post.route_params)
+    end
+  
+    def feeds_link_tag_for(name)
+      blog = Blog.find_by_name(name)
+      auto_discovery_link_tag(:rss, main_app.blog_feeds_url(:blog_id => blog), :title => "#{blog.name}")
+    end
+  
+    def new_comment_params(portlet)
+      {:url=> Cms::Engine.routes.url_helpers.portlet_handler_path(:id=>portlet.id, :handler=>'create_comment'), 
+      :method=>'post'}
+    end
+    
+    # Cms::ViewContext doesn't expose this method correctly, so duplicating it here.
+    def main_app
+      Rails.application.routes.url_helpers
+    end
+  end
+end

data/app/models/bcms_blog/blog.rb

@@ -0,0 +1,99 @@
+module BcmsBlog
+  class Blog < ActiveRecord::Base
+    acts_as_content_block
+  
+    has_many :posts, :class_name => "BlogPost", :conditions => { :published => true }, :order => "published_at desc"
+    has_many :blog_group_memberships
+    has_many :groups, :through => :blog_group_memberships, :class_name=>"Cms::Group"
+
+    attr_accessible :group_ids
+    
+    validates_presence_of :name
+    validates_uniqueness_of :name
+
+    scope :editable_by, lambda { |user|
+      if user.able_to?(:administrate)
+        { }
+      else
+        { :include => :groups, :conditions => ["groups.id IN (?)", user.group_ids.join(",")] }
+      end
+    }
+    
+    def self.default_template
+      template_file = ActionController::Base.view_paths.map do |vp|
+        path = vp.to_s.first == "/" ? vp.to_s : File.join(Rails.root, vp.to_s)
+        File.join(path, "bcms_blog/blogs/render.html.erb")
+      end.detect{|f| File.exists? f }
+      template_file ? open(template_file){|f| f.read } : ""
+    end
+
+    def self.posts_finder(finder, options)
+      if options[:tag]
+        finder = finder.tagged_with(options[:tag])
+      end
+      if options[:exclude_tags]
+        finder = finder.not_tagged_with(options[:exclude_tags])
+      end
+      if options[:category] || options[:category_id]
+        category_type = Cms::CategoryType.named("Blog Post").first
+        category = category_type.categories.named(options[:category]).first if options[:category]
+        category = category_type.categories. find(options[:category_id])    if options[:category_id]
+        finder = finder.in_category(category)
+      end
+      finder
+    end
+
+    def render
+      @blog = self
+      finder = @blog.posts.published
+      finder = Blog.posts_finder(finder, params)
+
+      if params[:year] && params[:month] && params[:day]
+        @date = Date.new(params[:year].to_i, params[:month].to_i, params[:day].to_i)
+        finder = posts.published_between(@date, @date + 1.day)
+      elsif params[:year] && params[:month]
+        @date = Date.new(params[:year].to_i, params[:month].to_i)
+        finder = posts.published_between(@date, @date + 1.month)
+      elsif params[:year]
+        @date = Date.new(params[:year].to_i)
+        finder = posts.published_between(@date, @date + 1.year)
+      end
+
+      @blog_posts = finder.all(:limit => 25, :order => "published_at desc")
+      raise ActiveRecord::RecordNotFound.new("No posts found") if @blog_posts.empty?
+
+      if params[:category]
+        @page_title = "#{params[:category]}"
+      elsif params[:tag]
+        @page_title = "Posts tagged with #{params[:tag]}"
+      elsif params[:year] && params[:month] && params[:day]
+        @page_title = "Posts from #{@date.to_s(:long)}"
+      elsif params[:year] && params[:month]
+        @page_title = "Posts from #{Date::MONTHNAMES[@date.month]} #{@date.year}"
+      elsif params[:year]
+        @page_title = "Posts from #{@date.year}"
+      end
+    end
+
+    def inline_options
+      {:inline => self.template}
+    end
+
+    def self.default_order
+      "name"
+    end
+
+    def editable_by?(user)
+      user.able_to?(:administrate) || !(group_ids & user.group_ids).empty?
+    end
+
+    def potential_authors
+      groups.map(&:users).flatten.uniq
+    end
+
+    def name_for_path
+      name.to_slug.gsub('-', '_')
+    end
+
+  end
+end

data/app/models/bcms_blog/blog_comment.rb

@@ -0,0 +1,36 @@
+module BcmsBlog
+  class BlogComment < ActiveRecord::Base
+    acts_as_content_block :is_searachable => "body"
+    belongs_to :post, :class_name => "BlogPost", :counter_cache => "comments_count"
+
+    validates_presence_of :post_id, :author, :body
+  
+    before_create :publish_if_comments_are_enabled
+  
+    def publish_if_comments_are_enabled
+      self.published = true unless post.blog.moderate_comments?
+    end
+
+    def self.default_order
+      "created_at desc"
+    end
+
+    def self.default_order_for_search
+      default_order
+    end
+
+    def self.columns_for_index
+      [ {:label => "Comment",    :method => :name,                 :order => "body" },
+        {:label => "Created At", :method => :formatted_created_at, :order => "created_at"} ]
+    end
+
+    def name
+      body ? body[0..50] : ""
+    end
+
+    def formatted_created_at
+      created_at.to_s(:date)
+    end
+
+  end
+end

data/app/models/bcms_blog/blog_group_membership.rb

@@ -0,0 +1,6 @@
+module BcmsBlog
+  class BlogGroupMembership < ActiveRecord::Base
+    belongs_to :blog, :class_name => "BcmsBlog::Blog"
+    belongs_to :group, :class_name => "Cms::Group"
+  end
+end

data/app/models/bcms_blog/blog_observer.rb

@@ -0,0 +1,141 @@
+module BcmsBlog
+  class BlogObserver < ActiveRecord::Observer
+  
+    def after_create(blog)
+      @blog = blog
+      create_section_pages_and_routes
+    end
+  
+    def after_save(blog)
+      if blog.persisted?
+        blog.publish
+      end
+    end
+  
+    # Can't use before_update since CMS callback stack is altered from normal callbacks.
+    def before_save(blog)
+      if blog.persisted?
+        update_section_pages_and_route(blog)
+      end
+    end
+
+    private
+  
+    # A section, two pages, 6 routes and a portlet are created alongside every blog.
+    # This structure provides sensible defaults so users can pretty much start adding
+    # posts right after creating a blog without having to worry about where to put
+    # their blog and portlets.
+    def create_section_pages_and_routes
+      create_blog_section
+      create_blog_block_page
+      create_post_portlet_page
+      reload_routes
+    end
+
+    # Every blog is created within a section with the same name.
+    # For example, if you create a blog named 'MyBlog', a section 'MyBlog' will be
+    # created. This section will hold two pages: one for the blog ContentBlock that
+    # will render the list of posts and one for the BlogPost portlet (ie the individual
+    # post view)  
+    def create_blog_section
+      @section = Cms::Section.find_by_name(@blog.name) || (
+        @section = Cms::Section.create!(
+          :name => @blog.name,
+          :path => "/#{@blog.name_for_path}",
+          :parent => Cms::Section.root.first
+        )
+        @section.allow_groups = :all
+        @section.save!
+        @section
+      )
+    end
+
+    # Following with the above example, the first page that is created is named 'MyBlog' and
+    # holds the Blog ContentBlock directly, not a portlet. Together with the 5 created routes,
+    # this page and its  ContentBlock handle different post listings (all posts, posts in year, 
+    # month or day and posts by tag or category).
+    def create_blog_block_page
+      page = Cms::Page.find_by_name(@blog.name) || Cms::Page.create!(
+        :name => @blog.name,
+        :path => "/#{@blog.name_for_path}",
+        :section => @section,
+        :template_file_name => "default.html.erb",
+        :hidden => true
+      )
+      page.create_connector(@blog, 'main')
+
+      create_route(page, "#{@blog.name}: Posts In Day",      "/#{@blog.name_for_path}/:year/:month/:day")
+      create_route(page, "#{@blog.name}: Posts In Month",    "/#{@blog.name_for_path}/:year/:month")
+      create_route(page, "#{@blog.name}: Posts In Year",     "/#{@blog.name_for_path}/:year")
+      create_route(page, "#{@blog.name}: Posts With Tag",    "/#{@blog.name_for_path}/tag/:tag")
+      create_route(page, "#{@blog.name}: Posts In Category", "/#{@blog.name_for_path}/category/:category")
+    end
+
+    # The second page that is created holds the BlogPostPortlet and displays the individual
+    # post view, along with it's comments.
+    def create_post_portlet_page
+      page = Cms::Page.find_by_name(portlet_name = "#{@blog.name}: Post") || Cms::Page.create!(
+        :name => portlet_name,
+        :path => "/#{@blog.name_for_path}/post",
+        :section => @section,
+        :template_file_name => "default.html.erb",
+        :hidden => true)
+      page.publish
+      create_route(page, portlet_name, "/#{@blog.name_for_path}/:year/:month/:day/:slug")
+      create_portlet(page, portlet_name, BlogPostPortlet)
+    end
+
+    # When the name of a Blog block changes, we need to change the Post page route.
+    # We also change the *names* of the section and pages that hold the blog block and 
+    # post portlet because presumably, by changing the name of the blog, the intention 
+    # was to reflect this name change in breadcrumbs and menus. 
+    # 
+    # Note that no other routes or paths are updated. This is intentional to be consistent
+    # with how BrowserCMS behaves when a Section or Page names change: paths are not
+    # updated automatically.
+    def update_section_pages_and_route(blog)
+      if blog.name_changed?
+        old_blog_name = blog.name_was
+
+        Cms::Section.find_by_name(old_blog_name).update_attribute(:name, blog.name)
+        Cms::PageRoute.find_by_name("#{old_blog_name}: Post").update_attribute(:name, "#{blog.name}: Post")
+
+        page = Cms::Page.find_by_name("#{old_blog_name}: Post")
+        page.update_attribute(:name, "#{blog.name}: Post")
+        page.publish
+
+        page = Cms::Page.find_by_name(old_blog_name)
+        page.update_attribute(:name, blog.name)
+        page.publish
+      end
+    end 
+
+    def reload_routes
+       Cms::PageRoute.reload_routes
+    end
+
+    def create_route(page, name, pattern)
+      route = page.page_routes.build(:name => name, :pattern => pattern, :code => "")
+      route.save!
+      route.add_condition(:method, "get").save
+      route.add_requirement(:year,  '\d{4,}') if pattern.include?(":year")
+      route.add_requirement(:month, '\d{2,}') if pattern.include?(":month")
+      route.add_requirement(:day,   '\d{2,}') if pattern.include?(":day")
+      route.requirements.each(&:save)
+    end
+
+    def create_portlet(page, name, portlet_class)
+      portlet_class.create!(
+        :name => "#{name} Portlet",
+        :blog_id => @blog.id,
+        :template => portlet_class.default_template,
+        :connect_to_page_id => page.id,
+        :connect_to_container => "main",
+        :publish_on_save => true)
+    end
+  end
+end
+
+
+
+

data/app/models/bcms_blog/blog_post.rb

@@ -0,0 +1,108 @@
+module BcmsBlog
+  class BlogPost < ActiveRecord::Base
+    acts_as_content_block :taggable => true
+
+    has_attachment :file
+
+
+    before_save :set_published_at
+
+    belongs_to :blog
+    belongs_to_category
+    belongs_to :author, :class_name => "Cms::User"
+    has_many :comments, :class_name => "BlogComment", :foreign_key => "post_id"
+
+    before_validation :set_slug
+    validates_presence_of :name, :slug, :blog_id, :author_id
+
+    scope :published_between, lambda { |start, finish|
+      { :conditions => [
+           "#{table_name}.published_at >= ? AND #{table_name}.published_at < ?",
+           start, finish ] }
+    }
+
+    scope :not_tagged_with, lambda { |tag| {
+      :conditions => [
+        "#{table_name}.id not in (
+          SELECT taggings.taggable_id FROM taggings
+          JOIN tags ON tags.id = taggings.tag_id
+          WHERE taggings.taggable_type = 'BlogPost'
+          AND (tags.name = ?)
+        )",
+        tag
+      ]
+    } }
+
+    INCORRECT_PARAMETERS = "Incorrect parameters. This is probably because you are trying to view the " +
+                           "portlet through the CMS interface, and so we have no way of knowing what " +
+                           "post(s) to show"
+
+    delegate :editable_by?, :to => :blog
+
+    def set_published_at
+      if !published_at && publish_on_save
+        self.published_at = Time.now
+      end
+    end
+
+    # This is necessary because, oddly, the publish! method in the Publishing behaviour sends an update
+    # query directly to the database, bypassing callbacks, so published_at does not get set by our
+    # set_published_at callback.
+    def after_publish_with_set_published_at
+      if published_at.nil?
+        self.published_at = Time.now
+        self.save!
+      end
+      after_publish_without_set_published_at if respond_to? :after_publish_without_set_published_at
+    end
+    if instance_methods.map(&:to_s).include? 'after_publish'
+      alias_method_chain :after_publish, :set_published_at
+    else
+      alias_method       :after_publish, :after_publish_with_set_published_at
+    end
+
+    def self.default_order
+      "created_at desc"
+    end
+
+    def self.columns_for_index
+      [ {:label => "Name", :method => :name, :order => "name" },
+        {:label => "Published At", :method => :published_label, :order => "published_at" } ]
+    end
+
+    def published_label
+      published_at ? published_at.to_s(:date) : nil
+    end
+
+    def set_slug
+      self.slug = name.to_slug
+    end
+
+    def path
+      send("#{blog.name_for_path}_post_path", route_params)
+    end
+    def route_name
+      "#{blog.name_for_path}_post"
+    end
+    def route_params
+      {:year => year, :month => month, :day => day, :slug => slug}
+    end
+
+    def year
+      published_at.strftime("%Y") unless published_at.blank?
+    end
+
+    def month
+      published_at.strftime("%m") unless published_at.blank?
+    end
+
+    def day
+      published_at.strftime("%d") unless published_at.blank?
+    end
+    
+    # Return true if this model has an attachment
+    def attachment
+      !file.blank?
+    end
+  end
+end

data/app/portlets/blog_post_portlet.rb

@@ -1,9 +1,9 @@
-class BlogPostPortlet < Portlet
+class BlogPostPortlet < Cms::Portlet
   
   enable_template_editor false
 
   def render
-    scope = Blog.find(self.blog_id).posts
+    scope = BcmsBlog::Blog.find(self.blog_id).posts
     if params[:blog_post_id]
       @blog_post = scope.find(params[:blog_post_id])
     elsif params[:slug]
@@ -13,7 +13,7 @@ class BlogPostPortlet < Portlet
       end
       @blog_post = scope.find_by_slug!(params[:slug])
     else
-      raise BlogPost::INCORRECT_PARAMETERS
+      raise BcmsBlog::BlogPost::INCORRECT_PARAMETERS
     end
 
     make_page_title_use_blog_post_name(@blog_post)
@@ -29,7 +29,7 @@ class BlogPostPortlet < Portlet
     work_around_cms_3_3_bug_where_current_user_is_not_correctly_set
 
     params[:blog_comment].merge! :ip => request.remote_ip
-    blog_comment = BlogComment.new(params[:blog_comment])
+    blog_comment = BcmsBlog::BlogComment.new(params[:blog_comment])
     if blog_comment.valid? && blog_comment.save
       url_for_success
     else
@@ -42,10 +42,10 @@ class BlogPostPortlet < Portlet
   private
   
   def work_around_cms_3_3_bug_where_current_user_is_not_correctly_set
-    User.current = current_user
+    Cms::User.current = current_user
   end
   
-  # This is a work around for a bug in bcms 3.3 where the Cms::PageHeler#page_title doesnt
+  # This is a work around for a bug in bcms 3.3 where the Cms::PageHelper#page_title doesnt
   #   share state between the portlet view and the page view.
   #   When the portlet view (app/views/portlets/blog_post/render) calls 'page_title @post.name' 
   #   that instance variable isn't shared back to the page template. 

data/app/portlets/blog_posts_portlet.rb

@@ -1,4 +1,4 @@
-class BlogPostsPortlet < Portlet
+class BlogPostsPortlet < Cms::Portlet
   
   after_initialize :build_permalink_code
   
@@ -22,9 +22,9 @@ class BlogPostsPortlet < Portlet
     Rails.logger.debug "... BlogPostsPortlet#render(options=#{@options.inspect} #{@options.class})"
 
     if @options[:blog_id]
-      finder = Blog.find(@options[:blog_id]).posts
+      finder = BcmsBlog::Blog.find(@options[:blog_id]).posts
     elsif @options[:blog_name]
-      finder = Blog.find_by_name(@options[:blog_name]).posts
+      finder = BcmsBlog::Blog.find_by_name(@options[:blog_name]).posts
     else
       finder = BlogPost
     end
@@ -35,7 +35,7 @@ class BlogPostsPortlet < Portlet
     end
 
     finder = finder.published
-    finder = Blog.posts_finder(finder, @options)
+    finder = BcmsBlog::Blog.posts_finder(finder, @options)
 
     @blog_posts = finder.all(
       :limit => @options[:limit] || 25,

data/app/views/bcms_blog/blog_comments/_form.html.erb

@@ -0,0 +1,5 @@
+<%= f.cms_drop_down :post_id, BcmsBlog::BlogPost.all(:order => "name").map{|p| [p.name, p.id]} %>
+<%= f.cms_text_field :author %>
+<%= f.cms_text_field :email %>
+<%= f.cms_text_field :url %>
+<%= f.cms_text_area :body %>

data/app/views/bcms_blog/blog_comments/render.html.erb

@@ -0,0 +1,2 @@
+<%= link_to h(@content_block.post.name), _blog_post_path(@content_block.post) %>
+<p><%=h @content_block.body.html_safe %></p>

data/app/views/{cms → bcms_blog}/blog_posts/_form.html.erb

@@ -7,5 +7,5 @@
 <% end %>
 <%= f.cms_drop_down :category_id, categories_for('Blog Post').map{|c| [c.path, c.id]}, :include_blank => true %>
 <%= f.cms_tag_list %>
-<%= f.cms_drop_down :blog_id, Blog.editable_by(current_user).map{|b| [b.name, b.id]} %>
+<%= f.cms_drop_down :blog_id, BcmsBlog::Blog.editable_by(current_user).map{|b| [b.name, b.id]} %>
 <%= f.cms_file_field :attachment_file, :label => "Image" %>