Class: Parlour::Plugin Abstract

Inherits:

Object

• Object
• Parlour::Plugin

Extended by:

T::Helpers, T::Sig

Defined in:

lib/parlour/plugin.rb

Overview

This class is abstract.

The base class for user-defined RBI generation plugins.

Constant Summary

@@registered_plugins =

{}

Class Method Summary

• .inherited(new_plugin) ⇒ void

  Called automatically by the Ruby interpreter when Plugin is subclassed.

• .registered_plugins ⇒ {String, Plugin}

  Returns all registered plugins, as a hash of their paths to the Plugin instances themselves.

• .run_plugins(plugins, generator) ⇒ void

  Runs an array of plugins on a given generator instance.

Instance Method Summary

• #generate(root) ⇒ void abstract

  Plugin subclasses should redefine this method and do their RBI generation inside it.

Class Method Details

.inherited(new_plugin) ⇒ void

This method returns an undefined value.

Called automatically by the Ruby interpreter when Parlour::Plugin is subclassed. This registers the new subclass into registered_plugins.

Parameters:

• new_plugin (Plugin) —

  The new plugin.

# File 'lib/parlour/plugin.rb', line 27

def self.inherited(new_plugin)
  registered_plugins[T.must(new_plugin.name)] = new_plugin.new
end

.registered_plugins ⇒ {String, Plugin}

Returns all registered plugins, as a hash of their paths to the Parlour::Plugin instances themselves.

Returns:

• ({String, Plugin})

# File 'lib/parlour/plugin.rb', line 17

def self.registered_plugins
  @@registered_plugins
end

.run_plugins(plugins, generator) ⇒ void

This method returns an undefined value.

Runs an array of plugins on a given generator instance.

Parameters:

• plugins (Array<Plugin>) —

  An array of Parlour::Plugin instances.

• generator (RbiGenerator) —

  The RbiGenerator to run the plugins on.

# File 'lib/parlour/plugin.rb', line 37

def self.run_plugins(plugins, generator)
  plugins.each do |plugin|
    generator.current_plugin = plugin
    plugin.generate(generator.root)
  end
end

Instance Method Details

#generate(root) ⇒ void

This method is abstract.

This method returns an undefined value.

Plugin subclasses should redefine this method and do their RBI generation inside it.

Parameters:

• root (RbiGenerator::Namespace) —

  The root RbiGenerator::Namespace.

# File 'lib/parlour/plugin.rb', line 51

def generate(root); end