Merge lp:~posulliv/drizzle-interface/ruby-interface into lp:drizzle-interface

[Padraig O'Sullivan]

[Padraig O'Sullivan (posulliv)]

I was messing around with the SWIG generated ruby interface to drizzle tonight and I've started thinking about how we are going to distribute this. I'm guessing we are going to want to create a ruby gem since that seems to be the standard way.

I've created the various files in this branch I'm proposing for a merge for creating a ruby gem and am currently working on writing some unit tests for it. I'm trying to do this in what appears to be the standard way that things like this are done in the ruby community.

How would we distribute something like this? It seems that most ruby folks use github and not launchpad. Is there a way to mirror a launchpad branch on github? What are your plans for the python interface?

Sorry for all the questions on this! Software distribution is something I'm really not familiar with at all.

-Padraig

[Monty Taylor (mordred)]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Padraig O'Sullivan wrote:
> Padraig O'Sullivan has proposed merging
> lp:~posulliv/drizzle-interface/ruby-interface into
> lp:drizzle-interface.
>
> Requested reviews: Monty Taylor (mordred)
>
>
> I was messing around with the SWIG generated ruby interface to
> drizzle tonight and I've started thinking about how we are going to
> distribute this. I'm guessing we are going to want to create a ruby
> gem since that seems to be the standard way.

Totally agree.

> I've created the various files in this branch I'm proposing for a
> merge for creating a ruby gem and am currently working on writing
> some unit tests for it. I'm trying to do this in what appears to be
> the standard way that things like this are done in the ruby
> community.

Looks good to me.

> How would we distribute something like this? It seems that most ruby
> folks use github and not launchpad. Is there a way to mirror a
> launchpad branch on github? What are your plans for the python
> interface?

The way I've been doing this for the python interface is similar. I use
python setuptools to create python packages and upload those to PyPI
(the python packaging system) In general, the thought is this:

root makefile generates the C code into language subdir
language subdir should be self-sufficient, so it (including the
generated file) can be tarred up and distributed

If you want to just install the code, you can grab a tarball we'll
publish of just your language. (python-libdrizzle-0.1.tar.gz or
ruby-libdrizzle-0.1.tar.gz)

If you want to hack on the _C_ part, you can grab the bzr branch from
launchpad and run SWIG and all of that. (less people will want to do this)

For distribution, I make a source tarball of just the python dir (using
python setup.py sdist) and I upload that to launchpad
(http://edge.launchpad.net/drizzle-interface/trunk/ongoing-development/+download/python-libdrizzle-0.3.0.tar.gz)
and also to PyPI (http://pypi.python.org/pypi/python-libdrizzle/ -
http://pypi.python.org/packages/source/p/python-libdrizzle/python-libdrizzle-0.3.0.tar.gz#md5=a938eb02df37168a2aa7ec0cf3b0b7fe)

I think a similar pattern can be used for Ruby. Make a gemspec file in
the ruby dir which assumes that the ruby dir is actually the root dir.
That can be used to create the tarballs for ruby, and then we can use
that to create gems to upload as well.

I'm not sure we need to do anything with github unless we were going to
move development to use git from bzr.

> Sorry for all the questions on this! Software distribution is
> something I'm really not familiar with at all.

Only one way to learn... :)

This reminds me - I _really_ need to make some .debs for these...

Monty

PS. Your branch is merged, btw.
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iEYEARECAAYFAkrf7wUACgkQ2Jv7/VK1RgH1fACgxvpzGovjvZMP6768yjpztYE5
4XkAoJ7x2YBSrJSZmrzMFHaJ0w9F1UQ8
=0aOg
-----END PGP SIGNATURE-----

=== modified file 'INSTALL'
--- INSTALL	2009-08-23 22:39:54 +0000
+++ INSTALL	2009-10-22 04:30:22 +0000
@@ -2,7 +2,7 @@
 *************************
 
 Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
-2006, 2007, 2008, 2009 Free Software Foundation, Inc.
+2006, 2007, 2008 Free Software Foundation, Inc.
 
    This file is free documentation; the Free Software Foundation gives
 unlimited permission to copy, distribute and modify it.
@@ -159,7 +159,7 @@
 CC is not installed, it is recommended to use the following options in
 order to use an ANSI C compiler:
 
-     ./configure CC="cc -Ae -D_XOPEN_SOURCE=500"
+     ./configure CC="cc -Ae"
 
 and if that doesn't work, install pre-built binaries of GCC for HP-UX.
 
@@ -174,16 +174,6 @@
 
      ./configure CC="cc -nodtk"
 
-   On Solaris, don't put `/usr/ucb' early in your `PATH'.  This
-directory contains several dysfunctional programs; working variants of
-these programs are available in `/usr/bin'.  So, if you need `/usr/ucb'
-in your `PATH', put it _after_ `/usr/bin'.
-
-   On Haiku, software installed for all users goes in `/boot/common',
-not `/usr/local'.  It is recommended to use the following options:
-
-     ./configure --prefix=/boot/common
-
 Specifying the System Type
 ==========================
 
@@ -199,8 +189,7 @@
 
 where SYSTEM can have one of these forms:
 
-     OS
-     KERNEL-OS
+     OS KERNEL-OS
 
    See the file `config.sub' for the possible values of each field.  If
 `config.sub' isn't included in this package, then this package doesn't

=== modified file 'Makefile.am'
--- Makefile.am	2009-10-07 19:04:30 +0000
+++ Makefile.am	2009-10-22 04:30:22 +0000
@@ -83,10 +83,10 @@
 if BUILD_RUBY
   libswig_la_SOURCES+= interface/ruby/libdrizzle.i
   nobase_rubyarch_LTLIBRARIES+= ruby/drizzle/libdrizzle.la
-  BUILT_SOURCES+= ruby/libdrizzle.cc ruby/drizzle/libdrizzle.so
-  CLEANFILES+= ruby/*.db ruby/core* ruby/libdrizzle.cc ruby/drizzle/libdrizzle.so ruby/drizzle/libdrizzle.so
+  BUILT_SOURCES+= ruby/ext/libdrizzle.cc ruby/drizzle/libdrizzle.so
+  CLEANFILES+= ruby/*.db ruby/core* ruby/ext/libdrizzle.cc ruby/drizzle/libdrizzle.so ruby/drizzle/libdrizzle.so
 
-  ruby_drizzle_libdrizzle_la_SOURCES= ruby/libdrizzle.cc
+  ruby_drizzle_libdrizzle_la_SOURCES= ruby/ext/libdrizzle.cc
   ruby_drizzle_libdrizzle_la_CXXFLAGS= ${RUBY_INCLUDES}
   ruby_drizzle_libdrizzle_la_LIBADD= ${LTLIBDRIZZLE}
   ruby_drizzle_libdrizzle_la_LDFLAGS= -module -avoid-version
@@ -97,7 +97,7 @@
 	@rm -f ruby/drizzle/libdrizzle.so
 	@ln -s .libs/libdrizzle.so ruby/drizzle/libdrizzle.so
 
-ruby/libdrizzle.cc: interface/ruby/libdrizzle.i
+ruby/ext/libdrizzle.cc: interface/ruby/libdrizzle.i
 	$(MKDIR_P) ruby/drizzle
 	$(SWIG) -ruby -autorename -MD -MF ruby/$(DEPDIR)/$(@F).Tpo -o $@ $<
 	@mv -f ruby/$(DEPDIR)/$(@F).Tpo ruby/$(DEPDIR)/$(@F).Plo

=== modified file 'config/install-sh'
--- config/install-sh	2009-08-23 22:39:54 +0000
+++ config/install-sh	2009-10-22 04:30:22 +0000
@@ -1,7 +1,7 @@
 #!/bin/sh
 # install - install a program, script, or datafile
 
-scriptversion=2009-04-28.21; # UTC
+scriptversion=2006-12-25.00
 
 # This originates from X11R5 (mit/util/scripts/install.sh), which was
 # later released in X11R6 (xc/config/util/install.sh) with the
@@ -515,6 +515,5 @@
 # eval: (add-hook 'write-file-hooks 'time-stamp)
 # time-stamp-start: "scriptversion="
 # time-stamp-format: "%:y-%02m-%02d.%02H"
-# time-stamp-time-zone: "UTC"
-# time-stamp-end: "; # UTC"
+# time-stamp-end: "$"
 # End:

=== added file 'ruby/CHANGELOG'
--- ruby/CHANGELOG	1970-01-01 00:00:00 +0000
+++ ruby/CHANGELOG	2009-10-22 04:30:22 +0000
@@ -0,0 +1,3 @@
+
+v0.1. Initial release.
+

=== added file 'ruby/LICENSE'
--- ruby/LICENSE	1970-01-01 00:00:00 +0000
+++ ruby/LICENSE	2009-10-22 04:30:22 +0000
@@ -0,0 +1,30 @@
+Copyright (C) 2009 Padraig O'Sullivan ([e-mail])
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+    * Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above
+copyright notice, this list of conditions and the following disclaimer
+in the documentation and/or other materials provided with the
+distribution.
+
+    * The names of its contributors may not be used to endorse or
+promote products derived from this software without specific prior
+written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

=== added file 'ruby/README'
--- ruby/README	1970-01-01 00:00:00 +0000
+++ ruby/README	2009-10-22 04:30:22 +0000
@@ -0,0 +1,8 @@
+These are the ruby wrappers for libdrizzle which can be used to connect
+to Drizzle or MySQL.
+
+The C++ source here is generated from SWIG. That, as well as the larger build
+process of which it is a part and from which this source package is derived 
+can be checked out from launchpad via:
+
+bzr branch lp:drizzle-interface

=== added file 'ruby/Rakefile'
--- ruby/Rakefile	1970-01-01 00:00:00 +0000
+++ ruby/Rakefile	2009-10-22 04:30:22 +0000
@@ -0,0 +1,8 @@
+require 'echoe'
+
+Echoe.new("drizzle") do |p|
+  p.author = "Padraig O'Sullivan"
+  p.project = "drizzle"
+  p.summary = "An interface to the libdrizzle C client."
+  p.url = "http://launchpad.net/drizzle-interface"
+end

=== renamed file 'ruby/client.rb' => 'ruby/examples/client.rb'
=== added directory 'ruby/ext'
=== added file 'ruby/ext/extconf.rb'
--- ruby/ext/extconf.rb	1970-01-01 00:00:00 +0000
+++ ruby/ext/extconf.rb	2009-10-22 04:30:22 +0000
@@ -0,0 +1,18 @@
+require 'mkmf'
+
+HERE = File.expand_path(File.dirname(__FILE__))
+
+$CPPFLAGS = $CFLAGS = $LDFLAGS = ""
+$LDFLAGS = " -L/usr/local/lib -lstdc++ -lm -lc -lgcc_s -ldrizzle"
+
+if ENV['DEBUG']
+  puts "Setting debug flags for gem."
+  $CPPFLAGS << " -O0 -g"
+else
+  $CPPFLAGS << "-O4"
+end
+
+if have_header('libdrizzle/con_client.h')
+  create_makefile 'drizzle'
+end
+

=== added directory 'ruby/lib'
=== added directory 'ruby/test'
=== added file 'ruby/test/setup.rb'
--- ruby/test/setup.rb	1970-01-01 00:00:00 +0000
+++ ruby/test/setup.rb	2009-10-22 04:30:22 +0000
@@ -0,0 +1,15 @@
+  
+unless defined? UNIX_SOCKET_NAME
+  HERE = File.dirname(__FILE__)
+  UNIX_SOCKET_NAME = File.join(ENV['TMPDIR']||'/tmp','drizzle')
+  
+  # Kill drizzled
+  system("drizzle --shutdown --port=43047")
+  
+  # Start drizzled
+  log = "/tmp/drizzle.log"
+  system ">#{log}"
+  
+  cmd = "drizzled --no-defaults --port=43047 --basedir=/tmp --datadir=/tmp >> #{log} 2>&1 &"
+  raise "'#{cmd}' failed to start" unless system(cmd)
+end

=== added file 'ruby/test/test_helper.rb'
--- ruby/test/test_helper.rb	1970-01-01 00:00:00 +0000
+++ ruby/test/test_helper.rb	2009-10-22 04:30:22 +0000
@@ -0,0 +1,16 @@
+
+$LOAD_PATH << "#{File.dirname(__FILE__)}/../lib"
+
+require 'rubygems'
+require 'mocha'
+
+if ENV['DEBUG']
+  require 'ruby-debug' 
+end
+  
+require 'drizzle'
+require 'test/unit'
+require 'ostruct'
+
+class GenericClass
+end

=== added directory 'ruby/test/unit'
=== added file 'ruby/test/unit/drizzle_test.rb'
--- ruby/test/unit/drizzle_test.rb	1970-01-01 00:00:00 +0000
+++ ruby/test/unit/drizzle_test.rb	2009-10-22 04:30:22 +0000
@@ -0,0 +1,32 @@
+
+require "#{File.dirname(__FILE__)}/../test_helper"
+require 'drizzle'
+require 'socket'
+require 'mocha'
+require 'benchmark'
+
+class DrizzleTest < Test::Unit::TestCase
+
+  def setup
+    @host = 'localhost'
+    @port = 43047
+    @server = Libdrizzle::Drizzle.new
+  end
+
+  # Initialize
+
+  def test_initialize
+    @con = @server.create_client_connection()
+    @con.set_db("information_schema")
+    @con.set_tcp(@host, @port)
+    @con.connect()
+  end
+
+  def simple_query
+    result = @con.buffer_query("select table_name from tables")
+    # this obviously needs to be changed...
+    assert_equal 25, result.row_count()
+  end
+
+end
+