cgialib 0.0.2 → 0.0.3

data/History.txt

@@ -2,3 +2,9 @@
 
 * 1 major enhancement:
   * Initial release
+
+== 0.0.3 2008-11-22
+* 2 major enhancement:
+  * testgen is available to generate Unit Test for C
+  * docgen is available to generate HTML Doc for SQL
+

data/Manifest.txt

@@ -3,13 +3,18 @@ Manifest.txt
 PostInstall.txt
 README.rdoc
 Rakefile
+bin/docgen
 bin/testgen
 config/website.yml.sample
 examples/ut/mytest1.c
+examples/docgen/tables.sql
+features/docgen.feature
 features/language_parser.feature
 features/steps/language_parser.rb
+features/steps/docgen.rb
 features/steps/env.rb
 lib/cgialib.rb
+lib/docgen/cli.rb
 lib/testgen/cli.rb
 lib/cgialib/lp.rb
 lib/cgialib/template.rb
@@ -32,6 +37,10 @@ spec/cgialib_spec.rb
 spec/spec.opts
 spec/spec_helper.rb
 spec/testgen_cli_spec.rb
+templates/ut/c.template
+templates/docgen/index.html.template
+templates/docgen/table_page.html.template
+templates/docgen/tables.html.template
 tasks/rspec.rake
 website/index.html
 website/index.txt

data/README.rdoc

@@ -9,11 +9,13 @@ Import the examples in Code Generation In Action
 == FEATURES/PROBLEMS:
 
 * language parsers
-* unit test generators
+* unit test generators for C
+* HTML DOC generators for SQL
 
 == SYNOPSIS:
 
-  testgen test.c
+  testgen -s test.c
+  docgen -s tables.sql
 
 == REQUIREMENTS:
 

data/bin/docgen

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+#
+#  Created on 2008-11-17.
+#  Copyright (c) 2008. All rights reserved.
+
+require File.expand_path(File.dirname(__FILE__) + "/../lib/cgialib")
+
+require "docgen/cli"
+
+Docgen::CLI.execute(STDOUT, ARGV)

data/examples/docgen/tables.sql

@@ -0,0 +1,81 @@
+  drop table Book;
+
+  -- Book contains information about each book, the title, the author, the publisher, etc.
+  --
+  -- @field bookID The primary key id
+  -- @field title The title of the book
+  -- @field ISBN The ISBN number of the book
+  -- @field authorID The author (as a foreign key relation)
+  -- @field publisherID The publisher (as a foreign key relation)
+  -- @field status The active or inactive state of the record
+  -- @field numCompies The number of copies in the library
+  -- @relates_to Author
+  -- @relates_to Publisher
+  create table Book ( 
+    bookID integer not null primary key 
+    ,title varchar(80) not null 
+    ,ISBN varchar(80) not null unique 
+    ,authorID integer not null 
+    ,publisherID integer not null 
+    ,status integer not null 
+    ,numCopies integer not null 
+  );
+
+  grant all on Book to public;
+
+  drop sequence Book_bookID_seq;
+
+  create sequence Book_bookID_seq start 100;
+
+  grant all on Book_bookID_seq to public;
+
+  drop table Author;
+
+  -- Author contains information about the author of a set of books
+  --
+  -- @field authorID The primary key id
+  -- @field name The name of the author
+  -- @field penName The pen name of the author
+  create table Author ( 
+    authorID integer not null primary key 
+    ,name varchar(80) not null unique 
+    ,penName varchar(80) 
+  );
+
+  grant all on Author to public;
+
+  drop sequence Author_authorID_seq;
+
+  create sequence Author_authorID_seq start 100;
+
+  grant all on Author_authorID_seq to public;
+
+  drop table Publisher;
+
+  -- Publisher contains information about the author of a set of books
+  --
+  -- @field publisherID The primary key id
+  -- @field name The name of the publisher
+  create table Publisher ( 
+    publisherID integer not null primary key 
+    ,name varchar(80) not null unique 
+  );
+
+  grant all on Publisher to public;
+
+  drop sequence Publisher_publisherID_seq;
+
+  create sequence Publisher_publisherID_seq start 100;
+
+  grant all on Publisher_publisherID_seq to public;
+
+  alter table Book 
+    add constraint Book_authorID
+    foreign key (authorID)
+    references Author (authorID);
+
+
+  alter table Book 
+    add constraint Book_publisherID
+    foreign key (publisherID)
+    references Publisher (publisherID);

