Module: Sequent::Core::Helpers::AttributeSupport
- Included in:
- BaseCommand, Event, ValueObject
- Defined in:
- lib/sequent/core/helpers/attribute_support.rb
Overview
Provides functionality for defining attributes with their types
Since our Commands and ValueObjects are not backed by a database like e.g. rails we can not infer their types. We need the types to be able to parse from and to json. We could have stored te type information in the json, but we didn’t.
You typically do not need to include this module in your classes. If you extend from Sequent::Core::ValueObject, Sequent::Core::Event or Sequent::Core::BaseCommand you will get this functionality for free.
Defined Under Namespace
Modules: ClassMethods
Class Method Summary collapse
-
.included(host_class) ⇒ Object
extend host class with class methods when we’re included.
Instance Method Summary collapse
- #as_json(opts = {}) ⇒ Object
- #attributes ⇒ Object
- #update(changes) ⇒ Object
- #validation_errors(prefix = nil) ⇒ Object
Class Method Details
.included(host_class) ⇒ Object
extend host class with class methods when we’re included
106 107 108 |
# File 'lib/sequent/core/helpers/attribute_support.rb', line 106 def self.included(host_class) host_class.extend(ClassMethods) end |
Instance Method Details
#as_json(opts = {}) ⇒ Object
124 125 126 127 128 129 130 131 132 133 134 135 |
# File 'lib/sequent/core/helpers/attribute_support.rb', line 124 def as_json(opts = {}) hash = HashWithIndifferentAccess.new self.class.types.each do |name, _| value = self.instance_variable_get("@#{name}") hash[name] = if value.respond_to?(:as_json) value.as_json(opts) else value end end hash end |
#attributes ⇒ Object
111 112 113 114 115 116 117 118 119 120 121 122 |
# File 'lib/sequent/core/helpers/attribute_support.rb', line 111 def attributes hash = HashWithIndifferentAccess.new self.class.types.each do |name, _| value = self.instance_variable_get("@#{name}") hash[name] = if value.respond_to?(:attributes) value.attributes else value end end hash end |
#update(changes) ⇒ Object
137 138 139 |
# File 'lib/sequent/core/helpers/attribute_support.rb', line 137 def update(changes) self.class.new(attributes.merge(changes)) end |
#validation_errors(prefix = nil) ⇒ Object
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 |
# File 'lib/sequent/core/helpers/attribute_support.rb', line 141 def validation_errors(prefix = nil) result = errors.to_hash self.class.types.each do |field| value = self.instance_variable_get("@#{field[0]}") if value.respond_to? :validation_errors value.validation_errors.each { |k, v| result["#{field[0].to_s}_#{k.to_s}".to_sym] = v } elsif field[1].class == ArrayWithType and value.present? value .select { |val| val.respond_to?(:validation_errors) } .each_with_index do |val, index| val.validation_errors.each do |k, v| result["#{field[0].to_s}_#{index}_#{k.to_s}".to_sym] = v end end end end prefix ? HashWithIndifferentAccess[result.map { |k, v| ["#{prefix}_#{k}", v] }] : result end |