ultimate-base 0.3.1.1 → 0.3.2

data/app/assets/javascripts/ultimate/helpers/form_options.js.coffee

@@ -0,0 +1,65 @@
+#= require ./base
+#= require ./tag
+
+@Ultimate.Helpers.FormOptions =
+
+  options_for_select: (container, selected = null) ->
+    return container  if _.isString(container)
+    [selected, disabled] = _.map @_extract_selected_and_disabled(selected), (r) ->
+      _.map _.outcasts.arrayWrap(r), (item) -> item.toString()
+    container = _.pairs(container)  if $.isPlainObject(container)
+    _.map(container, (element) ->
+      html_attributes = @_option_html_attributes(element)
+      [text, value] = _.map @_option_text_and_value(element), (item) -> if item? then item.toString() else ''
+      html_attributes['value'] = value
+      html_attributes['selected'] = 'selected'  if @_option_value_selected(value, selected)
+      html_attributes['disabled'] = 'disabled'  if disabled and @_option_value_selected(value, disabled)
+      Ultimate.Helpers.Tag.content_tag_string 'option', text, html_attributes
+    ).join("\n")
+
+  options_from_collection_for_select: (collection, value_method, text_method, selected = null) ->
+    options = _.map collection, (element) ->
+      [@_value_for_collection(element, text_method), @_value_for_collection(element, value_method)]
+    [selected, disabled] = @_extract_selected_and_disabled(selected)
+    select_deselect =
+      selected: @_extract_values_from_collection(collection, value_method, selected)
+      disabled: @_extract_values_from_collection(collection, value_method, disabled)
+    @options_for_select(options, select_deselect)
+
+
+
+  _option_html_attributes: (element) ->
+    result = {}
+    if _.isArray(element)
+      _.extend(result, e)  for e in element  when $.isPlainObject(e)
+    result
+
+  _option_text_and_value: (option) ->
+    # Options are [text, value] pairs or strings used for both.
+    if _.isArray(option)
+      option = _.reject(option, (e) -> $.isPlainObject(e))
+      [_.first(option), _.last(option)]
+    else
+      [option, option]
+
+  _option_value_selected: (value, selected) ->
+    value in selected
+
+  _extract_selected_and_disabled: (selected) ->
+    if _.isFunction(selected)
+      [selected, null]
+    else
+      selected = _.outcasts.arrayWrap(selected)
+      options = if $.isPlainObject(_.last(selected)) then selected.pop() else {}
+      selected_items = options['selected'] ? selected
+      [selected_items, options['disabled']]
+
+  _extract_values_from_collection: (collection, value_method, selected) ->
+    if _.isFunction(selected)
+      _.compact _.map collection, (element) ->
+        _.result(element, value_method)  if selected(element)
+    else
+      selected
+
+  _value_for_collection: (item, value) ->
+    if _.isFunction(value) then value(item) else _.result(item, value)

data/app/assets/javascripts/ultimate/helpers/form_tag.js.coffee

