sonic-pi

https://github.com/sonic-pi-net/sonic-pi

C++

Code. Music. Live.

Class#class_attribute

Declare a class-level attribute whose value is inheritable by subclasses.
Subclasses can change their own value and it will not impact parent class.

  class Base
    class_attribute :setting
  end

  class Subclass < Base
  end

  Base.setting = true
  Subclass.setting            # => true
  Subclass.setting = false
  Subclass.setting            # => false
  Base.setting                # => true

In the above case as long as Subclass does not assign a value to setting
by performing <tt>Subclass.setting = _something_ </tt>, <tt>Subclass.setting</tt>
would read value assigned to parent class. Once Subclass assigns a value then
the value assigned by Subclass would be returned.

This matches normal Ruby method inheritance: think of writing an attribute
on a subclass as overriding the reader method. However, you need to be aware
when using +class_attribute+ with mutable structures as +Array+ or +Hash+.
In such cases, you don't want to do changes in places but use setters:

  Base.setting = []
  Base.setting                # => []
  Subclass.setting            # => []

  # Appending in child changes both parent and child because it is the same object:
  Subclass.setting << :foo
  Base.setting               # => [:foo]
  Subclass.setting           # => [:foo]

  # Use setters to not propagate changes:
  Base.setting = []
  Subclass.setting += [:foo]
  Base.setting               # => []
  Subclass.setting           # => [:foo]

For convenience, an instance predicate method is defined as well.
To skip it, pass <tt>instance_predicate: false</tt>.

  Subclass.setting?       # => false

Instances may overwrite the class value in the same way:

  Base.setting = true
  object = Base.new
  object.setting          # => true
  object.setting = false
  object.setting          # => false
  Base.setting            # => true

To opt out of the instance reader method, pass <tt>instance_reader: false</tt>.

  object.setting          # => NoMethodError
  object.setting?         # => NoMethodError

To opt out of the instance writer method, pass <tt>instance_writer: false</tt>.

  object.setting = false  # => NoMethodError

To opt out of both instance methods, pass <tt>instance_accessor: false</tt>.

Source | Google | Stack overflow

Edit

git clone [email protected]:sonic-pi-net/sonic-pi.git

cd sonic-pi

open app/server/ruby/vendor/activesupport-7.0.6/lib/active_support/core_ext/class/attribute.rb

Contribute

# Make a new branch

git checkout -b -your-name--update-docs-Class-class_attribute-for-pr


# Commit to git

git add app/server/ruby/vendor/activesupport-7.0.6/lib/active_support/core_ext/class/attribute.rbgit commit -m "better docs for Class#class_attribute"


# Open pull request

gem install hub # on a mac you can `brew install hub`

hub fork

git push <your name> -your-name--update-docs-Class-class_attribute-for-pr

hub pull-request


# Celebrate!