Class: String
- Defined in:
- lib/sequel/core_sql.rb,
lib/sequel/extensions/blank.rb,
lib/sequel/extensions/inflector.rb,
lib/sequel/extensions/string_date_time.rb
Overview
The string_date_time extension provides String instance methods for converting the strings to a date (e.g. String#to_date), allowing for backwards compatibility with legacy Sequel code.
Direct Known Subclasses
Defined Under Namespace
Modules: Inflections
Class Method Summary collapse
-
.inflections {|Inflections| ... } ⇒ Object
Yield the Inflections module if a block is given, and return the Inflections module.
Instance Method Summary collapse
-
#blank? ⇒ Boolean
Strings are blank if they are empty or include only whitespace.
-
#camelize(first_letter_in_uppercase = :upper) ⇒ Object
(also: #camelcase)
By default, camelize converts the string to UpperCamelCase.
-
#classify ⇒ Object
Singularizes and camelizes the string.
-
#constantize ⇒ Object
Constantize tries to find a declared constant with the name specified in the string.
-
#dasherize ⇒ Object
Replaces underscores with dashes in the string.
-
#demodulize ⇒ Object
Removes the module part from the expression in the string.
-
#foreign_key(use_underscore = true) ⇒ Object
Creates a foreign key name from a class name.
-
#humanize ⇒ Object
Capitalizes the first word and turns underscores into spaces and strips _id.
-
#lit(*args) ⇒ Object
Converts a string into a Sequel::LiteralString, in order to override string literalization, e.g.:.
-
#pluralize ⇒ Object
Returns the plural form of the word in the string.
-
#singularize ⇒ Object
The reverse of pluralize, returns the singular form of a word in a string.
-
#tableize ⇒ Object
Underscores and pluralizes the string.
-
#titleize ⇒ Object
(also: #titlecase)
Capitalizes all the words and replaces some characters in the string to create a nicer looking title.
-
#to_date ⇒ Object
Converts a string into a Date object.
-
#to_datetime ⇒ Object
Converts a string into a DateTime object.
-
#to_sequel_blob ⇒ Object
Returns a Sequel::SQL::Blob that holds the same data as this string.
-
#to_sequel_time ⇒ Object
Converts a string into a Time or DateTime object, depending on the value of Sequel.datetime_class.
-
#to_time ⇒ Object
Converts a string into a Time object.
-
#underscore ⇒ Object
The reverse of camelize.
Methods included from Sequel::SQL::CastMethods
#cast, #cast_numeric, #cast_string
Methods included from Sequel::SQL::AliasMethods
Class Method Details
.inflections {|Inflections| ... } ⇒ Object
Yield the Inflections module if a block is given, and return the Inflections module.
138 139 140 141 |
# File 'lib/sequel/extensions/inflector.rb', line 138 def self.inflections yield Inflections if block_given? Inflections end |
Instance Method Details
#blank? ⇒ Boolean
Strings are blank if they are empty or include only whitespace
33 34 35 |
# File 'lib/sequel/extensions/blank.rb', line 33 def blank? strip.empty? end |
#camelize(first_letter_in_uppercase = :upper) ⇒ Object Also known as: camelcase
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"
153 154 155 156 157 |
# File 'lib/sequel/extensions/inflector.rb', line 153 def camelize(first_letter_in_uppercase = :upper) s = gsub(/\/(.?)/){|x| "::#{x[-1..-1].upcase unless x == '/'}"}.gsub(/(^|_)(.)/){|x| x[-1..-1].upcase} s[0...1] = s[0...1].downcase unless first_letter_in_uppercase == :upper s end |
#classify ⇒ Object
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"
167 168 169 |
# File 'lib/sequel/extensions/inflector.rb', line 167 def classify sub(/.*\./, '').singularize.camelize end |
#constantize ⇒ Object
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
178 179 180 181 |
# File 'lib/sequel/extensions/inflector.rb', line 178 def constantize raise(NameError, "#{inspect} is not a valid constant name!") unless m = /\A(?:::)?([A-Z]\w*(?:::[A-Z]\w*)*)\z/.match(self) Object.module_eval("::#{m[1]}", __FILE__, __LINE__) end |
#dasherize ⇒ Object
Replaces underscores with dashes in the string.
Example
"puni_puni".dasherize #=> "puni-puni"
187 188 189 |
# File 'lib/sequel/extensions/inflector.rb', line 187 def dasherize gsub(/_/, '-') end |
#demodulize ⇒ Object
Removes the module part from the expression in the string
Examples
"ActiveRecord::CoreExtensions::String::Inflections".demodulize #=> "Inflections"
"Inflections".demodulize #=> "Inflections"
196 197 198 |
# File 'lib/sequel/extensions/inflector.rb', line 196 def demodulize gsub(/^.*::/, '') end |
#foreign_key(use_underscore = true) ⇒ Object
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"
207 208 209 |
# File 'lib/sequel/extensions/inflector.rb', line 207 def foreign_key(use_underscore = true) "#{demodulize.underscore}#{'_' if use_underscore}id" end |
#humanize ⇒ Object
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"
217 218 219 |
# File 'lib/sequel/extensions/inflector.rb', line 217 def humanize gsub(/_id$/, "").gsub(/_/, " ").capitalize end |
#lit(*args) ⇒ Object
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"
192 193 194 |
# File 'lib/sequel/core_sql.rb', line 192 def lit(*args) args.empty? ? Sequel::LiteralString.new(self) : Sequel::SQL::PlaceholderLiteralString.new(self, args) end |
#pluralize ⇒ Object
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"
230 231 232 233 234 |
# File 'lib/sequel/extensions/inflector.rb', line 230 def pluralize result = dup Inflections.plurals.each{|(rule, replacement)| break if result.gsub!(rule, replacement)} unless Inflections.uncountables.include?(downcase) result end |
#singularize ⇒ Object
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"
245 246 247 248 249 |
# File 'lib/sequel/extensions/inflector.rb', line 245 def singularize result = dup Inflections.singulars.each{|(rule, replacement)| break if result.gsub!(rule, replacement)} unless Inflections.uncountables.include?(downcase) result end |
#tableize ⇒ Object
Underscores and pluralizes the string.
Examples
"RawScaledScorer".tableize #=> "raw_scaled_scorers"
"egg_and_ham".tableize #=> "egg_and_hams"
"fancyCategory".tableize #=> "fancy_categories"
257 258 259 |
# File 'lib/sequel/extensions/inflector.rb', line 257 def tableize underscore.pluralize end |
#titleize ⇒ Object Also known as: titlecase
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"
269 270 271 |
# File 'lib/sequel/extensions/inflector.rb', line 269 def titleize underscore.humanize.gsub(/\b([a-z])/){|x| x[-1..-1].upcase} end |
#to_date ⇒ Object
Converts a string into a Date object.
7 8 9 10 11 12 13 |
# File 'lib/sequel/extensions/string_date_time.rb', line 7 def to_date begin Date.parse(self, Sequel.convert_two_digit_years) rescue => e raise Sequel::InvalidValue, "Invalid Date value '#{self}' (#{e.})" end end |
#to_datetime ⇒ Object
Converts a string into a DateTime object.
16 17 18 19 20 21 22 |
# File 'lib/sequel/extensions/string_date_time.rb', line 16 def to_datetime begin DateTime.parse(self, Sequel.convert_two_digit_years) rescue => e raise Sequel::InvalidValue, "Invalid DateTime value '#{self}' (#{e.})" end end |
#to_sequel_blob ⇒ Object
Returns a Sequel::SQL::Blob that holds the same data as this string. Blobs provide proper escaping of binary data.
198 199 200 |
# File 'lib/sequel/core_sql.rb', line 198 def to_sequel_blob ::Sequel::SQL::Blob.new(self) end |
#to_sequel_time ⇒ Object
Converts a string into a Time or DateTime object, depending on the value of Sequel.datetime_class
26 27 28 29 30 31 32 33 34 35 36 |
# File 'lib/sequel/extensions/string_date_time.rb', line 26 def to_sequel_time begin if Sequel.datetime_class == DateTime DateTime.parse(self, Sequel.convert_two_digit_years) else Sequel.datetime_class.parse(self) end rescue => e raise Sequel::InvalidValue, "Invalid #{Sequel.datetime_class} value '#{self}' (#{e.})" end end |
#to_time ⇒ Object
Converts a string into a Time object.
39 40 41 42 43 44 45 |
# File 'lib/sequel/extensions/string_date_time.rb', line 39 def to_time begin Time.parse(self) rescue => e raise Sequel::InvalidValue, "Invalid Time value '#{self}' (#{e.})" end end |
#underscore ⇒ Object
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
280 281 282 283 |
# File 'lib/sequel/extensions/inflector.rb', line 280 def underscore gsub(/::/, '/').gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2'). gsub(/([a-z\d])([A-Z])/,'\1_\2').tr("-", "_").downcase end |