require 'active_support/xml_mini' require 'active_support/core_ext/hash/keys' require 'active_support/core_ext/string/inflections' require 'active_support/core_ext/object/to_param' require 'active_support/core_ext/object/to_query' class Array # Converts the array to a comma-separated sentence where the last element is # joined by the connector word. # # You can pass the following options to change the default behavior. If you # pass an option key that doesn't exist in the list below, it will raise an # ArgumentError. # # ==== Options # # * :words_connector - The sign or word used to join the elements # in arrays with two or more elements (default: ", "). # * :two_words_connector - The sign or word used to join the elements # in arrays with two elements (default: " and "). # * :last_word_connector - The sign or word used to join the last element # in arrays with three or more elements (default: ", and "). # * :locale - If +i18n+ is available, you can set a locale and use # the connector options defined on the 'support.array' namespace in the # corresponding dictionary file. # # ==== Examples # # [].to_sentence # => "" # ['one'].to_sentence # => "one" # ['one', 'two'].to_sentence # => "one and two" # ['one', 'two', 'three'].to_sentence # => "one, two, and three" # # ['one', 'two'].to_sentence(passing: 'invalid option') # # => ArgumentError: Unknown key :passing # # ['one', 'two'].to_sentence(two_words_connector: '-') # # => "one-two" # # ['one', 'two', 'three'].to_sentence(words_connector: ' or ', last_word_connector: ' or at least ') # # => "one or two or at least three" # # Using :locale option: # # # Given this locale dictionary: # # # # es: # # support: # # array: # # words_connector: " o " # # two_words_connector: " y " # # last_word_connector: " o al menos " # # ['uno', 'dos'].to_sentence(locale: :es) # # => "uno y dos" # # ['uno', 'dos', 'tres'].to_sentence(locale: :es) # # => "uno o dos o al menos tres" def to_sentence(options = {}) options.assert_valid_keys(:words_connector, :two_words_connector, :last_word_connector, :locale) default_connectors = { :words_connector => ', ', :two_words_connector => ' and ', :last_word_connector => ', and ' } if defined?(I18n) i18n_connectors = I18n.translate(:'support.array', locale: options[:locale], default: {}) default_connectors.merge!(i18n_connectors) end options = default_connectors.merge!(options) case length when 0 '' when 1 self[0].to_s.dup when 2 "#{self[0]}#{options[:two_words_connector]}#{self[1]}" else "#{self[0...-1].join(options[:words_connector])}#{options[:last_word_connector]}#{self[-1]}" end end # Extends Array#to_s to convert a collection of elements into a # comma separated id list if :db argument is given as the format. # # Blog.all.to_formatted_s(:db) # => "1,2,3" def to_formatted_s(format = :default) case format when :db if empty? 'null' else collect { |element| element.id }.join(',') end else to_default_s end end alias_method :to_default_s, :to_s alias_method :to_s, :to_formatted_s # Returns a string that represents the array in XML by invoking +to_xml+ # on each element. Active Record collections delegate their representation # in XML to this method. # # All elements are expected to respond to +to_xml+, if any of them does # not then an exception is raised. # # The root node reflects the class name of the first element in plural # if all elements belong to the same type and that's not Hash: # # customer.projects.to_xml # # # # # 20000.0 # 1567 # 2008-04-09 # ... # # # 57230.0 # 1567 # 2008-04-15 # ... # # # # Otherwise the root element is "objects": # # [{ foo: 1, bar: 2}, { baz: 3}].to_xml # # # # # 2 # 1 # # # 3 # # # # If the collection is empty the root element is "nil-classes" by default: # # [].to_xml # # # # # To ensure a meaningful root element use the :root option: # # customer_with_no_projects.projects.to_xml(root: 'projects') # # # # # By default name of the node for the children of root is root.singularize. # You can change it with the :children option. # # The +options+ hash is passed downwards: # # Message.all.to_xml(skip_types: true) # # # # # 2008-03-07T09:58:18+01:00 # 1 # 1 # 2008-03-07T09:58:18+01:00 # 1 # # # def to_xml(options = {}) require 'active_support/builder' unless defined?(Builder) options = options.dup options[:indent] ||= 2 options[:builder] ||= Builder::XmlMarkup.new(indent: options[:indent]) options[:root] ||= \ if first.class != Hash && all? { |e| e.is_a?(first.class) } underscored = ActiveSupport::Inflector.underscore(first.class.name) ActiveSupport::Inflector.pluralize(underscored).tr('/', '_') else 'objects' end builder = options[:builder] builder.instruct! unless options.delete(:skip_instruct) root = ActiveSupport::XmlMini.rename_key(options[:root].to_s, options) children = options.delete(:children) || root.singularize attributes = options[:skip_types] ? {} : { type: 'array' } if empty? builder.tag!(root, attributes) else builder.tag!(root, attributes) do each { |value| ActiveSupport::XmlMini.to_tag(children, value, options) } yield builder if block_given? end end end end