ecm_cms 0.0.1.pre

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Roberto Vasquez Angel
+
+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,55 @@
+= ECM Module Template
+
+= Prerequisites
+
+  * rails ~> 3.2.8
+  * active admin ~> 0.5.0
+
+= Installation
+
+Add it to your bundle:
+
+  # Gemfile:
+  gem 'ecm_cms'
+
+Install your bundle:
+
+  > bundle install
+
+Install the intializer:
+
+  > rails g ecm:cms:install
+
+Install the locales
+
+  > rails g ecm:cms:locales
+
+Generate migrations and migrate:
+
+  > rake ecm_cms_engine:install:migrations
+  > rake db:migrate
+
+= Configuring localized routing
+
+Add the routes to your routing file:
+
+  # config/routes.rb:
+  localized(I18n.available_locales) do
+    scope "/:i18n_locale", :constraints => {:i18n_locale => /#{I18n.available_locales.join('|')}/} do 
+      # ECM CMS
+      Ecm::Cms::Routing.routes(self)
+    end  
+  end  
+  match "/", :to => redirect("/#{I18n.locale}")
+
+= Optional: Generating example/default data
+
+There is a task to prepopulate your database tables with example data.
+
+Warning: *RUNNING THIS WILL DELETE ALL OF YOUR CMS DATA AND REPLACE IT WITH EXAMPLE DATA!*
+
+  > rake ecm:cms:db:populate!
+
+= License
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,27 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'EcmCms'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/assets/stylesheets/ecm_cms.css.less

@@ -0,0 +1,3 @@
+body.active_admin textarea#ecm_cms_page_body, body.active_admin textarea#ecm_cms_template_body, body.active_admin textarea#ecm_cms_partial_body {
+  font-family: Consolas, Monaco,Lucida Console, Liberation Mono, DejaVu Sans Mono, Bitstream Vera Sans Mono, Courier New, monospace;
+}

data/app/controllers/ecm/cms/page_controller.rb

@@ -0,0 +1,11 @@
+class Ecm::Cms::PageController < ApplicationController
+  # inject locale to params and vice versa
+  include RailsTools::I18nController
+  
+  # add the page resolver
+  append_view_path Ecm::Cms::PageResolver.instance unless view_paths.include?(Ecm::Cms::PageResolver.instance)
+
+  def respond
+    render :template => params[:page]
+  end
+end

data/app/helpers/ecm/cms_helper.rb

@@ -0,0 +1,42 @@
+module Ecm::CmsHelper
+  def cms_render_navigation(name, options = {})
+    options.reverse_merge! :renderer => :bootstrap, :expand_all => true
+    navigation = Ecm::Cms::Navigation.where(:name => name.to_s, :locale => I18n.locale.to_s).first
+
+    return I18n.t('ecm.cms.navigation.messages.not_found', {:lang => I18n.locale.to_s, :name => name.to_s}) unless navigation
+
+    options[:items] = []
+    navigation.ecm_cms_navigation_items.roots.all.each do |ni|
+      options[:items] << build_navigation(ni)
+    end
+
+    return I18n.t('ecm.cms.navigation.messages.empty', :lang => I18n.locale.to_s, :name => name) if options[:items].empty?
+    options[:items].first[:options] = {} if options[:items].first[:options].nil?
+    options[:items].first[:options].reverse_merge! :container_class => 'nav'
+    render_navigation(options)
+  end
+
+  def build_navigation(navigation_item)
+    if navigation_item.children.count > 0
+      items = []
+      navigation_item.children.each do |child|
+        items << build_navigation(child)
+      end
+      #output = { :key => navigation_item.key, :name => navigation_item.name, :url => eval(navigation_item.url), :items => items }
+      output = { :key => navigation_item.key, :name => navigation_item.name, :url => navigation_item.url, :items => items }
+    else
+      #output = { :key => navigation_item.key, :name => navigation_item.name, :url => eval(navigation_item.url) }
+      output = { :key => navigation_item.key, :name => navigation_item.name, :url => navigation_item.url }
+    end
+
+    begin
+      options = eval(navigation_item.options)
+      output[:options] = options if options.is_a?(Hash)
+    rescue
+      logger.debug "Invalid navigation item options: #{navigation_item.options}"
+    end
+
+    return output
+  end
+end
+

data/app/models/ecm/cms.rb

@@ -0,0 +1,5 @@
+module Ecm::Cms
+  def self.table_name_prefix
+    'ecm_cms_'
+  end
+end

data/app/models/ecm/cms/folder.rb

