Class: Jets::Commands::Base

Inherits:
Thor
  • Object
show all
Extended by:
Memoist
Defined in:
lib/jets/commands/base.rb

Direct Known Subclasses

Clean, Clean::Log, Db, Dynamodb, Dynamodb::Migrate, Import, Main

Class Method Summary collapse

Class Method Details

.autocomplete(full_command) ⇒ Object

If this fails to find a match then return the original full command



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/jets/commands/base.rb', line 132

def autocomplete(full_command)
  return nil if full_command.nil? # jets help

  eager_load!

  words = full_command.split(':')
  namespace = words[0..-2].join(':') if words.size > 1
  command = words.last

  # Thor's normalize_command_name autocompletes the command but then we need to add the namespace back
  begin
    thor_subclass = klass_from_namespace(namespace) # could NameError
    command = thor_subclass.normalize_command_name(command) # could Thor::AmbiguousCommandError
    [namespace, command].compact.join(':')
  rescue NameError
    full_command # return original full_command
  rescue Thor::AmbiguousCommandError => e
    puts "Unable to autodetect the command name. #{e.message}."
    full_command # return original full_command
  end
end

Use Jets banner instead of Thor to account for namespaces in commands.



91
92
93
94
95
96
97
 
# File 'lib/jets/commands/base.rb', line 91

def banner(command, namespace = nil, subcommand = false)
  namespace = namespace_from_class(self)
  command_name = command.usage # set with desc when defining tht Thor class
  namespaced_command = [namespace, command_name].compact.join(':')

  "jets #{namespaced_command}"
end

.dispatch(command, given_args, given_opts, config) ⇒ Object

Hacky way to handle error for ‘jets new’ when no project name is passed in to avoid this error:

required arguments 'project_name' (Thor::RequiredArgumentMissingError)



34
35
36
37
38
39
 
# File 'lib/jets/commands/base.rb', line 34

def dispatch(command, given_args, given_opts, config)
  if given_args.reject{|s| s =~ /^-/} == ['new'] # user forgot to pass a project name
    given_args = ['help', 'new']
  end
  super
end

.eager_load! ⇒ Object

Useful for help menu when we need to have all the definitions loaded. Using constantize instead of require so we dont care about order. The eager load actually uses autoloading.



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/jets/commands/base.rb', line 57

def eager_load!
  base_path = File.expand_path("../../", __FILE__)
  Dir.glob("#{base_path}/commands/**/*.rb").select do |path|
    next if !File.file?(path) or path =~ /templates/ or path =~ %r{/markdown/}

    class_name = path
                  .sub(/\.rb$/,'')
                  .sub(%r{.*/jets/commands}, 'jets/commands')
                  .classify
    class_name.sub!(/Task$/, "Tasks") # special rule here for Tasks class
    # NOTE: Weird thing where Jets::Commands::Db::Task => Thor::Command
    # because Task is a class available to Thor I believe.
    # puts "eager_load! loading path: #{path} class_name: #{class_name}" if ENV['JETS_DEBUG']
    class_name.constantize # dont have to worry about order.
  end
end

.help_list(all = false) ⇒ Object 



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/jets/commands/base.rb', line 104

def help_list(all=false)
  # hack to show hidden comands when requested
  Thor::HiddenCommand.class_eval do
    def hidden?; false; end
  end if all

  list = []
  eager_load!
  subclasses.each do |klass|
    commands = klass.printable_commands(true, false)
    commands.reject! { |array| array[0].include?(':help') }
    list += commands
  end

  list.sort_by! { |array| array[0] }
end

.inherited(base) ⇒ Object 



46
47
48
49
50
51
52
 
# File 'lib/jets/commands/base.rb', line 46

def inherited(base)
  super

  if base.name
    self.subclasses << base
  end
end

.klass_from_namespace(namespace) ⇒ Object 



121
122
123
124
125
126
127
128
129
 
# File 'lib/jets/commands/base.rb', line 121

def klass_from_namespace(namespace)
  if namespace.nil?
    Jets::Commands::Main
  else
    class_name = namespace.gsub(':','/')
    class_name = "Jets::Commands::#{class_name.classify}"
    class_name.constantize
  end
end

.namespace_from_class(klass) ⇒ Object 



99
100
101
102
 
# File 'lib/jets/commands/base.rb', line 99

def namespace_from_class(klass)
  namespace = klass.to_s.sub('Jets::Commands::', '').underscore.gsub('/',':')
  namespace unless namespace == "main"
end

.namespaced_commands ⇒ Object

Fully qualifed task names. Examples:

build
process:controller
dynamodb:migrate:down



79
80
81
82
83
84
85
86
87
88
 
# File 'lib/jets/commands/base.rb', line 79

def namespaced_commands
  eager_load!
  subclasses.map do |klass|
    klass.all_tasks.keys.map do |task_name|
      klass = klass.to_s.sub('Jets::Commands::','')
      namespace = klass =~ /^Main/ ? nil : klass.underscore.gsub('/',':')
      [namespace, task_name].compact.join(':')
    end
  end.flatten.sort
end

.perform(full_command, thor_args) ⇒ Object

thor_args is an array of commands. Examples:

["help"]
["dynamodb:migrate"]

Same signature as RakeCommand.perform. Not using full_command.



25
26
27
28
 
# File 'lib/jets/commands/base.rb', line 25

def perform(full_command, thor_args)
  config = {} # doesnt seem like config is used
  dispatch(nil, thor_args, nil, config)
end

.subclasses ⇒ Object

Track all command subclasses.



42
43
44
 
# File 'lib/jets/commands/base.rb', line 42

def subclasses
  @subclasses ||= []
end