Class: Class

Class | Class
In: | lib/extlib/class.rb
Parent: | Object

Allows attributes to be shared within an inheritance hierarchy, but where each descendant gets a copy of their parents’ attributes, instead of just a pointer to the same. This means that the child can add elements to, for example, an array without those additions being shared with either their parent, siblings, or children, which is unlike the regular class-level attributes that are shared across the entire hierarchy.

### Methods

cattr_accessor cattr_reader cattr_writer class_inheritable_accessor class_inheritable_reader class_inheritable_writer

### Public Instance methods

cattr_accessor(*syms)

Defines class-level (and optionally instance-level) attribute accessor.

@param *syms<Array[*to_s, Hash{:instance_writer => Boolean}]> Array of attributes to define accessor for. @option syms :instance_writer<Boolean> if true, instance-level attribute writer is defined. @return <Array[to_s]> List of attributes that were made into accessors

@api public

cattr_reader(*syms)

Defines class-level and instance-level attribute reader.

@param *syms<Array> Array of attributes to define reader for. @return <Array[to_s]> List of attributes that were made into cattr_readers

@api public

@todo Is this inconsistent in that it does not allow you to prevent

      an instance_reader via :instance_reader => false

cattr_writer(*syms)

Defines class-level (and optionally instance-level) attribute writer.

@param <Array[*to_s, Hash{:instance_writer => Boolean}]> Array of attributes to define writer for. @option syms :instance_writer<Boolean> if true, instance-level attribute writer is defined. @return <Array[to_s]> List of attributes that were made into cattr_writers

@api public

class_inheritable_accessor(*syms)

Defines class-level inheritable attribute accessor. Attributes are available to subclasses, each subclass has a copy of parent‘s attribute.

@param *syms<Array[*to_s, Hash{:instance_writer => Boolean}]> Array of attributes to

      define inheritable accessor for.

@option syms :instance_writer<Boolean> if true, instance-level inheritable attribute writer is defined. @return <Array[to_s]> An Array of attributes turned into inheritable accessors.

@api public

class_inheritable_reader(*ivars)

Defines class-level inheritable attribute reader. Attributes are available to subclasses, each subclass has a copy of parent‘s attribute.

@param *syms<Array[to_s]> Array of attributes to define inheritable reader for. @return <Array[to_s]> Array of attributes converted into inheritable_readers.

@api public

@todo Do we want to block instance_reader via :instance_reader => false @todo It would be preferable that we do something with a Hash passed in

      (error out or do the same as other methods above) instead of silently
      moving on). In particular, this makes the return value of this function
      less useful.

class_inheritable_writer(*ivars)

Defines class-level inheritable attribute writer. Attributes are available to subclasses, each subclass has a copy of parent‘s attribute.

@param *syms<Array[*to_s, Hash{:instance_writer => Boolean}]> Array of attributes to

      define inheritable writer for.

@option syms :instance_writer<Boolean> if true, instance-level inheritable attribute writer is defined. @return <Array[to_s]> An Array of the attributes that were made into inheritable writers.

@api public

@todo We need a style for class_eval <<-HEREDOC. I‘d like to make it

      class_eval(<<-RUBY, __FILE__, __LINE__), but we should codify it somewhere.

[Validate]