module EpubForge::Action::SharedActionInterface
Public Instance Methods
desc( usage, description, options = {} )
click to toggle source
eventually replace description
Calls superclass method
# File lib/epubforge/action/action.rb, line 44 def desc( usage, description, options = {} ) verbose = defined?(EpubForge::Action::Character) && self == EpubForge::Action::Character puts "--------------IN DESC()----------------" if verbose puts self.method_options.inspect if verbose self.command_to_action_classes[usage] = self super( usage, description, options ) puts self.method_options.inspect if verbose puts "--------------END DESC()----------------" if verbose end
include_standard_options()
click to toggle source
# File lib/epubforge/action/action.rb, line 93 def include_standard_options method_option :verbose, :type => :boolean, :default => false, :aliases => "-v" method_option :debug, :type => :boolean, :default => false, :aliases => "--dbg" method_option :help, :type => :boolean, :default => false, :aliases => "-h" method_option :project, :type => :string, :default => nil, :aliases => "--proj" end
project_not_required()
click to toggle source
Most actions require – nay, demand! – a project to act upon. Add the line ‘project_not_required’ to the class definition to keep it from failing out if it can’t find an existing project. Used for things like initializing new projects, or… my imagination fails me.
# File lib/epubforge/action/action.rb, line 89 def project_not_required @project_required = false end
project_required?()
click to toggle source
def keyword( k = nil )
@keyword = k unless k.nil? @keyword
end
def usage( str = nil )
@usage = str if str @usage
end
# File lib/epubforge/action/action.rb, line 79 def project_required? @project_required = true if @project_required.nil? @project_required end