aerogel-pages 1.4.12

data/db/model/page.rb

@@ -0,0 +1,137 @@
+class Page
+  include Model
+  include Model::Timestamps
+
+  # embedded_in :page
+  belongs_to :page_node, touch: true
+
+  PUBLICATION_STATES = [:published, :hidden, :not_published]
+
+  field :lang, type: Symbol
+  field :published_at, type: Time
+  field :publication_state, type: Symbol, default: :published
+  field :link, type: String
+  field :parent_links, type: Array, default: nil
+  field :title, type: String
+  field :html_description, type: String
+  field :html_keywords, type: String
+
+  before_save :update_links
+  before_update :touch_ancestors
+  before_destroy :touch_ancestors
+
+  embeds_many :page_blocks, class_name: "Pages::Block", order: :position.asc #, cascade_callbacks: true
+  accepts_nested_attributes_for :page_blocks,
+    reject_if: :all_blank,
+    allow_destroy: true
+
+  validates_presence_of :page_node_id, :lang, :title
+  validates_presence_of :link, unless: :root?
+  validates :publication_state, inclusion: { in: PUBLICATION_STATES }
+  validates_uniqueness_of :lang, scope: [:page_node_id]
+
+  # scope :children_of, ->(other_page) { where( :page_id.in => other_page.children.map(&:_id) ) }
+  scope :published, where( :publication_state => :published )
+  scope :published_and_hidden, where( :publication_state.in => [:published, :hidden] )
+
+  # Create a new embedded page block.
+  #
+  def create_page_block( opts )
+    pb = Aerogel::Pages.create_page_block opts[:type], opts
+    pb.page = self
+    pb
+  end
+
+  # Returns url to this page if it is accessible, constructed from the parent links.
+  #
+  def url
+    parts = [parent_links, link].flatten
+    parts.shift # skip root page
+    "/"+parts.join("/")
+    # ( root? ? "/" ) : parts.join("/")
+  end
+
+  # Returns +true+ if this Page is root.
+  #
+  def root?
+    page_node.try(:root?)
+  end
+
+  # Returns root in specified language.
+  #
+  def self.root( lang )
+    PageNode.root.try( :page, lang )
+  end
+
+  # Returns parent page.
+  #
+  def parent
+    page_node.parent.try( :page, lang )
+  end
+
+  # Returns children of this page.
+  #
+  def children
+    Page.where( lang: lang, :page_node_id.in => page_node.children.map(&:_id) )
+  end
+
+  # Returns ancestors of this page.
+  #
+  def ancestors
+    Page.where( lang: lang, :page_node_id.in => page_node.ancestors.map(&:_id) )
+  end
+
+  # Returns list of allowed content block types.
+  #
+  def available_block_types
+    Aerogel::Pages.registered_page_block_types.keys
+  end
+
+  # Returns list of available langs as Symbols
+  #
+  def self.available_langs
+    I18n.available_locales
+  end
+
+
+# private
+
+  def update_links
+    self.parent_links = default_parent_links if parent_links.nil?
+    update_children_links
+  end
+
+  # Generates default value for parent_links, that is used to populate new Page object.
+  #
+  # NOTE: This is impossible to do as field's default with Proc, because by some reason
+  # Mongoid does not initialize relations at 'assign defaults' stage.
+  #
+  def default_parent_links
+    # puts "** default_parent_links: self.page_node=#{self.page_node.inspect}"
+    # puts "** default_parent_links: self=#{self.inspect}"
+    parent_page = parent
+    if parent_page.present?
+      parent_page.parent_links + [parent_page.link]
+    else
+      []
+    end
+  end
+
+  def update_children_links
+    return unless link_changed? || parent_links_changed?
+    # puts "** update children links fired"
+    links = parent_links + [link]
+    children.each do |p|
+      p.update_attributes parent_links: links
+    end
+  end
+
+  # Touches parents (if present)
+  #
+  def touch_ancestors
+    ancestors.update_all updated_at: Time.now
+    page_node.ancestors.update_all updated_at: Time.now
+    page_node.touch
+  end
+
+end # class Page

data/db/model/page_node.rb

@@ -0,0 +1,43 @@
+class PageNode
+  include Model
+  include Model::OrderedTree
+  include Model::Timestamps
+
+  before_destroy :destroy_children
+
+  belongs_to :page_type
+  has_many :pages, dependent: :destroy
+  # embeds_many :pages, cascade_callbacks: true
+
+  validates_presence_of :page_type
+
+  accepts_nested_attributes_for :pages,
+    reject_if: :all_blank,
+    allow_destroy: true
+
+  before_update :touch_ancestors
+  before_destroy :touch_ancestors
+
+  # scope :with_content, ->(lang) { where( :'pages.lang' => lang ) }
+  # scope :published, ->(lang) { elem_match( pages: { lang: lang, :publication_state => :published } ) }
+  # scope :published_and_hidden, ->(lang) {
+  #   elem_match( pages: { lang: lang, :publication_state.in => [:published, :hidden] } )
+  # }
+
+  # Returns content for the specified +lang+.
+  #
+  def page( lang )
+    pages.where( lang: lang.to_sym ).first
+  end
+
+private
+
+  # Touches parents (if present)
+  #
+  def touch_ancestors
+    ancestors.update_all updated_at: Time.now
+  end
+
+
+
+end # class Page

