drg_cms 0.5.52.12 → 0.6.0.8

data/app/models/drgcms_form_fields/readonly.rb

@@ -0,0 +1,79 @@
+#--
+# Copyright (c) 2012+ 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.
+#++
+module DrgcmsFormFields
+  
+###########################################################################
+# Implementation of readonly DRG CMS form field. 
+# 
+# Readonly field value is just painted on form.
+# 
+# ===Form options:
+# * +name:+ field name
+# * +type:+ readonly
+# * +eval:+ value will be provided by evaluating expression. Usually dc_name4_id helper
+# can be used to get value. Example: dc_name4_id,model_name_in_lower_case,field_name 
+# 
+# * +readonly:+ yes (can be applied to any field type)
+# 
+# Form example:
+#    10:
+#      name: user
+#      type: readonly
+#      html:
+#        size: 50
+#    20:
+#      name: created_by
+#      type: readonly
+#      eval: dc_name4_id,dc_user,name
+###########################################################################
+class Readonly < DrgcmsField
+  
+###########################################################################
+# Render readonly field html code
+###########################################################################
+def render 
+  @html << @parent.hidden_field('record', @yaml['name']) # retain field as hidden field
+  @html << '<div class="dc-readonly">'
+  
+  @html << if @yaml['eval']
+    if @yaml['eval'].match('dc_name4_id')
+      a = @yaml['eval'].split(',')
+      if a.size == 3
+        @parent.dc_name4_id(a[1], a[2], nil, @record[ @yaml['name'] ])
+      else
+        @parent.dc_name4_id(a[1], a[2], a[3], @record[ @yaml['name'] ])
+      end
+      
+#      @parent.dc_name4_id(a[1], a[2], @record[ @yaml['name'] ])
+    else
+      eval( "#{@yaml['eval']} '#{@record.send(@yaml['name'])}'") 
+    end
+  else
+    @parent.dc_format_value(@record.send(@yaml['name']),@yaml['format'])    
+  end  
+  @html << '</div>'
+  self
+end
+end
+
+end

data/app/models/drgcms_form_fields/select.rb

