sequel 1.5.1 → 2.0.0

data/lib/sequel_model/hooks.rb

@@ -1,59 +1,61 @@
 module Sequel
   class Model
-    HOOKS = [
-      :after_initialize,
-      :before_create,
-      :after_create,
-      :before_update,
-      :after_update,
-      :before_save,
-      :after_save,
-      :before_destroy,
-      :after_destroy
-    ]
+    # Hooks that are safe for public use
+    HOOKS = [:after_initialize, :before_create, :after_create, :before_update,
+      :after_update, :before_save, :after_save, :before_destroy, :after_destroy,
+      :before_validation, :after_validation]
+
+    # Hooks that are only for internal use
+    PRIVATE_HOOKS = [:before_update_values, :before_delete]
     
-    # Some fancy code generation here in order to define the hook class methods...
-    HOOK_METHOD_STR = %Q{
-      def self.%s(method = nil, &block)
-        unless block
-          (raise SequelError, 'No hook method specified') unless method
-          block = proc {send method}
-        end
-        add_hook(%s, &block)
+    # Returns true if the model class or any of its ancestors have defined
+    # hooks for the given hook key. Notice that this method cannot detect 
+    # hooks defined using overridden methods.
+    def self.has_hooks?(key)
+      has = hooks[key] && !hooks[key].empty?
+      has || ((self != Model) && superclass.has_hooks?(key))
+    end
+
+    ### Private Class Methods ###
+
+    # Add a hook block to the list of hook methods.
+    # If a non-nil tag is given and it already is in the list of hooks,
+    # replace it with the new block.
+    def self.add_hook(hook, tag, &block) #:nodoc:
+      unless block
+        (raise Error, 'No hook method specified') unless tag
+        block = proc {send tag}
       end
-    }
-    
-    class << self
-      # Returns true if the model class or any of its ancestors have defined
-      # hooks for the given hook key. Notice that this method cannot detect 
-      # hooks defined using overridden methods.
-      def has_hooks?(key)
-        has = hooks[key] && !hooks[key].empty?
-        has || ((self != Model) && superclass.has_hooks?(key))
+      h = hooks[hook]
+      if tag && (old = h.find{|x| x[0] == tag})
+        old[1] = block
+      else
+        h << [tag, block]
       end
-      private
-        def def_hook_method(m) #:nodoc:
-          instance_eval(HOOK_METHOD_STR % [m.to_s, m.inspect])
-        end
-        
-        # Returns the hooks hash for the model class.
-        def hooks #:nodoc:
-          @hooks ||= Hash.new {|h, k| h[k] = []}
-        end
-        
-        def add_hook(hook, &block) #:nodoc:
-          chain = hooks[hook]
-          chain << block
-          define_method(hook) do 
-            return false if super == false
-            chain.each {|h| break false if instance_eval(&h) == false}
-          end
-        end
     end
 
-    HOOKS.each do |h|
-      define_method(h){}
-      def_hook_method(h)
+    # Returns all hook methods for the given type of hook for this
+    # model class and its ancestors.
+    def self.all_hooks(hook) # :nodoc:
+      ((self == Model ? [] : superclass.send(:all_hooks, hook)) + hooks[hook].collect{|x| x[1]})
+    end
+      
+    # Returns the hooks hash for this model class.
+    def self.hooks #:nodoc:
+      @hooks ||= Hash.new {|h, k| h[k] = []}
+    end
+
+    # Runs all hooks of type hook on the given object.
+    # Returns false if any hook returns false.
+    def self.run_hooks(hook, object) #:nodoc:
+      all_hooks(hook).each{|b| return false if object.instance_eval(&b) == false}
+    end
+
+    metaprivate :add_hook, :all_hooks, :hooks, :run_hooks
+
+    (HOOKS + PRIVATE_HOOKS).each do |hook|
+      instance_eval("def #{hook}(method = nil, &block); add_hook(:#{hook}, method, &block) end")
+      define_method(hook){model.send(:run_hooks, hook, self)}
     end
   end
 end

data/lib/sequel_model/inflector.rb

@@ -1,13 +1,12 @@
-require 'singleton'
+# Add inflection methods to String, which allows the easy transformation of
+# words from singular to plural,class names to table names, modularized class
+# names to ones without, and class names to foreign keys.
 
