dm-visualizer 0.1.0

data/lib/dm-visualizer/rake/graphviz_task.rb

@@ -0,0 +1,67 @@
+require 'dm-visualizer/rake/task'
+require 'dm-visualizer/graphviz'
+
+module DataMapper
+  module Visualizer
+    module Rake
+      class GraphVizTask < Task
+
+        # The relational diagram GraphViz visualizer
+        attr_reader :relational
+
+        # The schema diagram GraphViz visualizer
+        attr_reader :schema
+
+        #
+        # Creates a new `dm:doc:graphviz` task.
+        #
+        # @param [Hash] options
+        #   Additional options.
+        #
+        # @yield [task]
+        #   The given block will be passed the newly created task.
+        #
+        # @yieldparam [GraphVizTask] task
+        #   The new GraphViz task.
+        #
+        # @see GraphViz.new
+        #
+        def initialize(options={})
+          @relational = GraphViz.new(options.merge(
+            :naming => :relational,
+            :file => 'doc/relational_diagram'
+          ))
+
+          @schema = GraphViz.new(options.merge(
+            :naming => :schema,
+            :file => 'doc/schema_diagram'
+          ))
+
+          super
+        end
+
+        #
+        # Defines the `dm:doc:graphviz` namespace.
+        #
+        def define
+          super do
+            namespace :graphviz do
+              desc 'Generates a GraphViz relational diagram of the DataMapper Models'
+              task :relational do
+                @relational.visualize!
+              end
+
+              desc 'Generates a GraphViz schema diagram of the DataMapper Models'
+              task :schema do
+                @schema.visualize!
+              end
+            end
+
+            task :graphviz => ['graphviz:relational', 'graphviz:schema']
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/dm-visualizer/rake/rails/graphviz_task.rb

@@ -0,0 +1,16 @@
+require 'dm-visualizer/rake/rails/tasks'
+require 'dm-visualizer/rake/graphviz_task'
+
+module DataMapper
+  module Visualizer
+    module Rake
+      module Rails
+        class GraphVizTask < Rake::GraphVizTask
+
+          include Tasks
+
+        end
+      end
+    end
+  end
+end

data/lib/dm-visualizer/rake/rails/tasks.rb

@@ -0,0 +1,24 @@
+module DataMapper
+  module Visualizer
+    module Rake
+      module Rails
+        module Tasks
+          #
+          # Overrides the Rake `task` method to make sure every defined
+          # task depends on `dm:load_models`.
+          #
+          # @param [Array] arguments
+          #   The arguments of the task.
+          #
+          def task(*arguments)
+            if arguments.first.kind_of?(Hash)
+              super(*arguments)
+            else
+              super(arguments.first => 'db:load_models')
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dm-visualizer/rake/task.rb

@@ -0,0 +1,34 @@
+require 'rake'
+
+module DataMapper
+  module Visualizer
+    module Rake
+      class Task < ::Rake::TaskLib
+        #
+        # Creates a new task.
+        #
+        # @yield [task]
+        #   The given block will be passed the newly created task.
+        #   
+        # @yieldparam [Task] task
+        #   The new Task.
+        #
+        def initialize(options={})
+          yield self if block_given?
+
+          define()
+        end
+
+        #
+        # Defines a task within the `dm:doc` namespace.
+        #
+        def define(&block)
+          namespace :dm do
+            namespace(:doc,&block)
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/dm-visualizer/visualization.rb

