drg_cms 0.5.52.12 → 0.5.52.16

data/app/models/drgcms_form_fields/drgcms_field.rb

@@ -0,0 +1,241 @@
+#--
+# 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.
+#++
+
+###########################################################################
+# DrgcmsFormFields module contains definitions of classes used for 
+# rendering data entry fields on DRG CMS forms. 
+# 
+# Every data entry field type written in lowercase in form must have its class 
+# defined in CamelCase in DrgcmsFormFields module. 
+# 
+# Each class must have at least render method implemented. All classes can
+# inherit from DrgcmsField class which acts as abstract template class and implements 
+# most of surrounding code for creating custom DRG CMS form field.
+# 
+# Render method must create html and javascript code which must be
+# saved to internal @html and @js variables. Field code is then retrived by accessing
+# these two internal variables.
+# 
+# Example. How the field code is generated in form renderer:
+#    klas_string = yaml['type'].camelize
+#    if DrgcmsFormFields.const_defined?(klas_string) # check if field type class is defined
+#      klas = DrgcmsFormFields.const_get(klas_string)
+#      field = klas.new(self, @record, options).render
+#      javascript << field.js
+#      html << field.html 
+#    end
+# 
+# Example. How to mix DRG CMS field code in Rails views:
+#    <div>User:
+#    <%= 
+#      opts = {'name' => 'user', 'eval' => "dc_choices4('dc_user','name')", 
+#              'html' => { 'include_blank' => true } }
+#      dt = DrgcmsFormFields::Select.new(self, {}, opts).render
+#      (dt.html + javascript_tag(dt.js)).html_safe
+#     %></div> 
+###########################################################################
+module DrgcmsFormFields
+
+###########################################################################
+# Template method for DRG CMS form field definition. This is abstract class with
+# most of the common code for custom form field already implemented.
+###########################################################################
+class DrgcmsField
+attr_reader :js
+
+####################################################################
+# DrgcmsField initialization code.
+# 
+# Parameters:
+# [parent] Controller object. Controller object from where object is created. Usually self is send. 
+# [record] Document object. Document object which holds fields data.
+# [yaml] Hash. Hash object holding field definition data.
+# 
+# Returns: 
+# Self
+####################################################################
+def initialize( parent, record, yaml )
+  @parent = parent
+  @record = record
+  @yaml   = yaml
+  @form   = parent.form
+  @readonly = (@yaml and @yaml['readonly']) || (@form and @form['readonly'])
+  if @yaml['size'] # move size to html element if not already there
+    @yaml['html'] ||= {}
+    @yaml['html']['size'] ||= @yaml['size']
+  end
+  @html   = ''  
+  @js     = ''
+  @css    = @yaml['css']
+  self
+end
+
+####################################################################
+# Returns html code together with CSS code.
+####################################################################
+def html
+  @html + (@css ? "\n<style type=\"text/css\">#{@css}</style>" : '')
+end
+
+####################################################################
+# Wrapper for i18 t method, with some spice added. If translation is not found English
+# translation value will be returned. And if still not found default value will be returned if passed.
+# 
+# Parameters:
+# [key] String. String to be translated into locale.
+# [default] String. Value returned if translation is not found.
+# 
+# Example:
+#    t('translate.this','Enter text for ....')
+# 
+# Returns: 
+# String. Translated text. 
+####################################################################
+def t(key, default='')
+  c = I18n.t(key)
+  if c.match( 'translation missing' )
+    c = I18n.t(key, locale: 'en') 
+# Still not found. Return default if set
+    c = default unless default.blank?
+  end
+  c
+end
+
+####################################################################
+# Standard code for returning readonly field.
+####################################################################
+def ro_standard(value=nil)
+  value = @record[@yaml['name']] if value.nil? and @record.respond_to?(@yaml['name']) 
+  @html << (value.blank? ? '' : "<div class='dc-readonly'>#{value}</div>")
+  self
+end
+
+####################################################################
+# Set initial value of the field when initial value is set in url parameters..
+# 
+# Example: Form has field named picture. Field can be initialized by 
+# setting value of param p_picture.
+#    params['p_picture'] = '/path/to_picture'
+#    
+# When multiple initial values are assigned it is more convinient to assign them 
+# through flash object.
+#    flash[:record] = {}
+#    flash[:record]['picture'] = '/path/to_picture'
+####################################################################
+def set_initial_value(opt1='html', opt2='value')
+  @yaml['html'] ||= {}
+  value_send_as = 'p_' + @yaml['name']
+  if @parent.params[value_send_as]
+    @yaml[opt1][opt2] = @parent.params[value_send_as] 
+  elsif @parent.flash[:record] and @parent.flash[:record][@yaml['name']]
+    @yaml[opt1][opt2] = @parent.flash[:record][@yaml['name']]
+  end
+end
+
+####################################################################
+# Returns style html code for DRGForm object if style directive is present in field definition.
+# Otherwiese returns empty string.
+# 
+# Style may be defined like:
+#    style:
+#      height: 400px
+#      width: 800px
+#      padding: 10px 20px
+#     
+#    or 
+#     
+#    style: "height:400px; width:800px; padding: 10px 20px;"
+#    
+#  Style directive may also be defined under html directive.
+#    html:
+#      style:
+#        height: 400px
+#        width: 800px
+#    
+# 
+####################################################################
+def set_style()
+  style = @yaml['html']['style'] || @yaml['style']
+  case
+    when style.nil? then ''
+    when style.class == String then "style=\"#{style}\""
+    when style.class == Hash then
+      value = style.to_a.inject([]) {|r,v| r << "#{v[0]}: #{v[1]}" }.join(';')
+      "style=\"#{value}\"" 
+    else ''
+  end 
+end
+
+####################################################################
+# Will return ruby hash formated as javascript string which can be used
+# for passing parameters in javascript code.
+# 
+# Parameters:
+# [Hash] Hash. Ruby hash parameters.
+# 
+# Form example: As used in forms
+#    options:
+#      height: 400
+#      width: 800
+#      toolbar: "'basic'"
+#      
+#  => "height:400, width:800, toolbar:'basic'"
+# 
+# Return: 
+# String: Options formated as javascript options.
+#      
+####################################################################
+def hash_to_options(hash)
+  hash.to_a.inject([]) {|r,v| r << "#{v[0]}: #{v[1]}" }.join(',')
+end
+
+####################################################################
+# Checks if field name exists in document and alters record parameters if necesary.
+# Method was added after fields that do not belong to current edited document
+# were added to forms. Valid nonexisting form field names must start with underscore (_) letter.
+# 
+# Return: 
+# String: 'record' or '_record' when valid nonexisting field is used
+####################################################################
+def record_text_for(name)
+  (!@record.respond_to?(name) and name[0,1] == '_') ? '_record' : 'record'
+end
+
+
+###########################################################################
+# Default get_data method for retrieving data from parameters. Class method is called 
+# for every entry field defined on form before field value is saved to database.
+# 
+# Parameters:
+# [params] Controllers params object.
+# [name] Field name
+# 
+# Most of classes will use this default method which returns params['record'][name]. 
+# When field data is more complex class should implement its own get_data method. 
+###########################################################################
+def self.get_data(params, name)
+  params['record'][name]
+end
+
+end
+end

