odbc_adapter 3.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e903865d2eae4fef5a33f881da4d1890b7f2400c
+  data.tar.gz: e30af49c10265dcd7f189113b32ec59cf9d7267b
+SHA512:
+  metadata.gz: aa920bf163813b47069442b75e1290b3d418910f92c01904f5a0976e5809b768950382a3b693482f7f49e11a3532598a4e01c9929ac976e0aba7996115923b28
+  data.tar.gz: b85c71c0d26ccd11075308bf745f8592565e2434cd9038a38748f57f2866583386ca3bcadf4901a134a854122e90967b30a1f942c637bfafb891bfa0dd3399e7

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,29 @@
+sudo: required
+language: ruby
+cache: bundler
+matrix:
+  include:
+  - rvm: 2.3.1
+    env:
+    - DB=mysql
+    - CONN_STR='DRIVER=MySQL;SERVER=localhost;DATABASE=odbc_test;USER=root;PASSWORD=;'
+    addons:
+      mysql: "5.5"
+      apt:
+        packages:
+        - unixodbc
+        - unixodbc-dev
+        - libmyodbc
+        - mysql-client
+  - rvm: 2.3.1
+    env:
+    - DB=postgresql
+    - CONN_STR='DRIVER={PostgreSQL ANSI};SERVER=localhost;PORT=5432;DATABASE=odbc_test;UID=postgres;'
+    addons:
+      postgresql: "9.1"
+      apt:
+        packages:
+        - unixodbc
+        - unixodbc-dev
+        - odbc-postgresql
+before_script: bin/ci-setup

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'activerecord', '3.2.22.1'
+gem 'pry', '0.10.4'

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2017 Localytics http://www.localytics.com
+
+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.md

@@ -0,0 +1,37 @@
+# ODBCAdapter
+
+[![Build Status](https://travis-ci.com/localytics/odbc_adapter.svg?token=kQUiABmGkzyHdJdMnCnv&branch=master)](https://travis-ci.com/localytics/odbc_adapter)
+
+An ActiveRecord ODBC adapter.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'odbc_adapter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install odbc_adapter
+
+## Usage
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/localytics/odbc_adapter.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/ci-setup

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+case "$DB" in
+mysql)
+  sudo odbcinst -i -d -f /usr/share/libmyodbc/odbcinst.ini
+  mysql -e "DROP DATABASE IF EXISTS odbc_test; CREATE DATABASE IF NOT EXISTS odbc_test;" -uroot
+  mysql -e "GRANT ALL PRIVILEGES ON *.* TO 'root'@'localhost';" -uroot
+  ;;
+postgresql)
+  sudo odbcinst -i -d -f /usr/share/psqlodbc/odbcinst.ini.template
+  psql -c "CREATE DATABASE odbc_test;" -U postgres
+  ;;
+esac

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'odbc_adapter'
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/active_record/connection_adapters/odbc_adapter.rb

