umlify 0.6.1 → 1.0.0

data/README.md

@@ -39,7 +39,8 @@ Here is umlify umlified:
 Features
 --------
 
-* __new__ now supports inhertiance (v0.4.2)
+* __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)
 * supports methods and instance variables
 
@@ -65,11 +66,15 @@ 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:
+classes. However, if you want an association to be shown on your diagram simply annotate your classes such as:
 
-    # type: Unicorn
-    attr_accessor :animal
+    # type of @weapon: Rainbow
+    class Unicorn
+
+      def initialize weapon
+        @weapon = weapon
+      end
+    end
 
 Contribute
 ----------

data/lib/umlify/diagram.rb

@@ -1,11 +1,9 @@
 module Umlify
 
-  ##
   # Creates and store a yUML api string for generating diagram
-  #
+  # type of @statements: 1..* String
   class Diagram
 
-    # Array containing yUML DSL statements
     attr_accessor :statements
 
     def initialize
@@ -32,7 +30,12 @@ module Umlify
 
         unless statement.associations.empty?
           statement.associations.each do |name, type|
-            @statements << "[#{statement.name}]-#{name}>[#{type}]"
+            unless name =~ /-/
+              cardinality = if statement.associations[name+'-n']
+                              ' '+statement.associations[name+'-n']
+                            end
+              @statements << "[#{statement.name}]-#{name}#{cardinality}>[#{type}]"
+            end
           end
         end
 

data/lib/umlify/parser.rb

@@ -1,9 +1,8 @@
 module Umlify
 
-  ##
+  # First version of the ruby parser, using regular expression.
   # Parser is responsible for parsing ruby source files and building an array
   # of uml classes
-  #
   class Parser
 
     # An array containing all the parsed classes

data/lib/umlify/parser_sexp.rb

@@ -0,0 +1,98 @@
+require 'ruby_parser'
+
+module Umlify
+
+  # Parses files using S-Expressions given by the RubyParser gem
+  #
+  #   type of @classes: 0..* UmlClass
+  #
+  class ParserSexp
+
+    # files should be an array containing file names with the correct path
+    def initialize files
+      @files = files
+      @classes = []
+    end
+
+    # Parses the source code of the files in @files
+    # to build uml classes. Returns an array containing all the
+    # parsed classes or nil if no ruby file were found in the
+    # @files array.
+    def parse_sources!
+
+      @source_files = @files.select {|f| f.match /\.rb/}
+      return nil if @source_files.empty?
+
+      @source_files.each do |file|
+        puts "processing #{file}..."
+        (parse_file File.read(file)).each {|c| @classes << c}
+      end
+
+      @classes
+    end
+
+    # Parse the given string, and return the parsed classes
+    def parse_file file_content
+      classes = []
+
+      s_exp = RubyParser.new.parse(file_content)
+
+      if s_exp[0] == :class
+        classes << parse_class(s_exp)
+      else
+        s_exp.each_of_type :class do |a_class|
+          classes << parse_class(a_class)
+        end
+      end
+
+      classes
+    end
+
+    # Creates a UmlClass from a class s-expression
+    def parse_class class_s_exp
+      uml_class = UmlClass.new class_s_exp[1].to_s
+
+      # Let's start by building the associations of the class
+      each_association_for class_s_exp do |variable, type, cardinality|
+        uml_class.associations[variable] = type
+        uml_class.associations[variable+'-n'] = cardinality if cardinality
+      end
+
+      # 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
+        uml_class.parent = class_s_exp[2][1].to_s
+      end
+
+      # Looks-up for instance methods
+      class_s_exp.each_of_type :defn do |instance_method|
+        uml_class.methods << instance_method[1].to_s
+
+        # Now looking for @variables, inside instance methods
+        # I'm looking at assignments such as @var = x
+        instance_method.each_of_type :iasgn do |assignment|
+          if assignment[1] and assignment[1].class == Symbol and assignment[1].to_s =~ /@/
+            variable = assignment[1].to_s.gsub('@', '')
+            uml_class.variables << variable unless uml_class.variables.include? variable
+          end
+        end
+      end
+      uml_class
+    end
+
+    # Yields the variable, the type and the cardinality for each associations
+    def each_association_for a_class
+      if comments = a_class.comments
+        comments.split(/\n/).each do |line|
+          line.match(/type of @([\w]*): ([0-9.\*n]* )?([\w]*)\b/) do |m|
+
+            yield m[1], m[3], (m[2].chop if m[2])
+
+          end
+        end
+      end
+    end
+
+  end
+end
+

