tiny_tds 3.1.0 → 3.2.0

data/ext/tiny_tds/extconf.rb

@@ -1,91 +1,190 @@
-ENV['RC_ARCHS'] = '' if RUBY_PLATFORM =~ /darwin/
+require "mkmf"
+require_relative "extconsts"
+
+if ENV["MAINTAINER_MODE"]
+  warn "Maintainer mode enabled."
+  $CFLAGS << # standard:disable Style/GlobalVars
+    " -Wall" \
+    " -ggdb" \
+    " -DDEBUG" \
+    " -pedantic"
+  $LDFLAGS << # standard:disable Style/GlobalVars
+    " -ggdb"
+end
 
-# :stopdoc:
+if (gem_platform = with_config("cross-build"))
+  require "mini_portile2"
 
-require 'mkmf'
-require 'rbconfig'
-require_relative './extconsts'
+  openssl_platform = with_config("openssl-platform")
 
-# Shamelessly copied from nokogiri
-#
+  class BuildRecipe < MiniPortile
+    attr_accessor :gem_platform
 
-def do_help
-  print <<HELP
-usage: ruby #{$0} [options]
-    --with-freetds-dir=DIR
-      Use the freetds library placed under DIR.
-HELP
-  exit! 0
-end
+    def initialize(name, version, files)
+      super(name, version)
+      self.files = files
+      rootdir = File.expand_path("../../..", __FILE__)
+      self.target = File.join(rootdir, "ports")
+      self.patch_files = Dir[File.join("patches", self.name, self.version, "*.patch")].sort
+    end
+
+    # this will yield all ports into the same directory, making our path configuration for the linker easier
+    def port_path
+      "#{@target}/#{gem_platform}"
+    end
 
-do_help if arg_config('--help')
+    def cook_and_activate
+      checkpoint = File.join(target, "#{name}-#{version}-#{gem_platform}.installed")
 
-# Make sure to check the ports path for the configured host
-architecture = RbConfig::CONFIG['arch']
+      unless File.exist?(checkpoint)
+        cook
+        FileUtils.touch checkpoint
+      end
+
+      activate
+      self
+    end
+  end
 
-project_dir = File.expand_path("../../..", __FILE__)
-freetds_ports_dir = File.join(project_dir, 'ports', architecture, 'freetds', FREETDS_VERSION)
-freetds_ports_dir = File.expand_path(freetds_ports_dir)
+  openssl_recipe = BuildRecipe.new("openssl", OPENSSL_VERSION, [OPENSSL_SOURCE_URI]).tap do |recipe|
+    class << recipe
+      attr_accessor :openssl_platform
+
+      def configure
+        envs = []
+        envs << "CFLAGS=-DDSO_WIN32 -DOPENSSL_THREADS" if MiniPortile.windows?
+        envs << "CFLAGS=-fPIC -DOPENSSL_THREADS" if MiniPortile.linux?
+        execute("configure", ["env", *envs, "./Configure", openssl_platform, "threads", "-static", "CROSS_COMPILE=#{host}-", configure_prefix, "--libdir=lib"], altlog: "config.log")
+      end
+
+      def compile
+        execute("compile", "#{make_cmd} build_libs")
+      end
+
+      def install
+        execute("install", "#{make_cmd} install_dev")
+      end
+    end
+
+    recipe.gem_platform = gem_platform
+    recipe.openssl_platform = openssl_platform
+    recipe.cook_and_activate
+  end
 
-# Add all the special path searching from the original tiny_tds build
-# order is important here! First in, first searched.
-DIRS = %w(
-  /opt/local
-  /usr/local
-)
+  libiconv_recipe = BuildRecipe.new("libiconv", ICONV_VERSION, [ICONV_SOURCE_URI]).tap do |recipe|
+    recipe.configure_options << "CFLAGS=-fPIC" if MiniPortile.linux?
+    recipe.gem_platform = gem_platform
 
-if RbConfig::CONFIG['host_os'] =~ /darwin/i
-  # Ruby below 2.7 seems to label the host CPU on Apple Silicon as aarch64
-  # 2.7 and above print is as ARM64
-  target_host_cpu = Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.7') ? 'aarch64' : 'arm64'
+    recipe.cook_and_activate
+  end
 
