Module: FlexColumns::HasFlexColumns::ClassMethods

Defined in:
lib/flex_columns/has_flex_columns.rb

Instance Method Summary collapse

Instance Method Details

#_all_flex_column_names ⇒ Object

What are the names of all flex columns defined on this model?



142
143
144
 
# File 'lib/flex_columns/has_flex_columns.rb', line 142

def _all_flex_column_names
  _flex_column_classes.map(&:column_name)
end

#_flex_column_class_for(flex_column_name) ⇒ Object

Given the name of a flex column, returns the flex-column class for that column. Raises FlexColumns::Errors::NoSuchColumnError if there is no column with the given name.



159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/flex_columns/has_flex_columns.rb', line 159

def _flex_column_class_for(flex_column_name)
  flex_column_name = _flex_column_normalize_name(flex_column_name)
  out = _flex_column_classes.detect { |fcc| fcc.column_name == flex_column_name }

  unless out
    raise FlexColumns::Errors::NoSuchColumnError, %{Model class #{self.name} has no flex column named #{flex_column_name.inspect};
it has flex columns named: #{_all_flex_column_names.sort_by(&:to_s).inspect}.}
  end

  out
end

#_flex_column_dynamic_methods_module ⇒ Object

Returns the DynamicMethodsModule that we add methods to that should be present on this model class.



172
173
174
 
# File 'lib/flex_columns/has_flex_columns.rb', line 172

def _flex_column_dynamic_methods_module
  @_flex_column_dynamic_methods_module ||= FlexColumns::Util::DynamicMethodsModule.new(self, :FlexColumnsDynamicMethods)
end

#_flex_column_normalize_name(flex_column_name) ⇒ Object

Normalizes the name of a flex column, so we’re consistent when using it for things like hash keys, no matter how the client specifies it to us.



153
154
155
 
# File 'lib/flex_columns/has_flex_columns.rb', line 153

def _flex_column_normalize_name(flex_column_name)
  flex_column_name.to_s.strip.downcase.to_sym
end

#_has_flex_column_named?(column_name) ⇒ Boolean

Does this model have a flex column with the given name?

Returns:

  • (Boolean) 


147
148
149
 
# File 'lib/flex_columns/has_flex_columns.rb', line 147

def _has_flex_column_named?(column_name)
  _all_flex_column_names.include?(_flex_column_normalize_name(column_name))
end

#create_flex_object_from(column_name, raw_string) ⇒ Object

Exactly like #create_flex_objects_from, except that instead of taking an Array of raw strings and returning an Array of flex-column objects, takes a single raw string and returns a single flex-column object.

#create_flex_objects_from is currently very slightly faster than simply calling this method in a loop; however, in the future, the difference in performance may increase. If you have more than one string to create a flex-column object from, you should definitely use #create_flex_objects_from instead of this method.



204
205
206
 
# File 'lib/flex_columns/has_flex_columns.rb', line 204

def create_flex_object_from(column_name, raw_string)
  _flex_column_class_for(column_name).new(raw_string)
end

#create_flex_objects_from(column_name, raw_strings) ⇒ Object

Given the name of a column in column_name and an Array of (possibly nil) JSON-formatted strings (which can also be compressed using the flex_columns compression mechanism), returns an Array of new flex-column objects for that column that are not attached to any particular model instance. These objects will obey all field-definition rules for that column, be able to validate themselves (if you call #valid? on them), retrieve data, have any custom methods defined on them that you defined on that flex column, and so on.

However, because they’re detached from any model instance, they also won’t save themselves to the database under any circumstances; you are responsible for calling #to_stored_data on them, and getting those strings into the database in the right places yourself, if you want to save them.

The purpose of this method is to allow you to use flex_columns in bulk-access situations, such as when you’ve selected many records from the database without using ActiveRecord, for performance reasons (e.g., User.connection.select_all("...")).



221
222
223
224
225
226
 
# File 'lib/flex_columns/has_flex_columns.rb', line 221

def create_flex_objects_from(column_name, raw_strings)
  column_class = _flex_column_class_for(column_name)
  raw_strings.map do |rs|
    column_class.new(rs)
  end
end

#flex_column(flex_column_name, options = { }, &block) ⇒ Object

Declares a new flex column. flex_column_name is its name; options is passed through to FlexColumns::Definition::FlexColumnContentsClass#setup!, and so can contain any of the options that that method accepts. The block, if passed, will be evaluated in the context of the generated class.



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/flex_columns/has_flex_columns.rb', line 179

def flex_column(flex_column_name, options = { }, &block)
  return unless table_exists?

  flex_column_name = _flex_column_normalize_name(flex_column_name)

  new_class = Class.new(FlexColumns::Contents::FlexColumnContentsBase)
  new_class.setup!(self, flex_column_name, options, &block)

  _flex_column_classes.delete_if { |fcc| fcc.column_name == flex_column_name }
  _flex_column_classes << new_class

  define_method(flex_column_name) do
    _flex_column_object_for(flex_column_name)
  end

  _flex_column_dynamic_methods_module.remove_all_methods!
  _flex_column_classes.each(&:sync_methods!)
end

#has_any_flex_columns? ⇒ Boolean

Does this class have any flex columns? If this module has been included into a class, then the answer is true.

Returns:

  • (Boolean) 


137
138
139
 
# File 'lib/flex_columns/has_flex_columns.rb', line 137

def has_any_flex_columns?
  true
end