data/lib/umlify/runner.rb

@@ -1,44 +1,30 @@
-require 'optparse'
 require 'net/http'
 
 module Umlify
 
-  ###
-  # This class is instanciated and run by the bin file
+  # 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
 
-    # Contains the options from the command line
-    attr_reader :args
-
-    # type: Parser
-    attr_accessor :parser
-
-    # type: Diagram
-    attr_accessor :diagram
-
-    # Takes as input an array with the command line options
+    # Takes as input an array with file names
     def initialize args
       @args = args
     end
 
     # Runs the application
     def run
-      @args.push "-h" if @args.empty?
-
-      if @args[0][0] == '-'
-
-        OptionParser.new do |opts|
-          opts.banner = "Usage: umlify [option] [source-files directory]"
-          opts.on("-h", "--help",  "Shows this") do
-            puts opts
-          end
-        end.parse! @args
 
+      if @args.empty?
+        puts "Usage: umlify [source directory]"
       else
         puts "umlifying"
 
-        @parser = Parser.new @args
+        @parser = ParserSexp.new @args
 
         if classes = @parser.parse_sources!
           @diagram = Diagram.new
@@ -49,21 +35,31 @@ module Umlify
 
           puts "Downloading the image from yUML, it shouldn't be long."
 
-          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
+          image = download_image
+          save_to_file image
 
+          puts @diagram.get_uri
           puts "Saved in uml.png"
         else
           puts "No ruby files in the directory"
         end
+      end
+
+    end
 
+    # Downloads the image of the uml diagram from yUML
+    def download_image
+      Net::HTTP.start("yuml.me", 80) do |http|
+        http.get(URI.escape(@diagram.get_uri))
       end
+    end
 
+    #Saves the diagram to file
+    def save_to_file image
+      File.open('uml.png', 'wb') do |file|
+        file << image.body
+      end if image
     end
+
   end
 end

data/lib/umlify/uml_class.rb

@@ -1,8 +1,6 @@
 module Umlify
 
-  ##
   # Represent a parsed uml class
-  #
   class UmlClass
     attr_accessor :name, :variables, :methods, :associations, :parent
 

data/lib/umlify/version.rb

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

data/lib/umlify.rb

@@ -33,6 +33,7 @@
 require 'umlify/version'
 require 'umlify/runner'
 require 'umlify/parser'
+require 'umlify/parser_sexp'
 require 'umlify/extension'
 require 'umlify/uml_class'
 require 'umlify/diagram'

data/test/diagram_test.rb

@@ -50,6 +50,18 @@ class DiagramTest < Test::Unit::TestCase
       assert @diagram.statements.include? '[Unicorn]-chunky>[Bacon]'
     end
 
+    should "process cardinality for associations"  do
+      test_uml_class = Umlify::UmlClass.new 'Unicorn'
+      test_uml_class.associations['foo'] = 'Bar'
+      test_uml_class.associations['foo-n'] = '1..*'
+
+      @diagram.create do
+        add test_uml_class
+      end
+
+      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'

data/test/parser_sexp_test.rb

