bcms_blog 1.0.0 → 1.1.0

data/db/migrate/20090415000000_create_blogs.rb

@@ -1,3 +1,15 @@
+require 'pp'
+
+Page # trigger auto-loading
+# At the time of this writing, these associations are missing :dependent => :destroy
+class Page
+  has_many :page_routes, :dependent => :destroy
+end
+class PageRoute
+  has_many :requirements, :class_name => "PageRouteRequirement", :dependent => :destroy
+  has_many :conditions,   :class_name => "PageRouteCondition",   :dependent => :destroy
+end
+
 class CreateBlogs < ActiveRecord::Migration
   def self.up
     create_versioned_table :blogs do |t|
@@ -5,28 +17,29 @@ class CreateBlogs < ActiveRecord::Migration
       t.string :format
       t.text :template
     end
-    ContentType.create!(:name => "Blog", :group_name => "Blog")
     
-    blog_page = Page.first(:conditions => {:path => "/"})
-      
-    Blog.create!(
-      :name => "My Blog",
-      :template => Blog.default_template,
-      :connect_to_page_id => blog_page.id,
-      :connect_to_container => "main",
-      :publish_on_save => true)
-      
-    blog_page.page_routes.create(
-      :name => "Blog Posts With Tag",
-      :pattern => "/articles/tag/:tag")
-      
-    blog_page.page_routes.create(
-      :name => "Blog Posts In Category", 
-      :pattern => "/articles/category/:category")
+    create_table :blog_group_memberships do |t|
+      t.integer :blog_id
+      t.integer :group_id
+    end
+    
+    ContentType.create!(:name => "Blog", :group_name => "Blog")
   end
 
   def self.down
-    ContentType.delete_all(['name = ?', 'Blog'])
+    puts "Destroying portlets, pages, page_routes..."
+    pp (portlets = BlogPostPortlet.all).map(&:connected_pages).flatten.each(&:destroy)
+    pp portlets.each(&:destroy)
+
+    #Blog.all.map(&:connected_pages).flatten.map(&:page_routes).flatten.each(&:destroy)
+    pp Blog.all.map(&:connected_pages).flatten.each(&:destroy)
+
+    ContentType.destroy_all(:name => "Blog")
+    Connector.destroy_all(:connectable_type => "Blog")
+
+    drop_table :blog_versions
     drop_table :blogs
+
+    drop_table :blog_group_memberships
   end
 end

data/db/migrate/20090415000001_create_blog_posts.rb

@@ -4,46 +4,21 @@ class CreateBlogPosts < ActiveRecord::Migration
       t.integer :blog_id
       t.integer :author_id
       t.integer :category_id
-      t.string :name 
+      t.string :name
       t.string :slug
-      t.text :summary 
+      t.text :summary
       t.text :body, :size => (64.kilobytes + 1)
       t.integer :comments_count
       t.datetime :published_at
     end
     CategoryType.create!(:name => "Blog Post")
     ContentType.create!(:name => "BlogPost", :group_name => "Blog")
-    
-    blog_post_page = Page.create!(
-      :name => "Blog Post", 
-      :path => "/blog/post", 
-      :section => Section.root.first,
-      :template_file_name => "default.html.erb")
-      
-    BlogPostPortlet.create!(
-      :name => "Blog Post Portlet",
-      :template => BlogPostPortlet.default_template,
-      :connect_to_page_id => blog_post_page.id,
-      :connect_to_container => "main",
-      :publish_on_save => true)
-      
-    route = blog_post_page.page_routes.build(
-      :name => "Blog Post",
-      :pattern => "/articles/:year/:month/:day/:slug",
-      :code => "@blog_post = BlogPost.published_on(params).with_slug(params[:slug]).first")
-    route.add_condition(:method, "get")
-    route.add_requirement(:year, '\d{4,}')
-    route.add_requirement(:month, '\d{2,}')
-    route.add_requirement(:day, '\d{2,}')
-    route.save!    
-    
-    
-      
   end
 
   def self.down
-    ContentType.delete_all(['name = ?', 'BlogPost'])
-    CategoryType.all(:conditions => ['name = ?', 'Blog Post']).each(&:destroy)
+    ContentType.destroy_all(:name => 'BlogPost')
+    CategoryType.destroy_all(:name => "Blog Post")
+
     drop_table :blog_post_versions
     drop_table :blog_posts
   end