@@ -0,0 +1,31 @@
+class Ecm::Cms::Folder < ActiveRecord::Base
+  self.table_name = 'ecm_cms_folders'
+  
+  # associations
+  has_many :ecm_cms_pages,
+           :class_name => 'Ecm::Cms::Page',
+           :dependent => :destroy,
+           :foreign_key => 'ecm_cms_folder_id'
+  has_many :ecm_cms_partials,
+           :class_name => 'Ecm::Cms::Partial',
+           :dependent => :destroy,
+           :foreign_key => 'ecm_cms_folder_id'
+  has_many :ecm_cms_templates,
+           :class_name => 'Ecm::Cms::Template',
+           :dependent => :destroy,
+           :foreign_key => 'ecm_cms_folder_id'
+
+  # attributes
+  attr_accessible :basename,
+                  :children_count,
+                  :depth,
+                  :ecm_cms_templates_count,
+                  :lft,
+                  :pathname,
+                  :rgt
+
+  # validations
+  validates :basename, :presence => true
+  validates :pathname, :presence => true
+end
+

data/app/models/ecm/cms/navigation.rb

@@ -0,0 +1,24 @@
+class Ecm::Cms::Navigation < ActiveRecord::Base
+  self.table_name = 'ecm_cms_navigations'
+
+  # associations
+  has_many :ecm_cms_navigation_items,
+           :class_name => 'Ecm::Cms::NavigationItem',
+           :dependent => :destroy,
+           :foreign_key => 'ecm_cms_navigation_id'
+
+  # attributes
+  attr_accessible :locale,
+                  :name,
+                  :slug
+
+  # validations
+  validates :locale, :inclusion => I18n.available_locales.map(&:to_s),
+                     :allow_nil => true
+  validates :name, :presence => true,
+                   :uniqueness => { :scope => [ :locale ] }
+
+  def to_s
+    "#{self.name} (#{self.locale})"
+  end
+end

data/app/models/ecm/cms/navigation_item.rb

