ffi-mysql 0.0.1

data/History.rdoc

@@ -0,0 +1,4 @@
+== 0.0.1 / 2010-03-03
+
+* 1 major enhancement
+* mostly compatible to MySQL/Ruby  

data/README

@@ -0,0 +1,55 @@
+ffi-mysql
+    by Frank Fischer
+    http://bitbucket.org/lyro/ffi-mysql
+
+== DESCRIPTION:
+
+Pure Ruby FFI interface to MySQL.
+
+== FEATURES/PROBLEMS:
+
+* satisfies almost complete test-suite of MySQL/Ruby
+* prepared statement does not handle Double fields 
+  correctly
+
+== SYNOPSIS:
+
+  See MySQL/Ruby for examples.
+
+== REQUIREMENTS:
+
+* ffi >= 0.6.2
+
+== INSTALL:
+
+gem install ffi-ruby
+
+== ACKNOWLEDGEMENTS:
+
+Tomita Masahiro for his MySQL/Ruby and Ruby/MySQL gems from which some
+of the code has been stolen.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Frank Fischer
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,55 @@
+ffi-mysql
+    by Frank Fischer
+    http://bitbucket.org/lyro/ffi-mysql
+
+== DESCRIPTION:
+
+Pure Ruby FFI interface to MySQL.
+
+== FEATURES/PROBLEMS:
+
+* satisfies almost complete test-suite of MySQL/Ruby
+* prepared statement does not handle Double fields 
+  correctly
+
+== SYNOPSIS:
+
+  See MySQL/Ruby for examples.
+
+== REQUIREMENTS:
+
+* ffi >= 0.6.2
+
+== INSTALL:
+
+gem install ffi-ruby
+
+== ACKNOWLEDGEMENTS:
+
+Tomita Masahiro for his MySQL/Ruby and Ruby/MySQL gems from which some
+of the code has been stolen.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Frank Fischer
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,27 @@
+
+begin
+    require 'bones'
+rescue LoadError
+    abort '### Please install the "bones" gem ###'
+end
+
+ensure_in_path 'lib'
+require 'ffi-mysql'
+
+task :default => 'test:run'
+task 'gem:release' => 'test:run'
+
+Bones {
+    name  'ffi-mysql'
+    authors  'Frank Fischer'
+    email  'frank.fischer@mathematik.tu-chemnitz.de'
+    url  'http://bitbucket.org/lyro/ffi-mysql/wiki'
+    ignore_file '.hgignore'
+    readme_file 'README.rdoc'
+    history_file 'History.rdoc'
+    version  Mysql::VERSION
+    gem.extras = { :has_rdoc => 'yard' }
+    depend_on 'ffi', '>= 0.6.2'
+}
+
+# EOF

data/lib/ffi-mysql.rb

@@ -0,0 +1,49 @@
+
+class Mysql
+
+  # :stopdoc:
+  VERSION = '0.0.1'
+  LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
+  PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
+  # :startdoc:
+
+  # Returns the version string for the library.
+  #
+  def self.version
+    VERSION
+  end
+
+  # Returns the library path for the module. If any arguments are given,
+  # they will be joined to the end of the libray path using
+  # <tt>File.join</tt>.
+  #
+  def self.libpath( *args )
+    args.empty? ? LIBPATH : ::File.join(LIBPATH, args.flatten)
+  end
+
+  # Returns the lpath for the module. If any arguments are given,
+  # they will be joined to the end of the path using
+  # <tt>File.join</tt>.
+  #
+  def self.path( *args )
+    args.empty? ? PATH : ::File.join(PATH, args.flatten)
+  end
+
+  # Utility method used to require all files ending in .rb that lie in the
+  # directory below this file that has the same name as the filename passed
+  # in. Optionally, a specific _directory_ name can be passed in such that
+  # the _filename_ does not have to be equivalent to the directory.
+  #
+  def self.require_all_libs_relative_to( fname, dir = nil )
+    dir ||= ::File.basename(fname, '.*')
+    search_me = ::File.expand_path(
+        ::File.join(::File.dirname(fname), dir, '**', '*.rb'))
+
+    Dir.glob(search_me).sort.each {|rb| require rb}
+  end
+
+end  # class Mysql
+
+Mysql.require_all_libs_relative_to(__FILE__, "mysql")
+
+

