ecm_cms2 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8d6fcb88e37f46304a93a16318714c6abb90fcbe
+  data.tar.gz: ae240502120e7e4744700dc2a712a9bd026dd649
+SHA512:
+  metadata.gz: 243c50e7220649305bd6f4bd0210c1d66659b47b5857a8e41dd4a9c0503aac7815fcb2f2b649261a32cd6174e4bb903e74dcd98cdc35982b969659d7dc63cd84
+  data.tar.gz: 8b9949ad93aa390975d1c0524625f62757b4b2ec5e62db291e540a3f5e659bced0224082af92b7b364e45755d2a286fb3187ad1534685a4bb6c0e9aab26ee78b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 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,66 @@
+= ECM Module Template
+
+= End-User documentation
+
+Please look at the[link:doc] Folder.
+
+
+= Prerequisites
+
+= Installation
+
+Add it to your bundle:
+
+  # Gemfile:
+  gem 'ecm_cms2'
+
+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 do
+    Ecm::Cms::Routing.routes(self)
+  end
+  root 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!
+
+= Linking to pages
+
+    <%= link_to 'My Page', page_path(i18n_locale: I18n.locale, page: 'my-page') %>
+
+= Using partials form the database in other controllers
+
+    # app/controllers/application_controller.rb
+    class ApplicationController < ActionController::Base
+      prepend_view_path ::Ecm::Cms::PartialResolver.instance
+      ...
+    end
+
+= License
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,25 @@
+#!/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    = 'ECM CMS'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rails/dummy/tasks'

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

@@ -0,0 +1,11 @@
+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;
+}
+
+.active_admin pre {
+  white-space: pre-wrap !important;       /* css-3 */
+  white-space: -moz-pre-wrap !important;  /* Mozilla, since 1999 */
+  white-space: -pre-wrap !important;      /* Opera 4-6 */
+  white-space: -o-pre-wrap !important;    /* Opera 7 */
+}
+

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

@@ -0,0 +1,24 @@
+class Ecm::Cms::PageController < Ecm::Cms::Configuration.base_controller.constantize
+  # add the page resolver
+  include Ecm::Cms::ControllerExtensions::PageResolver
+  include Ecm::Cms::ControllerExtensions::PartialResolver
+
+  # avoid error 500 on missing template
+  rescue_from ActionView::MissingTemplate do
+    respond_to do |format|
+      format.html {
+        render(:file => "#{Rails.root}/public/404", :formats => [:html],
+                                                    :layout => false,
+                                                    :status => 404
+        )
+      }
+      format.xml  { head :not_found }
+      format.any  { head :not_found }
+    end
+  end
+
+  def respond
+    render :template => params[:page]
+  end
+end
+

data/app/helpers/ecm/cms_helper.rb

@@ -0,0 +1,46 @@
+module Ecm::CmsHelper
+  def cms_render_navigation(name, options = {})
+    options.reverse_merge! renderer: :bootstrap, expand_all: true, level: 1
+
+    level               = options.delete(:level)
+    expand_all          = options.delete(:expand_all)
+    container_css_class = options.delete(:container_css_class)
+    renderer            = options.delete(:renderer)
+
+    level_as_array = (level).is_a?(Range) ? level.to_a : [level]
+
+    navigation = Ecm::Cms::Navigation.where(:name => name.to_s, :locale => I18n.locale.to_s).first
+    unless navigation
+      return I18n.t('ecm.cms.navigation.messages.not_found', {:lang => I18n.locale.to_s, :name => name.to_s})
+    end
+
+    roots = navigation.ecm_cms_navigation_items.roots.all
+    if roots.empty?
+      return I18n.t('ecm.cms.navigation.messages.empty', :lang => I18n.locale.to_s, :name => name)
+    end
+
+    render_navigation(level: level, expand_all: expand_all, renderer: renderer) do |navigation|
+      navigation.dom_class = container_css_class
+      roots.each do |navigation_item|
+        build_navigation_item(navigation, navigation_item, container_css_class)
+      end
+    end
+  end
+
+  def build_navigation_item(navigation, item, container_css_class)
+    options = {}
+    options[:highlights_on] = /#{item.highlights_on}/ if item.highlights_on.present?
+    options = item.li_attributes.marshal_dump.delete_if {|key, value| value.blank? }
+
+    navigation.dom_class = container_css_class
+    if item.children.present?
+      navigation.item item.key, item.name, item.url, options do |sub_navigation|
+        item.children.each do |sub_item|
+          build_navigation_item(sub_navigation, sub_item, container_css_class)
+        end
+      end
+    else
+      navigation.item item.key, item.name, item.url, options
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+require 'active_support/concern'
+
+module Ecm::Cms
+  module NavigationItem::Properties
+    extend ActiveSupport::Concern
+
+    included do
+      serialize :properties, OpenStruct
+      delegate *Configuration.navigation_item_properties, to: :li_attributes
+      delegate *Configuration.navigation_item_properties.collect { |a| "#{a}=".to_sym }, to: :li_attributes
+    end
+
+    def highlights_on
+      self.properties.highlights_on ||= nil
+    end
+
+    def highlights_on=(highlights_on)
+      properties.highlights_on = highlights_on
+    end
+
+    def li_attributes
+      self.properties.li_attributes ||= OpenStruct.new
+    end
+
+    def li_attributes=(li_attributes)
+      properties.li_attributes = li_attributes
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Ecm::Cms
+  class ContentBox < ActiveRecord::Base
+    # associations
+    has_many :ecm_cms_page_content_blocks, :class_name => 'Page::ContentBlock',
+                                           :foreign_key => 'ecm_cms_content_box_id'
+
+    # validations
+    validates :name, :presence => true,
+                     :uniqueness => true
+
+    def ecm_cms_page_content_blocks_count
+      ecm_cms_page_content_blocks.count
+    end
+  end
+end
+

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

