dm-visualizer 0.1.0

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

@@ -0,0 +1,15 @@
+class Post
+
+  include DataMapper::Resource
+
+  property :id, Serial
+
+  property :title, String
+
+  property :body, Text
+
+  belongs_to :user
+
+  has 0..n, :comments
+
+end

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

@@ -0,0 +1,11 @@
+class User
+
+  include DataMapper::Resource
+
+  property :id, Serial
+
+  property :name, String
+
+  has 0..n, :posts
+
+end

data/spec/project_examples.rb

@@ -0,0 +1,19 @@
+require 'dm-visualizer/project'
+
+shared_examples_for "a Ruby project" do
+  it "should add the include directories to the $LOAD_PATH" do
+    @project.activate!
+
+    @project.include_dirs.all? { |dir|
+      $LOAD_PATH.include?(dir)
+    }.should == true
+  end
+
+  it "should remove the include directories to the $LOAD_PATH" do
+    @project.deactivate!
+
+    @project.include_dirs.all? { |dir|
+      $LOAD_PATH.include?(dir)
+    }.should == false
+  end
+end

data/spec/project_spec.rb

@@ -0,0 +1,47 @@
+require 'dm-visualizer/project'
+
+require 'spec_helper'
+require 'helpers/project'
+require 'project_examples'
+
+describe DataMapper::Visualizer::Project do
+  include Helpers::Project
+
+  context "library" do
+    before(:all) do
+      @dir = project_dir('library')
+      @project = DataMapper::Visualizer::Project.new(
+        :include => [File.join(@dir,'lib')],
+        :require => ['blog']
+      )
+    end
+
+    it_should_behave_like "a Ruby project"
+
+    it "should require the specified paths" do
+      @project.load!
+
+      Object.const_defined?('Blog').should == true
+    end
+  end
+
+  context "rails" do
+    before(:all) do
+      @dir = project_dir('rails')
+      @project = DataMapper::Visualizer::Project.new(
+        :include => [@dir],
+        :require_all => ['app/models/*.rb']
+      )
+    end
+
+    it_should_behave_like "a Ruby project"
+
+    it "should require all paths that match the specified glob patterns" do
+      @project.load!
+
+      Object.const_defined?('User').should == true
+      Object.const_defined?('Post').should == true
+      Object.const_defined?('Comment').should == true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+
+gem 'rspec', '~> 1.3.0'
+
+require 'spec'
+require 'dm-visualizer/version'

data/spec/visualization_spec.rb

