divine 0.0.3 → 0.0.4

data/lib/divine/dsl.rb

@@ -1,39 +1,73 @@
 module Divine
+  # Contains all defined structs
   $all_structs = {}
 
+  #
+  # Encapsulation basic struct information
+  #
   class StructDefinition
+
     def initialize(owner, type, args)
       @owner = owner
       @type = type
       @args = args
     end
   
+    #
+    # Get struct's name
+    #
     def name
       @args.first
     end
-  
+
     def type
       @type
     end
-    
+
+    #
+    # Get struct's version
+    #
     def version 
       @owner.version
     end
-    
+
+    #
+    # Represents strut as string
+    #
     def to_s
       "#{@owner.name}: #{self.type} #{self.name} (#{self.class.name}, #{@args.inspect})"
     end
   end
 
+  #
+  # Encapsulation simple struct information
+  #
   class SimpleDefinition < StructDefinition
+    #
+    # Ask if the struct is simple.
+    # * +Return+ : True
     def simple?; true; end
+    
+    #
+    # Get types used in the struct
+    #
     def referenced_types
       [@type]
     end
   end
 
+  #
+  # Encapsulation complex struct information
+  #
   class ComplexDefinition < StructDefinition
+    #
+    # Ask if the struct is simple.
+    # * *Return* : False
     def simple?; false; end
+
+    #
+    # Get types used in the struct
+    #
     def referenced_types
       fs = referenced_types_internal.map do |t|
         if t.is_a? StructBuilder
@@ -48,48 +82,100 @@ module Divine
     end
   end
 
+  #
+  # Encapsulation for dynamic integer date type
+  #
+  class DynamicInteger63Definition < SimpleDefinition
+  end
+
+  #
+  # Encapsulation for signed integer 64-bit date type
+  #
   class SInteger64Definition < SimpleDefinition
   end
 
+  #
+  # Encapsulation for signed integer 32-bit date type
+  #
   class SInteger32Definition < SimpleDefinition
   end 
 
+  #
+  # Encapsulation for unsigned integer 32-bit date type
+  #
   class Integer32Definition < SimpleDefinition
   end
 
+  #
+  # Encapsulation for unsigned integer 24-bit
+  #
   class Integer24Definition < SimpleDefinition
   end
 
+  #
+  # Encapsulation for unsigned integer 16-bit data type
+  #
   class Integer16Definition < SimpleDefinition
   end
 
+  #
+  # Encapsulation for unsigned integer 8-bit data type
+  #
   class Integer8Definition < SimpleDefinition
   end
 
+  #
+  # Encapsulation for binary data type
+  #
   class BinaryDefinition < SimpleDefinition
   end
 
+  #
+  # Encapsulation for short binary data type
+  #
   class ShortBinaryDefinition < SimpleDefinition # Shorted than 256 bytes
   end
 
+  #
+  # Encapsulation for string data type
+  #
   class StringDefinition < SimpleDefinition
   end
 
+  #
+  # Encapsulation for boolean data type
+  #
   class BooleanDefinition < SimpleDefinition
   end
 
+  #
+  # Encapsulation for IP(v4 & v6) data type
+  #
   class IpNumberDefinition < SimpleDefinition
   end
 
-
+  #
+  # Encapsulation for list data type
+  #
   class ListDefinition < ComplexDefinition
+    
+    #
+    # Return internal types contained in current list
+    #
     protected
     def referenced_types_internal
       [@args[1]]
     end
   end
 
+  #
+  # Encapsulation for map[dictionary] data type
+  #
   class MapDefinition < ComplexDefinition
+
+    #
+    # Return internal types contained in current map
+    #
     protected
     def referenced_types_internal
       [@args[1], @args[2]]
@@ -97,8 +183,9 @@ module Divine
   end
 
 
-
+  # Contains all supported data type
   $available_types = {
+    dint63: DynamicInteger63Definition,
     sint64: SInteger64Definition,
     sint32: SInteger32Definition,
     int32: Integer32Definition,
@@ -114,7 +201,9 @@ module Divine
     ip_number: IpNumberDefinition
   }
 
-
+  #
+  # Responsible for building structs 
+  #
   class StructBuilder
     # Name = name of the struct
     # Version = struct version (not currently used)

data/lib/divine/graph_generator/graph_generator.rb