@@ -0,0 +1,157 @@
+require 'shoulda'
+require 'umlify'
+
+class ParserSexpTest < Test::Unit::TestCase
+
+  context "ParserSexp" do
+
+    setup do
+      fixture = ["somefile.rb", "someotherfile.rb"]
+      @p = Umlify::ParserSexp.new fixture
+    end
+
+    should "respond to parse_sources!"  do
+      assert_respond_to @p, :parse_sources!
+    end
+
+    should "return nil if no source file in the given directory" do
+      parser = Umlify::ParserSexp.new ["not_source", "still_not_source"]
+      assert_equal nil, parser.parse_sources!
+    end
+
+    should "parse class names" do
+      test = <<-END_FILE
+      class AClassName
+      end
+      END_FILE
+      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
+      assert_equal 'SuperClass', @p.parse_file(test)[0].parent
+    end
+
+    should "parse instance methods" do
+      test = <<-END_FILE
+      class Bar
+        def initialize
+        end
+
+        def foo
+        end
+
+        def self.selfish
+        end
+      end
+      END_FILE
+      assert_equal 'Bar', @p.parse_file(test)[0].name
+      assert_equal ['initialize', 'foo'], @p.parse_file(test)[0].methods
+    end
+
+    should "parse instance variables" do
+      test = <<-END_FILE
+      class Bar
+        def foo
+          @a_variable = "foo"
+          @another_variable = "foo"
+          @@class_variable = "foo"
+        end
+
+        @a_class_instance_variable = "foo"
+      end
+      END_FILE
+      bar = @p.parse_file(test)[0]
+      assert_instance_of Umlify::UmlClass, bar
+      assert bar.variables.include? "a_variable"
+      assert bar.variables.include? "another_variable"
+      assert_equal false, bar.variables.include?('a_class_instance_variable')
+      assert_equal false, bar.variables.include?('class_variable')
+    end
+
+    should "Create associations when the types are specified" do
+      test = <<-END_FILE
+      # Describe the class's instance variables like that:
+      #
+      #    type of @unicorn: Unicorn
+      #    type of @quackable: Duck
+      #    type of @edible: 1..* Cow
+      class Bar
+
+        def foo
+          @unicorn = Unicorn.new
+          @quackable = Duck.new
+          @edible = Cow.new
+        end
+      end
+      END_FILE
+      bar = @p.parse_file(test)[0]
+      assert_instance_of Umlify::UmlClass, bar
+      assert_equal "Unicorn", bar.associations['unicorn']
+      assert_equal "Duck", bar.associations['quackable']
+      assert_equal "Cow", bar.associations['edible']
+      assert_equal "1..*", bar.associations['edible-n']
+    end
+
+    should "parse inherited classes" do
+      test = <<-END_FILE
+        class Bar < Hash
+
+          def initialize
+          end
+
+          def save
+          end
+
+        end
+      END_FILE
+      bar = @p.parse_file(test)[0]
+      assert_instance_of Umlify::UmlClass, bar
+      assert_equal "Hash", bar.parent
+    end
+
+    should "parse inheritance from other modules" do
+      test = <<-END_FILE
+        class Bar < SomeModule::Hash
+
+          def initialize
+          end
+
+          def save
+          end
+
+        end
+      END_FILE
+      bar = @p.parse_file(test)[0]
+      assert_instance_of Umlify::UmlClass, bar
+      assert_equal "Hash", bar.parent
+    end
+
+
+    should "parse file with multiple classes" do
+      test = <<-END_FILE
+        class Bar < Hash
+        end
+
+        class Foo
+        end
+      END_FILE
+
+      classes = @p.parse_file(test)
+      assert_equal 2, classes.count
+    end
+
+    should "return an array of UmlClasses when the parsing is done" do
+      p = Umlify::ParserSexp.new Dir[File.dirname(__FILE__)+'/fixtures/*']
+      parsed_classes = p.parse_sources!
+      puts "here : #{parsed_classes}"
+      assert_equal 3, parsed_classes.count
+    end
+
+  end
+end
+

metadata

@@ -2,7 +2,7 @@
 name: umlify
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.6.1
+  version: 1.0.0
 platform: ruby
 authors: 
 - Michael Sokol
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-04 00:00:00 -05:00
+date: 2011-03-06 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -30,11 +30,13 @@ files:
 - lib/umlify/version.rb
 - lib/umlify/runner.rb
 - lib/umlify/parser.rb
+- lib/umlify/parser_sexp.rb
 - lib/umlify/extension.rb
 - lib/umlify/uml_class.rb
 - lib/umlify/diagram.rb
 - test/parser_test.rb
 - test/diagram_test.rb
+- test/parser_sexp_test.rb
 has_rdoc: true
 homepage: https://github.com/mikaa123/umlify
 licenses: []
@@ -65,4 +67,5 @@ specification_version: 3
 summary: umlify is a tool that creates class diagrams from your code.
 test_files: 
 - test/parser_test.rb
+- test/parser_sexp_test.rb
 - test/diagram_test.rb