@@ -0,0 +1,92 @@
+require 'dm-visualizer/visualization'
+
+require 'spec_helper'
+require 'helpers/project'
+
+describe DataMapper::Visualizer::Visualization do
+  include Helpers::Project
+
+  it "should detect which inflector DataMapper is using" do
+    DataMapper::Visualizer::Visualization::Inflector.should_not be_nil
+  end
+
+  describe "defaults" do
+    before(:all) do
+      @vis = DataMapper::Visualizer::Visualization.new(
+        :include => [File.join(project_dir('library'),'lib')],
+        :require => ['blog']
+      )
+    end
+
+    it "should return the class names of Classes" do
+      @vis.class_name(Blog::User).should == 'User'
+    end
+
+    it "should return the class names of Objects" do
+      @vis.class_name(Blog::Post.body).should == 'Property'
+    end
+
+    it "should return the names of properties" do
+      @vis.property_name(Blog::Post.body).should == 'body'
+    end
+
+    it "should return the names of models" do
+      @vis.model_name(Blog::User).should == 'User'
+    end
+  end
+
+  describe "repository names" do
+    before(:all) do
+      @vis = DataMapper::Visualizer::Visualization.new(
+        :include => [File.join(project_dir('library'),'lib')],
+        :require => ['blog'],
+        :repository_names => {:default => 'blogdb'}
+      )
+    end
+
+    it "should map the DataMapper repository names" do
+      @vis.model_repository_name(Blog::User).should == 'blogdb'
+    end
+  end
+
+  describe "Schema naming convention" do
+    before(:all) do
+      @vis = DataMapper::Visualizer::Visualization.new(
+        :include => [File.join(project_dir('library'),'lib')],
+        :require => ['blog'],
+        :repository_names => {:default => 'blogdb'},
+        :naming => :schema
+      )
+    end
+
+    it "should return the database and table names for a model name" do
+      @vis.model_name(Blog::User).should == 'blogdb.blog_users'
+    end
+  end
+
+  describe "full names" do
+    before(:all) do
+      @vis = DataMapper::Visualizer::Visualization.new(
+        :include => [File.join(project_dir('library'),'lib')],
+        :require => ['blog'],
+        :full_names => true
+      )
+    end
+
+    it "should not demodulize the names of Classes" do
+      @vis.class_name(Blog::User).should == 'Blog::User'
+    end
+
+    it "should not demodulize the names of Objects" do
+      @vis.class_name(Blog::Post.body).should == 'DataMapper::Property'
+    end
+
+    it "should not demodulize property type names" do
+      @vis.property_type_name(Blog::Post.body).should == 'DataMapper::Types::Text'
+    end
+
+    it "should not demodulize model names" do
+      @vis.model_name(Blog::User).should == 'Blog::User'
+    end
+  end
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification 
+name: dm-visualizer
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Postmodern
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-27 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ruby-graphviz
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 47
+        segments: 
+        - 0
+        - 9
+        - 10
+        version: 0.9.10
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 51
+        segments: 
+        - 0
+        - 10
+        - 2
+        version: 0.10.2
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 35
+        segments: 
+        - 0
+        - 13
+        - 4
+        version: 0.13.4
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 5
+        - 3
+        version: 0.5.3
+  type: :development
+  version_requirements: *id005
+description: DataMapper Visualizer is both a library and a command-line utility for visualizing the Models, Properties and Relationships defined in a DataMapper based Ruby project.
+email: postmodern.mod3@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+files: 
+- .gitignore
+- .specopts
+- .yardopts
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- dm-visualizer.gemspec
+- lib/dm-visualizer.rb
+- lib/dm-visualizer/graphviz.rb
+- lib/dm-visualizer/project.rb
+- lib/dm-visualizer/rake/graphviz_task.rb
+- lib/dm-visualizer/rake/rails/graphviz_task.rb
+- lib/dm-visualizer/rake/rails/tasks.rb
+- lib/dm-visualizer/rake/task.rb
+- lib/dm-visualizer/visualization.rb
+- spec/dm_visualizer_spec.rb
+- spec/helpers/project.rb
+- spec/helpers/projects/library/lib/blog.rb
+- spec/helpers/projects/library/lib/blog/comment.rb
+- spec/helpers/projects/library/lib/blog/post.rb
+- spec/helpers/projects/library/lib/blog/user.rb
+- spec/helpers/projects/rails/app/models/comment.rb
+- spec/helpers/projects/rails/app/models/post.rb
+- spec/helpers/projects/rails/app/models/user.rb
+- spec/project_examples.rb
+- spec/project_spec.rb
+- spec/spec_helper.rb
+- spec/visualization_spec.rb
+has_rdoc: yard
+homepage: http://github.com/postmodern/dm-visualizer
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Visualizes the Models, Properties and Relationships defined in a DataMapper based Ruby project.
+test_files: 
+- spec/project_spec.rb
+- spec/spec_helper.rb
+- spec/visualization_spec.rb
+- spec/project_examples.rb
+- spec/helpers/project.rb
+- spec/helpers/projects/library/lib/blog.rb
+- spec/helpers/projects/library/lib/blog/post.rb
+- spec/helpers/projects/library/lib/blog/user.rb
+- spec/helpers/projects/library/lib/blog/comment.rb
+- spec/helpers/projects/rails/app/models/post.rb
+- spec/helpers/projects/rails/app/models/user.rb
+- spec/helpers/projects/rails/app/models/comment.rb
+- spec/dm_visualizer_spec.rb