-# The Inflector transforms words from singular to plural, class names to table names, modularized class names to ones without,
-# and class names to foreign keys. The default inflections for pluralization, singularization, and uncountable words are kept
-# in inflections.rb.
-module Inflector
-  # A singleton instance of this class is yielded by Inflector.inflections, which can then be used to specify additional
-  # inflection rules. Examples:
+class String
+  # This module acts as a singleton returned/yielded by String.inflections,
+  # which is used to override or specify additional inflection rules. Examples:
   #
-  #   Inflector.inflections do |inflect|
+  #   String.inflections do |inflect|
   #     inflect.plural /^(ox)$/i, '\1\2en'
   #     inflect.singular /^(ox)en/i, '\1'
   #
@@ -19,25 +18,24 @@ module Inflector
   # New rules are added at the top. So in the example above, the irregular rule for octopus will now be the first of the
   # pluralization and singularization rules that is runs. This guarantees that your rules run before any of the rules that may
   # already have been loaded.
-  class Inflections
-    include Singleton
+  module Inflections
+    @plurals, @singulars, @uncountables = [], [], []
 
-    attr_reader :plurals, :singulars, :uncountables
+    metaattr_reader :plurals, :singulars, :uncountables
 
-    def initialize
-      @plurals, @singulars, @uncountables = [], [], []
-    end
-
-    # Specifies a new pluralization rule and its replacement. The rule can either be a string or a regular expression.
-    # The replacement should always be a string that may include references to the matched data from the rule.
-    def plural(rule, replacement)
-      @plurals.insert(0, [rule, replacement])
-    end
-
-    # Specifies a new singularization rule and its replacement. The rule can either be a string or a regular expression.
-    # The replacement should always be a string that may include references to the matched data from the rule.
-    def singular(rule, replacement)
-      @singulars.insert(0, [rule, replacement])
+    # Clears the loaded inflections within a given scope (default is :all). Give the scope as a symbol of the inflection type,
+    # the options are: :plurals, :singulars, :uncountables
+    #
+    # Examples:
+    #   clear :all
+    #   clear :plurals
+    def self.clear(scope = :all)
+      case scope
+      when :all
+        @plurals, @singulars, @uncountables = [], [], []
+      else
+        instance_variable_set("@#{scope}", [])
+      end
     end
 
     # Specifies a new irregular that applies to both pluralization and singularization at the same time. This can only be used
@@ -46,89 +44,101 @@ module Inflector
     # Examples:
     #   irregular 'octopus', 'octopi'
     #   irregular 'person', 'people'
-    def irregular(singular, plural)
+    def self.irregular(singular, plural)
       plural(Regexp.new("(#{singular[0,1]})#{singular[1..-1]}$", "i"), '\1' + plural[1..-1])
       singular(Regexp.new("(#{plural[0,1]})#{plural[1..-1]}$", "i"), '\1' + singular[1..-1])
     end
 
+    # Specifies a new pluralization rule and its replacement. The rule can either be a string or a regular expression.
+    # The replacement should always be a string that may include references to the matched data from the rule.
+    #
+    # Example:
+    #   plural(/(x|ch|ss|sh)$/i, '\1es')
+    def self.plural(rule, replacement)
+      @plurals.insert(0, [rule, replacement])
+    end
+
+    # Specifies a new singularization rule and its replacement. The rule can either be a string or a regular expression.
+    # The replacement should always be a string that may include references to the matched data from the rule.
+    #
+    # Example:
+    #   singular(/([^aeiouy]|qu)ies$/i, '\1y') 
+    def self.singular(rule, replacement)
+      @singulars.insert(0, [rule, replacement])
+    end
+
     # Add uncountable words that shouldn't be attempted inflected.
     #
     # Examples:
     #   uncountable "money"
     #   uncountable "money", "information"
     #   uncountable %w( money information rice )
-    def uncountable(*words)
+    def self.uncountable(*words)
       (@uncountables << words).flatten!
     end
 