@@ -0,0 +1,177 @@
+#= require ./base
+#= require ./tag
+#= require ./url
+#= require ./asset_tag
+
+@Ultimate.Helpers.FormTag =
+
+  embed_authenticity_token_in_remote_forms: false
+
+  form_tag: (url_for_options = {}, options = {}, block = null) ->
+    html_options = @_html_options_for_form(url_for_options, options)
+    if block = _.outcasts.blockGiven(arguments)
+      @_form_tag_in_block(html_options, block)
+    else
+      @_form_tag_html(html_options)
+
+  select_tag: (name, option_tags = '', options = {}) ->
+    html_name = if options.multiple is true and not _.string.endsWith(name, '[]') then "#{name}[]" else name
+    if _.outcasts.delete(options, 'include_blank')
+      option_tags = Ultimate.Helpers.Tag.content_tag('option', '', value: '') + option_tags
+    if prompt = _.outcasts.delete(options, 'prompt')
+      option_tags = Ultimate.Helpers.Tag.content_tag('option', prompt, value: '') + option_tags
+    Ultimate.Helpers.Tag.content_tag 'select', option_tags, _.extend({name: html_name, id: @_sanitize_to_id(name)}, options), false
+
+  text_field_tag: (name, value = null, options = {}) ->
+    Ultimate.Helpers.Tag.tag 'input', _.extend({type: 'text', name: name, id: @_sanitize_to_id(name), value: value}, options)
+
+  label_tag: (name = null, content_or_options = null, options = null, block = null) ->
+    if (block = _.outcasts.blockGiven(arguments)) and $.isPlainObject(content_or_options)
+      options = content_or_options
+    else
+      options ||= {}
+    if _.isString(name) and not _.string.isBlank(name)
+      unless _.has(options, 'for')
+        options = _.clone(options)
+        options['for'] = @_sanitize_to_id(name)
+      content_or_options ||= _.string.humanize(name)
+    content_or_options = options  if block
+    Ultimate.Helpers.Tag.content_tag 'label', content_or_options, options, block
+
+  hidden_field_tag: (name, value = null, options = {}) ->
+    @text_field_tag name, value, _.extend(options, type: 'hidden')
+
+  file_field_tag: (name, options = {}) ->
+    @text_field_tag name, null, _.extend(options, type: 'file')
+
+  password_field_tag: (name = 'password', value = null, options = {}) ->
+    @text_field_tag name, value, _.extend(options, type: 'password')
+
+  text_area_tag: (name, content = null, options = {}) ->
+    if size = _.outcasts.delete(options, 'size')
+      [options['cols'], options['rows']] = size.split("x")  if _.isFunction(size.split)
+    escape = _.outcasts.delete(options, 'escape') ? true
+    Ultimate.Helpers.Tag.content_tag 'textarea', content, _.extend({name: name, id: @_sanitize_to_id(name)}, options), escape
+
+  check_box_tag: (name, value = '1', checked = false, options = {}) ->
+    html_options = _.extend({type: 'checkbox', name: name, id: @_sanitize_to_id(name), value: value}, options)
+    html_options['checked'] = 'checked'  if checked
+    Ultimate.Helpers.Tag.tag 'input', html_options
+
+  radio_button_tag: (name, value, checked = false, options = {}) ->
+    html_options = _.extend({type: 'radio', name: name, id: "#{@_sanitize_to_id(name)}_#{@_sanitize_to_id(value)}", value: value}, options)
+    html_options['checked'] = 'checked'  if checked
+    Ultimate.Helpers.Tag.tag 'input', html_options
+
+  submit_tag: (value = 'Save changes', options = {}) ->
+    Ultimate.Helpers.Tag.tag 'input', _.extend({type: 'submit', name: 'commit', value: value}, options)
+
+  button_tag: (content_or_options = null, options = null, block = null) ->
+    options = content_or_options  if (block = _.outcasts.blockGiven(arguments)) and $.isPlainObject(content_or_options)
+    options ||= {}
+    options = _.extend({name: 'button', type: 'submit'}, options)
+    content_or_options = options  if block
+    Ultimate.Helpers.Tag.content_tag 'button', content_or_options ? 'Button', options, not block, block
+
+  image_submit_tag: (source, options = {}) ->
+    Ultimate.Helpers.Tag.tag 'input', _.extend({type: 'image', src: Ultimate.Helpers.AssetTag.path_to_image(source)}, options)
+
+  field_set_tag: (legend = null, options = null, block) ->
+    output = Ultimate.Helpers.Tag.tag('fieldset', options, true)
+    output += Ultimate.Helpers.Tag.content_tag('legend', legend)  if _.isString(legend) and not _.string.isBlank(legend)
+    output += block()  if block = _.outcasts.blockGiven(arguments)
+    output += '</fieldset>'
+    output
+
+  color_field_tag: (name, value = null, options = {}) ->
+    @text_field_tag name, value, _.extend(options, type: 'color')
+
+  search_field_tag: (name, value = null, options = {}) ->
+    @text_field_tag name, value, _.extend(options, type: 'search')
+
+  telephone_field_tag: (name, value = null, options = {}) ->
+    @text_field_tag name, value, _.extend(options, type: 'tel')
+  
+  phone_field_tag: ->
+    @telephone_field_tag arguments...
+
+  date_field_tag: (name, value = null, options = {}) ->
+    @text_field_tag name, value, _.extend(options, type: 'date')
+
+  time_field_tag: (name, value = null, options = {}) ->
+    @text_field_tag name, value, _.extend(options, type: 'time')
+
+  datetime_field_tag: (name, value = null, options = {}) ->
+    @text_field_tag name, value, _.extend(options, type: 'datetime')
+
+  datetime_local_field_tag: (name, value = null, options = {}) ->
+    @text_field_tag name, value, _.extend(options, type: 'datetime-local')
+
+  month_field_tag: (name, value = null, options = {}) ->
+    @text_field_tag name, value, _.extend(options, type: 'month')
+
+  week_field_tag: (name, value = null, options = {}) ->
+    @text_field_tag name, value, _.extend(options, type: 'week')
+
+  url_field_tag: (name, value = null, options = {}) ->
+    @text_field_tag name, value, _.extend(options, type: 'url')
+
+  email_field_tag: (name, value = null, options = {}) ->
+    @text_field_tag name, value, _.extend(options, type: 'email')
+
+  number_field_tag: (name, value = null, options = {}) ->
+    options['type'] ||= 'number'
+    if range = _.outcasts.delete(options, 'in') or _.outcasts.delete(options, 'within')
+      _.extend options, min: range.min, max: range.max
+    @text_field_tag name, value, options
+
+  range_field_tag: (name, value = null, options = {}) ->
+    @number_field_tag name, value, _.extend(options, type: 'range')
+
+  utf8_enforcer_tag: ->
+    Ultimate.Helpers.Tag.tag 'input', type: 'hidden', name: 'utf8', value: '&#x2713;', false, false
+
+  _html_options_for_form: (url_for_options, options) ->
+    html_options = options
+    html_options['enctype'] = 'multipart/form-data'  if _.outcasts.delete(html_options, 'multipart')
+    # The following URL is unescaped, this is just a hash of options, and it is the
+    # responsibility of the caller to escape all the values.
+    html_options['action'] = Ultimate.Helpers.Url.url_for(url_for_options)
+    html_options['accept-charset'] = 'UTF-8'
+    html_options['data-remote'] = true  if _.outcasts.delete(html_options, 'remote')
+    if html_options['data-remote'] and
+        not @embed_authenticity_token_in_remote_forms and
+        _.string.isBlank(html_options['authenticity_token'])
+      # The authenticity token is taken from the meta tag in this case
+      html_options['authenticity_token'] = false
+    else if html_options['authenticity_token'] is true
+      # Include the default authenticity_token, which is only generated when its set to nil,
+      # but we needed the true value to override the default of no authenticity_token on data-remote.
+      html_options['authenticity_token'] = null
+    html_options
+
+  _extra_tags_for_form: (html_options) ->
+    authenticity_token = _.outcasts.delete(html_options, 'authenticity_token')
+    method = _.outcasts.delete(html_options, 'method')
+    method_tag =
+      if /^get$/i.test(method) # must be case-insensitive, but can't use downcase as might be nil
+        html_options['method'] = 'get'
+        ''
+      else if _.string.isBlank(method) or /^post$/i.test(method)
+        html_options['method'] = 'post'
+        Ultimate.Helpers.Url._token_tag(authenticity_token)
+      else
+        html_options['method'] = 'post'
+        Ultimate.Helpers.Url._method_tag(method) + Ultimate.Helpers.Url._token_tag(authenticity_token)
+    tags = @utf8_enforcer_tag() + method_tag
+    Ultimate.Helpers.Tag.content_tag('div', tags, style: 'margin:0;padding:0;display:inline', false)
+
+  _form_tag_html: (html_options) ->
+    extra_tags = @_extra_tags_for_form(html_options)
+    Ultimate.Helpers.Tag.tag('form', html_options, true) + extra_tags
+
+  _form_tag_in_block: (html_options, block) ->
+    "#{@_form_tag_html(html_options)}#{block()}</form>"
+
+  _sanitize_to_id: (name) ->
+    if name? then name.toString().replace(/\]/g, '').replace(/[^-a-zA-Z0-9:.]/g, '_') else ''

