Module: Preferred::Preferable

Extended by:
ActiveSupport::Concern
Defined in:
lib/preferred/preferable.rb,
lib/preferred/preferable_class_methods.rb

Instance Method Summary collapse

Instance Method Details

#clear_preferences ⇒ Object 



51
52
53
 
# File 'lib/preferred/preferable.rb', line 51

def clear_preferences
  preference_hash.keys.each {|pref| preference_hash.delete pref} if preference_hash.is_a? Hash
end

#get_preference(name) ⇒ Object Also known as: preferred, prefers? 



8
9
10
11
 
# File 'lib/preferred/preferable.rb', line 8

def get_preference(name)
  has_preference! name
  send self.class.preference_getter_method(name)
end

#has_preference!(name) ⇒ Object 



35
36
37
 
# File 'lib/preferred/preferable.rb', line 35

def has_preference!(name)
  raise NoMethodError.new "#{name} preference not defined" unless has_preference? name
end

#has_preference?(name) ⇒ Boolean

Returns:

  • (Boolean) 


39
40
41
 
# File 'lib/preferred/preferable.rb', line 39

def has_preference?(name)
  respond_to? self.class.preference_getter_method(name)
end

#preference(name, type, *args) ⇒ Object 



3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/preferred/preferable_class_methods.rb', line 3

def preference(name, type, *args)
  options = args.extract_options!
  options.assert_valid_keys(:default, :description)
  default = options[:default]
  description = options[:description] || name

  # cache_key will be nil for new objects, then if we check if there
  # is a pending preference before going to default
  define_method preference_getter_method(name) do
    if self.preference_hash && preference_hash.key?(name.to_s)
      convert_preference_value(preference_hash[name.to_s]["value"], preference_hash[name.to_s]["type"])
    else
      send self.class.preference_default_getter_method(name)
    end
  end

  define_method preference_setter_method(name) do |value|
    value = convert_preference_value(value, type)
    self.preference_hash = {} if preference_hash.nil?
    self.preference_hash[name.to_s] = {
      value: value,
      type: type
    }
  end

  define_method preference_default_getter_method(name) do
    default
  end

  define_method preference_type_getter_method(name) do
    type
  end

  define_method preference_description_getter_method(name) do
    description
  end
end

#preference_default(name) ⇒ Object 



25
26
27
28
 
# File 'lib/preferred/preferable.rb', line 25

def preference_default(name)
  has_preference! name
  send self.class.preference_default_getter_method(name)
end

#preference_default_getter_method(name) ⇒ Object 



57
58
59
 
# File 'lib/preferred/preferable_class_methods.rb', line 57

def preference_default_getter_method(name)
  "preferred_#{name}_default".to_sym
end

#preference_description(name) ⇒ Object 



30
31
32
33
 
# File 'lib/preferred/preferable.rb', line 30

def preference_description(name)
  has_preference! name
  send self.class.preference_description_getter_method(name)
end

#preference_description_getter_method(name) ⇒ Object 



65
66
67
 
# File 'lib/preferred/preferable_class_methods.rb', line 65

def preference_description_getter_method(name)
  "preferred_#{name}_description".to_sym
end

#preference_getter_method(name) ⇒ Object 



49
50
51
 
# File 'lib/preferred/preferable_class_methods.rb', line 49

def preference_getter_method(name)
  "preferred_#{name}".to_sym
end

#preference_setter_method(name) ⇒ Object 



53
54
55
 
# File 'lib/preferred/preferable_class_methods.rb', line 53

def preference_setter_method(name)
   "preferred_#{name}=".to_sym
end

#preference_type(name) ⇒ Object 



20
21
22
23
 
# File 'lib/preferred/preferable.rb', line 20

def preference_type(name)
  has_preference! name
  send self.class.preference_type_getter_method(name)
end

#preference_type_getter_method(name) ⇒ Object 



61
62
63
 
# File 'lib/preferred/preferable_class_methods.rb', line 61

def preference_type_getter_method(name)
  "preferred_#{name}_type".to_sym
end

#preferences ⇒ Object 



43
44
45
46
47
48
49
 
# File 'lib/preferred/preferable.rb', line 43

def preferences
  prefs = {}
  methods.grep(/^prefers_.*\?$/).each do |pref_method|
    prefs[pref_method.to_s.gsub(/prefers_|\?/, '').to_sym] = send(pref_method)
  end
  prefs
end

#remove_preference(name) ⇒ Object 



41
42
43
44
45
46
47
 
# File 'lib/preferred/preferable_class_methods.rb', line 41

def remove_preference(name)
  remove_method preference_getter_method(name) if method_defined? preference_getter_method(name)
  remove_method preference_setter_method(name) if method_defined? preference_setter_method(name)
  remove_method preference_default_getter_method(name) if method_defined? preference_default_getter_method(name)
  remove_method preference_type_getter_method(name) if method_defined? preference_type_getter_method(name)
  remove_method preference_description_getter_method(name) if method_defined? preference_description_getter_method(name)
end

#set_preference(name, value) ⇒ Object 



15
16
17
18
 
# File 'lib/preferred/preferable.rb', line 15

def set_preference(name, value)
  has_preference! name
  send self.class.preference_setter_method(name), value
end