-    # Clears the loaded inflections within a given scope (default is :all). Give the scope as a symbol of the inflection type,
-    # the options are: :plurals, :singulars, :uncountables
-    #
-    # Examples:
-    #   clear :all
-    #   clear :plurals
-    def clear(scope = :all)
-      case scope
-        when :all
-          @plurals, @singulars, @uncountables = [], [], []
-        else
-          instance_variable_set "@#{scope}", []
-      end
-    end
-  end
+    # Setup the default inflections
+    plural(/$/, 's')
+    plural(/s$/i, 's')
+    plural(/(ax|test)is$/i, '\1es')
+    plural(/(octop|vir)us$/i, '\1i')
+    plural(/(alias|status)$/i, '\1es')
+    plural(/(bu)s$/i, '\1ses')
+    plural(/(buffal|tomat)o$/i, '\1oes')
+    plural(/([ti])um$/i, '\1a')
+    plural(/sis$/i, 'ses')
+    plural(/(?:([^f])fe|([lr])f)$/i, '\1\2ves')
+    plural(/(hive)$/i, '\1s')
+    plural(/([^aeiouy]|qu)y$/i, '\1ies')
+    plural(/(x|ch|ss|sh)$/i, '\1es')
+    plural(/(matr|vert|ind)ix|ex$/i, '\1ices')
+    plural(/([m|l])ouse$/i, '\1ice')
+    plural(/^(ox)$/i, '\1en')
+    plural(/(quiz)$/i, '\1zes')
 
-  extend self
+    singular(/s$/i, '')
+    singular(/(n)ews$/i, '\1ews')
+    singular(/([ti])a$/i, '\1um')
+    singular(/((a)naly|(b)a|(d)iagno|(p)arenthe|(p)rogno|(s)ynop|(t)he)ses$/i, '\1\2sis')
+    singular(/(^analy)ses$/i, '\1sis')
+    singular(/([^f])ves$/i, '\1fe')
+    singular(/(hive)s$/i, '\1')
+    singular(/(tive)s$/i, '\1')
+    singular(/([lr])ves$/i, '\1f')
+    singular(/([^aeiouy]|qu)ies$/i, '\1y')
+    singular(/(s)eries$/i, '\1eries')
+    singular(/(m)ovies$/i, '\1ovie')
+    singular(/(x|ch|ss|sh)es$/i, '\1')
+    singular(/([m|l])ice$/i, '\1ouse')
+    singular(/(bus)es$/i, '\1')
+    singular(/(o)es$/i, '\1')
+    singular(/(shoe)s$/i, '\1')
+    singular(/(cris|ax|test)es$/i, '\1is')
+    singular(/(octop|vir)i$/i, '\1us')
+    singular(/(alias|status)es$/i, '\1')
+    singular(/^(ox)en/i, '\1')
+    singular(/(vert|ind)ices$/i, '\1ex')
+    singular(/(matr)ices$/i, '\1ix')
+    singular(/(quiz)zes$/i, '\1')
 
-  def inflections
-    if block_given?
-      yield Inflections.instance
-    else
-      Inflections.instance
-    end
-  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"
-  def pluralize(word)
-    result = word.to_s.dup
+    irregular('person', 'people')
+    irregular('man', 'men')
+    irregular('child', 'children')
+    irregular('sex', 'sexes')
+    irregular('move', 'moves')
 
-    if inflections.uncountables.include?(result.downcase)
-      result
-    else
-      inflections.plurals.each { |(rule, replacement)| break if result.gsub!(rule, replacement) }
-      result
-    end
+    uncountable(%w(equipment information rice money species series fish sheep))
   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"
-  def singularize(word)
-    result = word.to_s.dup
-
-    if inflections.uncountables.include?(result.downcase)
-      result
-    else
-      inflections.singulars.each { |(rule, replacement)| break if result.gsub!(rule, replacement) }
-      result
-    end
+  # Yield the Inflections module if a block is given, and return
+  # the Inflections module.
+  def self.inflections
+    yield Inflections if block_given?
+    Inflections
   end
 
-  # By default, camelize converts strings to UpperCamelCase. If the argument to camelize
-  # is set to ":lower" then camelize produces lowerCamelCase.
+  # 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
   #
@@ -137,143 +147,137 @@ module Inflector
   #   "active_record".camelize(:lower) #=> "activeRecord"
   #   "active_record/errors".camelize #=> "ActiveRecord::Errors"
   #   "active_record/errors".camelize(:lower) #=> "activeRecord::Errors"
-  def camelize(lower_case_and_underscored_word, first_letter_in_uppercase = true)
-    if first_letter_in_uppercase
-      lower_case_and_underscored_word.to_s.gsub(/\/(.?)/) { "::" + $1.upcase }.gsub(/(^|_)(.)/) { $2.upcase }
+  def camelize(first_letter_in_uppercase = :upper)
+    if first_letter_in_uppercase == :upper
+      gsub(/\/(.?)/){|x| "::#{x[-1..-1].upcase unless x == '/'}"}.gsub(/(^|_)(.)/){|x| x[-1..-1].upcase}
     else
