postgres_ext 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16a9a614595cf23330e0ef345abaa250b7c22ce4
-  data.tar.gz: a76e0358088afb3a32ee35acedf993178887a323
+  metadata.gz: 4fb1baea00022bce72d77b44835d7468bad8b5c3
+  data.tar.gz: beee8834d070b830cc100f1f76485888e9a7e655
 SHA512:
-  metadata.gz: d72d5bb3c07f5ff7a41dabe3a2bc4ee2c825b4868ad8f55ca6e8b147dcd35b71543f0a2f3fadaf364a5a77a7799cbe2ed8a440b2a0e4d2758605a573c6349499
-  data.tar.gz: bd734f9475b84bee09f43d8b8c6c6f076455ffc65f1a9bc66965391af9ea51a88156dba5c36a816cb395c8627adc65188d23357cbfc2b1641bd0181871d507b5
+  metadata.gz: 626ff8558284671aa255caa67e79e1570f01ab481c18ba7fd3a48d782ef6a6e9b805676bf26c2fb4f8b3d160bf382fcfbd006b565056e4d5395be7e34e49300f
+  data.tar.gz: 3bd135a3456d19ad3719f93d676551d24f367baa8711a91eec08bdb93e0f43db4e229da7cfacfcbc05c09bf3fb73d716337bb80f91cd68cabeb3c0724a1f318f

data/README.md

