mcms_pages 0.0.1

data/app/assets/stylesheets/mcms_pages/pages.css.scss

@@ -0,0 +1,172 @@
+/*
+
+*    @File Name                 : pages.css.scss
+*    @Company Name              : Mindfire Solutions Private Limited
+*    @Creator Name              : Vikram Kumar Mishra
+*    @Date Created              : 2012-06-06
+*    @Date Modified             : 2012-06-09
+*    @Last Modification Details : Styles added for some elements
+*    @Purpose                   : Place all the styles related to the pages controller here.
+
+*/
+
+
+ li{
+     list-style-type: none;
+     display:inline;
+}
+
+.even
+{
+    background-color: aquamarine;
+}
+
+.pages-clearfix:after {
+    clear: both;
+    content: ".";
+    display: block;
+    height: 0;
+    visibility: hidden;
+}
+
+.pages-clearfix {
+    display: block;
+}
+
+#application-actions{
+    float: right;
+    padding-left: 15px;
+    padding-top: 0;
+    width: 30.7%;
+}
+
+
+#pages-records {
+
+    float: left;
+    width: 67.7%;
+    border: 1px solid red;
+
+    #page-sortable-list {
+        margin-top: 6px;
+
+        li{
+            padding: 4px 0 0 40px;
+
+            div{
+                width: 100%;
+
+                span.page-icon{
+                    background: url("icons/page.png") no-repeat scroll center center transparent;
+                    display: block;
+                    float: left;
+                    height: 16px;
+                    margin: 3px 3px 0 0;
+                    width: 16px;
+                }
+
+                span.page-icon.page-toggle.page-expanded{
+                    background-image: url("icons/folder_open.png");
+                }
+
+                span.page-icon.page-toggle{
+                    background-image: url("icons/folder_open.png");
+                }
+
+                .page-title{
+                    width:80%;
+                    text-align:left;
+                }
+
+                .page-actions{
+                    display: inline;
+                    line-height: 28px;
+                    float: right;
+                    position:relative;
+                    top: 3px;
+                    width: 120px;
+                    text-align: right;
+
+                    a{
+                        margin: 3px 3px 0;
+                    }
+                }
+            }
+        }
+    }
+}
+
+#pages-records.pages-tree ul li, .pages-tree ul li {
+    background: url("branch.gif") no-repeat scroll 15px 0 transparent;
+    margin: 0;
+    padding: 4px 0 0 40px;
+}
+
+#pages-records.pages-tree li {
+    line-height: 25px;
+}
+
+#pages-records > ul li{
+    line-height: 35px;
+    list-style: none outside none;
+    margin-bottom: 2px;
+    padding: 0 5px;
+    position: relative;
+    vertical-align: top;
+}
+
+#pages-records.pages-tree ul li.pages-tree-start, .pages-tree ul li.pages-tree-start {
+    background-image: url("branch-start.gif");
+}
+
+#pages-records.pages-tree ul li, .pages-tree ul li {
+    background: url("branch.gif") no-repeat scroll 15px 0 transparent;
+    margin: 0;
+    padding: 4px 0 0 40px;
+}
+
+.pages-clearfix {
+    display: block;
+}
+
+#pages-records.pages-tree ul li.pages-tree-end, .pages-tree ul li.pages-tree-end {
+    background-image: url("branch-end.gif");
+}
+
+#pages-records.pages-tree li.pages-record ul {
+    margin-left: 0;
+}
+
+#pages-records.pages-tree ul li ul, .pages-tree ul li ul {
+    padding: 0;
+}
+
+.error-explanation
+{
+    color: red;
+    text-align: left;
+}
+
+.pages-menu {
+
+    width: 100%;
+    float: left;
+    text-align: right;
+    margin-bottom: 10px;
+
+}
+
+.pages-menu-li{
+
+    list-style-type: none;
+    float: left;
+    margin-left: 10px;
+}
+
+.pages-menu-li ul {display: none; }
+
+.notice {
+	color: green;
+	font-size: 16px;
+}
+

data/app/controllers/admin/layouts_controller.rb

