liquid_cms 0.2.0

data/.gitignore

@@ -0,0 +1,5 @@
+pkg/*
+*.gem
+*.swp
+.bundle
+test/rails_app/log

data/CHANGELOG.rdoc

@@ -0,0 +1,3 @@
+== 0.5.0
+
+* First release

data/Gemfile

@@ -0,0 +1,4 @@
+source :gemcutter
+
+# Specify your gem's dependencies in liquid_cms.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Redline Software Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,57 @@
+= Liquid CMS
+
+A context aware CMS Ruby on Rails engine that uses liquid templates.
+
+If you're using rails 2, use the 0.2.x series of this gem.
+
+If you're using rails 3, use the 0.3.x series of this gem.
+
+= Installation
+
+Install the gem:
+
+  gem install liquid_cms
+
+Add it to your config/environment.rb:
+
+  config.gem 'liquid_cms', '~> 0.2.0'
+
+Run the generator:
+
+  script/generator liquid_cms
+
+= Configuration
+
+Configure the engine in config/initializers/cms/liquid_cms.rb:
+
+  If you wish to run the cms under multiple "contexts" (ie. a cms each for a company, business, customer, etc.) then you need to perform the following steps:
+  
+    * Set the *context_class* attribute to your apps context class:
+
+      config.context_class = :Company
+
+    * And then set the context object in the Cms::SetupController or any controller up the inheritance chain.
+
+      Cms.set_context @company, self
+
+Add any controller specific tasks and customize the logic in app/controllers/cms/setup_controller.rb
+
+Run the migration:
+
+  rake db:migrate
+
+If you later decide to use the engine under a context, you'll have to re-run the migration.
+
+= Usage
+
+Once the engine is configured, you can view the CMS at the <b>/cms</b> path in your browser.
+
+= Customization
+
+In order to expose data in your application in the templates, liquid filters, drops, tags and blocks specific to your application can be added to the <b>app/liquid</b> folder.  Knowledge of liquid templates and the liquid library is required to do this.  Examples of custom filters, drops, tags and blocks can be found in the liquid_cms gem files or in additional documentation on this website or related forums.
+
+A set of filters, drops and tags are provided in addition to the defaults provided by liquid.  The documentation link accessible in the CMS provides additional details.
+
+= Contribution
+
+If you experience any issues with this CMS engine, please open a bug report.  Contributionis to improve this engine is extremely welcome.  A 1.0 release will be made when the engine has a bit more _polish_ on it.

data/Rakefile

@@ -0,0 +1,19 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake'
+require 'rake/testtask'
+
+desc 'Default: run tests.'
+task :default => :test
+
+desc 'Test the liquid_cms gem.'
+task :test => ['test:unit', 'test:functional', 'test:integration']
+
+%w(unit functional integration).each do |test|
+  desc "Run the #{test} tests for the liquid_cms gem."
+  Rake::TestTask.new("test:#{test}") do |t|
+    t.pattern = "test/#{test}/*_test.rb"
+    t.verbose = true
+  end
+end

data/TODO.rdoc

@@ -0,0 +1,7 @@
+* Implement a cleaner, more functional UI.
+* Vestal versions is used, but not exposed via the UI currently to go back to previous versions.
+* No functions are currently limited to specific user roles.  All CMS users can perform the same actions.
+* Implement caching and expiration logic.
+* Provide example apache/nginx/etc. conf files that properly scope cms assets for each context.
+* Generate CMS documentation from rdoc comments in source files.
+* Missing tests... add more coverage.

data/app/controllers/cms/assets_controller.rb

@@ -0,0 +1,47 @@
+class Cms::AssetsController < Cms::MainController
+  authenticate_user :all
+
+  def show
+    @asset = @context.assets.find params[:id]
+  end
+
+  def new
+    @asset = Cms::Asset.new
+  end
+
+  def create
+    @asset = @context.assets.build params[:cms_asset]
+    if @asset.save
+      flash[:notice] = t('assets.flash.created')
+      redirect_to cms_root_path
+    else
+      render :action => 'new'
+    end
+  end
+
+  def edit
+    @asset = @context.assets.find params[:id]
+  end
+
+  def update
+    @asset = @context.assets.find params[:id]
+    if @asset.update_attributes params[:cms_asset]
+      flash[:notice] = t('assets.flash.updated')
+      redirect_to cms_root_path
+    else
+      render :action => 'edit'
+    end
+  end
+
+  def destroy
+    @asset = @context.assets.find(params[:id])
+    @asset.destroy
+
+    flash[:notice] = t('assets.flash.deleted')
+    
+    respond_to do |format|
+      format.html { redirect_to cms_root_path }
+      format.js
+    end
+  end
+end

data/app/controllers/cms/components_controller.rb

@@ -0,0 +1,56 @@
+class Cms::ComponentsController < Cms::MainController
+  authenticate_user :all
+
+  before_filter :load_component_path, :except => :upload
+
+  def edit
+    if Cms::Component.editable?(@path)
+      @component = Cms::Component.new(@context, @path)
+    else
+      flash[:error] = "Not an editable component."
+      redirect_to cms_root_path
+    end
+  end
+
+  def update
+    if Cms::Component.editable?(@path)
+      @component = Cms::Component.new(@context, @path)
+      @component.write params[:contents]
+
+      flash[:notice] = "Component file updated."
+      redirect_to :controller => 'cms/components', :action => 'edit', :url => @path
+    else
+      flash[:error] = "Not an editable file."
+      redirect_to cms_root_path
+    end
+  end
+
+  def destroy
+    if @path.present? && Cms::Component.new(@context, @path).delete
+      flash[:notice] = 'The component has been removed.'
+    else
+      flash[:error] = 'The component path was invalid.'
+    end
+
+    redirect_to cms_root_path
+  end
+
+  def upload
+    component_zip = params[:zip_file]
+
+    if component_zip.present? && File.extname(component_zip.original_filename) == '.zip'
+      Cms::Component.new(@context).expand component_zip.path
+      flash[:notice] = 'The component has been uploaded.'
+    else
+      flash[:error] = 'The component file must be a zip archive.'
+    end
+
+    redirect_to cms_root_path
+  end
+
+protected
+  def load_component_path
+    @path = params[:url].first
+    @path = CGI::unescape(@path) if @path.present?
+  end
+end

data/app/controllers/cms/documentation_controller.rb

@@ -0,0 +1,4 @@
+class Cms::DocumentationController < Cms::MainController
+  def index
+  end
+end

data/app/controllers/cms/main_controller.rb

@@ -0,0 +1,22 @@
+class Cms::MainController < Cms::SetupController
+  unloadable
+  extend Cms::RoleAuthentication
+
+  layout 'cms'
+
+  before_filter :load_pages_and_assets
+
+  authenticate_user :all, :only => %w(index)
+
+  def index
+    render :partial => 'cms/shared/index', :layout => true
+  end
+
+protected
+  def load_pages_and_assets
+    @context = Cms::Context.new(@cms_context)
+
+    @pages = @context.pages.ordered.all(:conditions => {:layout_page_id => nil})
+    @assets = @context.assets.ordered
+  end
+end

data/app/controllers/cms/pages_controller.rb

@@ -0,0 +1,92 @@
+class Cms::PagesController < Cms::MainController
+  skip_before_filter :verify_authenticity_token, :only => [:load, :page_asset]
+
+  authenticate_user :all, :except => %w(load page_asset)
+
+  def new
+    @page = Cms::Page.new
+  end
+
+  def create
+    @page = @context.pages.build({:updated_by => current_user}.merge(params[:cms_page] || {}))
+    if @page.save
+      flash[:notice] = t('pages.flash.created')
+      redirect_to cms_root_path
+    else
+      render :action => 'new'
+    end
+  end
+
+  def edit
+    @page = @context.pages.find params[:id]
+  end
+
+  def update
+    @page = @context.pages.find params[:id]
+    if @page.update_attributes({:updated_by => current_user}.merge(params[:cms_page] || {}))
+      flash[:notice] = t('pages.flash.updated')
+      redirect_to edit_cms_page_path(@page)
+    else
+      render :action => 'edit'
+    end
+  end
+
+  def destroy
+    @page = @context.pages.find(params[:id])
+    @page.destroy
+
+    flash[:notice] = t('pages.flash.deleted')
+    
+    respond_to do |format|
+      format.html { redirect_to cms_root_path }
+      format.js
+    end
+  end
+
+  def load
+    # forces removal of any flash values used during this request
+    flash.discard
+
+    path = '/'+params[:url].join('/')
+
+    @page = if path == '/'
+      # if the root path is requested, find the root page or if a root page doesn't exist, get the first published page
+      @context.pages.root || @context.pages.published.first
+    else
+      @context.pages.published.first(:conditions => {:slug => path}) || @context.pages.published.first(:conditions => {:name => params[:url].first}) || @context.pages.published.first(:conditions => {:slug => wildcard_path}) 
+    end
+
+    if @page
+      response.content_type = @page.content_type
+      begin
+        render :text => @page.rendered_content(self)
+      rescue Liquid::SyntaxError, Liquid::ArgumentError, ArgumentError
+        render :text => $!.message
+      rescue Exception => e
+        # add the page content to the exception for a debugging aid
+        f = e.class.new(e.message + "\n\n" + @page.content)
+        f.set_backtrace e.backtrace
+        raise f
+      end
+    else
+      raise ActionController::RoutingError, "No route matches #{params.inspect}"
+    end
+  end
+
+  # for loading stylesheets or javascript content
+  def page_asset
+    @page = @context.pages.find_by_name [params[:id], params[:format]].compact.join('.')
+
+    if @page
+      response.content_type = @page.content_type
+      render :text => @page.rendered_content(self)
+    else
+      render :nothing => true, :status => 404
+    end
+  end
+
+protected
+  def wildcard_path
+    '/'+params[:url].slice(0..-2).join('/')
+  end
+end

data/app/helpers/cms/assets_helper.rb

@@ -0,0 +1,2 @@
+module Cms::AssetsHelper
+end

data/app/helpers/cms/common_helper.rb

@@ -0,0 +1,99 @@
+module Cms::CommonHelper
+  def cms_icon(name, options = {})
+    image_tag "/cms/images/icons/#{name}", options.merge(:size => '16x16')
+  end
+
+  def cms_flash_message
+    type = (flash[:error] ? :error : :notice)
+    javascript_tag("document.observe('dom:loaded', function(){ humanMsg.displayMsg('#{escape_javascript(flash[type])}', '#{type}');})") if flash[type].present?
+  end
+
+  def cms_row_class
+    cycle 'dark', 'light'
+  end
+
+  def codemirror_edit(content_type, form, content_id)
+    js_options = case content_type
+    when "text/css"
+      <<-JS
+      parserfile: ["../../javascripts/parseliquid.js", "parsecss.js"],
+      stylesheet: ["/cms/codemirror/css/csscolors.css", "/cms/stylesheets/liquidcolors.css"],
+      JS
+    when "text/javascript"
+      <<-JS
+      parserfile: ["../../javascripts/parseliquid.js", "tokenizejavascript.js", "parsejavascript.js"],
+      stylesheet: ["/cms/codemirror/css/jscolors.css", "/cms/stylesheets/liquidcolors.css"],
+      JS
+    else
+      <<-JS
+      parserfile: ["../../javascripts/parseliquid.js"],
+      stylesheet: ["/cms/codemirror/css/xmlcolors.css", "/cms/stylesheets/liquidcolors.css"],
+      JS
+    end
+
+    javascript_tag do
+      <<-JS
+      var editor = CodeMirror.fromTextArea("#{content_id}", {
+        #{js_options}
+        path: "/cms/codemirror/js/",
+        textWrapping: false,
+        height: '600px',
+        saveFunction: function() {
+          var form = $$('#{form}').first();
+          $('#{content_id}').setValue(editor.getCode());
+          form.submit();
+        }
+      });
+      JS
+    end
+  end
+
+  def file_type_icon(file_name)
+    icon = case File.extname(file_name).downcase
+    when ".xls"
+      'page_white_excel.png'
+    when ".doc"
+      'page_white_word.png'
+    when ".pdf"
+      'page_white_acrobat.png'
+    when ".zip"
+      'page_white_compressed.png'
+    when ".ppt"
+      'page_white_powerpoint.png'
+    when /\.(ico|bmp|gif|jpg|jpeg|png)$/
+      'page_white_camera.png'
+    when ".js"
+      'script.png'
+    when ".css"
+      'css.png'
+    when ".xml"
+      'xhtml.png'
+    else
+      'page_white.png'
+    end
+
+    cms_icon(icon)
+  end
+
+  def page_icon(page)
+    icon = case page.content_type
+    when 'text/css'
+      'css.png'
+    when 'text/javascript'
+      'script.png'
+    when 'text/xml'
+      'xhtml.png'
+    when 'text/plain'
+      'page_white.png'
+    else
+      'html.png'
+    end 
+
+    cms_icon(icon)
+  end
+
+  def asset_preview_option
+    # __CJ_ is the cookiejar js lib postfix value for cookies
+    ActiveSupport::JSON.decode(cookies[:__CJ_toggle] || '{}')['on'] == false ? 'style="display:none"' : ''
+  end
+end