@@ -0,0 +1,20 @@
+class Ecm::Cms::Folder < ActiveRecord::Base
+  # 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'
+
+  # validations
+  validates :basename, :presence => true
+  validates :pathname, :presence => true
+end
+

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

@@ -0,0 +1,18 @@
+class Ecm::Cms::Navigation < ActiveRecord::Base
+  # associations
+  has_many :ecm_cms_navigation_items,
+           :class_name => 'Ecm::Cms::NavigationItem',
+           :dependent => :destroy,
+           :foreign_key => 'ecm_cms_navigation_id'
+
+  # 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,88 @@
+module Ecm::Cms
+  class NavigationItem < ActiveRecord::Base
+    include Properties
+
+    # 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'
+
+    # 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
+
+    def to_label
+      if depth > 0
+      "#{'&nbsp;' * depth} &#9654; #{name}".html_safe
+      else
+        name
+      end
+    end
+
+    def to_s
+      "#{ecm_cms_navigation}: #{name}"
+    end
+
+    def update_navigation_from_parent!
+      update_navigation_from_parent
+      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
+end
+

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

@@ -0,0 +1,24 @@
+module Ecm::Cms
+  class Page::ContentBlock < ActiveRecord::Base
+    # associations
+    belongs_to :ecm_cms_content_box, :class_name => 'ContentBox',
+                                     :foreign_key => 'ecm_cms_content_box_id'
+    belongs_to :ecm_cms_page, :class_name => 'Ecm::Cms::Page',
+                              :foreign_key => 'ecm_cms_page_id'
+
+    # attributes
+    attr_accessible(:body,
+                    :ecm_cms_content_box_id) if Rails.version < '4.0.0'
+
+    # validations
+    validates :body, :presence => true
+    validates :ecm_cms_content_box, :presence => true
+    validates :ecm_cms_page, :presence => true
+    # validates :ecm_cms_page, :existence => true
+
+    def content_box_name
+      ecm_cms_content_box.name
+    end
+  end
+end
+

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

@@ -0,0 +1,33 @@
+module Ecm::Cms
+  class Page < ActiveRecord::Base
+    # add shared behaviour for database backed templates
+    include DatabaseTemplate
+
+    # associations
+    has_many :ecm_cms_navigation_items,
+             :class_name => 'NavigationItem',
+             :dependent => :nullify,
+             :foreign_key => 'ecm_cms_page_id'
+    has_many :ecm_cms_page_content_blocks,
+             :class_name => 'Ecm::Cms::Page::ContentBlock',
+             :dependent => :destroy,
+             :foreign_key => 'ecm_cms_page_id',
+             :inverse_of => :ecm_cms_page
+
+    accepts_nested_attributes_for :ecm_cms_page_content_blocks, :allow_destroy => true
+
+    # 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?
+      return self.pathname == '/' && self.basename == 'home'
+    end
+
+    def touch_navigation_items
+      self.ecm_cms_navigation_items.map(&:update_url_form_page!)
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+require 'ecm/cms/database_template'
+
+class Ecm::Cms::Partial < ActiveRecord::Base
+  # add shared behaviour for database backed templates
+  include Ecm::Cms::DatabaseTemplate
+
+  # 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,19 @@
+class Ecm::Cms::Template < ActiveRecord::Base
+  # 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'
+
+  # 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.content_box.de.yml

