Contents

#--
# Copyright (c) 2011 Michael Berkovich
#
# 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 Platform::Developer::HelpHelper

  def documentation_field_type_tag(field)
    return field[:type] if simple_field?(field[:type])
    if field[:type] == "Array"
      return "Array of #{field[:array_type].pluralize}".html_safe if simple_field?(field[:array_type])
      return "Array of #{documentation_field_link_tag(field[:array_type].pluralize, field[:array_type])}".html_safe
    end
    documentation_field_link_tag(field[:type], field[:type])
  end
  
  def documentation_field_link_tag(name, type)
    link_to(name, :controller => "/platform/developer/help", :action => :api, :path => type.underscore)
  end
  
private

  def simple_field?(type)
    ["String", "Number", "Boolean", "Array or String", "Hash", "Binary"].include?(type)
  end
  
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
platform-3.1.1	app/helpers/platform/developer/help_helper.rb