module Tennpipes::Generators::Actions

Common actions needed to support project and component generation.

Public Class Methods

included(base) click to toggle source
# File lib/tennpipes-init/generators/actions.rb, line 15
def self.included(base)
  base.extend(ClassMethods)
end

Public Instance Methods

already_exists?(name, project_name = nil) click to toggle source

Returns true if constant name already exists.

# File lib/tennpipes-init/generators/actions.rb, line 218
def already_exists?(name, project_name = nil)
  project_name = project_name ? (Object.const_get(project_name) rescue nil) : nil
  Object.const_defined?(name) || (project_name && project_name.const_defined?(name))
end
app_skeleton(app, tiny=false) click to toggle source

Generates standard and tiny applications within a project.

@param [String] app

Name of application.

@param [Boolean] tiny

Boolean to generate a tiny structure.

@example

app_skeleton 'some_app'
app_skeleton 'sub_app', true
# File lib/tennpipes-init/generators/actions.rb, line 493
def app_skeleton(app, tiny=false)
  directory('app/', destination_root(app))
  if tiny
    template 'templates/controller.rb.tt', destination_root(app, 'controllers.rb')
    @helper_name = DEFAULT_HELPER_NAME
    template 'templates/helper.rb.tt', destination_root(app, 'helpers.rb')
    @short_name = 'notifier'
    template 'templates/mailer.rb.tt', destination_root(app, 'mailers.rb')
  else
    empty_directory destination_root(app, 'controllers')
    empty_directory destination_root(app, 'helpers')
    empty_directory destination_root(app, 'views')
    empty_directory destination_root(app, 'views', 'layouts')
  end
end
apply_component_for(choice, component) click to toggle source

Returns the related module for a given component and option.

@param [String] choice

The name of the component module.

@param [Symbol] component

The type of the component module.

@example

apply_component_for('rr', :mock)
# File lib/tennpipes-init/generators/actions.rb, line 56
def apply_component_for(choice, component)
  # I need to override Thor#apply because for unknow reason :verbose => false break tasks.
  path = File.expand_path(File.dirname(__FILE__) + "/components/#{component.to_s.pluralize}/#{choice}.rb")
  say_status :apply, "#{component.to_s.pluralize}/#{choice}"
  shell.padding += 1
  instance_eval(File.read(path))
  shell.padding -= 1
end
apply_default_fields(fields) click to toggle source

Apply default field types.

@param [Array<String>] fields

Field names for generators.

@return [Array<String>] fields with default types

# File lib/tennpipes-init/generators/actions.rb, line 247
def apply_default_fields(fields)
  fields.map! { |field| field =~ /:/ ? field : "#{field}:string" }
end
ask(statement, default=nil, color=nil) click to toggle source
Ask something to the user and receives a response.

@param [String] statement
  String of statement to display for input.
@param [String] default
  Default value for input.
@param [String] color
  Name of color to display input.

auto_locale

@return [String] Input value

@example
  ask("What is your name?")
  ask("Path for ruby", "/usr/local/bin/ruby") => "Path for ruby (leave blank for /usr/local/bin/ruby):"
# File lib/tennpipes-init/generators/actions.rb, line 454
def ask(statement, default=nil, color=nil)
  default_text = default ? " (leave blank for #{default}):" : nil
  say("#{statement}#{default_text} ", color)
  result = $stdin.gets.strip
  result.blank? ? default : result
end
check_app_existence(app) click to toggle source

Raise SystemExit if the app does not exist.

@param [String] app

Directory name of application.

@example

check_app_existence 'app'
# File lib/tennpipes-init/generators/actions.rb, line 470
def check_app_existence(app)
  unless File.exist?(destination_root(app))
    say
    say "================================================================="
    say "Unable to locate '#{app.underscore.camelize}' application        "
    say "================================================================="
    say
    raise SystemExit
  end
end
destination_root(*paths) click to toggle source

Returns the root for this Thor class (also aliased as destination root).

@param [Array<String>] paths

The relative path from destination root.

@return [String] The full path

@example

destination_root('config/boot.rb')
# File lib/tennpipes-init/generators/actions.rb, line 204
def destination_root(*paths)
  File.expand_path(File.join(@destination_stack.last, paths))
end
empty_directory_with_keep_file(destination, config = {}) click to toggle source