@@ -0,0 +1,51 @@
+=begin
+
+  @File Name                 : admin/layouts_controller.rb
+  @Company Name              : Mindfire Solutions Private Limited
+  @Creator Name              : Vikram Kumar Mishra
+  @Date Created              : 2012-06-15
+  @Date Modified             :
+  @Last Modification Details :
+  @Purpose                   : To setup the communication between layout model and views related to layouts under namespace admin.
+
+=end
+
+class Admin::LayoutsController < AdminController
+
+  before_filter :load_assets
+
+  # GET /layouts
+  # GET /layouts.json
+  # To find all layouts and display it to the user to choose one
+  def index
+
+    # find all layouts
+    @layouts = Layout.all
+
+    # find parent_id of page if child page is being created
+    # if parent_id is not there i.e. child page is not being created,
+    # use parent_id as 0
+    @page_parent_id = (params[:parent_id]) ? params[:parent_id] : 0
+
+    # send data in different format
+    respond_to do |format|
+      format.html{render :template => 'mcms_pages/admin/layouts/index'}# index.html.erb
+      format.json { render json: @pages }
+    end # end respond_to
+
+  end # end action
+
+  #defining controller specific method as protected
+  protected
+
+  #calling library class AssetManager's methods to include specific js and css files
+  def load_assets
+
+    # class method call to include css files
+    AssetManager.include_css ["mcms_pages/layout"]
+
+  end # end method
+
+
+end # end class
+

data/app/controllers/admin/pages_controller.rb

