active_record_union 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3eba1bb2ac0137d8d84b62bb48f45e8c90f78efe
-  data.tar.gz: ef18422b1efeabda133e5e2d86985c918759f1b8
+  metadata.gz: de7279017756c9ab6fa65a13d457b671d4d3fc1f
+  data.tar.gz: a059566a08659d432635c1ad707431a3b8c163a1
 SHA512:
-  metadata.gz: e318f5d727ea3e1483c67638b824293840ba75f7d0191bf7490d62a32bc17c9dbd8fd7403f652f1fd51294f97b8bd8e33e4445cd83ac36e3956ded6b978efc12
-  data.tar.gz: 961b39db5ef83a66708c6424356189e60837d3eb2068a1c0464da7d7ddc2154cb116bf596f7f73b8b3c46bdffbafafa0774a20c4c0798b5774df71e12b246717
+  metadata.gz: bc0aae94fd243b66458b8ad719833bea64c69be694eaa5a73e370c3aea1dd918b74e15463b8c03b7d5c7d808db526bc0de3b06f27e8d27087e1678c0d0441b70
+  data.tar.gz: 0481dcf3092a0e166bcca93da7e9b1634d999cdecfd7ef14d108ab95ab2c291c9d8cf8e77f232b946da5beba0aec78ecb2036abaa5536668656655af6f908a0e

data/.travis.yml

@@ -1,4 +1,8 @@
 language: ruby
+addons:
+  postgresql: "9.3"
+before_script:
+  - psql -c 'create database travis;' -U postgres # "travis" is the UNIX username, and therefore the default database name on connection
 rvm:
   - 2.1.2
   - 2.0.0

data/README.md