Creates an empty directory with .keep file

# File lib/tennpipes-init/generators/actions.rb, line 539
def empty_directory_with_keep_file(destination, config = {})
  empty_directory(destination, config)
  keep_file(destination)
end
execute_component_setup(component, choice) click to toggle source

Performs the necessary generator for a given component choice.

@param [Symbol] component

The type of component module.

@param [String] choice

The name of the component module choice.

@example

execute_component_setup(:mock, 'rr')
# File lib/tennpipes-init/generators/actions.rb, line 38
def execute_component_setup(component, choice)
  return true && say_status(:skipping, "#{component} component...") if choice.to_s == 'none'
  say_status(:applying, "#{choice} (#{component})...")
  apply_component_for(choice, component)
  send("setup_#{component}") if respond_to?("setup_#{component}")
end
fetch_app_name(app='app') click to toggle source

Returns the app_name for the application at root.

@param [String] app

folder name of application.

@return [String] class name for application.

@example

fetch_app_name('subapp')
# File lib/tennpipes-init/generators/actions.rb, line 291
def fetch_app_name(app='app')
  app_path = destination_root(app, 'app.rb')
  @app_name ||= File.read(app_path).scan(/class\s(.*?)\s</).flatten[0]
end
fetch_component_choice(component) click to toggle source

Returns the component choice stored within the .component file of an application.

@param [Symbol] component

The type of component module.

@return [String] Name of the component module.

@example

fetch_component_choice(:mock)
# File lib/tennpipes-init/generators/actions.rb, line 95
def fetch_component_choice(component)
  retrieve_component_config(destination_root('.components'))[component]
end
fetch_project_name(app='app') click to toggle source

Returns the namespace for the project.

@param [String] app

folder name of application.

@return [String] namespace for application.

@example

fetch_project_name
# File lib/tennpipes-init/generators/actions.rb, line 261
      def fetch_project_name(app='app')
        app_path = destination_root(app, 'app.rb')
        @project_name = fetch_component_choice(:namespace) if @project_name.empty?
        @project_name ||= begin
          say "Autodetecting project namespace using folder name.", :red
          say ""
          detected_namespace = File.basename(destination_root('.')).gsub(/\W/, '_').camelize
          say(<<-WARNING, :red)
From v0.11.0 on, applications should have a `namespace` setting
in their .components file. Please include a line like the following
in your .components file:
WARNING
          say "\t:namespace: #{detected_namespace}", :yellow
          say ""

          detected_namespace
        end
      end
in_app_root?() click to toggle source

Returns true if inside a Tennpipes application.

# File lib/tennpipes-init/generators/actions.rb, line 211
def in_app_root?
  File.exist?(destination_root('config/boot.rb'))
end
include_component_module_for(component, choice=nil) click to toggle source

Includes the component module for the given component and choice. It determines the choice using .components file.

@param [Symbol] component

The type of component module.

@param [String] choice

The name of the component module.

@example

include_component_module_for(:mock)
include_component_module_for(:mock, 'rr')
# File lib/tennpipes-init/generators/actions.rb, line 78
def include_component_module_for(component, choice=nil)
  choice = fetch_component_choice(component) unless choice
  return false if choice.to_s == 'none'
  apply_component_for(choice, component)
end
initializer(name, data=nil) click to toggle source

Registers and creates initializer.

@param [Symbol] name

Name of the initializer.

@param [String] data

Text to generate into the initializer file.

@example

initializer(:test, "some stuff here")
#=> generates 'lib/test_init.rb'
# File lib/tennpipes-init/generators/actions.rb, line 378
def initializer(name, data=nil)
  @_init_name, @_init_data = name, data
  register = data.present? ? "    register #{name.to_s.underscore.camelize}Initializer\n" : "    register #{name}\n"
  inject_into_file destination_root("/app/app.rb"), register, :after => "Tennpipes::Application\n"
  template "templates/initializer.rb.tt", destination_root("/lib/#{name}_initializer.rb") if data.present?
end
inject_into_file(destination, *args, &block) click to toggle source

Avoids editing destination file if it does not exist.

Calls superclass method
# File lib/tennpipes-init/generators/actions.rb, line 21
def inject_into_file(destination, *args, &block)
  destination_path = Pathname.new(destination).absolute? ? destination : destination_root(destination)
  return unless File.exist?(destination_path)
  super
