xmimodel 0.1.0

data/lib/xmimodel.rb

@@ -0,0 +1,205 @@
+# encoding: utf-8
+
+require File.join(File.dirname(__FILE__), 'xmimodel/package.rb')
+require File.join(File.dirname(__FILE__), 'xmimodel/generalization.rb')
+require File.join(File.dirname(__FILE__), 'xmimodel/xmihelper.rb')
+
+##
+# A helper class for working with XMI Models.
+class XmiModel
+
+	# @return [Nokogiri::XML::Document]
+	attr_reader :document
+
+	# @return [String] The contents of the tag 'XMI.header/XMI.documentation/XMI.exporter'.
+	attr_reader :exporter
+
+	# @return [String] The contents of the tag 'XMI.header/XMI.documentation/XMI.exporterVersion'.
+	attr_reader :exporter_version
+
+	# @return [String] The value of property xmi.version of the tag 'XMI.header/XMI.metamodel'.
+	attr_reader :metamodel_version
+
+	# @return [Array<Generalization>] All model generalizations.
+	attr_reader :generalizations
+	
+	# @return [Array<Association>] All model associations.
+	attr_reader :associations
+
+	##
+	# Constructor. 
+	# 
+	# @param [String, #read] Path of model.
+	def initialize(model_file_name)
+
+		# Obtem a tag 'XMI.content' que contém todos os objetos que serão tratados
+		f = File.open(model_file_name)		
+		doc = Nokogiri::XML(f)
+		@document = doc
+		xmi_content = doc.at_xpath("./XMI/XMI.content")
+		f.close
+
+		# Header
+		@exporter = XmiHelper.exporter(doc)
+		@exporter_version = XmiHelper.exporter_version(doc)
+		@metamodel_version = XmiHelper.metamodel_version(doc)
+
+		# Constrói vetor de pacotes
+		@packages = Array.new		
+		XmiHelper.packages(xmi_content).each do |uml_package|
+			if ! (uml_package.attribute('name').nil? || 
+				uml_package.attribute('name').to_s.empty? || 
+				uml_package.attribute('name').to_s.strip == "Component View" ||
+				uml_package.attribute('name').to_s.strip == "Data types")
+				p = Package.new(uml_package, nil)
+				@packages << p
+			end
+		end
+
+		# Constrói vetor de heranças
+		@generalizations = Array.new
+		XmiHelper.all_generalizations(xmi_content).each do |xml|
+			g = Generalization.new(xml, self)
+			
+			g.child_obj.parent  = g.parent_obj unless g.child_obj.nil?
+			g.parent_obj.children << g.child_obj unless g.parent_obj.nil?
+
+			#puts "#{g.child_obj.full_name} - #{g.parent_obj.full_name}"
+			@generalizations << g
+		end
+
+		@associations = Array.new
+		XmiHelper.all_associations(xmi_content).each do |xml|
+			@associations << Association.new(xml, self)
+		end
+
+		true
+	end
+
+	##
+	# Get the object of type 'Clazz' by full name of class.
+	#
+	# @param [String, #read] Name of the class including package name.
+	# @return [Clazz]
+	def class_by_full_name(full_class_name)
+		raise ArgumentError.new("Parameter 'full_class_name' cannot be empty.") if full_class_name.nil? or full_class_name.empty?
+		clazz = classes.select{|c| c.full_name == full_class_name}
+		
+		if !clazz.nil? && clazz.size > 0
+			clazz[0]
+		else
+			nil
+		end
+	end
+
+	##
+	# Get the object of type 'Clazz' by id.
+	#
+	# @param [String, #read] Id of the class in model file.
+	# @return [Clazz]
+	def class_by_id(class_id)
+		raise ArgumentError.new("#{__method__}: 'class_id' cannot be empty.") if class_id.nil? or class_id.empty?
+		clazz = classes.select{|c| c.id == class_id}
+		
+		if !clazz.nil? && clazz.size > 0
+			clazz[0]
+		else
+			nil
+		end
+	end	
+
+	##
+	# Get all model classes.
+	#
+	# @return [Array<Clazz>]
+	def classes
+		return @classes unless @classes.nil?
+		@classes = Array.new
+		packages.each do |p|
+			@classes.concat p.classes.sort
+		end
+		@classes
+	end
+
+	##
+	# Get the object of type 'Package' by full name of package.
+	#
+	# @param [String, #read] Name of the package including sub packages name.
+	# @return [Package]
+	def package_by_full_name(full_package_name)
+		raise ArgumentError.new("Parameter 'full_package_name' cannot be empty.") if full_package_name.nil? or full_package_name.empty?
+		package = packages.select{|p| p.full_name == full_package_name}
+		
+		if !package.nil? && package.size > 0
+			package[0]
+		else
+			nil
+		end
+	end	
+
+	##
+	# Get all model packages.
+	#
+	# @return [Array<Package>]
+	def packages
+		return @all_packages unless @all_packages.nil?
+		@all_packages = Array.new
+
+		add_package(@packages)
+		
+		@all_packages.sort!
+		@all_packages
+	end
+
+	##
+	# Get the object of type 'State' by id.
+	#
+	# @param [String, #read] Id of the state in model file.
+	# @return [ActionState, FinalState, PseudoState]
+	def state_by_id(id)
+		raise ArgumentError.new("Parameter 'id' cannot be empty.") if id.nil? or id.empty?
+		objs = states.select{|obj| obj.id == id}	
+		(!objs.nil? && objs.size > 0) ? objs[0] : nil
+	end
+
+
+	##
+	# Get all model states.
+	#
+	# @return [Array<ActionState, FinalState, PseudoState>]
+	def states
+		return @states unless @states.nil?
+
+		@states = Array.new
+		packages.each do |p|
+			p.use_cases.each do |u|
+				u.activity_graphs.each do |a|
+					@states.concat a.action_states
+					@states.concat a.final_states
+					@states.concat a.pseudo_states
+				end
+			end
+			p.activity_graphs.each do |a|
+				@states.concat a.action_states
+				@states.concat a.final_states
+				@states.concat a.pseudo_states
+			end			
+		end
+		@states		
+	end
+
+	def to_s
+		"'XmiModel #{exporter} #{exporter_version} [Packages: #{packages.size}, Classes: #{classes.size}]'"
+	end
+
+	private
+	
+	def add_package(packages)
+		packages.each do |p|
+			#puts p.name
+			@all_packages << p			
+			add_package(p.packages) unless p.packages.nil?
+		end
+	end		
+
+end