data/db/migrate/20090415000002_create_blog_comments.rb

@@ -12,7 +12,8 @@ class CreateBlogComments < ActiveRecord::Migration
   end
 
   def self.down
-    ContentType.delete_all(['name = ?', 'BlogComment'])
+    ContentType.destroy_all(:name => 'BlogComment')
+    drop_table :blog_comment_versions
     drop_table :blog_comments
   end
 end

data/db/migrate/20090415000003_add_attachment_to_blog_posts.rb

@@ -0,0 +1,23 @@
+class AddAttachmentToBlogPosts < ActiveRecord::Migration
+  def self.up
+    change_table :blog_posts do |t|
+      t.belongs_to :attachment
+      t.integer :attachment_version
+    end
+    change_table :blog_post_versions do |t|
+      t.belongs_to :attachment
+      t.integer :attachment_version
+    end
+  end
+
+  def self.down
+    change_table :blog_posts do |t|
+      t.remove :attachment
+      t.remove :attachment_version
+    end
+    change_table :blog_post_versions do |t|
+      t.remove :attachment
+      t.remove :attachment_version
+    end
+  end
+end

data/db/migrate/20100521042244_add_moderate_comments_to_blog.rb

@@ -0,0 +1,10 @@
+class AddModerateCommentsToBlog < ActiveRecord::Migration
+  def self.up
+    add_content_column :blogs, :moderate_comments, :boolean, :default => true
+  end
+
+  def self.down
+    remove_column :blogs, :moderate_comments
+    remove_column :blog_versions, :moderate_comments
+  end
+end

data/doc/README_FOR_APP

@@ -0,0 +1,2 @@
+Use this README file to introduce your application and point to useful places in the API for learning more.
+Run "rake doc:app" to generate API documentation for your models, controllers, helpers, and libraries.

data/doc/migrate_to_20100427.rb

@@ -0,0 +1,77 @@
+# Ideally, we would create a new migration whenever we wanted to make changes to an existing
+# migration that is already in circulation, instead of simply editing the existing migrations
+# and publishing the new version, because doing rake db:migrate:redo VERSION=20090415000000,
+# etc. on each updated migration is not only a pain but will probably result in more data being
+# lost than is strictly necessary -- assuming the migrations work correctly at all.
+#
+# On the other hand, there's something pretty compelling about "fixing" the migration so that
+# it doesn't have any useless steps that are just going to get reverted by the next migration.
+#
+# There is also the problem of model dependencies: you can't safely remove a model in the same
+# commit that you use that model in a migration (f.e., Model.destroy_all). Even if you remove it
+# in the following commit, it's only safe if people check out every intermediate version and run
+# db:migrate at each version, instead of simply checking out the tip version and then running
+# db:migrate. And people don't do that.
+#
+# Anyway, I guess we assume that there are only a few brave souls out there who are already
+# using bcms_blog and hope for the best. Here is the "missing migration"; hopefully it will be
+# helpful to you.
+#
+# Run this script instead of re-running the changed migrations with rake db:migrate:redo so that
+# your blog data is not destroyed.
+#
+# Usage: ./script/runner 'require "/path/to/bcms_blog/doc/migrate_to_20100427.rb"'
+
+require 'pp'
+
+Page # trigger auto-loading
+# At the time of this writing, these associations are missing :dependent => :destroy
+class Page
+  has_many :page_routes, :dependent => :destroy
+end
+class PageRoute
+  has_many :requirements, :class_name => "PageRouteRequirement", :dependent => :destroy
+  has_many :conditions,   :class_name => "PageRouteCondition",   :dependent => :destroy
+end
+
+# Added these here because these classes will be removed by the next commit, so if anyone tried to run this script in future versions it would have a missing constant error unless we keep these class definitions around
+class BlogPostsInCategoryPortlet < Portlet; end
+class BlogPostsWithTagPortlet    < Portlet; end
+class BlogPostPortlet            < Portlet; end
+class BlogPostsInDayPortlet      < Portlet; end
+class BlogPostsInMonthPortlet    < Portlet; end
+class BlogPostsInYearPortlet     < Portlet; end
+
+class MigrateTo20100427 < ActiveRecord::Migration
+  def self.up
+    drop_table :blog_group_membership_versions
+
+    PageRouteOption.all.each {|a| a.destroy unless a.page_route }
+
+    puts "Destroying portlets, pages, page_routes left over from old version of bcms_blog..."
+    puts "(*Not* destroying any existing Blogs, pages on which Blogs are connected, or BlogPosts)"
+    portlets = [BlogPostPortlet, BlogPostsInCategoryPortlet, BlogPostsWithTagPortlet, BlogPostsInDayPortlet, BlogPostsInMonthPortlet, BlogPostsInYearPortlet]
+    #pp portlets.map(&:all).flatten.map(&:connected_pages).flatten.map(&:page_routes).flatten.each(&:destroy)
+    pp portlets.map(&:all).flatten.map(&:connected_pages).flatten.each(&:destroy)
+    pp portlets.map(&:all).flatten.each(&:destroy)
+
+    # Something like this might not work if they have moved their Blog page to a different section or to no section, so we better let users resolve this manually...
+    #Blog.all.map(&:connected_pages).flatten.each do |page|
+    #  page.hidden = true
+    #  page.save!
+    #  page.section.hidden = false
+    #  page.section.save!
+    #end
+
+    puts "Calling after_create on each Blog in the system..."
+    Blog.all.each do |blog|
+      puts "#{blog}..."
+      blog.send :after_create
+    end
+  end
+
+  def self.down
+  end
+end
+
+MigrateTo20100427.up

