Initial import

Author: greg

.gitignore

@@ -0,0 +1 @@
+.DS_Store

AUTHORS

@@ -0,0 +1 @@
+Gregoire Lejeune <[email protected]>

COPYING

@@ -0,0 +1,36 @@
+= Ruby/yUML
+
+Copyright (C) 2009 Gregoire Lejeune
+
+* home : http://github.com/glejeune/ruby-yuml
+* doc : http://rdoc.info/projects/glejeune/ruby-yuml
+  
+== DESCRIPTION: 
+
+Capcode is a web microframework
+
+== FEATURES/PROBLEMS:
+
+=== 0.1.0
+* Initial release
+
+== SYNOPSIS:
+
+  # file: sample.rb
+  
+== REQUIREMENTS:
+
+* An internet acces ;)
+
+== INSTALL:
+
+  sudo gem install ruby-yuml
+
+== LICENSE:
+
+Ruby/yUML is freely distributable according to the terms of the
+GNU General Public License.
+
+This program is distributed without any warranty. See the file
+'COPYING' for details.
+

README.rdoc

@@ -0,0 +1,84 @@
+require 'rake'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/testtask'
+require 'fileutils'
+require './lib/yuml/version'
+include FileUtils
+
+NAME = "Ruby-yUML"
+VERS = YUML::VERSION
+CLEAN.include ['**/.*.sw?', '*.gem', '.config', 'test/test.log']
+RDOC_OPTS = ['--quiet', '--title', "Ruby-yUML, the Documentation",
+  "--opname", "index.html",
+  "--line-numbers",
+  "--main", "README.rdoc",
+  "--inline-source"]
+
+desc "Packages up Ruby-yUML."
+task :default => [:package]
+task :package => [:clean]
+
+task :doc => [:rdoc, :after_doc]
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'doc/rdoc'
+  rdoc.options += RDOC_OPTS
+  rdoc.main = "README.rdoc"
+  rdoc.title = "Ruby/yUML, the Documentation"
+  rdoc.rdoc_files.add [
+    'README.rdoc', 
+    'AUTHORS', 
+    'COPYING',
+    'lib/yuml.rb'
+  ] + Dir.glob( "lib/yuml/*.rb" )
+end
+
+task :after_doc do
+  sh %{scp -r doc/rdoc/* #{ENV['USER']}@rubyforge.org:/var/www/gforge-projects/ruby-yuml/}
+end
+
+spec =
+  Gem::Specification.new do |s|
+    s.name = NAME
+    s.version = VERS
+    s.platform = Gem::Platform::RUBY
+    s.has_rdoc = true
+    s.extra_rdoc_files = ["README.rdoc", "AUTHORS", "COPYING",
+      'lib/yuml.rb'] + Dir.glob( "lib/yuml/*.rb" )
+    s.rdoc_options += RDOC_OPTS + ['--exclude', '^(examples|extras|test)\/']
+    s.summary = "Ruby/yUML is a UML diagrams generator via yuml.me"
+    s.description = s.summary
+    s.author = "Grégoire Lejeune"
+    s.email = '[email protected]'
+    s.homepage = 'http://algorithmique.net'
+    s.rubyforge_project = 'ruby-yuml'
+
+    s.required_ruby_version = ">= 1.8.1"
+
+    s.files = %w(COPYING README.rdoc AUTHORS setup.rb) + 
+      Dir.glob("{bin,doc,test,lib,examples}/**/*").delete_if {|item| item.include?("CVS") or item.include?("._")}
+       
+    s.require_path = "lib"
+        
+    s.post_install_message = <<EOM
+If For more information about Ruby/yUML, see 
+  http://algorithmique.net
+
+EOM
+  end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.need_tar = true
+  p.gem_spec = spec
+end
+
+task :install do
+  sh %{rake package}
+  sh %{sudo gem install pkg/#{NAME}-#{VERS}}
+end
+
+task :uninstall => [:clean] do
+  sh %{sudo gem uninstall #{NAME}}
+end

Rakefile

@@ -0,0 +1,20 @@
+$:.unshift( "../lib" )
+require 'yuml'
+
+x = YUML::useCaseDiagram( :scruffy, :scale => 75 ) {
+  actor(:Admin) ^ actor(:User)
+  actor(:Admin) - note( 'Most privilidged user' )
+  actor(:User) - useCase(:Login)
+  actor(:User) - useCase(:Logout) 
+  useCase(:Login) < useCase(:Reminder) 
+  useCase(:Login) > useCase(:Captcha)
+}
+
+puts "To String :"
+puts x.to_s
+
+puts "URL :"
+puts x.to_url( )
+
+puts "Image saved as use-case-diagram.png"
+x.to_png( "use-case-diagram.png" )

examples/use-case-diagram.rb

@@ -0,0 +1,58 @@
+require 'yuml/entities'
+require 'yuml/use_case_diagram'
+
+require 'net/http'
+
+module YUML
+  def self.options_string( options ) #:nodoc:
+    str = ""
+    sep = ""
+    options.each do |k, v|
+      if v.class == TrueClass
+        str << sep << k.to_s
+      else
+        str << sep << k.to_s << ":" << v.to_s
+      end
+      sep = ";"
+    end
+    str << "/" if str.size > 0
+  end
+  
+  def self.output( options, data, type, file ) #:nodoc:
+    opts = options.clone
+    diagram = opts.delete(:diagram)
+    uri = "/diagram/#{self.options_string(opts)}#{diagram}/#{data}#{type}"
+    # puts "*** #{uri}"
+    
+    writer = STDOUT
+    writer = open(file, "wb") unless file.nil?
+    res = Net::HTTP.start("yuml.me", 80) {|http|
+      http.get(URI.escape(uri))
+    }
+    writer.write(res.body)
+    writer.close
+  end
+  
+  def self.to_png( options, data, file ) #:nodoc:
+    self.output( options, data, "", file)
+  end
+  
+  def self.to_pdf( options, data, file ) #:nodoc:
+    self.output( options, data, ".pdf", file)
+  end
+
+  def self.to_jpg( options, data, file ) #:nodoc:
+    self.output( options, data, ".jpg", file)
+  end
+  
+  def self.to_url( options, data, type ) #:nodoc:
+    opts = options.clone
+    diagram = opts.delete(:diagram)
+    if type.nil?
+      type = ""
+    else
+      type = ".#{type}" if type[0].chr != "."
+    end
+    "http://yuml.me/diagram/#{self.options_string(opts)}#{diagram}/#{data}#{type}"
+  end
+end

lib/yuml.rb

@@ -0,0 +1,42 @@
+module YUML
+  class Entity #:nodoc:
+    def initialize( uc, name ) #:nodoc:
+      @uc = uc
+      @name = name
+    end
+    
+    def -(other)
+      @uc.link( self, other, "-" )
+    end
+    
+    def ^(other)
+      @uc.link( self, other, "^" )
+    end
+    
+    def <(other)
+      @uc.link( self, other, "<" )
+    end
+    
+    def >(other)
+      @uc.link( self, other, ">" )
+    end
+  end
+  
+  class Actor < Entity
+    def to_s #:nodoc:
+      "[#{@name.to_s}]"
+    end
+  end
+  
+  class UseCase < Entity
+    def to_s #:nodoc:
+      "(#{@name.to_s})"
+    end
+  end
+  
+  class Note < Entity
+    def to_s #:nodoc:
+      "(note: #{@name.to_s})"
+    end
+  end
+end

lib/yuml/entities.rb

@@ -0,0 +1,79 @@
+module YUML
+  # Create a new Use Case Diagram
+  def self.useCaseDiagram( *options, &block )
+    UseCaseDiagram.new( *options, &block )
+  end
+  
+  # Create a new Use Case Diagram
+  class UseCaseDiagram
+    def initialize( *options, &block )
+      @options = {
+        :diagram => "usecase"
+      }
+      options.each do |op|
+        if op.class == Hash
+          @options = @options.merge( op )
+        else
+          @options[op] = true
+        end
+      end
+      
+      @actors = {}
+      @useCases = {}
+      @notes = {}
+      @links = []
+      
+      instance_eval(&block)
+    end
+    
+    # Create a new actor in a Use Case Diagram
+    def actor(x)
+      @actors[x] ||= Actor.new( self, x )
+    end
+    
+    # Create a new use case in a Use Case Diagram
+    def useCase(x)
+      @useCases[x] ||= UseCase.new( self, x )
+    end
+    
+    # Create a new note in a Use Case Diagram
+    def note(x)
+      @notes[x] ||= Note.new( self, x )
+    end
+    
+    def link(one, two, type) #:nodoc:
+      @links << [one, type, two]
+    end
+    
+    # Generate the yUML file 
+    def to_s
+      output = ""
+      
+      @links.each do |l|
+        output << l[0].to_s << l[1].to_s << l[2].to_s << "\n"
+      end
+      
+      output
+    end
+    
+    # Generate the diagram as a PNG file
+    def to_png( file = nil )
+      YUML.to_png( @options, self.to_s.split(/\n/).join( ', ' ), file )
+    end
+
+    # Generate the diagram as a JPEG file
+    def to_jpg( file = nil )
+      YUML.to_jpg( @options, self.to_s.split(/\n/).join( ', ' ), file )
+    end
+    
+    # Generate the diagram as a PDF file
+    def to_pdf( file = nil )
+      YUML.to_pdf( @options, self.to_s.split(/\n/).join( ', ' ), file )
+    end
+    
+    # Return the yUML URL
+    def to_url( type = nil )
+      YUML.to_url( @options, self.to_s.split(/\n/).join( ', ' ), type )
+    end
+  end
+end

lib/yuml/use_case_diagram.rb

@@ -0,0 +1,3 @@
+module YUML
+  VERSION = "0.1.0"
+end