data/lib/xmimodel/action_state.rb

@@ -0,0 +1,17 @@
+require 'xmimodel/state'
+
+class ActionState < State
+
+	attr_reader :deferrable_event
+
+	def initialize(xml, activity_graph)
+		super(xml, activity_graph)
+		@deferrable_event = xml.attribute("deferrableEvent").to_s
+		true
+	end
+
+	def to_s
+		"ActionState"
+	end	
+
+end

data/lib/xmimodel/activity_graph.rb

@@ -0,0 +1,81 @@
+require 'xmimodel/action_state'
+require 'xmimodel/final_state'
+require 'xmimodel/pseudo_state'
+require 'xmimodel/transition'
+
+##
+# In umbrelo ActivityGraph is not represented by tag 'UML:ActivityGraph'. 
+# It's represented by tag diagram inside of XMI.extension.
+#
+#
+class ActivityGraph
+
+	attr_reader :xml
+	
+	attr_reader :id
+	attr_reader :name
+
+	attr_reader :pseudo_states
+	attr_reader :action_states
+	attr_reader :final_states
+	attr_reader :transitions
+
+	def initialize(xml, parent)
+		@xml = xml
+		@use_case = parent.parent
+		
+		@id = xml.attribute("xmi.id").to_s
+		@name = xml.attribute("name").to_s
+
+		@pseudo_states = Array.new
+		XmiHelper.pseudo_states(xml).each do |uml|
+			pseudo_state = PseudoState.new(uml, self)
+			@pseudo_states << pseudo_state
+		end
+
+		@action_states = Array.new
+		XmiHelper.action_states(xml).each do |uml|
+			action_state = ActionState.new(uml, self)
+			@action_states << action_state
+		end	
+
+		@final_states = Array.new
+		XmiHelper.final_states(xml).each do |uml|
+			final_state = FinalState.new(uml, self)
+			@final_states << final_state
+		end
+
+		@transitions = Array.new
+		XmiHelper.transitions(xml).each do |uml|
+			transition = Transition.new(uml, self)
+			@transitions << transition
+		end			
+	end
+
+	def full_name
+		"#{@use_case.full_name}::#{@name}"
+	end
+
+	def to_s
+		"ActivityGraph[#{full_name}]"
+	end		
+
+	def state_by_name(name_state, state_name)
+		case name_state
+			when "PseudoState"
+				state = @pseudo_states.select{|obj| obj.name == state_name}
+			when "ActionState"
+				state = @action_states.select{|obj| obj.name == state_name}
+			when "FinalState"
+				state = @final_states.select{|obj| obj.name == state_name}
+		end
+		return state[0] if !state.nil? && state.size > 0
+		nil
+	end
+
+	def transition_by_source_target_ids(source, target)
+		objs = @transitions.select{|obj| obj.source == source && obj.target == target}
+		(!objs.nil? && objs.size > 0) ? objs[0] : nil
+	end
+
+end