@@ -0,0 +1,15 @@
+de:
+  activerecord:
+    models:
+      ecm/cms/content_box:
+        one: Content Box
+        other: Content Boxen
+    attributes:
+      ecm/cms/content_box:
+        name: Name
+        body: Inhalt
+        created_at: Erstellt am
+        ecm_cms_page_content_blocks: Content Blöcke
+        ecm_cms_page_content_blocks_count: Content Blöcke
+        updated_at: Aktualisiert am
+

data/config/locales/ecm.cms.content_box.en.yml

@@ -0,0 +1,15 @@
+en:
+  activerecord:
+    models:
+      ecm/cms/content_box:
+        one: content box
+        other: content boxes
+    attributes:
+      ecm/cms/content_box:
+        name: name
+        body: body
+        created_at: created at
+        ecm_cms_page_content_blocks: content blocks
+        ecm_cms_page_content_blocks_count: content blocks
+        updated_at: updated at
+

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: navigationseintraege
+    ecm_cms_pages: seiten
+    ecm_cms_partials: fragmente
+    ecm_cms_templates: vorlagen    
+

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

@@ -0,0 +1,17 @@
+en:
+  ecm:
+    cms:
+      active_admin:
+        menu: CMS
+      navigation:
+        messages:
+          empty: Navigation  %{name} (%{lang}) is empty
+          not_found: Could not find navigation %{name} (%{lang})
+  resources:
+    ecm_cms_folders: folders
+    ecm_cms_navigations: navigations
+    ecm_cms_navigation_items: navigation_items
+    ecm_cms_pages: pages
+    ecm_cms_partials: partials
+    ecm_cms_templates: templates
+

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

@@ -0,0 +1,15 @@
+de:
+  activerecord:
+    models:
+      ecm/cms/navigation:
+        one: Navigation
+        other: Navigationen
+    attributes:
+      ecm/cms/navigation:
+        created_at: Erstellt am
+        ecm_cms_navigation_items: Navigationseinträge
+        locale: Sprache
+        name: Name
+        slug: Freundliche ID
+        updated_at: Aktualisiert am
+

data/config/locales/ecm.cms.navigation.en.yml

@@ -0,0 +1,15 @@
+en:
+  activerecord:
+    models:
+      ecm/cms/navigation:
+        one: navigation
+        other: navigations
+    attributes:
+      ecm/cms/navigation:
+        created_at: created at
+        ecm_cms_navigation_items: navigation items
+        locale: language
+        name: name
+        slug: friendly id
+        updated_at: updated at
+

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

@@ -0,0 +1,25 @@
+de:
+  activerecord:
+    models:
+      ecm/cms/navigation_item:
+        one: Navigationseintrag
+        other: Navigationseinträge
+    attributes:
+      ecm/cms/navigation_item:
+        created_at: Erstellt am
+        depth: Baumtiefe
+        ecm_cms_navigation: Navigation
+        ecm_cms_page: Seite
+        data_add_icon: Symbol
+        highlights_on: Hervorgehoben bei
+        key: Schlüssel
+        lft: Links
+        li_attributes: 'Listen-Element Attribute'
+        name: Name
+        options: Optionen
+        parent: Untereintrag von
+        rgt: Rechts
+        slug: Freundliche ID
+        updated_at: Aktualisiert am
+        url: Ziel-URL
+

data/config/locales/ecm.cms.navigation_item.en.yml

@@ -0,0 +1,25 @@
+en:
+  activerecord:
+    models:
+      ecm/cms/navigation_item:
+        one: navigation item
+        other: navigation items
+    attributes:
+      ecm/cms/navigation_item:
+        created_at: created at
+        depth: tree depth
+        ecm_cms_navigation: navigation
+        ecm_cms_page: page
+        data_add_icon: icon
+        highlights_on: highlights on
+        key: key
+        lft: left
+        li_attributes: 'list-element attributes'
+        name: name
+        options: options
+        parent: parent
+        rgt: right
+        slug: friendly id
+        updated_at: updated at
+        url: target url
+

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

@@ -0,0 +1,14 @@
+de:
+  activerecord:
+    models:
+      ecm/cms/page/content_block:
+        one: Content Block
+        other: Content Blöcke
+    attributes:
+      ecm/cms/page/content_block:
+        body: Inhalt
+        created_at: Erstellt am
+        ecm_cms_page: Seite
+        ecm_cms_content_box: Content Box
+        updated_at: Aktualisiert am
+

data/config/locales/ecm.cms.page.content_block.en.yml

@@ -0,0 +1,14 @@
+en:
+  activerecord:
+    models:
+      ecm/cms/page/content_block:
+        one: content block
+        other: content blocks
+    attributes:
+      ecm/cms/page/content_block:
+        body: body
+        created_at: created at
+        ecm_cms_page: page
+        ecm_cms_content_box: content box
+        updated_at: udpated at
+