tylerrick-bcms_blog 1.0.5 → 1.0.6

data/README.markdown

@@ -1,6 +1,6 @@
 # Blog Module for BrowserCMS
 
-A simple blog module that lets you create one or more blogs. It features:
+A simple blog module that lets you create one or more blogs and integrate them into your site. It features:
 
 * Blog posts can be tagged and categorized
 * The ability for users to leave comments on a blog post (stores the user name, email, url and comment)
@@ -16,9 +16,9 @@ This assumes you have the latest copy of the code from github on your machine.
         gem build bcms_blog.gemspec
         sudo gem install bcms_blog-1.x.x.gem
 
-At this point, the Page Comments gem should be installed as a gem on your system, and can be added to your projects.
+At this point, the BrowserCMS Blog gem should be installed as a gem on your system, and can be added to your projects.
 
-### B. Adding the Page Comments to your project
+### B. Adding the module to your project
 In your BrowserCMS application, do the following steps.
 
 #### 1. Edit the confing/environment.rb file
@@ -26,12 +26,12 @@ In your BrowserCMS application, do the following steps.
 		config.gem 'browsercms'
 
 		# Add this next line after the browsercms gem
-		config.gem "bcms_page_comments"
+		config.gem "bcms_blog"
 
 #### 2. Edit the routes.rb file
 
 		# Add this route. It must be before the core browser_cms route.
-		map.routes_for_bcms_page_comments
+		map.routes_for_bcms_blog
 		map.routes_for_browser_cms
 
 #### 3. Install the new module code
@@ -47,17 +47,23 @@ Modules will often add new data types, like content blocks, so you need to run t
 		rake db:migrate
 		script/server
 
-#### 5. Create a Comments portlet and embed into your templates
-* Open your browser to localhost:3000/cms/portlets and login 
-* Click 'Add New Content', and select 'Page Comments Portlet'
-* Set the name to 'Page Comments' and click save.
-* Now go to Administration -> Page Templates -> Sub Page -> Edit
-* Add the following line to your template, somewhere in the body (preferably after your main content area)
-
-		<%= render_portlet "Page Comments" %>
-
-This will render embed the portlet named "Page Comments" into any page which uses the Sub Page template. 
-
-* Now add a new page using the "Sub Page" template and you should see the comments form. Adding a new comment will display on that page.
-
-
+#### 5. Create a Blog content block and embed it into your templates
+* Open your browser to http://localhost:3000/cms/blogs and log in
+* Click 'Add New Content', choose a name for your blog (for example, "Blog"), and click Save and Publish
+* This will automatically create a new page named after the name of your blog and add your blog to it (you can delete this new page and add your Blog block to an existing page if you would rather)
+* Now go to Blog Post, click 'Add New Content', and fill out the other fields to create your first post for your new blog.
+* Don't forget that your new blog page won't appear in the menus until you publish the page. If you go to the Dashboard and look under Page Drafts, you will see that you can publish your new page there.
+* You can navigate to your blog page using your site's main navigation menu (if you have one) or by going to the Sitemap and looking for a page with the name that you selected for your blog.
+
+## Customization
+
+### blog_post partial
+
+* If you want to customize the way your blog posts are displayed, you can override the partial by copying this file from the gem to your application's directory and making changes to it: app/views/partials/_blog_post.html.haml or app/views/partials/_blog_post.html.erb (depending on if you prefer haml or erb)
+* (You can run `gem which bcms_blog` to figure out where the bcms_blog files are located on your system.)
+  `app/views/partials/_blog_post.html.haml` or `app/views/partials/_blog_post.html.erb` (depending on if you prefer haml or erb templates)
+* Example:
+        # cp /var/lib/gems/1.9.1/gems/bcms_blog-1.0.5/app/views/partials/_blog_post.html.erb app/views/partials/
+* Keep in mind that the same partial is used both on the main blog page (which lists all posts) and on the blog post page (that shows a single post)
+    * If you want something to only show up on the blog post page, you can enclose your markup within a `if showing_individual_post`
+    * If you want something to only show up on the main blog page, you can enclose your markup within a `if !showing_individual_post`

data/app/models/blog.posts_finder.rb

