Module: ActivityNotification::Common
- Included in:
- Group, Notifiable, Notifier, ORM::ActiveRecord::Notification, ORM::Dynamoid::Notification, ORM::Mongoid::Notification, Target
- Defined in:
- lib/activity_notification/common.rb
Overview
Common module included in target and notifiable model. Provides methods to resolve parameters from configured field or defined method. Also provides methods to convert into resource name or class name as string.
Instance Method Summary collapse
-
#printable_name ⇒ String
Convets to printable model name to show in view or email.
-
#printable_type ⇒ String
Convets to printable model type name to be humanized.
-
#resolve_value(thing, *args) ⇒ Object
Used to transform value from metadata to data which belongs model instance.
-
#to_class_name ⇒ String
Convets to class name.
-
#to_resource_name ⇒ String
Convets to singularized model name (resource name).
-
#to_resources_name ⇒ String
Convets to pluralized model name (resources name).
Instance Method Details
#printable_name ⇒ String
Convets to printable model name to show in view or email.
130 131 132 |
# File 'lib/activity_notification/common.rb', line 130 def printable_name "#{self.printable_type} (#{id})" end |
#printable_type ⇒ String
Is this the best to make readable?
Convets to printable model type name to be humanized.
124 125 126 |
# File 'lib/activity_notification/common.rb', line 124 def printable_type "#{self.to_class_name.demodulize.humanize}" end |
#resolve_value(thing, *args) ⇒ Object
Used to transform value from metadata to data which belongs model instance. Accepts Symbols, which it will send against this instance, Accepts Procs, which it will execute with this instance. Both Symbols and Procs will be passed arguments of this method. Also accepts Hash of these Symbols or Procs. If any other value will be passed, returns original value.
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 |
# File 'lib/activity_notification/common.rb', line 72 def resolve_value(thing, *args) case thing when Symbol symbol_method = method(thing) if symbol_method.arity > 0 symbol_method.call(*args) else symbol_method.call end when Proc if thing.arity > 1 thing.call(self, *args) elsif thing.arity > 0 thing.call(self) else thing.call end when Hash thing.dup.tap do |hash| hash.each do |key, value| hash[key] = resolve_value(value, *args) end end else thing end end |
#to_class_name ⇒ String
Convets to class name. This function returns base_class name for STI models if the class responds to base_class method.
105 106 107 |
# File 'lib/activity_notification/common.rb', line 105 def to_class_name self.class.respond_to?(:base_class) ? self.class.base_class.name : self.class.name end |
#to_resource_name ⇒ String
Convets to singularized model name (resource name).
111 112 113 |
# File 'lib/activity_notification/common.rb', line 111 def to_resource_name self.to_class_name.demodulize.singularize.underscore end |
#to_resources_name ⇒ String
Convets to pluralized model name (resources name).
117 118 119 |
# File 'lib/activity_notification/common.rb', line 117 def to_resources_name self.to_class_name.demodulize.pluralize.underscore end |