data/lib/mysql/constants.rb

@@ -0,0 +1,166 @@
+# Copyright (C) 2003-2008 TOMITA Masahiro
+# mailto:tommy@tmtm.org
+
+class Mysql
+    # Command
+    COM_SLEEP               = 0
+    COM_QUIT                = 1
+    COM_INIT_DB             = 2
+    COM_QUERY               = 3
+    COM_FIELD_LIST          = 4
+    COM_CREATE_DB           = 5
+    COM_DROP_DB             = 6
+    COM_REFRESH             = 7
+    COM_SHUTDOWN            = 8
+    COM_STATISTICS          = 9
+    COM_PROCESS_INFO        = 10
+    COM_CONNECT             = 11
+    COM_PROCESS_KILL        = 12
+    COM_DEBUG               = 13
+    COM_PING                = 14
+    COM_TIME                = 15
+    COM_DELAYED_INSERT      = 16
+    COM_CHANGE_USER         = 17
+    COM_BINLOG_DUMP         = 18
+    COM_TABLE_DUMP          = 19
+    COM_CONNECT_OUT         = 20
+    COM_REGISTER_SLAVE      = 21
+    COM_STMT_PREPARE        = 22
+    COM_STMT_EXECUTE        = 23
+    COM_STMT_SEND_LONG_DATA = 24
+    COM_STMT_CLOSE          = 25
+    COM_STMT_RESET          = 26
+    COM_SET_OPTION          = 27
+    COM_STMT_FETCH          = 28
+
+    # Client flag
+    CLIENT_LONG_PASSWORD     = 1         # new more secure passwords
+    CLIENT_FOUND_ROWS        = 1 << 1    # Found instead of affected rows
+    CLIENT_LONG_FLAG         = 1 << 2    # Get all column flags
+    CLIENT_CONNECT_WITH_DB   = 1 << 3    # One can specify db on connect
+    CLIENT_NO_SCHEMA         = 1 << 4    # Don't allow database.table.column
+    CLIENT_COMPRESS          = 1 << 5    # Can use compression protocol
+    CLIENT_ODBC              = 1 << 6    # Odbc client
+    CLIENT_LOCAL_FILES       = 1 << 7    # Can use LOAD DATA LOCAL
+    CLIENT_IGNORE_SPACE      = 1 << 8    # Ignore spaces before '('
+    CLIENT_PROTOCOL_41       = 1 << 9    # New 4.1 protocol
+    CLIENT_INTERACTIVE       = 1 << 10   # This is an interactive client
+    CLIENT_SSL               = 1 << 11   # Switch to SSL after handshake
+    CLIENT_IGNORE_SIGPIPE    = 1 << 12   # IGNORE sigpipes
+    CLIENT_TRANSACTIONS      = 1 << 13   # Client knows about transactions
+    CLIENT_RESERVED          = 1 << 14   # Old flag for 4.1 protocol
+    CLIENT_SECURE_CONNECTION = 1 << 15   # New 4.1 authentication
+    CLIENT_MULTI_STATEMENTS  = 1 << 16   # Enable/disable multi-stmt support
+    CLIENT_MULTI_RESULTS     = 1 << 17   # Enable/disable multi-results
+
+    # Connection Option
+    OPT_CONNECT_TIMEOUT         = 0
+    OPT_COMPRESS                = 1
+    OPT_NAMED_PIPE              = 2
+    INIT_COMMAND                = 3
+    READ_DEFAULT_FILE           = 4
+    READ_DEFAULT_GROUP          = 5
+    SET_CHARSET_DIR             = 6
+    SET_CHARSET_NAME            = 7
+    OPT_LOCAL_INFILE            = 8
+    OPT_PROTOCOL                = 9
+    SHARED_MEMORY_BASE_NAME     = 10
+    OPT_READ_TIMEOUT            = 11
+    OPT_WRITE_TIMEOUT           = 12
+    OPT_USE_RESULT              = 13
+    OPT_USE_REMOTE_CONNECTION   = 14
+    OPT_USE_EMBEDDED_CONNECTION = 15
+    OPT_GUESS_CONNECTION        = 16
+    SET_CLIENT_IP               = 17
+    SECURE_AUTH                 = 18
+    REPORT_DATA_TRUNCATION      = 19
+    OPT_RECONNECT               = 20
+    OPT_SSL_VERIFY_SERVER_CERT  = 21
+
+    # Server Option
+    OPTION_MULTI_STATEMENTS_ON  = 0
+    OPTION_MULTI_STATEMENTS_OFF = 1
+
+    # Server Status
+    SERVER_STATUS_IN_TRANS             = 1
+    SERVER_STATUS_AUTOCOMMIT           = 1 << 1
+    SERVER_MORE_RESULTS_EXISTS         = 1 << 3
+    SERVER_QUERY_NO_GOOD_INDEX_USED    = 1 << 4
+    SERVER_QUERY_NO_INDEX_USED         = 1 << 5
+    SERVER_STATUS_CURSOR_EXISTS        = 1 << 6
+    SERVER_STATUS_LAST_ROW_SENT        = 1 << 7
+    SERVER_STATUS_DB_DROPPED           = 1 << 8
+    SERVER_STATUS_NO_BACKSLASH_ESCAPES = 1 << 9
+
+    # Refresh parameter
+    REFRESH_GRANT     = 1
+    REFRESH_LOG       = 1 << 1
+    REFRESH_TABLES    = 1 << 2
+    REFRESH_HOSTS     = 1 << 3
+    REFRESH_STATUS    = 1 << 4
+    REFRESH_THREADS   = 1 << 5
+    REFRESH_SLAVE     = 1 << 6
+    REFRESH_MASTER    = 1 << 7
+    REFRESH_READ_LOCK = 1 << 14
+    REFRESH_FAST      = 1 << 15
+
+    class Field
+        # Field type
+        TYPE_DECIMAL     = 0
+        TYPE_TINY        = 1
+        TYPE_SHORT       = 2
+        TYPE_LONG        = 3
+        TYPE_FLOAT       = 4
+        TYPE_DOUBLE      = 5
+        TYPE_NULL        = 6
+        TYPE_TIMESTAMP   = 7
+        TYPE_LONGLONG    = 8
+        TYPE_INT24       = 9
+        TYPE_DATE        = 10
+        TYPE_TIME        = 11
+        TYPE_DATETIME    = 12
+        TYPE_YEAR        = 13
+        TYPE_NEWDATE     = 14
+        TYPE_VARCHAR     = 15
+        TYPE_BIT         = 16
+        TYPE_NEWDECIMAL  = 246
+        TYPE_ENUM        = 247
+        TYPE_SET         = 248
+        TYPE_TINY_BLOB   = 249
+        TYPE_MEDIUM_BLOB = 250
+        TYPE_LONG_BLOB   = 251
+        TYPE_BLOB        = 252
+        TYPE_VAR_STRING  = 253
+        TYPE_STRING      = 254
+        TYPE_GEOMETRY    = 255
+        TYPE_CHAR        = TYPE_TINY
+        TYPE_INTERVAL    = TYPE_ENUM
+
+        # Flag
+        NOT_NULL_FLAG       = 1
+        PRI_KEY_FLAG        = 2
+        UNIQUE_KEY_FLAG     = 4
+        MULTIPLE_KEY_FLAG   = 8
+        BLOB_FLAG           = 16
+        UNSIGNED_FLAG       = 32
+        ZEROFILL_FLAG       = 64
+        BINARY_FLAG         = 128
+        ENUM_FLAG           = 256
+        AUTO_INCREMENT_FLAG = 512
+        TIMESTAMP_FLAG      = 1024
+        SET_FLAG            = 2048
+        NUM_FLAG            = 32768
+        PART_KEY_FLAG       = 16384
+        GROUP_FLAG          = 32768
+        UNIQUE_FLAG         = 65536
+        BINCMP_FLAG         = 131072
+    end
+
+    class Stmt
+        # Cursor type
+        CURSOR_TYPE_NO_CURSOR = 0
+        CURSOR_TYPE_READ_ONLY = 1
+        NO_DATA               = 100
+        DATA_TRUNCATED        = 101
+    end
+end

