Class: Github::API::Config

Inherits:

Object

• Object
• Github::API::Config

Defined in:

lib/github_api/api/config.rb,
lib/github_api/api/config/property.rb,
lib/github_api/api/config/property_set.rb

Overview

A base class for constructing api configuration

Direct Known Subclasses

Configuration

Defined Under Namespace

Classes: Property, PropertySet

Class Attribute Summary

• .property_set ⇒ Object readonly

  Returns the value of attribute property_set.

Class Method Summary

• .inherited(descendant) ⇒ Object
• .property(name, options = {}) ⇒ self

  Defines a property on an object’s class or instance.

• .property?(name) ⇒ Boolean

  Check if property is defined.

• .property_names ⇒ Object
• .update_subclasses(name, options) ⇒ Object

Instance Method Summary

• #call(&block) ⇒ self private

  Provide access to properties.

• #fetch(value = nil) ⇒ Hash[Symbol]

  Fetch all the properties and their values.

• #initialize(&block) ⇒ Config constructor

  A new instance of Config.

• #property_names ⇒ Object

Constructor Details

#initialize(&block) ⇒ Config

Returns a new instance of Config.

# File 'lib/github_api/api/config.rb', line 64

def initialize(&block)
  super(&block)
end

Class Attribute Details

.property_set ⇒ Object (readonly)

Returns the value of attribute property_set.

# File 'lib/github_api/api/config.rb', line 52

def property_set
  @property_set
end

Class Method Details

.inherited(descendant) ⇒ Object

# File 'lib/github_api/api/config.rb', line 57

def self.inherited(descendant)
  super
  (@subclasses ||= Set.new) << descendant
  descendant.instance_variable_set('@property_set',
    PropertySet.new(descendant, self.property_set.properties.dup))
end

.property(name, options = {}) ⇒ self

Defines a property on an object’s class or instance

Examples:

class Configuration < Api::Config
  property :adapter, default: :net_http
  property :user, required: true
end

Parameters:

• name (Symbol) —

  the name of a property

• options (#to_hash) (defaults to: {}) —

  the extra options

Returns:

• (self)

# File 'lib/github_api/api/config.rb', line 27

def self.property(name, options = {})
  self.property_set << Property.new(name, options)
  update_subclasses(name, options)
  self
end

.property?(name) ⇒ Boolean

Check if property is defined

Parameters:

• name (Symbol) —

  the name to check

Returns:

• (Boolean)

# File 'lib/github_api/api/config.rb', line 47

def self.property?(name)
  property_set.include?(name)
end

.property_names ⇒ Object

# File 'lib/github_api/api/config.rb', line 72

def self.property_names
  property_set.properties.map(&:name)
end

.update_subclasses(name, options) ⇒ Object

# File 'lib/github_api/api/config.rb', line 33

def self.update_subclasses(name, options)
  if defined?(@subclasses) && @subclasses
    @subclasses.each { |klass| klass.property(name, options) }
  end
end

Instance Method Details

#call(&block) ⇒ self

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Provide access to properties

Examples:

config.call do |config|
  config.adapter = :net_http
end

Returns:

• (self)

# File 'lib/github_api/api/config.rb', line 99

def call(&block)
  block.call(self) if block_given?
  self
end

#fetch(value = nil) ⇒ Hash[Symbol]

Fetch all the properties and their values

Returns:

• (Hash[Symbol])

# File 'lib/github_api/api/config.rb', line 81

def fetch(value = nil)
  if value
    self.class.property_set[value]
  else
    self.class.property_set.to_hash
  end
end

#property_names ⇒ Object

# File 'lib/github_api/api/config.rb', line 68

def property_names
  self.class.property_set.properties.map(&:name)
end