comfortable_mexican_sofa 1.0.51 → 1.1.1

data/README.md

@@ -85,7 +85,7 @@ Here's a number of tag variations:
                                           
 Multiple Sites
 --------------
-Sofa is able to manage multiple sites from the same application. For instance: 'site-a.example.com' and 'site-b.example.com' will have distinct set of layouts, pages, snippets, etc. To enable multi-site functionality make sure you have this setting in the initializer: `config.auto_manage_sites = false`. When this setting is set to `true`, Sofa assumes there's only one site and will manage hostname associated with it automatically.
+Sofa is able to manage multiple sites from the same application. For instance: 'site-a.example.com' and 'site-b.example.com' will have distinct set of layouts, pages, snippets, etc. To enable multi-site functionality make sure you have this setting in the initializer: `config.enable_multiple_sites = true`.
     
 Integrating CMS with your app
 -----------------------------
@@ -142,25 +142,15 @@ Do you have other authentication system in place (like Devise, AuthLogic, etc) a
     
 You can put this module in /config/initializers/comfortable\_mexican\_sofa.rb and change authentication method: `config.authentication = 'CmsDeviseAuth'`. Now to access Sofa's admin area users will be authenticated against your existing authentication system.
 
-Working with seeds
-------------------
-ComfortableMexicanSofa has seeds, functionality that helps manage content during development phase. It's very different from Rails seeds as Sofa's seeds are loaded with each page load. The database is completely bypassed when seeds are active. This way, you can source-control content before going live, disabling seeds and dumping everything into the database.
+Working with Fixtures
+---------------------
+Sofa allows you to build entire site using files instead of updating database via admin area. This significantly speeds up initial content population. To enable fixtures go to the initializer and set this: `config.enable_fixtures = true`. You may also change the folder that is used to store fixtures.
 