@@ -0,0 +1,155 @@
+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
+
+  validates_presence_of :name
+  validates_uniqueness_of :name
+
+  named_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, "cms/blogs/render.html.erb")
+    end.detect{|f| File.exists? f }
+    template_file ? open(template_file){|f| f.read } : ""
+  end
+
+  def self.posts_finder(options)
+    finder = @blog.posts.published
+
+    if params[:category]
+      @category_type = CategoryType.named("Blog Post").first
+      @category = @category_type.categories.named(params[:category]).first
+      finder = finder.in_category(@category)
+    elsif params[:tag]
+      finder = finder.tagged_with(params[:tag])
+    elsif 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
+
+    finder
+  end
+
+  def render
+    @blog = self
+    finder = Blog.posts_finder(params)
+
+    @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
+
+protected
+  def after_create
+    section = Section.find_by_name(name) || (
+      section = Section.create!(
+        :name => name,
+        :path => "/#{name_for_path}",
+        :parent_id => 1
+      )
+      section.groups << Group.find_by_code("cms-admin")
+      section.groups << Group.find_by_code("guest")
+      section.groups << Group.find_by_code("content-editor")
+      section.save!
+      section
+    )
+
+    page = Page.find_by_name(name) || Page.create!(
+      :name => name,
+      :path => "/#{name_for_path}",
+      :section => section,
+      :template_file_name => "default.html.erb",
+      :hidden => true
+    )
+    page.create_connector(self, 'main')
+    create_route(page, "#{name}: Posts In Day",      "/#{name_for_path}/:year/:month/:day")
+    create_route(page, "#{name}: Posts In Month",    "/#{name_for_path}/:year/:month")
+    create_route(page, "#{name}: Posts In Year",     "/#{name_for_path}/:year")
+    create_route(page, "#{name}: Posts With Tag",    "/#{name_for_path}/tag/:tag")
+    create_route(page, "#{name}: Posts In Category", "/#{name_for_path}/category/:category")
+
+    page = Page.find_by_name(portlet_name = "#{name}: Post") || Page.create!(
+      :name => portlet_name,
+      :path => "/#{name_for_path}/post",
+      :section => section,
+      :template_file_name => "default.html.erb",
+      :hidden => true)
+    page.publish
+    create_route(  page, portlet_name, "/#{name_for_path}/:year/:month/:day/:slug")
+    create_portlet(page, portlet_name, BlogPostPortlet)
+
+    # FIXME: This takes about 5 seconds to run, which is probably too long.
+    # Solution: Disable PageRoute's after_save :reload_routes and add this to the end here:
+    # ActionController::Routing::Routes.load!
+  end
+
+  def create_route(page, name, pattern)
+    route = page.page_routes.build(:name => name, :pattern => pattern, :code => "")
+    route.add_condition(:method, "get")
+    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.save!
+  end
+
+  def create_portlet(page, name, portlet_class)
+    portlet_class.create!(
+      :name => "#{name} Portlet",
+      :blog_id => self.id,
+      :template => portlet_class.default_template,
+      :connect_to_page_id => page.id,
+      :connect_to_container => "main",
+      :publish_on_save => true)
+  end
+end

data/app/models/blog.rb

@@ -1,13 +1,13 @@
 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
-  
+
   validates_presence_of :name
   validates_uniqueness_of :name
-  
+
   named_scope :editable_by, lambda { |user|
     if user.able_to?(:administrate)
       { }
@@ -15,64 +15,82 @@ class Blog < ActiveRecord::Base
       { :include => :groups, :conditions => ["groups.id IN (?)", user.group_ids.join(",")] }
     end
   }
-  
+
   def self.default_template
-    template_file = ActionController::Base.view_paths.map do |vp| 
+    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, "cms/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[:tags]
+      finder = finder.tagged_with(options[:tags])
+    end
+    if options[:exclude_tags]
+      finder = finder.not_tagged_with(options[:exclude_tags])
+    end
+    if options[:category] || options[:category_id]
+      category_type = 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[:category]
-      @category_type = CategoryType.named("Blog Post").first
-      @category = @category_type.categories.named(params[:category]).first
-      finder = finder.in_category(@category)
-      @page_title = "Posts in category #{params[:category]}"
-    elsif params[:tag]
-      finder = finder.tagged_with(params[:tag])
-      @page_title = "Posts tagged with #{params[:tag]}"
-    elsif params[:year] && params[:month] && params[:day]
+    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)
-      @page_title = "Blog posts from #{@date.to_s(:long)}"
     elsif params[:year] && params[:month]
       @date = Date.new(params[:year].to_i, params[:month].to_i)
       finder = posts.published_between(@date, @date + 1.month)
