umlify 1.2.1 → 1.2.4

data/bin/umlify

@@ -2,4 +2,4 @@
 
 require 'umlify'
 
-Umlify::Runner.new(ARGV).run
+Umlify.execute ARGV

data/lib/umlify.rb

@@ -34,8 +34,18 @@
 
 require 'umlify/version'
 require 'umlify/runner'
-require 'umlify/parser'
 require 'umlify/parser_sexp'
 require 'umlify/extension'
 require 'umlify/uml_class'
 require 'umlify/diagram'
+
+module Umlify
+  class << self
+
+    # Executes umlify with the given set of options
+    def execute args
+      Umlify::Runner.new(args).run
+    end
+
+  end
+end

data/lib/umlify/parser_sexp.rb

@@ -51,7 +51,14 @@ module Umlify
 
     # Creates a UmlClass from a class s-expression
     def parse_class class_s_exp
-      uml_class = UmlClass.new class_s_exp[1].to_s
+
+      # Checks if the class is in a module
+      if class_s_exp[1].class == Symbol
+        uml_class = UmlClass.new class_s_exp[1].to_s
+      else
+        classname = class_s_exp[1][1][1].to_s+'::'+class_s_exp[1][2].to_s
+        uml_class = UmlClass.new classname
+      end
 
       # Let's start by building the associations of the class
       each_association_for class_s_exp do |variable, type, cardinality|
@@ -65,7 +72,8 @@ module Umlify
         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
+        classname = class_s_exp[2][1][1].to_s+'::'+class_s_exp[2][2].to_s
+        uml_class.parent = classname
       end
 
       # Looks-up for instance methods

data/lib/umlify/runner.rb

@@ -7,12 +7,13 @@ module Umlify
   # and generates and save a uml diagram using yUML API.
   class Runner
 
-    attr_reader :smart_mode
+    attr_reader :smart_mode, :html_mode
 
     # Takes as input an array with file names
     def initialize args
       @args = args
       @smart_mode = false
+      @html_mode = false
     end
 
     # Runs the application
@@ -24,9 +25,9 @@ module Umlify
       else
         puts "umlifying"
 
-        @parser = ParserSexp.new @args
+        @parser_sexp = ParserSexp.new @args
 
-        if classes = @parser.parse_sources!
+        if classes = @parser_sexp.parse_sources!
           @diagram = Diagram.new
 
           if @smart_mode
@@ -42,7 +43,7 @@ module Umlify
           image = download_image
           save_to_file image
 
-          puts 'http://yuml.me'+@diagram.get_uri
+          puts 'http://yuml.me'+@diagram.get_uri if @debug_mode
           puts "Saved in uml.png"
         else
           puts "No ruby files in the directory"
@@ -54,6 +55,7 @@ module Umlify
     def parse_options
       OptionParser.new do |opts|
         opts.on("-s", "--smart") { @smart_mode = true }
+        opts.on("-h", "--html") { @html_mode = true }
       end.parse! @args
     end
 

data/lib/umlify/version.rb

@@ -1,3 +1,3 @@
 module Umlify
-  VERSION = "1.2.1"
+  VERSION = "1.2.4"
 end

data/test/parser_sexp_test.rb

@@ -128,9 +128,25 @@ class ParserSexpTest < Test::Unit::TestCase
       END_FILE
       bar = @p.parse_file(test)[0]
       assert_instance_of Umlify::UmlClass, bar
-      assert_equal "Hash", bar.parent
+      assert_equal "SomeModule::Hash", bar.parent
     end
 
+    should "parse classes from a module" do
+      test = <<-END_FILE
+        class SomeModule::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 "SomeModule::Bar", bar.name
+    end
 
     should "parse file with multiple classes" do
       test = <<-END_FILE
@@ -148,7 +164,6 @@ class ParserSexpTest < Test::Unit::TestCase
     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
 

data/test/runner_test.rb

@@ -14,6 +14,14 @@ class RunnerTest < Test::Unit::TestCase
       assert r.smart_mode
     end
 
+    should "print the api url when passed -h or --html option"  do
+      r = Umlify::Runner.new(["-h"])
+      r.run
+      assert r.html_mode
+      r = Umlify::Runner.new(["--html"])
+      r.run
+      assert r.html_mode
+    end
   end
 end
 

metadata

@@ -2,7 +2,7 @@
 name: umlify
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.2.1
+  version: 1.2.4
 platform: ruby
 authors: 
 - Michael Sokol
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-10 00:00:00 -05:00
+date: 2011-03-14 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -61,12 +61,10 @@ files:
 - lib/umlify.rb
 - 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/uml_class_test.rb
 - test/runner_test.rb
@@ -101,7 +99,6 @@ signing_key:
 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

data/lib/umlify/parser.rb

@@ -1,86 +0,0 @@
-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
-    # type: UmlClass
-    attr_accessor :classes
-
-    # 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}..."
-        f = File.open file, 'r'
-        (parse_file f).each {|c| @classes << c}
-        f.close
-      end
-
-      @classes
-    end
-
-    # Parse the given file or string, and return the parsed classes
-    def parse_file file
-      classes_in_file = []
-      current_class = nil
-      type_annotation = nil
-
-      file.each do |line|
-
-        # This parses the classes
-        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
-          line.match(/@([\w]*)\b/) do |m|
-            current_class.variables << m[1] unless current_class.variables.include? m[1]
-          end
-
-          # This parses the methods
-          line.match(/def ([\w]*)\b/) do |m|
-            current_class.methods << m[1] unless current_class.methods.include? m[1]
-          end
-
-          # This raises the type_annotation flag
-          line.match(/# type: ([\w]*)\b/) {|m| type_annotation = m[1]}
-
-          # This adds an association to the current class, using the type_annotation
-          # if type_annotation has been set
-          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
-
-        end
-      end
-
-      classes_in_file
-    end
-  end
-end

data/test/parser_test.rb

@@ -1,126 +0,0 @@
-require 'shoulda'
-require 'umlify'
-
-class ParserTest < Test::Unit::TestCase
-
-  context "Parser" do
-
-    setup do
-      fixture = ["somefile.rb", "someotherfile.rb"]
-      @p = Umlify::Parser.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::Parser.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
-    end
-
-    should "parse @variables in classes" do
-      test = <<-END_FILE
-      class Bar
-        def foo
-          @a_variable = "foo"
-        end
-      end
-      END_FILE
-      bar = @p.parse_file(test)[0]
-      assert_instance_of Umlify::UmlClass, bar
-      assert bar.variables.include? "a_variable"
-    end
-
-    should "parse attr_accessor when preceeded by a # type: Type annotation" do
-      test = <<-END_FILE
-      class Bar
-
-        # type: FooBar
-        attr_accessor :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_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!
-      puts "here : #{parsed_classes}"
-      assert_equal 3, parsed_classes.count
-    end
-
-  end
-end