-  if RbConfig::CONFIG['host_cpu'] == target_host_cpu
-    # Homebrew on Apple Silicon installs into /opt/hombrew
-    # https://docs.brew.sh/Installation
-    # On Intel Macs, it is /usr/local, so no changes necessary to DIRS
-    DIRS.unshift("/opt/homebrew")
+  # remove the ".la" files, otherwise libtool starts to complain when linking into FreeTDS
+  Dir.glob(File.join(libiconv_recipe.path, "lib", "**", "*.la")).each do |la_file|
+    File.delete(la_file)
   end
-end
 
-if ENV["RI_DEVKIT"] && ENV["MINGW_PREFIX"] # RubyInstaller Support
-  DIRS.unshift(File.join(ENV["RI_DEVKIT"], ENV["MINGW_PREFIX"]))
-end
+  freetds_recipe = BuildRecipe.new("freetds", FREETDS_VERSION, [FREETDS_SOURCE_URI]).tap do |recipe|
+    class << recipe
+      def configure_defaults
+        [
+          "--host=#{@host}",
+          "--enable-shared",
+          "--disable-static",
+          "--disable-odbc"
+        ]
+      end
+    end
+
+    # i am not 100% what is going on behind the scenes
+    # it seems that FreeTDS build system prefers OPENSSL_CFLAGS and OPENSSL_LIBS
+    # but the linker still relies on LIBS and CPPFLAGS
+    # removing one or the other leads to build failures in any case of FreeTDS
+    if MiniPortile.linux?
+      recipe.configure_options << "CFLAGS=-fPIC"
+    elsif MiniPortile.windows?
+      recipe.configure_options << "--enable-sspi"
+    end
+
+    # pass an additional runtime path to the linker so defncopy and tsql can find our shared sybdb
+    recipe.configure_options << "LDFLAGS=-L#{openssl_recipe.path}/lib #{"-Wl,-rpath='$$ORIGIN/../lib'" if MiniPortile.linux?}"
+    recipe.configure_options << "LIBS=-liconv -lssl -lcrypto #{"-lwsock32 -lgdi32 -lws2_32 -lcrypt32" if MiniPortile.windows?} #{"-ldl -lpthread" if MiniPortile.linux?}"
+    recipe.configure_options << "CPPFLAGS=-I#{openssl_recipe.path}/include"
+
+    recipe.configure_options << "OPENSSL_CFLAGS=-L#{openssl_recipe.path}/lib"
+    recipe.configure_options << "OPENSSL_LIBS=-lssl -lcrypto #{"-lwsock32 -lgdi32 -lws2_32 -lcrypt32" if MiniPortile.windows?} #{"-ldl -lpthread" if MiniPortile.linux?}"
+
+    recipe.configure_options << "--with-openssl=#{openssl_recipe.path}"
+    recipe.configure_options << "--with-libiconv-prefix=#{libiconv_recipe.path}"
+    recipe.configure_options << "--sysconfdir=C:/Sites" if MiniPortile.windows?
+
+    recipe.gem_platform = gem_platform
+    recipe.cook_and_activate
+  end
 