data/db/model/page_type.rb

@@ -0,0 +1,15 @@
+class PageType
+  include Model
+
+  field :type, type: Symbol
+  field :name, type: String
+  field :allowed_parents, type: Array
+  field :allowed_children, type: Array
+  field :allowed_content_blocks, type: Array
+  field :defaults, type: Hash
+
+  validates_uniqueness_of :type
+
+  has_many :page_nodes
+
+end # class PageType

data/db/model/pages/block.rb

@@ -0,0 +1,38 @@
+module Pages
+  class Block
+    include Model
+
+    embedded_in :page
+
+    field :position, type: Integer
+
+    # Returns symbolized block type, inferred from class name.
+    #
+    def type
+      self.class.name.split("::").last.underscore.to_sym
+    end
+
+    # Returns PageNode of the Page the block belongs to.
+    #
+    def page_node
+      page.page_node
+    end
+
+    # Returns lang of the PageContent the block belongs to.
+    #
+    def lang
+      page.lang
+    end
+
+    # Returns +true+ if block has configurable details.
+    #
+    def has_details?
+      false
+    end
+
+    def self.has_details!
+      define_method(:has_details?) { true }
+    end
+
+  end # class Block
+end # module Pages

data/db/model/pages/blocks/hr.rb

@@ -0,0 +1,9 @@
+module Pages::Blocks
+  class Hr < Pages::Block
+
+    Aerogel::Pages.register_page_block_type :hr, self
+
+    # field :content, type: String
+
+  end # class Text
+end # module Pages

data/db/model/pages/blocks/image.rb

@@ -0,0 +1,16 @@
+module Pages::Blocks
+  class Image < Pages::Block
+
+    ALIGNMENT_STATES = [:left, :middle, :right]
+
+    field :image, type: Media::Image
+    field :name, type: String
+    field :alignment, type: Symbol, default: :middle
+    field :thumb, type: String
+
+    validates :alignment, inclusion: { in: ALIGNMENT_STATES }
+
+    Aerogel::Pages.register_page_block_type :image, self
+
+  end # class Text
+end # module Pages

data/db/model/pages/blocks/pages_list.rb

@@ -0,0 +1,41 @@
+module Pages::Blocks
+  class PagesList < Pages::Block
+
+    Aerogel::Pages.register_page_block_type :pages_list, self
+
+    field :target_page_node_id, type: String
+    field :ordered_by, type: Symbol, default: :position
+    field :ordered_asc, type: Symbol, default: :asc
+    field :limit, type: Integer
+    field :template, type: String
+    field :show_hidden, type: Boolean, default: false
+
+    has_details!
+
+    def listed_pages
+      return @_listed_pages_cache if @_listed_pages_cache
+      target_page_node = target_page_node_id.present? ? PageNode.find( target_page_node_id ) : page_node
+      return [] if target_page_node.nil?
+      listed = target_page_node.page( lang ).children
+      listed = (show_hidden ? listed.published_and_hidden : listed.published )
+      listed = listed.to_a
+      # unless ordered_by == :position
+      #   listed = listed.sort_by do |p|
+      #     p.content( lang ).try( :send, ordered_by ).try( :to_i ) || 0
+      #   end
+      # end
+      # listed = listed.reverse if ordered_asc == :desc
+      # listed = listed.first( limit ) if limit.present? && limit > 0
+      @_listed_pages_cache = listed
+      listed
+    end
+
+    def listed_pages_DISABLED
+      listed = listed_pages.map{|p| p.try :content, lang }.select{|pc| pc.present? }
+      # listed = listed.order_by( ordered_by => (ordered_asc == :asc ? 1 : -1) )
+      # listed = listed.limit( limit ) if limit.present? && limit > 0
+      # listed
+    end
+
+  end # class Text
+end # module Pages

data/db/model/pages/blocks/text.rb

@@ -0,0 +1,9 @@
+module Pages::Blocks
+  class Text < Pages::Block
+
+    Aerogel::Pages.register_page_block_type :text, self
+
+    field :content, type: String
+
+  end # class Text
+end # module Pages

data/db/seed/development/01_page_types.seed