data/app/models/drgcms_form_fields/drgcms_form_fields.rb

@@ -0,0 +1,25 @@
+#--
+# 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
+end

data/app/models/drgcms_form_fields/embedded.rb

@@ -0,0 +1,84 @@
+#--
+# 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 embedded DRG CMS form field.
+#
+# Creates html required to paint embedded object on form.
+# 
+# ===Form options:
+# * +name:+ field name (required)
+# * +type:+ embedded (required)
+# * +form_name:+ name of form which will be used for editing
+# * +html:+ html options (optional)
+#   * +height:+ height of embedded object in pixels (1000)
+#   * +width:+ width of embedded object in pixels (500)
+# 
+# Form example:
+#    10:
+#      name: dc_parts
+#      type: embedded
+#      form_name: dc_part
+#      html:
+#        height: 1000
+###########################################################################
+class Embedded < DrgcmsField
+###########################################################################
+# Render embedded field html code
+###########################################################################
+def render 
+  #return self if @record.new_record?  # would be in error otherwise
+# HTML defaults. Some must be set    
+  @yaml['html'] ||= {}
+  @yaml['html']['height'] ||= 300
+  @yaml['html']['width']  ||= '99%'
+# defaults both way 
+  @yaml['table']     ||= @yaml['form_name'] if @yaml['form_name']
+  @yaml['form_name'] ||= @yaml['table'] if @yaml['table']
+# 
+  html = ''  
+  @yaml['html'].each {|k,v| html << "#{k}=\"#{v}\" "}
+# 
+  if @yaml['name'] == @yaml['table']
+    tables = @yaml['table']
+    ids = @record._id
+  else
+    tables      = @parent.tables.inject('') { |r,v| r << "#{v[1]};" } + @yaml['table']
+    ids         = @parent.ids.inject('') { |r,v| r << "#{v};" } + @record._id
+  end
+  opts = { controller: 'cmsedit', action: 'index', ids: ids, table: tables, form_name: @yaml['form_name'], 
+           field_name: @yaml['name'], iframe: "if_#{@yaml['name']}", readonly: @readonly }
+  @html << "<iframe class='iframe_embedded' id='if_#{@yaml['name']}' name='if_#{@yaml['name']}' #{html}></iframe>"
+  unless @record.new_record?
+    @js << %Q[
+$(document).ready( function() {
+  $('#if_#{@yaml['name']}').attr('src', '#{@parent.url_for(opts)}');
+});]
+  end
+  self
+end
+
+end
+
+end