data/doc/release_notes.txt

@@ -0,0 +1,40 @@
+v1.1.0
+
+This version introduces significant changes and improvements over version 1.0.0
+and lays the groundwork for a more sophisticated blogging platform for BrowserCMS.
+
+Notable Features:
+=================
+
+1. A Blog and supporting structure (sections, pages, page routes, etc.) and data are no longer 
+   created as part of the modules's installation process. When running the module's migrations,
+   only the following items are created:
+   
+   * blogs, blog_posts and blog_comment tables (and corresponding tables to hold versioning data)
+   * blog_group_memberships table
+   * Blog, BlogPost and BlogComment content types
+   * Blog Post category type
+   
+2. It is only until a Blog is created when a corresponding section, pages, page routes and portlets are created.
+   Each blog has its own section, pages and page routes, which allows for multiple blogs to be created.
+
+3. It is now possible to add attachments to blog posts.
+
+4. Comments are moderated by default using BrowserCMS' default behaviors. However, when creating a Blog,
+   users can specify whether comments should be published automatically.
+   
+5. The module now uses BrowserCMS' permissions framework to specify if a particular user is able to
+   create or edit Blogs and BlogPosts.
+
+6. Portlets have been improved to match common standard blog publishing templates.
+
+For a complete rundown and rationale behind the changes introduced, please refer to:
+https://browsermedia.lighthouseapp.com/projects/28481/tickets/163-review-and-integrate-changes-to-the-blog-module
+
+Contributors:
+=============
+Tyler Rick
+Jon Leighton
+
+
+v1.0.0

data/lib/bcms_blog/routes.rb

@@ -1,5 +1,8 @@
 module Cms::Routes
   def routes_for_bcms_blog
+    
+    blog_feeds '/blog/feeds', :controller => "feeds", :format => "rss"
+    
     namespace(:cms) do |cms|      
       cms.content_blocks :blogs
       cms.content_blocks :blog_posts

data/rails/init.rb

@@ -1,3 +1,8 @@
 gem_root = File.expand_path(File.join(File.dirname(__FILE__), ".."))
 Cms.add_to_rails_paths gem_root
-Cms.add_generator_paths gem_root, "db/migrate/[0-9]*_*.rb"
+Cms.add_generator_paths gem_root, "db/migrate/[0-9]*_*.rb"
+ApplicationHelper.module_eval { include Cms::BlogHelper }
+
+config.after_initialize do
+  ActiveRecord::Base.observers << BlogObserver
+end

data/test/factories.rb