data/lib/xmimodel/association.rb

@@ -0,0 +1,26 @@
+
+class Association
+
+	attr_reader :xml
+	attr_reader :parent
+
+	attr_reader :id
+	attr_reader :name
+	
+	# TODO Build AssociationEnd class
+	def initialize(xml, parent)
+		@xml = xml
+		@parent = parent
+
+		@id = xml.attribute("xmi.id").to_s
+		@name = xml.attribute("name").to_s.strip
+
+		#association_end_a
+		#association_end_b
+	end
+
+	def to_s
+		"Association[#{@name}]"
+	end	
+	
+end

data/lib/xmimodel/attribute.rb

@@ -0,0 +1,76 @@
+require 'xmimodel/stereotype'
+require 'xmimodel/tagged_value'
+
+class Attribute
+
+	attr_reader :xml
+
+	attr_reader :id
+	attr_reader :name
+	attr_reader :type
+	attr_reader :visibility
+	attr_reader :initial_value
+	attr_reader :multiplicity_range
+	
+	attr_reader :clazz
+
+	attr_reader :stereotypes
+	attr_reader :tagged_values
+
+	def initialize(xml, clazz)
+		@xml = xml
+		@clazz = clazz
+
+		@id = xml.attribute("xmi:id").to_s
+		@name = xml.attribute("name").to_s.strip
+		@visibility = xml.attribute("visibility").to_s
+		@visibility = "private" if @visibility == ""
+
+		@type = XmiHelper.attribute_type_name(xml)
+
+		@initial_value = XmiHelper.attribute_initial_value(xml)
+		@multiplicity_range = XmiHelper.multiplicity_range(xml)
+
+		@stereotypes = Array.new
+		XmiHelper.stereotypes(xml).each do |uml_stereotype|
+			stereotype = Stereotype.new(uml_stereotype, self)
+			@stereotypes << stereotype
+		end	
+
+		@tagged_values = Array.new
+		XmiHelper.tagged_values(xml).each do |uml_tagged_value|
+			tagged_value = TaggedValue.new(uml_tagged_value, self)
+			@tagged_values << tagged_value
+		end		
+	end
+
+	def full_name
+		"#{@clazz.full_name}::#{@name}"
+	end
+
+	def stereotype_by_name(name)
+		stereotype = @stereotypes.select{|s| s.name == name}
+		return stereotype[0] if !stereotype.nil? && stereotype.size > 0
+		nil		
+	end
+
+	def tagged_value_by_name(tagged_value_name)
+		tagged_value = @tagged_values.select{|t| t.name == tagged_value_name}
+		return tagged_value[0] if !tagged_value.nil? && tagged_value.size > 0
+		nil			
+	end	
+
+	def ==(obj)
+		return false if obj.nil?
+		if String == obj.class
+			full_name == obj
+		else
+    		full_name == obj.full_name
+    	end
+	end	
+
+	def to_s
+		"Attribute[#{full_name}]"
+	end	
+
+end