-      lower_case_and_underscored_word.first + camelize(lower_case_and_underscored_word)[1..-1]
+      "#{first}#{camelize[1..-1]}"
     end
   end
+  alias_method :camelcase, :camelize
 
-  # Capitalizes all the words and replaces some characters in the string to create
-  # a nicer looking title. Titleize is meant for creating pretty output. It is not
-  # used in the Rails internals.
-  #
-  # titleize is also aliased as as titlecase
+  # Singularizes and camelizes the string.  Also strips out all characters preceding
+  # and including a period (".").
   #
   # Examples
-  #   "man from the boondocks".titleize #=> "Man From The Boondocks"
-  #   "x-men: the last stand".titleize #=> "X Men: The Last Stand"
-  def titleize(word)
-    humanize(underscore(word)).gsub(/\b([a-z])/) { $1.capitalize }
+  #   "egg_and_hams".classify #=> "EggAndHam"
+  #   "post".classify #=> "Post"
+  #   "schema.post".classify #=> "Post"
+  def classify
+    sub(/.*\./, '').singularize.camelize
   end
 
-  # The reverse of +camelize+. Makes an underscored form from the expression in the string.
-  #
-  # Changes '::' to '/' to convert namespaces to paths.
+  # 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
-  #   "ActiveRecord".underscore #=> "active_record"
-  #   "ActiveRecord::Errors".underscore #=> active_record/errors
-  def underscore(camel_cased_word)
-    camel_cased_word.to_s.gsub(/::/, '/').
-      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-      gsub(/([a-z\d])([A-Z])/,'\1_\2').
-      tr("-", "_").
-      downcase
+  #   "Module".constantize #=> Module
+  #   "Class".constantize #=> Class
+  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
 
   # Replaces underscores with dashes in the string.
   #
   # Example
-  #   "puni_puni" #=> "puni-puni"
-  def dasherize(underscored_word)
-    underscored_word.gsub(/_/, '-')
+  #   "puni_puni".dasherize #=> "puni-puni"
+  def dasherize
+    gsub(/_/, '-')
   end
 
-  # Capitalizes the first word and turns underscores into spaces and strips _id.
-  # Like titleize, this is meant for creating pretty output.
+  # Removes the module part from the expression in the string
   #
   # Examples
-  #   "employee_salary" #=> "Employee salary"
-  #   "author_id" #=> "Author"
-  def humanize(lower_case_and_underscored_word)
-    lower_case_and_underscored_word.to_s.gsub(/_id$/, "").gsub(/_/, " ").capitalize
+  #   "ActiveRecord::CoreExtensions::String::Inflections".demodulize #=> "Inflections"
+  #   "Inflections".demodulize #=> "Inflections"
+  def demodulize
+    gsub(/^.*::/, '')
   end
 
-  # Removes the module part from the expression in the string
+  # Creates a foreign key name from a class name.
+  # +use_underscore+ sets whether the method should put '_' between the name and 'id'.
   #
   # Examples
-  #   "ActiveRecord::CoreExtensions::String::Inflections".demodulize #=> "Inflections"
-  #   "Inflections".demodulize #=> "Inflections"
-  def demodulize(class_name_in_module)
-    class_name_in_module.to_s.gsub(/^.*::/, '')
+  #   "Message".foreign_key #=> "message_id"
+  #   "Message".foreign_key(false) #=> "messageid"
+  #   "Admin::Post".foreign_key #=> "post_id"
+  def foreign_key(use_underscore = true)
+    "#{demodulize.underscore}#{'_' if use_underscore}id"
   end
 
-  # Create the name of a table like Rails does for models to table names. This method
-  # uses the pluralize method on the last word in the string.
+  # Capitalizes the first word and turns underscores into spaces and strips _id.
+  # Like titleize, this is meant for creating pretty output.
   #
   # Examples
-  #   "RawScaledScorer".tableize #=> "raw_scaled_scorers"
-  #   "egg_and_ham".tableize #=> "egg_and_hams"
-  #   "fancyCategory".tableize #=> "fancy_categories"
-  def tableize(class_name)
-    pluralize(underscore(class_name))
+  #   "employee_salary" #=> "Employee salary"
+  #   "author_id" #=> "Author"
+  def humanize
+    gsub(/_id$/, "").gsub(/_/, " ").capitalize
   end
 
