cgialib 0.0.1

data/lib/testgen/cli.rb

@@ -0,0 +1,210 @@
+require 'optparse'
+# Bring in 'ftools' for File.copy
+require "ftools"
+# Bring in REXML and ERb
+require "rexml/document"
+require "erb"
+module Testgen
+  include LanguageParser
+  class PrototypeWithTests < Prototype
+    # initialize()
+    #
+    # Initializes the object
+    def initialize()
+      # Initialize the base class
+      super()
+      # Create the array of tests
+      @tests = []
+    end
+    attr_reader :tests   # The array of tests
+    # add_tests( tests )
+    #
+    # tests - An array of TestData objects
+    #
+    # Adds an array of tests to the prototype
+    def add_tests( tests )
+      tests.each { |test| @tests.push( test ); }
+    end
+  end
+  # class : TestData
+  #
+  # Objects of type TestData hold the data for a single test
+  class TestData
+    # initialize()
+    #
+    # Constructs the TestData object
+    def initialize()
+      @name = ""
+      @result = ""
+      @arguments = {}
+    end
+    attr_accessor :name      # The name of the test
+    attr_accessor :result    # The expected result
+    attr_reader :arguments   # The test data (a hash)
+    # add_argument( name, value )
+    #
+    # name - The name of the argument
+    # value - The test data value
+    #
+    # This adds data to the test
+    def add_argument( name, value )
+      @arguments[ name ] = value
+    end
+  end
+
+  class CLI
+    include LanguageParser
+    # parse_data( text )
+    #
+    # text - The text of the comment
+    #
+    # This builds a TestData object from a text string
+    def self.parse_data( text )
+      begin
+        # Create the new test data
+        data = TestData.new()
+        # Parse the XML of the comment 
+        doc = REXML::Document.new( text )
+        # Get the result and name
+        data.result = doc.root.attributes[ 'result' ]
+        data.name = doc.root.attributes[ 'name' ]
+        # Get the test data
+        doc.root.elements.each { |elem|
+          data.add_argument( elem.name, elem.text.strip )
+        }
+        # Return the new TestData object
+        data
+      rescue
+        nil
+      end
+    end
+    # find_tests( comments )
+    #
+    # comments - The array of comments returned from the Prototype object
+    #
+    # This finds all of the tests in all of the comments and returns
+    # an array of TestData objects. One for each test.
+    def self.find_tests( comments )
+      tests = []
+      # Iterate through the comments
+      comments.each { |comment|
+        # Search for the test data block XML
+        found = comment.to_s.scan( /(<test.*?<\/test>)/ )
+        # If we found some then use them to create the TestData objects
+        if ( found )
+          found.each { |items|
+            data = parse_data( items[0] )
+            tests.push( data ) if ( data )
+          }
+        end
+      }
+      # Return the comments
+      tests
+    end
+    # generate_tests( file_name )
+    #
+    # file_name - The name of the file to scan and alter
+    #
+    # This generates test case running code from test case comments around
+    # the function prototypes.
+    def self.generate_tests( file_name )
+      # Read the file contents
+      fh = File.open( file_name )
+      c_text = fh.read()
+      fh.close()
+      # Tokenize the file
+      tokenizer = CTokenizer.new( )
+      tokenizer.parse( c_text )
+      # Build the language scanner
+      languagescanner = CLanguageScanner.new()
+      # Use our prototype class when prototypes are built instead
+      # of the base class
+      languagescanner.prototypeClass = PrototypeWithTests
+      # Get the prototypes
+      languagescanner.parse( tokenizer.tokens )
+      # Iterate through the prototypes and turn the comments
+      # into tests
+      count = 0
+      languagescanner.prototypes.each { |proto|
+        # Parse the comments into tests and add them
+        tests = find_tests( proto.comments )
+        proto.add_tests( tests )
+        # Create unique names for the tests that don't
+        # have them
+        index = 1
+        proto.tests.each { |item|
+          name = "#{proto.method_name}_#{index}"
+          item.name = name unless ( item.name )
+          index += 1
+          count += 1
+        }
+      }
+    
+      # Create the testing code by calling the template.  The
+      # templates reference 'prototypes'.  They can do this because
+      # 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)
+      template_result = erb.result( binding )
+      # Add in the prefix
+      template_result = "// <test_start>\n#{template_result}\n// </test_start>"
+      # Backup the original file
+      File.copy file_name, "#{file_name}.bak"
+      # Insert the new template result
+      if ( c_text =~ /\/\/ <test_start>.*?\/\/ <\/test_start>/m )
+        c_text.sub!( /\/\/ <test_start>.*?\/\/ <\/test_start>/m, template_result )
+      else
+        c_text += template_result
+      end
+      # Output the finished code
+      File.open( file_name, "w" ).write( c_text )
+      # Tell the user what we did
+      print "#{file_name}: #{count} tests found\n"
+    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(/^          /,'')
+          This application is wonderful because...
+
+          Usage: #{File.basename($0)} [options]
+
+          Options are:
+        BANNER
+        opts.separator ""
+        opts.on("-p", "--path=PATH", String,
+                "This is a sample message.",
+                "For multiple lines, add more strings.",
+                "Default: ~") { |arg| options[:path] = arg }
+        opts.on("-s", "--source=Source", String,
+                "The source file.") { |arg| options[:source] = arg }
+        opts.on("-t", "--template=Template", String,
+                "The template file for the Unit Test.") { |arg| options[:template] = 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
+
+      path = options[:path]
+      source = options[:source]
+      template = options[:template]
+
+      # do stuff
+      if source
+        generate_tests( source )
+      else
+        print "Must specify an input C file\n"
+      end
+    end
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/cgialib.rb'}"
+puts "Loading cgialib gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/script/txt2html

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+
+GEM_NAME = 'cgialib' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'cgialib'
+
+require 'rubygems'
+begin
+  require 'newgem'
+  require 'rubyforge'
+rescue LoadError
+  puts "\n\nGenerating the website requires the newgem RubyGem"
+  puts "Install: gem install newgem\n\n"
+  exit(1)
+end
+require 'redcloth'
+require 'syntax/convertors/html'
+require 'erb'
+require File.dirname(__FILE__) + "/../lib/#{GEM_NAME}.rb"
+
+version  = Cgialib::VERSION
+download = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+def rubyforge_project_id
+  RubyForge.new.autoconfig["group_ids"][RUBYFORGE_PROJECT]
+end
+
+class Fixnum
+  def ordinal
+    # teens
+    return 'th' if (10..19).include?(self % 100)
+    # others
+    case self % 10
+    when 1: return 'st'
+    when 2: return 'nd'
+    when 3: return 'rd'
+    else    return 'th'
+    end
+  end
+end
+
+class Time
+  def pretty
+    return "#{mday}#{mday.ordinal} #{strftime('%B')} #{year}"
+  end
+end
+
+def convert_syntax(syntax, source)
+  return Syntax::Convertors::HTML.for_syntax(syntax).convert(source).gsub(%r!^<pre>|</pre>$!,'')
+end
+
+if ARGV.length >= 1
+  src, template = ARGV
+  template ||= File.join(File.dirname(__FILE__), '/../website/template.html.erb')
+else
+  puts("Usage: #{File.split($0).last} source.txt [template.html.erb] > output.html")
+  exit!
+end
+
+template = ERB.new(File.open(template).read)
+
+title = nil
+body = nil
+File.open(src) do |fsrc|
+  title_text = fsrc.readline
+  body_text_template = fsrc.read
+  body_text = ERB.new(body_text_template).result(binding)
+  syntax_items = []
+  body_text.gsub!(%r!<(pre|code)[^>]*?syntax=['"]([^'"]+)[^>]*>(.*?)</\1>!m){
+    ident = syntax_items.length
+    element, syntax, source = $1, $2, $3
+    syntax_items << "<#{element} class='syntax'>#{convert_syntax(syntax, source)}</#{element}>"
+    "syntax-temp-#{ident}"
+  }
+  title = RedCloth.new(title_text).to_html.gsub(%r!<.*?>!,'').strip
+  body = RedCloth.new(body_text).to_html
+  body.gsub!(%r!(?:<pre><code>)?syntax-temp-(\d+)(?:</code></pre>)?!){ syntax_items[$1.to_i] }
+end
+stat = File.stat(src)
+created = stat.ctime
+modified = stat.mtime
+
+$stdout << template.result(binding)

data/spec/cgialib_spec.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+# Time to add your specs!
+# http://rspec.info/
+describe "Place your specs here" do
+  
+  it "find this spec in spec directory" do
+    violated "Be sure to write your specs"
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'cgialib'

data/spec/testgen_cli_spec.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'testgen/cli'
+
+describe Testgen::CLI, "execute" do
+  before(:each) do
+    @stdout_io = StringIO.new
+    Testgen::CLI.execute(@stdout_io, [])
+    @stdout_io.rewind
+    @stdout = @stdout_io.read
+  end
+  
+  it "should do something" do
+    @stdout.should_not =~ /To update this executable/
+  end
+end

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

data/website/index.html

@@ -0,0 +1,86 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" />
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>
+      cgialib
+  </title>
+  <script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script>
+<style>
+
+</style>
+  <script type="text/javascript">
+    window.onload = function() {
+      settings = {
+          tl: { radius: 10 },
+          tr: { radius: 10 },
+          bl: { radius: 10 },
+          br: { radius: 10 },
+          antiAlias: true,
+          autoPad: true,
+          validTags: ["div"]
+      }
+      var versionBox = new curvyCorners(settings, document.getElementById("version"));
+      versionBox.applyCornersToAll();
+    }
+  </script>
+</head>
+<body>
+<div id="main">
+
+    <h1>cgialib</h1>
+    <div class="sidebar">
+      <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/cgialib"; return false'>
+        <p>Get Version</p>
+        <a href="http://rubyforge.org/projects/cgialib" class="numbers">0.0.1</a>
+      </div>
+    </div>
+    <h2>What</h2>
+<h2>Installing</h2>
+<p><pre class='syntax'><span class="ident">sudo</span> <span class="ident">gem</span> <span class="ident">install</span> <span class="ident">cgialib</span></pre></p>
+<h2>The basics</h2>
+<h2>Demonstration of usage</h2>
+<h2>Forum</h2>
+<p><a href="http://groups.google.com/group/cgialib">http://groups.google.com/group/cgialib</a></p>
+<p><span class="caps">TODO</span> &#8211; create Google Group &#8211; cgialib</p>
+<h2>How to submit patches</h2>
+<p>Read the <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/">8 steps for fixing other people&#8217;s code</a> and for section <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups">8b: Submit patch to Google Groups</a>, use the Google Group above.</p>
+<p><span class="caps">TODO</span> &#8211; pick <span class="caps">SVN</span> or Git instructions</p>
+<p>The trunk repository is <code>svn://rubyforge.org/var/svn/cgialib/trunk</code> for anonymous access.</p>
+<p><span class="caps">OOOORRRR</span></p>
+<p>You can fetch the source from either:</p>
+<ul>
+	<li>rubyforge: <span class="caps">MISSING</span> IN <span class="caps">ACTION</span></li>
+</ul>
+<p><span class="caps">TODO</span> &#8211; You can not created a RubyForge project, OR have not run <code>rubyforge config</code><br />
+yet to refresh your local rubyforge data with this projects&#8217; id information.</p>
+<p>When you do this, this message will magically disappear!</p>
+<p>Or you can hack website/index.txt and make it all go away!!</p>
+<ul>
+	<li>github: <a href="http://github.com/ruanwz/cgialib/tree/master">http://github.com/ruanwz/cgialib/tree/master</a></li>
+</ul>
+<pre>git clone git://github.com/ruanwz/cgialib.git</pre>
+<ul>
+	<li>gitorious: <a href="git://gitorious.org/cgialib/mainline.git">git://gitorious.org/cgialib/mainline.git</a></li>
+</ul>
+<pre>git clone git://gitorious.org/cgialib/mainline.git</pre>
+<h3>Build and test instructions</h3>
+<pre>cd cgialib
+rake test
+rake install_gem</pre>
+<h2>License</h2>
+<p>This code is free to use under the terms of the <span class="caps">MIT</span> license.</p>
+<h2>Contact</h2>
+<p>Comments are welcome. Send an email to <a href="mailto:FIXME"><span class="caps">FIXME</span> full name</a> email via the <a href="http://groups.google.com/group/cgialib">forum</a></p>
+    <p class="coda">
+      <a href="FIXME email">FIXME full name</a>, 19th November 2008<br>
+      Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
+    </p>
+</div>
+
+<!-- insert site tracking codes here, like Google Urchin -->
+
+</body>
+</html>

data/website/index.txt

@@ -0,0 +1,79 @@
+h1. cgialib
+
+
+h2. What
+
+
+h2. Installing
+
+<pre syntax="ruby">sudo gem install cgialib</pre>
+
+h2. The basics
+
+
+h2. Demonstration of usage
+
+
+
+h2. Forum
+
+"http://groups.google.com/group/cgialib":http://groups.google.com/group/cgialib
+
+TODO - create Google Group - cgialib
+
+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.
+
+TODO - pick SVN or Git instructions
+
+The trunk repository is <code>svn://rubyforge.org/var/svn/cgialib/trunk</code> for anonymous access.
+
+OOOORRRR
+
+You can fetch the source from either:
+
+<% if rubyforge_project_id %>
+
+* rubyforge: "http://rubyforge.org/scm/?group_id=<%= rubyforge_project_id %>":http://rubyforge.org/scm/?group_id=<%= rubyforge_project_id %>
+
+<pre>git clone git://rubyforge.org/cgialib.git</pre>
+
+<% else %>
+
+* rubyforge: MISSING IN ACTION
+
+TODO - You can not created a RubyForge project, OR have not run <code>rubyforge config</code>
+yet to refresh your local rubyforge data with this projects' id information.
+
+When you do this, this message will magically disappear!
+
+Or you can hack website/index.txt and make it all go away!!
+
+<% end %>
+
+* github: "http://github.com/ruanwz/cgialib/tree/master":http://github.com/ruanwz/cgialib/tree/master
+
+<pre>git clone git://github.com/ruanwz/cgialib.git</pre>
+
+
+
+* gitorious: "git://gitorious.org/cgialib/mainline.git":git://gitorious.org/cgialib/mainline.git
+
+<pre>git clone git://gitorious.org/cgialib/mainline.git</pre>
+
+h3. Build and test instructions
+
+<pre>cd cgialib
+rake test
+rake install_gem</pre>
+
+
+h2. License
+
+This code is free to use under the terms of the MIT license. 
+
+h2. Contact
+
+Comments are welcome. Send an email to "FIXME full name":mailto:FIXME email via the "forum":http://groups.google.com/group/cgialib
+