umlify 1.0.0 → 1.2.0

data/README.md

@@ -29,6 +29,9 @@ How to use
 2. type: `umlify lib/*/*`
 3. Open uml.html
 
+If you want umlify to try to guess the types of the associations, use
+`umlify -s lib/*/*` at step 2.
+
 Example
 -------
 
@@ -39,6 +42,7 @@ Here is umlify umlified:
 Features
 --------
 
+* Tries to guess the types of the instance variables (smart mode)
 * __new__ Use RubyParser instead of regular expression as of v1.0.0
 * __new__ supports inhertiance (v0.4.2)
 * supports associations (see "How to add associations to a diagram)
@@ -76,6 +80,19 @@ classes. However, if you want an association to be shown on your diagram simply
       end
     end
 
+Smart mode
+----------
+
+If you use umlify with the `-s` or `--smart` option, it'll try to guess
+the types of the associations based on the name of the instance
+variables.
+
+If you class variable is @duck, then it will try to create an
+association with the "Duck" class, if it exists.
+
+If your variable is @ducks, it will try to create an association with a
+cardinality of '*' with a class called "Duck", if such a class exists.
+
 Contribute
 ----------
 

data/lib/umlify.rb

@@ -11,6 +11,8 @@
 # umlify is tool that generates uml from your ruby source files. It
 # works using yUML.me web api.
 #
+# Copyright 2011 Michael Sokol
+#
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
 # in the Software without restriction, including without limitation the rights

data/lib/umlify/diagram.rb

@@ -1,7 +1,7 @@
 module Umlify
 
   # Creates and store a yUML api string for generating diagram
-  # type of @statements: 1..* String
+  # * type of @statements: 1..* String
   class Diagram
 
     attr_accessor :statements
@@ -12,6 +12,7 @@ module Umlify
 
     def create &blk
       instance_eval &blk
+      self
     end
 
     # Adds the given statement to the @diagram array
@@ -24,8 +25,10 @@ module Umlify
 
         @statements << statement.to_s
 
-        if statement.parent
-          @statements << "[#{statement.parent}]^[#{statement.name}]"
+        if statement.children
+          statement.children.each do |child|
+            @statements << "[#{statement.name}]^[#{child.name}]"
+          end
         end
 
         unless statement.associations.empty?
@@ -42,6 +45,31 @@ module Umlify
       end
     end
 
+    # Sorts the statements array so that
+    # 1. Class definitions
+    # 2. Inheritance
+    # 3. Associations
+    # Otherwise, strange behavior can happen in the downloadd graph
+    def compute!
+      class_def = /\[[\w;?|!]*\]/
+      inheritance = /\[(.*?)\]\^\[(.*?)\]/
+      association = /\[.*\]-.*>\[.*\]/
+
+      @statements.sort! do |x, y|
+
+        if x =~ class_def and y =~ inheritance
+          -1
+        elsif x =~ class_def and y =~ association
+          -1
+        elsif x =~ inheritance and y =~ association
+          -1
+        else
+          1
+        end
+
+      end
+    end
+
     # Returns the yuml.me uri
     def get_uri
       uri = '/diagram/class/'+@statements.join(", ")

data/lib/umlify/extension.rb

@@ -1,3 +1,5 @@
+require 'active_support/inflector'
+
 # Extends the String to add a String#each method so that
 # strings can be read just like files, line-by-line.
 
@@ -10,4 +12,5 @@ class String
     end
 
   end
+
 end

data/lib/umlify/parser_sexp.rb

@@ -4,7 +4,7 @@ module Umlify
 
   # Parses files using S-Expressions given by the RubyParser gem
   #
-  #   type of @classes: 0..* UmlClass
+  #  * type of @classes: 0..* UmlClass
   #
   class ParserSexp
 
@@ -28,7 +28,8 @@ module Umlify
         (parse_file File.read(file)).each {|c| @classes << c}
       end
 
-      @classes
+      # Removes duplicates between variables and associations in the class
+      @classes.each {|c| c.chomp! @classes}
     end
 
     # Parse the given string, and return the parsed classes
@@ -60,8 +61,11 @@ module Umlify
 
       # Searching for a s(:const, :Const) right after the class name, which
       # means the class inherits from a parents class, :Const
-      if class_s_exp[2] and class_s_exp[2][1] and class_s_exp[2][0] == :const
+      if class_s_exp[2] and class_s_exp[2][0] == :const
         uml_class.parent = class_s_exp[2][1].to_s
+      elsif class_s_exp[2] and class_s_exp[2][0] == :colon2
+        # If the parent class belongs to a module
+        uml_class.parent = class_s_exp[2][2].to_s
       end
 
       # Looks-up for instance methods

data/lib/umlify/runner.rb

@@ -1,23 +1,23 @@
 require 'net/http'
+require 'optparse'
 
 module Umlify
 
   # Class to run to execute umlify. It parses the ruby sources provided
   # and generates and save a uml diagram using yUML API.
-  # 
-  #   type of @diagram: Diagram
-  #   type of @args: 0..* String
-  #   type of @parser: ParserSexp
-  #
   class Runner
 
+    attr_reader :smart_mode
+
     # Takes as input an array with file names
     def initialize args
       @args = args
+      @smart_mode = false
     end
 
     # Runs the application
     def run
+      parse_options
 
       if @args.empty?
         puts "Usage: umlify [source directory]"
@@ -29,16 +29,20 @@ module Umlify
         if classes = @parser.parse_sources!
           @diagram = Diagram.new
 
+          if @smart_mode
+            classes.each {|c| c.infer_types! classes}
+          end
+
           @diagram.create do
             classes.each {|c| add c}
-          end
+          end.compute!
 
           puts "Downloading the image from yUML, it shouldn't be long."
 
           image = download_image
           save_to_file image
 
-          puts @diagram.get_uri
+          puts 'http://yuml.me'+@diagram.get_uri
           puts "Saved in uml.png"
         else
           puts "No ruby files in the directory"
@@ -47,6 +51,12 @@ module Umlify
 
     end
 
+    def parse_options
+      OptionParser.new do |opts|
+        opts.on("-s", "--smart") { @smart_mode = true }
+      end.parse! @args
+    end
+
     # Downloads the image of the uml diagram from yUML
     def download_image
       Net::HTTP.start("yuml.me", 80) do |http|

data/lib/umlify/uml_class.rb

@@ -1,8 +1,8 @@
 module Umlify
 
-  # Represent a parsed uml class
+  # Represents a parsed uml class
   class UmlClass
-    attr_accessor :name, :variables, :methods, :associations, :parent
+    attr_accessor :name, :variables, :methods, :associations, :parent, :children
 
     def initialize name
       @name = name
@@ -11,6 +11,37 @@ module Umlify
       @associations = {}
     end
 
+    # Deletes variables from the @variables array if they appear
+    # in an association.
+    # Sets the @children variable
+    def chomp! classes
+      @variables = @variables - @associations.keys unless @associations.nil?
+      @children = classes.select do |c|
+        if c.parent == @name
+          c.parent = nil
+          true
+        end
+      end
+    end
+
+    # Tries to create an association with the attributes in @variables.
+    def infer_types! classes
+      class_names = classes.collect {|c| c.name}
+      @variables.each do |attribute|
+
+        if class_names.include? attribute.classify
+          # A type has match with the attribute's name
+          @associations[attribute] = attribute.classify
+
+          # If it's a plural, adds a cardinality
+          if attribute == attribute.pluralize
+            @associations[attribute+'-n'] = '*'
+          end
+        end
+      end
+      chomp! classes
+    end
+
     def to_s
       '['+@name+'|'+
       @variables.collect{|var| var}.join(";")+'|'+

data/lib/umlify/version.rb

@@ -1,3 +1,3 @@
 module Umlify
-  VERSION = "1.0.0"
+  VERSION = "1.2.0"
 end

data/test/diagram_test.rb

@@ -62,19 +62,19 @@ class DiagramTest < Test::Unit::TestCase
       assert @diagram.statements.include? '[Unicorn]-foo 1..*>[Bar]'
     end
 
-    should "add UmlClass with parent to diagrams"  do
-      test_uml_class = Umlify::UmlClass.new 'Unicorn'
-      test_uml_class.variables << 'foo_variable'
-      test_uml_class.methods << 'bar_method'
-      test_uml_class.parent = "Foo"
+    # should "add UmlClass with parent to diagrams"  do
+    #   test_uml_class = Umlify::UmlClass.new 'Unicorn'
+    #   test_uml_class.variables << 'foo_variable'
+    #   test_uml_class.methods << 'bar_method'
+    #   test_uml_class.parent = "Foo"
 
-      @diagram.create do
-        add test_uml_class
-      end
+    #   @diagram.create do
+    #     add test_uml_class
+    #   end
 
-      assert @diagram.statements.include? '[Unicorn|foo_variable|bar_method]'
-      assert @diagram.statements.include? '[Foo]^[Unicorn]'
-    end
+    #   assert @diagram.statements.include? '[Unicorn|foo_variable|bar_method]'
+    #   assert @diagram.statements.include? '[Foo]^[Unicorn]'
+    # end
 
     should "get the yuml uri"  do
       test_uml_class = Umlify::UmlClass.new 'Unicorn'
@@ -89,6 +89,14 @@ class DiagramTest < Test::Unit::TestCase
        @diagram.get_uri
     end
 
+    should "sort the statements so that the class declarations are first, then
+        the inheritance, then the associations" do
+
+      @diagram.statements = ['[Foo]^[Unicorn]',  '[Unicorn]-foo 1..*>[Bar]', '[Unicorn|foo_variable|bar_method]']
+      @diagram.compute!
+      assert_equal ['[Unicorn|foo_variable|bar_method]', '[Foo]^[Unicorn]', '[Unicorn]-foo 1..*>[Bar]'], @diagram.statements
+    end
+
   end
 end
 

data/test/runner_test.rb

@@ -0,0 +1,19 @@
+require 'shoulda'
+require 'umlify'
+
+class RunnerTest < Test::Unit::TestCase
+
+  context "Runner" do
+
+    should "be in smart mode when passed -s or --smart as an option"  do
+      r = Umlify::Runner.new(["-s"])
+      r.run
+      assert r.smart_mode
+      r = Umlify::Runner.new(["--smart"])
+      r.run
+      assert r.smart_mode
+    end
+
+  end
+end
+

data/test/string_test.rb

@@ -0,0 +1,15 @@
+require 'shoulda'
+require 'umlify'
+
+class StringTest < Test::Unit::TestCase
+
+  context "String" do
+
+    should "should respond to #classify"  do
+      assert_equal "Duck", "ducks".classify
+      assert_equal "PepperoniPizza", "pepperoni_pizzas".classify
+    end
+
+  end
+end
+

data/test/uml_class_test.rb

@@ -0,0 +1,53 @@
+require 'shoulda'
+require 'umlify'
+
+class UmlClassTest < Test::Unit::TestCase
+
+  context "UmlClass" do
+
+    setup do
+      @class = Umlify::UmlClass.new 'Farm'
+      @class.variables = ['ducks', 'some_cows', 'farm_house']
+      @class.associations['ducks'] = 'Duck'
+    end
+
+    should "delete variables from the @variables array if they exist in association" do
+      @class.chomp! []
+      assert_equal false, @class.variables.include?('ducks')
+    end
+
+    should "create a list of children, given all the types available" do
+      foo = Umlify::UmlClass.new "Foo"
+      foo.parent = "Umlify"
+
+      bar = Umlify::UmlClass.new "Bar"
+      bar.parent = "Umlify"
+
+      umlify = Umlify::UmlClass.new "Umlify"
+
+      classes = [foo, bar, umlify]
+      classes.each {|c| c.chomp!(classes)}
+
+      assert umlify.children.include? foo
+      assert umlify.children.include? bar
+      assert_equal nil, foo.parent
+      assert_equal nil, bar.parent
+    end
+
+    should "be able to infer types for associations with the variables in @variables" do
+      classes = [Umlify::UmlClass.new("Foo"), Umlify::UmlClass.new("Bar")]
+      foo_bar = Umlify::UmlClass.new "FooBar"
+      foo_bar.variables = ["foo", "bars", "args"]
+      classes << foo_bar
+
+      foo_bar.infer_types! classes
+
+      assert_equal 'Foo', foo_bar.associations['foo']
+      assert_equal 'Bar', foo_bar.associations['bars']
+      assert_equal '*', foo_bar.associations['bars-n']
+      assert_equal nil, foo_bar.associations['args']
+    end
+
+  end
+end
+

metadata

@@ -2,7 +2,7 @@
 name: umlify
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Michael Sokol
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-06 00:00:00 -05:00
+date: 2011-03-10 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -36,6 +36,9 @@ files:
 - lib/umlify/diagram.rb
 - test/parser_test.rb
 - test/diagram_test.rb
+- test/uml_class_test.rb
+- test/runner_test.rb
+- test/string_test.rb
 - test/parser_sexp_test.rb
 has_rdoc: true
 homepage: https://github.com/mikaa123/umlify
@@ -67,5 +70,8 @@ specification_version: 3
 summary: umlify is a tool that creates class diagrams from your code.
 test_files: 
 - test/parser_test.rb
+- test/uml_class_test.rb
 - test/parser_sexp_test.rb
 - test/diagram_test.rb
+- test/runner_test.rb
+- test/string_test.rb