spree_essential_cms 0.1.0

data/LICENSE

@@ -0,0 +1,23 @@
+Redistribution and use in source and binary forms, with or without modification, 
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice, 
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice, 
+      this list of conditions and the following disclaimer in the documentation 
+      and/or other materials provided with the distribution.
+    * Neither the name of the Rails Dog LLC nor the names of its 
+      contributors may be used to endorse or promote products derived from this 
+      software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,78 @@
+SpreeEssentialCms
+=================
+
+SpreeEssentialCms is a full featured CMS for managing pages and content on your [Spree](http://spreecommerce.com) site.
+
+
+Installation
+------------
+
+If you don't already have an existing Spree site, [click here](https://gist.github.com/946719) then come back later... You can also read the Spree docs [here](http://spreecommerce.com/documentation/getting_started.html)...
+
+Otherwise, follow these steps to get up and running with SpreeEssentialCms:
+
+Add the necessary gems to your Gemfile... they haven't been released to Rubygems yet so we'll grab them from git.
+
+    gem 'spree_essentials',    :git => 'git://github.com/citrus/spree_essentials.git'
+    gem 'spree_essential_cms', :git => 'git://github.com/citrus/spree_essential_cms.git'
+
+Run the generators to create the migration files.
+
+    rails g spree_essentials:install
+    rails g spree_essentials:cms
+
+Now migrate your database...
+
+    rake db:migrate
+    
+Boot your server and checkout the admin!
+
+    rails s
+    
+    
+Demo
+----
+
+You can easily use the test/dummy app as a demo of spree_essential_cms. Just `cd` to where you develop and run:
+    
+    git clone git://github.com/citrus/spree_essential_cms.git
+    cd spree_essential_cms
+    mv lib/dummy_hooks/after_migrate.rb.sample lib/dummy_hooks/after_migrate.rb
+    bundle install
+    bundle exec dummier
+    cd test/dummy
+    rails s
+    
+
+Change Log
+----------
+
+**2011/4/26**
+
+* Extracted from the Spree Essentials core.
+
+
+To Do
+-----
+
+* more tests... many many more.
+* A 'create translation' button that clones the current page's contents into another language
+* add widgets that you can drop into any page
+* page and menu caching/sweeping
+* nested set for pages
+* 0.30 and 0.40 compatibility
+* create wiki pages
+
+
+Contributors
+------------
+
+So far it's just me; Spencer Steffen. 
+
+If you'd like to help out feel free to fork and send me pull requests!
+
+
+License
+-------
+
+Copyright (c) 2011 Spencer Steffen, released under the New BSD License All rights reserved.

data/Rakefile

@@ -0,0 +1,21 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must run `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+require 'rake/testtask'
+
+Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test

data/app/controllers/admin/contents_controller.rb

@@ -0,0 +1,41 @@
+class Admin::ContentsController < Admin::BaseController
+
+  resource_controller 
+  belongs_to :page
+
+  create.response do |wants|
+    wants.html { redirect_to collection_url }
+  end
+
+  update.response do |wants|
+    wants.html { redirect_to collection_url }
+  end
+
+  def update_positions
+    @page = parent_object
+    params[:positions].each do |id, index|
+      @page.contents.update_all(['position=?', index], ['id=?', id])
+    end
+    
+    respond_to do |format|
+      format.html { redirect_to admin_page_contents_url(@oage) }
+      format.js  { render :text => 'Ok' }
+    end
+  end
+
+  destroy.success.wants.js { render_js_for_destroy }
+
+  private
+    
+    def parent_object
+	   @page ||= Page.find_by_path(params[:page_id])
+    end
+          
+    def collection
+      params[:search] ||= {}
+      params[:search][:meta_sort] ||= "page.asc"
+      @search = end_of_association_chain.metasearch(params[:search])
+      @collection = @search.paginate(:per_page => Spree::Config[:orders_per_page], :page => params[:page])
+    end
+
+end

data/app/controllers/admin/page_images_controller.rb

@@ -0,0 +1,37 @@
+class Admin::PageImagesController < Admin::ResourceController
+  
+  before_filter :load_data
+
+  create.before :set_viewable
+  update.before :set_viewable
+  destroy.before :destroy_before
+
+  def update_positions
+    params[:positions].each do |id, index|
+      PageImage.update_all(['position=?', index], ['id=?', id])
+    end
+
+    respond_to do |format|
+      format.js  { render :text => 'Ok' }
+    end
+  end
+  
+  private
+  
+  def location_after_save
+    admin_page_images_url(@page)
+  end
+
+  def load_data
+    @page = Page.find_by_path(params[:page_id])
+  end
+
+  def set_viewable
+    @page_image.viewable = @page
+  end
+
+  def destroy_before
+    @viewable = @page_image.viewable
+  end
+
+end

data/app/controllers/admin/pages_controller.rb

@@ -0,0 +1,38 @@
+class Admin::PagesController < Admin::BaseController
+  resource_controller
+
+  create.response do |wants|
+    wants.html { redirect_to edit_admin_page_content_path(@page, @page.contents.first) }
+  end
+
+  update.response do |wants|
+    wants.html { redirect_to object_url }
+  end
+
+  destroy.success.wants.js { render_js_for_destroy }
+
+  def update_positions
+    params[:positions].each do |id, index|
+      Page.update_all(['position=?', index], ['id=?', id])
+    end
+    
+    respond_to do |format|
+      format.html { redirect_to admin_pages_url }
+      format.js  { render :text => 'Ok' }
+    end
+  end
+
+  private
+  
+    def object
+      @object ||= Page.find_by_path(params[:id])
+    end
+  
+    def collection
+      params[:search] ||= {}
+      params[:search][:meta_sort] ||= "page.asc"
+      @search = end_of_association_chain.metasearch(params[:search])
+      @collection = @search.order(:position).paginate(:per_page => Spree::Config[:orders_per_page], :page => params[:page])
+    end
+
+end

data/app/controllers/page_controller.rb

@@ -0,0 +1,19 @@
+class PageController < ApplicationController
+
+  before_filter :get_page, :only => :index
+  
+  def show
+  end
+    
+  private
+  
+    def get_page
+      @page = Page.active.find_by_path(page_path)
+      return raise ActionController::RoutingError.new(page_path) unless @page
+    end
+      
+    def page_path
+      params[:path] || "/"
+    end
+        
+end

data/app/controllers/pages_controller.rb

@@ -0,0 +1,28 @@
+class PagesController < ApplicationController
+  
+  before_filter :get_page, :only => :show
+  
+  def show
+    if @page.root?
+      @posts    = Post.live.limit(5)    if SpreeEssentials.has?(:blog)
+      @articles = Article.live.limit(5) if SpreeEssentials.has?(:news)
+      render :template => 'pages/home'
+    end
+  end
+  
+  private
+  
+    def get_page
+      @page = Page.active.find_by_path(page_path) rescue nil
+      return raise ActionController::RoutingError.new(page_path) unless @page
+    end
+      
+    def page_path
+      params[:page_path] || "/"
+    end
+  
+    def accurate_title
+      @page.meta_title
+    end
+    
+end

data/app/controllers/spree_base_controller_decorator.rb

@@ -0,0 +1,11 @@
+Spree::BaseController.class_eval do
+  
+  before_filter :get_pages
+  
+  def get_pages
+    @page = Page.find_by_path(request.path) rescue nil
+    scope = request.path =~ /^\/admin/ ? Page.scoped : Page.visible
+    @pages = scope.order(:position).all
+  end
+
+end

data/app/models/content.rb

@@ -0,0 +1,82 @@
+class Content < ActiveRecord::Base
+  
+  belongs_to :page
+  validates_associated :page
+  validates_presence_of :title
+
+  
+  if defined?(SpreeHeroku)
+    has_attached_file :attachment,
+      :styles => Proc.new{ |clip| clip.instance.attachment_sizes },
+      :default_style => :preview,
+      :path => "assets/contents/:id/:style/:basename.:extension",
+      :storage => "s3",
+      :s3_credentials => "#{Rails.root}/config/s3.yml"
+  else
+    has_attached_file :attachment,
+      :styles => Proc.new{ |clip| clip.instance.attachment_sizes },
+      :default_style => :preview,
+      :url => "/assets/contents/:id/:style/:basename.:extension",
+      :path => ":rails_root/public/assets/contents/:id/:style/:basename.:extension"
+  end
+  
+  
+  cattr_reader :per_page
+  @@per_page = 10
+  
+  
+  scope :for, Proc.new{|context| where(:context => context)}
+  
+    
+  [ :link_text, :link, :body ].each do |property|
+    define_method "has_#{property.to_s}?" do
+      has_value property
+    end
+  end
+  
+  def has_full_link?
+    has_link? && has_link_text?
+  end
+ 	
+  def has_image?
+    has_value(:attachment_file_name) && attachment_file_name.match(/gif|jpg|png/i)
+  end
+  
+  def hide_title?
+    self.hide_title == true
+  end
+  
+  
+  def rendered_body
+    RDiscount.new(body.to_s).to_html.html_safe
+  end
+    
+  
+  def default_attachment_sizes
+    { :mini => '48x48>', :medium => '427x287>' }
+  end
+ 	
+  def attachment_sizes
+    case self.context
+      when 'slideshow'
+        sizes = default_attachment_sizes.merge(:slide => '955x476#')
+      else
+        sizes = default_attachment_sizes
+    end
+    sizes
+  end
+  
+  
+  
+  def context=(value)
+    write_attribute :context, value.to_s.parameterize
+  end
+
+  private
+  
+    def has_value(selector)
+      v = self.send selector
+      v && !v.to_s.blank?
+    end
+
+end

data/app/models/page.rb

@@ -0,0 +1,61 @@
+class Page < ActiveRecord::Base
+  
+  validates_presence_of :title
+  validates :path, :presence => true, :uniqueness => { :case_sensitive => false }
+  
+  scope :active,  where(:accessible => true)
+  scope :visible, active.where(:visible => true)
+  
+  has_many :contents, :order => :position, :dependent => :destroy
+  has_many :images, :as => :viewable, :class_name => 'PageImage', :order => :position, :dependent => :destroy
+  
+  before_validation :set_defaults
+  after_create :create_default_content
+  
+  def self.find_by_path(_path)
+    return super("/") if _path == 'home'
+    super(_path.to_s.sub(/^\/?/, '/').gsub('--', '/'))
+  end
+  
+  def to_param
+    return 'home' if path == '/'
+    path.sub(/^\//, '').gsub('/', '--')
+  end
+  
+  def meta_title
+    val = read_attribute(:meta_title)
+    val.blank? ? title : val
+  end
+  
+  def for_context(context)
+    contents.where(:context => context)
+  end
+  
+  def has_context?(context)
+    contents.where(:context => context).count
+  end
+  
+  def matches?(_path)
+    (root? && _path == "/") || (!root? && _path.match(path))
+  end
+  
+  def root?
+    self.path == "/"
+  end
+  
+  private
+  
+    def set_defaults
+      return if title.blank?
+      return errors.add(:path, "is reserved. Please use another") if path.to_s =~ /home/
+      self.nav_title = title if nav_title.blank?
+      self.path = nav_title.parameterize if path.blank?
+      self.path = "/" + path.sub(/^\//, '')
+    end
+    
+    def create_default_content
+      self.contents.create(:title => title)
+    end
+  		
+end
+  

data/app/models/page_image.rb

@@ -0,0 +1,40 @@
+class PageImage < Image
+
+  validate :no_attachement_errors
+
+  if defined?(SpreeHeroku)
+    has_attached_file :attachment,
+      :styles => Proc.new{ |clip| clip.instance.attachment_sizes },
+      :default_style => :medium,
+      :path => "assets/posts/:id/:style/:basename.:extension",
+      :storage => "s3",
+      :s3_credentials => "#{Rails.root}/config/s3.yml"
+  else
+    has_attached_file :attachment,
+      :styles => Proc.new{ |clip| clip.instance.attachment_sizes },
+      :default_style => :medium,
+      :url => "/assets/posts/:id/:style/:basename.:extension",
+      :path => ":rails_root/public/assets/posts/:id/:style/:basename.:extension"
+  end 
+ 
+  def image_content?
+    attachment_content_type.match(/\/(jpeg|png|gif|tiff|x-photoshop)/)
+  end
+     
+  def attachment_sizes
+    sizes = {}
+    sizes.merge!(:mini => '48x48>', :small => '150x150>', :medium => '420x300>', :large => '900x650>') if image_content?
+    sizes.merge!(:slide => '950x250#') if viewable.respond_to?(:path) && viewable.path == "/"
+    sizes
+  end
+  
+  def no_attachement_errors
+    unless attachment.errors.empty?
+      # uncomment this to get rid of the less-than-useful interrim messages
+      errors.clear
+      errors.add :attachment, "Paperclip returned errors for file '#{attachment_file_name}' - check ImageMagick installation or image source file."
+      false
+    end
+  end
+  
+end

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

@@ -0,0 +1,74 @@
+<%= form.field_container :title do %>
+  <%= form.label :title, t('content.title') %><br />
+  <%= form.text_field :title, :class => "title"  %>
+  <%= error_message_on :content, :title %>
+<% end %>
+
+<%= form.field_container :page do %>
+  <%= form.label :page_id, t('content.page') %><br />
+  <%= form.select :page_id, @pages.collect{|i| [i.title, i.id]}  %>
+  <%= error_message_on :content, :page_id %>
+<% end %>
+
+<%= form.field_container :body do %>
+  <%= form.label :title, t('content.body') %><%= markdown_helper %><br />
+  <%= form.text_area :body  %>
+  <%= error_message_on :content, :body %>
+<% end %>
+
+<p><%= link_to "Optional Fields <span>&#9650;</span>".html_safe, "#options", :id => "btn_optional" %></p>
+
+<div class="optional" style="display: none;">
+
+  <%= form.field_container :attachment do %>
+    <%= form.label :attachment, t('content.attachment') %><br />
+    <%= form.file_field :attachment %>
+    <%= error_message_on :content, :attachment %>
+  <% end %>
+  
+  <% if @content.has_image? %>
+    <p><%= image_tag @content.attachment.url(:mini) %></p>
+  <% end %>
+
+  <%= form.field_container :link do %>
+    <%= form.label :link, t('content.link') %><br />
+    <%= form.text_field :link, :class => "text"  %>
+    <%= error_message_on :content, :link %>
+  <% end %>
+  
+  <%= form.field_container :link_text do %>
+    <%= form.label :link_text, t('content.link_text') %><br />
+    <%= form.text_field :link_text, :class => "text"  %>
+    <%= error_message_on :content, :link_text %>
+  <% end %>
+  
+  <%= form.field_container :context do %>
+    <%= form.label :context, t('content.context') %><br />
+    <%= form.text_field :context, :class => "text"  %>
+    <%= error_message_on :content, :context %>
+  <% end %>
+
+  <%= form.field_container :hide_title do %>
+    <%= form.check_box :hide_title, :class => "checkbox"  %>
+    <%= form.label :hide_title, t('content.hide_title') %><br />
+    <%= error_message_on :content, :hide_title %>
+  <% end %>
+
+</div>
+
+<% content_for :head do %>
+  <%= stylesheet_link_tag "markitup.css" %>
+  <%= javascript_include_tag 'jquery.markitup.js', 'markdown.set.js' %>
+  <script type="text/javascript">
+  //<![CDATA[
+    $(document).ready(function() {
+      $('#content_body').markItUp(markdownSettings);
+      $('#btn_optional').click(function(evt) {
+        evt.preventDefault();
+        var vis = $('.optional').toggle().css('display') == 'block';
+        $(this).find('span').html(vis ? '&#9660;' : '&#9650;');
+      });
+    }); 
+  //]]>
+  </script>
+<% end %>

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

@@ -0,0 +1,16 @@
+<%= render :partial => 'admin/shared/contents_sub_menu' %>
+
+<%= render :partial => 'admin/shared/page_tabs', :locals => {:current => 'Contents'} %>
+
+<% if @content.try(:errors).present? %>
+  <%= render 'shared/error_messages', :target => @content %>
+<% end %>
+
+<h2><%= t('.edit_content') %></h2>
+
+<%= form_for([:admin, @page, @content], :html => { :multipart => true }) do |f| %>
+  <%= render "form", :form => f %>
+  <p class="form-buttons">
+    <%= button t("update") %> <%= t('or') %> <%= link_to t('cancel'), collection_url %>
+  </p>
+<% end %>

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

@@ -0,0 +1,59 @@
+<%= render :partial => 'admin/shared/contents_sub_menu' %>
+
+<div class='toolbar'>
+  <ul class='actions'>
+    <li>
+      <p><%= button_link_to t('.new_content'), new_object_url, :icon => 'add' %></p>
+    </li>
+  </ul>
+  <br class='clear' />
+</div>
+
+<%= render :partial => 'admin/shared/page_tabs', :locals => {:current => 'Contents'} %>
+
+<h2><%= t('.listing_contents') %></h2>
+
+<table class="index sortable">
+  <thead>
+	<tr>
+    	<th><%= sort_link @search, :title, t("content.title") %></th>
+    	<th><%= sort_link @search, :context, t("content.context") %></th>
+    	<th><%= t("action") %></th>
+	</tr>
+  </thead>
+  <tbody>
+    <%- @collection.each do |content|%>
+    <tr id="<%= dom_id content %>">
+      <td><span class="handle">&nbsp;</span>&nbsp; <%= link_to content.title, object_url(content) %></td>
+      <td><%= content.context %>
+      <td>
+      	<%= link_to_edit content %> &nbsp;
+      	<%= link_to_delete content %>
+      </td>
+    </tr>
+    <% end %>
+  </tbody>
+</table>
+
+<%= will_paginate(@contents, :prev => "&#171; #{t('previous')}", :next => "#{t('next')} &#187;") %>
+
+<% content_for :sidebar do %>
+
+<div class="box">
+  <h3><%= t(:search) %></h3>
+
+  <% @content = Content.metasearch %>
+  <%= form_for [:admin, @page, @content] do |f| %>
+    <%- locals = {:f => f} %>
+    <%= hook :admin_contents_index_search, locals do %>
+      <p>
+        <label><%= t('content.title') %></label><br />
+        <%= f.text_field :title_like, :size => 25 %>
+      </p>      
+    <% end %>
+    <%= hook :admin_contents_index_search_buttons, locals do %>
+      <p><%= button t("search") %></p>
+    <% end %>
+  <% end %>
+</div>
+<% end %>

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

@@ -0,0 +1,18 @@
+<%= render :partial => 'admin/shared/contents_sub_menu' %>
+
+<%= render :partial => 'admin/shared/page_tabs', :locals => {:current => 'Contents'} %>
+
+<% if @content.try(:errors).present? %>
+  <%= render 'shared/error_messages', :target => @content %>
+<% end %>
+
+<h2><%= t('.new_content') %></h2>
+
+<% form_for([:admin, @page, @content], :html => { :multipart => true }) do |f| %>
+  <%= render "form", :form => f %>
+
+  <p class="form-buttons">
+    <%= button t("create") %> <%= t('or') %> <%= link_to t('cancel'), collection_url %>
+  </p>
+<% end %>
+

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

@@ -0,0 +1,11 @@
+<%= render :partial => 'admin/shared/contents_sub_menu' %>
+<%= render :partial => 'admin/shared/page_tabs', :locals => {:current => 'Contents'} %>
+
+<h2><%= h @content.title %></h2>
+
+<%= RDiscount.new(@content.body).to_html.html_safe %>
+
+<p>
+  <%= link_to_edit @user %> &nbsp;
+  <%= link_to t('back'), collection_url %>
+</p>

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

@@ -0,0 +1,8 @@
+<p>
+  <%= form.label :attachment %>:<br/>
+  <%= form.file_field :attachment %>
+</p>
+<p>
+  <%= form.label :alt %>:<br/>
+  <%= form.text_field :alt %>
+</p>