end
insert_hook(include_text, where) click to toggle source

Inserts an hook before or after load in our boot.rb.

@param [String] include_text

Text to include into hooks in boot.rb.

@param [Symbol] where

method hook to call from Tennpipes, i.e :after_load, :before_load.

@example

insert_hook("DataMapper.finalize", :after_load)
# File lib/tennpipes-init/generators/actions.rb, line 348
def insert_hook(include_text, where)
  inject_into_file('config/boot.rb', "  #{include_text}\n", :after => "Tennpipes.#{where} do\n")
end
insert_into_gemfile(name, options={}) click to toggle source

Inserts a required gem into the Gemfile to add the bundler dependency.

@param [String] name

Name of gem to insert into Gemfile.

@param [Hash] options

Options to generate into Gemfile for gem.

@example

insert_into_gemfile(name)
insert_into_gemfile(name, :group => 'test', :require => 'foo')
insert_into_gemfile(name, :group => 'test', :version => ">1.2.3")
# File lib/tennpipes-init/generators/actions.rb, line 327
def insert_into_gemfile(name, options={})
  after_pattern = options[:group] ? "#{options[:group].to_s.capitalize} requirements\n" : "Component requirements\n"
  version       = options.delete(:version)
  gem_options   = options.map { |k, v| k.to_s == 'require' && [true,false].include?(v) ? ":#{k} => #{v}" : ":#{k} => '#{v}'" }.join(", ")
  write_option  = gem_options.present? ? ", #{gem_options}" : ''
  write_version = version.present? ? ", '#{version}'" : ''
  include_text  = "gem '#{name}'" << write_version << write_option << "\n"
  inject_into_file('Gemfile', include_text, :after => after_pattern)
end
insert_middleware(include_text, app=nil) click to toggle source

Inserts a middleware inside app.rb.

@param [String] include_text

Text to include into hooks in boot.rb.

@example

insert_middleware(ActiveRecord::ConnectionAdapters::ConnectionManagement)
# File lib/tennpipes-init/generators/actions.rb, line 361
def insert_middleware(include_text, app=nil)
  name = app || (options[:name].present? ? @app_name.downcase : 'app')
  inject_into_file("#{name}/app.rb", "    use #{include_text}\n", :after => "Tennpipes::Application\n")
end
invalid_fields(fields) click to toggle source

Returns the field with an unacceptable name(for symbol) else returns nil.

@param [Array<String>] fields

Field names for generators.

@return [Array<String>] array of invalid fields

@example

invalid_fields ['foo:bar', 'hello:world']
# File lib/tennpipes-init/generators/actions.rb, line 234
def invalid_fields(fields)
  results = fields.select { |field| field.split(":").first =~ /\W/ }
  results.empty? ? nil : results
end
keep_file(destination) click to toggle source

Creates an empty .keep file

# File lib/tennpipes-init/generators/actions.rb, line 547
def keep_file(destination)
  create_file("#{destination}/.keep")
end
middleware(name, source) click to toggle source

Creates and inserts middleware. @param [Symbol, String] name

Name of the middleware.

@param [String] source

Text to generate into the middleware file.

@example

middleware(:hello, "class Hello\nend")
#=> generates 'lib/hello_middleware.rb'
# File lib/tennpipes-init/generators/actions.rb, line 396
def middleware(name, source)
  create_file destination_root("lib/#{name}_middleware.rb"), source
  insert_middleware name.to_s.underscore.camelize
end
recognize_path() click to toggle source

Recognizes the path of application.

# File lib/tennpipes-init/generators/actions.rb, line 532
def recognize_path
  options[:app] == '.' ? '/..' : '/../..'
end
require_contrib(contrib) click to toggle source

Insert the regired gem and add in boot.rb custom contribs.

@param [String] contrib

name of library from tennpipes-contrib

@example

require_contrib('auto_locale')
# File lib/tennpipes-init/generators/actions.rb, line 410
def require_contrib(contrib)
  insert_into_gemfile 'tennpipes-contrib'
  contrib = "require '" + File.join("tennpipes-contrib", contrib) + "'\n"
  inject_into_file destination_root("/config/boot.rb"), contrib, :before => "\nTennpipes.load!"
end
require_dependencies(*gem_names) click to toggle source