@@ -0,0 +1,303 @@
+=begin
+
+  @File Name                 : admin/pages_controller.rb
+  @Company Name              : Mindfire Solutions Private Limited
+  @Creator Name              : Vikram Kumar Mishra
+  @Date Created              : 2012-06-05
+  @Date Modified             : 2012-06-08
+  @Last Modification Details : Page part saved successfully
+  @Purpose                   : To setup the communication between page model and views related to pages under namespace admin.
+
+=end
+
+class Admin::PagesController < AdminController
+
+  #includes helper file
+  include PagesHelper
+
+  # loading controller specific assets
+  before_filter :load_assets
+
+  # GET /pages
+  # GET /pages.json
+  # finds all pages created so far and displays it
+  # It may change in future
+  def index
+
+    # find all pages
+    @pages = Page.all
+
+    # send data in different format
+    respond_to do |format|
+      format.html{render :template => 'mcms_pages/admin/pages/index'}# index.html.erb
+      format.json { render json: @pages }
+    end # end respond_to
+
+  end # end action
+
+  # GET /pages/new
+  # GET /pages/new.json
+  # renders the form for new page and also page part
+  # to save page and page part together successfully
+  def new
+
+    # check if params[:layout_id] is present
+    if not params[:layout_id]
+
+      # if not redirect to layout page
+      redirect_to admin_layouts_path(:parent_id => params[:parent_id])
+
+    else # params[:layout_id] is present
+
+      #initializing an empty object
+      @page = Page.new
+
+      #retrieve parent_id parameter
+      @page.parent_id = params[:parent_id]
+
+      #retrieving layout id from params and assigning to a variable
+      @layout = params[:layout_id]
+
+      # calling method to find all pages and page parts
+      find_pages_and_parts(@layout)
+
+      #calling method to build page parts
+      build_page_parts(@parts)
+
+      #sends data in different formats
+      respond_to do |format|
+
+        format.html{render :template => 'mcms_pages/admin/pages/new'}# new.html.erb
+        format.json { render json: @page }
+
+      end # end respond_to block
+
+    end # end if
+
+  end # end action
+
+  # GET /pages/1/edit
+  # finds the page with given ID and displays the
+  # fields with value to edit, i.e. edit form
+  def edit
+
+    # find page with given ID
+    #@page = Page.find(params[:id])
+    @page = Page.find_by_slug_or_id(params[:path], params[:id])
+
+    #retrieving layout id from params and assigning to a variable
+    @layout = @page["layout_id"]
+
+    # calling method to find all pages and page parts
+    find_pages_and_parts(@layout)
+
+    # calling method to define parts of the page
+    define_parts
+
+    #sends data in different formats
+    respond_to do |format|
+
+      format.html{render :template => 'mcms_pages/admin/pages/edit'}# edit.html.erb
+      format.json { render json: @page }
+
+    end # end respond_to block
+
+  end # end action
+
+  # POST /pages
+  # POST /pages.json
+  # saves page with page parts and redirects to the
+  # current created page
+  def create
+
+    # retrieve page part attributes from params and assign it to a variable
+    page_parts = params[:page][:page_parts_attributes]
+
+    # sort the page_parts and reassign it to the params
+    params[:page][:page_parts_attributes] = Hash[page_parts.sort]
+
+    #creating the page object with its own and child attributes
+    @page = Page.new(params[:page])
+
+    #retrieving layout id from params and assigning to a variable
+    @layout = params[:page][:layout_id]
+
+    # calling method to find all pages and page parts
+    find_pages_and_parts(@layout)
+
+    # sends the data in different formats
+    respond_to do |format|
+
+      if @page.save #page saved successfully
+
+        format.html { redirect_to admin_pages_path, notice: 'Page was successfully created.' }
+        format.json { render json: @page, status: :created, location: @page }
+
+      else #page saving failed, re-render the form
+
+        format.html { render action: "new" }
+        format.json { render json: @page.errors, status: :unprocessable_entity }
+
+      end # end if
+
+    end # end respond_to block
+
+  end # end action
+
+  # PUT /pages/1
+  # PUT /pages/1.json
+  # Gets the ID via put method and updates the field
+  # and redirects to current edited page
+  def update
+
+    #find the page with given id
+    @page = Page.find(params[:id])
+
+    #retrieving layout id from params and assigning to a variable
+    @layout = @page[:layout_id]
+
+    # calling method to find all pages and page parts
+    find_pages_and_parts(@layout)
+
+    # calling method to define parts of the page
+    define_parts
+
+    #sends in data in different format
+    respond_to do |format|
+
+      if @page.update_attributes(params[:page]) #page updated successfully
+        format.html { redirect_to admin_pages_path, notice: 'Page was successfully updated.' }
+        format.json { head :no_content }
+      else #page saving failed, re-renders edit template
+        format.html { render action: "edit" }
+        format.json { render json: @page.errors, status: :unprocessable_entity }
+
+      end # end if
+
+    end # end respond_to block
+
+  end # end action
+
+  # DELETE /pages/1
+  # DELETE /pages/1.json
+  # destroys the page on the basis of ID
+  # and redirects to all pages path
+  def destroy
+
+    # find the page with with
+    @page = Page.find(params[:id])
+
+    #destroy the page
+    @page.destroy
+
+    #sends in data in different format to index action
+    respond_to do |format|
+
+      format.html { redirect_to admin_pages_url }
+      format.json { head :no_content }
+
+    end # end respond_to block
+
+  end # end action
+
+
+  # @param   : None
+  # @return  : None
+  # @purpose : To find a child page
+  def find_child
+
+    @page = Page.find_by_slug(params[:path])
+
+    logger.debug @page
+    render :layout => false
+
+  end
+
+  # @param    : Object(as a string)
+  # @return   : None
+  # @purpose  : To render a page part dynamically
+  def add_page_part
+
+    #retrieve parameters and assign these to  instance variables
+    @title = params[:title]
+    @index = params[:index]
+
+    # render js.erb
+    respond_to do |format|
+
+      format.js{render :template => 'mcms_pages/admin/pages/add_page_part'}
+
+    end # end respond_to
+
+  end # end method
+
+
+  #defining controller specific method as protected
+  protected
+
+  #calling library class AssetManager's methods to include specific js and css files
+  def load_assets
+
+    # class method call to include js files
+    AssetManager.include_local_library [:application, :pageFormAdmin, "ckeditor/init"]
+
+    # class method call to include css files
+    AssetManager.include_css ["mcms_pages/pages", "mcms_pages/page_styles"]
+
+  end # end method
+
+  # @param    : Array
+  # @return   : None
+  # @purpose  : To build page parts for a page
+  def build_page_parts(parts)
+
+    #renders the form field for each part of layout
+    parts.each_with_index do |page_part, index|
+
+      fragment = get_fragments(index, page_part)
+
+      # check if same type of fragment is already created
+      if fragment.nil? or fragment.blank? or fragment.empty?
+
+        # if not then build child pages for all parts of the layout
+        @page.page_parts.build(:title => page_part)
+
+      else
+
+        # if yes then build child form for page_part_pages
+        @page.page_parts_pages.build
+
+      end # end if
+
+    end # end loop
+
+  end # end method
+
+  def find_pages_and_parts layout
+
+    #calling find_all_pages method from Page model
+    @pages = Page.find_all_pages
+
+    # storing the array returned by helper method to
+    # decide the page parts in a layout
+    @parts = Layout.find_page_parts(layout)
+
+  end
+
+  def define_parts
+
+    # declare an empty hash
+    @part_title = Hash.new
+
+    # loop through each part of the page
+    @parts.each_with_index do  |part,index|
+
+      # retrieve the id of page parts of the page based on title and store it as a hash element
+      @part_title[part] = @page.page_parts.select("mcms_page_parts.id").find_by_title(part).id
+
+    end # end loop
+
+  end
+
+end #end class
+

data/app/controllers/admin_controller.rb

@@ -0,0 +1,22 @@
+=begin
+
+  @File Name                 : admin_controller.rb
+  @Company Name              : Mindfire Solutions Private Limited
+  @Creator Name              : Vikram Kumar Mishra
+  @Date Created              : 2012-06-05
+  @Date Modified             :
+  @Last Modification Details :
+  @Purpose                   : To check current user's access, It is yet to implement.
+
+=end
+
+class AdminController < ApplicationController
+
+  #admin part
+  layout "mcms_pages/layouts/mcms_layout"
+
+  prepend_before_filter :authenticate_user!
+  load_and_authorize_resource
+
+end
+