data/app/models/drgcms_form_fields/file_select.rb

@@ -0,0 +1,70 @@
+#--
+# 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 file_select DRG CMS form field.
+# 
+# FileSelect like HtmlField implements redirection for calling document manager edit field code.
+# This can be drg_default_html_editor's elfinder or any other code defined
+# by dc_site.settings file_select setting.
+# 
+# Example of dc_site.setting used for drg_default_html_editor gem.
+#    html_editor: ckeditor
+#    ck_editor:
+#      config_file: /files/ck_config.js  
+#      css_file: /files/ck_css.css
+#   file_select: elfinder
+#   
+# Form example:
+#    60:
+#      name: picture
+#      type: file_select
+#      html:
+#        size: 50   
+###########################################################################
+class FileSelect < DrgcmsField
+
+###########################################################################
+# Render file_select field html code
+###########################################################################
+def render
+  return ro_standard if @readonly  
+# retrieve html editor from page settings
+  selector_string = @parent.dc_get_site.params['file_select'] if @parent.dc_get_site 
+  selector_string ||= 'elfinder' 
+# 
+  klas_string = selector_string.camelize
+  if DrgcmsFormFields.const_defined?(klas_string)
+    klas = DrgcmsFormFields::const_get(klas_string)
+    o = klas.new(@parent, @record, @yaml).render
+    @js << o.js
+    @html << o.html 
+  else
+    @html << "File select component not defined. Check site.settings or include drgcms_default_html_editor gem."
+  end
+  self
+end
+
+end
+end

data/app/models/drgcms_form_fields/hidden_field.rb

@@ -0,0 +1,52 @@
+#--
+# 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 hidden DRG CMS form field.
+# 
+# Will create hidden_field on form.
+# 
+# ===Form options:
+# * +name:+ field name
+# * +type:+ hidden_field
+# 
+# Form example:
+#    10:
+#      name: im_hidden
+#      type: hidden_field
+###########################################################################
+class HiddenField < DrgcmsField
+###########################################################################
+# Render hidden_field field html code
+###########################################################################
+def render 
+  set_initial_value
+  value = @yaml['html']['value'] ? @yaml['html']['value'] : @record[@yaml['name']]
+  record = record_text_for(@yaml['name'])  
+  @parent.hidden_field(record, @yaml['name'], value: value)
+end
+end
+
+
+end