railroady 1.0.6 → 1.0.7

data/README.rdoc

@@ -1,6 +1,6 @@
 = RailRoady 
 
-RailRoady generates Rails 3 model (AcitveRecord, Mongoid) and controller UML diagrams as cross-platform .svg files, as well as in the DOT language.
+RailRoady generates Rails 3 model (AcitveRecord, Mongoid, Datamapper) and controller UML diagrams as cross-platform .svg files, as well as in the DOT language.
 
 Code is based on the original "railroad" gem, patched and maintained over the years. Lineage can be traced via GitHub.
 

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
 :major: 1
 :minor: 0
-:patch: 6
+:patch: 7
 :build: 

data/lib/railroady/models_diagram.rb

@@ -26,7 +26,7 @@ class ModelsDiagram < AppDiagram
       end
 
     end
-  end 
+  end
 
   def get_files(prefix ='')
     files = !@options.specify.empty? ? Dir.glob(@options.specify) : Dir.glob(prefix << "app/models/**/*.rb")
@@ -38,34 +38,37 @@ class ModelsDiagram < AppDiagram
   # Process a model class
   def process_class(current_class)
     STDERR.puts "Processing #{current_class}" if @options.verbose
-    
-    generated = if defined?(Mongoid::Document) && current_class.new.is_a?(Mongoid::Document)
-      process_mongoid_model(current_class)
-    elsif current_class.respond_to?'reflect_on_all_associations'
-      process_active_record_model(current_class)
-    elsif @options.all && (current_class.is_a? Class)
-      process_basic_class(current_class)
-    elsif @options.modules && (current_class.is_a? Module)
-      process_basic_module(current_class)
-    end
+
+    generated =
+      if defined?(Mongoid::Document) && current_class.new.is_a?(Mongoid::Document)
+        process_mongoid_model(current_class)
+      elsif defined?(DataMapper::Resource) && current_class.new.is_a?(DataMapper::Resource)
+        process_datamapper_model(current_class)
+      elsif current_class.respond_to?'reflect_on_all_associations'
+        process_active_record_model(current_class)
+      elsif @options.all && (current_class.is_a? Class)
+        process_basic_class(current_class)
+      elsif @options.modules && (current_class.is_a? Module)
+        process_basic_module(current_class)
+      end
 
     if @options.inheritance && generated && include_inheritance?(current_class)
       @graph.add_edge ['is-a', current_class.superclass.name, current_class.name]
-    end      
-    
+    end
+
   end # process_class
-  
+
   def include_inheritance?(current_class)
     (defined?(ActiveRecord::Base) && current_class.superclass != ActiveRecord::Base) &&
     (current_class.superclass != Object)
   end
-  
+
   def process_basic_class(current_class)
     node_type = @options.brief ? 'class-brief' : 'class'
     @graph.add_node [node_type, current_class.name]
     true
   end
-  
+
   def process_basic_module(current_class)
     @graph.add_node ['module', current_class.name]
     false
@@ -86,15 +89,15 @@ class ModelsDiagram < AppDiagram
         # http://wiki.rubyonrails.org/rails/pages/MagicFieldNames
         magic_fields = [
         "created_at", "created_on", "updated_at", "updated_on",
-        "lock_version", "type", "id", "position", "parent_id", "lft", 
+        "lock_version", "type", "id", "position", "parent_id", "lft",
         "rgt", "quote", "template"
         ]
-        magic_fields << current_class.table_name + "_count" if current_class.respond_to? 'table_name' 
+        magic_fields << current_class.table_name + "_count" if current_class.respond_to? 'table_name'
         content_columns = current_class.content_columns.select {|c| ! magic_fields.include? c.name}
       else
         content_columns = current_class.content_columns
       end
-      
+
       content_columns.each do |a|
         content_column = a.name
         content_column += ' :' + a.type.to_s unless @options.hide_types
@@ -102,27 +105,69 @@ class ModelsDiagram < AppDiagram
       end
     end
     @graph.add_node [node_type, current_class.name, node_attribs]
-    
+
     # Process class associations
     associations = current_class.reflect_on_all_associations
     if @options.inheritance && ! @options.transitive
       superclass_associations = current_class.superclass.reflect_on_all_associations
-      
-      associations = associations.select{|a| ! superclass_associations.include? a} 
+
+      associations = associations.select{|a| ! superclass_associations.include? a}
       # This doesn't works!
       # associations -= current_class.superclass.reflect_on_all_associations
     end