-  # Create a class name from a table name like Rails does for table names to models.
-  # Note that this returns a string and not a Class. (To convert to an actual class
-  # follow classify with constantize.)
+  # Returns the plural form of the word in the string.
   #
   # Examples
-  #   "egg_and_hams".classify #=> "EggAndHam"
-  #   "post".classify #=> "Post"
-  def classify(table_name)
-    # strip out any leading schema name
-    camelize(singularize(table_name.to_s.sub(/.*\./, '')))
+  #   "post".pluralize #=> "posts"
+  #   "octopus".pluralize #=> "octopi"
+  #   "sheep".pluralize #=> "sheep"
+  #   "words".pluralize #=> "words"
+  #   "the blue mailman".pluralize #=> "the blue mailmen"
+  #   "CamelOctopus".pluralize #=> "CamelOctopi"
+  def pluralize
+    result = dup
+    Inflections.plurals.each{|(rule, replacement)| break if result.gsub!(rule, replacement)} unless Inflections.uncountables.include?(downcase)
+    result
   end
 
-  # Creates a foreign key name from a class name.
-  # +separate_class_name_and_id_with_underscore+ sets whether
-  # the method should put '_' between the name and 'id'.
+  # The reverse of pluralize, returns the singular form of a word in a string.
   #
   # Examples
-  #   "Message".foreign_key #=> "message_id"
-  #   "Message".foreign_key(false) #=> "messageid"
-  #   "Admin::Post".foreign_key #=> "post_id"
-  def foreign_key(class_name, separate_class_name_and_id_with_underscore = true)
-    underscore(demodulize(class_name)) + (separate_class_name_and_id_with_underscore ? "_id" : "id")
+  #   "posts".singularize #=> "post"
+  #   "octopi".singularize #=> "octopus"
+  #   "sheep".singluarize #=> "sheep"
+  #   "word".singluarize #=> "word"
+  #   "the blue mailmen".singularize #=> "the blue mailman"
+  #   "CamelOctopi".singularize #=> "CamelOctopus"
+  def singularize
+    result = dup
+    Inflections.singulars.each{|(rule, replacement)| break if result.gsub!(rule, replacement)} unless Inflections.uncountables.include?(downcase)
+    result
   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.
+  # Underscores and pluralizes the string.
   #
   # Examples
-  #   "Module".constantize #=> Module
-  #   "Class".constantize #=> Class
-  def constantize(camel_cased_word)
-    unless /\A(?:::)?([A-Z]\w*(?:::[A-Z]\w*)*)\z/ =~ camel_cased_word
-      raise NameError, "#{camel_cased_word.inspect} is not a valid constant name!"
-    end
+  #   "RawScaledScorer".tableize #=> "raw_scaled_scorers"
+  #   "egg_and_ham".tableize #=> "egg_and_hams"
+  #   "fancyCategory".tableize #=> "fancy_categories"
+  def tableize
+    underscore.pluralize
+  end
 
-    Object.module_eval("::#{$1}", __FILE__, __LINE__)
+  # 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"
+  def titleize
+    underscore.humanize.gsub(/\b([a-z])/){|x| x[-1..-1].upcase}
   end
+  alias_method :titlecase, :titleize
 
-  # Ordinalize turns a number into an ordinal string used to denote the
-  # position in an ordered sequence such as 1st, 2nd, 3rd, 4th.
+  # The reverse of camelize. Makes an underscored form from the expression in the string.
+  # Also changes '::' to '/' to convert namespaces to paths.
   #
   # Examples
-  #   ordinalize(1)     # => "1st"
-  #   ordinalize(2)     # => "2nd"
-  #   ordinalize(1002)  # => "1002nd"
-  #   ordinalize(1003)  # => "1003rd"
-  def ordinalize(number)
-    if (11..13).include?(number.to_i % 100)
-      "#{number}th"
-    else
-      case number.to_i % 10
-        when 1
-          "#{number}st"
-        when 2
-          "#{number}nd"
-        when 3
-          "#{number}rd"
-        else
-          "#{number}th"
-      end
-    end
+  #   "ActiveRecord".underscore #=> "active_record"
+  #   "ActiveRecord::Errors".underscore #=> active_record/errors
+  def underscore
+    gsub(/::/, '/').gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').tr("-", "_").downcase
   end
 end
-
-require File.dirname(__FILE__) + '/inflections'