spree_cms 0.0.3

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in how_are_we_doing.gemspec
+gemspec

data/README.markdown

@@ -0,0 +1,108 @@
+Spree on CMS
+=========
+
+A blog / static page extension for Spree version 10.x. Spree admin users can create blog posts and static pages.  The extension extends the admin interface to allow the adding of display names to users that will be displayed on blog posts.
+
+Comments on blog posts are currently powered by [Disqus](http://disqus.com/comments/).  The comment system and/or comments on individual blog posts can be disabled, if preferred.
+
+The extension provides basic views and a stylesheet that can easily be overridden through your site extension.  Also, several helpers exist to allow tags, posts and pages to be accesible in your site views.
+
+Installation
+------------
+
+    script/extension install git://github.com/jacobwg/spree-cms.git
+    rake gems:install
+    rake db:migrate
+
+All authors for the blog should be given a display name in the admin/users edit form. 
+
+Edit preferences in cms_extension.rb (Disqus site name if you are using Disqus)
+
+All done!
+
+Setup
+------
+
+in cms_extension.rb add your disqus account identifier if you plan to use comments.
+
+You can edit the preferences in the extension.rb file or in the http://localhost:3000/admin/cms_settings ui.
+
+The blog home slug requires a server restart so it can only be edited in the extension file.
+
+Posts
+-------
+
+New Posts can be created in the admin section http://localhost:3000/admin/posts
+
+Posts have unique permalinks created for all new post entries. The permalink can be modified after initial save.
+
+RedCloth is used for post formatting.
+
+is_taggable gem is used for adding tags to each post. A helper linked_tag_list is provided to display a list of the link tags to filter by.
+
+
+Comments
+--------
+
+Comments can be opened or closed for a post.  The comment form displays on the post page when enabled for the specific post.
+
+Comments are now managed by Disqus via the disqus gem, http://github.com/norman/disqus/. Management of spam and comment moderation is done through the Disqus UI.
+
+Create disqus account at [http://disqus.com/comments/](http://disqus.com/comments/).  
+
+
+Blog
+-----
+
+View the blog at http://localhost:3000/blog or the defined slug from the preferences.
+
+Use helper post_link_list(limit) to get a list of recent post links.
+
+Views are in folder extension/app/views/posts
+
+
+RSS
+-----
+
+http://localhost:3000/blog.rss - All Posts
+
+Customize RSS feed in extension/app/views/posts/index.rss.builder
+
+
+Pages
+-----
+
+Under Admin section add pages for static-content (http://localhost:3000/admin/pages).
+
+Use helper page_link() to print a link to page, based on ID or Permalink.
+
+Pages are displayed by the content route provided by Spree core. Customize the extension/app/views/content/show.html.erb file.
+
+
+
+Tips
+--------
+
+You can add a blog link anywhere on your site or include the recent_articles partial.
+
+One option is to add the Blog link to the store_menu partial
+
+    <li><%= link_to t('blog'), posts_path %></li>
+
+Use the cms_content_for partial to include the cms css and recent articles partial in the sidebar.
+
+    <%= render :partial => 'shared/cms_content_for'%>
+
+
+
+TODO
+-----
+
+- improve permalinks for posts
+- wysiwyg editor for blog posts and pages.
+
+
+Credits
+-------
+
+Based on spree-wordsmith created by [Matt Anderson](http://tonkapark.com/)

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/app/controllers/admin/cms_settings_controller.rb

@@ -0,0 +1,11 @@
+class Admin::CmsSettingsController < Admin::BaseController
+
+  def update
+    Spree::Config.set(params[:preferences])
+    
+    respond_to do |wants|
+      wants.html { redirect_to admin_cms_settings_path }
+    end
+  end
+  
+end 

data/app/controllers/admin/pages_controller.rb

@@ -0,0 +1,54 @@
+class Admin::PagesController < Admin::BaseController
+  resource_controller :except => [:show]
+  
+  
+  index.response do |wants|
+    wants.html { render :action => :index }
+    wants.json { render :json => @collection.to_json()  }
+  end
+  
+  new_action.response do |wants|
+    wants.html {render :action => :new, :layout => false}
+  end
+  
+  create.before :create_before
+
+  create.response do |wants|
+    # go to edit form after creating as new page
+    wants.html {redirect_to edit_admin_page_url(Page.find(@page.id)) }
+  end
+
+  update.response do |wants|
+    # override the default redirect behavior of r_c
+    # need to reload Page in case name / permalink has changed
+    wants.html {redirect_to edit_admin_page_url(Page.find(@page.id)) }
+  end
+  
+  private
+    def collection
+
+      unless request.xhr?
+        # Note: the SL scopes are on/off switches, so we need to select "not_deleted" explicitly if the switch is off
+        # QUERY - better as named scope or as SL scope?
+        #if params[:search].nil? || params[:search][:deleted_at_not_null].blank?
+        #  base_scope = base_scope.not_deleted
+        #end
+
+        @search = Page.search(params[:search])
+        @search.order ||= "ascend_by_title"
+
+        @collection = @search.paginate(:page => params[:page])
+      else
+        @collection = Page.title_contains(params[:q]).all(:include => includes, :limit => 10)
+        @collection.uniq!
+      end
+
+    end
+    
+    # set the default published and comment status if applicable
+    def create_before
+      return unless Spree::Config[:cms_page_status_default]
+      @page.is_active = Spree::Config[:cms_page_status_default]
+    end
+    
+end

data/app/controllers/admin/posts_controller.rb

@@ -0,0 +1,55 @@
+class Admin::PostsController < Admin::BaseController
+  resource_controller :except => [:show]
+
+  index.response do |wants|
+    wants.html { render :action => :index }
+    wants.json { render :json => @collection.to_json()  }
+  end
+  
+  new_action.response do |wants|
+    wants.html {render :action => :new, :layout => false}
+  end
+  
+  create.before :create_before
+
+  create.response do |wants|
+    # go to edit form after creating as new post
+    wants.html {redirect_to edit_admin_post_url(Post.find(@post.id)) }
+  end
+
+  update.response do |wants|
+    # override the default redirect behavior of r_c
+    # need to reload Post in case name / permalink has changed
+    wants.html {redirect_to edit_admin_post_url(Post.find(@post.id)) }
+  end
+
+  private
+  
+    def collection
+
+      unless request.xhr?
+        # Note: the SL scopes are on/off switches, so we need to select "not_deleted" explicitly if the switch is off
+        # QUERY - better as named scope or as SL scope?
+        #if params[:search].nil? || params[:search][:deleted_at_not_null].blank?
+        #  base_scope = base_scope.not_deleted
+        #end
+
+        @search = Post.search(params[:search])
+        @search.order ||= "ascend_by_title"
+
+        @collection = @search.paginate( :page  => params[:page] )
+      else
+        @collection = Post.title_contains(params[:q]).all(:include => includes, :limit => 10)
+        @collection.uniq!
+      end
+
+    end
+    
+    # set the default published and comment status if applicable
+    def create_before
+      return unless Spree::Config[:cms_post_status_default] || Spree::Config[:cms_post_comment_default]
+      @post.is_active = Spree::Config[:cms_post_status_default]
+      @post.commentable = Spree::Config[:cms_post_comment_default]
+    end
+  
+end 

data/app/controllers/pages_controller.rb

@@ -0,0 +1,4 @@
+class PagesController < Spree::BaseController  
+  resource_controller
+  actions :show, :index
+end 

data/app/controllers/posts_controller.rb

@@ -0,0 +1,26 @@
+class PostsController < Spree::BaseController  
+
+  resource_controller
+  actions :show, :index
+
+  index.response do |wants|
+    wants.html
+    wants.rss
+  end
+    
+  def tags
+      @posts = Post.publish.find_all_tagged_with(params[:tag_name]).paginate :page => params[:page]    
+  end
+    
+private
+  def collection
+    @collection ||= end_of_association_chain.publish.paginate :page => params[:page]
+  end
+  
+  #def object
+  #  @object ||= end_of_association_chain.publish.find(param) unless param.nil?
+  #  @object
+  #end
+
+
+end 

data/app/helpers/cms_helper.rb

@@ -0,0 +1,21 @@
+module CmsHelper 
+  
+  def linked_tag_list(tags)
+    tags.collect {|tag| link_to(tag.name, tag_posts_url(:tag_name => tag.name ))}.join(", ")
+  end
+  
+  def post_link_list(limit = Spree::Config[:cms_posts_recent])
+    link = Struct.new(:name,:url)
+    Post.publish.limit(limit).collect { |post| link.new(post.title, post_path(post)) }
+  end
+  
+  def page_link(id)
+    if id.kind_of?(String)  
+      page = Page.publish.find_by_permalink(id)
+    elsif id.kind_of?(Fixnum)
+      page = Page.publish.find(id)
+    end
+    link_to page.title, page.link unless page.nil?
+  end
+  
+end 

data/app/models/page.rb

@@ -0,0 +1,38 @@
+class Page < ActiveRecord::Base
+
+  before_validation :format_markup
+  before_validation :published
+
+  validates_presence_of :title, :message => 'required'
+  validates_presence_of :body, :message => 'required'
+  validates_uniqueness_of :permalink 
+  
+  make_permalink :with => :title
+  
+  scope :publish, where('published_at < ? and is_active = ?', Time.zone.now, 1)
+
+  def to_param
+    return permalink unless permalink.blank?
+    title.to_url
+  end
+  
+  def format_markup
+    if not self.body_raw.nil?
+      self.body = RedCloth.new(self.body_raw,[:sanitize_html, :filter_html]).to_html
+    end
+  end
+  
+  def published
+    #self.published_at ||= Time.now unless self.is_active == 0
+    if self.is_active == 0
+      if !self.published_at.blank?
+        self.published_at = nil
+      end
+    else
+      if self.published_at.blank?
+        self.published_at = Time.now
+      end
+    end
+  end
+
+end

data/app/models/post.rb

@@ -0,0 +1,73 @@
+class Post < ActiveRecord::Base
+  cattr_reader :per_page
+  @@per_page = Spree::Config[:cms_posts_per_page]
+  #attr_accessible :user_id, :title, :body_raw, :published_at, :is_active, :permalink, :tag_list, :excerpt, :commentable, :meta_keywords, :meta_description
+
+  is_taggable :tags
+  
+  belongs_to :user
+  
+  before_validation :format_markup
+  #before_validation :generate_permalink
+  before_validation :published
+  
+  make_permalink :with => :title
+   
+  validates_presence_of :title, :message => 'required'
+  validates_presence_of :body, :message => 'required'
+  validates_uniqueness_of :permalink 
+  
+  default_scope order('published_at DESC')
+  scope :publish, where('published_at < ? and is_active = ?', Time.zone.now, 1)
+  
+
+  #should be part of is_taggable
+  #pulled from http://github.com/gnugeek/is_taggable/commit/10b590865f0effeed20f00e3581a7aed8a6bd3b4
+  def self.find_all_tagged_with(tag_or_tags, conditions=[])
+    return [] if tag_or_tags.nil? || tag_or_tags.empty?
+    case tag_or_tags
+    when Array, IsTaggable::TagList
+      includes('tags', 'taggings').where(conditions).select { |record| tag_or_tags.all? { |tag| record.tags.map(&:name).include?(tag) } } || []
+    else
+      includes('tags', 'taggings').where(conditions).select { |record| record.tags.map(&:name).include?(tag_or_tags)  } || []
+    end
+  end
+    
+  def to_param
+    return permalink unless permalink.blank?
+    title.to_url
+  end
+  
+  def format_markup
+    if not self.body_raw.nil?
+      self.body = RedCloth.new(self.body_raw,[:sanitize_html, :filter_html]).to_html
+    end
+  end
+
+  #def link
+  #  ensure_slash_prefix permalink
+  #end
+  
+  def published
+    #self.published_at ||= Time.now unless self.is_active == 0
+    if self.is_active == 0
+      if !self.published_at.blank?
+          self.published_at = nil
+      end
+    else
+      if self.published_at.blank?
+          self.published_at = Time.now
+      end
+    end
+  end
+  
+  def month
+    published_at.strftime('%B %Y')
+  end
+  
+#private
+
+#  def ensure_slash_prefix(str)
+#    str.index('/') == 0 ? str : '/' + str
+#  end   
+end

data/app/views/admin/cms_settings/edit.html.erb

@@ -0,0 +1,40 @@
+<%= render :partial => 'admin/posts/sub_menu' %>
+
+<h1><%= t('cms.settings') %></h1>
+
+<% form_tag(admin_cms_settings_path, :method => :put) do -%>
+
+
+  
+  <p>
+	<label><%= t('cms.posts_per_page') %></label>
+	<%= text_field_tag('preferences[cms_posts_per_page]', Spree::Config[:cms_posts_per_page]) %>
+  </p>
+  <p>
+	<label><%= t('cms.posts_recent') %></label>
+	<%= text_field_tag('preferences[cms_posts_recent]', Spree::Config[:cms_posts_recent])%>
+  </p>	
+  
+  <p>
+  <label><%= t('cms.post_status_default') %></label>
+  <%= radio_button_tag('preferences[cms_post_status_default]', 1, Spree::Config[:cms_post_status_default]) %> <%= t("cms.publish") %>
+  <%= radio_button_tag('preferences[cms_post_status_default]', 0, Spree::Config[:cms_post_status_default] ) %> <%= t("cms.draft") %>
+  </p>
+  
+  <p>
+  <label><%= t('cms.page_status_default') %></label>
+  <%= radio_button_tag('preferences[cms_page_status_default]', 1, Spree::Config[:cms_page_status_default]) %> <%= t("cms.publish") %>
+  <%= radio_button_tag('preferences[cms_page_status_default]', 0, Spree::Config[:cms_page_status_default] ) %> <%= t("cms.draft") %>
+  </p>
+    	  
+  <p>
+  <label><%= t('cms.post_comment_default') %></label>
+  <%= radio_button_tag('preferences[cms_post_comment_default]', 1, Spree::Config[:cms_post_comment_default]) %> <%= t("cms.open") %>
+  <%= radio_button_tag('preferences[cms_post_comment_default]', 0, Spree::Config[:cms_post_comment_default] ) %> <%= t("cms.closed") %>
+  </p>
+
+  <p class="form-buttons">
+    <%= button t('update') %> 
+    <%= t("or") %> <%= link_to t("cancel"), admin_cms_settings_url %>
+  </p>
+<% end -%>

data/app/views/admin/cms_settings/show.html.erb

@@ -0,0 +1,42 @@
+<%= render :partial => 'admin/posts/sub_menu' %>
+
+<h1><%= t("cms.settings") %></h1>
+
+<table>
+  <tr>
+    <th scope="row"><%= t("cms.permalink") %>:</th> 
+    <td><%=  Spree::Config[:cms_permalink] %></td>
+  </tr>
+  <tr>
+    <th scope="row"><%= t("cms.posts_per_page") %>:</th> 
+    <td><%=  Spree::Config[:cms_posts_per_page] %></td>
+  </tr>
+  <tr>
+    <th scope="row"><%= t("cms.posts_recent") %>:</th> 
+    <td><%=  Spree::Config[:cms_posts_recent] %></td>
+  </tr>
+
+  <tr>
+    <th scope="row"><%= t("cms.post_status_default") %>:</th> 
+    <td><%= (Spree::Config[:cms_post_status_default] ? t("cms.publish") : t("cms.draft")) %></td>
+  </tr>
+  
+  <tr>
+    <th scope="row"><%= t("cms.page_status_default") %>:</th> 
+    <td><%= (Spree::Config[:cms_page_status_default] ? t("cms.publish") : t("cms.draft")) %></td>
+  </tr>
+  
+  <tr>
+    <th scope="row"><%= t("cms.post_comment_default") %>:</th> 
+    <td><%= (Spree::Config[:cms_post_comment_default] ? t("cms.open") : t("cms.closed")) %>
+</td>
+  </tr>
+  
+  
+  
+
+</table>
+
+<p><%= link_to_with_icon 'edit', t("edit"), edit_admin_cms_settings_path %></p>
+
+

data/app/views/admin/pages/_form.html.erb

@@ -0,0 +1,51 @@
+<div class="yui-gc">
+  <div class="yui-u first">
+    <%- locals = {:f => f} -%>
+    <% hook :admin_page_form_left, locals do %>
+      <% f.field_container :title do %>
+        <%= f.label :title, t("cms.title") %> <span class="required">*</span><br />
+        <%= f.text_field :title, :class => 'fullwidth title'  %>
+        <%= f.error_message_on :title %>
+      <% end %>
+
+      <% f.field_container :permalink do %>
+        <%= f.label :permalink, t("cms.permalink") %> <span class="required">*</span><br />
+        <%= f.text_field :permalink, :class => 'fullwidth title'  %>
+        <%= f.error_message_on :permalink %>
+      <% end %>
+
+      <% f.field_container :body_raw do %>
+        <%= f.label :body_raw, t("cms.body")%><br />
+        <%= f.text_area :body_raw, {:cols => 60, :rows => 4, :class => 'fullwidth'} %>
+        <%= f.error_message_on :body_raw %>
+      <% end %>
+    <% end %>
+  </div>
+  <div class="yui-u">
+    <% hook :admin_page_form_right, locals do %>
+    
+      <p>
+        <%= f.label :is_active, t("cms.status")%><br />
+
+        <%= f.radio_button :is_active, 1 %><%= t("cms.publish") %> 
+        <%= f.radio_button :is_active, 0 %><%= t("cms.draft") %>
+        <%= f.error_message_on :is_active%>
+      </p>
+      <h2><%= t("metadata") %></h2>
+      <% hook :admin_page_form_meta, locals do %>
+        <p>
+          <%= f.label :meta_keywords, t("cms.meta_keywords")%><br />
+          <%= f.text_field :meta_keywords, :class => 'fullwidth' %>
+        </p>
+        <p>
+          <%= f.label :meta_description, t("cms.meta_description")%><br />
+          <%= f.text_field :meta_description, :class => 'fullwidth' %>
+        </p>
+      <% end %>
+    <% end %>
+  </div>
+</div>
+
+
+
+

data/app/views/admin/pages/edit.html.erb

@@ -0,0 +1,7 @@
+<h1><%= t("cms.editing_page") + " &ldquo;#{@page.title}&rdquo;" %></h1>
+
+<% form_for(@page, :url => object_url, :html => { :method => :put, :multipart => true }) do |f| %>
+  <%= render :partial => 'form', :locals => {:f => f} %>
+  <%= render :partial => 'admin/shared/edit_resource_links' %>
+<% end %>
+

data/app/views/admin/pages/index.html.erb

@@ -0,0 +1,90 @@
+<div class='toolbar'>
+  <ul class='actions'>
+    <li id="new_ot_link">
+      <%= button_link_to_remote t("cms.new_page"),
+                         {:url => new_object_url,
+                         :method => :get,
+                         :update => "new-page"}, :icon => 'add' %>
+    </li>
+  </ul>
+  <br class='clear' />
+</div>
+
+<h1><%= "#{t('actions.listing')} #{t('pages')}" %></h1>
+
+<%= image_tag "spinner.gif", :plugin=>"spree", :style => "display:none", :id => 'busy_indicator' %>
+<div id="new-page"></div>
+
+
+<table class="index">
+  <tr>
+    <% hook :admin_pages_index_headers do %>
+      <th><%= order @search, :by => :title, :as => t("cms.title") %></th>
+      <th><%= order @search, :by => :date, :as => t("cms.date") %></th>
+    <% end %>
+    <th>
+      <%= hook :admin_pages_index_header_actions %>
+    </th>
+  </tr>
+
+<% @collection.each do |page| %>
+  <%- locals = {:page => page} -%>
+  <tr>
+    <% hook :admin_pages_index_rows, locals do %>
+      <td><%= link_to h(page.title), [:edit,:admin,page] %> (<%= page.is_active == 1 ? t("cms.published") : t("cms.draft") %>) </td>
+      <td><%= (page.published_at.blank? ? page.updated_at : page.published_at).strftime("%B %d, %Y at %I:%M%p") %></td>
+    <% end %>
+    <td class="actions">
+      <% hook :admin_pages_index_row_actions, locals do %>
+        <%= link_to_edit page %>
+        &nbsp;
+        <%= link_to_delete page %>
+      <% end %>
+    </td>
+  </tr>
+<% end %>
+</table>
+<%= will_paginate(:previous_label => "&#171; #{t('previous')}", :next_label => "#{t('next')} &#187;") %>
+
+<% content_for :sidebar do %>
+
+  <% form_for @search do |f| %>
+    <div class="box">
+      <h3><%= t(:search) %></h3>
+
+      <%- locals = {:f => f} -%>
+      <% hook :admin_pages_index_search, locals do %>
+        <p>
+          <label><%= t("cms.title") %></label><br />
+          <%= f.text_field :title_contains, :size => 15 %>
+        </p>
+        
+        <label><%= t("cms.published_date_range") %></label><br />
+        <div class="yui-g date-range-filter">
+          <div class="yui-u sub-field first">
+            <%= f.unobtrusive_date_text_picker :published_at_after %><br />
+            <label class="sub"><%= t("start") %></label>
+          </div>
+          <div class="yui-u sub-field">
+            <%= f.unobtrusive_date_text_picker :published_at_before %><br />
+            <label><%= t("stop") %></label>
+          </div>
+        </div>
+
+        <p>
+          <%= f.check_box :is_active, {:style => "vertical-align:middle;"}, "1", ""  %>
+          <label>
+            <%= t("cms.show_only_published_pages") %>
+          </label>
+        </p>
+      <% end %>
+
+      <% hook :admin_pages_index_search_buttons, locals do %>
+        <p class="form-buttons">
+          <%= button t("search") %>
+        </p>
+      <% end %>
+    </div>
+  <% end %>
+
+<% end %>

data/app/views/admin/pages/new.html.erb

@@ -0,0 +1,28 @@
+<%= error_messages_for :page %>
+
+<% form_for(:page,  :url => collection_url, :html => { :multipart => true }) do |f| %>
+<fieldset>
+
+  <% f.field_container :title do %>
+    <%= f.label :title, t("cms.title") %> <span class="required">*</span><br />
+    <%= f.text_field :title, :class => 'fullwidth title'  %>
+    <%= f.error_message_on :title %>
+  <% end %>
+
+  <div class="yui-gb">
+    <div class="yui-u first">
+
+      <% f.field_container :body_raw do %>
+        <%= f.label :body_raw, t("cms.body")%> <span class="required">*</span><br />
+        <%= f.text_area :body_raw, {:cols => 120, :rows => 4, :class => 'fullwidth'} %>
+        <%= f.error_message_on :body_raw %>
+      <% end %>
+
+    </div>
+
+  </div>
+
+  <%= render :partial => 'admin/shared/new_resource_links' %>
+
+</fieldset>
+<% end %>