drg_cms 0.4.39 → 0.4.53

data/app/models/{__dc_global_data.rb → __dc_stat.rb}

@@ -21,24 +21,23 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
-###########################################################################
-# Based on knowledge found here
-# http://jolierouge.net/2011/05/ruby-on-rails-session-in-models-not-so-evil-actually/
-###########################################################################
-class DcGlobalData
-  # This is a Locator/Broker class for global data that
-  # Needs to be accessible everywhere!
-  def self.method_missing(sym, *args, &block)
-    @@attrs ||= {}
-    sym = sym.to_s
-    if sym.include? "=" then
-      @@attrs[sym.gsub('=','')] = args.first
-    else
-#      if @@attrs[sym].class == Hash then
-#        return ValueProxy.new(@@attrs[sym])
-#      else
-        return @@attrs[sym]
-#      end
-    end
-  end
-end
+########################################################################
+# Mongoid::Document model for dc_stat documents.
+# 
+# 
+########################################################################
+
+class DcStat #:nodoc:
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  
+  field :key1,                type: String
+  field :key2,                type: String
+  field :key3,                type: String
+  field :value,               type: Integer, default: 0
+  field :text1,               type: String
+  field :text2,               type: String
+  field :link,                type: String
+  
+  index( { key1: 1, key2: 1, key3: 1 } )
+end

data/app/models/dc_ad.rb

@@ -21,6 +21,15 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
+##########################################################################
+# Mongoid::Document model for dc_ads collection. 
+# 
+# Ads can be defined as picture file, flash file or script. 
+# 
+# More than one ad can be shown on the same place of design. They are grouped by 
+# position field, have priority, valid time period and can be limited by number of 
+# clicks or displays. 
+##########################################################################
 class DcAd
   include Mongoid::Document
   include Mongoid::Timestamps
@@ -31,7 +40,7 @@ class DcAd
   field :file,        type: String,  default: ''
   field :script,      type: String,  default: ''
   field :link,        type: String,  default: ''
-  field :link_target,   type: String,  default: ''
+  field :link_target, type: String,  default: ''
   field :height,      type: Integer
   field :width,       type: Integer  
   field :valid_from,  type: DateTime
@@ -49,4 +58,7 @@ class DcAd
   belongs_to  :dc_site
   
   index( { dc_site: 1, position: 1 } )
+  
+  validates :position, presence: true
+  validates :description, presence: true  
 end

data/app/models/dc_ad_stat.rb

@@ -21,6 +21,12 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
+##########################################################################
+# Mongoid::Document model for dc_ad_stats collection. 
+# 
+# Documents in this collection holds data about displays and clicks on ads which
+# can be further processed for statistical purposes.
+##########################################################################
 class DcAdStat
   include Mongoid::Document
   include Mongoid::Timestamps

data/app/models/dc_big_menu.rb

@@ -20,6 +20,15 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
+
+##########################################################################
+# Mongoid::Document model for dc_big_menus collection. 
+#
+# This menu system is still experimental. It can be used for sites with menu
+# which has many sub menus each linked to its own document. Unlike other menu 
+# models which provide menu in single document (with embedded documents as sub menus) this 
+# menu system provides one document for every menu option.
+##########################################################################
 class DcBigMenu
   include Mongoid::Document
   include Mongoid::Timestamps
@@ -41,7 +50,9 @@ class DcBigMenu
   index( { dc_site_id: 1, parent: 1 } )
   index( { page_id: 1 } )
   
-###########################################################################  
+########################################################################### 
+# Process submenu. Subroutine of choices4_menu.
+########################################################################### 
 def self.add_sub_menu(site, parent, rez, level)
 #TODO Make this faster  
   only(:_id,:parent,:caption).where(dc_site_id: site._id, parent: parent).sort( order: 1).to_a.each do |m|
@@ -50,7 +61,9 @@ def self.add_sub_menu(site, parent, rez, level)
   end
 end
 
-###########################################################################  
+###########################################################################
+# Returns available menu choices for selecting menu
+###########################################################################
 def self.choices4_menu(site)
   rez   = []
   self.add_sub_menu(site, nil, rez, -1)

data/app/models/dc_big_table.rb

@@ -20,6 +20,29 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
+
+##########################################################################
+# Mongoid::Document model for dc_big_table collection.
+# 
+# Big table is meant to be a common space for defining default choices for select fields on forms. 
+# Documents are organized as key-value pair with the difference that values for the key can 
+# be defined for every site and can also be localized.
+# 
+# Usage (as used in forms):
+# 
+# In the example administrator may help user by providing values that can be used 
+# on DcAd document position field by defining them in ads-position key of big table.
+# Example is from dc_ads.yml form.
+# 
+#    10:
+#      name: position
+#      type: text_with_select
+#      eval: dc_big_table 'ads-positions'
+#      html:
+#        size: 20
+#        
+# dc_big_table collection embeds many DcBigTableValue documents.
+##########################################################################
 class DcBigTable
   include Mongoid::Document
   include Mongoid::Timestamps