@@ -3,7 +3,7 @@
 Adds missing native PostgreSQL data types to ActiveRecord and convenient querying extensions for ActiveRecord and Arel for Rails 4.x
 
 [![Build Status](https://secure.travis-ci.org/dockyard/postgres_ext.png?branch=master)](http://travis-ci.org/dockyard/postgres_ext)
-[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/dockyard/postgres_ext)
+[![Code Climate](https://codeclimate.com/github/dockyard/postgres_ext.png)](https://codeclimate.com/github/dockyard/postgres_ext)
 
 ## Looking for help? ##
 

data/lib/postgres_ext/active_record.rb

@@ -1 +1,3 @@
 require 'postgres_ext/active_record/relation'
+require 'postgres_ext/active_record/cte_proxy'
+require 'postgres_ext/active_record/querying'

data/lib/postgres_ext/active_record/cte_proxy.rb

@@ -0,0 +1,33 @@
+class CTEProxy
+  include ActiveRecord::Querying
+  include ActiveRecord::Sanitization::ClassMethods
+  include ActiveRecord::Reflection::ClassMethods
+
+  attr_accessor :reflections
+  attr_reader :connection, :arel_table
+
+  def initialize(name, model)
+    @name = name
+    @arel_table = Arel::Table.new(name)
+    @model = model
+    @connection = model.connection
+    @reflections = {}
+  end
+
+  def name
+    @name
+  end
+
+  def table_name
+    name
+  end
+
+  def column_names
+    @model.column_names
+  end
+
+  def columns_hash
+    @model.columns_hash
+  end
+end
+

data/lib/postgres_ext/active_record/querying.rb

@@ -0,0 +1,13 @@
+require 'active_record/querying'
+
+module ActiveRecord::Querying
+  delegate :with, :ranked, to: :all
+
+  def from_cte(name, expression)
+    table = Arel::Table.new(name)
+
+    cte_proxy = CTEProxy.new(name, self)
+    relation = ActiveRecord::Relation.new cte_proxy, cte_proxy.arel_table
+    relation.with name => expression
+  end
+end

data/lib/postgres_ext/active_record/relation/query_methods.rb

@@ -66,5 +66,92 @@ module ActiveRecord
         @scope
       end
     end
+
+    [:with, :rank].each do |name|
+      class_eval <<-CODE, __FILE__, __LINE__ + 1
+       def #{name}_values                   # def select_values
+         @values[:#{name}] || []            #   @values[:select] || []
+       end                                  # end
+                                            #
+       def #{name}_values=(values)          # def select_values=(values)
+         raise ImmutableRelation if @loaded #   raise ImmutableRelation if @loaded
+         @values[:#{name}] = values         #   @values[:select] = values
+       end                                  # end
+      CODE
+    end
+
+    def with(*args)
+      check_if_method_has_arguments!('with', args)
+      spawn.with!(*args.compact.flatten)
+    end
+
+    def with!(*args)
+      self.with_values += args
+      self
+    end
+
+    def ranked(options = :order)
+      spawn.ranked! options
+    end
+
+    def ranked!(*args)
+      self.rank_values += args
+      self
+    end
+
+    def build_arel_with_extensions
+      arel = build_arel_without_extensions
+
+      build_with(arel, with_values)
+
+      build_rank(arel, rank_values)
+
+      arel
+    end
+
+    def build_with(arel, withs)
+      with_statements = withs.flat_map do |with_value|
+        case with_value
+        when String
+          with_value
+        when Hash
+          with_value.map  do |name, expression|
+            case expression
+            when String
+              select = Arel::SqlLiteral.new "(#{expression})"
+            when ActiveRecord::Relation
+              select = Arel::SqlLiteral.new "(#{expression.to_sql})"
+            end
+            as = Arel::Nodes::As.new Arel::SqlLiteral.new(name.to_s), select
+          end
+        end
+      end
+      arel.with with_statements unless with_statements.empty?
+    end
+
+    def build_rank(arel, ranks)
+      rank_orders = ranks.uniq.reject(&:blank?).flat_map do |value|
+        case value
+        when :order
+          arel.orders
+        when Symbol
+          table[value].asc
+        when Hash
+          value.map { |field, dir| table[field].send(dir) }
+        else
+          Arel::Nodes::SqlLiteral.new value
+        end
+      end
+
+      unless rank_orders.blank?
+        rank_node = Arel::Nodes::SqlLiteral.new 'rank()'
+        window = Arel::Nodes::Window.new.order(rank_orders)
+        over_node = Arel::Nodes::Over.new rank_node, window
+
+        arel.project(over_node)
+      end
+    end
+
+    alias_method_chain :build_arel, :extensions
   end
 end

data/lib/postgres_ext/version.rb

@@ -1,3 +1,3 @@
 module PostgresExt
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

data/postgres_ext.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rails', '~> 4.0.0'
   gem.add_development_dependency 'rspec-rails', '~> 2.12.0'
   gem.add_development_dependency 'bourne', '~> 1.3.0'
+  gem.add_development_dependency 'database_cleaner'
   if RUBY_PLATFORM =~ /java/
       gem.add_development_dependency 'activerecord-jdbcpostgresql-adapter', '1.3.0.beta2'
   else

data/spec/queries/common_table_expression_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe 'Common Table Expression queries' do
+  describe '.with(common_table_expression_hash)' do
+    it 'generates an expression with the CTE' do
+      query = Person.with(lucky_number_seven: Person.where(lucky_number: 7)).joins('JOIN lucky_number_seven ON lucky_number_seven.id = people.id')
+      query.to_sql.should eq 'WITH lucky_number_seven AS (SELECT "people".* FROM "people"  WHERE "people"."lucky_number" = 7) SELECT "people".* FROM "people" JOIN lucky_number_seven ON lucky_number_seven.id = people.id'
+    end
+
+    it 'generates an expression with multiple CTEs' do
+      query = Person.with(lucky_number_seven: Person.where(lucky_number: 7), lucky_number_three: Person.where(lucky_number: 3)).joins('JOIN lucky_number_seven ON lucky_number_seven.id = people.id').joins('JOIN lucky_number_three ON lucky_number_three.id = people.id')
+      query.to_sql.should eq 'WITH lucky_number_seven AS (SELECT "people".* FROM "people"  WHERE "people"."lucky_number" = 7), lucky_number_three AS (SELECT "people".* FROM "people"  WHERE "people"."lucky_number" = 3) SELECT "people".* FROM "people" JOIN lucky_number_seven ON lucky_number_seven.id = people.id JOIN lucky_number_three ON lucky_number_three.id = people.id'
+    end
+
+    it 'generates an expression with multiple with calls' do
+      query = Person.with(lucky_number_seven: Person.where(lucky_number: 7)).with(lucky_number_three: Person.where(lucky_number: 3)).joins('JOIN lucky_number_seven ON lucky_number_seven.id = people.id').joins('JOIN lucky_number_three ON lucky_number_three.id = people.id')
+      query.to_sql.should eq 'WITH lucky_number_seven AS (SELECT "people".* FROM "people"  WHERE "people"."lucky_number" = 7), lucky_number_three AS (SELECT "people".* FROM "people"  WHERE "people"."lucky_number" = 3) SELECT "people".* FROM "people" JOIN lucky_number_seven ON lucky_number_seven.id = people.id JOIN lucky_number_three ON lucky_number_three.id = people.id'
+    end
+  end
+
+  describe '.from_cte(common_table_expression_hash)' do
+    it 'generates an expression with the CTE as the main table' do
+      query = Person.from_cte('lucky_number_seven', Person.where(lucky_number: 7)).where(id: 5)
+      query.to_sql.should eq 'WITH lucky_number_seven AS (SELECT "people".* FROM "people"  WHERE "people"."lucky_number" = 7) SELECT "lucky_number_seven".* FROM "lucky_number_seven"  WHERE "lucky_number_seven"."id" = 5'
+    end
+
+    it 'returns instances of the model' do
+      3.times { Person.create! lucky_number: 7 }
+      3.times { Person.create! lucky_number: 3 }
+      people = Person.from_cte('lucky_number_seven', Person.where(lucky_number: 7))
+
+      people.count.should eq 3
+    end
+  end
+end

data/spec/queries/window_functions_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe 'Window functions' do
+  describe 'ranked' do
+    it 'uses the order when no order is passed to ranked' do
+      query = Person.order(lucky_number: :desc).ranked
+      query.to_sql.should eq 'SELECT "people".*, rank() OVER (ORDER BY "people"."lucky_number" DESC) FROM "people"   ORDER BY "people"."lucky_number" DESC'
+    end
+
+    it 'uses the order when no order is passed to ranked, swapped calls' do
+      query = Person.ranked.order(lucky_number: :desc)
+      query.to_sql.should eq 'SELECT "people".*, rank() OVER (ORDER BY "people"."lucky_number" DESC) FROM "people"   ORDER BY "people"."lucky_number" DESC'
+    end
+
+    it 'uses the rank value when there is an order passed to it' do
+      query = Person.ranked(lucky_number: :desc)
+      query.to_sql.should eq 'SELECT "people".*, rank() OVER (ORDER BY "people"."lucky_number" DESC) FROM "people"'
+    end
+
+    it 'uses the rank value when a symbol passed to it' do
+      query = Person.ranked(:lucky_number)
+      query.to_sql.should eq 'SELECT "people".*, rank() OVER (ORDER BY "people"."lucky_number" ASC) FROM "people"'
+    end
+
+    it 'uses the rank value when a string passed to it' do
+      query = Person.ranked('lucky_number desc')
+      query.to_sql.should eq 'SELECT "people".*, rank() OVER (ORDER BY lucky_number desc) FROM "people"'
+    end
+
+    it 'combines the order and rank' do
+      query = Person.ranked(lucky_number: :desc).order(id: :asc)
+      query.to_sql.should eq 'SELECT "people".*, rank() OVER (ORDER BY "people"."lucky_number" DESC) FROM "people"   ORDER BY "people"."id" ASC'
+    end
+
+    it 'executes the query with the rank' do
+      Person.create!
+      Person.create!
+
+      ranked_people = Person.ranked(:id)
+      ranked_people[0].rank.should eq 1
+      ranked_people[1].rank.should eq 2
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -12,9 +12,17 @@ ENGINE_RAILS_ROOT=File.join(File.dirname(__FILE__), '../')
 # in spec/support/ and its subdirectories.
 Dir[File.join(ENGINE_RAILS_ROOT, 'spec/support/**/*.rb')].each { |f| require f }
 require 'postgres_ext'
+require 'database_cleaner'
 
 RSpec.configure do |config|
-  config.before(:suite) { ActiveRecord::Base.connection.enable_extension('pg_trgm')}
+  config.before(:suite) { ActiveRecord::Base.connection.enable_extension('pg_trgm') }
+  config.before(:suite) do
+    DatabaseCleaner.clean
+    DatabaseCleaner.strategy = :deletion
+  end
+  config.before(:each) do
+    DatabaseCleaner.clean
+  end
   config.use_transactional_fixtures = false
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.mock_with :mocha

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: postgres_ext
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Dan McClain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-23 00:00:00.000000000 Z
+date: 2013-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -94,6 +94,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  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
@@ -127,6 +141,8 @@ files:
 - docs/querying.md
 - lib/postgres_ext.rb
 - lib/postgres_ext/active_record.rb
+- lib/postgres_ext/active_record/cte_proxy.rb
+- lib/postgres_ext/active_record/querying.rb
 - lib/postgres_ext/active_record/relation.rb
 - lib/postgres_ext/active_record/relation/predicate_builder.rb
 - lib/postgres_ext/active_record/relation/query_methods.rb
@@ -140,9 +156,9 @@ files:
 - lib/postgres_ext/arel/visitors/visitor.rb
 - lib/postgres_ext/version.rb
 - postgres_ext.gemspec
-- spec/arel/arel_spec.rb
 - spec/arel/array_spec.rb
 - spec/arel/inet_spec.rb
+- spec/arel/rank_spec.rb
 - spec/dummy/.gitignore
 - spec/dummy/README.rdoc
 - spec/dummy/Rakefile
@@ -195,8 +211,10 @@ files:
 - spec/dummy/vendor/assets/stylesheets/.gitkeep
 - spec/dummy/vendor/plugins/.gitkeep
 - spec/queries/array_queries_spec.rb
+- spec/queries/common_table_expression_spec.rb
 - spec/queries/contains_querie_spec.rb
 - spec/queries/sanity_spec.rb
+- spec/queries/window_functions_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
@@ -223,9 +241,9 @@ signing_key:
 specification_version: 4
 summary: Extends ActiveRecord to handle native PostgreSQL data types
 test_files:
-- spec/arel/arel_spec.rb
 - spec/arel/array_spec.rb
 - spec/arel/inet_spec.rb
+- spec/arel/rank_spec.rb
 - spec/dummy/.gitignore
 - spec/dummy/README.rdoc
 - spec/dummy/Rakefile
@@ -278,6 +296,8 @@ test_files:
 - spec/dummy/vendor/assets/stylesheets/.gitkeep
 - spec/dummy/vendor/plugins/.gitkeep
 - spec/queries/array_queries_spec.rb
+- spec/queries/common_table_expression_spec.rb
 - spec/queries/contains_querie_spec.rb
 - spec/queries/sanity_spec.rb
+- spec/queries/window_functions_spec.rb
 - spec/spec_helper.rb

data/spec/arel/arel_spec.rb

@@ -1,29 +0,0 @@
-require 'spec_helper'
-
-describe 'Don\'t stomp all over the default ActiveRecord queries' do
-  let!(:adapter) { ActiveRecord::Base.connection }
-
-  before do
-    adapter.create_table :cars, :force => true do |t|
-      t.string :make
-      t.string :model
-      t.timestamps
-    end
-
-    class Car < ActiveRecord::Base
-    end
-  end
-
-  after do
-    adapter.drop_table :cars
-    Object.send(:remove_const, :Car)
-  end
-
-  describe 'Where Queries' do
-    describe 'Set query' do
-      it '' do
-        Car.where('id in (?)', [1,2]).to_sql.should eq "SELECT \"cars\".* FROM \"cars\"  WHERE (id in (1,2))"
-      end
-    end
-  end
-end