Module: DcApplicationHelper
- Included in:
- BrowseModelsControl, DcAdRenderer, DcBigMenuRenderer, DcCommonRenderer, DcGalleryRenderer, DcMenuRenderer, DcPageRenderer, DcPartRenderer, DcPieceRenderer, DcPollRenderer, DcSimpleMenuRenderer
- Defined in:
- app/helpers/dc_application_helper.rb
Overview
DcApplicationHelper defines common helper methods for using with DRG CMS.
Instance Attribute Summary collapse
-
#design ⇒ Object
readonly
design document.
-
#form ⇒ Object
readonly
form object.
-
#ids ⇒ Object
readonly
ids url parameter.
-
#json_ld ⇒ Object
readonly
json_ld.
-
#menu ⇒ Object
readonly
menu document.
-
#menu_item ⇒ Object
readonly
selected menu_item document.
-
#options ⇒ Object
readonly
options object.
-
#page ⇒ Object
readonly
page document.
-
#page_title ⇒ Object
page title.
-
#part ⇒ Object
readonly
part.
-
#parts ⇒ Object
all parts read from page, design, …
-
#record ⇒ Object
Returns the value of attribute record.
-
#record_footer ⇒ Object
Returns the value of attribute record_footer.
-
#site ⇒ Object
readonly
site document.
-
#tables ⇒ Object
readonly
tables url parameter.
Instance Method Summary collapse
-
#_origin ⇒ Object
When @parent is present then helper methods are called from parent class otherwise from self.
-
#dc_add2_record_cookie(hash) ⇒ Object
Will add data to record cookie.
-
#dc_add_json_ld(element) ⇒ Object
Will add new element to json_ld structure.
-
#dc_add_meta_tag(type, name, content) ⇒ Object
Will add a meta tag to internal hash structure.
-
#dc_big_table(key) ⇒ Object
Returns key defined in DcBigTable as array of choices for use in select fields.
-
#dc_choices4(model, name, id = '_id', options = {}) ⇒ Object
Returns choices for select input field when choices are generated from all documents in collection.
-
#dc_choices4_all_collections ⇒ Object
Returns list of all collections (tables) as array of choices for usage in select fields.
-
#dc_choices4_cmsmenu ⇒ Object
Returns choices for creating collection edit select field on CMS top menu.
-
#dc_choices4_folders_list ⇒ Object
Returns list of directories as array of choices for use in select field on folder permission form.
-
#dc_choices4_menu ⇒ Object
Returns list of choices for selection top level menu on dc_page form.
-
#dc_choices4_site_policies ⇒ Object
Return array of policies defined in a site document formated to be used as choices for select field.
-
#dc_deprecate(msg) ⇒ Object
Writes out deprication msg.
-
#dc_document_path(document) ⇒ Object
Will return whole path to document if document is embedded in another document.
-
#dc_dont?(what, default = false) ⇒ Boolean
Returns true if parameter has value of 0, false, no, none or -.
-
#dc_edit_mode? ⇒ Boolean
Checks if CMS is in edit mode (CMS menu bar is visible).
-
#dc_edit_title ⇒ Object
Creates title for cmsedit edit action dialog.
-
#dc_error_messages_for(doc) ⇒ Object
Returns validation error messages for the document (record) formatted for display on message div.
-
#dc_flash_messages ⇒ Object
Returns flash messages formatted for display on message div.
-
#dc_get_json_ld ⇒ Object
Will return formated code for embedding json+ld data into page.
-
#dc_get_seo_meta_tags ⇒ Object
Will return meta data for SEO optimizations.
-
#dc_get_site ⇒ Object
Parse site name from url and return dc_site document.
-
#dc_icon_for_link(icon) ⇒ Object
Returns icon code if icon is specified.
-
#dc_iframe_edit(table, opts = {}) ⇒ Object
Will return html code required for load DRG form into iframe.
-
#dc_img_alt(file_name, text = nil) ⇒ Object
Will return alt image option when text is provided.
-
#dc_img_alt_tag(file_name, text = nil) ⇒ Object
Will return alt image option when text is provided.
-
#dc_internal_var(object, var_name, current_document = nil) ⇒ Object
Will return value from Rails and DRG internal objects.
-
#dc_label_for(input_html, label) ⇒ Object
Formats label and html input code for display on edit form.
-
#dc_limit_string(string, size) ⇒ Object
Truncates string length maximal to the size required and takes care, that words are not broken in middle.
-
#dc_link_for_create(opts) ⇒ Object
Will create HTML code required to create new document.
-
#dc_link_for_edit(opts) ⇒ Object
Will create HTML code required to edit document.
-
#dc_link_for_edit1(opts, link_text) ⇒ Object
Create one option in page edit link.
-
#dc_link_menu_tag(title) {|html| ... } ⇒ Object
Create edit link with edit picture.
-
#dc_link_to(caption, icon, parms, rest = {}) ⇒ Object
Similar to rails link_to, but also takes care of link icon, translation, …
-
#dc_menu_class ⇒ Object
Return menu class model defined in site document menu_class field.
-
#dc_new_title ⇒ Object
Creates title for cmsedit new action dialog.
-
#dc_page_bottom ⇒ Object
Helper for adding additional css and javascript code added by documents and renderers during page rendering.
-
#dc_page_class ⇒ Object
Return page class model defined in site document page_class field.
-
#dc_page_edit_menu(opts = @opts) ⇒ Object
Create edit menu for editing existing or creating new dc_page documents.
-
#dc_page_top ⇒ Object
Helper for rendering top CMS menu when in editing mode.
-
#dc_render(renderer, opts = {}) ⇒ Object
This is main method used for render parts of design into final HTML document.
- #dc_render_design(part) ⇒ Object
-
#dc_render_design_part(part) ⇒ Object
Used for designs with lots of common code and one (or more) part which differs.
-
#dc_render_from_site(opts = {}) ⇒ Object
Used for designs with lots of common code and one (or more) part which differs.
-
#dc_render_partial(opts = {}) ⇒ Object
This is main method used for render parts of design into final HTML document.
-
#dc_replace_in_design(opts = {}) ⇒ Object
Used for designs with lots of common code and one (or more) part which differs.
-
#dc_submit_tag(caption, icon, parms, rest = {}) ⇒ Object
Similar to rails submit_tag, but also takes care of link icon, translation, …
-
#dc_table_title(text, result_set = nil) ⇒ Object
Creates title div for DRG CMS dialogs.
-
#dc_user_can_view(ctrl, policy_id) ⇒ Object
Will check if user roles allow user to view data in document with defined access_policy.
-
#dc_user_has_role(role, user = nil, roles = nil) ⇒ Object
Check if user has required role assigned to its user profile.
-
#decamelize_type(string) ⇒ Object
Decamelizes string.
-
#forms_merge(hash1, hash2) ⇒ Object
Merges two forms when current form extends other form.
Instance Attribute Details
#design ⇒ Object (readonly)
design document
35 36 37 |
# File 'app/helpers/dc_application_helper.rb', line 35 def design @design end |
#form ⇒ Object (readonly)
form object
47 48 49 |
# File 'app/helpers/dc_application_helper.rb', line 47 def form @form end |
#ids ⇒ Object (readonly)
ids url parameter
45 46 47 |
# File 'app/helpers/dc_application_helper.rb', line 45 def ids @ids end |
#json_ld ⇒ Object (readonly)
json_ld
62 63 64 |
# File 'app/helpers/dc_application_helper.rb', line 62 def json_ld @json_ld end |
#menu ⇒ Object (readonly)
menu document
39 40 41 |
# File 'app/helpers/dc_application_helper.rb', line 39 def @menu end |
#menu_item ⇒ Object (readonly)
selected menu_item document
41 42 43 |
# File 'app/helpers/dc_application_helper.rb', line 41 def @menu_item end |
#options ⇒ Object (readonly)
options object
49 50 51 |
# File 'app/helpers/dc_application_helper.rb', line 49 def @options end |
#page ⇒ Object (readonly)
page document
33 34 35 |
# File 'app/helpers/dc_application_helper.rb', line 33 def page @page end |
#page_title ⇒ Object
page title
54 55 56 |
# File 'app/helpers/dc_application_helper.rb', line 54 def page_title @page_title end |
#part ⇒ Object (readonly)
part
51 52 53 |
# File 'app/helpers/dc_application_helper.rb', line 51 def part @part end |
#parts ⇒ Object
all parts read from page, design, …
56 57 58 |
# File 'app/helpers/dc_application_helper.rb', line 56 def parts @parts end |
#record ⇒ Object
Returns the value of attribute record.
58 59 60 |
# File 'app/helpers/dc_application_helper.rb', line 58 def record @record end |
#record_footer ⇒ Object
Returns the value of attribute record_footer.
60 61 62 |
# File 'app/helpers/dc_application_helper.rb', line 60 def @record_footer end |
#site ⇒ Object (readonly)
site document
37 38 39 |
# File 'app/helpers/dc_application_helper.rb', line 37 def site @site end |
#tables ⇒ Object (readonly)
tables url parameter
43 44 45 |
# File 'app/helpers/dc_application_helper.rb', line 43 def tables @tables end |
Instance Method Details
#_origin ⇒ Object
When @parent is present then helper methods are called from parent class otherwise from self.
68 69 70 |
# File 'app/helpers/dc_application_helper.rb', line 68 def _origin #:nodoc: @parent ? @parent : self end |
#dc_add2_record_cookie(hash) ⇒ Object
Will add data to record cookie. Record cookie is used to preload some data on next create action. Create action will look for cookies and if found initialize fields on form with matching name to value found in cookie data.
Example:
kukis = {'dc_page.dc_design_id' => @page.dc_design_id,
'dc_page.dc_menu_id' => @page.menu_id)
dc_add2_record_cookie(kukis)
867 868 869 870 871 872 873 874 875 |
# File 'app/helpers/dc_application_helper.rb', line 867 def (hash) kukis = if @parent.[:record] and @parent.[:record].size > 0 Marshal.load(@parent.[:record]) else {} end hash.each {|k,v| kukis[k] = v } @parent.[:record] = Marshal.dump(kukis) end |
#dc_add_json_ld(element) ⇒ Object
Will add new element to json_ld structure
Parameters:
- element
-
Hash or Array of hashes: json+ld element
1175 1176 1177 1178 1179 1180 1181 1182 |
# File 'app/helpers/dc_application_helper.rb', line 1175 def dc_add_json_ld(element) @json_ld ||= [] if element.class == Array @json_ld += element else @json_ld << element end end |
#dc_add_meta_tag(type, name, content) ⇒ Object
Will add a meta tag to internal hash structure. If meta tag already exists it will be overwritten.
Parameters:
- name
-
String: meta name
- content
-
String: meta content
1208 1209 1210 1211 1212 1213 |
# File 'app/helpers/dc_application_helper.rb', line 1208 def (type, name, content) return if content.blank? @meta_tags ||= {} key = "#{type}=\"#{name}\"" @meta_tags[key] = content end |
#dc_big_table(key) ⇒ Object
Returns key defined in DcBigTable as array of choices for use in select fields. DcBigTable can be used like a key/value store for all kind of predefined values which can be linked to site and or locale.
Parameters:
- key
-
String. Key name to be searched in dc_big_tables documents.
Example:
10:
name: category
type: select
eval: dc_big_table 'categories_for_page' # as used on form
Returns: Array of choices ready for select field.
1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 |
# File 'app/helpers/dc_application_helper.rb', line 1027 def dc_big_table(key) ret = [] bt = DcBigTable.find_by(key: key, site: dc_get_site._id, active: true) bt = DcBigTable.find_by(key: key, site: nil, active: true) if bt.nil? return ret if bt.nil? locale = I18n.locale.to_s bt.dc_big_table_values.each do |v| # iterate each value next unless v.active desc = '' v.dc_big_table_locales.each do |l| # iterate each locale if l.locale == locale desc = l.description break end end desc = v.description if desc.blank? # get description from value description desc = v.value if desc.blank? # still blank. Use value as description ret << [desc, v.value] end ret end |
#dc_choices4(model, name, id = '_id', options = {}) ⇒ Object
Returns choices for select input field when choices are generated from all documents in collection.
Parameters:
- model
-
String. Collection (table) name in lowercase format.
- name
-
String. Field name containing description text.
- id
-
String. Field name containing id field. Default is ‘_id’
- options
-
Hash. Various options. Currently site: (:only, :with_nil, :all) is used.
Will return only documents belonging to current site, also with site not defined, or all documents.
Example (as used in forms):
50:
name: dc_poll_id
type: select
eval: dc_choices4('dc_poll','name','_id')
825 826 827 828 829 830 831 832 833 834 835 836 837 838 |
# File 'app/helpers/dc_application_helper.rb', line 825 def dc_choices4(model, name, id='_id', = {}) model = model.classify.constantize qry = model.only(id, name) if (param = [:site]) sites = [dc_get_site.id] unless param == :all sites << nil if param == :with_nil qry = qry.in(dc_site_id: sites) if sites end qry = qry.and(active: true) if model.method_defined?(:active) qry = qry.order_by(name => 1).collation(locale: I18n.locale.to_s) #choices = qry.inject([]) {|result,e| result << [ e[name], e[id] ]} #choices.sort_alphabetical_by(&:first) # use UTF-8 sort qry.map { |e| [e[name], e[id]] } end |
#dc_choices4_all_collections ⇒ Object
Returns list of all collections (tables) as array of choices for usage in select fields. List is collected from cms_menu.yml files and may not include all collections used in application. Currently list is only used for helping defining collection names on dc_permission form.
Example (as used in forms):
form:
fields:
10:
name: table_name
type: text_with_select
eval: dc_choices4_all_collections
720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 |
# File 'app/helpers/dc_application_helper.rb', line 720 def dc_choices4_all_collections choices = {} DrgCms.paths(:forms).reverse.each do |path| filename = "#{path}/cms_menu.yml" next unless File.exist?(filename) = YAML.load_file(filename) rescue nil # load menu next if .nil? or !['menu'] # not menu or error ['menu'].each do |section| next unless section.last['items'] # next if no items section.last['items'].each do |k, v| # look for caption and key = v['table'] choices[key] ||= "#{key} - #{t(v['caption'], v['caption'])}" end end end choices.invert.to_a.sort # hash has to be inverted for values to be returned right end |
#dc_choices4_cmsmenu ⇒ Object
Returns choices for creating collection edit select field on CMS top menu.
759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 |
# File 'app/helpers/dc_application_helper.rb', line 759 def () = {} DrgCms.paths(:forms).reverse.each do |path| filename = "#{path}/cms_menu.yml" next unless File.exist?(filename) = YAML.load_file(filename) rescue nil # load menu next if .nil? or !['menu'] # not menu or error = forms_merge(['menu'], ) # ignore top level part end html = '<ul>' .to_a.sort.each do |index, | # sort menus, result is array of sorted hashes next unless ['caption'] icon = ['icon'].match('/') ? image_tag(['icon']) : fa_icon(['icon']) #external or fa- image html << "<li class=\"cmsedit-top-level-menu\">#{icon}#{t(['caption'])}<ul>" ['items'].to_a.sort.each do |index1, value| # again, sort menu items first html << if value['link'] opts = { target: value['target'] || 'iframe_cms' } "<li>#{dc_link_to(t(value['caption']), value['icon'] || '', value['link'], opts)}</li>" else opts = { controller: value['controller'], action: value['action'], table: value['table'], form_name: value['form_name'] || value['table'], target: value['target'] || 'iframe_cms', } "<li>#{dc_link_to(t(value['caption']), value['icon'] || '', opts)}</li>" end end html << '</ul></li>' end html end |
#dc_choices4_folders_list ⇒ Object
Returns list of directories as array of choices for use in select field on folder permission form. Directory root is determined from dc_site.files_directory field.
798 799 800 801 802 803 804 805 |
# File 'app/helpers/dc_application_helper.rb', line 798 def dc_choices4_folders_list public = File.join(Rails.root,'public') home = File.join(public,dc_get_site.files_directory) choices = Dir.glob(home + '/**/*/').select { |fn| File.directory?(fn) } choices << home # add home choices.collect! {|e| e.gsub(public,'')} # remove public part choices.sort end |
#dc_choices4_menu ⇒ Object
Returns list of choices for selection top level menu on dc_page form. Used for defining which top level menu will be highlited when page is displayed.
Example (as used in forms):
20:
name: menu_id
type: select
eval: dc_choices4_menu
850 851 852 853 854 855 |
# File 'app/helpers/dc_application_helper.rb', line 850 def m_clas = dc_get_site. m_clas = 'DcSimpleMenu' if m_clas.blank? klass = m_clas.classify.constantize klass.(dc_get_site) end |
#dc_choices4_site_policies ⇒ Object
Return array of policies defined in a site document formated to be used as choices for select field. Method is used for selecting site policy where policy for displaying data is required.
Example (as used in forms):
name: policy_id
type: select
eval: dc_choices4_site_policies
html:
include_blank: true
702 703 704 705 |
# File 'app/helpers/dc_application_helper.rb', line 702 def dc_choices4_site_policies site = dc_get_site() site.dc_policies.where(active: true).order_by(name: 1).map { |policy| [ policy.name, policy.id] } end |
#dc_deprecate(msg) ⇒ Object
Writes out deprication msg. It also adds site_name to message, so it is easier to find where the message is comming from.
76 77 78 |
# File 'app/helpers/dc_application_helper.rb', line 76 def dc_deprecate(msg) ActiveSupport::Deprecation.warn("#{dc_get_site.name}: #{msg}") end |
#dc_document_path(document) ⇒ Object
Will return whole path to document if document is embedded in another document.
Parameters:
- document
-
Object: Document object
Returns: String of ID-s separated by semicolon.
1144 1145 1146 1147 1148 1149 1150 1151 |
# File 'app/helpers/dc_application_helper.rb', line 1144 def dc_document_path(document) path, parent = [document.id], document._parent while parent path << parent.id parent = parent._parent end path.reverse.join(';') end |
#dc_dont?(what, default = false) ⇒ Boolean
Returns true if parameter has value of 0, false, no, none or -. Returns default if parameter has nil value.
Parameters:
- what
-
String/boolean/Integer.
- default
-
Default value when what has value of nil. False by default.
Example:
dc_dont?('none') # => true
dc_dont?('-') # => true
dc_dont?(1) # => false
982 983 984 985 986 |
# File 'app/helpers/dc_application_helper.rb', line 982 def dc_dont?(what, default=false) return default if what.nil? %w(0 n - no none false).include?(what.to_s.downcase.strip) end |
#dc_edit_mode? ⇒ Boolean
Checks if CMS is in edit mode (CMS menu bar is visible).
Returns: Boolean. True if in edit mode
493 494 495 |
# File 'app/helpers/dc_application_helper.rb', line 493 def dc_edit_mode? _origin.session[:edit_mode] > 1 end |
#dc_edit_title ⇒ Object
Creates title for cmsedit edit action dialog.
Returns: String. HTML code for title.
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 |
# File 'app/helpers/dc_application_helper.rb', line 282 def dc_edit_title session[:form_processing] = "form:title:" title = @form['form']['title'] # defined as form:title:edit if title and title['edit'] and !@form['readonly'] t( title['edit'], title['edit'] ) elsif title and title['show'] and @form['readonly'] t( title['show'], title['show'] ) else # concatenate title c = (@form['readonly'] ? t('drgcms.show') : t('drgcms.edit')) + " : " c << (@form['title'] ? t( @form['title'], @form['title'] ) : t_tablename(@form['table'])) + ' : ' title = (title and title['field']) ? title['field'] : @form['form']['edit_title'] dc_deprecate('form:edit_title will be deprecated. Use form:title:field instead.') if @form['form']['edit_title'] # c << "#{@record[ title ]} : " if title and @record.respond_to?(title) c << @record.id if @record end c end |
#dc_error_messages_for(doc) ⇒ Object
Returns validation error messages for the document (record) formatted for display on message div.
Parameters:
- doc
-
Document. Document record which will be checked for errors.
Returns: String. HTML code formatted for display.
470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 |
# File 'app/helpers/dc_application_helper.rb', line 470 def (doc) return '' unless doc and doc.errors.any? msgs = '' doc.errors.each do |attribute, errors_array| label = t("helpers.label.#{decamelize_type(doc.class)}.#{attribute}", attribute) msgs << "<li>#{label} : #{errors_array}</li>" end c = <<eot <div class="dc-form-error"> <h2>#{t('drgcms.errors_no')} #{doc.errors.size}</h2> <ul>#{msgs}</ul> </div> eot c.html_safe end |
#dc_flash_messages ⇒ Object
Returns flash messages formatted for display on message div.
Returns: String. HTML code formatted for display.
409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 |
# File 'app/helpers/dc_application_helper.rb', line 409 def () err = _origin.flash[:error] war = _origin.flash[:warning] inf = _origin.flash[:info] note = _origin.flash[:note] html = '' unless err.nil? and war.nil? and inf.nil? and note.nil? html << "<div class=\"dc-form-error\">#{err}</div>" if err html << "<div class=\"dc-form-warning\">#{war}</div>" if war html << "<div class=\"dc-form-info\">#{inf}</div>" if inf html << note if note _origin.flash[:error] = nil _origin.flash[:warning] = nil _origin.flash[:info] = nil _origin.flash[:note] = nil end # Update fields on the form if _origin.flash[:update] html << "<div class=\"dc-form-updates\">\n" _origin.flash[:update].each do |field, value| html << %Q[<div data-field="#{field}" data-value="#{value}"></div>\n] end html << '</div>' _origin.flash[:update] = nil end html.html_safe end |
#dc_get_json_ld ⇒ Object
Will return formated code for embedding json+ld data into page
Returns: HTML data to be embedded into page header
1159 1160 1161 1162 1163 1164 1165 1166 1167 |
# File 'app/helpers/dc_application_helper.rb', line 1159 def dc_get_json_ld() return '' if @json_ld.nil? or @json_ld.size == 0 %Q[ <script type="application/ld+json"> #{JSON.pretty_generate({'@context' => 'http://schema.org', '@graph' => @json_ld})} </script> ].html_safe end |
#dc_get_seo_meta_tags ⇒ Object
Will return meta data for SEO optimizations
Returns: HTML data to be embedded into page header
1190 1191 1192 1193 1194 1195 1196 1197 1198 |
# File 'app/helpers/dc_application_helper.rb', line 1190 def () html = '' html << "<link rel=\"canonical\" href=\"#{@page.canonical_link}\">\n " unless @page&.canonical_link.blank? html << @meta_tags.inject('') do |r, hash| r << "<meta #{hash.first} content=\"#{hash.last}\">\n " end if @meta_tags html.html_safe end |
#dc_get_site ⇒ Object
Parse site name from url and return dc_site document. Site document will be cached in If not in production environment and site document is not found method will search for ‘test’ document and return dc_site document found in alias_for field.
Returns: DCSite. Site document.
673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 |
# File 'app/helpers/dc_application_helper.rb', line 673 def dc_get_site return @site if @site # already cached req = _origin.request.url # different when called from renderer uri = URI.parse(req) @site = DcSite.find_by(name: uri.host) # Site can be aliased @site = DcSite.find_by(name: @site.alias_for) if @site&.alias_for.present? # Development. If site with name test exists use alias_for field as pointer to real site data if @site.nil? && ENV["RAILS_ENV"] != 'production' @site = DcSite.find_by(name: 'test') @site = DcSite.find_by(name: @site.alias_for) if @site end @site = nil if @site && !@site.active # site is disabled @site end |
#dc_icon_for_link(icon) ⇒ Object
Returns icon code if icon is specified
368 369 370 371 372 373 374 375 376 377 |
# File 'app/helpers/dc_application_helper.rb', line 368 def dc_icon_for_link(icon) return nil unless icon if icon.match(/\./) _origin.image_tag(icon, class: 'dc-link-img dc-animate') elsif icon.match('<i') icon else _origin.fa_icon(icon) end end |
#dc_iframe_edit(table, opts = {}) ⇒ Object
Will return html code required for load DRG form into iframe. If parameters are passed to method iframe url will have initial value and thus enabling automatic form load on page display.
Parameters:
- table
-
String: Collection (table) name used to load initial form.
- opts
-
Hash: Optional parameters which define url for loading DRG form.
These parameters are :action, :oper, :table, :form_name, :id, :readonly
Example:
# just iframe code
<%= dc_iframe_edit(nil) %>
# load note form for note collection
<%= dc_iframe_edit('note') %>
# on register collection use reg_adresses form_name to display data with id @register.id
<%= dc_iframe_edit('register', action: :show, form_name: 'reg_adresses', readonly: 1, id: @register.id ) %>
Returns: Html code for edit iframe
1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 |
# File 'app/helpers/dc_application_helper.rb', line 1072 def dc_iframe_edit(table, opts={}) ret = if params.to_unsafe_h.size > 2 and table # controller, action, path is minimal params[:controller] = 'cmsedit' params[:action] = (params[:oper] and (params[:oper] == 'edit')) ? 'edit' : 'index' params[:action] = opts[:action] unless params[:oper] params[:table] ||= table params[:form_name] ||= opts[:form_name] || table params[:id] ||= params[:idp] || opts[:id] params[:readonly] ||= opts[:readonly] params[:path] = nil params.permit! # rails 5 request "<iframe id='iframe_edit' name='iframe_edit' src='#{url_for params}'></iframe>" else "<iframe id='iframe_edit' name='iframe_edit'></iframe>" end ret.html_safe end |
#dc_img_alt(file_name, text = nil) ⇒ Object
Will return alt image option when text is provided. When text is blank it will extract alt name from picture file_name. This method returns just alt name.
Parameters:
- file_name
-
String: Filename of a picture
- text
-
String: Alt text name
Returns:
- String
-
alt_image_name
1243 1244 1245 1246 1247 |
# File 'app/helpers/dc_application_helper.rb', line 1243 def dc_img_alt(file_name, text=nil) return text unless text.blank? name = File.basename(file_name.to_s) name[0,name.index('.')].downcase rescue name end |
#dc_img_alt_tag(file_name, text = nil) ⇒ Object
Will return alt image option when text is provided. When text is blank it will extract alt name from picture file_name. This method returns together with alt=“image-tag” tag.
Parameters:
- file_name
-
String: Filename of a picture
- text
-
String: Alt text name
Returns:
- String
-
alt=“image-tag”
1227 1228 1229 |
# File 'app/helpers/dc_application_helper.rb', line 1227 def dc_img_alt_tag(file_name, text=nil) " alt=\"#{dc_img_alt(file_name, text)}\" ".html_safe end |
#dc_internal_var(object, var_name, current_document = nil) ⇒ Object
Will return value from Rails and DRG internal objects. This objects can be params, session, record, site, page
Parameters:
- object
-
String: Internal object holding variable. Possible values are session, params, record, site, page, class
- var_name
-
String: Variable name (:user_name, ‘user_id’, …)
- current_document
-
Object: If passed and object is ‘record’ then it will be used for retrieving data.
Example:
# called when constructing iframe for display
dc_internal_var('session', :user_id)
dc_internal_var('params', :some_external_parameter)
dc_internal_var('site', :name)
# or even
dc_internal_var('class', 'ClassName.class_method_name')
Returns: Value of variable or error when not found
1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 |
# File 'app/helpers/dc_application_helper.rb', line 1111 def dc_internal_var(object, var_name, current_document = nil) begin case when object == 'session' then _origin.session[var_name] when object == 'params' then _origin.params[var_name] when object == 'site' then _origin.dc_get_site.send(var_name) when object == 'page' then _origin.page.send(var_name) when object == 'record' then current_document ? current_document.send(var_name) : _origin.record.send(var_name) when object == 'class' then clas, method_name = var_name.split('.') klas = clas.classify.constantize # call method. Error will be caught below. klas.send(method_name) else 'VARIABLE: UNKNOWN OBJECT' end rescue Exception => e Rails.logger.debug "\ndc_internal_var. Runtime error. #{e.}\n" Rails.logger.debug(e.backtrace.join($/)) if Rails.env.development? 'VARIABLE: ERROR' end end |
#dc_label_for(input_html, label) ⇒ Object
Formats label and html input code for display on edit form.
Parameters:
[input_html] String. HTML code for data input field.
[label] String. Input field label.
336 337 338 339 340 341 342 343 344 |
# File 'app/helpers/dc_application_helper.rb', line 336 def dc_label_for(input_html, label) c =<<eot <tr> <td class="dc-edit-label">#{label}</td> <td class="dc-edit-field">#{input_html}</td> </tr> eot c.html_safe end |
#dc_limit_string(string, size) ⇒ Object
Truncates string length maximal to the size required and takes care, that words are not broken in middle. Used for output text summary with texts that can be longer then allowed space.
Parameters:
- string
-
String of any size.
- size
-
Maximal size of the string to be returned.
Example:
dc_limit_string(description, 100)
Returns: String, truncated to required size. If string is truncated ‘…’ will be added to the end.
1002 1003 1004 1005 1006 1007 1008 |
# File 'app/helpers/dc_application_helper.rb', line 1002 def dc_limit_string(string, size) return string if string.size < size string = string[0,size] string.chop! until (string[-1,1] == ' ' or string == '') string << '...' end |
#dc_link_for_create(opts) ⇒ Object
Will create HTML code required to create new document.
Parameters:
- opts
-
Hash. Optional parameters for url_for helper. These options must provide at least table and form_name
parameters.
Example:
if @opts[:edit_mode] > 1
opts = {table: 'dc_page;dc_part', form_name: 'dc_part', ids: @doc.id }
html << dc_link_for_create( opts.merge!({title: 'Add new part', 'dc_part.name' => 'initial name', 'dc_part.order' => 10}) )
end
Returns: String. HTML code which includes add image and javascript to invoke new document create action.
513 514 515 516 517 518 519 520 521 522 523 524 |
# File 'app/helpers/dc_application_helper.rb', line 513 def dc_link_for_create(opts) opts.stringify_keys! title = opts.delete('title') # title = t(title, title) if title target = opts.delete('target') || 'iframe_cms' opts['form_name'] ||= opts['table'].to_s.split(';').last opts['action'] = 'new' opts['controller'] ||= 'cmsedit' js = "$('##{target}').attr('src', '#{_origin.url_for(opts)}'); return false;" dc_link_to(nil, _origin.fa_icon('plus-circle lg', class: 'dc-inline-link'), '#', { onclick: js, title: title, alt: 'Create'}).html_safe end |
#dc_link_for_edit(opts) ⇒ Object
Will create HTML code required to edit document.
Parameters:
- opts
-
Hash. Optional parameters for url_for helper. These options must provide
at least table, form_name and id parameters. Optional title, target and icon parameters can be set.
Example:
html << dc_link_for_edit( @options ) if @opts[:edit_mode] > 1
Returns: String. HTML code which includes edit image and javascript to invoke edit document action.
540 541 542 543 544 545 546 547 548 549 550 551 552 |
# File 'app/helpers/dc_application_helper.rb', line 540 def dc_link_for_edit(opts) opts.stringify_keys! title = opts.delete('title') # title = t(title) target = opts.delete('target') || 'iframe_cms' icon = opts.delete('icon') || 'edit lg' opts['controller'] ||= 'cmsedit' opts['action'] ||= 'edit' opts['form_name'] ||= opts['table'].to_s.split(';').last js = "$('##{target}').attr('src', '#{_origin.url_for(opts)}'); return false;" dc_link_to(nil, _origin.fa_icon(icon, class: 'dc-inline-link'), '#', { onclick: js, title: title, alt: 'Edit'}) end |
#dc_link_for_edit1(opts, link_text) ⇒ Object
Create one option in page edit link. Subroutine of dc_page_edit_menu.
574 575 576 577 578 579 |
# File 'app/helpers/dc_application_helper.rb', line 574 def dc_link_for_edit1(opts, link_text) #:nodoc: icon = opts.delete('icon') url = _origin.url_for(opts) "<li><div class='drgcms_popmenu_item' style='cursor: pointer;' data-url='#{url}'> #{_origin.fa_icon(icon)} #{link_text}</div></li>\n" end |
#dc_link_menu_tag(title) {|html| ... } ⇒ Object
Create edit link with edit picture. Subroutine of dc_page_edit_menu.
557 558 559 560 561 562 563 564 565 566 567 568 569 |
# File 'app/helpers/dc_application_helper.rb', line 557 def (title) #:nodoc: html = %Q[ <dl> <dt><div class='drgcms_popmenu' href="#"> #{_origin.fa_icon('file-text-o lg', class: 'dc-inline-link', title: title)} </div></dt> <dd> <ul class=' div-hidden drgcms_popmenu_class'> ] yield html html << "</ul></dd></dl>" end |
#dc_link_to(caption, icon, parms, rest = {}) ⇒ Object
Similar to rails link_to, but also takes care of link icon, translation, …
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 |
# File 'app/helpers/dc_application_helper.rb', line 382 def dc_link_to(, icon, parms, rest={}) icon_pos = 'first' if parms.class == Hash parms.stringify_keys! rest.stringify_keys! rest['class'] = rest['class'].to_s + ' dc-animate' unless rest['class'].to_s.match('dc-animate') rest['target'] ||= parms.delete('target') parms['controller'] ||= 'cmsedit' icon_pos = parms.delete('icon_pos') || 'first' end # icon_image = dc_icon_for_link(icon) if = t(, ) icon_image << ' ' if icon_image end icon_pos == 'first' ? _origin.link_to("#{icon_image}#{}".html_safe, parms, rest) : _origin.link_to("#{} #{icon_image}".html_safe, parms, rest) end |
#dc_menu_class ⇒ Object
Return menu class model defined in site document menu_class field.
Used in forms for providing menus class to the forms object.
Example as used on form:
30:
name: menu_id
type: tree_view
eval: 'dc_menu_class.all_menus_for_site(@parent.dc_get_site)'
659 660 661 |
# File 'app/helpers/dc_application_helper.rb', line 659 def dc_get_site..classify.constantize end |
#dc_new_title ⇒ Object
Creates title for cmsedit new action dialog.
Returns: String. HTML code for title.
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 |
# File 'app/helpers/dc_application_helper.rb', line 309 def dc_new_title() session[:form_processing] = "form:title:" title = @form['form']['title'] # defined as form:title:new if title and title['new'] t( title['new'], title['new'] ) else if @form['table'] == 'dc_dummy' dc_deprecate('dc_dummy will be deprecated. Use dc_memory instead.') @form['table'] = 'dc_memory' end # in memory variables if @form['table'] == 'dc_memory' t( @form['title'], @form['title'] ) else "#{t('drgcms.new')} : #{t_tablename(@form['table'])}" end end end |
#dc_page_bottom ⇒ Object
Helper for adding additional css and javascript code added by documents and renderers during page rendering.
246 247 248 |
# File 'app/helpers/dc_application_helper.rb', line 246 def dc_page_bottom %(<style type="text/css">#{@css}</style>#{javascript_tag @js}).html_safe end |
#dc_page_class ⇒ Object
Return page class model defined in site document page_class field.
Used in forms, when method must be called from page model and model is overwritten by user’s own model.
Example as used on form:
30:
name: link
type: text_with_select
eval: 'dc_page_class.all_pages_for_site(@parent.dc_get_site)'
644 645 646 |
# File 'app/helpers/dc_application_helper.rb', line 644 def dc_page_class dc_get_site.page_klass end |
#dc_page_edit_menu(opts = @opts) ⇒ Object
Create edit menu for editing existing or creating new dc_page documents. Edit menu consists of for options.
-
Edit content. Will edit only body part od document.
-
Edit advanced. Will create edit form for editing all document fields.
-
New page. Will create new document and pass some initial data to it. Initial data is saved to cookie.
-
New part. Will create new part of document.
Parameters:
- opts
-
Hash. Optional parameters for url_for helper. These options must provide at least table and form_name
and id parameters.
Example:
html << () if @opts[:edit_mode] > 1
Returns: String. HTML code required for manipulation of currently processed document.
599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 |
# File 'app/helpers/dc_application_helper.rb', line 599 def (opts = @opts) opts[:edit_mode] ||= _origin.session[:edit_mode] return '' if opts[:edit_mode] < 2 # save some data to cookie. This can not go to session. page = opts[:page] || @page table = _origin.site.page_class.underscore kukis = { "#{table}.dc_design_id" => page.dc_design_id, # "#{table}.menu_id" => page.menu_id, "#{table}.kats" => page.kats, "#{table}.page_id" => page.id, "#{table}.dc_site_id" => _origin.site.id } _origin.[:record] = Marshal.dump(kukis) title = "#{t('drgcms.edit')}: #{page.subject}" opts[:editparams] ||= {} (title) do |html| opts[:editparams].merge!( controller: 'cmsedit', action: 'edit', 'icon' => 'edit' ) opts[:editparams].merge!( :id => page.id, :table => _origin.site.page_class.underscore, form_name: opts[:form_name], edit_only: 'body' ) html << dc_link_for_edit1( opts[:editparams], t('drgcms.edit_content') ) opts[:editparams].merge!( edit_only: nil, 'icon' => 'pencil' ) html << dc_link_for_edit1( opts[:editparams], t('drgcms.edit_advanced') ) opts[:editparams].merge!( action: 'new', 'icon' => 'plus' ) html << dc_link_for_edit1( opts[:editparams], t('drgcms.edit_new_page') ) opts[:editparams].merge!(ids: page.id, form_name: 'dc_part', 'icon' => 'plus-square-o', table: "#{_origin.site.page_class.underscore};dc_part" ) html << dc_link_for_edit1( opts[:editparams], t('drgcms.edit_new_part') ) end.html_safe end |
#dc_page_top ⇒ Object
Helper for rendering top CMS menu when in editing mode
234 235 236 237 238 239 240 |
# File 'app/helpers/dc_application_helper.rb', line 234 def dc_page_top() if @design and !@design.rails_view.blank? # Evaluate parameters in design body eval(@design.body) end session[:edit_mode] > 0 ? render(partial: 'cmsedit/edit_stuff') : '' end |
#dc_render(renderer, opts = {}) ⇒ Object
This is main method used for render parts of design into final HTML document.
Parameters:
- renderer
-
String or Symbol. Class name (in lowercase) that will be used to render final HTML code.
If class name is provided without ‘_renderer’ suffix it will be added automatically.
When renderer has value :part, it is a shortcut for dc_render_design_part method which is used to draw parts of layout on design.
- opts
-
Hash. Additional options that are passed to method. Options are merged with
options set on site, design, page and passed to renderer object.
Example:
<%= dc_render(:dc_page, method: 'view', category: 'news') %>
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 |
# File 'app/helpers/dc_application_helper.rb', line 96 def dc_render(renderer, opts={}) return dc_render_design_part(renderer[:part]) if renderer.class == Hash # opts[:edit_mode] = session[:edit_mode] opts[:editparams] = {} opts = @options.merge(opts) # merge options with parameters passed on site, page, design ... opts.symbolize_keys! # this makes lots of things easier # Create renderer object klass = renderer.to_s.downcase klass += '_renderer' unless klass.match('_renderer') # obj = Kernel.const_get(klass.classify, Class.new).new(self, opts) rescue nil # if obj html = obj.render_html @css << obj.render_css.to_s html.nil? ? '' : html.html_safe # nil can happened else I18n.t 'drgcms.no_class', class: klass end end |
#dc_render_design(part) ⇒ Object
207 208 209 |
# File 'app/helpers/dc_application_helper.rb', line 207 def dc_render_design(part) dc_render_design_part(part) end |
#dc_render_design_part(part) ⇒ Object
Used for designs with lots of common code and one (or more) part which differs. Point is to define design once and replace some parts of design dinamically. Design may be defined in site and design doc defines only parts that vary from page to page.
Example: As used in design.
<%= dc_render_design_part(@main) %>
main variable is defined in design body for example:
@main = Proc.new {render partial: 'parts/home'}
This helper is replacement dc_render_from_site method which will soon be deprecated.
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 |
# File 'app/helpers/dc_application_helper.rb', line 182 def dc_render_design_part(part) case when part.nil? then logger.error('ERROR dc_render_design_part! part is NIL !'); '' # Send as array. Part may be defined with options on page. First element has # name of element which defines what to do. If not defined default behaviour is # called. That is what is defined in second part of array. when part.class == Array then if @options.dig(:settings, part.first) #TODO to be defined else result = part.last.call result.class == Array ? result.first : result end when part.class == Proc then result = part.call result.class == Array ? result.first : result # Send as string. Evaluate content of string when part.class == String then eval part # For future maybe. Just call objects to_s method. else part.to_s end.html_safe end |
#dc_render_from_site(opts = {}) ⇒ Object
Used for designs with lots of common code and one (or more) part which differs. It will simply replace anchor code with value of variable.
Example: As used in design. Backslashing < and % is important <%
<% part = "<div class='some-class'>\<\%= dc_render(:my_renderer, method: 'render_method') \%\></div>" %>
<%= dc_replace_in_design(piece: 'piece_name', replace: '[main]', with: part) %>
Want to replace more than one part. Use array.
<%= dc_replace_in_design(replace: ['[part1]','[part2]'], with: [part1, part2]) %>
This helper is replacement for old ‘script’ method defined in dc_piece_renderer, but it uses design defined in site document if piece parameter is not set.
160 161 162 163 164 165 |
# File 'app/helpers/dc_application_helper.rb', line 160 def dc_render_from_site(opts={}) design = opts[:piece] ? DcPiece.find(name: opts[:piece]).script : dc_get_site.design layout = opts[:layout] || (dc_get_site.site_layout.size > 2 ? dc_get_site.site_layout : nil) render(inline: design, layout: opts[:layout], with: opts[:with]) end |
#dc_render_partial(opts = {}) ⇒ Object
This is main method used for render parts of design into final HTML document.
Parameters:
- renderer
-
String or Symbol. Class name (in lowercase) that will be used to render final HTML code.
If class name is provided without ‘_renderer’ suffix it will be added automatically.
When renderer has value :part, it is a shortcut for dc_render_design_part method which is used to draw parts of layout on design.
- opts
-
Hash. Additional options that are passed to method. Options are merged with
options set on site, design, page and passed to renderer object.
Example:
<%= dc_render(:dc_page, method: 'view', category: 'news') %>
227 228 229 |
# File 'app/helpers/dc_application_helper.rb', line 227 def dc_render_partial(opts={}) _origin.render(partial: opts[:partial], formats: [:html], locals: opts[:locals]) end |
#dc_replace_in_design(opts = {}) ⇒ Object
Used for designs with lots of common code and one (or more) part which differs. It will simply replace anchor code with value of variable.
Example: As used in design. Backslashing < and % is important <%
<% part = "<div class='some-class'>\<\%= dc_render(:my_renderer, method: 'render_method') \%\></div>" %>
<%= dc_replace_in_design(piece: 'piece_name', replace: '[main]', with: part) %>
Want to replace more than one part. Use array.
<%= dc_replace_in_design(replace: ['[part1]','[part2]'], with: [part1, part2]) %>
This helper is replacement for old ‘script’ method defined in dc_piece_renderer, but it uses design defined in site document if piece parameter is not set.
132 133 134 135 136 137 138 139 140 141 142 143 144 |
# File 'app/helpers/dc_application_helper.rb', line 132 def dc_replace_in_design(opts={}) design = opts[:piece] ? DcPiece.find(name: opts[:piece]).script : dc_get_site.design layout = opts[:layout] || (dc_get_site.site_layout.size > 2 ? dc_get_site.site_layout : nil) if opts[:replace] # replace more than one part of code if opts[:replace].class == Array 0.upto(opts[:replace].size - 1) {|i| design.sub!(opts[:replace][i], opts[:with][i])} else design.sub!(opts[:replace], opts[:with]) end end render(inline: design, layout: nil) end |
#dc_submit_tag(caption, icon, parms, rest = {}) ⇒ Object
Similar to rails submit_tag, but also takes care of link icon, translation, …
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 |
# File 'app/helpers/dc_application_helper.rb', line 349 def dc_submit_tag(, icon, parms, rest={}) parms['class'] ||= 'dc-submit' if icon icon_image = if icon.match(/\./) image_tag(icon, class: 'dc-animate') elsif icon.match('<i') icon else fa_icon(icon) end end html = icon_image || '' #html << submit_tag(t(caption, caption), parms) %Q[<button type="submit" class="dc-submit" name="commit" value="#{t(, )}">#{icon_image} #{t(, )}</button>].html_safe end |
#dc_table_title(text, result_set = nil) ⇒ Object
Creates title div for DRG CMS dialogs. Title may also contain pagination section on right side if result_set is provided as parameter.
Parameters:
- text
-
String. Title caption.
- result_set=nil
-
Document collection. If result_set is passed pagination links will be created.
Returns: String. HTML code for title.
261 262 263 264 265 266 267 268 269 270 271 272 273 274 |
# File 'app/helpers/dc_application_helper.rb', line 261 def dc_table_title(text, result_set = nil) c = %(<div class="dc-title">#{text}) # help button type = result_set.nil? ? 'form' : 'index' form_name = params[:form_name] || params[:table] url = url_for(controller: :dc_common, action: :help, type: type, form_name: form_name) c << %(<div class="dc-help dc-link-ajax" data-url=#{url}>#{fa_icon('question-circle')}</div>) if result_set and result_set.respond_to?(:current_page) c << %(<div class="dc-paginate">#{paginate(result_set, :params => {action: 'index', clear: 'no', filter: nil})}</div>) end c << '<div style="clear: both;"></div></div>' c.html_safe end |
#dc_user_can_view(ctrl, policy_id) ⇒ Object
Will check if user roles allow user to view data in document with defined access_policy.
Parameters:
- ctrl
-
Controller object or object which holds methods to access session object. For example @parent
variable when called from renderer.
- policy_id
-
Document or documents policy_id field value required to view data. Method will automatically
check if parameter send has policy_id field defined and use value of that field.
Example:
can_view, = dc_user_can_view(@parent, @page)
# or
can_view, = dc_user_can_view(@parent, @page.policy_id)
return unless can_view
Returns: True if access_policy allows user to view data. False and message from policy that is blocking view if access is not allowed.
896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 |
# File 'app/helpers/dc_application_helper.rb', line 896 def dc_user_can_view(ctrl, policy_id) policy_id = policy_id.policy_id if policy_id and policy_id.respond_to?(:policy_id) # Eventualy object without policy_id will be checked. This is to prevent error policy_id = nil unless policy_id.class == BSON::ObjectId site = ctrl.site policies = if site.inherit_policy.blank? site.dc_policies else Mongoid::QueryCache.cache { DcSite.find(site.inherit_policy) }.dc_policies end # permission defined by default policy default_policy = Mongoid::QueryCache.cache { policies.find_by(is_default: true) } return false, 'Default access policy not found for the site!' unless default_policy = {} default_policy.dc_policy_rules.to_a.each { |v| [v.dc_policy_role_id] = v. } # update permissions with defined policy part_policy = nil if policy_id part_policy = Mongoid::QueryCache.cache { policies.find(policy_id) } return false, 'Access policy not found for part!' unless part_policy part_policy.dc_policy_rules.to_a.each { |v| [v.dc_policy_role_id] = v. } end # apply guest role if no roles defined if ctrl.session[:user_roles].nil? role = Mongoid::QueryCache.cache { DcPolicyRole.find_by(system_name: 'guest', active: true) } return false, 'System guest role not defined!' unless role ctrl.session[:user_roles] = [role.id] end # Check if user has any role that allows him to view part can_view, msg = false,'' ctrl.session[:user_roles].each do |role| next unless [role] # role not yet defined. Will die in next line. if [role] > 0 can_view = true break end end msg = if !can_view part_policy ? t(part_policy.,part_policy.) : t(default_policy.,default_policy.) end return can_view, msg end |
#dc_user_has_role(role, user = nil, roles = nil) ⇒ Object
Check if user has required role assigned to its user profile. If role is passed as string method will check roles for name and system name.
Parameters:
- role
-
DcPolicyRole/String. Required role. If passed as string role will be searched in dc_policy_roles collection.
- user
-
User id. Defaults to session.
- roles
-
Array of roles that will be searched. Default session.
Example:
if dc_user_has_role('decision_maker', session[:user_id), session[:user_roles])
do_something_important
end
Returns: Boolean. True if user has required role.
958 959 960 961 962 963 964 965 966 967 |
# File 'app/helpers/dc_application_helper.rb', line 958 def dc_user_has_role( role, user=nil, roles=nil ) roles = _origin.session[:user_roles] if roles.nil? user = _origin.session[:user_id] if user.nil? return false if user.nil? or roles.nil? role = DcPolicyRole.get_role(role) return false if role.nil? # role is included in roles array roles.include?(role._id) end |
#decamelize_type(string) ⇒ Object
Decamelizes string. This probably doesn’t work very good with non ascii chars. Therefore it is very unwise to use non ascii chars for table (collection) names.
Parameters:
- string
-
String. String to be converted into decamelized string.
Returns: String. Decamelized string.
447 448 449 450 451 452 453 454 455 456 457 458 |
# File 'app/helpers/dc_application_helper.rb', line 447 def decamelize_type(string) return nil if string.nil? r = '' string.to_s.each_char do |c| r << case when r.size == 0 then c.downcase when c.downcase != c then '_' + c.downcase else c end end r end |
#forms_merge(hash1, hash2) ⇒ Object
Merges two forms when current form extends other form. Subroutine of dc_choices4_cmsmenu. With a little help of www.ruby-forum.com/topic/142809
743 744 745 746 747 748 749 750 751 752 753 754 |
# File 'app/helpers/dc_application_helper.rb', line 743 def forms_merge(hash1, hash2) #:nodoc: target = hash1.dup hash2.keys.each do |key| if hash2[key].is_a? Hash and hash1[key].is_a? Hash target[key] = forms_merge(hash1[key], hash2[key]) next end target[key] = hash2[key] == '/' ? nil : hash2[key] end # delete keys with nil value target.delete_if{ |k, v| v.nil? } end |