umlify 0.3.3 → 0.6.1

data/README.md

@@ -0,0 +1,114 @@
+                            _ _  __
+                           | (_)/ _|
+            _   _ _ __ ___ | |_| |_ _   _
+           | | | | '_ ` _ \| | |  _| | | |
+           | |_| | | | | | | | | | | |_| |
+            \__,_|_| |_| |_|_|_|_|  \__, |
+                                     __/ |
+                                    |___/
+
+            umlify is a tool that creates
+          uml class diagrams from your code
+
+         <https://github.com/mikaa123/umlify>
+
+Introduction
+------------
+
+umlify takes your ruby project's source code and creates an uml class diagram out of it.
+
+Installation
+------------
+
+    gem install umlify
+
+How to use
+----------
+
+1. Go to your gem project directory
+2. type: `umlify lib/*/*`
+3. Open uml.html
+
+Example
+-------
+
+Here is umlify umlified:
+
+![umlify's uml](http://img43.imageshack.us/img43/2756/umlify.png)
+
+Features
+--------
+
+* __new__ now supports inhertiance (v0.4.2)
+* supports associations (see "How to add associations to a diagram)
+* supports methods and instance variables
+
+How it works
+------------
+
+umlify parses your source codes using regular expressions to build an uml
+diagram using [yUML](http://yuml.me/)'s api.
+
+Note: Regexps parsing is really dirty. This point needs serious
+improvement
+
+On dynamic languages
+--------------------
+
+Ruby's extreme decoupling and duck-typing philosophy doesn't judge a class by its hierarchy.
+Thus, variables don't have a predefined type, which conflicts with uml's static typed object-model.
+The objective of this project isn't to bend uml's model to make it semantically comply with
+duck typing (by the use of interfaces, or other tricks), but to add a basic visual representation
+of the code of your project for documenting and helping maintainers.
+
+How to add associations to a diagram
+------------------------------------
+
+Because of the above point, there's no direct way to automatically draw associations between your
+classes. However, if you want an association to be shown on your diagram simply add an annotation
+on top of an `attr_accessor`, such as:
+
+    # type: Unicorn
+    attr_accessor :animal
+
+Contribute
+----------
+
+If you are interested by this project (I hope you are!), you can send me your comments
+(mikaa123 at gmail), test the application and create some issue when you find a bug.
+
+If you want to contribute, you can check the TODO, it's a good place to start. :)
+Just fork and send a pull request. I'd love to have some help.
+
+Not having the expected results?
+--------------------------------
+
+If you have found a bug, or if the results you obtained don't correspond
+to your code, you can raise an issue and link to your github project
+page.
+
+Real project testing is way more efficient than on test cases. :)
+
+License
+-------
+
+Copyright (C) 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
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+

data/lib/umlify/diagram.rb

@@ -17,17 +17,20 @@ module Umlify
     end
 
     # Adds the given statement to the @diagram array
+    # Statement can either be a String or an UmlClass
     def add statement
       # TODO: Add some sort of validation
 
       @statements << statement if statement.is_a? String
       if statement.is_a? UmlClass
 
-        if statement.associations.empty?
-          @statements << statement.to_s
-        else
-          @statements << statement.to_s
+        @statements << statement.to_s
 
+        if statement.parent
+          @statements << "[#{statement.parent}]^[#{statement.name}]"
+        end
+
+        unless statement.associations.empty?
           statement.associations.each do |name, type|
             @statements << "[#{statement.name}]-#{name}>[#{type}]"
           end
@@ -36,9 +39,9 @@ module Umlify
       end
     end
 
-    # Dumps the html of the diagram
-    def export
-      '<img src="http://yuml.me/diagram/class/'+@statements.join(", ")+'" />'
+    # Returns the yuml.me uri
+    def get_uri
+      uri = '/diagram/class/'+@statements.join(", ")
     end
   end
 end

data/lib/umlify/parser.rb

@@ -26,6 +26,7 @@ module Umlify
       return nil if @source_files.empty?
 
       @source_files.each do |file|
+        puts "processing #{file}..."
         f = File.open file, 'r'
         (parse_file f).each {|c| @classes << c}
         f.close
@@ -43,11 +44,18 @@ module Umlify
       file.each do |line|
 
         # This parses the classes
-        line.match(/^\s*class ([\w]*)\b/) do |m|
+        line.match(/^\s*class ([\w]*)\b[\s]*$/) do |m|
           current_class = UmlClass.new m[1]
           classes_in_file << current_class
         end
 
+        # This parses the classes and its parent (class Foo < Bar)
+        line.match(/^\s*class ([\w]*) < ([\w]*)\b/) do |m|
+          current_class = UmlClass.new m[1]
+          current_class.parent = m[2]
+          classes_in_file << current_class
+        end
+
         if current_class
 
           # This parses the @variables
@@ -65,8 +73,8 @@ module Umlify
 
           # This adds an association to the current class, using the type_annotation
           # if type_annotation has been set
-          line.match(/attr_accessor :([\w]*)\b/) do |m|
-            current_class.associations[m[1]] = type_annotation
+          line.match(/(attr_accessor|attr_reader|attr_writer) :([\w]*)\b/) do |m|
+            current_class.associations[m[2]] = type_annotation
             type_annotation = nil
           end if type_annotation
 

data/lib/umlify/runner.rb

@@ -1,4 +1,5 @@
 require 'optparse'
+require 'net/http'
 
 module Umlify
 
@@ -28,7 +29,7 @@ module Umlify
       if @args[0][0] == '-'
 
         OptionParser.new do |opts|
-          opts.banner = "Usage: umlify [option]"
+          opts.banner = "Usage: umlify [option] [source-files directory]"
           opts.on("-h", "--help",  "Shows this") do
             puts opts
           end
@@ -36,37 +37,33 @@ module Umlify
 
       else
         puts "umlifying"
-        if files = get_files_from_dir(@args[0])
-          puts "about to parse..."
-          @parser = Parser.new files
 
-          if classes = @parser.parse_sources!
-            @diagram = Diagram.new
+        @parser = Parser.new @args
 
-            @diagram.create do
-              classes.each {|c| add c}
-            end
+        if classes = @parser.parse_sources!
+          @diagram = Diagram.new
 
-            File.open("uml.html", 'w') do |file|
-              file << @diagram.export
-            end
+          @diagram.create do
+            classes.each {|c| add c}
+          end
+
+          puts "Downloading the image from yUML, it shouldn't be long."
 
-            puts "Saved in uml.html"
-          else
-            puts "No ruby files in the directory"
+          image = Net::HTTP.start("yuml.me", 80) do |http|
+            http.get(URI.escape(@diagram.get_uri))
           end
 
+          File.open('uml.png', 'wb') do |file|
+            file << image.body
+          end if image
+
+          puts "Saved in uml.png"
         else
-          puts "empty directory"
+          puts "No ruby files in the directory"
         end
-      end
 
-    end
-
-    private
+      end
 
-    def get_files_from_dir directory
-      Dir[directory] unless Dir[directory].empty?
     end
   end
 end

data/lib/umlify/uml_class.rb

@@ -4,7 +4,7 @@ module Umlify
   # Represent a parsed uml class
   #
   class UmlClass
-    attr_accessor :name, :variables, :methods, :associations
+    attr_accessor :name, :variables, :methods, :associations, :parent
 
     def initialize name
       @name = name

data/lib/umlify/version.rb

@@ -1,3 +1,3 @@
 module Umlify
-  VERSION = "0.3.3"
+  VERSION = "0.6.1"
 end

data/lib/umlify.rb

@@ -1,3 +1,35 @@
+#                            _ _  __
+#                           | (_)/ _|
+#            _   _ _ __ ___ | |_| |_ _   _
+#           | | | | '_ ` _ \| | |  _| | | |
+#           | |_| | | | | | | | | | | |_| |
+#            \__,_|_| |_| |_|_|_|_|  \__, |
+#                                     __/ |
+#                                    |___/
+#
+#
+# umlify is tool that generates uml from your ruby source files. It
+# works using yUML.me web api.
+#
+# 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
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+
 require 'umlify/version'
 require 'umlify/runner'
 require 'umlify/parser'

data/test/diagram_test.rb

@@ -50,17 +50,31 @@ class DiagramTest < Test::Unit::TestCase
       assert @diagram.statements.include? '[Unicorn]-chunky>[Bacon]'
     end
 
-    should "export th yUML html"  do
+    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
 
-      assert_equal '<img src="http://yuml.me/diagram/class/[Unicorn|foo_variable|bar_method]" />',
-       @diagram.export
+      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'
+      test_uml_class.variables << 'foo_variable'
+      test_uml_class.methods << 'bar_method'
+
+      @diagram.create do
+        add test_uml_class
+      end
+
+      assert_equal '/diagram/class/[Unicorn|foo_variable|bar_method]',
+       @diagram.get_uri
     end
 
   end

data/test/parser_test.rb

@@ -27,6 +27,14 @@ class ParserTest < Test::Unit::TestCase
       assert_equal 'AClassName', @p.parse_file(test)[0].name
     end
 
+    should "parse class name of inherited classes" do
+      test = <<-END_FILE
+      class AClassName < SuperClass
+      end
+      END_FILE
+      assert_equal 'AClassName', @p.parse_file(test)[0].name
+    end
+
     should "parse @variables in classes" do
       test = <<-END_FILE
       class Bar
@@ -56,6 +64,57 @@ class ParserTest < Test::Unit::TestCase
       assert_equal "FooBar", bar.associations['unicorn']
     end
 
+    should "parse attr_reader when preceeded by a # type: Type annotation" do
+      test = <<-END_FILE
+      class Bar
+
+        # type: FooBar
+        attr_reader :unicorn
+
+        def foo
+        end
+      end
+      END_FILE
+      bar = @p.parse_file(test)[0]
+      assert_instance_of Umlify::UmlClass, bar
+      assert_equal "FooBar", bar.associations['unicorn']
+    end
+
+
+    should "parse attr_writer when preceeded by a # type: Type annotation" do
+      test = <<-END_FILE
+      class Bar
+
+        # type: FooBar
+        attr_writer :unicorn
+
+        def foo
+        end
+      end
+      END_FILE
+      bar = @p.parse_file(test)[0]
+      assert_instance_of Umlify::UmlClass, bar
+      assert_equal "FooBar", bar.associations['unicorn']
+    end
+
+    should "parse inherited classes" do
+      test = <<-END_FILE
+        class Bar < Hash
+
+          def initialize
+          end
+
+          def save
+          end
+
+        end
+      end
+      END_FILE
+      bar = @p.parse_file(test)[0]
+      assert_instance_of Umlify::UmlClass, bar
+      assert_equal "Hash", bar.parent
+    end
+
     should "return an array of UmlClasses when the parsing is done" do
       p = Umlify::Parser.new Dir[File.dirname(__FILE__)+'/fixtures/*']
       parsed_classes = p.parse_sources!

metadata

@@ -2,7 +2,7 @@
 name: umlify
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.3.3
+  version: 0.6.1
 platform: ruby
 authors: 
 - Michael Sokol
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-02 00:00:00 -05:00
+date: 2011-03-04 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -24,7 +24,7 @@ extra_rdoc_files: []
 
 files: 
 - Rakefile
-- README
+- README.md
 - bin/umlify
 - lib/umlify.rb
 - lib/umlify/version.rb

data/README

@@ -1,19 +0,0 @@
-                            _ _  __
-                           | (_)/ _|
-            _   _ _ __ ___ | |_| |_ _   _
-           | | | | '_ ` _ \| | |  _| | | |
-           | |_| | | | | | | | | | | |_| |
-            \__,_|_| |_| |_|_|_|_|  \__, |
-                                     __/ |
-                                    |___/
-
-            umlify is a tool that creates
-          uml class diagrams from your code
-
-         <https://github.com/mikaa123/umlify>
-
-
-Introduction
-------------
-
-umlify takes your project's source code and creates an uml class diagram out of it.