drg_manual 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7da9d2693c1ed2ef587bab36fb87739b4db73bad
+  data.tar.gz: 2cb5aa108d3939063808f9f3b43de677d0a69846
+SHA512:
+  metadata.gz: def3863a5070aed0c7d777933ccd5f8011b1b6ba93936d25c26245c1b224912e62fdc5a08605defd85b610b1936f2faa46a695cb2109f341fe2e91b2459d2554
+  data.tar.gz: b8d88f7756fde5d94662a9a566c59c8983eb77c5aed81b1550ac39d6c0b9521d7a06832f1aa8847d3c831d84b13b854dcac9675cf7ca164d086c122dab722908

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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,60 @@
+# DrgBooks
+
+DrgBooks plugin implements documentation management in DRG CMS enabled web site.
+
+Configuration
+----------------
+
+Usage:
+
+Add this line to your Gemfile:
+```ruby
+  gem 'drg_books'
+```  
+
+Create apropriate dc_page document with related design. Use this line in design.
+```irb
+div id="docs"><%= dc_render(:dc_book) %></div>
+```
+
+Update routes.rb
+```ruby
+  get '/books/:method/:book_id/', to: 'dc_main#page', :defaults => { path: 'books' }
+  get '/books/:method/:book_id/:chapter_id', to: 'dc_main#page', :defaults => { path: 'books' }
+  get '/books/:method/:book_id/:chapter_id/:version', to: 'dc_main#page', :defaults => { path: 'books' }
+```
+
+Documentation
+-------------
+
+Please see the DRG CMS website for up-to-date documentation:
+[www.drgcms.org](http://www.drgcms.org)
+
+License
+-------
+
+Copyright (c) 2012-2015 Damjan Rems
+
+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.
+
+Credits
+-------
+
+Damjan Rems: damjan dot rems at gmail dot com

data/Rakefile

@@ -0,0 +1,39 @@
+#!/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    = 'DrgManual'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/stylesheets/drg_manual.css

@@ -0,0 +1,52 @@
+/*
+#--
+# Copyright (c) 2018+ Damjan Rems
+#
+# 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.
+#++
+*/
+
+.manual .menu a {
+  padding: 5px 0;
+  font-size: 1.2em;
+  color: #666;
+}
+.manual .title {
+  font-size: 1.3em;
+  font-weight: bold;
+}
+.manual .title a {
+  color: #db363a;
+}
+.manual .menu a:hover {
+  color: #444;
+}
+
+.manual .menu .is-active > a {
+  color: #444;
+  font-weight: bold;
+  background-color: transparent;
+}
+
+.manual .column:first-child {
+  background: linear-gradient(to top, #eee 0%, #fefefe 100%); 
+  padding: 1em;
+  border-radius: 2px;
+}

data/app/controllers/drgcms_controls/dc_book_chapter_dc_reply_control.rb

@@ -0,0 +1,50 @@
+#encoding: utf-8
+#--
+# Copyright (c) 2014+ Damjan Rems
+#
+# 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.
+#++
+
+######################################################################
+# DrgcmsControls for DcBlog.DcReply form
+######################################################################
+module DrgcmsControls::DcBookChapterDcReplyControl
+
+######################################################################
+# Called when new empty record is created
+######################################################################
+def dc_new_record()
+# fill with quote when reply_to is present  
+  if params[:reply_to]
+    replyto = @record._parent.dc_replies.find(params[:reply_to])
+    @record.subject = "Re: #{replyto.subject}"
+    @record.body = "<div class='dc-forum-quote'>#{replyto.body}</div><br>"
+  end
+  @record.created_by_name = session[:user_name] if session[:user_name]
+end
+
+######################################################################
+# Called before save. Reloads browser.
+######################################################################
+def dc_before_save()
+  params[:return_to] = 'parent.reload'
+end
+
+end 

data/app/forms/cms_menu.yml

@@ -0,0 +1,34 @@
+#--
+# Copyright (c) 2012-2013 Damjan Rems
+#
+# 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.
+#++
+
+menu:
+  80_drg_manuals: 
+    caption: Manuals
+    icon: book lg        
+    items:
+      10:
+        caption: helpers.label.drg_manual.tabletitle
+        controller: cmsedit
+        icon: book lg        
+        table: drg_manual
+                

data/app/forms/dc_manual.yml

@@ -0,0 +1,58 @@
+# Form DcManual
+table: dc_manual
+index:
+  actions: standard
+  
+result_set:
+  actions: 
+    standard : yes
+
+  columns:
+    10:  
+      name: title
+      width: 30%
+    20:  
+      name: updated_at
+      format: '%d.%m.%Y'
+    30:  
+      name: order
+    40: 
+      name: active
+      eval: dc_icon4_boolean      
+
+form:
+  actions: standard
+
+  tabs:
+    1basic:
+      10:
+        name: title
+        type: text_field
+        size: 80
+      20:
+        name: link
+        type: text_field
+        size: 80
+      30:
+        name: policy_id
+        type: select
+        eval: dc_choices4_site_policies
+        html:
+          include_blank: true
+      40:
+        name: active
+        type: check_box
+        
+    2body:
+      20:
+        name: body
+        type: html_field
+        options: 'height: 800,width: 800'
+        
+    3pages:
+      10:
+        name: dc_manual_pages
+        type: embedded
+        form_name: dc_manual_page
+        html:
+          height: 1000

data/app/forms/dc_manual_page.yml

@@ -0,0 +1,70 @@
+# Form for drg_manual_pages
+table: dc_manual_pages
+index:
+  actions: new
+  
+result_set:
+  actions: 
+    standard : yes
+
+  columns:
+    10:  
+      name: title
+      width: 30%
+    20:  
+      name: updated_at
+      format: '%d.%m.%Y'
+    30:  
+      name: order
+    40: 
+      name: active
+      eval: dc_icon4_boolean
+      width: 5%
+
+form:
+  actions: standard
+
+  tabs:
+    1basic:
+      10:
+        name: title
+        type: text_field
+        size: 80
+      20:
+        name: link
+        type: text_field
+        size: 80
+      30:
+        name: policy_id
+        type: select
+        eval: dc_choices4_site_policies
+        html:
+          include_blank: true
+      40:
+        name: order
+        type: text_field
+        size: 2
+        
+      50:
+        name: active
+        type: check_box
+        
+      60:
+        name: use_page
+        type: tree_select
+        eval: "DcManual.get_all_menus()"
+        style: "max-height: 300px"
+        
+    2body:
+      20:
+        name: body
+        type: html_field
+        options: 'height: 600,width: 800'
+        
+    3pages:
+      10:
+        name: dc_manual_pages
+        type: embedded
+        form_name: dc_manual_page
+        html:
+          height: 1000

data/app/forms/dc_manual_settings.yml

@@ -0,0 +1,17 @@
+## Form for dc_manual settings
+table: dc_memory
+title: helpers.dc_manual.settings
+controls: design_element_settings
+
+form:
+  actions: 
+    1: save
+
+  fields:
+    10:
+      name: prirocnik_id
+      text: helpers.dc_manual.drg_manual_id
+      help: helpers.dc_manual.drg_manual_id_help
+      type: select
+      eval: "dc_choices4('dc_manual','title')"
+      

data/app/helpers/dc_manual_renderer.rb

@@ -0,0 +1,209 @@
+#coding: utf-8
+#--
+# Copyright (c) 2018+ Damjan Rems
+#
+# 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.
+#++
+
+########################################################################
+# 
+########################################################################
+class DcManualRenderer
+include DcApplicationHelper
+
+########################################################################
+#
+########################################################################
+def initialize( parent, opts={} )
+  @parent = parent
+  @opts   = opts
+  self
+end
+
+#########################################################################
+# List all manuals
+########################################################################
+def list
+  html = "<div class='#{@opts[:div] || 'list-manuals'}'>"
+  if @opts[:edit_mode] > 1
+    html << dc_link_for_create({ controller: 'cmsedit', table: 'dc_manual', title: t('dc_manual.new') }) 
+  end
+  manuals = DcManual.where(active: true).sort(title: 1).to_a
+  html << @parent.render( partial: 'dc_manual/list', locals: { manuals: manuals }, formats: [:html] )
+  html << '</div>'
+end
+
+########################################################################
+# Find document.
+########################################################################
+def find_document
+# found bookname in path link 
+  book_name_ix = @path.index(@parent.page.link)
+  @manual      = DcManual.find_by(link: @path[book_name_ix+1])
+  if @manual
+    @prepand_path = @path.shift(book_name_ix+2)
+  else
+# manual_id should be set in page settings   
+    manual_id  = @opts.dig(:settings, 'manual', 'manual_id')
+    @prepand_path = @path.shift(book_name_ix+1)
+    @manual       = DcManual.find(manual_id) if manual_id
+  end  
+  return if @manual.nil?
+# ids for editing manual page
+  @manual_ids  = '' 
+# Determine selected page
+  @manual_page = @manual
+  while (link_page = @path.shift) != nil do
+    @manual_ids << (@manual_ids.blank? ? '' : ';') + "#{@manual_page.id}"
+    @manual_page = @manual_page.dc_manual_pages.find_by(link: link_page)
+    if @manual_page.nil?
+# select first page if path is in error    
+      @manual_page = @manual
+      break 
+    end      
+  end
+end
+
+########################################################################
+# Create link for one page
+########################################################################
+def menu_link_for(menu, parent_path)
+  document_link = parent_path + [menu[4]]
+  document_link.shift # remove link to document name
+  link = "/#{@prepand_path.join('/')}/#{document_link.join('/')}"
+  @parent.link_to(menu[0],link)
+end
+
+########################################################################
+# Create submenus for a menu
+########################################################################
+def submenu(menu_item, menu, parent_path)
+# is active when ids path matches parent path or last (my id) matches manual_page
+  last_item = menu_item[1].split(';').last
+  is_active = (@manual_ids.match(menu_item[1]) or last_item.match(@manual_page.id.to_s)) ? ' is-active' : '' 
+  
+  html = parent_path.blank? ? '' : "<li class=\"#{is_active}\">#{menu_link_for(menu_item, parent_path)}" 
+# select subpages  
+  sub_pages = menu.select {|e| e[2] == menu_item[1]}
+  return html if sub_pages.size == 0
+#  
+  sub_pages.sort! {|a,b| a[3] <=> b[3]}
+  sub_pages.each do |page|
+    html << %Q[<ul class="menu vertical nested #{is_active}" >]
+    html << submenu(page, menu, parent_path + [menu_item[4]] )
+    html << '</ul>'
+  end
+  html << '</li>'
+end
+
+########################################################################
+# Create menu 
+########################################################################
+def manual_menu
+  menu = @manual.choices4_all_as_tree    
+  html = "<div class=\"title\">#{menu_link_for(menu.first,[])}</div>"
+  html << submenu(menu.first, menu, [])
+%Q[<ul id="manual-menu" class="is-active menu multilevel-accordion-menu " data-accordion-menu data-submenu-toggle="true">
+  #{html}
+</ul>]
+end
+
+#######################################################################
+# Render manual data
+#######################################################################
+def default
+  @path = @opts[:path]
+  return list if @path.size == 1 
+# link for manual settings on the page  
+  edit_html = ''
+  if dc_edit_mode?
+    edit_html << @parent.dc_link_for_edit(table: 'dc_memory', title: 'dc_manual.settings', 
+                             form_name: 'dc_manual_settings', icon: 'book lg', 
+                             location: @parent.page.class.to_s,
+                             field_name: 'params', id: @parent.page.id,
+                             action: 'new', element: 'manual' )
+  end
+  find_document()
+  return "ERROR! #{@parent.params[:path]} #{edit_html}" if @manual.nil? or @manual_page.nil?
+#  
+  if dc_edit_mode?
+    opts = { action: 'edit', table: 'dc_manual', 
+             id: @manual._id, title: 'dc_manual.edit' }
+    edit_html << dc_link_for_edit(opts)    
+  end
+#
+  html = %Q[
+<div class="wrap">
+<div class="row manual">
+  <div class="column small-12 medium-3 large-4">
+    #{edit_html}#{manual_menu()}
+  </div>
+  <div class="column small-12 medium-9 large-8 body">]
+#
+# ;add dc_manual_pages 
+  no_subsections = @manual_ids.split(';').size
+  table = 'dc_manual' + ';dc_manual_page'*no_subsections
+  form_name = @manual_ids.blank? ? 'dc_manual' : 'dc_manual_page'
+  if dc_edit_mode?
+    unless @manual_ids.blank?
+      opts = { action: 'edit', form_name: form_name, table: table,
+               ids: @manual_ids, 'id' => @manual_page.id, 
+               title: I18n.t('dc_manual.edit_chapter', title: @manual_page.title) }
+      html << dc_link_for_edit(opts) + '<br>'.html_safe
+    end
+# Add new subchapter
+    ids = @manual_ids + (@manual_ids.blank? ? '' : ';') + @manual_page.id.to_s
+    table = 'dc_manual' + ';dc_manual_page'*(no_subsections+1)
+    opts = { controller: 'cmsedit', action: 'new', form_name: 'dc_manual_page', 
+             table: table, ids: ids, 
+             title: I18n.t('dc_manual.new_chapter', title: @manual_page.title) }
+    html << dc_link_for_create(opts) + '<br>'.html_safe  
+  end
+#    
+  can_view, msg = dc_user_can_view(@parent, @manual_page)
+  html << if can_view
+%Q[<h2>#{@manual_page.title}</h2>#{@manual_page.body}<br>
+<div class='updated'>
+  #{t('dc_manual.updated')} <b>#{@manual_page.updated_at.strftime('%d.%m.%Y')}</b>
+</div>]
+  else
+    msg
+  end
+  html << '</div></div></div>'
+end
+
+########################################################################
+#
+########################################################################
+def render_html
+  method = @opts[:method] || 'default'
+  return "#{self.class}. Method #{method} not defined!" unless method
+  
+  send method
+end
+
+########################################################################
+#
+########################################################################
+def render_css
+  @manual.try :css
+end
+
+end