data/lib/mysql/error.rb

@@ -0,0 +1,4 @@
+class Mysql
+    class Error < Exception
+    end
+end

data/lib/mysql/field.rb

@@ -0,0 +1,89 @@
+class Mysql
+    # Information about one column.
+    class Field 
+        attr_reader :name
+        attr_reader :org_name
+        attr_reader :table
+        attr_reader :org_table
+        attr_reader :db
+        attr_reader :catalog
+        attr_reader :def
+        attr_reader :length
+        attr_reader :max_length
+        attr_reader :name_length
+        attr_reader :org_name_length
+        attr_reader :table_length
+        attr_reader :org_table_length
+        attr_reader :db_length
+        attr_reader :catalog_length
+        attr_reader :def_length
+        attr_reader :flags
+        attr_reader :decimals
+        attr_reader :charsetnr
+        attr_reader :type
+        
+        def initialize(c_field)
+            @name =             c_field[:name]
+            @org_name =         c_field[:org_name]
+            @table =            c_field[:table]
+            @org_table =        c_field[:org_table]
+            @db =               c_field[:db]
+            @catalog =          c_field[:catalog]
+            @def =              c_field[:def]
+            @length =           c_field[:length]
+            @max_length =       c_field[:max_length]
+            @name_length =      c_field[:name_length]
+            @org_name_length =  c_field[:org_name_length]
+            @table_length =     c_field[:table_length]
+            @org_table_length = c_field[:org_table_length]
+            @db_length =        c_field[:db_length]
+            @catalog_length =   c_field[:catalog_length]
+            @def_length =       c_field[:def_length]
+            @flags =            c_field[:flags]
+            @decimals =         c_field[:decimals]
+            @charsetnr =        c_field[:charsetnr]
+            # @type =             C::FieldType[c_field[:type]]
+            @type =             c_field[:type]
+            @flags |= NUM_FLAG if is_num_type?
+        end
+
+        # @return [Boolean] true if this field is not null
+        def is_not_null?
+            @flags & NOT_NULL_FLAG != 0
+        end
+
+        # @return [Boolean] true if this is a numeric field
+        def is_num?
+            @flags & NUM_FLAG != 0
+        end
+
+        # @return [Boolean] true if this field is a primary key
+        def is_pri_key?
+            @flags & PRI_KEY_FLAG != 0
+        end
+
+        # @return [Hash] this field as a hash
+        def hash
+            h = {}
+            h['name'] = @name             
+            h['table'] = @table            
+            h['def'] = @def              
+            h['length'] = @length           
+            h['max_length'] = @max_length       
+            h['flags'] = @flags            
+            h['decimals'] = @decimals         
+            h['type'] = @type             
+            h
+        end
+
+        def inspect
+            "#<Mysql::Field:#{@name}>"
+        end
+
+        private
+        # @return [Boolean] true if this field's type is a numeric type
+        def is_num_type?
+            [TYPE_DECIMAL, TYPE_TINY, TYPE_SHORT, TYPE_LONG, TYPE_FLOAT, TYPE_DOUBLE, TYPE_LONGLONG, TYPE_INT24].include?(@type) || (@type == TYPE_TIMESTAMP && (@length == 14 || @length == 8))
+        end
+    end
+end