Padrino::Generators::Components::Actions

Public Instance Methods

controller_actions(fields) click to toggle source

For Controller action generation Takes in fields for routes in the form of get:index post:test delete:yada and such

@param [Array<String>] fields

Array of controller actions and route name

@example

controller_actions "get:index", "post:test"o

@api private

# File lib/padrino-gen/generators/components/actions.rb, line 185
def controller_actions(fields)
  field_tuples = fields.map { |value| value.split(":") }
  action_declarations = field_tuples.map do |request, name|
    "#{request} :#{name} do\n  end\n"
  end
  action_declarations.join("\n  ")
end
indent_spaces(count) click to toggle source

Returns space characters of given count

@example

indent_spaces(2)

@api private

# File lib/padrino-gen/generators/components/actions.rb, line 171
def indent_spaces(count)
  ' ' * count
end
insert_mocking_include(library_name, options={}) click to toggle source

For mocking components Injects the mock library include into the test class in test_config for setting up mock gen

@param [String] library_name

name of mocking library

@param [Hash] options

Additional options to pass into injection

@example

insert_mock_library_include('Mocha::API')
=> inject_into_file("test/test_config.rb", "  include Mocha::API\n", :after => /class.*?\n/)

@api private

# File lib/padrino-gen/generators/components/actions.rb, line 158
def insert_mocking_include(library_name, options={})
  options.reverse_merge!(:indent => 2, :after => /class.*?\n/, :path => "test/test_config.rb")
  return unless File.exist?(destination_root(options[:path]))
  include_text = indent_spaces(2) + "include #{library_name}\n"
  inject_into_file(options[:path], include_text, :after => options[:after])
end
insert_test_suite_setup(suite_text, options={}) click to toggle source

For testing components Injects the test class text into the test_config file for setting up the test gen

@param [String] suite_text

Class name for test suite

@param [Hash] options

Additional options to pass into injection

@example

insert_test_suite_setup('...CLASS_NAME...')
=> inject_into_file("test/test_config.rb", TEST.gsub(/CLASS_NAME/, @app_name), :after => "set :environment, :test")

@api private

# File lib/padrino-gen/generators/components/actions.rb, line 140
def insert_test_suite_setup(suite_text, options={})
  options.reverse_merge!(:path => "test/test_config.rb")
  create_file(options[:path], suite_text.gsub(/CLASS_NAME/, @app_name))
end
migration_exist?(filename) click to toggle source

Return true if the migration already exist

@param [String] filename

File name of the migration file

@param [Boolean] Boolean if file exists

@api private

# File lib/padrino-gen/generators/components/actions.rb, line 106
def migration_exist?(filename)
  Dir[destination_root("db/migrate/*_#{filename.underscore}.rb")].size > 0
end
output_migration_file(filename, name, columns, options={}) click to toggle source

For orm database components Generates a standalone migration file based on the given options and columns

@param [String] filename

File name of model migration

@param [String] name

Name of model

@param [Array<String>] columns

Array of column names and property type

@param [Hash] options

