Module: ActiveSupport::CoreExtensions::Hash::Conversions

Included in:
Hash
Defined in:
lib/active_support/core_ext/hash/conversions.rb

Defined Under Namespace

Modules: ClassMethods

Constant Summary collapse

XML_TYPE_NAMES = 
{
  "Symbol"     => "symbol",
  "Fixnum"     => "integer",
  "Bignum"     => "integer",
  "BigDecimal" => "decimal",
  "Float"      => "float",
  "Date"       => "date",
  "DateTime"   => "datetime",
  "Time"       => "datetime",
  "TrueClass"  => "boolean",
  "FalseClass" => "boolean"
}
XML_FORMATTING = 
{
  "symbol"   => Proc.new { |symbol| symbol.to_s },
  "date"     => Proc.new { |date| date.to_s(:db) },
  "datetime" => Proc.new { |time| time.xmlschema },
  "binary"   => Proc.new { |binary| ActiveSupport::Base64.encode64(binary) },
  "yaml"     => Proc.new { |yaml| yaml.to_yaml }
}
XML_PARSING = 
{
  "symbol"       => Proc.new  { |symbol|  symbol.to_sym },
  "date"         => Proc.new  { |date|    ::Date.parse(date) },
  "datetime"     => Proc.new  { |time|    ::Time.parse(time).utc },
  "integer"      => Proc.new  { |integer| integer.to_i },
  "float"        => Proc.new  { |float|   float.to_f },
  "decimal"      => Proc.new  { |number|  BigDecimal(number) },
  "boolean"      => Proc.new  { |boolean| %w(1 true).include?(boolean.strip) },
  "string"       => Proc.new  { |string|  string.to_s },
  "yaml"         => Proc.new  { |yaml|    YAML::load(yaml) rescue yaml },
  "base64Binary" => Proc.new  { |bin|     Base64.decode64(bin) },
  # FIXME: Get rid of eval and institute a proper decorator here
  "file"         => Proc.new do |file, entity|
    f = StringIO.new(Base64.decode64(file))
    eval "def f.original_filename() '#{entity["name"]}' || 'untitled' end"
    eval "def f.content_type()      '#{entity["content_type"]}' || 'application/octet-stream' end"
    f
  end
}

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(klass) ⇒ Object 



81
82
83
 
# File 'lib/active_support/core_ext/hash/conversions.rb', line 81

def self.included(klass)
  klass.extend(ClassMethods)
end

Instance Method Details

#to_query(namespace = nil) ⇒ Object

Converts a hash into a string suitable for use as a URL query string. An optional namespace can be passed to enclose the param names (see example below).

Example:

{ :name => 'David', :nationality => 'Danish' }.to_query # => "name=David&nationality=Danish"

{ :name => 'David', :nationality => 'Danish' }.to_query('user') # => "user%5Bname%5D=David&user%5Bnationality%5D=Danish"



92
93
94
95
96
 
# File 'lib/active_support/core_ext/hash/conversions.rb', line 92

def to_query(namespace = nil)
  collect do |key, value|
    value.to_query(namespace ? "#{namespace}[#{key}]" : key)
  end.sort * '&'
end

#to_xml(options = {}) ⇒ Object 



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/active_support/core_ext/hash/conversions.rb', line 98

def to_xml(options = {})
  options[:indent] ||= 2
  options.reverse_merge!({ :builder => Builder::XmlMarkup.new(:indent => options[:indent]),
                           :root => "hash" })
  options[:builder].instruct! unless options.delete(:skip_instruct)
  dasherize = !options.has_key?(:dasherize) || options[:dasherize]
  root = dasherize ? options[:root].to_s.dasherize : options[:root].to_s

  options[:builder].__send__(:method_missing, root) do
    each do |key, value|
      case value
        when ::Hash
          value.to_xml(options.merge({ :root => key, :skip_instruct => true }))
        when ::Array
          value.to_xml(options.merge({ :root => key, :children => key.to_s.singularize, :skip_instruct => true}))
        when ::Method, ::Proc
          # If the Method or Proc takes two arguments, then
          # pass the suggested child element name.  This is
          # used if the Method or Proc will be operating over
          # multiple records and needs to create an containing
          # element that will contain the objects being
          # serialized.
          if 1 == value.arity
            value.call(options.merge({ :root => key, :skip_instruct => true }))
          else
            value.call(options.merge({ :root => key, :skip_instruct => true }), key.to_s.singularize)
          end
        else
          if value.respond_to?(:to_xml)
            value.to_xml(options.merge({ :root => key, :skip_instruct => true }))
          else
            type_name = XML_TYPE_NAMES[value.class.name]

            key = dasherize ? key.to_s.dasherize : key.to_s

            attributes = options[:skip_types] || value.nil? || type_name.nil? ? { } : { :type => type_name }
            if value.nil?
              attributes[:nil] = true
            end

            options[:builder].tag!(key,
              XML_FORMATTING[type_name] ? XML_FORMATTING[type_name].call(value) : value,
              attributes
            )
        end
      end
    end
    
    yield options[:builder] if block_given?
  end

end