testability-driver 0.9.2

data/lib/tdriver-devtools/behaviour/old/xml/example/impl.rb_invalid

@@ -0,0 +1,194 @@
+############################################################################
+## 
+## Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). 
+## All rights reserved. 
+## Contact: Nokia Corporation (testabilitydriver@nokia.com) 
+## 
+## This file is part of Testability Driver. 
+## 
+## If you have questions regarding the use of this file, please contact 
+## Nokia at testabilitydriver@nokia.com . 
+## 
+## This library is free software; you can redistribute it and/or 
+## modify it under the terms of the GNU Lesser General Public 
+## License version 2.1 as published by the Free Software Foundation 
+## and appearing in the file LICENSE.LGPL included in the packaging 
+## of this file. 
+## 
+############################################################################
+
+# generated behaviour implementation
+module MobyBehaviour
+
+  # == description
+  # This module contains example implementation containing tags for documentation generation  
+  #
+  # == behaviour
+  # QtExampleBehaviour
+  #
+  # == requires
+  # testability-driver-sut-qt-plugin
+  #
+  # == input_type
+  # *
+  #
+  # == sut_type
+  # qt
+  #
+  # == sut_version
+  # *
+  #
+  # == objects
+  # *;sut
+  #
+  module Example
+
+    include MobyBehaviour::Behaviour
+
+  private # construction
+
+    # this method will be called once module is extended to test object  
+    def self.extended( object )
+
+      object.instance_exec{
+
+        # default settings (optional)
+        initialize_behaviour_settings
+
+      }
+
+    end
+  
+    # this method will be called once behaviour is extended to test object
+    def initialize_behaviour_settings
+
+    end
+
+  public # behaviours
+
+    # TODO: jotain
+    # this line won't be documented
+    #
+    # == description
+    # Cause a drag operation on the screen. Basically the same as flick or gesture but done slowly.
+    #
+    # == arguments
+    # direction
+    #  description:  Angle of direction of the drag. Supported range is from 0 to 360
+    #  example:   180 
+    #  default:   
+    #
+    # direction
+    #  type:     Symbol 
+    #  description:  Symbol of direction of the drag. See Valid drag direction symbols table for valid values.
+    #  example:  :Right
+    #  default:   :Left
+    #
+    # distance
+    #  type:    Integer
+    #  description:  Distance in pixels of the drag motion
+    #  example:  10
+    #  default:
+    #
+    # button
+    #  type:    Symbol
+    #  description:  Symbol of button used for drag. See Valid drag button symbols table for valid values.
+    #  example:  :Left
+    #  default:  :Left
+    #
+    # == returns
+    # MobyBase::TestObject
+    #  description:  Target test object
+    #   example:
+    # 
+    # MobyBase::TestObject2
+    #  description:  Target test object2
+    #  example:  example2
+    #
+    # == exceptions
+    # MobyBase::TestObjectNotFoundError
+    #  description:  If a graphics item is not visible on screen
+    #      lisäää descriptionia
+    #
+    # ArgumentError
+    #  description:  If an invalid direction or button is given
+    #    
+    # == example
+    # # Drag QGraphicsItem with tooltip 'node1' down 50 pixels
+    # @sut.application.GraphWidget.QGraphicsItem(:tooltip => 'node1').drag(:Down, 50)
+    #
+    # # Drag 'test_object' up 200 pixels
+    # @test_object = @sut.application.GraphWidget.QGraphicsItem(:tooltip => 'node1')
+        # @test_object.drag(:Up, 200)
+    #
+    # == see
+    # flick, gesture
+    def drag( direction, distance, button = :Left )
+
+      # implementation
+
+    end
+=begin
+    # documentation for the method
+    def []=( value )
+
+      # implementation
+
+    end
+
+    # documentation for the method
+    def []( value )
+
+      # implementation
+
+    end
+
+    # documentation for the method
+    def d
+
+      # implementation
+
+    end
+
+    # documentation for the method
+    def <=>( other )
+
+      # implementation
+
+    end
+
+    # documentation for the method
+    def e()
+
+      # implementation
+
+    end
+
+    # documentation for the method
+    def f!()
+
+      # implementation
+
+    end
+
+    # documentation for the method
+    def g?()
+
+      # implementation
+
+    end
+
+    # documentation for the method
+    def x# dada
+
+      # implementation
+
+    end
+=end
+    attr_accessor :xxz
+
+    attr_reader :yys
+
+  end # Example
+
+end # MobyBehaviour