@@ -0,0 +1,226 @@
+#--
+# Copyright (c) 2012+ 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.
+#++
+module DrgcmsFormFields
+
+###########################################################################
+# Implementation of select DRG CMS form field.
+# 
+# ===Form options:
+# * +name:+ field name (required)
+# * +type:+ select (required)
+# * +choices:+ Values for choices separated by comma. Values can also be specified like description:value.
+# In the example description will be shown to user, but value will be saved to document.
+#    choices: 'OK:0,Ready:1,Error:2'
+#    choices: Ruby,Pyton,PHP
+# * +eval:+ Choices will be provided by evaluating expression
+#   * eval: dc_choices4('model_name','description_field_name','_id'); dc_choices4 helper will provide data for select field. 
+#   * eval: ModelName.choices4_field; ModelName class will define method choices4_field which 
+#   will provide data for select field.
+#   * collection_name.search_field_name.method_name; When searching is more complex custom search
+#   method may be defined in CollectionName model which will provide result set for search.
+# * If choices or eval is not defined choices will be provided from translation helpers. For example: 
+#   Collection has field status choices for field may be provided by en.helpers.model_name.choices4_status 
+#   entry of english translation. English is of course default translation. If you provide translations in
+#   your local language then select choices will be localized.
+#    en.helpers.model_name.choices4_status: 'OK:0,Ready:1,Error:2'
+#    sl.helpers.model_name.choices4_status: 'V redu:0,Pripravljen:1,Napaka:2'
+# * +depend:+ Select options may depend on a value in some other field. If depend option is specified
+#   then chices must be provided by class method and defined in eval option.
+# * +html:+ html options which apply to select field (optional)
+#      
+# Form example:
+#    30:
+#      name: type
+#      type: select
+#    40:
+#      name: parent
+#      type: select
+#      eval: DcCategory.values_for_parent
+#      html:
+#        include_blank: true      
+#    50:
+#      name: company
+#      type: select
+#      choices: Audi,BMW,Mercedes
+#        or
+#      choices: helpers.label.model.choices4_field
+#    60:
+#      name: type
+#      type: select
+#      eval: Cars.choices4_type
+#      depend: company
+###########################################################################
+class Select < DrgcmsField
+  
+###########################################################################
+# Choices are defined in helper as:
+# helper.label.table_name.choices_for_fieldname or
+# choices4_tablename_fieldname
+###########################################################################
+def choices_in_helper(helper = nil)
+  helper ||= "helpers.label.#{@form['table']}.choices4_#{@yaml['name']}"
+  c = t(helper)
+  if c.match( 'translation missing' )
+    helper = "choices_for_#{@form['table']}_#{@yaml['name']}"
+    return "Error. #{helper} not defined" if c.match( 'translation missing' )
+  end
+  c
+end
+
+###########################################################################
+# Choices are defined by evaluating an expression. This is most common class
+# method defined in a class. eg. SomeClass.get_choices4
+###########################################################################
+def choices_in_eval(e)
+  e.strip!
+  if @yaml['depend'].nil?
+    method = e.split(/\ |\(/).first
+    return eval(e) if respond_to?(method) # id method defined here
+    return eval('@parent.'+e) if @parent.respond_to?(method) # is method defined in helpers
+    # eval whatever it is there
+    eval e
+  else
+    # add event listener to depend field
+    @js << %(
+$(document).ready(function() {
+  $('#record_#{@yaml['depend']}').change( function(e) { update_select_depend('record_#{@yaml['name']}', 'record_#{@yaml['depend']}','#{e}');});
+  $('#_record_#{@yaml['depend']}').change( function(e) { update_select_depend('record_#{@yaml['name']}', '_record_#{@yaml['depend']}','#{e}');});
+});
+)
+    # depend field might be virtual field. It's value should be set in params
+    depend_value = @yaml['depend'][0] == '_' ? @parent.params["p_#{@yaml['depend']}"] : @record[@yaml['depend']]
+
+    e << " '#{depend_value}'"
+    eval e
+  end
+end
+
+###########################################################################
+# Create choices array for select field.
+###########################################################################
+def get_choices
+  begin
+    choices = case 
+              when @yaml['choices'] then
+                @yaml['choices'].match('helpers.') ? choices_in_helper(@yaml['choices']) : @yaml['choices']
+              when @yaml['eval'] then
+                choices_in_eval(@yaml['eval'])
+              else
+                choices_in_helper()
+              end
+  # Convert string to Array
+    choices.class == String ?
+      choices.chomp.split(',').inject([]) { |r,v| r << (v.match(':') ? v.split(':') : v ) } :
+      choices
+  rescue Exception => e 
+    Rails.logger.debug "Error in select eval. #{e.message}\n"
+    ['error'] # return empty array when error occures
+  end
+end
+
+###########################################################################
+# Will add code to view more data about selected option in a window
+###########################################################################
+def add_view_code
+  return '' if (data = @record.send(@yaml['name'])).blank?
+  ar = @yaml['view'].split(/\ |\,/).delete_if {|e| e.blank?}
+  table, form_name = *ar
+  url  = @parent.url_for(controller: :cmsedit, id: data, action: :edit, table: table, form_name: form_name, readonly: true, window_close: 1 )
+  icon = @parent.fa_icon('eye')
+  %(<span class="dc-window-open" data-url="#{url}">#{icon}</span>)
+end
+
+###########################################################################
+# Return value when readonly is required
+###########################################################################
+def ro_standard
+  value = @record.respond_to?(@yaml['name']) ? @record.send(@yaml['name']) : nil
+  return self if value.blank?
+
+  choices = get_choices()
+  if value.class == Array   # multiple choices
+    html = ''
+    value.each do |element|
+      choices.each do |choice|
+        if choice.to_s == element.to_s
+          html << '<br>' if html.size > 0
+          html << "#{element.to_s}"
+        end
+      end       
+    end
+    return super(html)
+  else
+    choices.each do |choice|
+      if choice.class == Array
+        return super(choice.first) if choice.last.to_s == value.to_s
+      else
+        return super(choice) if choice.to_s == value.to_s
+      end 
+    end
+  end
+  super('')
+end
+
+###########################################################################
+# Render select field html code
+###########################################################################
+def render
+  return ro_standard if @readonly
+  set_initial_value('html','selected')
+  # separate options and html part
+  @yaml['html'].symbolize_keys!
+  html_part = {}
+  html_part[:class] = @yaml['html'].delete(:class)  if @yaml['html'][:class]
+  html_part[:id]    = @yaml['html'].delete(:id)     if @yaml['html'][:id]
+  html_part[:style] = @yaml['html'].delete(:style)  if @yaml['html'][:style]
+  record = record_text_for(@yaml['name'])
+  if @yaml['multiple']
+    html_part[:multiple] = true
+    @html << @parent.select(record, @yaml['name'], get_choices, @yaml['html'], html_part)
+    @js   << "$('##{record}_#{@yaml['name']}').selectMultiple();"
+  else
+    @html << @parent.select(record, @yaml['name'], get_choices, @yaml['html'], html_part)
+    # add code for view more data
+    @html << add_view_code() if @yaml['view']
+  end
+  self
+end
+
+###########################################################################
+# Return value. 
+###########################################################################
+def self.get_data(params, name)
+  if params['record'][name].class == Array
+    params['record'][name].delete_if {|e| e.blank? }
+    return nil if params['record'][name].size == 0
+
+    # convert to BSON objects
+    is_id = BSON::ObjectId.legal?(params['record'][name].first)
+    return params['record'][name].map{ |e| BSON::ObjectId.from_string(e) } if is_id
+    return params['record'][name]
+  end
+  params['record'][name]
+end
+
+end
+end

data/app/models/drgcms_form_fields/submit_tag.rb

@@ -0,0 +1,58 @@
+#--
+# Copyright (c) 2012+ 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.
+#++
+module DrgcmsFormFields
+
+###########################################################################
+# Create submit_tag form field. submit_tag form field is mostly used by polls but can
+# be also incorporated in the middle of form.
+# 
+# ===Form options:
+# * +type:+ submit_tag (required)
+# * +caption:+ Submit field caption 
+# * +icon:+ Icon
+# * +html:+ html options which apply to link_to (optional)
+#      
+# Form example:
+#    40:
+#      type: submit_tag
+#      caption: translate.this
+#      icon: check
+###########################################################################
+class SubmitTag < DrgcmsField
+  
+###########################################################################
+# Render submit_tag field html code
+###########################################################################
+def render
+  @yaml['html'] ||= {}
+  @yaml['html']['class'] ||= 'dc-submit'
+  @yaml['html'].symbolize_keys!
+  text = @yaml['caption'] || @yaml['text']
+  text = t(@yaml['text']) if text.match(/\./)
+  
+  @html << @parent.submit_tag(text, @yaml['html'])
+  self
+end
+end
+
+end

data/app/models/drgcms_form_fields/text_area.rb

@@ -0,0 +1,68 @@
+#--
+# Copyright (c) 2012+ 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.
+#++
+module DrgcmsFormFields
+
+###########################################################################
+# Implementation of text_area DRG CMS form field.
+# 
+# ===Form options:
+# * +type:+ text_area (required)
+# * +name:+ Field name (required) 
+# * +html:+ html options which apply to text_area field (optional)
+# 
+# Form example:
+#    10:
+#      name: css
+#      type: text_area
+#      html:
+#        size: 100x30
+###########################################################################
+class TextArea < DrgcmsField
+
+###########################################################################
+# Return value for readonly field
+###########################################################################
+def ro_standard
+  value = @record[@yaml['name']]
+  @html << "<div class='dc-readonly'>#{value.gsub("\n",'<br>')}</div>" unless value.blank?
+  self
+end
+
+###########################################################################
+# Render text_area field html code
+###########################################################################
+def render
+  #return ro_standard if @readonly
+  set_initial_value
+#
+#  @yaml['html'] ||= {}
+#  value_send_as = 'p_' + @yaml['name']
+#  @yaml['html']['value'] = @parent.params[value_send_as] if @parent.params[value_send_as]
+
+  record = record_text_for(@yaml['name'])
+  @html << @parent.text_area(record, @yaml['name'], @yaml['html'])
+  self
+end
+
+end
+end

data/app/models/drgcms_form_fields/text_autocomplete.rb

@@ -0,0 +1,155 @@
+#--
+# Copyright (c) 2012+ 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.
+#++
+module DrgcmsFormFields
+
+###########################################################################
+# Implementation of text_autocomplete DRG CMS form field.
+# 
+# ===Form options:
+# * +name:+ field name (required)
+# * +type:+ text_autocomplete (required)
+# * +table+ Collection (table) name. When defined search must contain field name
+# * +with_new+ Will add an icon for shortcut to add new document to collection
+# * +is_id+ Field value represent value as id. If false, field will use entered value and not value selected with autocomplete. Default is true.
+# * +search:+ Search may consist of three parameters from which are separated either by dot (.) 
+#   * search_field_name; when table option is defined search must define field name which will be used for search query
+#   * collection_name.search_field_name; Same as above except that table options must be ommited.
+#   * collection_name.search_field_name.method_name; When searching is more complex custom search
+#   method may be defined in CollectionName model which will provide result set for search.
+# 
+# Form example:
+#    10:
+#      name: user_id
+#      type: text_autocomplete
+#      search: dc_user.name
+#      is_id: false
+#      html:
+#        size: 30
+###########################################################################
+class TextAutocomplete < DrgcmsField
+ 
+###########################################################################
+# Render text_autocomplete field html code
+###########################################################################
+def render
+  # Return descriptive text and put it into input field
+  # search field name
+  if @yaml['search'].class == Hash
+    table    = @yaml['search']['table']
+    ret_name = @yaml['search']['field']
+    method   = @yaml['search']['method']
+  elsif @yaml['search'].match(/\./)
+    table, ret_name, method = @yaml['search'].split('.') 
+  else
+    ret_name = @yaml['search']
+  end
+  # determine table name
+  if @yaml['table']
+    table = if @yaml['table'].class == String
+      @yaml['table']
+    elsif @yaml['table']['eval']
+      eval @yaml['table']['eval']
+    else
+      Rails.logger.error "Field #{ @yaml['name'] }: Invalid table parameter!"
+      nil
+    end
+  end
+  return 'Table or field keyword not defined!' unless (table and ret_name)
+  # TODO check if table exists
+  t = table.classify.constantize
+  # find record and return value of field
+  value_send_as = 'p_' + @yaml['name']
+  value = if @parent.params[value_send_as]
+    @parent.params[value_send_as]
+  elsif @record and @record[@yaml['name']]
+    @record[@yaml['name']]
+  end
+  # Found value to be written in field. If field is not found write out value.
+  if value
+    record = t.find(value) unless @yaml['not_id'] # don't if it's is not an id
+    value_displayed = record ? record.send(ret_name) : value
+  end
+  # return if readonly
+  return ro_standard(value_displayed) if @readonly
+  # Add method back, so autocomplete will know that it must search for method inside class
+  ret_name = "#{ret_name}.#{method}" if method
+  @yaml['html'] ||= {}
+  @yaml['html']['value'] = value_displayed
+  @yaml['html']['placeholder'] ||= t('drgcms.search_placeholder') || nil
+  #
+  _name = '_' + @yaml['name']
+  record = record_text_for(@yaml['name'])  
+  @html << '<span class="dc-text-autocomplete">' + @parent.text_field(record, _name, @yaml['html']) + '<span></span>'
+  if @yaml['with_new']
+    @html << ' ' + 
+             @parent.fa_icon('plus-square lg', class: 'in-edit-add', title: t('drgcms.new'), 
+             style: "vertical-align: top;", 'data-table' => @yaml['with_new'] )    
+  end
+  @html << '</span>' + @parent.hidden_field(record, @yaml['name'], value: value)        # actual value will be in hidden field
+  # JS stuff
+  # allow unselected values on is_id: false option
+  not_id = @parent.dc_dont?(@yaml['is_id'], false)
+  not_id_code = %(
+if (ui.item == null) {  
+$("##{record}_#{@yaml['name']}").val($("##{record}__#{@yaml['name']}").val() );
+return;
+} ) if not_id
+  #
+  @js << <<EOJS
+$(document).ready(function() {
+  $("##{record}_#{_name}").autocomplete( {
+    source: function(request, response) {
+      $.ajax({
+        url: '/dc_common/autocomplete',
+        type: "POST",
+        dataType: "json",
+        data: { input: request.term, table: "#{table}", search: "#{ret_name}" #{(',id: "'+@yaml['id'] + '"') if @yaml['id']} },
+        success: function(data) {
+          response( $.map( data, function(key) {
+            return key;
+          }));
+        }
+      });
+    },
+    change: function (event, ui) { 
+      #{not_id_code}
+      $("##{record}_#{@yaml['name']}").val(ui.item.id);
+      
+    },
+    minLength: 2
+  });
+});
+EOJS
+    
+  self 
+end
+
+###########################################################################
+# Return value. Return nil if input field is empty
+###########################################################################
+def self.get_data(params, name)
+  params['record']["_#{name}"].blank? ? nil : params['record'][name]
+end
+
+end
+end