data/lib/xmimodel/clazz.rb

@@ -0,0 +1,123 @@
+# encoding: utf-8
+
+require 'xmimodel/attribute'
+require 'xmimodel/stereotype'
+require 'xmimodel/tagged_value'
+require 'xmimodel/operation'
+
+class Clazz
+	
+	attr_reader :xml
+	
+	attr_reader :id
+	attr_reader :name
+
+	# @return [String] Full Package name of class.
+	attr_reader :package
+
+	# @return [Array<Attribute>] Class attributes.
+	attr_reader :attributes
+
+	# @return [Array<String>] Class associations.
+	attr_reader :stereotypes
+
+	attr_reader :tagged_values
+	attr_reader :operations
+
+	attr_accessor :children
+	attr_accessor :parent
+
+	def initialize(xml, parent)
+		@xml = xml
+		@package = parent.parent
+		
+		@id = xml.attribute("xmi.id").to_s
+		@name = xml.attribute("name").to_s.strip
+		
+		@attributes = Array.new
+		XmiHelper.attributes(xml).each do |uml_attribute|
+			attribute = Attribute.new(uml_attribute, self)
+			@attributes << attribute
+		end
+
+		@stereotypes = Array.new
+		stereotype_id = xml.attribute("stereotype").to_s
+		if !stereotype_id.empty?
+			stereotype = XmiHelper.stereotype_by_id(xml, stereotype_id)
+			stereotype = Stereotype.new(stereotype, self)
+			@stereotypes << stereotype			
+		end
+		XmiHelper.stereotypes(xml).each do |uml_stereotype|
+			stereotype = Stereotype.new(uml_stereotype, self)
+			@stereotypes << stereotype
+		end	
+
+		@tagged_values = Array.new
+		XmiHelper.tagged_values(xml).each do |uml_tagged_value|
+			tagged_value = TaggedValue.new(uml_tagged_value, self)
+			@tagged_values << tagged_value
+		end
+
+		@operations = Array.new
+		XmiHelper.operations(xml).each do |uml_operation|
+			tagged_value = Operation.new(uml_operation, self)
+			@operations << tagged_value
+		end
+
+		# Será povoado quando tratar dos objetos do tipo Genezalization
+		@children = Array.new
+
+	end
+
+	def attribute_by_id(attribute_id)
+		attribute = @attributes.select{|obj| obj.id == attribute_id}
+		return attribute[0] if !attribute.nil? && attribute.size > 0
+		nil
+	end	
+
+	def attribute_by_name(attribute_name)
+		attribute = @attributes.select{|obj| obj.name == attribute_name}
+		return attribute[0] if !attribute.nil? && attribute.size > 0
+		nil
+	end
+
+	def operation_by_name(operation_name)
+		operation = @operations.select{|obj| obj.name == operation_name}
+		return operation[0] if !operation.nil? && operation.size > 0
+		nil
+	end	
+
+	def stereotype_by_name(name)
+		stereotype = @stereotypes.select{|obj| obj == name}
+		return stereotype[0] if !stereotype.nil? && stereotype.size > 0
+		nil		
+	end
+
+	def tagged_value_by_name(tagged_value_name)
+		tagged_value = @tagged_values.select{|obj| obj.name == tagged_value_name}
+		return tagged_value[0] if !tagged_value.nil? && tagged_value.size > 0
+		nil
+	end
+
+	def <=>(obj)
+    	full_name <=> obj.full_name
+	end
+
+	def ==(obj)
+		return false if obj.nil?
+		if String == obj.class
+			full_name == obj
+		else
+    		full_name == obj.full_name
+    	end
+	end	
+
+	def full_name
+		"#{package.full_name}.#{name}"
+	end
+
+	def to_s
+		"Clazz[#{full_name}]"
+	end	
+
+end