data/features/docgen.feature

@@ -0,0 +1,17 @@
+Feature: Generate HTML Doc for SQL by Language Parser
+
+  As a SQL language designer
+  I want docgen to generate html doc for SQL table
+  So that I can understand the relationships between the tables
+
+  Scenario: Generate HTML Doc for SQL
+    Given this project is active project folder
+    And 'examples/docgen/tables.sql' file is existed
+    And 'examples/docgen/tables.sql' file is copied to 'tmp' folder
+    And file 'tmp/tables.sql' contains /-- @field/
+    When command 'ruby bin/docgen -s tmp/tables.sql' is invoked
+    Then folder 'tmp/html_doc' is created
+    Then file 'tmp/html_doc/index.html' is created
+
+
+

data/features/language_parser.feature

@@ -9,13 +9,13 @@ Feature: Generate Unit Test for C by Language Parser
     And 'examples/ut/mytest1.c' file is existed
     And 'examples/ut/mytest1.c' file is copied to 'tmp' folder
     And file 'tmp/mytest1.c' contains /\/\/ <test.*<\/test>/
-    When command 'testgen -s tmp/mytest1.c' is invoked
+    When command 'ruby bin/testgen -s tmp/mytest1.c' is invoked
     Then file 'tmp/mytest1.c.bak' is created
     And file 'tmp/mytest1.c' contains /\/\/ <test_start>.*?\/\/ <\/test_start>/m
+
   Scenario: Compile and Run the Unit Test
     Given this project is active project folder
     And file 'tmp/mytest1.c' contains /test_start/
     When command 'gcc tmp/mytest1.c -o tmp/mytest1' is invoked
     And command 'tmp/mytest1' is invoked
     Then file 'tmp/tests.out' contains /\(100%\) Unit Test are passed/
-    

data/features/steps/docgen.rb

@@ -0,0 +1,7 @@
+When %r{^command 'ruby bin/docgen -s (.*\.sql)' is invoked$} do |source_file|
+  @stdout = File.expand_path(File.join(@tmp_root, "tests.out"))
+  FileUtils.chdir(@active_project_folder) do
+    system "ruby bin/docgen -s #{source_file} > #{@stdout} 2> #{@stdout}"
+  end
+end
+

data/features/steps/language_parser.rb

@@ -38,10 +38,10 @@ Given %r{'(.*)' file is deleted} do |file|
   end
 end
 
-When %r{^command 'testgen -s (.*\.c)' is invoked$} do |source_file|
+When %r{^command 'ruby bin/testgen -s (.*\.c)' is invoked$} do |source_file|
   @stdout = File.expand_path(File.join(@tmp_root, "tests.out"))
   FileUtils.chdir(@active_project_folder) do
-    system "testgen -s #{source_file} > #{@stdout} 2> #{@stdout}"
+    system "ruby bin/testgen -s #{source_file} > #{@stdout} 2> #{@stdout}"
   end
 end
 When %r{^command 'gcc (.*\.c) (.*)' is invoked$} do |source_file,option|

data/lib/cgialib.rb

@@ -2,8 +2,8 @@ $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
 require 'cgialib/lp'
-require 'cgialib/template'
+#require 'cgialib/template'
 
 module Cgialib
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/lib/docgen/cli.rb