@@ -100,6 +100,13 @@ SELECT "posts".* FROM (
 
 <a name="footnote-1"></a>[1] Note: the `?` in the SQL is bound to the correct value when ActiveRecord executes the query. Also, the SQL examples here were generated for a SQLite database. The syntax generated for other databases may vary slightly.
 
+## Caveats
+
+There's a couple things to be aware of when using ActiveRecordUnion:
+
+1. ActiveRecordUnion with raise an error if you try to UNION any relations that do any preloading/eager-loading. There's no sensible way to do the preloading in the subselects. If enough people complain maybe we can change ActiveRecordUnion to let the queries run anyway but without preloading any records.
+2. There's no easy way to get SQLite to allow ORDER BY in the UNION subselects. If you get a syntax error, you can either write `my_relation.reorder(nil).union(other.reorder(nil))` or switch to Postgres.
+
 ## Another nifty way to reduce extra queries
 
 ActiveRecord already supports turning scopes into nested queries in WHERE clauses. The nested relation defaults to selecting `id` by default.
@@ -152,6 +159,12 @@ https://github.com/yakaz/rails/commit/29b8ebd187e0888d5e71b2e1e4a12334860bc76c
 
 This is a gem not a Rails pull request because the standard of code quality for a PR is a bit higher, and we'd have to wait for the PR to be merged and relased to use UNIONs. That said, the code here is fairly clean and it may end up in a PR sometime.
 
+## Changelog
+
+**1.0.1** - Sept 2, 2014 - Allow ORDER BY in UNION subselects for databases that support it (not SQLite).
+
+**1.0.0** - July 24, 2014 - Initial release.
+
 ## License
 
 ActiveRecordUnion is dedicated to the public domain by its author, Brian Hempel. No rights are reserved. No restrictions are placed on the use of ActiveRecordUnion. That freedom also means, of course, that no warrenty of fitness is claimed; use ActiveRecordUnion at your own risk.

data/active_record_union.gemspec

@@ -25,4 +25,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec",   "~> 3.0"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "pg"
+  spec.add_development_dependency "mysql2"
 end

data/lib/active_record_union/active_record/relation/union.rb

@@ -7,19 +7,27 @@ module ActiveRecord
 
         verify_union_relations!(self, other)
 
-        union = self.arel.union(other)
+        # Postgres allows ORDER BY in the UNION subqueries if each subquery is surrounded by parenthesis
+        # but SQLite does not allow parens around the subqueries; you will have to explicitly do `relation.reorder(nil)` in SQLite
+        if Arel::Visitors::SQLite === self.visitor
+          left, right = self.ast, other.ast
+        else
+          left, right = Arel::Nodes::Grouping.new(self.ast), Arel::Nodes::Grouping.new(other.ast)
+        end
+
+        union = Arel::Nodes::Union.new(left, right)
         from = Arel::Nodes::TableAlias.new(
           union,
           Arel::Nodes::SqlLiteral.new(@klass.arel_table.name)
         )
 
         relation = @klass.unscoped.from(from)
-        relation.bind_values = self.bind_values + other.bind_values + relation.bind_values
+        relation.bind_values = self.bind_values + other.bind_values
         relation
       end
 
       private
-      
+
       def verify_union_relations!(*args)
         includes_relations = args.select { |r| r.includes_values.any? }
         if includes_relations.any?

data/lib/active_record_union/version.rb

@@ -1,3 +1,3 @@
 module ActiveRecordUnion
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/spec/spec_helper.rb

@@ -1,11 +1,11 @@
+require "bundler/setup"
+
+Bundler.require(:development)
 require "active_record_union"
 
-ActiveRecord::Base.establish_connection(
-  adapter:  "sqlite3",
-  database: ":memory:"
-)
+require "support/databases"
 
-require "support/models"
+Databases.connect_to_sqlite
 
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|

data/spec/support/databases.rb

@@ -0,0 +1,47 @@
+module Databases
+  extend self
+
+  def connect_to_sqlite
+    ActiveRecord::Base.establish_connection(
+      adapter:  "sqlite3",
+      database: ":memory:"
+    )
+    load("support/models.rb")
+  end
+
+  def connect_to_postgres
+    ActiveRecord::Base.establish_connection(
+      adapter:  "postgresql"
+    )
+    ActiveRecord::Base.connection.recreate_database("test_active_record_union")
+    ActiveRecord::Base.establish_connection(
+      adapter:  "postgresql",
+      database: "test_active_record_union"
+    )
+    load("support/models.rb")
+  end
+
+  def connect_to_mysql
+    ActiveRecord::Base.establish_connection(
+      adapter:  "mysql2"
+    )
+    ActiveRecord::Base.connection.recreate_database("test_active_record_union")
+    ActiveRecord::Base.establish_connection(
+      adapter:  "mysql2",
+      database: "test_active_record_union"
+    )
+    load("support/models.rb")
+  end
+
+  def with_postgres(&block)
+    connect_to_postgres
+  ensure
+    connect_to_sqlite
+  end
+
+  def with_mysql(&block)
+    connect_to_mysql
+  ensure
+    connect_to_sqlite
+  end
+end

data/spec/support/models.rb

@@ -1,15 +1,16 @@
-class User < ActiveRecord::Base
-  connection.create_table :users, force: true do |t|
-  end
+ActiveRecord::Base.connection.create_table :users, force: true do |t|
+end
 
+class User < ActiveRecord::Base
   has_many :posts
+end unless defined?(User)
+
+ActiveRecord::Base.connection.create_table :posts, force: true do |t|
+  t.integer   :user_id
+  t.timestamp :published_at
+  t.timestamps
 end
 
 class Post < ActiveRecord::Base
-  connection.create_table :posts, force: true do |t|
-    t.integer :user_id
-    t.timestamps
-  end
-
   belongs_to :user
-end
+end unless defined?(Post)

data/spec/union_spec.rb

@@ -31,6 +31,7 @@ describe ActiveRecord::Relation do
       expect(union.to_sql).to eq(
         "SELECT \"posts\".* FROM ( SELECT \"posts\".* FROM \"posts\"  WHERE \"posts\".\"user_id\" = ? UNION SELECT \"posts\".* FROM \"posts\"  WHERE (created_at > '2014-07-19 00:00:00.000000') ) posts"
       )
+      expect{union.to_a}.to_not raise_error
     end
 
     it "binds values properly" do
@@ -57,6 +58,46 @@ describe ActiveRecord::Relation do
       expect(union.to_sql).to eq(
         "SELECT \"posts\".* FROM ( SELECT \"posts\".* FROM \"posts\"  WHERE (published_at < '2014-07-24 00:00:00.000000') AND (created_at > '2014-07-19 00:00:00.000000') UNION SELECT \"posts\".* FROM \"posts\"  WHERE \"posts\".\"user_id\" = ? ) posts"
       )
+      expect{union.to_a}.to_not raise_error
+    end
+
+    context "with ORDER BY in subselects" do
+      def union
+        User.new.posts.order(:created_at).union(
+          Post.where("created_at > ?", Time.utc(2014, 7, 19, 0, 0, 0)).order(:created_at)
+        ).order(:created_at)
+      end
+
+      context "in SQLite" do
+        it "lets ORDER BY in query subselects throw a syntax error" do
+          expect(union.to_sql).to eq(
+            "SELECT \"posts\".* FROM ( SELECT \"posts\".* FROM \"posts\"  WHERE \"posts\".\"user_id\" = ?  ORDER BY \"posts\".\"created_at\" ASC UNION SELECT \"posts\".* FROM \"posts\"  WHERE (created_at > '2014-07-19 00:00:00.000000')  ORDER BY \"posts\".\"created_at\" ASC ) posts   ORDER BY \"posts\".\"created_at\" ASC"
+          )
+          expect{union.to_a}.to raise_error(ActiveRecord::StatementInvalid)
+        end
+      end
+
+      context "in Postgres" do
+        it "wraps query subselects in parentheses to allow ORDER BY clauses" do
+          Databases.with_postgres do
+            expect(union.to_sql).to eq(
+              "SELECT \"posts\".* FROM ( (SELECT \"posts\".* FROM \"posts\"  WHERE \"posts\".\"user_id\" = $1  ORDER BY \"posts\".\"created_at\" ASC) UNION (SELECT \"posts\".* FROM \"posts\"  WHERE (created_at > '2014-07-19 00:00:00.000000')  ORDER BY \"posts\".\"created_at\" ASC) ) posts   ORDER BY \"posts\".\"created_at\" ASC"
+            )
+            expect{union.to_a}.to_not raise_error
+          end
+        end
+      end
+
+      context "in MySQL" do
+        it "wraps query subselects in parentheses to allow ORDER BY clauses" do
+          Databases.with_mysql do
+            expect(union.to_sql).to eq(
+              "SELECT \"posts\".* FROM ( (SELECT \"posts\".* FROM \"posts\"  WHERE \"posts\".\"user_id\" = $1  ORDER BY \"posts\".\"created_at\" ASC) UNION (SELECT \"posts\".* FROM \"posts\"  WHERE (created_at > '2014-07-19 00:00:00.000000')  ORDER BY \"posts\".\"created_at\" ASC) ) posts   ORDER BY \"posts\".\"created_at\" ASC"
+            )
+            expect{union.to_a}.to_not raise_error
+          end
+        end
+      end
     end
 
     context "builds a scope when given" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record_union
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Brian Hempel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-24 00:00:00.000000000 Z
+date: 2014-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -94,6 +94,34 @@ dependencies:
     - - ">="
       - !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: mysql2
+  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: UNIONs in ActiveRecord! Adds a proper union method to ActiveRecord::Relation.
 email:
 - plasticchicken@gmail.com
@@ -113,6 +141,7 @@ files:
 - lib/active_record_union/active_record/relation/union.rb
 - lib/active_record_union/version.rb
 - spec/spec_helper.rb
+- spec/support/databases.rb
 - spec/support/models.rb
 - spec/union_spec.rb
 homepage: https://github.com/brianhempel/active_record_union
@@ -141,6 +170,7 @@ specification_version: 4
 summary: UNIONs in ActiveRecord! Adds a proper union method to ActiveRecord::Relation.
 test_files:
 - spec/spec_helper.rb
+- spec/support/databases.rb
 - spec/support/models.rb
 - spec/union_spec.rb
 - bin/console