-# Add the ports directory if it exists for local developer builds
-DIRS.unshift(freetds_ports_dir) if File.directory?(freetds_ports_dir)
+  # enable relative path to later load the FreeTDS shared library
+  $LDFLAGS << " '-Wl,-rpath=$$ORIGIN/../../../ports/#{gem_platform}/lib'" # standard:disable Style/GlobalVars
+
+  dir_config("freetds", "#{freetds_recipe.path}/include", "#{freetds_recipe.path}/lib")
+else
+  # Make sure to check the ports path for the configured host
+  architecture = RbConfig::CONFIG["arch"]
+
+  project_dir = File.expand_path("../../..", __FILE__)
+  freetds_ports_dir = File.join(project_dir, "ports", architecture, "freetds", FREETDS_VERSION)
+  freetds_ports_dir = File.expand_path(freetds_ports_dir)
+
+  # Add all the special path searching from the original tiny_tds build
+  # order is important here! First in, first searched.
+  DIRS = %w[
+    /opt/local
+    /usr/local
+  ]
+
+  if /darwin/i.match?(RbConfig::CONFIG["host_os"])
+    # Ruby below 2.7 seems to label the host CPU on Apple Silicon as aarch64
+    # 2.7 and above print is as ARM64
+    target_host_cpu = (Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.7")) ? "aarch64" : "arm64"
+
+    if RbConfig::CONFIG["host_cpu"] == target_host_cpu
+      # Homebrew on Apple Silicon installs into /opt/hombrew
+      # https://docs.brew.sh/Installation
+      # On Intel Macs, it is /usr/local, so no changes necessary to DIRS
+      DIRS.unshift("/opt/homebrew")
+    end
+  end
 
-# Grab freetds environment variable for use by people on services like
-# Heroku who they can't easily use bundler config to set directories
-DIRS.unshift(ENV['FREETDS_DIR']) if ENV.has_key?('FREETDS_DIR')
+  if ENV["RI_DEVKIT"] && ENV["MINGW_PREFIX"] # RubyInstaller Support
+    DIRS.unshift(File.join(ENV["RI_DEVKIT"], ENV["MINGW_PREFIX"]))
+  end
 
-# Add the search paths for freetds configured above
-ldirs = DIRS.flat_map do |path|
-  ldir = "#{path}/lib"
-  [ldir, "#{ldir}/freetds"]
-end
+  # Add the ports directory if it exists for local developer builds
+  DIRS.unshift(freetds_ports_dir) if File.directory?(freetds_ports_dir)
 
-idirs = DIRS.flat_map do |path|
-  idir = "#{path}/include"
-  [idir, "#{idir}/freetds"]
-end
+  # Grab freetds environment variable for use by people on services like
+  # Heroku who they can't easily use bundler config to set directories
+  DIRS.unshift(ENV["FREETDS_DIR"]) if ENV.has_key?("FREETDS_DIR")
 
-puts "looking for freetds headers in the following directories:\n#{idirs.map{|a| " - #{a}\n"}.join}"
-puts "looking for freetds library in the following directories:\n#{ldirs.map{|a| " - #{a}\n"}.join}"
-dir_config('freetds', idirs, ldirs)
-
-have_dependencies = [
-  find_header('sybfront.h'),
-  find_header('sybdb.h'),
-  find_library('sybdb', 'tdsdbopen'),
-  find_library('sybdb', 'dbanydatecrack')
-].inject(true) do |memo, current|
-  memo && current
-end
+  # Add the search paths for freetds configured above
+  ldirs = DIRS.flat_map do |path|
+    ldir = "#{path}/lib"
+    [ldir, "#{ldir}/freetds"]
+  end
+
+  idirs = DIRS.flat_map do |path|
+    idir = "#{path}/include"
+    [idir, "#{idir}/freetds"]
+  end
 
-unless have_dependencies
-  abort 'Failed! Do you have FreeTDS 1.0.0 or higher installed?'
+  puts "looking for freetds headers in the following directories:\n#{idirs.map { |a| " - #{a}\n" }.join}"
+  puts "looking for freetds library in the following directories:\n#{ldirs.map { |a| " - #{a}\n" }.join}"
+  dir_config("freetds", idirs, ldirs)
 end
 
-create_makefile('tiny_tds/tiny_tds')
+find_header("sybfront.h") or abort "Can't find the 'sybfront.h' header"
+find_header("sybdb.h") or abort "Can't find the 'sybdb.h' header"
+
+unless have_library("sybdb", "dbanydatecrack")
+  abort "Failed! Do you have FreeTDS 1.0.0 or higher installed?"
+end
 
-# :startdoc:
+create_makefile("tiny_tds/tiny_tds")

data/ext/tiny_tds/extconsts.rb

@@ -1,9 +1,8 @@
-
-ICONV_VERSION = ENV['TINYTDS_ICONV_VERSION'] || "1.17"
+ICONV_VERSION = ENV["TINYTDS_ICONV_VERSION"] || "1.18"
 ICONV_SOURCE_URI = "http://ftp.gnu.org/pub/gnu/libiconv/libiconv-#{ICONV_VERSION}.tar.gz"
 
-OPENSSL_VERSION = ENV['TINYTDS_OPENSSL_VERSION'] || '3.4.0'
+OPENSSL_VERSION = ENV["TINYTDS_OPENSSL_VERSION"] || "3.4.0"
 OPENSSL_SOURCE_URI = "https://www.openssl.org/source/openssl-#{OPENSSL_VERSION}.tar.gz"
 
-FREETDS_VERSION = ENV['TINYTDS_FREETDS_VERSION'] || '1.4.23'
+FREETDS_VERSION = ENV["TINYTDS_FREETDS_VERSION"] || "1.4.26"
 FREETDS_SOURCE_URI = "http://www.freetds.org/files/stable/freetds-#{FREETDS_VERSION}.tar.bz2"

data/lib/tiny_tds/bin.rb

@@ -1,23 +1,22 @@
-require_relative './version'
-require_relative './gem'
-require 'shellwords'
+require_relative "version"
+require_relative "gem"
+require "shellwords"
 
 module TinyTds
   class Bin
-
     attr_reader :name
 
     class << self
       def exe(name, *args)
         bin = new(name)
-        puts bin.info unless args.any? { |x| x == '-q' }
+        puts bin.info unless args.any? { |x| x == "-q" }
         bin.run(*args)
       end
     end
 
     def initialize(name)
       @root = Gem.root_path
-      @exts = (ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']) | ['.exe']
+      @exts = (ENV["PATHEXT"] ? ENV["PATHEXT"].split(";") : [""]) | [".exe"]
 
       @name = name
       @binstub = find_bin
@@ -33,7 +32,7 @@ module TinyTds
     end
 
     def path
-      @path ||= @exefile && File.exist?(@exefile) ? @exefile : which
+      @path ||= (@exefile && File.exist?(@exefile)) ? @exefile : which
     end
 
     def info
@@ -43,26 +42,26 @@ module TinyTds
     private
 
     def search_paths
-      ENV['PATH'].split File::PATH_SEPARATOR
+      ENV["PATH"].split File::PATH_SEPARATOR
     end
 
     def with_ports_paths
-      old_path = ENV['PATH']
+      old_path = ENV["PATH"]
 
       begin
-        ENV['PATH'] = [
+        ENV["PATH"] = [
           Gem.ports_bin_paths,
           old_path
         ].flatten.join File::PATH_SEPARATOR
 
         yield if block_given?
       ensure
-        ENV['PATH'] = old_path
+        ENV["PATH"] = old_path
       end
     end
 
     def find_bin
-      File.join @root, 'bin', name
+      File.join @root, "bin", name
     end
 
     def find_exe
@@ -81,24 +80,11 @@ module TinyTds
           exe = File.expand_path File.join(path, "#{name}#{ext}"), @root
           next if exe == @binstub
           next unless File.executable?(exe)
-          next unless binary?(exe)
+
           return exe
         end
       end
       nil
     end
-
-    # Implementation directly copied from ptools.
-    # https://github.com/djberg96/ptools
-    # https://opensource.org/licenses/Artistic-2.0
-    #
-    def binary?(file)
-      bytes = File.stat(file).blksize
-      return false unless bytes
-      bytes = 4096 if bytes > 4096
-      s = (File.read(file, bytes) || '')
-      s = s.encode('US-ASCII', undef: :replace).split(//)
-      ((s.size - s.grep(' '..'~').size) / s.size.to_f) > 0.30
-    end
   end
 end

data/lib/tiny_tds/client.rb

@@ -1,6 +1,5 @@
 module TinyTds
   class Client
-
     @default_query_options = {
       as: :hash,
       symbolize_keys: false,
@@ -13,7 +12,6 @@ module TinyTds
     attr_reader :message_handler
 
     class << self
-
       attr_reader :default_query_options
 
       # Most, if not all, iconv encoding names can be found by ruby. Just in case, you can
@@ -27,7 +25,6 @@ module TinyTds
       def local_offset
         ::Time.local(2010).utc_offset.to_r / 86_400
       end
-
     end
 
     # rubocop:disable Metrics/AbcSize
@@ -36,23 +33,23 @@ module TinyTds
     # rubocop:disable Metrics/PerceivedComplexity
     def initialize(opts = {})
       if opts[:dataserver].to_s.empty? && opts[:host].to_s.empty?
-        raise ArgumentError, 'missing :host option if no :dataserver given'
+        raise ArgumentError, "missing :host option if no :dataserver given"
       end
 
       @message_handler = opts[:message_handler]
       if @message_handler && !@message_handler.respond_to?(:call)
-        raise ArgumentError, ':message_handler must implement `call` (eg, a Proc or a Method)'
+        raise ArgumentError, ":message_handler must implement `call` (eg, a Proc or a Method)"
       end
 
       opts[:username] = parse_username(opts)
       @query_options = self.class.default_query_options.dup
-      opts[:password] = opts[:password].to_s if opts[:password] && opts[:password].to_s.strip != ''
-      opts[:appname] ||= 'TinyTds'
+      opts[:password] = opts[:password].to_s if opts[:password] && opts[:password].to_s.strip != ""
+      opts[:appname] ||= "TinyTds"
       opts[:tds_version] = tds_versions_setter(opts)
       opts[:use_utf16] = opts[:use_utf16].nil? || ["true", "1", "yes"].include?(opts[:use_utf16].to_s)
       opts[:login_timeout] ||= 60
       opts[:timeout] ||= 5
-      opts[:encoding] = opts[:encoding].nil? || opts[:encoding].casecmp('utf8').zero? ? 'UTF-8' : opts[:encoding].upcase
+      opts[:encoding] = (opts[:encoding].nil? || opts[:encoding].casecmp("utf8").zero?) ? "UTF-8" : opts[:encoding].upcase
       opts[:port] ||= 1433
       opts[:dataserver] = "#{opts[:host]}:#{opts[:port]}" if opts[:dataserver].to_s.empty?
       forced_integer_keys = [:login_timeout, :port, :timeout]
@@ -79,14 +76,14 @@ module TinyTds
       host = opts[:host]
       username = opts[:username]
       return username if username.nil? || !opts[:azure]
-      return username if username.include?('@') && !username.include?('database.windows.net')
-      user, domain = username.split('@')
+      return username if username.include?("@") && !username.include?("database.windows.net")
+      user, domain = username.split("@")
       domain ||= host
-      "#{user}@#{domain.split('.').first}"
+      "#{user}@#{domain.split(".").first}"
     end
 
     def tds_versions_setter(opts = {})
-      v = opts[:tds_version] || ENV['TDSVER'] || '7.3'
+      v = opts[:tds_version] || ENV["TDSVER"] || "7.3"
       TDS_VERSIONS_SETTERS[v.to_s]
     end
 
@@ -94,22 +91,22 @@ module TinyTds
     # DBVERSION_xxx are used with dbsetversion()
     #
     TDS_VERSIONS_SETTERS = {
-      'unknown' => 0,
-      '46'      => 1,
-      '100'     => 2,
-      '42'      => 3,
-      '70'      => 4,
-      '7.0'     => 4,
-      '71'      => 5,
-      '7.1'     => 5,
-      '80'      => 5,
-      '8.0'     => 5,
-      '72'      => 6,
-      '7.2'     => 6,
-      '90'      => 6,
-      '9.0'     => 6,
-      '73'      => 7,
-      '7.3'     => 7
+      "unknown" => 0,
+      "46" => 1,
+      "100" => 2,
+      "42" => 3,
+      "70" => 4,
+      "7.0" => 4,
+      "71" => 5,
+      "7.1" => 5,
+      "80" => 5,
+      "8.0" => 5,
+      "72" => 6,
+      "7.2" => 6,
+      "90" => 6,
+      "9.0" => 6,
+      "73" => 7,
+      "7.3" => 7
     }.freeze
 
     # From sybdb.h comments:
@@ -117,20 +114,19 @@ module TinyTds
     # The integer values of the constants are poorly chosen.
     #
     TDS_VERSIONS_GETTERS = {
-      0  => { name: 'DBTDS_UNKNOWN',        description: 'Unknown' },
-      1  => { name: 'DBTDS_2_0',            description: 'Pre 4.0 SQL Server' },
-      2  => { name: 'DBTDS_3_4',            description: 'Microsoft SQL Server (3.0)' },
-      3  => { name: 'DBTDS_4_0',            description: '4.0 SQL Server' },
-      4  => { name: 'DBTDS_4_2',            description: '4.2 SQL Server' },
-      5  => { name: 'DBTDS_4_6',            description: '2.0 OpenServer and 4.6 SQL Server.' },
-      6  => { name: 'DBTDS_4_9_5',          description: '4.9.5 (NCR) SQL Server' },
-      7  => { name: 'DBTDS_5_0',            description: '5.0 SQL Server' },
-      8  => { name: 'DBTDS_7_0',            description: 'Microsoft SQL Server 7.0' },
-      9  => { name: 'DBTDS_7_1/DBTDS_8_0',  description: 'Microsoft SQL Server 2000' },
-      10 => { name: 'DBTDS_7_2/DBTDS_9_0',  description: 'Microsoft SQL Server 2005' },
-      11 => { name: 'DBTDS_7_3',            description: 'Microsoft SQL Server 2008' },
-      12 => { name: 'DBTDS_7_4',            description: 'Microsoft SQL Server 2012/2014' }
+      0 => {name: "DBTDS_UNKNOWN", description: "Unknown"},
+      1 => {name: "DBTDS_2_0", description: "Pre 4.0 SQL Server"},
+      2 => {name: "DBTDS_3_4", description: "Microsoft SQL Server (3.0)"},
+      3 => {name: "DBTDS_4_0", description: "4.0 SQL Server"},
+      4 => {name: "DBTDS_4_2", description: "4.2 SQL Server"},
+      5 => {name: "DBTDS_4_6", description: "2.0 OpenServer and 4.6 SQL Server."},
+      6 => {name: "DBTDS_4_9_5", description: "4.9.5 (NCR) SQL Server"},
+      7 => {name: "DBTDS_5_0", description: "5.0 SQL Server"},
+      8 => {name: "DBTDS_7_0", description: "Microsoft SQL Server 7.0"},
+      9 => {name: "DBTDS_7_1/DBTDS_8_0", description: "Microsoft SQL Server 2000"},
+      10 => {name: "DBTDS_7_2/DBTDS_9_0", description: "Microsoft SQL Server 2005"},
+      11 => {name: "DBTDS_7_3", description: "Microsoft SQL Server 2008"},
+      12 => {name: "DBTDS_7_4", description: "Microsoft SQL Server 2012/2014"}
     }.freeze
-
   end
 end

data/lib/tiny_tds/error.rb

@@ -1,6 +1,5 @@
 module TinyTds
   class Error < StandardError
-
     attr_accessor :source, :severity, :db_error_number, :os_error_number
 
     def initialize(message)
@@ -9,6 +8,5 @@ module TinyTds
       @db_error_number = nil
       @os_error_number = nil
     end
-
   end
 end

data/lib/tiny_tds/gem.rb

@@ -1,26 +1,22 @@
-require 'rbconfig'
+require "rbconfig"
 
 module TinyTds
   module Gem
     class << self
       def root_path
-        File.expand_path '../../..', __FILE__
+        File.expand_path "../../..", __FILE__
       end
 
       def ports_root_path
-        File.join(root_path,'ports')
+        File.join(root_path, "ports")
       end
 
       def ports_bin_paths
-        Dir.glob(File.join(ports_root_path,ports_host,'**','bin'))
+        Dir.glob(File.join(ports_root_path, "**", "bin"))
       end
 
       def ports_lib_paths
-        Dir.glob(File.join(ports_root_path,ports_host,'**','lib'))
-      end
-
-      def ports_host
-        RbConfig::CONFIG["arch"]
+        Dir.glob(File.join(ports_root_path, "**", "lib"))
       end
     end
   end

data/lib/tiny_tds/result.rb

@@ -1,7 +1,5 @@
 module TinyTds
   class Result
-
     include Enumerable
-
   end
 end

data/lib/tiny_tds/version.rb

@@ -1,3 +1,3 @@
 module TinyTds
-  VERSION = File.read(File.expand_path('../../../VERSION', __FILE__)).chomp
+  VERSION = File.read(File.expand_path("../../../VERSION", __FILE__)).chomp
 end