Class | String |
In: |
lib/sequel/extensions/string_date_time.rb
lib/sequel/extensions/inflector.rb lib/sequel/extensions/blank.rb lib/sequel/core_sql.rb |
Parent: | Object |
Yield the Inflections module if a block is given, and return the Inflections module.
# File lib/sequel/extensions/inflector.rb, line 137 137: def self.inflections 138: yield Inflections if block_given? 139: Inflections 140: end
Strings are blank if they are empty or include only whitespace
# File lib/sequel/extensions/blank.rb, line 32 32: def blank? 33: strip.empty? 34: end
By default, camelize converts the string to UpperCamelCase. If the argument to camelize is set to :lower then camelize produces lowerCamelCase.
camelize will also convert ’/’ to ’::’ which is useful for converting paths to namespaces
Examples
"active_record".camelize #=> "ActiveRecord" "active_record".camelize(:lower) #=> "activeRecord" "active_record/errors".camelize #=> "ActiveRecord::Errors" "active_record/errors".camelize(:lower) #=> "activeRecord::Errors"
# File lib/sequel/extensions/inflector.rb, line 152 152: def camelize(first_letter_in_uppercase = :upper) 153: s = gsub(/\/(.?)/){|x| "::#{x[-1..-1].upcase unless x == '/'}"}.gsub(/(^|_)(.)/){|x| x[-1..-1].upcase} 154: s[0...1] = s[0...1].downcase unless first_letter_in_uppercase == :upper 155: s 156: end
Singularizes and camelizes the string. Also strips out all characters preceding and including a period (".").
Examples
"egg_and_hams".classify #=> "EggAndHam" "post".classify #=> "Post" "schema.post".classify #=> "Post"
# File lib/sequel/extensions/inflector.rb, line 166 166: def classify 167: sub(/.*\./, '').singularize.camelize 168: end
Constantize tries to find a declared constant with the name specified in the string. It raises a NameError when the name is not in CamelCase or is not initialized.
Examples
"Module".constantize #=> Module "Class".constantize #=> Class
# File lib/sequel/extensions/inflector.rb, line 177 177: def constantize 178: raise(NameError, "#{inspect} is not a valid constant name!") unless m = /\A(?:::)?([A-Z]\w*(?:::[A-Z]\w*)*)\z/.match(self) 179: Object.module_eval("::#{m[1]}", __FILE__, __LINE__) 180: end
Replaces underscores with dashes in the string.
Example
"puni_puni".dasherize #=> "puni-puni"
# File lib/sequel/extensions/inflector.rb, line 186 186: def dasherize 187: gsub(/_/, '-') 188: end
Removes the module part from the expression in the string
Examples
"ActiveRecord::CoreExtensions::String::Inflections".demodulize #=> "Inflections" "Inflections".demodulize #=> "Inflections"
# File lib/sequel/extensions/inflector.rb, line 195 195: def demodulize 196: gsub(/^.*::/, '') 197: end
Creates a foreign key name from a class name. use_underscore sets whether the method should put ‘_’ between the name and ‘id’.
Examples
"Message".foreign_key #=> "message_id" "Message".foreign_key(false) #=> "messageid" "Admin::Post".foreign_key #=> "post_id"
# File lib/sequel/extensions/inflector.rb, line 206 206: def foreign_key(use_underscore = true) 207: "#{demodulize.underscore}#{'_' if use_underscore}id" 208: end
Capitalizes the first word and turns underscores into spaces and strips _id. Like titleize, this is meant for creating pretty output.
Examples
"employee_salary" #=> "Employee salary" "author_id" #=> "Author"
# File lib/sequel/extensions/inflector.rb, line 216 216: def humanize 217: gsub(/_id$/, "").gsub(/_/, " ").capitalize 218: end
Converts a string into a Sequel::LiteralString, in order to override string literalization, e.g.:
DB[:items].filter(:abc => 'def').sql #=> "SELECT * FROM items WHERE (abc = 'def')" DB[:items].filter(:abc => 'def'.lit).sql #=> "SELECT * FROM items WHERE (abc = def)"
You can also provide arguments, to create a Sequel::SQL::PlaceholderLiteralString:
DB[:items].select{|o| o.count('DISTINCT ?'.lit(:a))}.sql #=> "SELECT count(DISTINCT a) FROM items"
# File lib/sequel/core_sql.rb, line 192 192: def lit(*args) 193: args.empty? ? Sequel::LiteralString.new(self) : Sequel::SQL::PlaceholderLiteralString.new(self, args) 194: end
Returns the plural form of the word in the string.
Examples
"post".pluralize #=> "posts" "octopus".pluralize #=> "octopi" "sheep".pluralize #=> "sheep" "words".pluralize #=> "words" "the blue mailman".pluralize #=> "the blue mailmen" "CamelOctopus".pluralize #=> "CamelOctopi"
# File lib/sequel/extensions/inflector.rb, line 229 229: def pluralize 230: result = dup 231: Inflections.plurals.each{|(rule, replacement)| break if result.gsub!(rule, replacement)} unless Inflections.uncountables.include?(downcase) 232: result 233: end
The reverse of pluralize, returns the singular form of a word in a string.
Examples
"posts".singularize #=> "post" "octopi".singularize #=> "octopus" "sheep".singluarize #=> "sheep" "word".singluarize #=> "word" "the blue mailmen".singularize #=> "the blue mailman" "CamelOctopi".singularize #=> "CamelOctopus"
# File lib/sequel/extensions/inflector.rb, line 244 244: def singularize 245: result = dup 246: Inflections.singulars.each{|(rule, replacement)| break if result.gsub!(rule, replacement)} unless Inflections.uncountables.include?(downcase) 247: result 248: end
Underscores and pluralizes the string.
Examples
"RawScaledScorer".tableize #=> "raw_scaled_scorers" "egg_and_ham".tableize #=> "egg_and_hams" "fancyCategory".tableize #=> "fancy_categories"
# File lib/sequel/extensions/inflector.rb, line 256 256: def tableize 257: underscore.pluralize 258: end
Capitalizes all the words and replaces some characters in the string to create a nicer looking title. Titleize is meant for creating pretty output.
titleize is also aliased as as titlecase
Examples
"man from the boondocks".titleize #=> "Man From The Boondocks" "x-men: the last stand".titleize #=> "X Men: The Last Stand"
# File lib/sequel/extensions/inflector.rb, line 268 268: def titleize 269: underscore.humanize.gsub(/\b([a-z])/){|x| x[-1..-1].upcase} 270: end
Converts a string into a Date object.
# File lib/sequel/extensions/string_date_time.rb, line 8 8: def to_date 9: begin 10: Date.parse(self, Sequel.convert_two_digit_years) 11: rescue => e 12: raise Sequel::InvalidValue, "Invalid Date value '#{self}' (#{e.message})" 13: end 14: end
Converts a string into a DateTime object.
# File lib/sequel/extensions/string_date_time.rb, line 17 17: def to_datetime 18: begin 19: DateTime.parse(self, Sequel.convert_two_digit_years) 20: rescue => e 21: raise Sequel::InvalidValue, "Invalid DateTime value '#{self}' (#{e.message})" 22: end 23: end
Returns a Sequel::SQL::Blob that holds the same data as this string. Blobs provide proper escaping of binary data.
# File lib/sequel/core_sql.rb, line 198 198: def to_sequel_blob 199: ::Sequel::SQL::Blob.new(self) 200: end
Converts a string into a Time or DateTime object, depending on the value of Sequel.datetime_class
# File lib/sequel/extensions/string_date_time.rb, line 27 27: def to_sequel_time 28: begin 29: if Sequel.datetime_class == DateTime 30: DateTime.parse(self, Sequel.convert_two_digit_years) 31: else 32: Sequel.datetime_class.parse(self) 33: end 34: rescue => e 35: raise Sequel::InvalidValue, "Invalid #{Sequel.datetime_class} value '#{self}' (#{e.message})" 36: end 37: end
Converts a string into a Time object.
# File lib/sequel/extensions/string_date_time.rb, line 40 40: def to_time 41: begin 42: Time.parse(self) 43: rescue => e 44: raise Sequel::InvalidValue, "Invalid Time value '#{self}' (#{e.message})" 45: end 46: end
The reverse of camelize. Makes an underscored form from the expression in the string. Also changes ’::’ to ’/’ to convert namespaces to paths.
Examples
"ActiveRecord".underscore #=> "active_record" "ActiveRecord::Errors".underscore #=> active_record/errors
# File lib/sequel/extensions/inflector.rb, line 279 279: def underscore 280: gsub(/::/, '/').gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2'). 281: gsub(/([a-z\d])([A-Z])/,'\1_\2').tr("-", "_").downcase 282: end