arel-extensions 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52a47012efafaa4b4d73f2b13b017a3e35c75587525de84c16dd4a585a29909e
-  data.tar.gz: 2a8a38a06be27912f2877bebd701a4f1f1dcce1e0d69211611f660de612f902c
+  metadata.gz: 7760e9c8da3eca620a0c390b8767b4e1dd37be5e7612debf58f0bb284e8809ca
+  data.tar.gz: ba383da2aecf077b8b91c8e3ed29f3724093fc0c8e15329b96b9b6b077c67ca6
 SHA512:
-  metadata.gz: 1b533cb96f4274645663d55e5b2ff5784784490f72baa34925791914c95b76724b06a9f7b64873e8c5f5f85f64622b26256bff7f5cd7caa1f29c3f9906dc4d88
-  data.tar.gz: e9ce3d9dbb5d1efbc757e032df5809cc5aad64bdd4ee5eaaf7097ff4f437b0a16536367867e72475a4e019bf759ac81dcc7aaeedbe1e313b5d1760debc3e4856
+  metadata.gz: b6a5d3844c8d1f2d24b6f6c7306f8f2338ebfba347df06108539e09771ea10d3fc453f47b976cd05ffda0addda6ce57fbaeebdb96b0671efa10a6518fbc14627
+  data.tar.gz: ff44a1804d9691fa8ffd445b5115d00c6e0b42adf403681aeb741bb71bae9651dbf1b2b97c70035388afb1ae56771c963d9fb8bc11a718d0289869d29d6627f2

data/.gitignore

@@ -0,0 +1 @@
+.DS_Store

data/.travis.yml

@@ -5,17 +5,17 @@ cache:
   bundler: true
 
 rvm:
-  - 2.3.4
   - 2.4.1
+  - 2.5.1
 
 env:
   matrix:
-    - RAILS_VERSION=v5.1.0 GEM=ar:mysql2
-    - RAILS_VERSION=v5.1.0 GEM=ar:sqlite3
-    - RAILS_VERSION=v5.1.0 GEM=ar:postgresql
-    - RAILS_VERSION=v5.1.1 GEM=ar:mysql2
-    - RAILS_VERSION=v5.1.1 GEM=ar:sqlite3
-    - RAILS_VERSION=v5.1.1 GEM=ar:postgresql
+    - RAILS_VERSION=v5.2.0 GEM=ar:mysql2
+    - RAILS_VERSION=v5.2.0 GEM=ar:sqlite3
+    - RAILS_VERSION=v5.2.0 GEM=ar:postgresql
+    - RAILS_VERSION=v5.2.1 GEM=ar:mysql2
+    - RAILS_VERSION=v5.2.1 GEM=ar:sqlite3
+    - RAILS_VERSION=v5.2.1 GEM=ar:postgresql
 
 addons:
   postgresql: "9.4"

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sunstone.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    arel-extensions (1.6.0)
+      arel (>= 9.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.1)
+      activesupport (= 5.2.1)
+    activerecord (5.2.1)
+      activemodel (= 5.2.1)
+      activesupport (= 5.2.1)
+      arel (>= 9.0)
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ansi (1.5.0)
+    arel (9.0.0)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    i18n (1.1.1)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    minitest-reporters (1.3.5)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    pg (1.1.3)
+    rake (12.3.1)
+    rgeo (1.0.0)
+    ruby-progressbar (1.10.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  arel-extensions!
+  bundler
+  minitest
+  minitest-reporters
+  pg
+  rake
+  rgeo
+
+BUNDLED WITH
+   1.16.0

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/setup'
+require "bundler/gem_tasks"
+Bundler.require(:development)
+
+require 'fileutils'
+require "rake/testtask"
+
+# Test Task
+Rake::TestTask.new do |t|
+    t.libs << 'lib' << 'test'
+    t.test_files = FileList['test/**/*_test.rb']
+    # t.warning = true
+    # t.verbose = true
+end

data/arel-extensions.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name = 'arel-extensions'
-  gem.version = '1.6.0'
+  gem.version = '1.7.0'
   
   gem.authors       = ["Jon Bracy"]
   gem.email         = ["jonbracy@gmail.com"]
@@ -14,6 +14,12 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency 'arel', '>= 9.0.0'
 
-  gem.add_development_dependency 'rake'
+  gem.add_development_dependency "bundler"
+  gem.add_development_dependency "rake"
   gem.add_development_dependency 'minitest'
+  gem.add_development_dependency 'minitest-reporters'
+  gem.add_development_dependency 'pg'
+  gem.add_development_dependency 'rgeo'
+  gem.add_development_dependency 'activerecord'
+  
 end

data/lib/arel/extensions.rb

@@ -20,6 +20,8 @@ Arel::Attributes::Attribute.include(Arel::JSONPredications)
 require File.expand_path('../nodes/ts_vector', __FILE__)
 require File.expand_path('../nodes/ts_query', __FILE__)
 require File.expand_path('../nodes/ts_match', __FILE__)
+require File.expand_path('../nodes/ts_rank', __FILE__)
+require File.expand_path('../nodes/ts_rank_cd', __FILE__)
 require File.expand_path('../ts_predications', __FILE__)
 Arel::Attributes::Attribute.include(Arel::TSPredications)
 

data/lib/arel/nodes/ts_query.rb

@@ -4,7 +4,7 @@ module Arel
       
       attr_reader :expression, :language
       
-      def initialize(expression, language)
+      def initialize(expression, language: nil)
         @expression = Arel::Nodes.build_quoted(expression)
         @language = Arel::Nodes.build_quoted(language) if language
       end

data/lib/arel/nodes/ts_rank.rb

@@ -0,0 +1,14 @@
+module Arel
+  module Nodes
+    class TSRank < Arel::Nodes::Node
+      
+      attr_reader :tsvector, :tsquery
+      
+      def initialize(tsvector, tsquery)
+        @tsvector = tsvector
+        @tsquery = tsquery
+      end
+
+    end
+  end
+end

data/lib/arel/nodes/ts_rank_cd.rb

@@ -0,0 +1,14 @@
+module Arel
+  module Nodes
+    class TSRankCD < Arel::Nodes::Node
+      
+      attr_reader :tsvector, :tsquery
+      
+      def initialize(tsvector, tsquery)
+        @tsvector = tsvector
+        @tsquery = tsquery
+      end
+
+    end
+  end
+end

data/lib/arel/nodes/ts_vector.rb

@@ -4,7 +4,7 @@ module Arel
       
       attr_reader :attribute, :language
       
-      def initialize(attribute, language)
+      def initialize(attribute, language: nil)
         @attribute = attribute
         @language = Arel::Nodes.build_quoted(language) if language
       end

data/lib/arel/visitors/postgresql_extensions.rb

@@ -119,6 +119,24 @@ module Arel
         collector
       end
       
+      def visit_Arel_Nodes_TSRank(o, collector)
+        collector << 'ts_rank('
+        visit(o.tsvector, collector) 
+        collector << ', '
+        visit(o.tsquery, collector)
+        collector << ')'
+        collector
+      end
+      
+      def visit_Arel_Nodes_TSRankCD(o, collector)
+        collector << 'ts_rank_cd('
+        visit(o.tsvector, collector) 
+        collector << ', '
+        visit(o.tsquery, collector)
+        collector << ')'
+        collector
+      end
+      
       def visit_Arel_Nodes_HexEncodedBinary(o, collector)
         collector << "E'\\\\x"
         collector << o.expr

data/test/database.rb

@@ -0,0 +1,40 @@
+task = ActiveRecord::Tasks::PostgreSQLDatabaseTasks.new({
+  'adapter' => 'postgresql',
+  'database' => "arel-extensions-test"
+})
+task.drop
+task.create
+
+ActiveRecord::Base.establish_connection({
+  adapter:  "postgresql",
+  database: "arel-extensions-test",
+  encoding: "utf8"
+})
+
+ActiveRecord::Migration.suppress_messages do
+  ActiveRecord::Schema.define do
+
+    create_table "addresses", force: :cascade do |t|
+      t.integer  "name"
+      t.integer  "property_id"
+    end
+    
+    create_table "properties", force: :cascade do |t|
+      t.string   "name",                 limit: 255
+      t.tsvector 'vector_col'
+    end
+
+  end
+end
+
+class Address < ActiveRecord::Base
+  
+  belongs_to :property
+
+end
+
+class Property < ActiveRecord::Base
+  
+  has_many :addresses
+
+end

data/test/test_helper.rb

@@ -0,0 +1,131 @@
+# To make testing/debugging easier, test within this source tree versus an
+# installed gem
+$LOAD_PATH << File.expand_path('../lib', __FILE__)
+
+# require 'simplecov'
+# SimpleCov.start do
+#   add_group 'lib', 'sunstone/lib'
+#   add_group 'ext', 'sunstone/ext'
+# end
+
+require 'rgeo'
+require "minitest/autorun"
+require 'minitest/unit'
+require 'minitest/reporters'
+# require 'webmock/minitest'
+# require 'mocha/minitest'
+require 'active_record'
+require 'arel/extensions'
+
+# Setup the test db
+ActiveSupport.test_order = :random
+require File.expand_path('../database', __FILE__)
+
+Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new
+
+$debugging = false
+
+# File 'lib/active_support/testing/declarative.rb', somewhere in rails....
+class ActiveSupport::TestCase
+  # include WebMock::API
+  
+  # File 'lib/active_support/testing/declarative.rb'
+  def self.test(name, &block)
+    test_name = "test_#{name.gsub(/\s+/, '_')}".to_sym
+    defined = method_defined? test_name
+    raise "#{test_name} is already defined in #{self}" if defined
+    if block_given?
+      define_method(test_name, &block)
+    else
+      define_method(test_name) do
+        skip "No implementation provided for #{name}"
+      end
+    end
+  end
+  
+  def webmock(method, path, query=nil)
+    query = deep_transform_query(query) if query
+
+    stub_request(method, /^#{ActiveRecord::Base.connection.instance_variable_get(:@connection).url}/).with do |req|
+      if query
+        req&.uri&.path == path && req.uri.query && unpack(req.uri.query.sub(/=true$/, '')) == query
+      else
+        req&.uri&.path == path && req.uri.query.nil?
+      end
+    end
+  end
+
+  def debug
+    ActiveRecord::Base.logger = Logger.new(STDOUT)
+    $debugging = true
+    yield
+  ensure
+    ActiveRecord::Base.logger = nil
+    $debugging = false
+  end
+
+
+  class SQLLogger
+    class << self
+      attr_accessor :ignored_sql, :log, :log_all
+      def clear_log; self.log = []; self.log_all = []; end
+    end
+
+    self.clear_log
+
+    self.ignored_sql = [/^PRAGMA/i, /^SELECT currval/i, /^SELECT CAST/i, /^SELECT @@IDENTITY/i, /^SELECT @@ROWCOUNT/i, /^SAVEPOINT/i, /^ROLLBACK TO SAVEPOINT/i, /^RELEASE SAVEPOINT/i, /^SHOW max_identifier_length/i, /^BEGIN/i, /^COMMIT/i]
+
+    # FIXME: this needs to be refactored so specific database can add their own
+    # ignored SQL, or better yet, use a different notification for the queries
+    # instead examining the SQL content.
+    oracle_ignored     = [/^select .*nextval/i, /^SAVEPOINT/, /^ROLLBACK TO/, /^\s*select .* from all_triggers/im, /^\s*select .* from all_constraints/im, /^\s*select .* from all_tab_cols/im]
+    mysql_ignored      = [/^SHOW FULL TABLES/i, /^SHOW FULL FIELDS/, /^SHOW CREATE TABLE /i, /^SHOW VARIABLES /, /^\s*SELECT (?:column_name|table_name)\b.*\bFROM information_schema\.(?:key_column_usage|tables)\b/im]
+    postgresql_ignored = [/^\s*select\b.*\bfrom\b.*pg_namespace\b/im, /^\s*select tablename\b.*from pg_tables\b/im, /^\s*select\b.*\battname\b.*\bfrom\b.*\bpg_attribute\b/im, /^SHOW search_path/i]
+    sqlite3_ignored =    [/^\s*SELECT name\b.*\bFROM sqlite_master/im, /^\s*SELECT sql\b.*\bFROM sqlite_master/im]
+
+    [oracle_ignored, mysql_ignored, postgresql_ignored, sqlite3_ignored].each do |db_ignored_sql|
+      ignored_sql.concat db_ignored_sql
+    end
+
+    attr_reader :ignore
+
+    def initialize(ignore = Regexp.union(self.class.ignored_sql))
+      @ignore = ignore
+    end
+
+    def call(name, start, finish, message_id, values)
+      sql = values[:sql]
+
+      # FIXME: this seems bad. we should probably have a better way to indicate
+      # the query was cached
+      return if 'CACHE' == values[:name]
+
+      self.class.log_all << sql
+      unless ignore =~ sql
+        if $debugging
+        puts caller.select { |l| l.starts_with?(File.expand_path('../../lib', __FILE__)) }
+        puts "\n\n" 
+        end
+      end
+      self.class.log << sql unless ignore =~ sql
+    end
+  end
+  ActiveSupport::Notifications.subscribe('sql.active_record', SQLLogger.new)
+
+  # test/unit backwards compatibility methods
+  alias :assert_raise :assert_raises
+  alias :assert_not_empty :refute_empty
+  alias :assert_not_equal :refute_equal
+  alias :assert_not_in_delta :refute_in_delta
+  alias :assert_not_in_epsilon :refute_in_epsilon
+  alias :assert_not_includes :refute_includes
+  alias :assert_not_instance_of :refute_instance_of
+  alias :assert_not_kind_of :refute_kind_of
+  alias :assert_no_match :refute_match
+  alias :assert_not_nil :refute_nil
+  alias :assert_not_operator :refute_operator
+  alias :assert_not_predicate :refute_predicate
+  alias :assert_not_respond_to :refute_respond_to
+  alias :assert_not_same :refute_same
+  
+end

data/test/ts_test.rb

@@ -0,0 +1,136 @@
+require 'test_helper'
+
+class TSTest < ActiveSupport::TestCase
+
+  test 'tsquery(query)' do
+    query = Property.where( Arel::Nodes::TSQuery.new('query') )
+
+    assert_equal(<<~SQL.gsub(/( +|\n)/, ' ').strip, query.to_sql)
+      SELECT "properties".* FROM "properties"
+      WHERE to_tsquery('query')
+    SQL
+  end
+  
+  test 'tsquery(query, language: lang)' do
+    query = Property.where( Arel::Nodes::TSQuery.new('query', language: 'lang') )
+
+    assert_equal(<<~SQL.gsub(/( +|\n)/, ' ').strip, query.to_sql)
+      SELECT "properties".* FROM "properties"
+      WHERE to_tsquery('lang', 'query')
+    SQL
+  end
+  
+  test 'tsvector(attribute)' do
+    query = Property.where( Arel::Nodes::TSVector.new(Property.arel_table[:name]) )
+
+    assert_equal(<<~SQL.gsub(/( +|\n)/, ' ').strip, query.to_sql)
+      SELECT "properties".* FROM "properties"
+      WHERE to_tsvector("properties"."name")
+    SQL
+  end
+  
+  test 'tsvector(text)' do
+    query = Property.where( Arel::Nodes::TSVector.new(
+      Arel::Nodes::Quoted.new("my data O'Malley")
+    ))
+
+    assert_equal(<<~SQL.gsub(/( +|\n)/, ' ').strip, query.to_sql)
+      SELECT "properties".* FROM "properties"
+      WHERE to_tsvector('my data O''Malley')
+    SQL
+  end
+
+  test 'tsvector(attribute, language: lang)' do
+    query = Property.where( Arel::Nodes::TSVector.new(Property.arel_table[:name], language: 'lang') )
+
+    assert_equal(<<~SQL.gsub(/( +|\n)/, ' ').strip, query.to_sql)
+      SELECT "properties".* FROM "properties"
+      WHERE to_tsvector('lang', "properties"."name")
+    SQL
+  end
+
+  test 'ts_match(attrbute, tsquery)' do
+    query = Property.where(
+      Arel::Nodes::TSMatch.new(
+        Property.arel_table[:name],
+        Arel::Nodes::TSQuery.new('query')
+      )
+    )
+
+    assert_equal(<<~SQL.gsub(/( +|\n)/, ' ').strip, query.to_sql)
+      SELECT "properties".* FROM "properties"
+      WHERE "properties"."name" @@ to_tsquery('query')
+    SQL
+  end
+
+  test 'ts_match(tsvector, tsquery)' do
+    query = Property.where(
+      Arel::Nodes::TSMatch.new(
+        Arel::Nodes::TSVector.new(Property.arel_table[:name]),
+        Arel::Nodes::TSQuery.new('query')
+      )
+    )
+
+    assert_equal(<<~SQL.gsub(/( +|\n)/, ' ').strip, query.to_sql)
+      SELECT "properties".* FROM "properties"
+      WHERE to_tsvector("properties"."name") @@ to_tsquery('query')
+    SQL
+  end
+
+  test 'ts_rank(attribute, tsquery)' do
+    query = Property.where(
+      Arel::Nodes::TSRank.new(
+        Property.arel_table[:name],
+        Arel::Nodes::TSQuery.new('query')
+      )
+    )
+    
+    assert_equal(<<~SQL.gsub(/( +|\n)/, ' ').strip, query.to_sql)
+      SELECT "properties".* FROM "properties"
+      WHERE ts_rank("properties"."name", to_tsquery('query'))
+    SQL
+  end
+    
+  test 'ts_rank(tsvector, tsquery)' do
+    query = Property.where(
+      Arel::Nodes::TSRank.new(
+        Arel::Nodes::TSVector.new(Property.arel_table[:name]),
+        Arel::Nodes::TSQuery.new('query')
+      )
+    )
+    
+    assert_equal(<<~SQL.gsub(/( +|\n)/, ' ').strip, query.to_sql)
+      SELECT "properties".* FROM "properties"
+      WHERE ts_rank(to_tsvector("properties"."name"), to_tsquery('query'))
+    SQL
+  end
+
+  test 'ts_rank_cd(attribute, tsquery)' do
+    query = Property.where(
+      Arel::Nodes::TSRankCD.new(
+        Property.arel_table[:name],
+        Arel::Nodes::TSQuery.new('query')
+      )
+    )
+    
+    assert_equal(<<~SQL.gsub(/( +|\n)/, ' ').strip, query.to_sql)
+      SELECT "properties".* FROM "properties"
+      WHERE ts_rank_cd("properties"."name", to_tsquery('query'))
+    SQL
+  end
+    
+  test 'ts_rank_cd(tsvector, tsquery)' do
+    query = Property.where(
+      Arel::Nodes::TSRankCD.new(
+        Arel::Nodes::TSVector.new(Property.arel_table[:name]),
+        Arel::Nodes::TSQuery.new('query')
+      )
+    )
+    
+    assert_equal(<<~SQL.gsub(/( +|\n)/, ' ').strip, query.to_sql)
+      SELECT "properties".* FROM "properties"
+      WHERE ts_rank_cd(to_tsvector("properties"."name"), to_tsquery('query'))
+    SQL
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arel-extensions
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Jon Bracy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-06 00:00:00.000000000 Z
+date: 2018-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: arel
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 9.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rgeo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - jonbracy@gmail.com
@@ -59,9 +129,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - ".travis.yml"
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
+- Rakefile
 - arel-extensions.gemspec
 - lib/active_record/query_methods.rb
 - lib/arel/array_predications.rb
@@ -80,11 +154,16 @@ files:
 - lib/arel/nodes/overlaps.rb
 - lib/arel/nodes/ts_match.rb
 - lib/arel/nodes/ts_query.rb
+- lib/arel/nodes/ts_rank.rb
+- lib/arel/nodes/ts_rank_cd.rb
 - lib/arel/nodes/ts_vector.rb
 - lib/arel/nodes/within.rb
 - lib/arel/ts_predications.rb
 - lib/arel/visitors/postgresql_extensions.rb
 - lib/arel/visitors/sunstone_extensions.rb
+- test/database.rb
+- test/test_helper.rb
+- test/ts_test.rb
 homepage: https://github.com/malomalo/arel-extensions
 licenses:
 - MIT
@@ -109,4 +188,7 @@ rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: Adds support for missing SQL operators and functions to Arel
-test_files: []
+test_files:
+- test/database.rb
+- test/test_helper.rb
+- test/ts_test.rb