ar-sybase-jdbc-adapter 0.0.1

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 arkadiy kraportov
+
+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,92 @@
+= ar-sybase-jdbc-adapter
+
+ar-sybase-jdbc-adapter enhances the Arel 2 activerecord-jdbc-adapter to support "limit" and "offset" for Sybase ASE DB.
+
+To use this gem, set the "dialect" configuration parameter to "sybase_jtds".
+
+e.g.
+    development:
+      adapter: jdbc
+      username: user_name
+      password: password
+      database: your_database
+      dialect: sybase_jtds
+      driver: net.sourceforge.jtds.jdbc.Driver
+      url: jdbc:jtds:sybase://host:port/db_name
+
+== Offset in Sybase ASE
+
+Sybase is an awful DB in term of support for "offset". I found 2 ways to do it for generic queries:
+
+=== 1. Use TempTables:
+
+    select top <limit + offset> * into #tt from (<original query with NO order by>) t ORDER BY <original order> ASC
+    select top <limit> * from #tt into #tt_sorted ORDER BY <original order> DESC
+    select * from #tt_sorted ORDER BY <original order>
+
+There are 2 major drawbacks here. 
+1. If the offset is a large number, the space taken by the temptable can fill up the tempdb. 
+2. The original query should be parsed to strip out "ORDER BY"
+
+=== 2. Use a scrollable cursor:
+
+    declare crsr  insensitive scroll cursor for
+        select * from <original query>
+    go
+
+    declare @counter int
+    set @counter = 1
+    open crsr
+    fetch absolute <offset> from crsr
+
+    while @counter < <limit>
+    begin
+        set @counter = @counter + 1
+        fetch next from crsr
+    end
+
+    close crsr
+    deallocate crsr
+
+The problems here are: 
+1. Scrollable cursor works for Sybase ASE starting from version 15. 
+2. Cursors are not very efficient in Sybase ASE, and very inefficient in Sybase IQ.
+
+I am not a Sybase expert, so *Please let me know if you are aware of more efficient ways to do limit and offset.*
+
+== Known issues
+
+I am aware of a very strange issue where the driver does not work when the very first query uses "limit()".
+
+e.g.
+    $ rails c
+    Loading development environment (Rails 3.0.3)
+    irb(main):001:0> Client.limit(10).to_sql
+    => "SELECT clients.* FROM clients LIMIT 10"
+
+Otherwise, the driver works fine by adding the "TOP" keyword to your SQL query:
+
+e.g.
+    $ rails c
+    Loading development environment (Rails 3.0.3)
+    irb(main):001:0> Client.scoped.to_sql
+    => "SELECT clients.* FROM clients"
+    irb(main):002:0> Client.limit(10).to_sql
+    => "SELECT TOP 10 clients.* FROM clients"
+
+
+== Contributing to ar-sybase-jdbc-adapter
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2010 arkadiy kraportov. See LICENSE.txt for
+further details.
+

data/lib/ar-sybase-jdbc-adapter.rb

@@ -0,0 +1,2 @@
+require 'arjdbc'
+

data/lib/arel/visitors/sybase_jtds.rb

@@ -0,0 +1,26 @@
+module Arel
+  module Visitors
+    class SybaseJtds < Arel::Visitors::ToSql
+      def visit_Arel_Nodes_SelectStatement o
+        limit  = o.limit
+        offset = o.offset
+        o.limit = o.offset = nil
+        sql = super
+
+        if limit && !offset
+          limit_and_no_offset sql, limit
+        end
+
+        sql
+      end
+
+      def limit_and_no_offset sql, limit
+        if sql =~ /DISTINCT /
+          sql.gsub!(/DISTINCT /, "DISTINCT TOP #{limit} ")
+        else
+          sql.gsub!(/SELECT /, "SELECT TOP #{limit} ")
+        end
+      end
+    end
+  end
+end

data/lib/arjdbc/discover.rb

@@ -0,0 +1,8 @@
+module ::ArJdbc
+  extension :SybaseJtds do |name|
+    if name =~ /sybase_jtds/i
+      require 'arjdbc/sybase_jtds'
+      true
+    end
+  end
+end

data/lib/arjdbc/sybase_jtds.rb

@@ -0,0 +1,7 @@
+module ::ArJdbc
+  module SybaseJtds
+    def arel2_visitors
+      {'sybase_jtds' => ::Arel::Visitors::SybaseJtds}
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+
+require 'minitest/autorun'
+require 'fileutils'
+require 'arel'
+
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'ar-sybase-jdbc-adapter'
+require 'support/fake_record'
+
+
+Arel::Table.engine = Arel::Sql::Engine.new(FakeRecord::Base.new)
+
+class Object
+  def must_be_like other
+    gsub(/\s+/, ' ').strip.must_equal other.gsub(/\s+/, ' ').strip
+  end
+end