data/lib/tdriver-devtools/behaviour/old/xml/generate_behaviour_xml.rb

@@ -0,0 +1,95 @@
+############################################################################
+## 
+## Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). 
+## All rights reserved. 
+## Contact: Nokia Corporation (testabilitydriver@nokia.com) 
+## 
+## This file is part of Testability Driver. 
+## 
+## If you have questions regarding the use of this file, please contact 
+## Nokia at testabilitydriver@nokia.com . 
+## 
+## This library is free software; you can redistribute it and/or 
+## modify it under the terms of the GNU Lesser General Public 
+## License version 2.1 as published by the Free Software Foundation 
+## and appearing in the file LICENSE.LGPL included in the packaging 
+## of this file. 
+## 
+############################################################################
+#!/usr/bin/env ruby
+require 'rdoc/rdoc'
+
+# delete doc
+#`rm -rf doc`
+
+module RDoc
+
+=begin
+  class Stats
+    
+    alias old_print print
+
+    def print(*args)
+
+      puts "---------------"
+
+      old_print
+
+      puts ""
+
+    end
+
+  end
+=end
+
+  class RDoc
+
+    # install custom generator to RDoc
+    def install_generator( name, filename )
+
+        GENERATORS[ name.to_s.downcase ] = Generator.new(
+        filename,
+        "#{ name.to_s }Generator".intern,
+        name.to_s.downcase
+      )
+
+    end
+
+  end
+
+end
+
+if ARGV.count == 0
+  
+  puts "\nUsage: #{ $0 } filename.rb\n\n"
+  exit
+
+else
+
+  ARGV.each{ | filename | 
+
+    abort("\nUnable to create behaviours XML due to implementation file %s not found\n\n" % [ filename ] ) unless File.exist?( File.expand_path( filename ) )
+
+  }
+
+end
+
+begin
+
+  RDoc::RDoc.new.tap{ | rdoc |
+
+    rdoc.install_generator( 'TDriver', File.expand_path( File.join( File.dirname( __FILE__ ), 'lib/tdriver_generator.rb' ) ) )
+
+    #rdoc.document( ['--inline-source', '--quiet', '--fmt', 'tdriver'] + ARGV )
+    rdoc.document( ['--inline-source', '--fmt', 'tdriver'] + ARGV )
+
+  }
+
+rescue RDoc::RDocError => e
+
+  $stderr.puts e.message
+
+  exit( 1 )
+
+end
+

data/lib/tdriver-devtools/behaviour/old/xml/lib/tdriver_generator.rb