data/app/controllers/application_controller.rb

@@ -0,0 +1,20 @@
+=begin
+
+  @File Name                 : application_controller.rb
+  @Company Name              : Mindfire Solutions Private Limited
+  @Creator Name              : Vikram Kumar Mishra
+  @Date Created              : 2012-06-05
+  @Date Modified             :
+  @Last Modification Details :
+  @Purpose                   : To navigate between different controllers throughout the application.
+                               Its the backbone of the application.
+
+=end
+
+class ApplicationController < ActionController::Base
+
+  #calling rails standard method to request forgery protection for non-GET, HTML/JAVASCRIPT requests
+  protect_from_forgery
+
+end # end class
+

data/app/controllers/pages_controller.rb

@@ -0,0 +1,151 @@
+=begin
+
+  @File Name                 : pages_controller.rb
+  @Company Name              : Mindfire Solutions Private Limited
+  @Creator Name              : Vikram Kumar Mishra
+  @Date Created              : 2012-06-05
+  @Date Modified             :
+  @Last Modification Details :
+  @Purpose                   : To setup the communication between page model and views related to pages for users,
+                               It's yet to be implemented.
+
+=end
+
+class PagesController < ApplicationController
+
+  # loading controller specific assets
+  before_filter :load_assets
+  layout "mcms_pages/layouts/mcms_layout"
+
+  #finding page based on url
+  before_filter :get_page, :except => [:preview]
+
+  # GET / or GET /home
+  # @params  : none
+  # return   : none
+  # @purpose : To show the home page
+  def home
+
+    respond_to do |format|
+
+      format.html{ render :template => 'mcms_pages/pages/home'}# home.html.erb
+      format.json { render json: @page }
+
+    end # end respond_to block
+
+  end # end action
+
+  # GET /1 or GET /page-title
+  # GET /1.json or GET /page-title.json
+  # @params  : integer or string through url
+  # return   : none
+  # @purpose : To show the page with custom url to the user
+  def show
+
+    # if page is not publeshed
+    if not @page.published?
+
+      # show page 404
+      page_404_error
+
+    # if link_url is present for page
+    elsif @page.link_url.present? and @page.link_url != '/404'
+
+      # redirect to given link url
+      redirect_to @page.link_url
+
+    else
+
+      # send data in different format
+      respond_to do |format|
+
+        format.html{ render :template => 'mcms_pages/pages/show'}# show.html.erb
+        format.json { render json: @page }
+
+      end # end respond_to block
+
+    end # end if
+
+  end # end action
+
+  # GET /pages/1 or GET /pages/page-title
+  # GET /pages/1.json or GET /pages/page-title.json
+  # @params  : integer or string through url
+  # return   : none
+  # @purpose : To show the page preview with custom url to admin
+  def preview
+
+    if get_page(page_not_found = false)
+
+      # Preview existing pages
+      @page.attributes = params[:page]
+
+    elsif params[:page]
+
+      # Preview a non-persisted page
+      @page = Page.new(params[:page])
+
+    end # end if
+
+    # send data in different format
+    respond_to do |format|
+
+      format.html{ render :template => 'mcms_pages/pages/show'}
+      format.json { render json: @page }
+
+    end # end respond_to block
+
+  end # end method preview
+
+  #defining controller specific method as protected
+  protected
+
+  #calling library class AssetManager's methods to include specific js and css files
+  def load_assets
+
+    # class method call to include css files
+    AssetManager.include_css ["mcms_pages/pages", "mcms_pages/page_styles"]
+
+  end # end method
+
+  # @param   : boolean(optional)
+  # @return  : none
+  # @purpose : To find a page if it exists or show the page not found error
+  def get_page(page_not_found = true)
+
+    @menu_pages = Page.where(:published => true)
+
+    # case statement based on current action and assign the result to instance variable
+    case action_name
+
+      # when action is home
+      when "home"
+
+        # find page bbased on link url
+        @page = Page.where(:link_url => '/').first
+
+      # when action is show or preview
+      when "show", "preview"
+
+        # find page using path or id of page
+        @page = Page.find_by_slug_or_id(params[:path], params[:id])
+
+    end # end case statement
+
+    # return page or page not found error
+    @page || ( page_404_error if page_not_found)
+
+  end # end method
+
+  # @param   : none
+  # @return  : none
+  # @purpose : To show custom 404 page if page with given ID does not exist
+  def page_404_error
+
+    # find page based on link_url and assign it to an instance variable
+    @page = Page.where(:link_url => "/404").first
+
+  end # end method
+
+end #end class
+