@@ -0,0 +1,204 @@
+require 'dm-visualizer/project'
+
+require 'dm-core'
+
+module DataMapper
+  module Visualizer
+    #
+    # The base class for all visualizations.
+    #
+    class Visualization
+
+      # The inflector to use
+      Inflector = if Object.const_defined?('ActiveSupport')
+                    ActiveSupport::Inflector
+                  else
+                    Extlib::Inflection
+                  end
+
+      # The project that will be visualized
+      attr_reader :project
+
+      # Mapping of DataMapper repository names and their actual names.
+      attr_reader :repository_names
+
+      # Specifies which naming convention to use
+      # (`:relational` or `:schema`).
+      attr_accessor :naming
+
+      # Specifies whether to demodulize class names.
+      attr_accessor :full_names
+
+      #
+      # 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.
+      #
+      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
+
+      #
+      # 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.
+      #
+      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
+
+      #
+      # Returns the name of a given property.
+      #
+      # @param [DataMapper::Property] property
+      #   The property.
+      #
+      # @return [String]
+      #   The property name.
+      #
+      def property_name(property)
+        property.name.to_s
+      end
+
+      #
+      # Returns the name the given foreign key.
+      #
+      # @param [Symbol] key
+      #   The foreign key.
+      #
+      # @return [String]
+      #   The foreign key name.
+      #
+      def foreign_key_name(key)
+        key = key.to_s
+
+        key.chomp!('_id') unless @naming == :schema
+        return key
+      end
+
+      #
+      # Returns the type name of a property.
+      #
+      # @param [DataMapper::Property] property
+      #   The property.
+      #
+      # @return [String]
+      #   The property type name.
+      #
+      def property_type_name(property)
+        class_name(property.type || property.class)
+      end
+
+      #
+      # Returns the repository name of a model.
+      #
+      # @param [DataMapper::Model] model
+      #   The model.
+      #
+      # @return [String]
+      #   The repository name.
+      #
+      def model_repository_name(model)
+        @repository_names[model.default_repository_name]
+      end
+
+      #
+      # Returns the name of a model.
+      #
+      # @param [DataMapper::Model] model
+      #   The model.
+      #
+      # @return [String]
+      #   The name of the model.
+      #
+      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
+
+      #
+      # Loads the project and visualizes it.
+      #
+      # @param [Array] arguments
+      #   Additional arguments to pass to {#visualize}.
+      #
+      def visualize!(*arguments)
+        @project.load!
+
+        visualize(*arguments)
+      end
+
+      protected
+
+      #
+      # Default method which visualizes the DataMapper models, properties
+      # and relationships.
+      #
+      # @param [Project] project
+      #   The project to visualize.
+      #
+      def visualize
+      end
+
+    end
+  end
+end

data/spec/dm_visualizer_spec.rb

@@ -0,0 +1,9 @@
+require 'dm-visualizer'
+
+require 'spec_helper'
+
+describe DataMapper::Visualizer do
+  it "should define a VERSION constant" do
+    DataMapper::Visualizer.const_defined?('VERSION').should == true
+  end
+end

data/spec/helpers/project.rb

@@ -0,0 +1,9 @@
+module Helpers
+  module Project
+    PROJECTS_DIR = File.expand_path(File.join(File.dirname(__FILE__),'projects'))
+
+    def project_dir(name)
+      File.join(PROJECTS_DIR,name)
+    end
+  end
+end

data/spec/helpers/projects/library/lib/blog.rb

@@ -0,0 +1,3 @@
+require 'blog/user'
+require 'blog/post'
+require 'blog/comment'

data/spec/helpers/projects/library/lib/blog/comment.rb

@@ -0,0 +1,17 @@
+require 'blog/post'
+
+require 'dm-core'
+
+module Blog
+  class Comment
+
+    include DataMapper::Resource
+
+    property :id, Serial
+
+    property :body, Text
+
+    belongs_to :post
+
+  end
+end

data/spec/helpers/projects/library/lib/blog/post.rb

@@ -0,0 +1,21 @@
+require 'blog/user'
+
+require 'dm-core'
+
+module Blog
+  class Post
+
+    include DataMapper::Resource
+
+    property :id, Serial
+
+    property :title, String
+
+    property :body, Text
+
+    belongs_to :user
+
+    has 0..n, :comments
+
+  end
+end

data/spec/helpers/projects/library/lib/blog/user.rb

@@ -0,0 +1,17 @@
+require 'blog/post'
+
+require 'dm-core'
+
+module Blog
+  class User
+
+    include DataMapper::Resource
+
+    property :id, Serial
+
+    property :name, String
+
+    has 0..n, :posts
+
+  end
+end

data/spec/helpers/projects/rails/app/models/comment.rb

@@ -0,0 +1,11 @@
+class Comment
+
+  include DataMapper::Resource
+
+  property :id, Serial
+
+  property :body, Text
+
+  belongs_to :post
+
+end