@@ -0,0 +1,243 @@
+require 'optparse'
+# Bring in 'ftools' for File.copy
+require "ftools"
+require "fileutils"
+# Bring in REXML and ERb
+require "rexml/document"
+require "erb"
+module Docgen
+  include LanguageParser
+  # class : ExtendedJavaDoc
+  #
+  # An extension to JavaDoc to look for our specific JavaDoc markup
+  
+  class ExtendedJavaDoc < JavaDoc
+  
+    # initialize()
+    #
+    # Constructor
+    
+    def initialize()
+  
+      super()
+  
+      @tableDescription = ""
+      @fieldDescriptions = {}
+      @relatesTo = []
+  
+    end
+  
+    attr_reader :tableDescription   # The table description string
+    attr_reader :fieldDescriptions  # The hash of descriptions for each field
+    attr_reader :relatesTo          # The array of tables this table relates to
+  
+    # add_to_tag( key, text )
+    #
+    # key - The JavaDoc key
+    # text - The text associated with the key
+    #
+    # An override of the JavaDoc handler to look for our markup
+  
+    def add_to_tag( key, text )
+  
+      # Strip any whitespace off the text
+  
+      text.strip!
+  
+      if ( key == "@desc" )
+  
+        # Add to the description any @desc data
+  
+        @tableDescription += text
+  
+      elsif ( key == "@field" )
+  
+        # Parse any @field description data
+  
+        text =~ /(.*?)\s/
+        field = $1
+  
+        text.sub!( /^#{field}\s*/, "" )
+  
+        @fieldDescriptions[ field.downcase.strip ] = text
+  
+      elsif ( key == "@relates_to" )
+    
+        # Parse any @relates_to data
+  
+        @relatesTo.push( text )
+  
+      end
+  
+    end
+  
+  end
+
+ 
+  class CLI
+    include LanguageParser
+    # run_template( template_name, bind )
+    #
+    # template_name - The name of the template file
+    # bind - The binding to pass to the template
+    #
+    # This runs the specified template with the bindings and returns the text
+    # output.
+    
+    def self.run_template( template_name, bind )
+    
+      erb = ERB.new( File.new( File.dirname(__FILE__)+"/../../templates/docgen/#{template_name}" ).read )
+      erb.result( bind )
+    
+    end
+    
+    # convert_comment( comment )
+    #
+    # comment - An SQL Comment
+    #
+    # This converts and SQL comment into a JavaDoc style comment
+    
+    def self.convert_comment( comment )
+    
+      # First clean off all of the '--' markers
+    
+      cleaned = ""
+    
+      comment.each_line { |line|
+        line.sub!( /\s*\-\-\s*/, "" )
+        line.strip!
+        cleaned += "#{line}\n" if ( line.length > 0 )
+      }
+    
+      # Now create a new buffer with the proper JavaDoc formatting
+      # around it
+    
+      converted = "/**\n"
+    
+      cleaned.each_line { |line| converted += " * #{line}" }
+    
+      converted += " */\n"
+    
+      converted
+    
+    end
+    # read_sql_file( file_name )
+    #
+    # file_name - The name of the file
+    #
+    # This reads and parses the file.
+    
+    def self.read_sql_file( file_name )
+    
+      # Read the file contents
+    
+      print "Parsing #{file_name}...\n"
+    
+      fh = File.open( file_name )
+      in_text = fh.read()
+      fh.close()
+    
+      # Tokenize the Java
+    
+      tokenizer = SQLTokenizer.new( )
+      tokenizer.parse( in_text )
+    
+      # Run it through the language parser
+    
+      languagescanner = SQLLanguageScanner.new()
+      languagescanner.parse( tokenizer.tokens )
+    
+      # Get the tables
+    
+      tables = languagescanner.tables
+
+      @@output_dir = File.expand_path(File.dirname(file_name))+"/html_doc"
+      FileUtils.rm_rf @@output_dir
+      FileUtils.mkdir_p @@output_dir
+    
+      # Iterate over each table and make the HTML file for it
+      
+      tables.each { |table|
+    
+      # Tell the user what we are building
+    
+      print "Building #{table.name}.html\n"
+    
+      # Parse the JavaDoc in the comments attached to the table
+    
+      jd = ExtendedJavaDoc.new()
+      jd.parse( convert_comment( table.comment ) )
+    
+      # Fill the field comment value with the appropriate comment from the
+      # JavaDoc
+    
+      table.fields.each { |field|
+        field.comment = jd.fieldDescriptions[ field.name.to_s.downcase.strip ]
+      }
+    
+      # Setup other locals that the template will use
+    
+      table_comment = jd.tableDescription
+      relates_to = jd.relatesTo
+    
+      # Create the HTML file and use the template to build it
+   
+      fh = File.new("#{@@output_dir}/#{table.name}.html", "w" )
+        fh.print run_template( "table_page.html.template", binding )
+        fh.close()
+      }
+    
+      # Build the table index
+    
+      print "Building tables.html\n"
+      fh = File.new("#{@@output_dir}/tables.html", "w" )
+      fh.print run_template( "tables.html.template", binding )
+      fh.close()
+    
+      # Build the main index page
+    
+      print "Building index.html\n"
+      fh = File.new("#{@@output_dir}/index.html", "w" )
+      fh.print run_template( "index.html.template", binding )
+      fh.close()
+    
+    end
+
+
+    def self.execute(stdout, arguments=[])
+      # NOTE: the option -p/--path= is given as an example, and should be replaced in your application.
+      options = {
+        :path     => '~'
+      }
+      mandatory_options = %w(  )
+      parser = OptionParser.new do |opts|
+        opts.banner = <<-BANNER.gsub(/^          /,'')
+          Generate HTML Doc for SQL
+
+          Usage: #{File.basename($0)} [options]
+
+          Options are:
+        BANNER
+        opts.separator ""
+        opts.on("-s", "--source=Source", String,
+                "The input SQL file.") { |arg| options[:source] = arg }
+        opts.on("-h", "--help",
+                "Show this help message.") { stdout.puts opts; exit }
+        opts.parse!(arguments)
+
+        if mandatory_options && mandatory_options.find { |option| options[option.to_sym].nil? }
+          stdout.puts opts; exit
+        end
+      end
+
+      source = options[:source]
+
+      # do stuff
+      if source
+        read_sql_file( source )
+      else
+        print "Must specify an input SQL file\n"
+      end
+    end
+  end
+end

data/lib/testgen/cli.rb

@@ -145,8 +145,8 @@ module Testgen
       # we pass 'binding' into ERb so that the template is evaluated
       # in our context so that it has access to our locals.
       prototypes = languagescanner.prototypes
-      #erb = ERB.new( File.new( "templates/c.template" ).read )
-      erb = ERB.new(CGIA_UT_Template::C_UT_TEMPLATE)
+      erb = ERB.new( File.new( File.dirname(__FILE__)+"/../../templates/ut/c.template" ).read )
+      #erb = ERB.new(CGIA_UT_Template::C_UT_TEMPLATE)
       template_result = erb.result( binding )
       # Add in the prefix
       template_result = "// <test_start>\n#{template_result}\n// </test_start>"

data/templates/docgen/index.html.template

@@ -0,0 +1,4 @@
+<frameset cols="20%,*">
+	<frame src="tables.html">
+	<frame name="main" src="tables.html">
+</frameset>

data/templates/docgen/table_page.html.template

@@ -0,0 +1,36 @@
+<html><head>
+<title><%= table.name %></title>
+</head>
+<body>
+<table width=100%>
+<tr>
+<td width=10% nowrap valign=top><b>Table Name:</td><td><%= table.name %></td></tr>
+<td width=10% nowrap valign=top><b>Description:</td><td><%= table_comment %></td></tr>
+<td width=10% nowrap valign=top><b>Fields:</td><td>
+<table cellspacing=1 cellpadding=0 bgcolor=#bbbbbb width=100%>
+<tr>
+<td width=20% nowrap valign=top><b>Name</b></td>
+<td width=20% nowrap valign=top><b>Type</b></td>
+<td width=20% nowrap valign=top><b>Constraints</b></td>
+<td width=40% valign=top><b>Comments</b></td>
+</tr>
+<% table.fields.each { |field|
+constraints = []
+constraints.push( "Non-null" ) if ( field.not_null ) 
+constraints.push( "Unique" ) if ( field.unique ) 
+constraints.push( "Primary key" ) if ( field.primary_key ) 
+%><tr>
+<td bgcolor=white valign=top><%= field.name %></td>
+<td bgcolor=white valign=top><%= field.type %></td>
+<td bgcolor=white valign=top><%= constraints.join( ", " ) %></td>
+<td bgcolor=white valign=top><%= field.comment %></td>
+</tr><% } %>
+</table>
+</td></tr>
+<% if ( relates_to.length > 0 )
+rel_text = relates_to.map { |table| "<a href=\"#{table}.html\">#{table}</a>" }.join( ", " )
+%><td width=10% nowrap valign=top><b>Relates To:</td>
+<td valign=top><%= rel_text %></td>
+</tr><% end %></table>
+</body>
+</html>

data/templates/docgen/tables.html.template

@@ -0,0 +1,7 @@
+<html>
+<body>
+<% tables.each { |table| %>
+<a href="<%= table.name %>.html" target="main"><%= table.name %></a><br>
+<% } %>
+</body>
+</html>

data/templates/ut/c.template

@@ -0,0 +1,44 @@
+/*
+ * ==========================================================================
+ * WARNING: This code has been generated by 'testgen'. Any modifications
+ * you make to it will be lost when it is regenerated.
+ * ==========================================================================
+ */
+int run_tests()
+{
+int failed = 0;
+int success = 0;
+<%
+prototypes.each { |proto|
+  name = proto.method_name
+  proto.tests.each { |test| 
+    values = []
+    proto.arguments.each { |arg|
+      values.push( test.arguments[ arg.name.to_s ] )
+    }
+    args = values.join( ", " )
+    result = test.result
+    test_name = test.name
+%>
+  if ( <%= name %>( <%= args %> ) != <%= result %> )
+  {
+    failed++;
+    printf( "<%= test_name %>: <%= name %>( <%= args %> ) == <%= result%> failed!\n" );
+  } else {
+    success++;
+    printf( "<%= test_name %>: <%= name %>( <%= args %> ) == <%= result%> passed!\n" );
+
+  }
+<%
+  }
+}
+%>
+  printf("%d of %d (%d%%) Unit Test are passed\n",  success, success+failed,success*100/(success+failed));
+  return 1;
+}
+/*
+ * ==========================================================================
+ * WARNING: This code has been generated by 'testgen'. Any modifications
+ * you make to it will be lost when it is regenerated.
+ * ==========================================================================
+ */

data/website/index.txt

@@ -2,15 +2,24 @@ h1. cgialib
 
 h2. What
 
+Import the examples in Code Generation In Action
+
 h2. Installing
 
 <pre syntax="ruby">sudo gem install cgialib</pre>
 
 h2. The basics
 
+Generate Unit Test for C
+
+Generate HTML Doc for SQL
 
 h2. Demonstration of usage
 
+testgen -s examples/ut/mytest1.c
+
+docgen -s examples/docgen/tables.sql
+
 h2. How to submit patches
 
 Read the "8 steps for fixing other people's code":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/ and for section "8b: Submit patch to Google Groups":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups, use the Google Group above.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cgialib
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - David Ruan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-21 00:00:00 -06:00
+date: 2008-11-22 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -56,6 +56,7 @@ description: Import the examples in Code Generation In Action
 email: 
 - ruanwz@gmail.com
 executables: 
+- docgen
 - testgen
 extensions: []
 
@@ -71,13 +72,18 @@ files:
 - PostInstall.txt
 - README.rdoc
 - Rakefile
+- bin/docgen
 - bin/testgen
 - config/website.yml.sample
 - examples/ut/mytest1.c
+- examples/docgen/tables.sql
+- features/docgen.feature
 - features/language_parser.feature
 - features/steps/language_parser.rb
+- features/steps/docgen.rb
 - features/steps/env.rb
 - lib/cgialib.rb
+- lib/docgen/cli.rb
 - lib/testgen/cli.rb
 - lib/cgialib/lp.rb
 - lib/cgialib/template.rb
@@ -100,6 +106,10 @@ files:
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/testgen_cli_spec.rb
+- templates/ut/c.template
+- templates/docgen/index.html.template
+- templates/docgen/table_page.html.template
+- templates/docgen/tables.html.template
 - tasks/rspec.rake
 - website/index.html
 - website/index.txt
@@ -129,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: cgialib
-rubygems_version: 1.3.0
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: Import the examples in Code Generation In Action