@@ -0,0 +1,81 @@
+require 'graphviz'
+
+module Divine
+
+  #
+  # Responsible for drawing ERD diagram corresponding to structs
+  #
+  class GraphGenerator
+
+    #
+    # Draw Graph for current structs on $all_structs 
+    # * *Args* :
+    #  -path- -> target path
+    def draw(path = "", file_name = "graph", format = "jpg")
+      @relations = {}
+      @nodes_map = {}
+      @graph = GraphViz.new( :G, :type => :digraph )
+      $all_structs.keys.each do |k|
+          name = "Struct: #{k}"
+          content = "Temp Contents"
+          simple_fields = ""
+          complex_fields = ""
+          $all_structs[k][0].simple_fields.each  { |f|
+            simple_fields  << "#{f.name}: #{f.type}\n"
+          }
+          $all_structs[k][0].complex_fields.each { |f|
+            type = f.referenced_types.to_s.gsub(':','').gsub("[list,", "list[").gsub("[map,", "map[").gsub(/[\s]*/, "").gsub("[", "&lt;").gsub("]", "&gt;")
+            $all_structs.keys.each do |l|
+              if type.include?(l.to_s)
+                addRelation(l, k)
+              end
+            end
+            complex_fields << "#{f.name}: #{type}\n"
+          }
+          content = simple_fields + complex_fields
+          @nodes_map[k] = addNode(name, content)
+      end
+      
+      addLinks()
+
+      # Generate output image
+      @graph.output( format.to_sym => File.join(path, "#{file_name}.#{format}") )
+    end
+  
+
+    #
+    # Add node to the graph
+    # * *Args* :
+    #  -struct_name- -> struct name
+    #  -struct_content- -> struct contents "Fields"
+    def addNode(struct_name, struct_content)
+      @graph.add_nodes( "{ #{struct_name} | #{struct_content} }", "shape" => "record", "style" => "rounded")
+    end
+ 
+
+    #
+    # Build links from relation map
+    # 
+    def addLinks()
+      @relations.each_pair do |src, trgs|
+        trgs.each { |trg|
+          @graph.add_edges( @nodes_map[trg], @nodes_map[src] )
+        }
+      end
+    end
+    
+    #
+    # Add relation between nodes
+    # * *Args* :
+    #  -src- -> the source struct
+    #  -trg- -> the target struct
+    def addRelation(src, trg)
+      if @relations.keys.include?(src)
+        @relations[src].push(trg)
+      else
+        @relations[src] = [trg]
+      end
+    end
+  end
+
+end

data/lib/divine/version.rb

@@ -1,3 +1,4 @@
 module Divine
-  VERSION = "0.0.3"
+  # Divine Version
+  VERSION = "0.0.4"
 end

data/test/basic_complex_test/basic_complex_test.rb

@@ -24,11 +24,16 @@ struct(:TestComplex) {
   }
 }
 
+# Draw ERD for prev. structs
+Divine::GraphGenerator.new.draw("test/basic_complex_test/")
+
 if ARGV[0] == "ruby"
   Divine::CodeGenerator.new.generate(:ruby, file: 'test_babel.rb', module: 'BabelTest', parent_class: "Object", target_dir: 'test/basic_complex_test/ruby_test')
 elsif ARGV[0] == "js"
   Divine::CodeGenerator.new.generate(:javascript, file: 'test_babel.js', target_dir: 'test/basic_complex_test/js_test')
 elsif ARGV[0] == "java"
   Divine::CodeGenerator.new.generate(:java, file: 'test_babel.java', target_dir: 'test/basic_complex_test/java_test')
+elsif ARGV[0] == "csharp"
+  #Divine::CodeGenerator.new.generate(:csharp, file: 'test_babel.cs', target_dir: "test/basic_complex_test/csharp_test")
 end
 

data/test/basic_complex_test/java_test/JavaTest.java

@@ -72,7 +72,7 @@ public class JavaTest {
 		
     }
     