-First, you will need to set a path where fixture files will be found (inside Sofa's initializer):
-    
-    if Rails.env.development? || Rails.env.test?
-      ComfortableMexicanSofa.config.seed_data_path = File.expand_path('db/cms_seeds', Rails.root)
-    end
-    
-If you ran `rails g cms`, you should find an example set of seeds in /db/cms\_seeds directory. Please note that seeds are nested in the folder that is the hostname of your site. Each file is an YAML representation of a database entry for that layout/page/snippet.
+If you run `rails g cms` you should find an example set of fixtures in [/db/cms\_fixtures](https://github.com/twg/comfortable-mexican-sofa/blob/master/db/cms_fixtures). If you run multiple sites, each set of fixtures should be inside a folder named as the hostname of the site. It's optional if you only have one site.
 
-There's a rake task that makes moving seeds into database (and vice-versa) easy:
-    
-    # from seeds into database
-    rake comfortable_mexican_sofa:import:all FROM=your-site.local TO=your-site.com SEED_PATH=/path/to/seeds
-    
-    # from database to seeds
-    rake comfortable_mexican_sofa:export:all FROM=your-site.com TO=your-site.local SEED_PATH=/path/to/seeds
+When fixtures are enabled, database is updated with each request, but only if fixture file is newer than the database entry. Database is also purged of items that are not defined in fixtures. So be careful not to clear out your database by mistake.
+
+When deploying to a production server don't forget to turn off fixtures. To load them into the database just run this rake task: `rake comfortable_mexican_sofa:fixtures:import`. When running multiple sites specify which one by passing argument like this: `SITE=example.com`.
     
 Active Components
 -----------------

data/Rakefile

@@ -11,14 +11,11 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name        = 'comfortable_mexican_sofa'
-    gem.summary     = 'ComfortableMexicanSofa is a Rails Engine CMS gem'
+    gem.summary     = 'ComfortableMexicanSofa is a powerful micro CMS for Ruby on Rails 3 applications'
     gem.description = ''
     gem.email       = 'oleg@theworkinggroup.ca'
     gem.homepage    = 'http://github.com/twg/comfortable-mexican-sofa'
     gem.authors     = ['Oleg Khabarov', 'The Working Group Inc']
-    gem.add_dependency('rails',           '>=3.0.3')
-    gem.add_dependency('active_link_to',  '>=0.0.6')
-    gem.add_dependency('paperclip',       '>=2.3.8')
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-1.0.51
+1.1.1

data/app/controllers/cms_admin/base_controller.rb

@@ -13,16 +13,15 @@ class CmsAdmin::BaseController < ActionController::Base
 protected
   
   def load_admin_cms_site
-    hostname = ComfortableMexicanSofa.config.override_host || request.host.downcase
-    @cms_site = CmsSite.find_by_hostname!(hostname)
-  
-  rescue ActiveRecord::RecordNotFound
+    hostname = request.host.downcase
+    @cms_site = Cms::Site.find_by_hostname!(hostname)
     
-    if ComfortableMexicanSofa.config.auto_manage_sites
-      if CmsSite.count == 0
-        @cms_site = CmsSite.create!(:label => 'Default Site', :hostname => hostname)
-      elsif CmsSite.count == 1
-        @cms_site = CmsSite.first
+  rescue ActiveRecord::RecordNotFound
+    unless ComfortableMexicanSofa.config.enable_multiple_sites
+      if Cms::Site.count == 0
+        @cms_site = Cms::Site.create!(:label => 'Default Site', :hostname => hostname)
+      else
+        @cms_site = Cms::Site.first
         @cms_site.update_attribute(:hostname, hostname)
       end
     end

data/app/controllers/cms_admin/layouts_controller.rb

@@ -4,8 +4,8 @@ class CmsAdmin::LayoutsController < CmsAdmin::BaseController
   before_filter :load_cms_layout,   :only => [:edit, :update, :destroy]
   
   def index
-    return redirect_to :action => :new if @cms_site.cms_layouts.count == 0
-    @cms_layouts = @cms_site.cms_layouts.roots
+    return redirect_to :action => :new if @cms_site.layouts.count == 0
+    @cms_layouts = @cms_site.layouts.roots
   end
   
   def new
@@ -43,13 +43,13 @@ class CmsAdmin::LayoutsController < CmsAdmin::BaseController
 protected
   
   def build_cms_layout
-    @cms_layout = @cms_site.cms_layouts.new(params[:cms_layout])
-    @cms_layout.parent ||= CmsLayout.find_by_id(params[:parent_id])
+    @cms_layout = @cms_site.layouts.new(params[:cms_layout])
+    @cms_layout.parent ||= Cms::Layout.find_by_id(params[:parent_id])
     @cms_layout.content ||= '{{ cms:page:content:text }}'
   end
   
   def load_cms_layout
-    @cms_layout = @cms_site.cms_layouts.find(params[:id])
+    @cms_layout = @cms_site.layouts.find(params[:id])
   rescue ActiveRecord::RecordNotFound
     flash[:error] = 'Layout not found'
     redirect_to :action => :index

data/app/controllers/cms_admin/pages_controller.rb

@@ -7,8 +7,8 @@ class CmsAdmin::PagesController < CmsAdmin::BaseController
   before_filter :build_upload_file, :only => [:new, :edit]
   
   def index
-    return redirect_to :action => :new if @cms_site.cms_pages.count == 0
-    @cms_pages = [@cms_site.cms_pages.root].compact
+    return redirect_to :action => :new if @cms_site.pages.count == 0
+    @cms_pages = [@cms_site.pages.root].compact
   end
   
   def new
@@ -44,12 +44,12 @@ class CmsAdmin::PagesController < CmsAdmin::BaseController
   end
   
   def form_blocks
-    @cms_page = @cms_site.cms_pages.find_by_id(params[:id]) || CmsPage.new
-    @cms_page.cms_layout = @cms_site.cms_layouts.find_by_id(params[:layout_id])
+    @cms_page = @cms_site.pages.find_by_id(params[:id]) || @cms_site.pages.new
+    @cms_page.layout = @cms_site.layouts.find_by_id(params[:layout_id])
   end
   
   def toggle_branch
-    @cms_page = @cms_site.cms_pages.find(params[:id])
+    @cms_page = @cms_site.pages.find(params[:id])
     s   = (session[:cms_page_tree] ||= [])
     id  = @cms_page.id.to_s
     s.member?(id) ? s.delete(id) : s << id
@@ -59,7 +59,7 @@ class CmsAdmin::PagesController < CmsAdmin::BaseController
   
   def reorder
     (params[:cms_page] || []).each_with_index do |id, index|
-      if (cms_page = CmsPage.find_by_id(id))
+      if (cms_page = Cms::Page.find_by_id(id))
         cms_page.update_attribute(:position, index)
       end
     end
@@ -69,26 +69,26 @@ class CmsAdmin::PagesController < CmsAdmin::BaseController
 protected
 
   def check_for_layouts
-    if CmsLayout.count == 0
+    if @cms_site.layouts.count == 0
       flash[:error] = 'No Layouts found. Please create one.'
       redirect_to new_cms_admin_layout_path
     end
   end
   
   def build_cms_page
-    @cms_page = @cms_site.cms_pages.new(params[:cms_page])
-    @cms_page.parent ||= (CmsPage.find_by_id(params[:parent_id]) || @cms_site.cms_pages.root)
-    @cms_page.cms_layout ||= (@cms_page.parent && @cms_page.parent.cms_layout || @cms_site.cms_layouts.first)
+    @cms_page = @cms_site.pages.new(params[:cms_page])
+    @cms_page.parent ||= (@cms_site.pages.find_by_id(params[:parent_id]) || @cms_site.pages.root)
+    @cms_page.layout ||= (@cms_page.parent && @cms_page.parent.layout || @cms_site.layouts.first)
   end
   
   def build_upload_file
-    @upload = CmsUpload.new
+    @upload = Cms::Upload.new
   end
   
   def load_cms_page
-    @cms_page = @cms_site.cms_pages.find(params[:id])
+    @cms_page = @cms_site.pages.find(params[:id])
     @cms_page.attributes = params[:cms_page]
-    @cms_page.cms_layout ||= (@cms_page.parent && @cms_page.parent.cms_layout || @cms_site.cms_layouts.first)
+    @cms_page.layout ||= (@cms_page.parent && @cms_page.parent.layout || @cms_site.layouts.first)
   rescue ActiveRecord::RecordNotFound
     flash[:error] = 'Page not found'
     redirect_to :action => :index
@@ -96,7 +96,7 @@ protected
   
   def preview_cms_page
     if params[:preview]
-      layout = @cms_page.cms_layout.app_layout.blank?? false : @cms_page.cms_layout.app_layout
+      layout = @cms_page.layout.app_layout.blank?? false : @cms_page.layout.app_layout
       render :inline => @cms_page.content(true), :layout => layout
     end
   end

data/app/controllers/cms_admin/sites_controller.rb

@@ -6,8 +6,8 @@ class CmsAdmin::SitesController < CmsAdmin::BaseController
   before_filter :load_cms_site,   :only => [:edit, :update, :destroy]
   
   def index
-    return redirect_to :action => :new if CmsSite.count == 0
-    @cms_sites = CmsSite.all
+    return redirect_to :action => :new if Cms::Site.count == 0
+    @cms_sites = Cms::Site.all
   end
   
   def new
@@ -45,12 +45,12 @@ class CmsAdmin::SitesController < CmsAdmin::BaseController
 protected
   
   def build_cms_site
-    @cms_site = CmsSite.new(params[:cms_site])
+    @cms_site = Cms::Site.new(params[:cms_site])
     @cms_site.hostname ||= request.host.downcase
   end
   
   def load_cms_site
-    @cms_site = CmsSite.find(params[:id])
+    @cms_site = Cms::Site.find(params[:id])
   rescue ActiveRecord::RecordNotFound
     flash[:error] = 'Site not found'
     redirect_to :action => :index

data/app/controllers/cms_admin/snippets_controller.rb

@@ -4,8 +4,8 @@ class CmsAdmin::SnippetsController < CmsAdmin::BaseController
   before_filter :load_cms_snippet,  :only => [:edit, :update, :destroy]
   
   def index
-    return redirect_to :action => :new if @cms_site.cms_snippets.count == 0
-    @cms_snippets = @cms_site.cms_snippets.all(:order => 'label')
+    return redirect_to :action => :new if @cms_site.snippets.count == 0
+    @cms_snippets = @cms_site.snippets.all(:order => 'label')
   end
   
   def new
@@ -43,11 +43,11 @@ class CmsAdmin::SnippetsController < CmsAdmin::BaseController
 protected
   
   def build_cms_snippet
-    @cms_snippet = @cms_site.cms_snippets.new(params[:cms_snippet])
+    @cms_snippet = @cms_site.snippets.new(params[:cms_snippet])
   end
   
   def load_cms_snippet
-    @cms_snippet = @cms_site.cms_snippets.find(params[:id])
+    @cms_snippet = @cms_site.snippets.find(params[:id])
   rescue ActiveRecord::RecordNotFound
     flash[:error] = 'Snippet not found'
     redirect_to :action => :index

data/app/controllers/cms_admin/uploads_controller.rb

@@ -7,7 +7,7 @@ class CmsAdmin::UploadsController < CmsAdmin::BaseController
   end
   
   def create
-    @cms_upload = @cms_site.cms_uploads.create!(:file => params[:file])
+    @cms_upload = @cms_site.uploads.create!(:file => params[:file])
     render :partial => 'file', :object => @cms_upload
   rescue ActiveRecord::RecordInvalid
     render :nothing => true, :status => :bad_request
@@ -20,7 +20,7 @@ class CmsAdmin::UploadsController < CmsAdmin::BaseController
 protected
   
   def load_cms_upload
-    @cms_upload = @cms_site.cms_uploads.find(params[:id])
+    @cms_upload = @cms_site.uploads.find(params[:id])
   rescue ActiveRecord::RecordNotFound
     render :nothing => true
   end

data/app/controllers/cms_content_controller.rb

@@ -1,14 +1,19 @@
 class CmsContentController < ApplicationController
   
   before_filter :load_cms_site
+  before_filter :load_fixtures
   before_filter :load_cms_page,   :only => :render_html
   before_filter :load_cms_layout, :only => [:render_css, :render_js]
   
   caches_page :render_css, :render_js, :if => Proc.new { |c| ComfortableMexicanSofa.config.enable_caching }
   
   def render_html(status = 200)
-    layout = @cms_page.cms_layout.app_layout.blank?? false : @cms_page.cms_layout.app_layout
-    render :inline => @cms_page.content, :layout => layout, :status => status
+    if layout = @cms_page.layout
+      app_layout = layout.app_layout.blank?? false : layout.app_layout
+      render :inline => @cms_page.content, :layout => app_layout, :status => status
+    else
+      render :text => 'Layout Not Found', :status => 404
+    end
   end
   
   def render_css
@@ -21,18 +26,26 @@ class CmsContentController < ApplicationController
   
 protected
   
+  def load_fixtures
+    return unless ComfortableMexicanSofa.config.enable_fixtures
+    ComfortableMexicanSofa::Fixtures.sync(@cms_site)
+  end
+  
   def load_cms_site
-    @cms_site = CmsSite.find_by_hostname!(ComfortableMexicanSofa.config.override_host || request.host.downcase)
-  rescue ActiveRecord::RecordNotFound
-    render :text => 'Site Not Found', :status => 404
+    @cms_site = if ComfortableMexicanSofa.config.enable_multiple_sites
+      Cms::Site.find_by_hostname(request.host.downcase)
+    else
+      Cms::Site.first
+    end
+    render :text => 'Site Not Found', :status => 404 if !@cms_site
   end
   
   def load_cms_page
-    @cms_page = CmsPage.published.load_for_full_path!(@cms_site, "/#{params[:cms_path]}")
+    @cms_page = @cms_site.pages.published.find_by_full_path!("/#{params[:cms_path]}")
     return redirect_to(@cms_page.target_page.full_path) if @cms_page.target_page
     
   rescue ActiveRecord::RecordNotFound
-    if @cms_page = CmsPage.published.load_for_full_path(@cms_site, '/404')
+    if @cms_page = @cms_site.pages.published.find_by_full_path('/404')
       render_html(404)
     else
       render :text => 'Page Not Found', :status => 404
@@ -40,7 +53,7 @@ protected
   end
   
   def load_cms_layout
-    @cms_layout = CmsLayout.load_for_slug!(@cms_site, params[:id])
+    @cms_layout = @cms_site.layouts.find_by_slug!(params[:id])
   rescue ActiveRecord::RecordNotFound
     render :nothing => true, :status => 404
   end

data/app/models/cms/block.rb

@@ -0,0 +1,13 @@
+class Cms::Block < ActiveRecord::Base
+  
+  set_table_name :cms_blocks
+  
+  # -- Relationships --------------------------------------------------------
+  belongs_to :page
+  
+  # -- Validations ----------------------------------------------------------
+  validates :label,
+    :presence   => true,
+    :uniqueness => { :scope => :page_id }
+  
+end

data/app/models/{cms_layout.rb → cms/layout.rb}

@@ -1,23 +1,25 @@
-class CmsLayout < ActiveRecord::Base
+class Cms::Layout < ActiveRecord::Base
+  
+  set_table_name :cms_layouts
   
   acts_as_tree
   
   # -- Relationships --------------------------------------------------------
-  belongs_to :cms_site
-  has_many :cms_pages, :dependent => :nullify
+  belongs_to :site
+  has_many :pages, :dependent => :nullify
   
   # -- Callbacks ------------------------------------------------------------
   after_save    :clear_cache, :clear_cached_page_content
   after_destroy :clear_cache, :clear_cached_page_content
   
   # -- Validations ----------------------------------------------------------
-  validates :cms_site_id,
+  validates :site_id,
     :presence   => true
   validates :label,
     :presence   => true
   validates :slug,
     :presence   => true,
-    :uniqueness => { :scope => :cms_site_id },
+    :uniqueness => { :scope => :site_id },
     :format     => { :with => /^\w[a-z0-9_-]*$/i }
   validates :content,
     :presence   => true
@@ -25,13 +27,13 @@ class CmsLayout < ActiveRecord::Base
     
   # -- Class Methods --------------------------------------------------------
   # Tree-like structure for layouts
-  def self.options_for_select(cms_site, cms_layout = nil, current_layout = nil, depth = 0, spacer = '. . ')
+  def self.options_for_select(site, layout = nil, current_layout = nil, depth = 0, spacer = '. . ')
     out = []
-    [current_layout || cms_site.cms_layouts.roots].flatten.each do |layout|
-      next if cms_layout == layout
-      out << [ "#{spacer*depth}#{layout.label}", layout.id ]
-      layout.children.each do |child|
-        out += options_for_select(cms_site, cms_layout, child, depth + 1, spacer)
+    [current_layout || site.layouts.roots].flatten.each do |l|
+      next if layout == l
+      out << [ "#{spacer*depth}#{l.label}", l.id ]
+      l.children.each do |child|
+        out += options_for_select(site, layout, child, depth + 1, spacer)
       end
     end
     return out.compact
@@ -46,36 +48,6 @@ class CmsLayout < ActiveRecord::Base
     end.compact
   end
   
-  # Attempting to initialize layout object from yaml file that is found in config.seed_data_path
-  def self.load_from_file(site, slug)
-    return nil if ComfortableMexicanSofa.config.seed_data_path.blank?
-    file_path = "#{ComfortableMexicanSofa.config.seed_data_path}/#{site.hostname}/layouts/#{slug}.yml"
-    return nil unless File.exists?(file_path)
-    attributes            = YAML.load_file(file_path).symbolize_keys!
-    attributes[:parent]   = CmsLayout.load_from_file(site, attributes[:parent])
-    attributes[:cms_site] = site
-    new(attributes)
-  rescue
-    raise "Failed to load from #{file_path}"  
-  end
-  
-  # Wrapper around load_from_file and find_by_slug
-  # returns layout object if loaded / found
-  def self.load_for_slug!(site, slug)
-    if ComfortableMexicanSofa.configuration.seed_data_path
-      load_from_file(site, slug)
-    else
-      site.cms_layouts.find_by_slug(slug)
-    end || raise(ActiveRecord::RecordNotFound, "CmsLayout with slug: #{slug} cannot be found")
-  end
-  
-  # Non-blowing-up version of the method above
-  def self.load_for_slug(site, slug)
-    load_for_slug!(site, slug) 
-  rescue ActiveRecord::RecordNotFound
-    nil
-  end
-  
   # -- Instance Methods -----------------------------------------------------
   # magical merging tag is {cms:page:content} If parent layout has this tag
   # defined its content will be merged. If no such tag found, parent content
@@ -96,8 +68,8 @@ class CmsLayout < ActiveRecord::Base
 protected
   
   def check_content_tag_presence
-    CmsTag.process_content((test_page = CmsPage.new), content)
-    if test_page.cms_tags.select{|t| t.class.superclass == CmsBlock}.blank?
+    ComfortableMexicanSofa::Tag.process_content((test_page = site.pages.new), content)
+    if test_page.tags.select{|t| t.is_cms_block?}.blank?
       self.errors.add(:content, 'No cms page tags defined')
     end
   end
@@ -111,7 +83,7 @@ protected
   
   # Forcing page content reload
   def clear_cached_page_content
-    self.cms_pages.each{ |page| page.save! }
+    self.pages.each{ |page| page.save! }
     self.children.each{ |child_layout| child_layout.save! }
   end