@@ -0,0 +1,127 @@
+require 'active_record'
+require 'arel/visitors/bind_visitor'
+require 'odbc'
+
+require 'odbc_adapter'
+require 'odbc_adapter/database_limits'
+require 'odbc_adapter/database_statements'
+require 'odbc_adapter/quoting'
+require 'odbc_adapter/schema_statements'
+
+require 'odbc_adapter/column'
+require 'odbc_adapter/column_metadata'
+require 'odbc_adapter/dbms'
+require 'odbc_adapter/type_caster'
+require 'odbc_adapter/version'
+
+module ActiveRecord
+  class Base
+    class << self
+      def odbc_connection(config) # :nodoc:
+        config = config.symbolize_keys
+
+        connection, options =
+          if config.key?(:dsn)
+            odbc_dsn_connection(config)
+          elsif config.key?(:conn_str)
+            odbc_conn_str_connection(config)
+          else
+            raise ArgumentError, "No data source name (:dsn) or connection string (:conn_str) specified."
+          end
+
+        dbms = ::ODBCAdapter::DBMS.new(connection)
+        dbms.adapter_class.new(connection, logger, dbms)
+      end
+
+      private
+
+      def odbc_dsn_connection(config)
+        username   = config[:username] ? config[:username].to_s : nil
+        password   = config[:password] ? config[:password].to_s : nil
+        connection = ODBC.connect(config[:dsn], username, password)
+        options    = { dsn: config[:dsn], username: username, password: password }
+        [connection, options]
+      end
+
+      # Connect using ODBC connection string
+      # Supports DSN-based or DSN-less connections
+      # e.g. "DSN=virt5;UID=rails;PWD=rails"
+      #      "DRIVER={OpenLink Virtuoso};HOST=carlmbp;UID=rails;PWD=rails"
+      def odbc_conn_str_connection(config)
+        connstr_keyval_pairs = config[:conn_str].split(';')
+
+        driver = ODBC::Driver.new
+        driver.name = 'odbc'
+        driver.attrs = {}
+
+        connstr_keyval_pairs.each do |pair|
+          keyval = pair.split('=')
+          driver.attrs[keyval[0]] = keyval[1] if keyval.length == 2
+        end
+
+        connection = ODBC::Database.new.drvconnect(driver)
+        options    = { conn_str: config[:conn_str], driver: driver }
+        [connection, options]
+      end
+    end
+  end
+
+  module ConnectionAdapters
+    class ODBCAdapter < AbstractAdapter
+      include ::ODBCAdapter::DatabaseLimits
+      include ::ODBCAdapter::DatabaseStatements
+      include ::ODBCAdapter::Quoting
+      include ::ODBCAdapter::SchemaStatements
+
+      ADAPTER_NAME = 'ODBC'.freeze
+
+      attr_reader :dbms
+
+      def initialize(connection, logger, dbms)
+        super(connection, logger)
+        @connection = connection
+        @dbms       = dbms
+        @visitor    = self.class::BindSubstitution.new(self)
+      end
+
+      # Returns the human-readable name of the adapter. Use mixed case - one
+      # can always use downcase if needed.
+      def adapter_name
+        ADAPTER_NAME
+      end
+
+      # Does this adapter support migrations? Backend specific, as the
+      # abstract adapter always returns +false+.
+      def supports_migrations?
+        true
+      end
+
+      # CONNECTION MANAGEMENT ====================================
+
+      # Checks whether the connection to the database is still active. This includes
+      # checking whether the database is actually capable of responding, i.e. whether
+      # the connection isn't stale.
+      def active?
+        @connection.connected?
+      end
+
+      # Disconnects from the database if already connected, and establishes a
+      # new connection with the database.
+      def reconnect!
+        disconnect!
+        @connection =
+          if options.key?(:dsn)
+            ODBC.connect(options[:dsn], options[:username], options[:password])
+          else
+            ODBC::Database.new.drvconnect(options[:driver])
+          end
+      end
+
+      # Disconnects from the database if already connected. Otherwise, this
+      # method does nothing.
+      def disconnect!
+        @connection.disconnect if @connection.connected?
+      end
+    end
+  end
+end

data/lib/odbc_adapter.rb

@@ -0,0 +1,17 @@
+# Requiring with this pattern to mirror ActiveRecord
+require 'active_record/connection_adapters/odbc_adapter'
+
+module ODBCAdapter
+  class << self
+    def dbms_registry
+      @dbms_registry ||= {
+        /my.*sql/i => :MySQL,
+        /postgres/i => :PostgreSQL
+      }
+    end
+
+    def register(pattern, superclass, &block)
+      dbms_registry[pattern] = Class.new(superclass, &block)
+    end
+  end
+end

data/lib/odbc_adapter/adapters/mysql_odbc_adapter.rb