data/app/assets/javascripts/ultimate/helpers/javascript.js.coffee

@@ -0,0 +1,31 @@
+#= require ./base
+#= require ./tag
+
+JS_ESCAPE_MAP =
+  '\\'    : '\\\\'
+  '</'    : '<\\/'
+  "\r\n"  : '\\n'
+  "\n"    : '\\n'
+  "\r"    : '\\n'
+  '"'     : '\\"'
+  "'"     : "\\'"
+
+@Ultimate.Helpers.Javascript =
+
+  escape_javascript: (javascript) ->
+    return ''  unless _.isString(javascript)
+    javascript.replace( /(\\|<\/|\r\n|[\n\r"'])/g, (match) -> JS_ESCAPE_MAP[match] )
+
+  j: -> @escape_javascript arguments...
+
+  javascript_tag: (content_or_options_with_block = null, html_options = {}, block = null) ->
+    content =
+      if block = _.outcasts.blockGiven(arguments)
+        html_options = content_or_options_with_block if  $.isPlainObject(content_or_options_with_block)
+        block()
+      else
+        content_or_options_with_block
+    Ultimate.Helpers.Tag.content_tag 'script', @javascript_cdata_section(content), html_options, false
+
+  javascript_cdata_section: (content) ->
+    "\n//#{Ultimate.Helpers.Tag.cdata_section("\n#{content}\n//")}\n"

data/app/assets/javascripts/ultimate/helpers/record_tag.js.coffee

@@ -21,11 +21,21 @@
     options = if  _.isObject(options) then _.clone(options) else {}
     _.extend options, {class: Ultimate.Helpers.Tag.concat_class(@dom_class(record, prefix), options['class']), id: @dom_id(record, prefix)}
     if block
-      Ultimate.Helpers.Tag.content_tag(tag_name, block(record), options)
+      Ultimate.Helpers.Tag.content_tag(tag_name, block(record), options, false)
     else
-      Ultimate.Helpers.Tag.content_tag(tag_name, block, options)
+      Ultimate.Helpers.Tag.content_tag(tag_name, block, options, false)
 
-  # ============= from ActionController::RecordIdentifier ===============
+
+
+  # from ActionView::ModelNaming
+  model_name_from_record_or_class: (record_or_class) ->
+    modelClass = record_or_class.constructor ? record_or_class
+    if modelClass?
+      modelClass.modelName or modelClass.className or modelClass.name or 'Model'
+    else
+      'Model'
+
+  # ============= from ActionView::RecordIdentifier ===============
 
   # The DOM class convention is to use the singular form of an object or class. Examples:
   #
@@ -34,15 +44,16 @@
   #
   # If you need to address multiple instances of the same class in the same view, you can prefix the dom_class:
   #
-  #   dom_class(post, :edit)   # => "edit_post"
-  #   dom_class(Person, :edit) # => "edit_person"
+  #   dom_class(post, 'edit')   # => "edit_post"
+  #   dom_class(Person, 'edit') # => "edit_person"
   dom_class: (record_or_class, prefix = "") ->
-    # TODO improve as in Ultimate.Backbone.Model
-    if _.isString(record_or_class)
-      singular = _.singularize(record_or_class)
-    else unless singular = _.result(record_or_class, 'singular')
-      if _.isString(record_or_class?.constructor?.name)
-        singular = _.singularize(_.string.underscored(record_or_class.constructor.name))
+    singular =
+      _.result(record_or_class, 'singular') ?
+      _.singularize _.string.underscored(
+        if _.isString(record_or_class)
+          record_or_class
+        else
+          @model_name_from_record_or_class(record_or_class) )
     if prefix then "#{prefix}_#{singular}" else singular
 
   # The DOM id convention is to use the singular form of an object or class with the id following an underscore.
@@ -56,11 +67,14 @@
   #   dom_id(Post.find(45), "edit") # => "edit_post_45"
   # TODO sync with rorId and ror_id
   dom_id: (record, prefix = "") ->
-    if record_id = @sanitize_dom_id(record.id)
+    if record_id = @_record_key_for_dom_id(record)
       "#{@dom_class(record, prefix)}_#{record_id}"
     else
       @dom_class(record, prefix or "new")
 
-  # Replaces characters that are invalid in HTML DOM ids with valid ones.
-  sanitize_dom_id: (candidate_id) ->
-    candidate_id # TODO implement conversion to valid DOM id values
+
+
+  # protected
+
+  _record_key_for_dom_id: (record) ->
+    record.id

data/app/assets/javascripts/ultimate/helpers/tag.js.coffee

@@ -11,7 +11,7 @@
     textarea: "\n"
 
   tag: (tag_name, options = {}, open = false, escape = true) ->
-    "<#{tag_name}#{@tag_options(options)}#{if open then '>' else ' />'}"
+    "<#{tag_name}#{@tag_options(options, escape)}#{if open then '>' else ' />'}"
 
   content_tag: (name, content_or_options_with_block = null, options = null, escape = true, block = null) ->
     if block = _.outcasts.blockGiven(arguments)
@@ -20,13 +20,17 @@
     else
       @content_tag_string(name, content_or_options_with_block, options, escape)
 
+  cdata_section: (content) ->
+    splitted = content.replace(/\]\]>/g, ']]]]><![CDATA[>')
+    "<![CDATA[#{splitted}]]>"
+
   content_tag_string: (name, content = '', options = {}, escape = true) ->
-    content = _.escape(content)  if escape
+    content = _.string.escapeHTML(content)  if escape
     "<#{name}#{@tag_options(options, escape)}>#{@PRE_CONTENT_STRINGS[name] ? ''}#{content}</#{name}>"
 
   html_options_to_s: (html_options, escape = false, prefix = "") ->
     deprecate 'html_options_to_s()', "tag_options()"
-    @tag_options.apply(@, arguments)
+    @tag_options arguments...
 
   tag_options: (options, escape = true) ->
     return ""  if _.isEmpty(options)

data/app/assets/javascripts/ultimate/helpers/url.js.coffee

@@ -1,17 +1,22 @@
 #= require ./base
 #= require ./tag
+#= require ./javascript
+
+__char_encode = (char) -> "%#{char.charCodeAt(0).toString(16)}"
+escape_path = (str) -> str.replace(/[^*\-.0-9A-Z_a-z]/g, __char_encode).replace(/\+/g, '%20')
+__string_encode = (str) -> _.map(str, (char) -> "&##{char.charCodeAt(0)};" ).join('')
 
 @Ultimate.Helpers.Url =
 
   url_for: (options = null) ->
     if _.isString(options)
-      if options is "back"
+      if options is 'back'
         'javascript:history.back();'
       else
         options
     else unless _.isEmpty(options)
       url = _.result(options, 'url') ? ''
-      if _.isObject(options)
+      if $.isPlainObject(options)
         options = _.clone(options)
         delete options['url']
         anchor = _.outcasts.delete(options, 'anchor')
@@ -26,8 +31,41 @@
     options ||= {}
     url = @url_for(options)
     html_options = @_convert_options_to_data_attributes(options, html_options)
-    html_options["href"] ||= url
-    Ultimate.Helpers.Tag.content_tag("a", name or url, html_options, false, block)
+    html_options['href'] ||= url
+    if block
+      Ultimate.Helpers.Tag.content_tag('a', html_options, null, false, block)
+    else
+      Ultimate.Helpers.Tag.content_tag('a', name or url, html_options, false)
+
+  link_to_js: (name = null, html_options = null, block = null) ->
+    [options, name] = [name, null]  if block = _.outcasts.blockGiven(arguments)
+    @link_to [name, options, html_options, block]...
+
+
+
+  mail_to: (email_address, name = null, html_options = {}) ->
+    email_address = _.string.escapeHTML(email_address)
+    encode = _.outcasts.delete(html_options, 'encode')
+    extras = _.compact _.map _.string.words('cc bcc body subject'), (item) ->
+      option = _.outcasts.delete(html_options, item)
+      if option?
+        "#{item}=#{escape_path(option)}"
+    extras = if _.isEmpty(extras) then '' else '?' + _.string.escapeHTML(extras.join('&'))
+    email_address_obfuscated = email_address
+    email_address_obfuscated = email_address_obfuscated.replace('@', _.outcasts.delete(html_options, 'replace_at'))   if 'replace_at' of html_options
+    email_address_obfuscated = email_address_obfuscated.replace('.', _.outcasts.delete(html_options, 'replace_dot'))  if 'replace_dot' of html_options
+    switch encode
+      when 'javascript'
+        html   = @link_to(name or email_address_obfuscated, "mailto:#{email_address}#{extras}", html_options)
+        html   = Ultimate.Helpers.Javascript.escape_javascript(html)
+        string = _.map("document.write('#{html}');", __char_encode).join('')
+        "<script>eval(decodeURIComponent('#{string}'))</script>"
+      when 'hex'
+        email_address_encoded = __string_encode(email_address_obfuscated)
+        string = __string_encode('mailto:') + _.map(email_address, (char) -> if /\w/.test(char) then __char_encode(char) else char).join('')
+        @link_to name or email_address_encoded, "#{string}#{extras}", html_options
+      else
+        @link_to name or email_address_obfuscated, "mailto:#{email_address}#{extras}", html_options
 
 
 
@@ -44,6 +82,23 @@
     _.isObject(options) and _.outcasts.delete(options, 'remote')
 
   _add_method_to_attributes: (html_options, method) ->
-    if _.isString(method) and method.toLowerCase() isnt "get" and not /nofollow/.test(html_options["rel"])
-      html_options["rel"] = _.string.lstrip("#{html_options["rel"]} nofollow")
-    html_options["data-method"] = method
+    if _.isString(method) and method.toLowerCase() isnt 'get' and not /nofollow/.test(html_options['rel'])
+      html_options['rel'] = _.string.lstrip("#{html_options['rel']} nofollow")
+    html_options['data-method'] = method
+
+  _convert_boolean_attributes: (html_options, bool_attrs) ->
+    html_options[x] = x  for x in bool_attrs  when _.outcasts.delete(html_options, x)
+    html_options
+
+  __protect_against_forgery: false
+  __form_authenticity_token: 'secret'
+  __request_forgery_protection_token: 'form_token'
+
+  _token_tag: (token = @__form_authenticity_token) ->
+    if token isnt false and @__protect_against_forgery
+      Ultimate.Helpers.Tag.tag 'input', type: 'hidden', name: @__request_forgery_protection_token, value: token
+    else
+      ''
+
+  _method_tag: (method) ->
+    Ultimate.Helpers.Tag.tag 'input', type: 'hidden', name: '_method', value: method