aerogel-pages 1.4.12

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8e26c560b6efb0c21e672cdec8a7ff2ebf041c1b
+  data.tar.gz: eb661e738d4d57d2d5808c7ae1b16f7f7d53ab1d
+SHA512:
+  metadata.gz: 7877fad07008c646599daff5ad77adc06d5e6f589e3dc2911c06f3bf7cd6789f61cad45d58907bc61f8553cf95abd51a1ea8ffba700c712b1e5378c4d721d83d
+  data.tar.gz: 076ff583a35fabd307a3edf87cad5a1956875f20919998d00af042c14c2b7788f7f7a61f9926e56581527d577c7876a025a52ce120bc9a50e6b323602243a2c3

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in aerogel-module123.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Alex Kukushkin
+
+MIT License
+
+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.md

@@ -0,0 +1,14 @@
+# aerogel-pages
+
+Page editing/publishing for aerogel CMS.
+
+## Usage
+
+Module is included in 'aerogel' gem.
+
+In your application's config.ru:
+```ruby
+require 'aerogel'
+
+run Aerogel::Application.load
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/aerogel-pages.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aerogel/pages/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "aerogel-pages"
+  spec.version       = Aerogel::Pages::VERSION
+  spec.authors       = ["Alex Kukushkin"]
+  spec.email         = ["alex@kukushk.in"]
+  spec.description   = %q{Page editing/publishing module for aerogel CMS}
+  spec.summary       = %q{Page editing/publishing module for aerogel CMS}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "aerogel-core", "~> 1.4"
+  spec.add_dependency "aerogel-admin", "~> 1.4"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/app/helpers/README.md

@@ -0,0 +1,7 @@
+Module helpers go there. Suggested format is:
+
+```ruby
+def my_helper_name1
+...
+end
+```

data/app/helpers/decorators.rb

@@ -0,0 +1,74 @@
+# Returns publication state as icon,
+# unless it is :published, in which case nothing is rendered.
+#
+def admin_pages_publication_state_as_icon( page_node, lang )
+  page = page_node.page( lang )
+  state = page.try(:publication_state) || :not_published
+  case state.to_sym
+    when :published then '' # icon 'fa-check'
+    when :hidden then icon 'fa-eye', title: 'hidden'
+    else
+      icon 'fa-times', title: 'not published'
+  end
+end
+
+# Returns page title for given +lang+, with respect to publication state.
+#
+def admin_pages_title_as_text( page_node, lang )
+  page = page_node.page( lang )
+  if page.nil?
+    publication_state = :not_published
+    other_page = page_node.pages.first
+    if other_page.nil?
+      return "<span class='nodata'>no translation</span>"
+    end
+    return "<span class='nodata'>#{other_page.lang}: #{h other_page.title}</span>"
+  end
+  case page.publication_state.to_sym
+    when :published then h page.title
+    when :hidden then "<span class='state-hidden'>#{h page.title}</span>"
+    else
+      "<span class='state-not-published'>#{h page.title}</span>"
+  end
+end
+
+# Returns title and publication state as icon and text.
+#
+def admin_pages_title_as_icon_and_text( page_node, lang )
+  admin_pages_publication_state_as_icon( page_node, lang )+" "+admin_pages_title_as_text( page_node, lang )
+end
+
+
+# Returns link to a page for given +lang+, with respect to publication state.
+#
+def admin_pages_link_as_text( page_node, lang )
+  page = page_node.page( lang )
+  return "<span class='nodata'>no content</span>" if page.blank?
+  case page.publication_state.to_sym
+    when :published then h( page.link )
+    when :hidden then "<span class='state-hidden'>#{h page.link}</span>"
+    else
+      "<span class='state-not-published'>#{h page.link}</span>"
+  end
+end
+
+# Returns link and publication state as icon and text.
+#
+def admin_pages_link_as_icon_and_text( page_node, lang )
+  admin_pages_publication_state_as_icon( page_node, lang )+" "+admin_pages_link_as_text( page_node, lang )
+end
+
+# Returns full path to current page in given +lang+,
+# links are generated as icon and text
+#
+def admin_pages_url_as_text( page_node, lang )
+  return '' if page_node.nil?
+  page_node.ancestors_and_self.sort_by(&:depth).map do |pn|
+    if pn.root?
+      icon 'fa-home'
+    else
+      admin_pages_link_as_icon_and_text pn, lang
+    end
+  end.join(" / ")
+end
+

data/app/helpers/pages.rb

@@ -0,0 +1,32 @@
+# Returns root page in current lang
+#
+def page_root
+  @current_page_root ||= Page.root( current_locale )
+end
+
+# Returns or sets current Page object being served.
+#
+def current_page( page = nil )
+  @current_page = page if page.present?
+  @current_page
+end
+
+# Returns current page url, if Page is served,
+# plain ULR otherwise.
+#
+# If opts[:locale] is specified, tries to find closest page in other lang.
+#
+def current_page_url( opts = {} )
+  if current_page.present?
+    if !opts.key?(:locale) || opts[:locale] == current_page.lang
+      current_page.url
+    else
+      # find this page in other lang
+      other_page = Aerogel::Pages::Traversal.find_closest_in_other_lang( current_page, opts[:locale] )
+      return nil unless other_page.present?
+      url_to( other_page.url, opts )
+    end
+  else
+    current_url opts
+  end
+end

data/app/routes/admin-pages.rb

@@ -0,0 +1,150 @@
+namespace "/admin/pages" do
+
+  admin_menu "/admin/pages/", icon: 'fa-file', label: :'aerogel.admin.panes.pages', priority: 10
+
+  get "/", "/:lang-" do
+    @page_nodes = PageNode.traverse
+    @lang = params[:lang] || I18n.default_locale
+    pass
+  end
+
+  namespace "/:lang-:id" do
+    before do
+      @lang = params[:lang]
+      @selected_page_node = PageNode.find( params[:id] ) or halt 404
+    end
+
+    get do
+      @page_nodes = PageNode.traverse
+      pass
+    end
+
+    get "/preview" do
+      layout "admin/pages/preview"
+      @page_node = @selected_page_node
+      pass
+    end
+
+    get "/append" do
+      @page_node = PageNode.new( parent_id: @selected_page_node.parent_id )
+      @page_node.page_type = PageType.where( type: :page ).first
+      pass
+    end
+
+    post "/append" do
+      @page_node = PageNode.new( params[:page_node] )
+      @page_node.parent_id = @selected_page_node.parent_id
+      pass unless @page_node.save
+      @page_node.move_below @selected_page_node
+      redirect "/admin/pages/#{@lang}-#{@page_node.id}"
+    end
+
+    get "/insert" do
+      @page_node = PageNode.new( parent_id: @selected_page_node.id )
+      @page_node.page_type = PageType.where( type: :page ).first
+      pass
+    end
+
+    post "/insert" do
+      @page_node = PageNode.new( params[:page_node] )
+      @page_node.parent_id = @selected_page_node.id
+      if @page_node.save
+        redirect "/admin/pages/#{@lang}-#{@page_node.id}"
+      end
+      # flash.now[:error] = t.aerogel.db.errors.failed_to_save( name: h( @page.id ),
+      #   errors: @page.errors.full_messages.join(", ")
+      # )
+      pass
+    end
+
+    get "/delete" do
+      @page_node = @selected_page_node
+      pass
+    end
+
+    post "/delete" do
+      @page_node = @selected_page_node
+      # pass unless @page.save
+      parent_id = @page_node.parent_id
+      @page_node.destroy
+      redirect "/admin/pages/#{@lang}-#{parent_id}",
+        notice: "Page \"#{admin_pages_title_as_text @page_node, @lang}\" deleted."
+    end
+
+
+    get "/edit" do
+      @page_node = @selected_page_node
+      pass
+    end
+
+    post "/edit" do
+      # flash.now[:debug] = "params: #{params.inspect}"
+      @page_node = @selected_page_node
+      if @page_node.update_attributes params[:page_node].except( :page_type )
+        redirect "/admin/pages/#{@lang}-#{@page_node.id}" #, notice: "Page updated"
+      end
+      # flash.now[:error] = t.aerogel.db.errors.failed_to_save( name: h( @page.id ),
+      #  errors: @page.errors.full_messages.join(", ")
+      #)
+      pass
+    end
+
+    get "/edit/page_block" do
+      # Find or Create page and page content with given ids
+      # and place the new block inside
+      #
+      page_node = PageNode.find( params[:page_block][:page_node_id] )
+      unless page_node.present?
+        page_node = PageNode.new
+        page_node._id = params[:page_block][:page_node_id]
+      end
+      page = page_node.pages.find params[:page_block][:page_id]
+      unless page.present?
+        page = page_node.pages.new lang: params[:page_block][:lang]
+        page._id = params[:page_block][:page_id]
+      end
+      page_block = page.create_page_block params[:page_block]
+      field_prefix = "page_node[pages_attributes][#{page.lang}][page_blocks_attributes][#{page_block.id}]"
+      opts = {
+        field_prefix: field_prefix,
+        style: 'admin-pages-edit-block'
+      }
+      fields = Aerogel::Forms::Fieldset.new page_block, nil, nil, opts do
+        partial "admin/pages/edit/block", scope: self, locals: { type: params[:page_block][:type] }
+      end
+      fields.render
+    end
+
+    get "/edit/select_page" do
+      @page_nodes = PageNode.traverse
+      @select_lang = params[:select_lang] || @lang
+      @select_page_node_id = params[:select_page_node_id] || nil
+      view "admin/pages/edit/select_page"
+    end
+
+    get "/edit/select_template" do
+      @select_template_name = params[:select_template_name] || nil
+      @select_template_prefix = params[:select_template_prefix] || nil
+      @templates = []
+      templates_wildcard = File.join( @select_template_prefix, '**/*.erb' )
+      template_entry = Struct.new :id, :module, :filename
+      Aerogel.get_resource_list( :views, templates_wildcard ) do |f, rf, path, base_path|
+        id = rf
+        filename = rf.sub(/^#{@select_template_prefix}/, '')
+        module_name = base_path[:module_name]
+        @templates << template_entry.new( id, module_name, filename )
+      end
+
+      view "admin/pages/edit/select_template"
+    end
+
+  end # namespace ":lang\::id"
+  #
+  # Common Pages controller routes
+  #
+  route :get, :post, ['/', '/:id', '/:id/:action'] do
+    action = params[:action] || 'index'
+    view "admin/pages/#{action}"
+  end
+
+end

data/app/routes/pages.rb

@@ -0,0 +1,16 @@
+
+# Locate page by URL
+#
+get "/*" do
+  path = params[:splat].first.split "/" # .join "/"
+  @page = Aerogel::Pages::Traversal.find path, current_locale
+  pass if @page.nil?
+
+  current_page @page
+  page_title @page.try( :title )
+  view "pages/view"
+end
+
+error do
+  "Internal server error: #{h env['sinatra.error'].inspect}"
+end

data/assets/javascripts/admin-pages/pages-widget.js.coffee

@@ -0,0 +1,83 @@
+#
+#
+log = (msg) ->
+    console?.log "** admin/pages: #{msg}"
+
+
+class @PagesWidget
+    two_pane_widget: null
+    current_state: {
+        lang: 'en'
+    }
+
+    constructor: ( @element, @pane_left, @pane_right ) ->
+        @two_pane_widget = new TwoPaneWidget @element, @pane_left, @pane_right
+        top_h = $("#top-menu").outerHeight()
+        foot_h = $("#footer").outerHeight()
+        @height_fixer = new AutofixedHeight @element, top_h+foot_h #, top_h+ foot_h
+        @current_title = document.title
+        History.Adapter.bind window, 'statechange', =>
+            @set_state History.getState().data
+
+        @element.on 'changed.two-pane', (e, left_middle_right) =>
+            @on_pane_open left_middle_right
+        log "initialized"
+
+    # Callback invoked by tree 'selected' event
+    on_page_selected: ( id, object ) =>
+        @current_state.page_node_id = id
+        # @current_state.page_attributes = object.attributes
+        @push_state()
+        log "on_page_selected: id:#{@current_state.page_node_id}"
+
+
+    # Callback invoked on pane open/close events
+    on_pane_open: ( left_middle_right ) =>
+        @current_state.open_pane = left_middle_right
+        @push_state()
+
+    # Go to page
+    goto_page: (id) ->
+        @current_state.page_node_id = id
+        @push_state()
+
+    push_state: ->
+        # push current state to history,
+        url = ''
+        if @current_state.page_node_id?
+            url = "#{@current_state.lang}-#{@current_state.page_node_id}"
+        log "setting url to '#{url}'"
+        log "setting lang '#{@current_state.lang}'"
+        History.pushState( @current_state, @current_title, url )
+
+
+    set_state: ( state ) ->
+        log "set_state: id:#{state.page_node_id}"
+        # console?.log state
+        @current_state = state
+        if state.page_node_id?
+            row = pane_tree.find_row_by_id state.page_node_id
+            @current_state.page_attributes = row.attributes
+        @update @current_state
+
+    update: ( state ) ->
+        log "calling update(): id=#{state.page_node_id}"
+        pane_tree.update state
+        pane_preview.update state
+        if state.open_pane == 'left'
+            @two_pane_widget.open_left( false )
+        else if state.open_pane == 'right'
+            @two_pane_widget.open_right( false )
+        else
+            @two_pane_widget.open_middle( false )
+
+    # Constructs url to +action+ on page specified by +lang+ and +id+
+    #
+    url_to: ( lang, id = '', action = null ) ->
+        if action? then "#{lang}-#{id}/#{action}" else "#{lang}-#{id}"
+
+
+    # Constructs url to +action+ on page specified by current state.
+    #
+    url_to_action: ( action ) ->
+        @url_to( @current_state.lang, @current_state.page_node_id, action )

data/assets/javascripts/admin-pages/pane-preview.js.coffee

@@ -0,0 +1,37 @@
+log = (msg) ->
+    console?.log "** admin/pages:preview: #{msg}"
+
+class @PanePreview
+    constructor: (@element) ->
+        @content = @element.find('.content').first()
+        @preview = @element.find('#preview').first()
+        @preview_empty = @element.find('#preview-empty').first()
+        @toolbar = @element.find('.bottom-toolbar').first()
+        @attached_footer = new AttachedFooter
+            target: @preview
+            footer: @toolbar
+            observe: @content
+        @current_page_node_id = null
+        log "initialized"
+        # ...
+        #
+    update: (state) ->
+        if state.page_node_id?
+            url_preview = pages_widget.url_to_action 'preview'
+            url_edit = pages_widget.url_to_action 'edit'
+            if @current_page_node_id != state.page_node_id
+                $.get url_preview, (data) =>
+                    @preview.html data
+                    @preview.show()
+                    @preview_empty.hide()
+                    @content.animate {scrollTop: 0} #, 'slow'
+                    @toolbar.show()
+                    @toolbar.find('.page-edit-link').attr 'href', url_edit
+                    @attached_footer.update_footer()
+        else
+            @preview.hide()
+            @toolbar.hide()
+            @preview_empty.show()
+        @current_page_node_id = state.page_node_id
+
+

data/assets/javascripts/admin-pages/pane-tree.js.coffee

@@ -0,0 +1,105 @@
+# Left pane (tree) widget
+#
+tree_selector = "#tree"
+tree_column = 3
+
+log = (msg) ->
+    console?.log "** admin/pages:tree: #{msg}"
+
+class @PaneTree
+    constructor: (@element) ->
+        @tree_table = new SmartTreeTable @element.find( tree_selector ).first(),
+            column: tree_column
+            on_select: @on_tree_item_selected
+            prefix:
+                branch:
+                    expanded: '<i class="prefix-expanded fa fa-caret-down"></i>'
+                    collapsed: '<i class="prefix-collapsed fa fa-caret-right"></i>'
+            dragAndDrop:
+                enabled: false
+                dropTarget:
+                    overlay:
+                        before: '<i class="fa fa-long-arrow-up"></i>'
+                        into: '<i class="fa fa-long-arrow-right"></i>'
+                        after: '<i class="fa fa-long-arrow-down"></i>'
+
+        @select null
+
+        @attached_footer = new AttachedFooter
+            target: $(tree_selector)
+            footer: @bottom_toolbar()
+            observe: $('.pane-tree .content')
+
+        log "initialized"
+
+    # Updates pane tree widget
+    #
+    update: (state) ->
+        @tree_table.select state.page_node_id, false
+        @scroll_to_view state.page_node_id
+        @update_bottom_toolbar state
+        @update_top_toolbar state
+
+    select: (id) ->
+        @tree_table.select id, false
+
+    expand: (id) ->
+        @tree_table.expand id
+
+    scroll_to_view: (id) ->
+        return unless id?
+        row = @tree_table.rows[id]
+        return unless row?
+        el = row.el
+        el_t = el.position().top
+        el_b = el_t + el.height()
+        if el_t < 0 || $('.pane-tree .content').height() < el_b
+            origin_to = @tree_table.table.position().top
+            scroll_to = el.position().top
+            # console?.log "** pane-tree: scrolling to selected: #{scroll_to}: #{origin_to}"
+            @element.find('.content').animate { scrollTop: scroll_to - origin_to } #, 'slow'
+
+
+    # Callback to be invoked when page (tree item) is selected
+    #
+    on_tree_item_selected: (id, object, el) =>
+        pages_widget.on_page_selected id, object
+
+
+    # Returns row object specified by given +id+
+    #
+    find_row_by_id: (id) ->
+        @tree_table.rows[id]
+
+    # Returns action buttons elements, or elements within buttons specified by +selector+
+    #
+    bottom_toolbar: (selector = '') ->
+        @element.find(".bottom-toolbar #{selector}")
+
+    # Updates action buttons state and labels
+    #
+    update_bottom_toolbar: (state) ->
+        unless state.page_node_id?
+            @bottom_toolbar().hide()
+            return
+        object = @find_row_by_id state.page_node_id
+        @bottom_toolbar().show()
+        @bottom_toolbar('.page-append-link').attr 'href', pages_widget.url_to_action 'append'
+        @bottom_toolbar('.page-insert-link').attr 'href', pages_widget.url_to_action 'insert'
+        @bottom_toolbar('.page-delete-link').attr 'href', pages_widget.url_to_action 'delete'
+        @bottom_toolbar(' .page-name').text object.contents
+        @attached_footer.update_footer()
+
+    # Returns top toolbar element, or elements within buttons specified by +selector+
+    #
+    top_toolbar: (selector = '') ->
+        @element.find(".top-toolbar #{selector}")
+
+    # Updates top toolbar buttons and links
+    #
+    update_top_toolbar: (state) ->
+        @top_toolbar('.lang-select-link').each ->
+            lang = $(@).attr 'data-lang-id'
+            $(@).attr 'href', pages_widget.url_to( lang, state.page_node_id )
+
+

data/assets/javascripts/admin-pages-edit/admin-modal-select.js.coffee

@@ -0,0 +1,63 @@
+# Modal dialogs for page and template/layout selection.
+#
+
+modal_result = null
+
+@admin_modal_select_and_close = ( result ) ->
+    console?.log "** amdin modal select and close: #{result}"
+    modal_result = result
+    $("#adminModal").modal 'hide'
+
+@admin_modal_select_page_clear = (e) ->
+    field = $(e.currentTarget).closest('.field-select-page')
+    field.find('.page-node-id').val ''
+    field.find('.page-label').val ''
+
+@admin_modal_select_page_select = (e) ->
+    field = $(e.currentTarget).closest('.field-select-page')
+    modal_result = null
+    select_lang = field.data 'lang'
+    select_page_node_id = field.find(".page-node-id").val()
+    $("#adminModal").modal
+        remote: "edit/select_page?select_lang=#{select_lang}&select_page_node_id=#{select_page_node_id}"
+    $("#adminModal").on 'hidden.bs.modal', ->
+        if modal_result?
+            console?.log "** select page: selected result: #{modal_result.page_id}, #{modal_result.page_label}"
+            field.find('.page-node-id').val modal_result.page_node_id
+            html_result = $.parseHTML(modal_result.page_label)
+            text_result = $(html_result).text().replace(/^\s+|\s+$/g, '')
+            field.find('.page-label').val text_result
+        # on_select()
+        $("#adminModal").off 'hidden.bs.modal'
+
+@admin_modal_select_template_clear = (e) ->
+    field = $(e.currentTarget).closest('.field-select-template')
+    field.find('.template-id').val ''
+    field.find('.template-label').val ''
+
+@admin_modal_select_template_select = (e) ->
+    field = $(e.currentTarget).closest('.field-select-template')
+    modal_result = null
+    select_template_prefix = field.data 'prefix'
+    select_template_id = field.find(".template-id").val()
+    $("#adminModal").modal
+        remote: "edit/select_template?select_template_prefix=#{select_template_prefix}&select_template_name=#{select_template_id}"
+    $("#adminModal").on 'hidden.bs.modal', ->
+        if modal_result?
+            console?.log "** select template: selected result: #{modal_result.template_id}"
+            field.find('.template-id').val modal_result.template_id
+            html_result = $.parseHTML(modal_result.template_label)
+            text_result = $(html_result).text().replace(/^\s+|\s+$/g, '')
+            field.find('.template-label').val text_result
+        # on_select()
+        $("#adminModal").off 'hidden.bs.modal'
+
+
+# Install event handlers on select-page fields
+$ ->
+    $("body").on 'click', '.field-select-page .btn-clear', admin_modal_select_page_clear
+    $("body").on 'click', '.field-select-page .btn-select', admin_modal_select_page_select
+    $("body").on 'click', '.field-select-template .btn-clear', admin_modal_select_template_clear
+    $("body").on 'click', '.field-select-template .btn-select', admin_modal_select_template_select
+
+    console?.log "** select page fields installed"