@@ -0,0 +1,141 @@
+module ODBCAdapter
+  module Adapters
+    # Overrides specific to MySQL. Mostly taken from
+    # ActiveRecord::ConnectionAdapters::MySQLAdapter
+    class MySQLODBCAdapter < ActiveRecord::ConnectionAdapters::ODBCAdapter
+      class BindSubstitution < Arel::Visitors::MySQL
+        include Arel::Visitors::BindVisitor
+      end
+
+      PRIMARY_KEY = 'INT(11) NOT NULL AUTO_INCREMENT PRIMARY KEY'
+
+      def limited_update_conditions(where_sql, _quoted_table_name, _quoted_primary_key)
+        where_sql
+      end
+
+      # Taken from ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter
+      def join_to_update(update, select) #:nodoc:
+        if select.limit || select.offset || select.orders.any?
+          subsubselect = select.clone
+          subsubselect.projections = [update.key]
+
+          subselect = Arel::SelectManager.new(select.engine)
+          subselect.project Arel.sql(update.key.name)
+          subselect.from subsubselect.as('__active_record_temp')
+
+          update.where update.key.in(subselect)
+        else
+          update.table select.source
+          update.wheres = select.constraints
+        end
+      end
+
+      # Quotes a string, escaping any ' (single quote) and \ (backslash)
+      # characters.
+      def quote_string(string)
+        string.gsub(/\\/, '\&\&').gsub(/'/, "''")
+      end
+
+      def disable_referential_integrity(&block) #:nodoc:
+        old = select_value("SELECT @@FOREIGN_KEY_CHECKS")
+
+        begin
+          update("SET FOREIGN_KEY_CHECKS = 0")
+          yield
+        ensure
+          update("SET FOREIGN_KEY_CHECKS = #{old}")
+        end
+      end
+
+      # Create a new MySQL database with optional <tt>:charset</tt> and <tt>:collation</tt>.
+      # Charset defaults to utf8.
+      #
+      # Example:
+      #   create_database 'charset_test', :charset => 'latin1', :collation => 'latin1_bin'
+      #   create_database 'matt_development'
+      #   create_database 'matt_development', :charset => :big5
+      def create_database(name, options = {})
+        if options[:collation]
+          execute("CREATE DATABASE `#{name}` DEFAULT CHARACTER SET `#{options[:charset] || 'utf8'}` COLLATE `#{options[:collation]}`")
+        else
+          execute("CREATE DATABASE `#{name}` DEFAULT CHARACTER SET `#{options[:charset] || 'utf8'}`")
+        end
+      end
+
+      # Drops a MySQL database.
+      #
+      # Example:
+      #   drop_database('sebastian_development')
+      def drop_database(name) #:nodoc:
+        execute("DROP DATABASE IF EXISTS `#{name}`")
+      end
+
+      def create_table(name, options = {})
+        super(name, { options: 'ENGINE=InnoDB' }.merge(options))
+      end
+
+      # Renames a table.
+      def rename_table(name, new_name)
+        execute("RENAME TABLE #{quote_table_name(name)} TO #{quote_table_name(new_name)}")
+      end
+
+      def change_column(table_name, column_name, type, options = {})
+        # column_name.to_s used in case column_name is a symbol
+        unless options_include_default?(options)
+          options[:default] = columns(table_name).find { |c| c.name == column_name.to_s }.default
+        end
+
+        change_column_sql = "ALTER TABLE #{table_name} CHANGE #{column_name} #{column_name} #{type_to_sql(type, options[:limit], options[:precision], options[:scale])}"
+        add_column_options!(change_column_sql, options)
+        execute(change_column_sql)
+      end
+
+      def change_column_default(table_name, column_name, default)
+        col = columns(table_name).detect { |c| c.name == column_name.to_s }
+        change_column(table_name, column_name, col.type,
+          default: default, limit: col.limit, precision: col.precision, scale: col.scale)
+      end
+
+      def rename_column(table_name, column_name, new_column_name)
+        col = columns(table_name).detect { |c| c.name == column_name.to_s }
+        current_type = col.sql_type
+        current_type << "(#{col.limit})" if col.limit
+        execute("ALTER TABLE #{table_name} CHANGE #{column_name} #{new_column_name} #{current_type}")
+      end
+
+      def indexes(table_name, name = nil)
+        # Skip primary key indexes
+        super(table_name, name).delete_if { |i| i.unique && i.name =~ /^PRIMARY$/ }
+      end
+
+      def options_include_default?(options)
+        # MySQL 5.x doesn't allow DEFAULT NULL for first timestamp column in a table
+        if options.include?(:default) && options[:default].nil?
+          if options.include?(:column) && options[:column].sql_type =~ /timestamp/i
+            options.delete(:default)
+          end
+        end
+        super(options)
+      end
+
+      def structure_dump
+        select_all("SHOW FULL TABLES WHERE Table_type = 'BASE TABLE'").map do |table|
+          table.delete('Table_type')
+          sql = "SHOW CREATE TABLE #{quote_table_name(table.to_a.first.last)}"
+          exec_query(sql).first['Create Table'] + ";\n\n"
+        end.join
+      end
+
+      protected
+
+      def insert_sql(sql, name = nil, pk = nil, id_value = nil, sequence_name = nil)
+        super
+        id_value || last_inserted_id(nil)
+      end
+
+      def last_inserted_id(_result)
+        @connection.last_id
+      end
+    end
+  end
+end