data/test/support/fake_record.rb

@@ -0,0 +1,91 @@
+module FakeRecord
+  class Column < Struct.new(:name, :type)
+  end
+
+  class Connection
+    attr_reader :tables
+
+    def initialize
+      @tables = %w{ users photos developers }
+      @columns = {
+        'users' => [
+          Column.new('id', :integer),
+          Column.new('name', :string),
+          Column.new('bool', :boolean),
+          Column.new('created_at', :date),
+        ]
+      }
+      @primary_keys = {
+        'users' => 'id'
+      }
+    end
+
+    def primary_key name
+      @primary_keys[name.to_s]
+    end
+
+    def table_exists? name
+      @tables.include? name.to_s
+    end
+
+    def columns name, message = nil
+      @columns[name.to_s]
+    end
+
+    def quote_table_name name
+      "\"#{name.to_s}\""
+    end
+
+    def quote_column_name name
+      "\"#{name.to_s}\""
+    end
+
+    def quote thing, column = nil
+      if column && column.type == :integer
+        return 'NULL' if thing.nil?
+        return thing.to_i
+      end
+
+      case thing
+      when true
+        "'t'"
+      when false
+        "'f'"
+      when nil
+        'NULL'
+      when Numeric
+        thing
+      else
+        "'#{thing}'"
+      end
+    end
+  end
+
+  class ConnectionPool
+    class Spec < Struct.new(:config)
+    end
+
+    attr_reader :spec, :connection
+
+    def initialize
+      @spec = Spec.new(:adapter => 'america')
+      @connection = Connection.new
+    end
+
+    def with_connection
+      yield connection
+    end
+  end
+
+  class Base
+    attr_accessor :connection_pool
+
+    def initialize
+      @connection_pool = ConnectionPool.new
+    end
+
+    def connection
+      connection_pool.connection
+    end
+  end
+end

data/test/test_connection.rb

@@ -0,0 +1,42 @@
+require 'arjdbc'
+require 'helper'
+
+#module ActiveRecord
+#  module ConnectionAdapters
+#    class JdbcAdapter < AbstractAdapter
+#      def initialize
+#      end
+#    end
+#  end
+#end
+
+module ConnectionTests
+  class MockConnection
+    def adapter=(adapt)
+    end
+    def jndi_connection?
+      false
+    end
+  end
+
+  describe 'the sybase jtds connection' do
+    before do
+      @config = {
+        :driver =>  'net.sourceforge.jtds.Driver',
+        :url => "jdbc:jtds:sybase://test:1234/database",
+        :dialect => 'sybase_jtds'
+      }
+      @adapter = ActiveRecord::ConnectionAdapters::JdbcAdapter.new MockConnection.new, nil, @config
+    end
+
+    it "instantiate correct adapter when using 'sybase_jtds' dialect" do
+      @adapter.must_be_kind_of(::ArJdbc::SybaseJtds)
+    end
+
+    it "should configure arel2 visitors for SybaseJtds" do
+      ::Arel::Visitors::VISITORS.must_include('sybase_jtds')
+      visitor = ::Arel::Visitors::VISITORS['sybase_jtds']
+      visitor.must_equal(::Arel::Visitors::SybaseJtds)
+    end
+  end
+end

data/test/test_visitor.rb