@@ -34,17 +57,17 @@ class DcBigTable
   
   embeds_many :dc_big_table_values
   
-  index( { name: 1, site_id: 1 } )
+  index( { key: 1, site_id: 1 } )
   
   validates :key,         presence: true
   validates :description, presence: true
   
 ########################################################################
-# 
+# Will return possible choices for specified key prepared for usega in select input field.
 ########################################################################
-def self.choices4(name, site, locale=nil)
+def self.choices4(key, site, locale=nil)
   a = []
-  r = find(name: name, site: site)
+  r = find(key: key, site: site)
   if r
     r.dc_big_table_values.each do |v| 
       desc = v.description

data/app/models/dc_big_table_locale.rb

@@ -20,6 +20,13 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
+
+#####################################################################
+# Mongoid::Document model for dc_big_table_locale embedded document.
+# 
+# Documents are embedded in DcBigTableValue documents. Every value defined in 
+# DcBigTableValue parent document can have its locale translation.
+#####################################################################
 class DcBigTableLocale
   include Mongoid::Document
   include Mongoid::Timestamps

data/app/models/dc_big_table_value.rb

@@ -20,6 +20,13 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
+
+#####################################################################
+# Mongoid::Document model for dc_big_table_values embedded documents.
+# 
+# Documents are embedded in DcBigTable document. Every value defined has its own description,
+# which can further be translated in embedded DcBigTableLocale documents.
+#####################################################################
 class DcBigTableValue
   include Mongoid::Document
   include Mongoid::Timestamps

data/app/models/dc_category.rb

@@ -20,6 +20,13 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
+
+#####################################################################
+# Mongoid::Document model for dc_categories collection.
+# 
+# Categories are used on DcPage documents for grouping documents. Categorization 
+# is most useful for grouping news, blog entries ...
+#####################################################################
 class DcCategory
   include Mongoid::Document
   include Mongoid::Timestamps
@@ -39,10 +46,9 @@ class DcCategory
   index  ctype: 1
   
 #########################################################################
-# returns all possible parent values
+# Returns all values where parent value is nil (top level parent).
 #########################################################################
-
-  def self.values_for_parent
+  def self.values_for_parent #:nodoc:
     where(parent: nil).sort(name: 1).inject([]) {|r,v| r << [v.name, v._id]} 
   end
 end

data/app/models/dc_design.rb

@@ -20,6 +20,55 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
+
+########################################################################
+# Mongoid::Document model for dc_designs collection.
+# 
+# Designs are essential parts of DRG CMS. Every DcPage document must have its design document defined.
+# If DcPage documents are anchors for url addresses, DcDesign documents define how 
+# will page data be rendered in browser. 
+# 
+# DcDesign documents define what would normally be written into Rails view file. The code
+# is saved in the body field of DcDesign document. If you prefere Rails way, enter view 
+# file name into rails_view field and put your code into file into views directory 
+# (ex. designs/home_page for ../views/designs/home_page.html.erb file). 
+# 
+# If you choose to save code to Rails view file you must add one top and bottom line to every source file.
+# Top line will provide CMS edit menu, bottom line will provide additional CSS and javascript code
+# scooped when renderers are called.
+# 
+# Example (as written in body of dc_design):
+#    <div id="site">
+#      <div id="site-top-bg">
+#        <div id="site-top"><div id="logo"><%= dc_render(:dc_piece, name: 'site-top') %></div>
+#          <div id="login"><%= dc_render(:common, method: 'login') %></div>
+#       </div>
+#        <%= dc_render(:dc_menu, name: 'test-menu') %>
+#      </div>
+#
+#      <div id="page"><%= dc_render(:dc_page) %></div>
+#    </div>
+#    <div id="site-bottom"><%= dc_render(:dc_piece, name: 'site-bottom') %></div>
+#    
+# Example (as written in Rails view file):
+# 
+#    <!-- Pay attention on lines added at the top and bottom of file -->
+#    <%= render partial: 'cmsedit/edit_stuff' if session[:edit_mode] > 0 %>
+#    
+#    <div id="site">
+#      <div id="site-top-bg">
+#        <div id="site-top"><div id="logo"><%= dc_render(:dc_piece, name: 'site-top') %></div>
+#          <div id="login"><%= dc_render(:common, method: 'login') %></div>
+#       </div>
+#        <%= dc_render(:dc_menu, name: 'test-menu') %>
+#      </div>
+#
+#      <div id="page"><%= dc_render(:dc_page) %></div>
+#    </div>
+#    <div id="site-bottom"><%= dc_render(:dc_piece, name: 'site-bottom') %></div>
+#    
+#    <style type="text/css"><%= @css.html_safe %></style><%= javascript_tag @js %>
+########################################################################
 class DcDesign
   include Mongoid::Document
   include Mongoid::Timestamps
