Module: Tennpipes::Generators::Actions::ClassMethods

Defined in:
lib/tennpipes-init/generators/actions.rb

Overview

Class methods for Thor generators to support the generators and component choices.

Instance Method Summary collapse

Instance Method Details

#available_choices_for(component) ⇒ Array<Symbol>

Returns the list of available choices for the given component (including none).

Examples:

available_choices_for :test
=> [:shoulda, :bacon, :riot, :minitest]

Parameters:

  • component (Symbol) —

    The type of the component module.

Returns:

  • (Array<Symbol>) —

    Array of component choices.



624
625
626
 
# File 'lib/tennpipes-init/generators/actions.rb', line 624

def available_choices_for(component)
  @available_choices[component] + [:none]
end

#component_option(name, caption, options = {}) ⇒ Object

Defines a class option to allow a component to be chosen and add to component type list. Also builds the available_choices hash of which component choices are supported.

Examples:

component_option :test, "Testing framework", :aliases => '-t', :choices => [:bacon, :shoulda]

Parameters:

  • name (Symbol) —

    Name of component.

  • caption (String) —

    Description of the component.

  • options (Hash) (defaults to: {}) —

    Additional parameters for component choice.



567
568
569
570
571
572
 
# File 'lib/tennpipes-init/generators/actions.rb', line 567

def component_option(name, caption, options = {})
  (@component_types   ||= []) << name # TODO use ordered hash and combine with choices below
  (@available_choices ||= Hash.new)[name] = options[:choices]
  description = "The #{caption} component (#{options[:choices].join(', ')}, none)"
  class_option name, :default => options[:default] || options[:choices].first, :aliases => options[:aliases], :desc => description
end

#component_types ⇒ Object

Returns the compiled list of component types which can be specified.



608
609
610
 
# File 'lib/tennpipes-init/generators/actions.rb', line 608

def component_types
  @component_types
end

#defines_component_options(options = {}) ⇒ Object

Definitions for the available customizable components.



577
578
579
580
581
582
583
584
585
586
587
588
589
 
# File 'lib/tennpipes-init/generators/actions.rb', line 577

def defines_component_options(options = {})
  [
    [ :orm,        'database engine',    { :aliases => '-d', :default => :none }],
    [ :test,       'testing framework',  { :aliases => '-t', :default => :none }],
    [ :mock,       'mocking library',    { :aliases => '-m', :default => :none }],
    [ :script,     'javascript library', { :aliases => '-s', :default => :none }],
    [ :renderer,   'template engine',    { :aliases => '-e', :default => :none }],
    [ :stylesheet, 'stylesheet engine',  { :aliases => '-c', :default => :none }]
  ].each do |name, caption, opts|
    opts[:default] = '' if options[:default] == false
    component_option name, caption, opts.merge(:choices => Dir["#{File.dirname(__FILE__)}/components/#{name.to_s.pluralize}/*.rb"].map{|lib| File.basename(lib, '.rb').to_sym})
  end
end

#require_arguments! ⇒ Object

Tell Tennpipes that for this Thor::Group it is a necessary task to run.



594
595
596
 
# File 'lib/tennpipes-init/generators/actions.rb', line 594

def require_arguments!
  @require_arguments = true
end

#require_arguments? ⇒ Boolean

Return true if we need an arguments for our Thor::Group.

Returns:

  • (Boolean) 


601
602
603
 
# File 'lib/tennpipes-init/generators/actions.rb', line 601

def require_arguments?
  @require_arguments
end