@@ -0,0 +1,60 @@
+require 'helper'
+require 'arel/visitors/sybase_jtds'
+
+module Arel
+  module Visitors
+    describe 'the sybase jtds visitor' do
+      before do
+        @visitor = SybaseJtds.new Table.engine
+      end
+
+
+      describe Nodes::SelectStatement do
+        it "should not have 'LIMIT' keyword" do
+          stmt = Nodes::SelectStatement.new
+          stmt.cores.first.projections << 'first_field'
+          stmt.limit = 10
+          sql = @visitor.accept stmt
+          sql.wont_match /LIMIT 10/
+        end
+
+        describe 'limit with no offset and no "DISTINCT"' do
+          it 'adds a TOP keyword after "SELECT"' do
+            stmt = Nodes::SelectStatement.new
+            stmt.cores.first.projections << 'first_field'
+            stmt.limit = 10
+            sql = @visitor.accept stmt
+            sql.must_be_like %{ SELECT TOP 10 'first_field' }
+          end
+        end
+
+        describe 'limit with no offset and "DISTINCT"' do
+          it 'adds a TOP keyword after "DISTINCT"' do
+            stmt = Nodes::SelectStatement.new
+            stmt.cores.first.projections << Nodes::SqlLiteral.new('DISTINCT id')
+            stmt.limit = 10
+            sql = @visitor.accept stmt
+            sql.must_be_like %{ SELECT DISTINCT TOP 10 id }
+          end
+        end
+
+#
+#        describe 'only offset' do
+#          it 'creates a select from subquery with rownum condition' do
+#            stmt = Nodes::SelectStatement.new
+#            stmt.offset = Nodes::Offset.new(10)
+#            sql = @visitor.accept stmt
+#            sql.must_be_like %{
+#              SELECT * FROM (
+#                SELECT raw_sql_.*, rownum raw_rnum_
+#                FROM (SELECT ) raw_sql_
+#              )
+#              WHERE raw_rnum_ > 10
+#            }
+#          end
+#        end
+
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,218 @@
+--- !ruby/object:Gem::Specification 
+name: ar-sybase-jdbc-adapter
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+    - 0
+    - 0
+    - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+  - arkadiy kraportov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-27 00:00:00 +09:00
+default_executable: 
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: bundler
+    version_requirements: &id001 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 1
+              - 0
+              - 0
+            version: 1.0.0
+    requirement: *id001
+    prerelease: false
+    type: :development
+  - !ruby/object:Gem::Dependency 
+    name: jeweler
+    version_requirements: &id002 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 1
+              - 5
+              - 1
+            version: 1.5.1
+    requirement: *id002
+    prerelease: false
+    type: :development
+  - !ruby/object:Gem::Dependency 
+    name: rcov
+    version_requirements: &id003 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 0
+            version: "0"
+    requirement: *id003
+    prerelease: false
+    type: :development
+  - !ruby/object:Gem::Dependency 
+    name: minitest
+    version_requirements: &id004 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 0
+            version: "0"
+    requirement: *id004
+    prerelease: false
+    type: :development
+  - !ruby/object:Gem::Dependency 
+    name: arel
+    version_requirements: &id005 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ">"
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 2
+              - 0
+              - 0
+            version: 2.0.0
+    requirement: *id005
+    prerelease: false
+    type: :development
+  - !ruby/object:Gem::Dependency 
+    name: activerecord-jdbc-adapter
+    version_requirements: &id006 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 1
+              - 1
+              - 0
+            version: 1.1.0
+    requirement: *id006
+    prerelease: false
+    type: :development
+  - !ruby/object:Gem::Dependency 
+    name: activerecord
+    version_requirements: &id007 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 3
+              - 0
+              - 3
+            version: 3.0.3
+    requirement: *id007
+    prerelease: false
+    type: :development
+  - !ruby/object:Gem::Dependency 
+    name: activerecord-jdbc-adapter
+    version_requirements: &id008 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 1
+              - 1
+              - 0
+            version: 1.1.0
+    requirement: *id008
+    prerelease: false
+    type: :runtime
+  - !ruby/object:Gem::Dependency 
+    name: arel
+    version_requirements: &id009 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 2
+              - 0
+              - 6
+            version: 2.0.6
+    requirement: *id009
+    prerelease: false
+    type: :runtime
+  - !ruby/object:Gem::Dependency 
+    name: jdbc-jtds
+    version_requirements: &id010 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 0
+            version: "0"
+    requirement: *id010
+    prerelease: false
+    type: :runtime
+  - !ruby/object:Gem::Dependency 
+    name: minitest
+    version_requirements: &id011 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 2
+              - 0
+              - 0
+            version: 2.0.0
+    requirement: *id011
+    prerelease: false
+    type: :development
+description: Adds support for limit and offset for Sybase ASE DB to activerecord-jdbc-adapter for Arel 2
+email: arkadiyk@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+  - LICENSE.txt
+  - README.rdoc
+files: 
+  - lib/ar-sybase-jdbc-adapter.rb
+  - lib/arel/visitors/sybase_jtds.rb
+  - lib/arjdbc/discover.rb
+  - lib/arjdbc/sybase_jtds.rb
+  - LICENSE.txt
+  - README.rdoc
+has_rdoc: true
+homepage: http://github.com/arkadiyk/ar-sybase-jdbc-adapter
+licenses: 
+  - MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+  - lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 0
+        version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 0
+        version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Adds support for limit and offset for Sybase JDBC driver
+test_files: 
+  - test/helper.rb
+  - test/support/fake_record.rb
+  - test/test_connection.rb
+  - test/test_visitor.rb