Module: Annotations::Config

Defined in:

lib/annotations/config.rb

Constant Summary

@@attribute_names_for_values_to_be_downcased =

List of attribute name(s) that need the corresponding value to be downcased (made all lowercase).

NOTE: The attribute names specified MUST all be in lowercase.

[ ]

@@attribute_names_for_values_to_be_upcased =

List of attribute name(s) that need the corresponding value to be upcased (made all uppercase).

NOTE: The attribute names specified MUST all be in lowercase.

[ ]

@@strip_text_rules =

This defines a hash of attributes, and the characters/strings that need to be stripped (removed) out of values of the attributes specified. Regular expressions can also be used instead of characters/strings. ie: { attribute_name => [ array of characters to strip out ] } (note: doesn’t have to be an array, can be a single string)

e.g: { “tag” => [ ‘“’, ‘,’] } or { ”tag“ => ‘”’ }

NOTE: The attribute name(s) specified MUST all be in lowercase.

{ }

@@user_model_name =

This allows you to specify a different model name for users in the system (if different from the default: “User”).

"User"

@@limits_per_source =

This allows you to limit the number of annotations (of specified attribute names) per source per annotatable.

Key/value pairs in hash should follow the spec: { attribute_name => max_number_allowed }

e.g: { “rating” =>1 } - will only ever allow 1 “rating” annotation per annotatable by each source.

NOTE (1): The attribute name(s) specified MUST all be in lowercase.

{ }

@@attribute_names_to_allow_duplicates =

By default, duplicate annotations CANNOT be created (same value for the same attribute, on the same annotatable object, regardless of source). For example: a user cannot add a description to a specific book that matches an existing description for that book.

This config setting allows exceptions to this rule, on a per attribute basis. I.e: allow annotations with certain attribute names to have duplicate values (per annotatable).

e.g: [ “tag”, “rating” ] - allows tags and ratings to have the same value more than once.

NOTE (1): The attribute name(s) specified MUST all be in lowercase. NOTE (2): This setting can be used in conjunction with the limits_per_source setting to allow

duplicate annotations BUT limit the number of annotations (per attribute) per user.

[ ]

@@content_restrictions =

This allows you to restrict the content of the values for annotations with a specific attribute name.

Key/value pairs in the hash should follow the spec: { attribute_name => { :in => array_or_range, :error_message => error_msg_to_show_if_value_not_allowed }

e.g: { “rating” => { :in => 1..5, :error_message => “Please provide a rating between 1 and 5” } }

NOTE (1): The attribute name(s) specified MUST all be in lowercase. NOTE (2): values will be checked in a case insensitive manner.

{ }

@@default_attribute_identifier_template =

This determines what template to use to generate the unique ‘identifier’ for new AnnotationAttribute objects.

String interpolation will be used to place the ‘name’ of the annotation within the template, in order to generate a unique identifier (usually a URI).

This uses the @@attribute_name_transform_for_identifier defined below when performing the substitution.

For more info on this substitution algorithm, see AnnotationAttribute#before_validation.

"http://www.example.org/attribute#%s"

@@attribute_name_transform_for_identifier =

Defines a Proc that will be used to transform the value of AnnotationAttribute#name when generating the AnnotationAttribute#identifier value. See AnnotationAttribute#before_validation for more info.

Proc.new { |name| name.to_s }

@@value_factories_for_attributes =

This stores the factory Procs that are used to generate the value objects for annotations, based on the attribute name.

• Keys should be attribute names (as Strings, in lowercase).

• Values should either be a Proc that takes in one argument - the raw value object, that is then used

to output the actual value to be stored. IMPORTANT: the Procs must be exhibit consistent data behaviour. I.e. should be able to run them over and over again without causing data inconsistencies or harmful side effects.

NOTE (1): this is run BEFORE the default value generation logic in the Annotation model. The default value generation logic will still run after the Proc. NOTE (2): The attribute name(s) specified MUST all be in lowercase.

{ }

@@valid_value_types =

This determines the valid value types that are allowed for certain attribute names.

• Keys should be attribute names (as Strings, in lowercase).

• Values should be an Array of Strings, or single String, of valid class names for the value object type.

NOTE (1): It is possible to use the above value_factories_for_attributes option to achieve similar behaviour. However, this config option allows you to state explicitly what types are allowed as value objects. NOTE (2): The attribute name(s) specified MUST all be in lowercase.

{ }

@@versioning_enabled =

This determines whether versioning is enabled. The default behaviour is true, in which case when a new annotation is created or updated, a copy of the new version is stored in Annotation::Version and linked to the annotation. Likewise versions of the annotation values are created. By setting to false, no versions are recorded.

true

Class Method Summary

• .reset ⇒ Object

Class Method Details

.reset ⇒ Object

# File 'lib/annotations/config.rb', line 103

def self.reset
  @@attribute_names_for_values_to_be_downcased = [ ]
  @@attribute_names_for_values_to_be_upcased = [ ]
  @@strip_text_rules = { }
  @@user_model_name = "User"
  @@limits_per_source = { }
  @@attribute_names_to_allow_duplicates = [ ]
  @@content_restrictions = { }
  @@default_attribute_identifier_template = "http://www.example.org/attribute#%s"
  @@attribute_name_transform_for_identifier = Proc.new { |name| name.to_s }
  @@value_factories = { }
  @@valid_value_types = { }
end