@@ -1,3 +1,49 @@
+Factory.define :category_type do |m|
+  m.name "Blog Post"
+end
+
+Factory.define :group do |m|
+  m.sequence(:name) {|n| "TestGroup#{n}" }
+  m.association :group_type
+end
+
+Factory.define :group_type do |m|
+  m.sequence(:name) {|n| "TestGroupType#{n}" }
+end
+
+Factory.define :permission do |m|
+  m.name "edit_content"
+end
+
+Factory.define :user do |m|
+  m.first_name "Test"
+  m.last_name "User"
+  m.sequence(:login) {|n| "test_#{n}" }
+  m.email {|a| "#{a.login}@example.com" }
+  m.password "password"
+  m.password_confirmation {|a| a.password }
+end
+
+Factory.define :section do |m|
+  m.name "A Section"
+  m.path "/a-section"
+end
+
 Factory.define :blog do |m|
   m.sequence(:name) {|n| "TestBlog#{n}"}
-end
+  m.moderate_comments true
+end
+
+Factory.define :blog_post do |m|
+  m.sequence(:name) { |n| "BlogPost#{n}" }
+  m.blog {|b| b.association(:blog) }
+  m.sequence(:body) { |n| "Lorem ipsum #{n}" }
+  m.association :author, :factory => :user
+end
+
+Factory.define :blog_comment do |m|
+  m.name "Just a comment"
+  m.body "Nice blog"
+  m.association :post, :factory => :blog_post
+  m.association :author, :factory => :user
+end

data/test/functional/blog_post_test.rb

@@ -5,31 +5,33 @@ class BlogPostTest < ActionController::TestCase
   
   def setup
     create_baseline_data
-    @blog_post_portlet = BlogPostPortlet.create!(:name => "Blog Post Portlet",
-      :template => BlogPostPortlet.default_template,
-      :connect_to_page_id => @blog_post_page.id,
-      :connect_to_container => "main",
-      :publish_on_save => true)
   end
-  
+
+=begin  
   def test_show_post
-    get :show_page_route, :_page_route_id => @blog_post_route.id.to_s,
-      :year => @first_post.year,
-      :month => @first_post.month,
-      :day => @first_post.day,
-      :slug => @first_post.slug
-    #log @response.body
+    get :show, :path => ["myblog"],
+               :year => 2008,
+               :month => 07,
+               :day => 05
+    log @response.body
     assert_response :success
     assert_select "title", @first_post.name
     assert_select ".blog_post", 1
-
+  
     assert_select "#blog_post_#{@first_post.id}" do
-      assert_select "h2 a", "First Post"
-      assert_select "p.body", "Yadda Yadda Yadda"
+      assert_select "h2 a", @first_post.name
+      assert_select "p.body", @first_post.body
       assert_select "p.meta a", "General"
       assert_select "p.meta a", "0 Comments"
     end
-    
+  end
+=end
+  
+  def test_non_existent_slug_should_return_404
+    get :show, :path => ["blog", "post"],
+      :year => 2005, :month => 6, :day => 14,
+      :slug => "not-here"
+    assert_response :not_found
   end
   
-end
+end

data/test/functional/blog_test.rb

@@ -6,40 +6,62 @@ class BlogTest < ActionController::TestCase
   def setup
     create_baseline_data
   end
-  
-  def test_list_of_blog_posts
-    get :show, :paths => ["/"]
-    #log @response.body
-    assert_response :success
-    assert_select ".blog_post", 5
-    
-    assert_select "#blog_post_#{@first_post.id}" do
-      assert_select "h2 a", "First Post"
-      assert_select "p.body", "Yadda Yadda Yadda"
-      assert_select "p.meta a", "General"
-      assert_select "p.meta a", "0 Comments"
-    end
-    
-    assert_select "#blog_post_#{@foo_post_1.id}" do
-      assert_select "h2 a", "Foo #1"
-      assert_select "p.body", "Foo 1 Foo 1 Foo 1"
-      assert_select "p.meta .tags a", "foo"
-      assert_select "p.meta .tags a", "stuff"
+
+=begin
+  test "displays the list of blog posts" do
+     get :show, :path => ['myblog']
+      log @response.body
+      assert_response :success
+      assert_select ".blog_post", 5
+      
+      assert_select "#blog_post_#{@first_post.id}" do
+        assert_select "h2 a", @first_post.name
+        assert_select "p.body", @first_post.body
+        assert_select "p.meta a", "General"
+        assert_select "p.meta a", "0 Comments"
+      end
+      
+      assert_select "#blog_post_#{@foo_post_1.id}" do
+        assert_select "h2 a", @foo_post_1.name
+        assert_select "p.body", @foo_post_1.body
+        assert_select "p.meta .tags a", "foo"
+        assert_select "p.meta .tags a", "stuff"
+      end
     end