@@ -35,6 +84,7 @@ class DcDesign
   field   :updated_by,  type: BSON::ObjectId
   
   embeds_many :dc_parts
+#  embeds_many :dc_parts, as: :dc_parts
 
   index( { name: 1 }, { unique: true } )
   

data/app/models/dc_dummy.rb

@@ -21,10 +21,50 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
+########################################################################
+# Mongoid::Document model for dc_dummy collection. 
+# 
+# Which is not collection at all. DcDummy model is used for entering data on forms 
+# where data will not be saved to database but will instead be processed by custom 
+# made routine. For example entering begin and end date on report.
+# 
+# Example (as used in forms):
+# 
+#    table: dc_dummy
+#    title: Enter time period
+#
+#      form:
+#        actions:
+#          1:
+#            type: ajax
+#            method: post
+#            controller: reports
+#            action: do_some_report
+#            caption: Run report
+#
+#        fields:
+#          10:
+#            name: date_start
+#            type: date_picker
+#            caption: Start date
+#          20:
+#            name: date_end
+#            type: date_picker
+#            caption: End date
+#            
+# And suppose your report saved data to file named public/report.pdf. Put this line at the end of do_some_report
+# action:
+#    render inline: { :window_report => '/report.pdf' }.to_json, formats: 'js'
+#    
+# As result report.pdf file will be opened in new browser window.
+########################################################################
 class DcDummy
   include Mongoid::Document
   
-  def method_missing(m, *args, &block)
+########################################################################
+# Ignore errors.
+########################################################################
+  def method_missing(m, *args, &block) #:nodoc:
     nil
   end
 end

data/app/models/dc_folder_permission.rb

@@ -22,7 +22,14 @@
 #++
 
 #########################################################################
-#
+# Mongoid::Document model for dc_folder_permissions collection. 
+# 
+# Similar to DcPermission DcFolderPermission model defines documents
+# for accessing file system. Permissions defined on a parent folder automatically
+# apply to all folders below unless folder on lower level has its own permission document.
+# 
+# At least one document must exist for file manager to work. Default document
+# usually defines that admin role has ADMINISTRATOR rights on top level folder.
 #########################################################################
 class DcFolderPermission
 include Mongoid::Document
@@ -30,7 +37,7 @@ include Mongoid::Timestamps
 
 field   :folder_name, type: String
 field   :inherited,   type: Boolean, default: true
-field   :is_default,  type: Boolean, default: false  
+#field   :is_default,  type: Boolean, default: false  
 field   :active,      type: Boolean, default: true  
 
 embeds_many :dc_policy_rules

data/app/models/{dc_global_data.rb → dc_ident.rb}

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2012+ Damjan Rems
+# Copyright (c) 2015+ Damjan Rems
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -21,24 +21,22 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
-###########################################################################
-# Based on knowledge found here
-# http://jolierouge.net/2011/05/ruby-on-rails-session-in-models-not-so-evil-actually/
-###########################################################################
-class DcGlobalData
-  # This is a Locator/Broker class for global data that
-  # Needs to be accessible everywhere!
-  def self.method_missing(sym, *args, &block)
-    @@attrs ||= {}
-    sym = sym.to_s
-    if sym.include? "=" then
-      @@attrs[sym.gsub('=','')] = args.first
-    else
-#      if @@attrs[sym].class == Hash then
-#        return ValueProxy.new(@@attrs[sym])
-#      else
-        return @@attrs[sym]
-#      end
-    end
-  end
-end
+########################################################################
+# Mongoid::Document model for dc_idents emdedded documents.
+# 
+# dc_idents are similar to mongoid hash structure and can be used for saveing 
+# key/value object. Fact is that I have overlooked the existance of MongoDB Hash field type
+# and this structure will be used until drg_forms_field which will use Hash field type is created.
+#########################################################################
+class DcIdent
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  field   :key,       type: String
+  field   :value,     type: String
+
+  embedded_in :idents, polymorphic: true 
+  
+  validates :key, presence: true
+  validates :value, presence: true
+end

data/app/models/dc_journal.rb

@@ -21,6 +21,14 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
+#########################################################################
+# Mongoid::Document model for dc_journals collection. 
+# 
+# dc_journals collections saves all data that has been updated through cmsedit 
+# controller. It saves old and new values of changed fields and can be used for
+# instant restore of single document field or tracking who and when updated 
+# particular document.
+#########################################################################
 class DcJournal
   include Mongoid::Document
   
@@ -32,7 +40,7 @@ class DcJournal
   field :ids,         type: String
   field :ip,          type: String
   field :time,        type: DateTime
-  field :diff,     type: String
+  field :diff,        type: String
   
   index( { user_id: 1, time: -1 } )  
   index( { time: 1 } )