@@ -0,0 +1,8 @@
+model PageType
+
+find_by :type
+
+seeds [
+{ type: :page, name: 'Page' }
+]
+

data/db/seed/development/02_root_page_node.seed

@@ -0,0 +1,8 @@
+page_type_simple = PageType.where( type: :page ).first
+
+model PageNode
+
+find_by :parent_id
+
+seeds [{ parent_id: nil, page_type: page_type_simple }]
+

data/db/seed/development/03_root_pages.seed

@@ -0,0 +1,10 @@
+root_page_node = PageNode.root
+
+model Page
+
+find_by :page_node_id, :lang
+
+seeds [
+  { page_node_id: root_page_node.id, lang: :en, link: '', title: 'Home page' },
+  { page_node_id: root_page_node.id, lang: :ru, link: '', title: 'Главная страница' }
+]

data/db/seed/development/04_news_page_node.seed

@@ -0,0 +1,15 @@
+# Sub pages created here only if root has no children
+#
+page_type_simple = PageType.where( type: :page ).first
+page_node_root = PageNode.root
+
+model PageNode
+
+find_by :parent_id
+
+seeds [
+{
+  parent_id: page_node_root.id, page_type: page_type_simple
+}
+]
+

data/db/seed/development/05_news_pages.seed

@@ -0,0 +1,10 @@
+news_page_node = PageNode.root.children.first
+
+model Page
+
+find_by :page_node_id, :lang
+
+seeds [
+  { page_node_id: news_page_node.id, lang: :en, link: 'news', title: 'News' },
+  { page_node_id: news_page_node.id, lang: :ru, link: 'новости', title: 'Новости' }
+]

data/db/seed/production/01_page_types.seed

@@ -0,0 +1,8 @@
+model PageType
+
+find_by :type
+
+seeds [
+{ type: :page, name: 'Page' }
+]
+

data/db/seed/production/02_root_page_node.seed

@@ -0,0 +1,8 @@
+page_type_simple = PageType.where( type: :page ).first
+
+model PageNode
+
+find_by :parent_id
+
+seeds [{ parent_id: nil, page_type: page_type_simple }]
+

data/db/seed/production/03_root_pages.seed

@@ -0,0 +1,10 @@
+root_page_node = PageNode.root
+
+model Page
+
+find_by :page_node_id, :lang
+
+seeds [
+  { page_node_id: root_page_node.id, lang: :en, link: '', title: 'Home page' },
+  { page_node_id: root_page_node.id, lang: :ru, link: '', title: 'Главная страница' }
+]

data/db/seed/seed.template

@@ -0,0 +1,42 @@
+# A .seed file is a .conf file which stores
+# database seed data and rules.
+#
+
+# Model class to use
+#
+# ! required
+model Setting
+
+# Attribute name or a list of attribute names to be used as key(s)
+# when finding objects
+#
+# Usage:
+#   find_by :name
+# or
+#   find_by [:first_name, :last_name]
+#
+# ! required
+find_by :name
+
+# Values of attributes listed here will be set even
+# if they exist already in the matching database object.
+#
+# Other attributes in the seed data will be treated as a default value,
+# i.e. they will only be set if the matching database object does not exist
+# or its corresponding attribute is not set.
+#
+# Usage:
+#   force :value
+# or:
+#   force [:value, :description]
+#
+# default is: no fields are forced
+force :value
+
+seeds [
+{ name: 'abc', value: '123' },
+{ name: 'def', value: '456' },
+{ name: 'ghi', value: '789' },
+{ name: 'abcdef', value: '123456' }
+]
+

data/lib/aerogel/pages/core.rb

@@ -0,0 +1,37 @@
+module Aerogel::Pages
+
+  def self.registered(app)
+    setup_reloader(app) if Aerogel.config.aerogel.reloader?
+
+    # module initialization
+    Aerogel::Pages.reset!
+  end
+
+  def self.setup_reloader(app)
+    app.use Aerogel::Reloader, :'db/model', before: true do
+      Aerogel::Pages.reset!
+    end
+  end
+
+  def self.reset!
+    @registered_page_block_types ||= {}
+  end
+
+  def self.registered_page_block_types
+    @registered_page_block_types ||= {}
+  end
+
+  def self.register_page_block_type( type, model )
+    registered_page_block_types[type] = model
+  end
+
+  def self.create_page_block( type, *args )
+    type = type.to_sym
+    if registered_page_block_types[type].nil?
+      raise ArgumentError.new( "Invalid page block type: '#{type}'")
+    end
+    registered_page_block_types[type].new( *args )
+  end
+
+end # module Aerogel::Pages
+

data/lib/aerogel/pages/traversal.rb