Additional migration options, e.g { :base "...text...", :change_format => "...text...",
                                    :add => proc { |field, kind| "add_column :#{table_name}, :#{field}, :#{kind}" },
                                    :remove => proc { |field, kind| "remove_column :#{table_name}, :#{field}" }

@example

output_migration_file(migration_name, name, columns,
  :base => AR_MIGRATION, :change_format => AR_CHANGE_MG,
  :add => Proc.new { |field, kind| "t.#{kind.underscore.gsub(/_/, '')} :#{field}" },
  :remove => Proc.new { |field, kind| "t.remove :#{field}" }
)

@api private

# File lib/padrino-gen/generators/components/actions.rb, line 64
def output_migration_file(filename, name, columns, options={})
  if behavior == :revoke
    remove_migration(name)
  else
    return if migration_exist?(filename)
    change_format = options[:change_format]
    migration_scan = filename.camelize.scan(/(Add|Remove)(?:.*?)(?:To|From)(.*?)$/).flatten
    direction, table_name = migration_scan[0].downcase, migration_scan[1].downcase.pluralize if migration_scan.any?
    tuples = direction ? columns.map { |value| value.split(":") } : []
    tuples.map! { |field, kind| kind =~ /datetime/ ? [field, 'DateTime'] : [field, kind] } # fix datetime
    add_columns    = tuples.map(&options[:add]).join("\n    ")
    remove_columns = tuples.map(&options[:remove]).join("\n    ")
    forward_text = change_format.gsub(/!TABLE!/, table_name).gsub(/!COLUMNS!/, add_columns) if tuples.any?
    back_text    = change_format.gsub(/!TABLE!/, table_name).gsub(/!COLUMNS!/, remove_columns) if tuples.any?
    contents = options[:base].dup.gsub(/\s{4}!UP!\n/,   (direction == 'add' ? forward_text.to_s : back_text.to_s))
    contents.gsub!(/\s{4}!DOWN!\n/, (direction == 'add' ? back_text.to_s : forward_text.to_s))
    contents = contents.gsub(/!FILENAME!/, filename.underscore).gsub(/!FILECLASS!/, filename.camelize)
    current_migration_number = return_last_migration_number
    contents.gsub!(/!VERSION!/, (current_migration_number + 1).to_s)
    migration_filename = "#{format("%03d", current_migration_number+1)}_#{filename.underscore}.rb"
    create_file(destination_root('db/migrate/', migration_filename), contents, :skip => true)
  end
end
output_model_migration(filename, name, columns, options={}) click to toggle source

For orm database components Generates the model migration file created when generating a new model

@param [String] filename

File name of model migration

@param [String] name

Name of model

@param [Array<String>] columns

Array of column names and property type

@param [Hash] options

Additional migration options, e.g { :base => "....text...", :up => "..text...",
                                    :down => "..text...", column_format => "t.column :#{field}, :#{kind}" }

@example

output_model_migration("AddPerson", "person", ["name:string", "age:integer"],
  :base => AR_MIGRATION,
  :column_format => Proc.new { |field, kind| "t.#{kind.underscore.gsub(/_/, '')} :#{field}" },
  :up => AR_MODEL_UP_MG, :down => AR_MODEL_DOWN_MG)

@api private

# File lib/padrino-gen/generators/components/actions.rb, line 24
def output_model_migration(filename, name, columns, options={})
  if behavior == :revoke
    remove_migration(filename)
  else
    return if migration_exist?(filename)
    model_name = name.to_s.pluralize
    field_tuples = columns.map { |value| value.split(":") }
    field_tuples.map! { |field, kind| kind =~ /datetime/ ? [field, 'DateTime'] : [field, kind] } # fix datetime
    column_declarations = field_tuples.map(&options[:column_format]).join("\n      ")
    contents = options[:base].dup.gsub(/\s{4}!UP!\n/, options[:up]).gsub(/!DOWN!\n/, options[:down])
    contents = contents.gsub(/!NAME!/, model_name.camelize).gsub(/!TABLE!/, model_name.underscore)
    contents = contents.gsub(/!FILENAME!/, filename.underscore).gsub(/!FILECLASS!/, filename.camelize)
    current_migration_number = return_last_migration_number
    contents = contents.gsub(/!FIELDS!/, column_declarations).gsub(/!VERSION!/, (current_migration_number + 1).to_s)
    migration_filename = "#{format("%03d", current_migration_number+1)}_#{filename.underscore}.rb"
    create_file(destination_root('db/migrate/', migration_filename), contents, :skip => true)
  end
end
remove_migration(name) click to toggle source

For the removal of migration files removes the migration file based on the migration name

@param [String] name

File name of the migration

@api private

# File lib/padrino-gen/generators/components/actions.rb, line 117
def remove_migration(name)
  migration_path =  Dir[destination_root('db/migrate/*.rb')].find do |f|
    File.basename(f) =~ /#{name.to_s.underscore}/
  end
  return unless migration_path
  if behavior == :revoke
    create_file migration_path # we use create to reverse the operation of a revoke
  end
end
return_last_migration_number() click to toggle source

For migration files returns the number of the latest(most current) migration file

@api private

# File lib/padrino-gen/generators/components/actions.rb, line 92
def return_last_migration_number
  Dir[destination_root('db/migrate/*.rb')].map { |f|
    File.basename(f).match(/^(\d+)/)[0].to_i
  }.max.to_i || 0
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.