Class: Pry::PluginManager::Plugin

Inherits:

Object

• Object
• Pry::PluginManager::Plugin

show all

Defined in:

lib/pry/plugins.rb

Instance Attribute Summary (collapse)

• - (Object) active (also: #active?)

  Returns the value of attribute active.

• - (Object) enabled (also: #enabled?)

  Returns the value of attribute enabled.

• - (Object) gem_name

  Returns the value of attribute gem_name.

• - (Object) name

  Returns the value of attribute name.

• - (Object) spec

  Returns the value of attribute spec.

Instance Method Summary (collapse)

• - (Object) activate!

  Activate the plugin (require the gem - enables/loads the plugin immediately at point of call, even if plugin is disabled) Does not reload plugin if it's already active.

• - (Object) disable!

  Disable a plugin.

• - (Object) enable!

  Enable a plugin.

• - (Plugin) initialize(name, gem_name, spec, enabled) constructor

  A new instance of Plugin.

• - (Object) load_cli_options

  Load the Command line options defined by this plugin (if they exist).

19
20
21

# File 'lib/pry/plugins.rb', line 19

def initialize(name, gem_name, spec, enabled)
  @name, @gem_name, @enabled, @spec = name, gem_name, enabled, spec
end

17
18
19

# File 'lib/pry/plugins.rb', line 17

def active
  @active
end

17
18
19

# File 'lib/pry/plugins.rb', line 17

def enabled
  @enabled
end

17
18
19

# File 'lib/pry/plugins.rb', line 17

def gem_name
  @gem_name
end

17
18
19

# File 'lib/pry/plugins.rb', line 17

def name
  @name
end

17
18
19

# File 'lib/pry/plugins.rb', line 17

def spec
  @spec
end

44
45
46
47
48
49
50
51
52
53
54
55
56
57

# File 'lib/pry/plugins.rb', line 44

def activate!
  # Create the configuration object for the plugin.
  Pry.config.send("#{gem_name.gsub('-', '_')}=", OpenStruct.new)

  begin
    require gem_name if !active?
  rescue LoadError => e
    warn "Warning: The plugin '#{gem_name}' was not found! (gem found but could not be loaded)"
    warn e
  end

  self.active = true
  self.enabled = true
end

25
26
27

# File 'lib/pry/plugins.rb', line 25

def disable!
  self.enabled = false
end

31
32
33

# File 'lib/pry/plugins.rb', line 31

def enable!
  self.enabled = true
end

36
37
38
39

# File 'lib/pry/plugins.rb', line 36

def load_cli_options
  cli_options_file = File.join(spec.full_gem_path, "lib/#{spec.name}/cli.rb")
  require cli_options_file if File.exists?(cli_options_file)
end