Parent

Object

Files

DataMapper::Visualizer::Visualization

The base class for all visualizations.

Constants

Inflector

The inflector to use

Attributes

full_names[RW]

Specifies whether to demodulize class names.

naming[RW]

Specifies which naming convention to use (`:relational` or `:schema`).

project[R]

The project that will be visualized

repository_names[R]

Mapping of DataMapper repository names and their actual names.

Public Class Methods

new(options={}) click to toggle source

Initializes a new visualization.

@param [Hash] options

Additional options.

@option options [Hash] :repository_names

The actual names of the DataMapper repositories.

@option options [String] :repository_name

The actual name to use for the `:default` DataMappe repository.

@option options [Symbol] :naming

The naming convention to use. May be either `:relational` or
`:schema`.

@option options [Boolean] :full_names

Specifies whether to demodulize class names.
# File lib/dm-visualizer/visualization.rb, line 51
def initialize(options={})
  @project = Project.new(options)

  @repository_names = {}
  @naming = :relational
  @full_names = false

  if options[:repository_names]
    options[:repository_names].each do |name,db_name|
      @repository_names[name.to_sym] = db_name.to_s
    end
  end

  if options[:repository_name]
    @database_names[:default] = options[:repository_name].to_s
  end

  if options[:naming]
    @naming = options[:naming].to_sym
  end

  if options.has_key?(:full_names)
    @full_names  = options[:full_names]
  end
end

Public Instance Methods

class_name(obj) click to toggle source

Returns the class name of a given object.

@param [Class, Object] obj

The object or class.

@return [String]

The class name of the object or class.
# File lib/dm-visualizer/visualization.rb, line 86
def class_name(obj)
  name = if (obj.class == Class || obj.class == Module)
           obj.name
         else
           obj.class.name
         end

  name = Inflector.demodulize(name) unless @full_names

  return name
end
foreign_key_name(key) click to toggle source

Returns the name the given foreign key.

@param [Symbol] key

The foreign key.

@return [String]

The foreign key name.
# File lib/dm-visualizer/visualization.rb, line 120
def foreign_key_name(key)
  key = key.to_s

  key.chomp!('_id') unless @naming == :schema
  return key
end
model_name(model) click to toggle source

Returns the name of a model.

@param [DataMapper::Model] model

The model.

@return [String]

The name of the model.
# File lib/dm-visualizer/visualization.rb, line 162
def model_name(model)
  if @naming == :schema
    name = model_repository_name(model)
    storage_name = model.storage_names[:default]
    storage_name ||= NamingConventions::Resource::UnderscoredAndPluralized.call(model.name)

    if name
      "#{name}.#{storage_name}"
    else
      storage_name
    end
  else
    class_name(model)
  end
end
model_repository_name(model) click to toggle source

Returns the repository name of a model.

@param [DataMapper::Model] model

The model.

@return [String]

The repository name.
# File lib/dm-visualizer/visualization.rb, line 149
def model_repository_name(model)
  @repository_names[model.default_repository_name]
end
property_name(property) click to toggle source

Returns the name of a given property.

@param [DataMapper::Property] property

The property.

@return [String]

The property name.
# File lib/dm-visualizer/visualization.rb, line 107
def property_name(property)
  property.name.to_s
end
property_type_name(property) click to toggle source

Returns the type name of a property.

@param [DataMapper::Property] property

The property.

@return [String]

The property type name.
# File lib/dm-visualizer/visualization.rb, line 136
def property_type_name(property)
  class_name(property.type || property.class)
end
visualize!(*arguments) click to toggle source

Loads the project and visualizes it.

@param [Array] arguments

Additional arguments to pass to {#visualize}.
# File lib/dm-visualizer/visualization.rb, line 184
def visualize!(*arguments)
  @project.load!

  visualize(*arguments)
end

Protected Instance Methods

visualize() click to toggle source

Default method which visualizes the DataMapper models, properties and relationships.

@param [Project] project

The project to visualize.
# File lib/dm-visualizer/visualization.rb, line 199
def visualize
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.