@@ -0,0 +1,30 @@
+module Aerogel::Pages
+  module Traversal
+
+    def self.page( id, lang )
+      PageNode.find( id ).try( :page, lang )
+    end
+
+    def self.root( lang )
+      Page.root(lang)
+    end
+
+    def self.find( url, lang )
+      page = root(lang)
+      traverse page, url.dup, lang
+    end
+
+    def self.traverse( page, url, lang )
+      return page if page.nil? || url.blank?
+      link = url.shift
+      page = page.children.where( link: link ).first
+      traverse page, url, lang
+    end
+
+    def self.find_closest_in_other_lang( page, lang )
+      return page.page_node.page(lang) if page.page_node.page(lang).present?
+      return root(lang) if page.root?
+      find_closest_in_other_lang( page.parent, lang )
+    end
+  end # module Traversal
+end # module Aerogel::Pages

data/lib/aerogel/pages/version.rb

@@ -0,0 +1,5 @@
+module Aerogel
+  module Pages
+    VERSION = "1.4.12"
+  end
+end

data/lib/aerogel/pages.rb

@@ -0,0 +1,19 @@
+require 'aerogel/core'
+require 'aerogel/admin'
+require "aerogel/pages/version"
+require "aerogel/pages/core"
+require "aerogel/pages/traversal"
+
+module Aerogel
+
+  # Finally, register module's root folder
+  register_path File.join( File.dirname(__FILE__), '..', '..' )
+
+
+  # configure module
+  on_load do |app|
+    app.register Aerogel::Pages
+  end
+
+end
+

data/locales/actions.en.yml

@@ -0,0 +1,11 @@
+en:
+    aerogel:
+        admin:
+            pages:
+                delete: Delete page
+                delete_short: Delete
+                insert: Insert page
+                insert_short: Insert
+                append: Append page
+                append_short: Append
+                edit: Edit page

data/locales/actions.ru.yml

@@ -0,0 +1,11 @@
+ru:
+    aerogel:
+        admin:
+            pages:
+                delete: Удалить страницу
+                delete_short: Удалить
+                insert: Вставить новую страницу
+                insert_short: Вставить
+                append: Добавить новую страницу
+                append_short: Добавить
+                edit: Редактировать страницу

data/locales/admin.en.yml

@@ -0,0 +1,11 @@
+en:
+    aerogel:
+        admin:
+            panes:
+                pages: Pages
+
+            decorators:
+                no_date: "<span class='nodata'>no date</span>"
+                confirmed: confirmed
+                not_confirmed: not confirmed
+

data/locales/admin.ru.yml

@@ -0,0 +1,11 @@
+ru:
+    aerogel:
+        admin:
+            panes:
+                pages: Страницы
+
+            decorators:
+                no_date: "<span class='nodata'>нет даты</span>"
+                # confirmed: confirmed
+                # not_confirmed: not confirmed
+

data/locales/models.en.yml

@@ -0,0 +1,18 @@
+en:
+    mongoid:
+        models:
+            page: Page
+            page_node: Page (tree node)
+
+        attributes:
+            page_node:
+                title: Title
+                type: Type
+
+            page:
+                title: Title
+                published_at: Published at
+                publication_state: Publication state
+                link: Link
+                html_description: "<HTML/> meta description"
+                html_keywords: "<HTML/> meta keywords"

data/locales/models.ru.yml

@@ -0,0 +1,19 @@
+ru:
+    mongoid:
+        models:
+            page: Страница
+            page_node: Страница (узел дерева)
+
+        attributes:
+
+            page_node:
+                title: Заголовок
+                type: Тип
+
+            page:
+                title: Заголовок
+                published_at: Дата публикации
+                publication_state: Состояние публикации
+                link: Ссылка
+                html_description: "<HTML/> meta description"
+                html_keywords: "<HTML/> meta keywords"

data/locales/views.en.yml

@@ -0,0 +1,38 @@
+en:
+    aerogel:
+        admin:
+            pages:
+                views:
+                    index:
+                        no_page_selected: No page is selected
+
+                    delete:
+                        title: Delete page?
+                        text_no_subpages: |
+                            <p>
+                                Do you really want to delete page <b>%{title}</b>?
+                            </p>
+
+                        text_with_subpages: |
+                            <p>
+                                Do you really want to delete page <b>%{title}</b> and <b>%{count}</b>
+                                of its subpages?
+                            </p>
+
+                    preview:
+                        no_content_in_this_language: Page has no content in this language
+
+                    edit:
+                        clear_page_content: Clear page content
+                        no_content: No content
+                        add_content: Add content
+                        page_details: Page details
+                        no_publication_date: No publication date
+                        add_block: Add block
+                        block:
+                            details: Details
+                            text: Text
+                            image: Image
+                            hr: HR
+                            pages_list: "Pages: List"
+