aboutsummaryrefslogblamecommitdiffstats
path: root/activesupport/lib/active_support/core_ext/range/conversions.rb
blob: 83eced50bf5eaaa66d8ba5052ca84f78e36ccc2d (plain) (tree)
1
2
3
4
5
6
7



                                                                                            
 
                                                                                  
   















                                                                                                           




                                        

       


                                     
   
class Range
  RANGE_FORMATS = {
    :db => Proc.new { |start, stop| "BETWEEN '#{start.to_s(:db)}' AND '#{stop.to_s(:db)}'" }
  }

  # Convert range to a formatted string. See RANGE_FORMATS for predefined formats.
  #
  # This method is aliased to <tt>to_s</tt>.
  #
  #   range = (1..100)           # => 1..100
  #
  #   range.to_formatted_s       # => "1..100"
  #   range.to_s                 # => "1..100"
  #
  #   range.to_formatted_s(:db)  # => "BETWEEN '1' AND '100'"
  #   range.to_s(:db)            # => "BETWEEN '1' AND '100'"
  #
  # == Adding your own range formats to to_formatted_s
  # You can add your own formats to the Range::RANGE_FORMATS hash.
  # Use the format name as the hash key and a Proc instance.
  #
  #   # config/initializers/range_formats.rb
  #   Range::RANGE_FORMATS[:short] = ->(start, stop) { "Between #{start.to_s(:db)} and #{stop.to_s(:db)}" }
  def to_formatted_s(format = :default)
    if formatter = RANGE_FORMATS[format]
      formatter.call(first, last)
    else
      to_default_s
    end
  end

  alias_method :to_default_s, :to_s
  alias_method :to_s, :to_formatted_s
end