@@ -0,0 +1,93 @@
+class Ecm::Cms::NavigationItem < ActiveRecord::Base
+  self.table_name = 'ecm_cms_navigation_items'
+
+  # associations
+  belongs_to :ecm_cms_navigation,
+             :class_name => 'Ecm::Cms::Navigation',
+             :foreign_key => 'ecm_cms_navigation_id'
+  belongs_to :ecm_cms_page,
+             :class_name => 'Ecm::Cms::Page',
+             :foreign_key => 'ecm_cms_page_id'
+
+  # attributes
+  attr_accessible :depth,
+                  :key,
+                  :name,
+                  :options,
+                  :string,
+                  :url
+  attr_protected :lgt,
+                 :rgt
+
+  # awesome nested set
+  acts_as_nested_set :dependent => :destroy, :counter_cache => :children_count, :scope => :ecm_cms_navigation_id
+
+  # callbacks
+  before_validation :update_navigation_from_parent, :if => Proc.new { |ni| ni.child? }
+  before_validation :update_url_form_page, :if => Proc.new { |ni| ni.ecm_cms_page.present? && ni.url.blank? }
+  after_save :update_children_navigations!
+
+  # default_scope
+  default_scope :order => [:ecm_cms_navigation_id, :lft]
+
+  # validations
+  validates :key, :presence => true
+  validates :name, :presence => true
+  validates :url, :presence => true
+  validates :ecm_cms_navigation, :presence => true, :if => :root?
+
+  def params_for_new_page
+    return {} if self.new_record?
+    match = self.url.scan(/(#{I18n.available_locales.join('|')})$/)
+    return { :locale => match[0][0], :pathname => '/', :basename => 'home', :title => self.name, :ecm_cms_navigation_item_ids => [ self.to_param ] } if match.size > 0
+    match = self.url.scan(/(#{I18n.available_locales.join('|')})(.*)\/(.*)/)
+    return {} unless match.first.respond_to?(:size) # && match.first.size != 3
+    params = match.first
+    return {} if params.size != 3
+    params[1] << '/' unless params[1].end_with?('/')
+    return { :locale => params[0], :pathname => params[1], :basename => params[2], :title => self.name, :ecm_cms_navigation_item_ids => [ self.to_param ] }
+  end
+
+  # @TODO: test
+  def to_label
+    if depth > 0
+    "#{'&nbsp;' * depth} &#9654; #{name}".html_safe
+    else
+      name
+    end
+  end
+
+  def update_navigation_from_parent!
+    self.update_navigation_from_parent
+    self.save!
+  end
+
+  def update_children_navigations!
+    self.descendants.map(&:"update_navigation_from_parent!")
+  end
+
+  def update_url_form_page!
+    # self.url = build_url_from_page(ecm_cms_page.locale, ecm_cms_page.pathname, ecm_cms_page.basename, ecm_cms_page.home_page?)
+    update_url_form_page
+    save!
+  end
+
+  private
+
+  def build_url_from_page(locale, pathname, basename, is_home_page)
+    if is_home_page
+      "/#{locale}"
+    else
+      "/#{locale}#{pathname}#{basename}"
+    end
+  end
+
+  def update_navigation_from_parent
+    self.ecm_cms_navigation = self.parent.ecm_cms_navigation
+  end
+
+  def update_url_form_page
+    self.url = build_url_from_page(ecm_cms_page.locale, ecm_cms_page.pathname, ecm_cms_page.basename, ecm_cms_page.home_page?)
+  end
+end
+

data/app/models/ecm/cms/page.rb

@@ -0,0 +1,42 @@
+class Ecm::Cms::Page < ActiveRecord::Base
+  self.table_name = 'ecm_cms_pages'
+
+  # add shared behaviour for database backed templates
+  include Ecm::Cms::DatabaseTemplate
+
+  # associations
+  has_many :ecm_cms_navigation_items,
+           :class_name => 'Ecm::Cms::NavigationItem',
+           :dependent => :nullify,
+           :foreign_key => 'ecm_cms_page_id'
+
+  # attributes
+  attr_accessible :basename,
+                  :body,
+                  :ecm_cms_folder_id,
+                  :ecm_cms_navigation_item_ids,
+                  :format,
+                  :handler,
+                  :layout,
+                  :locale,
+                  :meta_description,
+                  :pathname,
+                  :title
+
+  # callbacks
+  after_save :touch_navigation_items # , :if => Proc.new { |page| page.locale_changed? || page.pathname_changed? || page.basename_changed? }
+
+  # validations
+  validates :title, :presence => true
+
+  def home_page?
+p self.pathname
+p self.basename  
+    return self.pathname == '/' && self.basename == 'home'
+  end
+
+  def touch_navigation_items
+    self.ecm_cms_navigation_items.map(&:update_url_form_page!)
+  end
+end
+

data/app/models/ecm/cms/partial.rb

@@ -0,0 +1,31 @@
+class Ecm::Cms::Partial < ActiveRecord::Base
+  self.table_name = 'ecm_cms_partials'
+
+  # add shared behaviour for database backed templates
+  include Ecm::Cms::DatabaseTemplate
+
+  # associations
+#  belongs_to :ecm_cms_folder,
+#             :class_name => 'Ecm::Cms::Folder',
+#             :foreign_key => 'ecm_cms_folder_id'
+
+  # attributes
+  attr_accessible :basename,
+                  :body,
+                  :ecm_cms_folder_id,
+                  :format,
+                  :handler,
+                  :layout,
+                  :locale,
+                  :pathname
+
+  # callbacks
+  before_validation :ensure_basename_starts_with_underscore, :if => Proc.new { |t| t.basename.present? }
+
+  private
+
+  def ensure_basename_starts_with_underscore
+    self.basename.insert(0, '_') unless self.basename.start_with?('_')
+  end
+end
+

data/app/models/ecm/cms/template.rb

@@ -0,0 +1,31 @@
+class Ecm::Cms::Template < ActiveRecord::Base
+  self.table_name = 'ecm_cms_templates'
+
+  # add shared behaviour for database backed templates
+  include Ecm::Cms::DatabaseTemplate
+  
+  # associations
+  belongs_to :ecm_cms_folder,
+             :class_name => 'Ecm::Cms::Folder',
+             :foreign_key => 'ecm_cms_folder_id'
+
+  # attributes
+  attr_accessible :basename,
+                  :body,
+                  :ecm_cms_folder_id,
+                  :format,
+                  :handler,
+                  :layout,
+                  :locale,
+                  :pathname
+
+  # callbacks
+  before_validation :ensure_basename_starts_without_underscore, :if => Proc.new { |t| t.basename.present? }
+
+  private
+
+  def ensure_basename_starts_without_underscore
+    self.basename.slice!(0) if self.basename.start_with?('_')
+  end
+end
+

data/config/locales/ecm.cms.de.yml

@@ -0,0 +1,17 @@
+de:
+  ecm:
+    cms:
+      active_admin:
+        menu: CMS
+      navigation:
+        messages:
+          empty: Navigation  %{name} (%{lang}) ist leer
+          not_found: Navigation %{name} (%{lang}) nicht gefunden
+  resources:
+    ecm_cms_folders: ordner
+    ecm_cms_navigations: navigationen
+    ecm_cms_navigation_items: navigationenseintraege
+    ecm_cms_pages: seiten
+    ecm_cms_partials: fragmente
+    ecm_cms_templates: vorlagen    
+