-  end
   
   def test_list_of_tagged_blog_posts
-    get :show, :paths => ["/"], :category => "General"
-    #log @response.body
+    get :show, :category => "General"
+    puts @response.body
     assert_response :success
     assert_select ".blog_post", 3
   end
   
   def test_list_of_categorized_blog_posts
-    get :show, :paths => ["/"], :tag => "foo"
-    #log @response.body
+    get :show, :tag => "foo"
+    assert_response :success
+    assert_select ".blog_post", 2
+  end
+  
+  def test_list_of_blog_posts_in_day
+    get :show, :path => ["blog", "posts_in_day"],
+        :year => 2008, :month => 7, :day => 5
     assert_response :success
     assert_select ".blog_post", 2
   end
   
-end
+  def test_list_of_blog_posts_in_month
+    get :show, :path => ["blog", "posts_in_month"],
+               :year => 2008, :month => 7
+    assert_response :success
+    assert_select ".blog_post", 3
+  end
+  
+  def test_list_of_blog_posts_in_year
+    get :show, :path => ["blog", "posts_in_year"],
+        :year => 2008
+    assert_response :success
+    assert_select ".blog_post", 4
+  end
+=end
+
+end

data/test/functional/cms/blog_posts_controller_test.rb

@@ -0,0 +1,44 @@
+require File.dirname(__FILE__) + '/../../test_helper'
+
+class Cms::BlogPostsControllerTest < ActionController::TestCase
+  def setup
+    setup_stubs
+    ContentType.create!(:name => 'BlogPost', :group_name => 'Blog')
+    login_as(_create_user)
+  end
+
+  def test_access_denied_on_create_if_blog_not_user_editable
+    @editable = Factory(:blog, :groups => [@group])
+    @non_editable = Factory(:blog)
+    post :create, :blog_post => { :blog_id => @non_editable.id }
+    assert @response.body.include?("Access Denied")
+  end
+  
+  def test_access_denied_on_update_if_blog_not_user_editable
+    @editable = Factory.create(:blog, :groups => [@group])
+    @non_editable = Factory.create(:blog)
+    @blog_post = Factory.create(:blog_post, :blog => @non_editable)
+    put :update, :id => @blog_post, :blog_post => { :name => "Foo" }
+    assert @response.body.include?("Access Denied")
+   end
+   
+   def test_no_access_if_no_editable_blogs
+     @blog = Factory.create(:blog)
+     get :index
+     assert_template "no_access"
+   end
+   
+   def test_index_shouldnt_show_non_editable_posts
+     @editable = Factory.create(:blog, :groups => [@group])
+     @non_editable = Factory.create(:blog)
+     @blog_post = Factory.create(:blog_post, :name => "Non-editable", :blog => @non_editable)
+     get :index
+     assert !@response.body.include?("Non-editable")
+   end
+   
+   def test_create_sets_author
+     @blog = Factory.create(:blog, :groups => [@group])
+     post :create, :blog_post => { :blog_id => @blog.id }
+     assert_equal @user, assigns(:block).author
+   end
+end

data/test/functional/cms/blogs_controller_test.rb

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + '/../../test_helper'
+
+class Cms::BlogsControllerTest < ActionController::TestCase
+  
+  def setup
+    setup_stubs
+    ContentType.create!(:name => 'Blog', :group_name => 'Blog')
+    Factory(:blog)
+  end
+  
+  test "should allow access to admin users" do
+    login_as(_create_user(:admin => true))
+    get :index
+    assert_response :success
+    assert assigns(:blocks)
+    assert_template("index")
+  end
+  
+  test "should not allow access to non-admin users" do
+    login_as(_create_user)
+    get :index
+    assert_response :success
+    assert_template("admin_only.html.erb")    
+  end
+end

data/test/functional/feeds_controller_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class FeedsControllerTest < ActionController::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end