-    
+
     associations.each do |a|
       process_association current_class.name, a
     end
-    
+
     true
   end
-  
+
+  def process_datamapper_model(current_class)
+    node_attribs = []
+    if @options.brief #|| current_class.abstract_class?
+      node_type = 'model-brief'
+    else
+      node_type = 'model'
+
+      # Collect model's properties
+      props = current_class.properties.sort_by(&:name)
+
+      if @options.hide_magic
+        # From patch #13351
+        # http://wiki.rubyonrails.org/rails/pages/MagicFieldNames
+        magic_fields =
+          ["created_at", "created_on", "updated_at", "updated_on", "lock_version", "_type", "_id",
+           "position", "parent_id", "lft", "rgt", "quote", "template"]
+        props = props.select {|c| !magic_fields.include?(c.name.to_s) }
+      end
+
+      props.each do |a|
+        prop = a.name.to_s
+        prop += ' :' + a.class.name.split('::').last unless @options.hide_types
+        node_attribs << prop
+      end
+    end
+    @graph.add_node [node_type, current_class.name, node_attribs]
+
+    # Process relationships
+    relationships = current_class.relationships
+
+    # TODO: Manage inheritance
+
+    relationships.each do |a|
+      process_datamapper_relationship current_class.name, a
+    end
+
+    true
+  end
+
+
+
+
   def process_mongoid_model(current_class)
     node_attribs = []
-    
+
     if @options.brief
       node_type = 'model-brief'
     else
@@ -141,31 +186,31 @@ class ModelsDiagram < AppDiagram
         ]
         content_columns = content_columns.select {|c| !magic_fields.include?(c.name) }
       end
-      
+
       content_columns.each do |a|
         content_column = a.name
         content_column += " :#{a.type}" unless @options.hide_types
         node_attribs << content_column
       end
     end
-    
+
     @graph.add_node [node_type, current_class.name, node_attribs]
-    
+
     # Process class associations
     associations = current_class.relations.values
-    
+
     if @options.inheritance && !@options.transitive &&
        current_class.superclass.respond_to?(:relations)
       associations -= current_class.superclass.relations.values
     end
-    
+
     associations.each do |a|
       process_association current_class.name, a
     end
-    
+
     true
   end
-  
+
 
   # Process a model association
   def process_association(class_name, assoc)
@@ -175,21 +220,21 @@ class ModelsDiagram < AppDiagram
     macro = assoc.macro.to_s
     return if %w[belongs_to referenced_in].include?(macro) && !@options.show_belongs_to
 
-    #TODO: 
+    #TODO:
     # FAIL: assoc.methods.include?(:class_name)
     # FAIL: assoc.responds_to?(:class_name)
     assoc_class_name = assoc.class_name rescue nil
     assoc_class_name ||= assoc.name.to_s.underscore.singularize.camelize
-    
+
     # Only non standard association names needs a label
-    
+
     # from patch #12384
     # if assoc.class_name == assoc.name.to_s.singularize.camelize
     if assoc_class_name == assoc.name.to_s.singularize.camelize
       assoc_name = ''
     else
       assoc_name = assoc.name.to_s
-    end 
+    end
 
     # Patch from "alpack" to support classes in a non-root module namespace. See: http://disq.us/yxl1v
     if class_name.include?("::") && !assoc_class_name.include?("::")
@@ -207,9 +252,45 @@ class ModelsDiagram < AppDiagram
       return if @habtm.include? [assoc_class_name, class_name, assoc_name]
       assoc_type = 'many-many'
       @habtm << [class_name, assoc_class_name, assoc_name]
-    end  
-    # from patch #12384    
+    end
+    # from patch #12384
     # @graph.add_edge [assoc_type, class_name, assoc.class_name, assoc_name]
-    @graph.add_edge [assoc_type, class_name, assoc_class_name, assoc_name]    
+    @graph.add_edge [assoc_type, class_name, assoc_class_name, assoc_name]
   end # process_association
 end # class ModelsDiagram
