Module: HasNamedBootstraps::ClassMethods

Defined in:
lib/has_named_bootstraps.rb

Instance Method Summary collapse

Instance Method Details

#handle_missing_bootstrap(handle_missing_bootstrap_strategy, name_field, record_name) ⇒ Object

:nodoc:



94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/has_named_bootstraps.rb', line 94

def handle_missing_bootstrap(handle_missing_bootstrap_strategy, name_field, record_name) #:nodoc:
  error_message = "Couldn't find bootstrap #{self} with #{name_field} \"#{record_name}\""

  case handle_missing_bootstrap_strategy
  when :raise
    raise MissingBootstrapError, error_message
  when :warn
    Rails.logger.warn error_message
  when :silent
    # Don't raise anything, don't log a warning, just let the constant be 
    # silently set to nil.
  end
end

#has_named_bootstraps(constant_hash, options = {}) ⇒ Object

For each key/value pair in constant_hash, look up the record with the value in the “name” attribute (by default), and assign it to the constant denoted by the key.

Example:

class Department < ActiveRecord::Base
  has_named_bootstraps(
    :R_AND_D         => 'R&D',
    :MARKETING       => 'Marketing', 
    :HANDSOME_DEVILS => 'Web Development' 
  )
end

Department::R_AND_D, Department::MARKETING and Department::HANDSOME_DEVILS are now all defined and point to an ActiveRecord object.

Valid options:

master_list

Assign to the given constant name a list of all constants that has_named_bootstraps creates. Example:

class Dog < ActiveRecord::Base
  has_named_bootstraps(
    {:FIDO => 'Fido', :ROVER => 'Rover', :SPOT  => 'Spot'},
    :master_list => :GOOD_DOGS
  )
end

Dog::FIDO, Dog::ROVER, and Dog::SPOT are now defined as above, but there’s also another constant, Dog::GOOD_DOGS, which contains a list of those three dogs.

name_field

Look up bootstrapped constants by the specified field, rather than name. Example:

class Part < ActiveRecord::Base
  has_named_bootstraps(
    {
      :BANANA_GRABBER => '423-GOB-127', 
      :TURNIP_TWADDLER => 'ZOMG-6-5000', 
      :MOLE_WHACKER => '520-23-17X'
    },
    :name_field => :serial_number
  )
end

>> Part.all
=> [#<Part id: 1, serial_number: "423-GOB-127">, #<Part id: 2, serial_number: "ZOMG-6-5000">, #<Part id: 3, serial_number: "520-23-17X">]
>> Part::BANANA_GRABBER
=> #<Part id: 1, serial_number: "423-GOB-127">
handle_missing_bootstrap

What to do if an expected bootstrap doesn’t exist. Valid values are:

  • raise (default)

    Raise a HasNamedBootstraps::MissingBootstrapError

  • warn

    Log a warning in the Rails log and leave the constant set to nil.

  • silent

    Leave the constant set to nil as in warn, but without any warning logged.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/has_named_bootstraps.rb', line 65

def has_named_bootstraps(constant_hash, options={})
  name_field = options[:name_field] || :name

  handle_missing_bootstrap_strategy = options[:handle_missing_bootstrap] || :raise
  unless %w(raise warn silent).include?(handle_missing_bootstrap_strategy.to_s)
    raise ArgumentError, "Invalid :handle_missing_bootstrap option \"#{handle_missing_bootstrap_strategy}\""
  end

  # If the master_list option isn't set, we're just going to throw this
  # list away, but it's clearer to just check once at the end if it's set
  # rather than check repeatedly.
  master_list = []

  constant_hash.each do |constant_name, record_name|
    bootstrapped_record = self.find(:first, :conditions => {name_field => record_name})

    unless bootstrapped_record
      handle_missing_bootstrap(handle_missing_bootstrap_strategy, name_field, record_name)
    end

    master_list << self.const_set(constant_name, bootstrapped_record.freeze)
  end

  master_list_name = options[:master_list]
  if master_list_name
    self.const_set(master_list_name, master_list.freeze)
  end
end