Class: Nanoc::CLI::Commands::ShowPlugins

Inherits:
Nanoc::CLI::CommandRunner show all
Defined in:
lib/nanoc/cli/commands/show-plugins.rb

Constant Summary

PLUGIN_CLASS_ORDER =
[
  Nanoc::Filter,
  Nanoc::Extra::VCS,
  Nanoc::DataSource,
  Nanoc::Extra::Deployer
]
PLUGIN_CLASSES =
{
  Nanoc::Filter          => 'Filters',
  Nanoc::DataSource      => 'Data Sources',
  Nanoc::Extra::VCS      => 'VCSes',
  Nanoc::Extra::Deployer => 'Deployers'
}

Instance Method Summary (collapse)

Methods inherited from Nanoc::CLI::CommandRunner

#call, call, #debug?, #in_site_dir?, #load_site, #require_site, #site

Instance Method Details

- (Object) run



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# File 'lib/nanoc/cli/commands/show-plugins.rb', line 13

def run
  # Check arguments
  if arguments.size != 0
    raise Nanoc::Errors::GenericTrivial, "usage: #{command.usage}"
  end

  # Get list of plugins (before and after)
  plugins_before = Nanoc::Plugin.all
  site.code_snippets if site
  plugins_after  = Nanoc::Plugin.all

  # Divide list of plugins into builtin and custom
  plugins_builtin = plugins_before
  plugins_custom  = plugins_after - plugins_before

  # Find max identifiers length
  plugin_with_longest_identifiers = plugins_after.reduce do |longest, current|
    longest[:identifiers].join(', ').size > current[:identifiers].join(', ').size ? longest : current
  end
  max_identifiers_length = plugin_with_longest_identifiers[:identifiers].join(', ').size

  PLUGIN_CLASS_ORDER.each do |superclass|
    plugins_with_this_superclass = {
      builtin: plugins_builtin.select { |p| p[:superclass] == superclass },
      custom: plugins_custom.select  { |p| p[:superclass] == superclass }
    }

    # Print kind
    kind = name_for_plugin_class(superclass)
    puts "#{kind}:"
    puts

    # Print plugins organised by subtype
    [:builtin, :custom].each do |type|
      # Find relevant plugins
      relevant_plugins = plugins_with_this_superclass[type]

      # Print type
      puts "  #{type}:"
      if relevant_plugins.empty?
        puts '    (none)'
        next
      end

      # Print plugins
      relevant_plugins.sort_by { |k| k[:identifiers].join(', ') }.each do |plugin|
        # Display
        puts format(
          "    %-#{max_identifiers_length}s (%s)",
          plugin[:identifiers].join(', '),
          plugin[:class].to_s.sub(/^::/, '')
        )
      end
    end

    puts
  end
end