+
+  # Process a DataMapper relationship
+  def process_datamapper_relationship(class_name, relation)
+    STDERR.puts "- Processing DataMapper model relationship #{relation.name.to_s}" if @options.verbose
+
+    # Skip "belongs_to" relationships
+    dm_type = relation.class.to_s.split('::')[-2]
+    return if dm_type == 'ManyToOne' && !@options.show_belongs_to
+
+    dm_parent_model = relation.parent_model.to_s
+    dm_child_model = relation.child_model.to_s
+
+    assoc_class_name = ''
+    # Get the assoc_class_name
+    if dm_parent_model.eql?(class_name)
+      assoc_class_name = dm_child_model
+    else
+      assoc_class_name = dm_parent_model
+    end
+
+    # Only non standard association names needs a label
+    assoc_name = ''
+    if !(relation.name.to_s.singularize.camelize.eql?(assoc_class_name.split('::').last))
+      assoc_name = relation.name.to_s
+    end
+
+    # TO BE IMPROVED
+    rel_type = 'many-many' # default value for ManyToOne and ManyToMany
+    if dm_type == 'OneToOne'
+      rel_type = 'one-one'
+    elsif dm_type == 'OneToMany'
+      rel_type = 'one-many'
+    end
+
+    @graph.add_edge [rel_type, class_name, assoc_class_name, assoc_name ]
+  end

data/tasks/railroady.rake

@@ -7,22 +7,27 @@
 #
 # Author: Preston Lee, http://railroady.prestonlee.com 
 
-# Returns an absolute path for the following file.
-def format
-  @@DIAGRAM_FORMAT ||= 'svg'
-end
+# wrap helper methods so they don't conflict w/ methods on Object
+module RailRoady
+  class RakeHelpers
+    def self.format
+      @@DIAGRAM_FORMAT ||= 'svg'
+    end
 
-def full_path(name = 'test.txt')
-  f = File.join(Rails.root.to_s.gsub(' ', '\ '), 'doc', name)
-  f.to_s
+    # Returns an absolute path for the following file.
+    def self.full_path(name = 'test.txt')
+      f = File.join(Rails.root.to_s.gsub(' ', '\ '), 'doc', name)
+      f.to_s
+    end
+  end
 end
 
 namespace :diagram do
 
-  @MODELS_ALL = full_path("models_complete.#{format}").freeze
-  @MODELS_BRIEF = full_path("models_brief.#{format}").freeze
-  @CONTROLLERS_ALL = full_path("controllers_complete.#{format}").freeze
-  @CONTROLLERS_BRIEF = full_path("controllers_brief.#{format}").freeze
+  @MODELS_ALL = RailRoady::RakeHelpers.full_path("models_complete.#{RailRoady::RakeHelpers.format}").freeze
+  @MODELS_BRIEF = RailRoady::RakeHelpers.full_path("models_brief.#{RailRoady::RakeHelpers.format}").freeze
+  @CONTROLLERS_ALL = RailRoady::RakeHelpers.full_path("controllers_complete.#{RailRoady::RakeHelpers.format}").freeze
+  @CONTROLLERS_BRIEF = RailRoady::RakeHelpers.full_path("controllers_brief.#{RailRoady::RakeHelpers.format}").freeze
 
   namespace :models do
 
@@ -30,14 +35,14 @@ namespace :diagram do
     task :complete do
       f = @MODELS_ALL
       puts "Generating #{f}"
-      sh "railroady -ilamM | dot -T#{format} > #{f}"
+      sh "railroady -ilamM | dot -T#{RailRoady::RakeHelpers.format} > #{f}"
     end
 
     desc 'Generates an abbreviated class diagram for all models.'
     task :brief do
       f = @MODELS_BRIEF
       puts "Generating #{f}"
-      sh "railroady -bilamM | dot -T#{format} > #{f}"
+      sh "railroady -bilamM | dot -T#{RailRoady::RakeHelpers.format} > #{f}"
     end
 
   end
@@ -48,14 +53,14 @@ namespace :diagram do
     task :complete do
       f = @CONTROLLERS_ALL
       puts "Generating #{f}"
-      sh "railroady -ilC | neato -T#{format} > #{f}"
+      sh "railroady -ilC | neato -T#{RailRoady::RakeHelpers.format} > #{f}"
     end
 
     desc 'Generates an abbreviated class diagram for all controllers.'
     task :brief do
       f = @CONTROLLERS_BRIEF
       puts "Generating #{f}"
-      sh "railroady -bilC | neato -T#{format} > #{f}"
+      sh "railroady -bilC | neato -T#{RailRoady::RakeHelpers.format} > #{f}"
     end
 
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: railroady
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 1
   - 0
-  - 6
-  version: 1.0.6
+  - 7
+  version: 1.0.7
 platform: ruby
 authors: 
 - Preston Lee
@@ -18,7 +18,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-03 00:00:00 +05:30
+date: 2012-02-28 00:00:00 +05:30
 default_executable: railroady
 dependencies: []