qcms 1.3.3

data/.gitignore

@@ -0,0 +1,14 @@
+*.log
+db/schema.rb
+db/schema.sql
+.DS_Store
+doc/api
+doc/app
+config/database.yml
+config/settings.yml
+config/authorisation.yml
+nbproject
+pkg/**
+.yardoc/*
+doc/*
+rdoc/*

data/README

@@ -0,0 +1,70 @@
+Qwerty CMS
+==========
+
+A unique CMS provided as a Rails 2 engine
+
+Key Features
+
+* Extended template pathing
+** blog.post.erb.html
+** blog.post.comment.erb.html
+** homepage.erb.html
+** gallery.picture.erb.html
+
+* sitemap.yml
+** A nice way to represent a sites nested structure and defaults for each level such as pagination and ordering
+
+* Not bound to a autherisation or authentication system
+
+== Install
+
+sudo gem install qcms
+
+== Get going
+
+Firstly, it is easiest to start using Skeletor app which provides a bare bones application with examples configuration files, and Authlogic integration.
+
+Otherwise:
+
+Copy the migrations and rake tasks to your Rails app.
+
+config.gem "qcms",  :version => '~>1.0'
+
+Create sitemap.yml (see skeletor for examples)
+
+rake qwerty:bootstrap
+
+== TODO
+
+* migrations to work from inside a gem
+* rake tasks to work from inside a gem.
+* Specify gem dependancies
+
+== Release Gem with Jeweler and Git to RubyGems
+
+(next) git co -b release_1.2.1
+(release_1.2.1) rake version:bump:patch
+(release_1.2.1) git co master
+(master) git merge --no-ff release_1.2.1
+(master) rake release
+(master) git co next
+(next) git merge --no-ff release_1.2.1
+
+== Versioning
+
+Versioning schema: http://semver.org/
+
+== Upgrade Notes
+
+= 1.3
+
+settings.yml
+
+documents
+    cache: true
+
+== Authors
+
+Kris Leech @ Interkonect Limited
+
+http://interkonect.com

data/Rakefile

@@ -0,0 +1,39 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the qwerty plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the qwerty plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Qwerty'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.include('app/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "qcms"
+    gemspec.summary = "A CMS built in collaberation with designers"
+    gemspec.description = "Key CMS features: extended template pathing, sitemap.yml, simple configurable, deeply nestable content"
+    gemspec.email = "kris.leech@interkonect.com"
+    gemspec.homepage = "http://github.com/krisleech/qcms"
+    gemspec.authors = ["Kris Leech"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+1.3.3

data/app/controllers/admin/admin_controller.rb

@@ -0,0 +1,12 @@
+class Admin::AdminController < ApplicationController
+  before_filter :require_user
+
+  layout 'admin'
+
+  def system    
+  end
+
+  def dashboard
+    redirect_to admin_documents_path
+  end
+end

data/app/controllers/admin/documents_controller.rb

@@ -0,0 +1,133 @@
+class Admin::DocumentsController < Admin::AdminController
+  before_filter :find_document, :except => [:index]
+  before_filter :catch_sti_problem, :only => [:update]
+
+  cache_sweeper :document_sweeper, :only => [:create, :update, :destroy]
+
+  def index    
+    @documents = Document.roots.sort_by(&:position)
+  end
+
+  def show    
+    render :text => "Document Not Found [#{params[:id]}]" and return unless @document
+    render :template => admin_view_for('show')
+  end
+
+  def new    
+    @document.type = params[:type] || 'Document'
+    if params[:parent]
+      @document.parent = Document.find(params[:parent])
+      @document.meta_definition = @document.parent.meta_definition.children.by_label(params[:label]).first
+    else
+      @document.meta_definition = MetaDefinition.find_by_label_path(params[:label_path])
+    end    
+    @document.label = params[:label] || @document.meta_definition.label
+    render :template => admin_view_for('new')
+  end
+
+  def create    
+    @document = Document.create(params[:document])
+    @document.type = params[:document][:type] || 'Document'
+    @document.author = current_user
+    if @document.save
+      flash[:notice] = "Succesfully Saved"
+      redirect_to parent_path
+    else           
+      render :template => admin_view_for('new')
+    end    
+  end
+
+  def edit    
+    render :template => admin_view_for('edit')
+  end
+
+  def update
+    if @document.update_attributes(params[:document])
+      flash[:notice] = "Succesfully Saved"
+      redirect_to parent_path
+    else
+      render :template => admin_view_for('edit')
+    end
+  end
+
+  def destroy    
+    @document.destroy
+    redirect_to parent_path
+  end
+
+  def up    
+    @document.move_higher
+    redirect_to parent_path
+  end
+
+  def down    
+    @document.move_lower
+    redirect_to parent_path
+  end
+
+  # Generate a view from template.erb
+  def generate_template
+    if request.post?
+      template = File.new("#{RAILS_ROOT}/app/views/pages/#{@document.meta_definition.label_path.gsub('/', '.')}.html.erb", 'w')
+      template.write(ERB.new(IO.read("#{RAILS_ROOT}/app/views/pages/template.erb")).result(binding))
+      template.close
+    end
+    @document.touch # delete cache (FIXME: Not ideal)
+    redirect_to document_path(@document)
+  end
+
+  private
+  
+  def find_document
+    if params[:id]
+      @document = Document.find(params[:id])
+    else
+      @document = Document.new
+    end
+  end
+
+  def parent_path
+    if @document.parent
+      admin_document_path(@document.parent.id)
+    else
+      admin_dashboard_path
+    end
+  end
+
+
+  # eg. my_first_post.html.erb, blog.post.comment.html.erb, default.html.erb
+  def admin_view_for(action, options = {})
+    options[:extension] = '.html.erb'
+
+    filenames = [@document.permalink, @document.meta_definition.label_path.gsub('/', '.'), 'default']
+    
+    view_paths.each do | view_path |
+      filenames.each do | filename |
+        next if filename.nil?
+        target = File.join('admin', 'documents', filename + '.' + action) + options[:extension]
+        target_with_view_path = File.join(view_path, target)
+        if File.exists? target_with_view_path
+          headers['content-type'] = 'text/html' # Otherwise wrong content-type is set due to multiple file extensions
+          logger.debug 'TEMPLATE FOUND: ' + target_with_view_path
+          return target
+        else
+          logger.debug 'TEMPLATE NOT FOR: ' + target_with_view_path
+        end
+      end
+    end
+    raise 'No Template found'
+  end
+
+
+  # No idea why this happens but if the inputs are (incorrectly) named page[field] instead of document[field] you get
+  # params[:document] from now where. This would be okay but sometimes fields appear to be missing when using fckeditor(!?!)
+  # For the new form @document is_a? Document (not yet 'typed' via STI), but when editing it is_a? Page or Folder...
+  # To get the correct input names @document needs to be type cast to Document class
+  # Example: form_for @document.becomes(Document)
+  def catch_sti_problem
+    return unless RAILS_ENV == 'development'
+    if params[:document] && params[:page]
+      raise 'Both params[:document] and params[:page] found, you might need to add @document.becomes(Document) to get the correct input names'
+    end
+  end
+end

data/app/controllers/admin/meta_definitions_controller.rb

@@ -0,0 +1,36 @@
+class Admin::MetaDefinitionsController < Admin::AdminController
+
+  def index
+  end
+
+  def show
+  end
+
+  def new    
+  end
+
+  def create
+  end
+
+  def edit    
+  end
+
+  def update
+    @meta_definition = MetaDefinition.find(params[:id])
+    if @meta_definition.update_attributes(params[:meta_definition])
+      flash[:notice] = "Succesfully Saved"      
+    else
+      flash[:notice] = 'Not saved'            
+    end
+    redirect_to admin_document_path(params[:document_id])
+  end
+
+ 
+
+
+  
+
+  private
+  
+  
+end

data/app/controllers/documents_controller.rb

@@ -0,0 +1,187 @@
+class DocumentsController < ApplicationController
+  unloadable
+  skip_before_filter  :require_user
+
+  # Show a document:
+  # Route using catch-all, /*path, or, pass specific 'id', :path => 'gallery'
+  def show    
+    render :file => cache_file and return if cached_file?
+    
+    @document = Document.find_by_path(request_path)
+  
+    raise ActiveRecord::RecordNotFound unless @document and (@document.published? or @document.allowed? current_user, 'read')
+
+    respond_to do |format|
+      format.html do
+        setup_view_environment
+        render :template => view_for
+      end
+      format.xml { render :xml => @document.to_xml(:only => [:title, :summary, :body, :published_at, :permalink]) }
+      format.rss { render :template => 'pages/feed.rss.builder' }
+    end
+
+    cache_this_page!
+  end
+  
+  # Show all pages in any Document for a particular month/year
+  # /*path/archive/:month/:year
+  def archive
+    render :file => cache_file and return if cached_file?
+    @document = Document.public.find_by_path(params[:path].join('/'))
+    raise ActiveRecord::RecordNotFound if @document.nil?
+
+ 
+    @documents = @document.archive_for(params[:month], params[:year]).paginate :page => params[:page], :per_page => Settings.documents.per_page
+    render :template => view_for(:suffix => '_archive')
+    cache_this_page!
+  end
+
+  # Allows searching of pages in a folder
+  # /:permalink/search?search[title_like]=hello
+  def search
+    params[:search] ||= {}
+    @document = Document.public.find_by_path(params[:path].join('/'))
+    params[:search].merge!(:parent_id => @document.id)
+    params[:search][:state_eq] = 'published'
+    @documents = Document.search(params[:search]).paginate :page => params[:page], :per_page => Settings.documents.per_page
+    setup_view_environment
+    render :template => view_for(:suffix => '_search')
+  end
+
+  # Allow Document wide search
+  # /search?terms[title_like]=hello
+  def search_all
+    params[:search] ||= {}
+    params[:search][:state_eq] = 'published'
+    @documents = Document.search(params[:search]).paginate :page => params[:page], :per_page => Settings.documents.per_page
+    render :template => '/pages/search'
+  end
+
+  # public facing creation of documents
+  def create
+    @document = Document.public.find(params[:id])
+
+    begin
+      do_human_test
+    rescue
+      flash.now[:notice] = 'You did not add up the numbers correctly, please try again.'
+
+      new_document = Document.new
+      new_document.body = params[:document][:body]
+
+      eval("@new_#{params[:label]} = new_document")
+
+      setup_view_environment
+      render :template => view_for
+      return
+    end
+
+    params[:document][:state] = nil # prevent auto approval hack (FIXME: use attr_protected)
+
+
+    if @document.meta_definition_for(params[:label]).allowed? current_user, 'create'
+
+      new_document = Document.new(params[:document])
+      new_document.parent = @document
+      new_document.label = params[:label]
+      new_document.author = current_user || User.anonymous
+      new_document.published_at = Time.now
+
+      if new_document.save
+        flash[:notice] = new_document.meta_definition.flash_messages['create'] || "Your #{params[:label]} has been saved"
+        if new_document.meta_definition.notify_admins
+          DocumentMailer.deliver_new_document(new_document)
+        end
+        redirect_to document_path(@document)
+      else
+        flash.now[:notice] = 'Could not be saved'
+        eval("@new_#{params[:label]} = new_document")
+        setup_view_environment
+        render :template => view_for
+      end
+    else
+      render :text => 'Not Allowed' and return
+    end
+  end
+  
+  private
+
+  def request_path
+    @path ||= CGI::unescape(request.path[1..-1])
+    @path.blank? ? 'home' : @path
+  end
+
+  # Does a cache exist for this URL
+  def cached_file?
+    Settings.documents.page_cache && File.exists?(cache_file)
+  end
+
+  def cache_file
+    @url_id ||= request_path.split('/').last + (request.query_string.blank? ? '' : '_' + Digest::MD5.hexdigest(request.query_string))
+    @cache_file ||= File.join(RAILS_ROOT, 'public', 'cache', request_path, self.action_name, @url_id) + '.html'
+  end
+
+  def cache_this_page!
+    if Settings.documents.page_cache && !File.exists?(cache_file)
+      logger.debug 'Caching Page: ' + cache_file
+      FileUtils.mkdir_p File.dirname(cache_file)
+      cache = File.open(cache_file, 'w')
+      cache.write(response.body)
+      cache.close
+    end
+  end
+
+  def do_human_test
+    raise 'Human Test Failed' unless params[:human_test][:answer].crypt('humAn5') == params[:human_test][:crypted_answer]
+  end
+
+  def setup_view_environment
+    # create children vars such as @comments
+    if @document.can_have_children?
+      
+      @children = []
+      
+      # make an instance variable for each child eg. @posts @comments etc.
+      @document.child_labels.each do | label|
+        per_page = @document.meta_definition.children.by_label(label).first.per_page || Settings.documents.per_page
+        order = @document.meta_definition.children.by_label(label).first.sort_by || Settings.documents._sort_by
+        instance_variable_set('@' + label.pluralize, @document.children.by_label(label).with_states(:published).paginate(:order => order, :page => params[:page], :per_page => per_page))
+      end
+      
+    end
+   
+    # make instance variable for the parent eg. @story
+    instance_variable_set("@#{@document.label.gsub(' ', '_')}", @document)
+   
+    # HTML meta tags
+    @page_title = @document.meta_title
+    @meta_description = @document.meta_description
+    @meta_keywords = @document.meta_keywords
+  end
+
+
+  # eg. blog.post.comment.html.erb
+  def view_for(options = {})
+    create_missing_template if !params[:create_template].nil? && RAILS_ENV == 'development'
+    
+    options[:extension] = '.html.erb'
+    options[:prefix] ||= ''
+    options[:suffix] ||= ''
+
+    filenames = [@document.permalink, @document.meta_definition.template_filename(false), 'default']
+    
+    view_paths.each do | view_path |
+      filenames.each do | filename |      
+        target = File.join('pages', filename) + options[:suffix] + options[:extension]
+        target_with_view_path = File.join(view_path, target)
+        if File.exists? target_with_view_path
+          logger.debug 'FOUND: ' + target_with_view_path
+          return target
+        else
+          logger.debug 'NOT FOUND: ' + target_with_view_path
+        end
+      end
+    end
+    raise 'No Template found'
+  end
+end