-    	public void serialize(BabelBase obj) throws IOException {
+    	public void serialize(Divine obj) throws IOException {
 		byte[] data = obj.serialize();
 		File file = new File("test/basic_complex_test/java_test/bin.babel");
 		try {

data/test/basic_complex_test/ruby_test/ruby_test.rb

@@ -1,12 +1,14 @@
 require_relative 'test_babel.rb'
 require 'minitest/autorun'
 
+#
+# Responsible for testing basic and complex structure
+#
 class TestBabelTestBasic < MiniTest::Unit::TestCase
 
-  def setup
-    
-  end
-
+  #
+  # Compare objects after serialize and deserialize operations "simple structure"
+  #
   def test_basic
     puts "Basic Test"
     testbasic_ser = BabelTest::TestBasic.new
@@ -32,6 +34,9 @@ class TestBabelTestBasic < MiniTest::Unit::TestCase
     assert_equal testbasic_ser.guid , testbasic_deser.guid
   end
 
+  #
+  # Compare objects after serialize and deserialize operations "complex structure"
+  #
   def test_complex
     testcomplex_ser = BabelTest::TestComplex.new
     testcomplex_ser.list1 = [0, 1, 255, 0x7FFFFFFF, 0x7FFFFFFF+1, 0xFFFFFFFE, 0xFFFFFFFF]
@@ -56,12 +61,20 @@ class TestBabelTestBasic < MiniTest::Unit::TestCase
     end
   end
 
+  #
+  # Write binary data to file
+  # * *Args* :
+  #  -data-   --> bytes to be written
+  #
   def serialize(data)
     File.open("test/basic_complex_test/ruby_test/bin.babel.rb", "w+b") do |f|
       f.write(data)
     end
   end
 
+  #
+  # Read file in binary mode and return its bytes content
+  #
   def deserialize()
     mem_buf = File.new('test/basic_complex_test/ruby_test/bin.babel.rb').binmode
   end

data/test/binaryTree_test/binaryTree_test.rb

@@ -10,10 +10,15 @@ struct 'BinaryTree' do
   list :root_node, :Node   # List of root node of size equals to 1.
 end
 
+# Draw ERD for prev. structs
+Divine::GraphGenerator.new.draw("test/binaryTree_test/", "graph", "png")
+
 if ARGV[0] == "ruby"
   Divine::CodeGenerator.new.generate(:ruby, file: 'test_binaryTree.rb', module: 'BabelTest', parent_class: "Object", target_dir: 'test/binaryTree_test/ruby_test')
 elsif ARGV[0] == "js"
   Divine::CodeGenerator.new.generate(:javascript, file: 'test_binaryTree.js', target_dir: 'test/binaryTree_test/js_test')
 elsif ARGV[0] == "java"
   Divine::CodeGenerator.new.generate(:java, file: 'test_binaryTree.java', target_dir: 'test/binaryTree_test/java_test')
+elsif ARGV[0] == "csharp"
+  Divine::CodeGenerator.new.generate(:csharp, file: 'test_binaryTree.cs', target_dir: "test/binaryTree_test/csharp_test")
 end

data/test/binaryTree_test/csharp_test/csharp_test.cs

@@ -0,0 +1,99 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+using System.IO;
+using divine;
+using NUnit.Framework;
+
+namespace test_signed_int
+{
+    [TestFixture]
+    class divine
+    {
+        [Test]
+        public static void Main(String[] args)
+        {
+	    System.Console.Write("Test Binary Tree  \n");
+            BinaryTree ser = buildObj();
+            serialize(ser);
+            byte[] res = deserialize();
+
+            BinaryTree deser = new BinaryTree();
+            deser.deserialize(new MemoryStream(res));
+
+            compare(ser, deser);            
+        }
+
+        public static BinaryTree buildObj() {
+		Node root = new Node();
+		root.i32 = 0;
+
+		Node n1_L = new Node();
+		n1_L.i32 = 1;
+
+		Node n1_R = new Node();
+		n1_R.i32 = 2;
+
+		Node n2_L_L = new Node();
+		n2_L_L.i32 = 3;
+
+		Node n2_L_R = new Node();
+		n2_L_R.i32 = 4;
+
+		Node n2_R_L = new Node();
+		n2_R_L.i32 = 5;
+
+		Node n2_R_R = new Node();
+		n2_R_R.i32 = 6;
+
+		root.next_node.Add(n1_L);
+		root.next_node.Add(n1_R);
+
+		n1_L.next_node.Add(n2_L_L);
+		n1_L.next_node.Add(n2_L_R);
+
+		n1_R.next_node.Add(n2_R_L);
+		n1_R.next_node.Add(n2_R_R);
+
+		BinaryTree bt = new BinaryTree();
+		bt.root_node.Add(root);
+
+            return bt;
+	    }
+
+        public static void compare(BinaryTree bt1, BinaryTree bt2)
+        {
+            Assert.AreEqual(bt1.root_node.Count, bt2.root_node.Count);
+	    Assert.AreEqual(bt1.root_node[0].i32, bt2.root_node[0].i32);
+	    Assert.AreEqual(bt1.root_node[0].next_node.Count, bt2.root_node[0].next_node.Count);
+	    Assert.AreEqual(bt1.root_node[0].next_node[0].next_node[0].i32,
+				bt2.root_node[0].next_node[0].next_node[0].i32);
+        }
+
+        public static void serialize(Divine obj)
+        {
+            try
+            {
+                byte[] data = obj.serialize();
+                File.WriteAllBytes("test/binaryTree_test/csharp_test/bin.babel.csharp", data);                
+            }
+            catch (System.IO.IOException ex)
+            {
+                throw ex;
+            }
+	    }
+
+	    public static byte[] deserialize(){
+            try
+            {
+                byte[] data = File.ReadAllBytes("test/binaryTree_test/csharp_test/bin.babel.csharp");
+                return data;
+            }
+            catch (System.IO.IOException ex)
+            {
+                throw ex;
+            }
+	    }
+            
+    }
+}