@@ -0,0 +1,722 @@
+############################################################################
+## 
+## Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). 
+## All rights reserved. 
+## Contact: Nokia Corporation (testabilitydriver@nokia.com) 
+## 
+## This file is part of Testability Driver. 
+## 
+## If you have questions regarding the use of this file, please contact 
+## Nokia at testabilitydriver@nokia.com . 
+## 
+## This library is free software; you can redistribute it and/or 
+## modify it under the terms of the GNU Lesser General Public 
+## License version 2.1 as published by the Free Software Foundation 
+## and appearing in the file LICENSE.LGPL included in the packaging 
+## of this file. 
+## 
+############################################################################
+
+module Generators
+  
+  abort("") unless defined?( RDoc )
+
+	class TDriverGenerator                 
+
+		TYPE = {
+
+			:file		=> 1, 
+			:class		=> 2, 
+			:module		=> 3 
+
+		}
+
+		VISIBILITY  = {
+
+			:public		=> 1, 
+			:private	=> 2, 
+			:protected	=> 3 
+
+		}
+
+		PROCESS_METHODS = { 
+
+			:method_list 	=> :process_method, 
+			:aliases 	=> :process_alias,
+			:constants 	=> :process_constant, 
+			:requires 	=> :process_require, 
+			:includes 	=> :process_include, 
+			:attributes 	=> :process_attribute 
+
+		}
+
+		def TDriverGenerator.for( options )
+
+			new( options )
+
+		end
+
+		def initialize( options ) #:not-new:
+
+			@options = options
+
+			@current_behaviour = nil
+
+			@behaviours = {}
+
+			# set up a hash to keep track of all the classes/modules we have processed
+			@already_processed = {}
+
+			@module_template = template( "templates/behaviour.module" )
+			@method_template = template( "templates/behaviour.method" )
+
+			@xml_behaviour_template = template( "templates/behaviour.xml" )
+			@xml_method_template = template( "templates/behaviour.xml.method" )
+			@xml_argument_template = template( "templates/behaviour.xml.argument" )
+			@xml_argument_type_template = template( "templates/behaviour.xml.argument_type" )
+			@xml_exception_template = template( "templates/behaviour.xml.exception" )
+			@xml_howto_template = template( "templates/behaviour.xml.howto" )
+			@xml_howto_line_template = template( "templates/behaviour.xml.howto.line" )
+			
+			
+			# set up a hash to keep track of all of the objects to be output
+			@output = {
+				:files => [], 
+				:classes => [], 
+				:modules => [], 
+				:attributes => [], 
+				:methods => [], 
+				:aliases => [], 
+				:constants => [], 
+				:requires => [], 
+				:includes => []
+			}
+		end
+
+		# Rdoc passes in TopLevel objects from the code_objects.rb tree (all files)
+		def generate( files )
+                             
+			# Each object passed in is a file, process it
+			files.each { | file | 
+
+				process_file( file )
+
+			}
+
+		end
+
+	private
+
+		def process_comment( comment )
+
+			hash = { :nodoc => [] }
+
+			section = :nodoc # hash.keys.first
+
+			comment.lines.each{ | line |
+
+				# remove line feed
+				line.gsub!( /\n/, '' )
+
+				#match = nil
+
+				#if /^\s*#[ ]*(.*)$/.match( line )
+				if /^\s*#\s(.*)$/.match( line )
+
+					match = $1
+
+					if /^==\s{1,}(.*)\s*$/.match( match )
+
+						section = $1.gsub( /\s/, '_' ).to_sym
+
+						hash[ section ] = [] 
+
+						next
+
+					end
+
+				end
+
+				hash[ section ] << match.rstrip unless section.nil? || match.nil? || match.empty?
+
+			}
+
+			hash
+
+		end
+
+		def parse_to_sections( array )
+
+			result = []
+
+			tag = nil
+
+			array.each{ | line |
+
+				if /^\w/.match( line )
+
+					result << { :section => line }
+
+					tag = nil
+
+				end
+
+				if /^\s/.match( line )
+
+					raise RuntimeError.new( "No section defined for '%s' in method '%s'" % [ line, $current_method ] ) if result.last.nil?
+
+					#if /^\s{1}(\w+)\s*(.*)$/.match( line )
+					if /^\s+(\w+):\s*(.*)$/.match( line )
+
+						tag = $1
+
+						value = $2.strip
+
+					elsif /^\s+(.*)$/.match( line )
+
+						raise RuntimeError.new( "No tag defined for '%s' in method '%s'" % [ line, $current_method ] ) unless tag
+
+						value = $1.strip
+
+					end
+
+					# store empty array to tag key if none already exists
+					( result.last[ tag.to_sym ] ||= [] ).tap{ | values |
+
+						values.concat( [ value ] )
+
+					}
+
+				end
+			}
+
+			result
+
+		end
+=begin		
+		def parse_to_sections_debug( array )
+
+			result = []
+
+			tag = nil
+
+			array.each{ | line |
+
+				if /^\w/.match( line )
+
+					result << { :section => line }
+
+					tag = nil
+
+				end
+
+				if /^\s/.match( line )
+
+					raise RuntimeError.new( "No section defined for '%s'" % [ line ] ) if result.last.nil?
+
+					puts "S1: " << line.inspect
+					#if /^\s{1}(\w+)\s*(.*)$/.match( line )
+					if /^\s+(\w+):\s*(.*)$/.match( line )
+
+						puts "S1-a: " << line.inspect
+						tag = $1
+
+						value = $2.strip
+
+					elsif /^\s+(.*)$/.match( line )
+
+						puts "S1-b: " << line.inspect
+						raise RuntimeError.new( "No tag defined for '%s'" % [ line ] ) unless tag
+
+						value = $1.strip
+
+					end
+					
+					puts "V: " << value.inspect
+
+					# store empty array to tag key if none already exists
+					( result.last[ tag.to_sym ] ||= [] ).tap{ | values |
+
+						values.concat( [ value ] )
+
+					}
+
+				end
+			}
+			
+			puts "R: " << result.inspect
+
+			result
+
+		end
+=end
+		def process_header_comment( module_header )
+
+			# process data
+			module_header.each_pair{ | key, value |
+
+				case key
+	
+					when :behaviour, :description, :nodoc
+						# do nothing
+
+					when :objects, :sut_type, :sut_version, :input_type, :requires
+
+						module_header[ key ] = value.to_s.split(";")
+
+				else
+
+					puts "Unknown module header tag: %s" % key
+
+				end
+
+			}
+
+		end
+
+		def process_method_comment( method )
+
+			#p array
+
+			#p array.class
+
+			#array.each{ | method |
+
+				#p method
+
+				method.each_pair{ | key, value |
+
+					#p key, value
+
+					#next
+
+					case key
+
+						when :nodoc, :method_name
+
+							# do nothing
+							method[ key ] = value.to_s.strip
+
+						when :example, :description, :info
+
+							method[ key ] = value.join('\n')
+
+						when :see
+							method[ key ] = value.to_s.gsub(/\s+/, "").split(",")
+
+						when :returns, :exceptions, :howto
+
+							method[ key ] = parse_to_sections( value )							
+
+						when :arguments
+						
+							method[ key ] = parse_arguments( value )
+						
+						else
+
+							puts "Unknown method header tag: %s" % key
+
+					end
+
+				}
+
+			#}
+
+			method
+			#array
+
+		end
+		
+		def parse_arguments( arguments )
+					
+			args = {}
+			
+			result = []
+			last_key = nil
+
+			tag = nil
+
+			arguments.each{ | line |
+
+				if /^\w/.match( line )
+
+					if !last_key.nil?
+					
+						args[ last_key ] = parse_to_sections( args[ last_key ] )
+						
+					end
+					
+					last_key = line.strip.to_sym
+					args[ last_key ] = []
+
+					tag = nil
+
+				end
+				
+				
+				if /^\s/.match( line )
+
+					if /^\s+(\w+):\s*(.*)$/.match( line )
+						
+						args[ last_key ] << line
+
+					elsif /^\s+(.*)$/.match( line )
+
+						args[ last_key ] << line.strip
+						
+					end
+
+				end
+
+			}
+			
+			if !last_key.nil?
+
+				args[ last_key ] = parse_to_sections( args[ last_key ] )
+						
+			end
+		
+			args
+		
+		end
+
+		def apply_macros( template_string, macros )
+
+			template_string.clone.tap{ | template |
+
+				macros.each{ | hash |
+
+					h = hash[ :value ]
+
+					h = h.first if h.kind_of?( Array )
+
+					h ||= ""
+
+					template.gsub!( hash[ :key ], h )
+
+				}
+
+			}
+
+		end
+
+		def encode_string( string )
+
+			result = "%s" % string
+
+			result.gsub!( '&', '&amp;')
+			result.gsub!( '<', '&lt;')
+			result.gsub!( '>', '&gt;')
+
+			result
+
+		end
+
+		def behaviour_methods_arguments( arguments )
+
+			#puts "ARG-in: " << arguments.inspect
+
+			arg_out = ""
+			if !arguments.empty?
+				arguments.each_pair do | arg_key, arg_value |
+					arg_out += apply_macros(
+						@xml_argument_template,
+						[
+							{ :key => '$ARGUMENT_NAME', :value => encode_string( arg_key.to_s ) },
+							{ :key => '$METHOD_ARGUMENT_TYPES', :value => behaviour_methods_argument_types( arg_value ) }
+						]
+					)		
+				end
+			end
+			
+			arg_out
+
+		end
+		
+		def behaviour_methods_argument_types( types )
+
+			( types || [] ).collect{ | type | 
+			 
+				apply_macros( 
+					@xml_argument_type_template,
+					[						
+						{ :key => '$ARGUMENT_TYPE', :value => encode_string( type[ :section ].first ) },
+						{ :key => '$ARGUMENT_DESCRIPTION', :value => encode_string( type[ :description ].join( '\n' ) ) },
+						{ :key => '$ARGUMENT_EXAMPLE', :value => encode_string( type[ :example ].first ) },
+						{ :key => '$ARGUMENT_DEFAULT', :value => encode_string( type[ :default ].first ) }
+
+					]
+
+				)
+
+			}.join()
+
+		end
+
+		def behaviour_methods_exceptions( exceptions )
+
+			( exceptions || [] ).collect{ | exception | 
+
+				apply_macros( 
+					@xml_exception_template, 
+					[
+						{ :key => '$EXCEPTION_NAME', :value => encode_string( exception[ :section ] ) },
+						{ :key => '$EXCEPTION_DESCRIPTION', :value => encode_string( exception[ :description ].join('\n') ) }
+
+					] 
+				)
+			}.join 
+
+		end
+		
+		def behaviour_methods_howtos( howtos )
+
+			( howtos || [] ).collect{ | howto | 
+				
+				apply_macros( 
+					@xml_howto_template, 
+					[
+						{ :key => '$HOWTO_DESCRIPTION', :value => encode_string( howto[ :description ] ) },
+						{ :key => '$HOWTO_CODE', :value => behaviour_methods_howto_lines( howto[ :code ] ) }
+
+					] 
+				)
+			}.join 
+			
+		end
+		
+		def behaviour_methods_howto_lines( code_lines )
+
+			( code_lines || [] ).collect{ | code_line | 
+				
+				apply_macros( 
+					@xml_howto_line_template, 
+					[
+						{ :key => '$HOWTO_LINE', :value => encode_string( code_line ) }
+					] 
+				)
+			}.join 
+			
+		end
+		
+		def behaviour_methods( methods )
+
+			methods.collect{ | method | 
+
+				apply_macros( 
+					@xml_method_template, 
+					[
+						{ :key => '$METHOD_NAME', :value => encode_string( method[ :method_name ] ) },
+						{ :key => '$METHOD_DESCRIPTION', :value => encode_string( method[ :description ] ) },
+						{ :key => '$METHOD_EXAMPLE', :value => encode_string( method[ :example ] ) },
+						{ :key => '$METHOD_ARGUMENTS', :value => behaviour_methods_arguments( method[ :arguments ] ) }, 
+						{ :key => '$METHOD_EXCEPTIONS', :value => behaviour_methods_exceptions( method[ :exceptions ] ) },
+						{ :key => '$METHOD_HOWTOS', :value => behaviour_methods_howtos( method[ :howto ] ) },
+						{ :key => '$METHOD_INFO', :value => encode_string( method[ :info ] ) }
+					] 
+				) 
+
+			}.join
+
+		end
+
+		def generate_behaviour( module_header, methods )
+
+			unless module_header[ :module ].to_s == "MobyBehaviour"
+
+				xml = apply_macros( 
+					@xml_behaviour_template, 
+					[
+						{ :key => '$REQUIRED_PLUGIN', :value => module_header[ :requires ] || [].join( ";" ) },
+						{ :key => '$BEHAVIOUR_NAME', :value => module_header[ :behaviour ] || [].first },
+						{ :key => '$OBJECT_TYPE', :value => module_header[ :objects ] || [].join( ";" ) },
+						{ :key => '$SUT_TYPE', :value => module_header[ :sut_type ] || [].join( ";" ) },
+						{ :key => '$INPUT_TYPE', :value => module_header[ :input_type ] || [].join( ";" ) },
+						{ :key => '$VERSION', :value => module_header[ :sut_version ] || [].join( ";" ) },
+						{ :key => '$MODULE_NAME', :value => module_header[ :module ] },
+						{ :key => '$BEHAVIOUR_METHODS', :value => behaviour_methods( methods ) }
+					]
+
+				).gsub( /\n\n\n/, "\n\n" ) unless module_header[ :module ].to_s == "MobyBehaviour"
+
+        unless module_header[ :behaviour ].to_s.empty?
+
+  				File.open( "%s.xml" % module_header[ :behaviour ], 'w'){ | file | file << xml } 
+
+				  puts xml
+
+        end
+
+
+			end
+
+		end
+
+		def process_object( file )
+
+			PROCESS_METHODS.each_pair{ | list, method |
+
+				file.send( list ).each{ | child | send( method, child ) }
+
+			} 
+
+		end
+
+		# process a file from the code_object.rb tree
+		def process_file( file )
+
+			@current_behaviour = nil
+
+			@behaviours = {}
+	
+			@output[ :files ] << file
+
+			#puts "#{file.comment}"
+
+			# Process all of the objects that this file contains
+			process_object( file )
+
+			# Recursively process contained subclasses and modules 
+			file.each_classmodule do | child |
+
+				process_class_or_module( child )
+
+			end
+
+			@behaviours.each_pair{ | key, value |
+
+				generate_behaviour value[ :header ], value[ :methods ]
+
+			}
+
+		end
+
+		def template( filename )
+
+			open( File.join( File.dirname( File.expand_path( __FILE__ ) ), "..", "%s.template" % filename ) ).read
+
+		end
+
+		# Process classes and modiles   
+		def process_class_or_module( obj )
+
+			type = obj.is_module? ? ( :modules ) : ( :classes )
+
+			if( !@already_processed.has_key?( obj.full_name ) ) then      
+
+				@output[ type ].push( obj )
+
+				@already_processed[ obj.full_name ] = true
+
+				header = process_comment( obj.comment )
+				
+				process_header_comment( header )
+
+				header[ :module ] = obj.full_name
+
+				@behaviours[ ( @current_behaviour = obj.full_name ) ] = {
+ 
+					:header 	=> header,
+
+					:methods	=> []
+
+				}
+
+				# Process all of the objects that this class or module contains
+				process_object( obj ) if obj.full_name =~ /^MobyBehaviour::/
+
+			end
+
+			#id = @already_processed[ obj.full_name ]
+			# Recursively process contained subclasses and modules 
+
+			obj.each_classmodule do | child | 
+
+				process_class_or_module( child ) 
+
+			end
+
+		end       
+
+		def process_method( obj )  
+
+			#obj.source_code = get_source_code( obj )
+
+			if ( obj.visibility == :public )
+
+        $current_method = obj.name.to_str
+
+				comment = process_comment( obj.comment || "" )
+
+				process_method_comment( comment )
+
+				comment[ :method_name ] = obj.name.to_str
+
+				@behaviours[ @current_behaviour ][ :methods ] << comment
+
+				#puts "\n%s (%s)" % [ obj.name, obj.visibility ] #{obj.param_seq}"
+
+				#puts "#{obj.source_code}" # Source code, unformatted
+				#puts "====================================="
+
+			end
+
+			@output[ :methods ] << obj
+
+		end
+
+		def process_alias( obj )
+
+			@output[ :aliases ] << obj
+
+		end
+
+		def process_constant( obj )
+
+			@output[ :constants ] << obj
+
+		end
+
+		def process_attribute( obj )
+
+			#puts "\n%s (%s, %s)" % [ obj.name, obj.visibility, obj.rw ] #{obj.param_seq}"
+			#p process_comment( obj.comment || "" )
+
+			@output[ :attributes ] << obj     
+
+		end
+
+		def process_require( obj )
+
+			@output[ :requires ] << obj 
+
+		end
+
+		def process_include( obj )
+
+			@output[ :includes ] << obj
+
+		end   
+
+		# get the source code
+		def get_source_code( method )
+
+			method.token_stream.collect{ | token |
+
+				token ? token.text : "" 
+				
+			}.join
+
+		end
+
+	end
+
+	# dynamically add a source code attribute to the base oject of code_objects.rb
+	class RDoc::AnyMethod
+
+		attr_accessor :source_code	  
+
+	end
+
+end
+