Adds all the specified gems into the Gemfile for bundler.

@param [Array<String>] gem_names

Splat of gems to require in Gemfile.

@param [Hash] options

The options to pass to gem in Gemfile.

@example

require_dependencies('active_record')
require_dependencies('mocha', 'bacon', :group => 'test')
require_dependencies('json', :version => ">=1.2.3")
# File lib/tennpipes-init/generators/actions.rb, line 309
def require_dependencies(*gem_names)
  options = gem_names.extract_options!
  gem_names.reverse_each { |lib| insert_into_gemfile(lib, options) }
end
resolve_valid_choice(component) click to toggle source

Prompts the user if necessary until a valid choice is returned for the component.

@param [Symbol] component

The type of component module.

@return [String] Name of component if valid, otherwise ask for valid choice.

@example

resolve_valid_choice(:mock)
# File lib/tennpipes-init/generators/actions.rb, line 147
def resolve_valid_choice(component)
  available_string = self.class.available_choices_for(component).join(", ")
  choice = options[component]
  until valid_choice?(component, choice)
    say("Option for --#{component} '#{choice}' is not available.", :red)
    choice = ask("Please enter a valid option for #{component} (#{available_string}):")
  end
  choice
end
retrieve_component_config(target) click to toggle source

Loads the component config back into a hash.

@param [String] target

Path to component config file.

@return [Hash] Loaded YAML file.

@example

retrieve_component_config(...)
# => { :mock => 'rr', :test => 'riot', ... }
# File lib/tennpipes-init/generators/actions.rb, line 132
def retrieve_component_config(target)
  YAML.load_file(target)
end
run_bundler() click to toggle source

Run the bundler.

# File lib/tennpipes-init/generators/actions.rb, line 433
def run_bundler
  say 'Bundling application dependencies using bundler...', :yellow
  in_root { run 'bundle install' }
end
store_component_choice(key, value) click to toggle source

Set the component choice in the .component file of the application.

@param [Symbol] key

The type of component module.

@param [Symbol] value

The name of the component module.

@return [Symbol] The name of the component module.

@example

store_component_choice(:renderer, :haml)
# File lib/tennpipes-init/generators/actions.rb, line 112
def store_component_choice(key, value)
  path        = destination_root('.components')
  config      = retrieve_component_config(path)
  config[key] = value
  create_file(path, :force => true) { config.to_yaml }
  value
end
store_component_config(destination) click to toggle source

Creates a component_config file at the destination containing all component options. Content is a YAMLized version of a hash containing component name mapping to chosen value.

@param [String] destination

The file path to store the component config.

@example

store_component_config('/foo/bar')
# File lib/tennpipes-init/generators/actions.rb, line 184
def store_component_config(destination)
  components = @_components || options
  create_file(destination) do
    self.class.component_types.inject({}) { |result, comp|
      result[comp] = components[comp].to_s; result
    }.to_yaml
  end
end
test?() click to toggle source

Return true if our project has test component.

# File lib/tennpipes-init/generators/actions.rb, line 419
def test?
  fetch_component_choice(:test).to_s != 'none'
end
tiny?() click to toggle source

Return true if we have a tiny skeleton.

# File lib/tennpipes-init/generators/actions.rb, line 426
def tiny?
  File.exist?(destination_root('app/controllers.rb'))
end
valid_choice?(component, choice) click to toggle source

Returns true if the option passed is a valid choice for component.

@param [Symbol] component

The type of component module.

@param [String] choice

The name of the component module.

@return [Boolean] Boolean of whether the choice is valid.

@example

valid_choice?(:mock, 'rr')
# File lib/tennpipes-init/generators/actions.rb, line 170
def valid_choice?(component, choice)
  choice.present? && self.class.available_choices_for(component).include?(choice.to_sym)
end
valid_constant?(name) click to toggle source

Ensure that project name is valid, else raise an NameError.

@param [String] name

Name of project.

@return [Exception] Exception with error message if not valid.

@example

valid_constant '1235Stuff'
valid_constant '#Abc'
# File lib/tennpipes-init/generators/actions.rb, line 521
def valid_constant?(name)
  if name =~ /^\d/
    raise ::NameError, "Project name #{name} cannot start with numbers"
  elsif name =~ /^\W/
    raise ::NameError, "Project name #{name} cannot start with non-word character"
  end
end