rbuml 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1d197fadc0f325f5aaf69e7e1d466659b71ff64c
+  data.tar.gz: 6a3f847977a9e154ee3c4710f60bba15abb6f63a
+SHA512:
+  metadata.gz: 6e6ea97d14e7425da642f6e6098268c44a9e8ce85d3f5b974ba525a692c2bc41a1a7599f0e43367c02d5c75ecc89abf46a39d29dee509745a0fbb9437bd94396
+  data.tar.gz: bce53d897766d8c201510cd528e44dcf47650a30d5a1543c08af89e20388e28304c461873d0471d201e4d04bab3070bc90c0cc3b52a25cd5f7346de7601fbb30

data/bin/rbuml

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'rbuml/dsl'
+
+ARGV.each do |fn|
+	puts "running #{fn}"
+	code = File.read(fn)
+	eval(code)
+end

data/lib/rbuml.rb

@@ -0,0 +1,2 @@
+require 'rbuml/models'
+require 'rbuml/dot'

data/lib/rbuml/dot.rb

@@ -0,0 +1,108 @@
+require 'graphviz'
+
+require 'rbuml/models'
+
+
+def rbuml_dot_render(classes, filename, format=:png)
+	g = GraphViz.new(:G, :type => :digraph, :ratio => :compress)
+	
+	classes.each do |name, cls|
+		g.add_nodes(cls.name, :label => cls.dot_label, :shape => "record")
+	end
+	
+	classes.each do |name, cls|
+		cls.notes.each_with_index do |note,i|
+			g.add_nodes("note#{cls.name}#{i}", :label => note.dot_label, :shape => :note)
+			g.add_edges(cls.name, "note#{cls.name}#{i}", :dir => :none)
+		end
+	end
+	
+	classes.each do |name, cls|
+		cls.interfaces.each do |inter|
+			g.add_edges(cls.name, inter, :arrowhead => :empty)
+		end
+		
+		cls.parents.each do |parent|
+			g.add_edges(cls.name, parent, :arrowhead => :empty)
+		end
+		
+		cls.relationships.each do |rel|
+			g.add_edges(cls.name, rel.kind, :label => rel.dot_label, :dir => :both, :arrowhead => :none, :arrowtail => :odiamond, :headlabel => rel.head_label)
+		end
+	end
+	
+	g.output(format => filename)
+	puts "saved " + filename
+end
+
+
+class RbUMLClass
+	def dot_label
+		kind_lookup = {
+			:class => "",
+			:enumeration => "<<enumeration>>\n",
+			:interface => "<<interface>>\n",
+		}
+		attributes = @attributes.collect { |a| a.dot_label }.join('\l')
+		methods = @methods.collect { |m| m.dot_label }.join('\l')
+		"{#{kind_lookup[@kind]}#{@name}|#{attributes}\\l|#{methods}\\l}"
+	end
+end
+
+
+class RbUMLAttribute
+	def dot_label
+		visibility_lookup = {
+			:unspecified => '',
+			:public => '+',
+			:private => '-',
+			:protected => '#',
+			:derived => '/',
+			:package => '~',
+		}
+		kind = @kind ? " : #{@kind.to_s}" : ""
+		"#{visibility_lookup[@visibility]}#{@name}#{kind}"
+	end
+end
+
+
+class RbUMLRelationship
+	def dot_label
+		@verb ? "<<#{@verb}>>" : ''
+	end
+	
+	def head_label
+		@multiplicity ? @multiplicity : ''
+	end
+end
+
+
+class RbUMLMethod
+	def dot_label
+		visibility_lookup = {
+			:unspecified => '',
+			:public => '+',
+			:private => '-',
+			:protected => '#',
+			:derived => '/',
+			:package => '~',
+		}
+		args = @arguments.collect { |p| p.dot_label }.join(', ')
+		kind = @returns ? " : #{@returns}" : ""
+		"#{visibility_lookup[@visibility]}#{@name}(#{args})#{kind}"
+	end
+end
+
+
+class RbUMLMethodArgument
+	def dot_label
+		@kind ? "#{@name} : #{@kind}" : "#{@name}"
+	end
+end
+
+
+class RbUMLNote
+	def dot_label
+		@text.split("\n").collect {|line| line.gsub("\t", '') }.join('\l') + '\l'
+	end
+end