-      @page_title = "Blog posts from #{Date::MONTHNAMES[@date.month]} #{@date.year}"
     elsif params[:year]
       @date = Date.new(params[:year].to_i)
       finder = posts.published_between(@date, @date + 1.year)
-      @page_title = "Blog posts from #{@date.year}"
     end
 
-    @blog_posts = finder.all(:limit => 25, :order => "published_at desc") 
+    @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
@@ -139,5 +157,4 @@ protected
       :connect_to_container => "main",
       :publish_on_save => true)
   end
-
 end

data/app/models/blog_post.rb

@@ -32,6 +32,18 @@ class BlogPost < ActiveRecord::Base
          start, finish ] }
   }
 
+  named_scope :not_tagged_with, lambda { |tag| {
+    :conditions => [
+      "blog_posts.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"

data/app/portlets/blog_post_portlet.rb

@@ -1,6 +1,6 @@
 class BlogPostPortlet < Portlet
-  render_inline false
-  enable_template_editor false
+  #render_inline false
+  #enable_template_editor false
 
   def render
     scope = Blog.find(self.blog_id).posts

data/app/portlets/blog_posts_portlet.rb

@@ -0,0 +1,50 @@
+class BlogPostsPortlet < Portlet
+  def after_initialize
+    self.render_blog_post_code ||= 'truncate(blog_post.name, 30)'
+  end
+
+  # Mark this as 'true' to allow the portlet's template to be editable via the CMS admin UI.
+  enable_template_editor false
+
+  def render(_options = {})
+    # Since we can't pass any options to render_portlet, you can use $blog_posts_portlet_options if you want to pass in/override some options
+    # This is an ugly workaround for https://browsermedia.lighthouseapp.com/projects/28481-browsercms-30/tickets/350-make-it-possible-to-pass-options-to-render_portletrender_connectable in case we want to call render_portlet with some options
+    _options = $blog_posts_portlet_options || {}
+    _options.symbolize_keys!
+
+    portlet_attributes = self.portlet_attributes.inject({}) {|hash, a| hash[a.name] = a.value; hash}.reject {|k,v| v.blank?}.symbolize_keys
+
+    #options.reverse_merge!(params.slice(:tags)).symbolize_keys!
+    @options = portlet_attributes.merge(_options)
+    Rails.logger.debug "... BlogPostsPortlet#render(options=#{@options.inspect} #{@options.class})"
+
+    if @options[:blog_id]
+      finder = Blog.find(@options[:blog_id]).posts
+    elsif @options[:blog_name]
+      finder = Blog.find_by_name(@options[:blog_name]).posts
+    else
+      finder = BlogPost
+    end
+
+    if @options[:tags].is_a?(Array) && @options[:tags].size > 1
+      other_tags = @options[:tags][1..-1]
+      @options[:tags] = @options[:tags][0]
+    end
+
+    finder = finder.published
+    finder = Blog.posts_finder(finder, @options)
+
+    @blog_posts = finder.all(
+      :limit => @options[:limit] || 25,
+      :order => "published_at desc"
+    )
+
+    if other_tags
+      @blog_posts.select! {|p| (p.tags.map(&:name).map(&:downcase) & other_tags.map(&:downcase)).size == other_tags.size }
+    end
+
+    raise ActiveRecord::RecordNotFound.new("No articles found") if @blog_posts.empty?
+
+    @portlet = self
+  end
+end

data/app/views/portlets/blog_post/_form.html.erb

@@ -1,3 +1,3 @@
 <%= f.cms_text_field :name %>
 <%= f.cms_drop_down :blog_id, Blog.all.map{|b| [b.name, b.id.to_s]} %>
-<%= f.cms_text_area :template, :default_value => @block.class.default_template %>
+<%# f.cms_text_area :template, :default_value => @block.class.default_template %>

data/app/views/portlets/blog_posts/_form.html.erb

@@ -0,0 +1,13 @@
+<%= f.cms_text_field :name, :label => 'Portlet Name', :instructions => 'Since we may have many Articles portlets, each with different parameters, give each portlet a descriptive name.' %>
+
+<%= f.cms_drop_down :blog_id, Blog.all.map{|b| [b.name, b.id.to_s]}, :include_blank => true, :label => "Show posts from", :instructions => 'Leave blank to include posts from all blogs' %>
+<%# f.cms_drop_down :show_posts_as, [['First post as full post, the rest as Summary + Read More link', 'first_full_post_others_summary'], ['Summary + Read More link', 'summary'], ['Full post', 'full_post'], ['Title (links to post)', 'link']] %>
+<%= f.cms_drop_down :show_posts_as, [['Title (links to post)', 'link'], ['Post', 'post']] %>
+<%= f.cms_check_box :show_full_posts %>
+<%= f.cms_drop_down :category_id, categories_for('Blog Post').map{|c| [c.path, c.id]}, :include_blank => true, :label => "Only posts in category" %>
+<%= f.cms_tag_list :label => "Only posts with tags", :instructions => 'Separate tags with spaces' %>
+<%= f.cms_text_field :exclude_tags, :label => 'Exclude posts with tags' %>
+<%= f.cms_text_field :limit, :label => 'Limit' %>
+<%= f.cms_text_area :render_blog_post_code, :label => 'Code to turn blog_post into link text' %>
+
+<%= f.cms_template_editor :template %>

data/app/views/portlets/blog_posts/render.html.haml

@@ -0,0 +1,9 @@
+- if @portlet.show_posts_as == 'post'
+  = render :partial => '/partials/blog_post', :collection => @blog_posts, :locals => {:show_full_posts => @options[:show_full_posts]}
+- elsif @portlet.show_posts_as == 'link'
+  %ul.blog_posts
+    - for blog_post in @blog_posts
+      - text = @portlet.render_blog_post_code.present? ? eval(@portlet.render_blog_post_code) : text = truncate(blog_post.name, 30)
+      %li= link_to text, _blog_post_path(blog_post)
+- else
+  Unrecognized option '#{@portlet.show_posts_as}' for @portlet.show_posts_as

data/doc/migrate_to_20100427.rb

@@ -34,6 +34,14 @@ class PageRoute
   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
@@ -45,6 +53,7 @@ class MigrateTo20100427 < ActiveRecord::Migration
     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|

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: tylerrick-bcms_blog
 version: !ruby/object:Gem::Version 
-  version: 1.0.5
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 6
+  version: 1.0.6
 platform: ruby
 authors: 
 - BrowserMedia
@@ -9,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-29 00:00:00 -07:00
+date: 2010-05-18 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -28,11 +33,13 @@ files:
 - app/controllers/cms/blogs_controller.rb
 - app/helpers/application_helper.rb
 - app/helpers/cms/blog_helper.rb
+- app/models/blog.posts_finder.rb
 - app/models/blog.rb
 - app/models/blog_comment.rb
 - app/models/blog_group_membership.rb
 - app/models/blog_post.rb
 - app/portlets/blog_post_portlet.rb
+- app/portlets/blog_posts_portlet.rb
 - app/views/cms/blog_comments/_form.html.erb
 - app/views/cms/blog_comments/render.html.erb
 - app/views/cms/blog_posts/_form.html.erb
@@ -45,6 +52,8 @@ files:
 - app/views/partials/_blog_post.html.haml
 - app/views/portlets/blog_post/_form.html.erb
 - app/views/portlets/blog_post/render.html.erb
+- app/views/portlets/blog_posts/_form.html.erb
+- app/views/portlets/blog_posts/render.html.haml
 - db/migrate/20090415000000_create_blogs.rb
 - db/migrate/20090415000001_create_blog_posts.rb
 - db/migrate/20090415000002_create_blog_comments.rb
@@ -55,6 +64,16 @@ files:
 - lib/bcms_blog/routes.rb
 - rails/init.rb
 - README.markdown
+- test/test_helper.rb
+- test/factories.rb
+- test/test_logging.rb
+- test/performance/browsing_test.rb
+- test/unit/blog_post_test.rb
+- test/unit/blog_test.rb
+- test/functional/blog_post_test.rb
+- test/functional/blog_test.rb
+- test/functional/cms/blogs_controller_test.rb
+- test/functional/cms/blog_posts_controller_test.rb
 has_rdoc: true
 homepage: http://browsercms.org
 licenses: []
@@ -65,21 +84,25 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: browsercms
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: The Blog Module for BrowserCMS