sqlanywhere 0.1.1

data/CHANGELOG

@@ -0,0 +1,16 @@
+=CHANGE LOG
+
+=====0.1.1 -- 2008/11/06
+- Created a source gem rake task
+- Created a 'hint' file if the source gem is used directly
+- Changed file permissions on archives
+- Changed archives to be specific to platform (.zip on windows, .tar.gz
+otherwise)
+- Changed default rake task to only build library, not gem
+- Added a gem rake task
+
+=====0.1.0 -- 2008/10/15
+- Initial Release
+- Wraps DBCAPI functionality
+- Includes a simple unit test suite
+

data/LICENSE

@@ -0,0 +1,23 @@
+/*====================================================
+*
+*   Copyright 2008 iAnywhere Solutions, Inc.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*                                                                               
+*
+* http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+*
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*
+* While not a requirement of the license, if you do modify this file, we
+* would appreciate hearing about it.   Please email sqlany_interfaces@sybase.com
+*
+*
+*====================================================*/

data/README

@@ -0,0 +1,130 @@
+=SQL Anywhere Ruby Driver
+
+This is a native SQL Anywhere driver for Ruby. This library wraps the 
+functionality provided by the SQL Anywhere DBCAPI library. This driver
+is intended to be a base-level library to be used by interface libraries
+such as Ruby-DBI and ActiveRecord.
+
+This driver can be used with SQL Anywhere 11 and SQL Anywhere 10.
+
+This driver is licensed under the Apache License, Version 2.
+
+==Build Instructions
+
+===Requirements
+* C Compiler
+* Ruby
+* RubyGem Package manager
+
+
+===All Platforms
+
+To build the library (.so), use:
+
+   rake
+
+To build and install the gem, use:
+
+   rake gem
+   rake install
+
+The other rake tasks are 
+
+   rake clean   -> Cleans up all temp files (ex *.~)
+   rake clobber -> Cleans up all built files (ex *.gem, *.o, *.so)
+
+===Additional Install Notes for Windows
+
+The popular One-Click Ruby Installer for Windows (RubyInstaller) is built using 
+Microsoft Visual C++ 6.0. Since problems can arise by combining binaries from
+different compilers, we advise you use this compiler.
+
+If you want to use a more recent version of the MS C++ compiler, you will need to make a few changes:
+
+1. Open the file: <RUBY DIR>\lib\ruby\1.8\i386-mswin32\config.h, and comment out the first three lines so they look like:
+
+    //#if _MSC_VER != 1200
+    //#error MSC version unmatch
+    //#endif
+  
+   This removes the check for C++ Version 6.0
+
+2. Open <tt>rakefile</tt> and set:
+
+      APPLY_MANIFEST = true
+
+   This will add the manifest to the compiled binaries.
+
+By default, rake will attempt to use Microsoft <tt>nmake</tt> when building under Windows. To use another make program, set:
+
+     USE_NMAKE_ON_WIN = FALSE
+
+==Running Unit Tests
+
+1. Change to the the <tt>test</tt> directory
+
+    cd test
+
+2. Create a testing database:
+
+    dbinit test
+
+3. Start the testing database:
+
+    dbeng11 test.db
+ 
+4. Create the test schema:
+
+    dbisql -c "eng=test;uid=dba;pwd=sql" test.sql
+
+5. Run the unit tests:
+
+    ruby sqlanywhere_test.rb
+
+<b>If the tests fail to run, make sure you have set up the SQL Anywhere environment variables correctly.</b> For more information
+review the online documentation here[http://dcx.sybase.com/index.php#http%3A%2F%2Fdcx.sybase.com%2F1100en%2Fdbadmin_en11%2Fda-envvar-sect1-3672410.html].
+
+==Sample
+
+This script makes a connection, prints <tt>Successful Ruby Connection</tt> to the SQL
+Anywhere console, then disconnects.
+  
+   # load the SQLAnywhere gem
+   begin
+     require 'rubygems'
+     gem 'sqlanywhere'
+     unless defined? SQLAnywhere
+       require 'sqlanywhere'
+     end    
+   end
+
+   # create an interface
+   api = SQLAnywhere::SQLAnywhereInterface.new()
+
+   # initialize the interface (loads the DLL/SO)
+   SQLAnywhere::API.sqlany_initialize_interface( api )
+
+   # initialize our api object
+   api.sqlany_init()
+
+   # create a connection
+   conn = api.sqlany_new_connection()
+
+   # establish a connection
+   api.sqlany_connect(conn, "uid=dba;pwd=sql")
+
+   # execute a query without a result set
+   api.sqlany_execute_immediate(conn, "MESSAGE 'Successful Ruby Connection'")
+
+   # disconnect from the database
+   api.sqlany_disconnect(conn)
+
+   # free the connection resources
+   api.sqlany_free_connection(conn)
+
+   # free resources the api object uses
+   api.sqlany_fini()
+
+   # close the interface
+   SQLAnywhere::API.sqlany_finalize_interface( api )
+

data/Rakefile

@@ -0,0 +1,207 @@
+#====================================================
+#
+#    Copyright 2008 iAnywhere Solutions, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#                                                                               
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# While not a requirement of the license, if you do modify this file, we
+# would appreciate hearing about it.   Please email sqlany_interfaces@sybase.com
+#
+#
+#====================================================
+
+require 'ftools'
+require 'rbconfig'
+require 'rake/clean'
+require 'rake/rdoctask'
+require 'rubygems'
+require 'rubygems/builder'
+
+# By default, windows will try to use nmake instead of make. If you are on windows but using
+# a different compiler that uses standard make, set this to false.
+USE_NMAKE_ON_WIN = true
+
+# By default on windows, ruby expects to be compiled by Visual Studio C++ 6.0. If you are using 
+# a newer version of Visual Studio, you will need to apply a manifest to the dll. To apply the
+# manifest set this to true.
+APPLY_MANIFEST = false
+
+PACKAGE_NAME = "sqlanywhere"
+ARCH=Config::CONFIG['arch']
+
+pkg_version = ""
+
+# The package version of determined by parsing the c source file. This ensures the version is
+# only ever specified ins a single place.
+File.open(File.join("ext", "sqlanywhere.c") ) do |f|
+   f.grep( /const char\* VERSION/ ) do |line|
+      pkg_version = /\s*const char\* VERSION\s*=\s*["|']([^"']*)["|'];\s*/.match(line)[1]
+   end
+end
+
+# If we can't determine the version, throw up your hands and exit
+raise RuntimeError, "Could not determine current package version!" if pkg_version.empty?
+
+# The hint file will be automatically added to a souce_gem builds. If someone installs the source gem and 
+# tries to run it, they will get a LoadError telling them that they must compile the software. This file 
+# ONLY exists in a source gem
+hint_file = "raise LoadError, \"You need to compile the sqlanywhere package for this particular platform. To compile the package, change to the sqlanywhere package directory and run rake:\n     cd $GEM_HOME/sqlanywhere-#{pkg_version}\n     rake\nFor more information on compiling, please read $GEM_HOME/sqlanywhere-#{pkg_version}/README\""
+
+MAKE = (ARCH =~ /win32/ and USE_NMAKE_ON_WIN) ? 'nmake' : 'make'
+
+spec = Gem::Specification.new do |spec|
+  spec.authors = ["Eric Farrar"]
+  spec.email = 'eric.farrar@ianywhere.com'
+  spec.name = 'sqlanywhere'
+  spec.summary = 'SQL Anywhere library for Ruby'
+  spec.description = <<-EOF
+    SQL Anywhere  Driver for Ruby
+  EOF
+  spec.version = pkg_version
+  spec.autorequire = 'sqlanywhere'
+  spec.has_rdoc = true
+  spec.rubyforge_project = 'sqlanywhere'
+  spec.homepage = 'http://sqlanywhere.rubyforge.org'
+  spec.platform = Gem::Platform::CURRENT
+  spec.required_ruby_version = '>= 1.8.6'
+  spec.require_paths = ['lib']
+  spec.test_file  = 'test/sqlanywhere_test.rb'
+  spec.rdoc_options << '--title' << 'SQL Anywhere Ruby Driver' <<
+                       '--main' << 'README' <<
+                       '--line-numbers'
+  spec.extra_rdoc_files = ['README', 'CHANGELOG', 'LICENSE', 'ext/sqlanywhere.c']
+end
+
+# The default task is to build the library (.dll or .so)
+desc "Build the library"
+task :default => ["lib/sqlanywhere.so"]
+
+# Builds the binary gem for this platform
+desc "Build the gem"
+task :gem => ["sqlanywhere-#{pkg_version}-#{spec.platform}.gem"]
+
+file "sqlanywhere-#{pkg_version}-#{spec.platform}.gem" => ["Rakefile", 
+                                             "test/test.sql", 
+                                             "test/sqlanywhere_test.rb", 
+                                             "README", 
+                                             "CHANGELOG", 
+                                             "LICENSE", 
+                                             "lib/sqlanywhere.so"] do
+   # Get the updated list of files to include in the gem
+   spec.files = Dir['ext/**/*'] + Dir['lib/**/*'] + Dir['test/**/*'] + Dir['CHANGELOG'] + Dir['LICENSE'] + Dir['README'] + Dir['Rakefile']
+   # Set the gem to be platform specific since it includes compiled binaries   
+   spec.platform = Gem::Platform::CURRENT
+   Gem::Builder.new(spec).build
+end
+
+# Builds the source gem for any platform
+desc "Build the source gem"
+task :source_gem => ["sqlanywhere-#{pkg_version}.gem"]
+
+file "sqlanywhere-#{pkg_version}.gem" => ["Rakefile", 
+                                          "test/test.sql", 
+                                          "test/sqlanywhere_test.rb", 
+                                          "README", 
+                                          "CHANGELOG", 
+                                          "LICENSE"] do
+   # Create the hint file in the lib directory
+   File.open(File.join("lib", "sqlanywhere.rb"), "w") do |f| 
+      f.puts hint_file
+   end
+   # Get the updated list of files to include in the gem
+   spec.files = Dir['ext/**/*'] + Dir['lib/**/*'] + Dir['test/**/*'] + Dir['CHANGELOG'] + Dir['LICENSE'] + Dir['README'] + Dir['Rakefile']
+   # Since this contains no compilked binaries, set it to be platform RUBY
+   spec.platform = Gem::Platform::RUBY					
+   Gem::Builder.new(spec).build
+   # Delete the hint file
+   File.unlink(File.join("lib", "sqlanywhere.rb"))
+end
+
+
+file "lib/sqlanywhere.so" => ["ext/sqlanywhere.so"] do
+   # If the hint file exists, delete it
+   File.unlink(File.join("lib", "sqlanywhere.rb")) if File.exists?(File.join("lib", "sqlanywhere.rb"))
+   File.copy(File.join("ext", "sqlanywhere.so"), "lib")
+end
+
+file "ext/sqlanywhere.so" => ["ext/sqlanywhere.c"] do
+   sh "cd ext && ruby extconf.rb"
+   sh "cd ext && #{MAKE}"
+   sh "cd ext && mt -outputresource:sqlanywhere.so;2 -manifest sqlanywhere.so.manifest" if APPLY_MANIFEST
+end
+
+desc "Install the gem"
+task :install => [:gem] do
+     sh "gem install sqlanywhere-#{pkg_version}-#{spec.platform}.gem"
+end
+
+# This builds the distributables. On windows it builds a platform specific gem, a source gem, and a souce zip archive.
+# On other platforms this builds a platform specific gem, a source gem, and a source tar.gz archive.
+desc "Build distributables (src zip, src tar.gz, gem)"
+task :dist do |t|
+   puts "Cleaning Build Environment..."
+   Rake.application['clobber'].invoke   
+
+   files = Dir.glob('*')
+
+   puts "Creating #{File.join('build', PACKAGE_NAME)}-#{pkg_version} directory..." 
+   FileUtils.mkdir_p "#{File.join('build', PACKAGE_NAME)}-#{pkg_version}"
+
+   puts "Copying files to #{File.join('build', PACKAGE_NAME)}-#{pkg_version}..." 
+   FileUtils.cp_r files, "#{File.join('build', PACKAGE_NAME)}-#{pkg_version}"
+
+   if( ARCH =~ /win32/ ) then
+      system "attrib -R #{File.join('build', PACKAGE_NAME)}-#{pkg_version} /S"
+   else
+      system "find #{File.join('build', PACKAGE_NAME)}-#{pkg_version} -type d -exec chmod 755 {} \\;"
+      system "find #{File.join('build', PACKAGE_NAME)}-#{pkg_version} -type f -exec chmod 644 {} \\;"
+   end
+
+   if( ARCH =~ /win32/ ) then   
+      puts "Creating #{File.join('build', PACKAGE_NAME)}-#{pkg_version}.zip..." 
+      system "cd build && zip -q -r #{PACKAGE_NAME}-#{pkg_version}.zip #{PACKAGE_NAME}-#{pkg_version}"   
+   else
+      puts "Creating #{File.join('build', PACKAGE_NAME)}-#{pkg_version}.tar..." 
+      system "tar cf #{File.join('build', PACKAGE_NAME)}-#{pkg_version}.tar -C build #{PACKAGE_NAME}-#{pkg_version}"
+      
+      puts "GZipping to create #{File.join('build', PACKAGE_NAME, PACKAGE_NAME)}-#{pkg_version}.tar.gz..." 
+      system "gzip #{File.join('build', PACKAGE_NAME)}-#{pkg_version}.tar"
+   end
+
+   puts "Building GEM source distributable..." 
+   Rake.application['source_gem'].invoke   
+
+   puts "Copying source GEM to #{File.join('build', PACKAGE_NAME)}-#{pkg_version}.gem..." 
+   FileUtils.cp "#{PACKAGE_NAME}-#{pkg_version}.gem", "build"
+
+   puts "Building GEM binary distributable..." 
+   Rake.application['gem'].invoke   
+
+   puts "Copying binary GEM to #{File.join('build', PACKAGE_NAME)}-#{pkg_version}-#{spec.platform}.gem..." 
+   FileUtils.cp "#{PACKAGE_NAME}-#{pkg_version}-#{spec.platform}.gem", "build"
+end
+
+Rake::RDocTask.new do |rd|
+   rd.title = "SQL Anywhere Ruby Driver"
+   rd.main = "README"
+   rd.rdoc_files.include('README', 'CHANGELOG', 'LICENSE', 'ext/sqlanywhere.c')
+end
+
+desc "Publish the RDOCs on RubyForge"
+task :publish_rdoc => ["html/index.html"] do
+  system "pscp -r html/* efarrar@rubyforge.org:/var/www/gforge-projects/sqlanywhere/sqlanywhere"
+end
+
+CLOBBER.include("sqlanywhere-#{pkg_version}-#{spec.platform}.gem", "sqlanywhere-#{pkg_version}.gem", "lib/*", "ext/*.obj", "ext/*.def", "ext/*.so", "ext/*.log", "ext/*.exp", "ext/*.lib", "ext/*.pdb", "ext/Makefile", "ext/*.so.manifest", "ext/*.o", "build/**/*", "build")

data/ext/extconf.rb

@@ -0,0 +1,30 @@
+#====================================================
+#
+#    Copyright 2008 iAnywhere Solutions, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#                                                                               
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# While not a requirement of the license, if you do modify this file, we
+# would appreciate hearing about it.   Please email sqlany_interfaces@sybase.com
+#
+#
+#====================================================
+
+require 'mkmf'
+
+dir_config('SQLANY')
+
+create_makefile("sqlanywhere")
+