data/lib/rbuml/dsl.rb

@@ -0,0 +1,65 @@
+require 'rbuml/models'
+require 'rbuml/dot'
+
+$known_classes = {}
+$current = nil
+$method = nil
+
+def uml_class(*params, &block)
+	$current = RbUMLClass.new(*params)
+	if block_given?
+		block.call $current
+	end
+	$known_classes[$current.name] = $current
+	$current = nil
+end
+
+
+def kind(k)
+	$current.kind = k
+end
+
+
+def note(text)
+	$current.add_note RbUMLNote.new(text)
+end
+
+
+def extends(kind)
+	$current.add_parent kind
+end
+
+
+def implements(kind)
+	$current.add_interface kind
+end
+
+
+def attribute(*params)
+	$current.add_attribute RbUMLAttribute.new(*params)
+end
+
+
+def relationship(*params)
+	$current.add_relationship RbUMLRelationship.new(*params)
+end
+
+
+def method(*params, &block)
+	$method = RbUMLMethod.new(*params)
+	if block_given?
+		block.call $method
+	end
+	$current.add_method $method
+	$method = nil
+end
+
+
+def argument(*params)
+	$method.add_argument RbUMLMethodArgument.new(*params)
+end
+
+
+def save(filename, format=:png)
+	rbuml_dot_render $known_classes, filename, format
+end

data/lib/rbuml/models.rb

@@ -0,0 +1,100 @@
+class RbUMLClass
+	attr_reader :name
+	attr_reader :parents
+	attr_reader :interfaces
+	attr_reader :relationships
+	attr_reader :notes
+	attr_writer :kind
+	
+	def initialize(name, kind=:class)
+		@name = name
+		@parents = []
+		@interfaces = []
+		@attributes = []
+		@relationships = []
+		@methods = []
+		@notes = []
+		@kind = kind
+	end
+	
+	def add_parent(cls)
+		@parents << cls
+	end
+	
+	def add_interface(inter)
+		@interfaces << inter
+	end
+	
+	def add_attribute(attrib)
+		@attributes << attrib
+	end
+	
+	def add_relationship(rel)
+		@relationships << rel
+	end
+	
+	def add_method(method)
+		@methods << method
+	end
+	
+	def add_note(note)
+		@notes << note
+	end
+end
+
+
+class RbUMLAttribute
+	attr_reader :kind
+	
+	def initialize(name, kind, visibility=:unspecified)
+		@name = name
+		@kind = kind
+		@visibility = visibility
+	end
+end
+
+
+class RbUMLRelationship
+	attr_reader :kind
+	
+	def initialize(kind, verb=nil, multiplicity=nil)
+		@kind = kind
+		@verb = verb
+		@multiplicity = multiplicity
+	end
+end
+
+
+class RbUMLMethod
+	attr_reader :name
+	attr_reader :note
+	
+	def initialize(name, returns=nil, visibility=:unspecified)
+		@name = name
+		@returns = returns
+		@arguments = []
+		@visibility = visibility
+	end
+	
+	def add_argument(arg)
+		@arguments << arg
+	end
+end
+
+
+class RbUMLMethodArgument
+	attr_reader :name
+	attr_reader :kind
+	
+	def initialize(name, kind=nil)
+		@name = name
+		@kind = kind
+	end
+end
+
+
+class RbUMLNote
+	def initialize(text)
+		@text = text
+	end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: rbuml
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Neil Isaac
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-graphviz
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: rbuml provides classes and a dsl for representing uml class relationships
+  that can be rendered as a uml class diagram using graphviz dot
+email: mail@neilisaac.ca
+executables:
+- rbuml
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/rbuml
+- lib/rbuml.rb
+- lib/rbuml/dot.rb
+- lib/rbuml/dsl.rb
+- lib/rbuml/models.rb
+homepage: https://github.com/neilisaac/rbuml
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: rbuml is a uml dsl for ruby for generating class diagrams
+test_files: []