order_as_specified 0.1.0 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e011d7a057022124433414e9da18da5578a809d
-  data.tar.gz: 331b7087e75d2610e695f86db3741db58ca46bc4
+  metadata.gz: aa46391db1a92ccc0095e732300f8ff9dff05219
+  data.tar.gz: 54dc39bd5f341a8a0245c25cfbbdb56a72590b4e
 SHA512:
-  metadata.gz: 7b1371f79ccd95c02c121775077b0779089cd570605180b19722e471949ee14f640d4aaeaf0c14305670c15fa8801388f7c801dac8aa83e83f904697dcf6beef
-  data.tar.gz: 9da69d269c2bdf3e01b9390d478234b0d07257aa7e8b06696211ec57748b513b0f2e2add820944f9ebb97cf85e9ce726cbb640e6dcc6c53198e0117063be9a80
+  metadata.gz: 92a5c23cd6dff0657c08cf71387b30fa8ce6ae4a1113c51f3aeb7ad8c6f75786f9449b49ebc1d8e445341bf65b3a9bd431febb00436c8d7c566a0c30247097e8
+  data.tar.gz: d0ce1a2a19c3f1d03d80d4c2ef940551423ea3fb986b30685d99966ad1b71cc91d94c60881a61c068af8b6927e78cbb4d909f8b9df5ffc42f2d88dd3542e108b

data/.travis.yml

@@ -1,8 +1,11 @@
 language: ruby
 rvm:
 - 2.2.1
+before_script:
+  - psql -c 'create database order_as_specified_test;' -U postgres
 script: bundle exec rspec
 addons:
+  postgresql: "9.3"
   code_climate:
     repo_token: 781c439d68cbb928316deaec1c7136f98423e1db87238f99cbc95183de94df9e
 notifications:

data/README.md

@@ -103,6 +103,23 @@ TestObject.order_as_specified(language: ["fr", "es"])
    ]>
 ```
 
+In databases that support it (such as PostgreSQL), you can also use an option to
+add a `DISTINCT ON` to your query when you would otherwise have duplicates:
+
+```ruby
+TestObject.order_as_specified(distinct_on: true, language: ["fr", "en"])
+=> #<ActiveRecord::Relation [
+     #<TestObject id: 2, language: "fr">,
+     #<TestObject id: 3, language: "en">,
+     #<TestObject id: 4, language: "es">
+   ]>
+```
+
+Note that if a `nil` value is passed in the ordering an error is raised, because
+databases do not have good or consistent support for ordering with `NULL` values
+in an arbitrary order, so we don't permit this behavior instead of allowing an
+unexpected result.
+
 ## Documentation
 
 We have documentation on [RubyDoc](http://www.rubydoc.info/github/panorama-ed/order_as_specified/master).

data/lib/order_as_specified.rb

@@ -1,4 +1,5 @@
 require "order_as_specified/version"
+require "order_as_specified/error"
 
 # This module adds the ability to query an ActiveRecord class for results from
 # the database in an arbitrary order, without having to store anything extra
@@ -9,19 +10,28 @@ module OrderAsSpecified
   # @param hash [Hash] the ActiveRecord arguments hash
   # @return [ActiveRecord::Relation] the objects, ordered as specified
   def order_as_specified(hash)
+    distinct_on = hash.delete(:distinct_on)
     params = extract_params(hash)
 
     table = params[:table]
     attribute = params[:attribute]
 
     # We have to explicitly quote for now because SQL sanitization for ORDER BY
-    # queries hasn't yet merged into Rails.
+    # queries isn't in less current versions of Rails.
     # See: https://github.com/rails/rails/pull/13008
-    order_by = params[:values].map do |value|
-      "#{table}.#{attribute}='#{value}' DESC"
-    end.join(", ")
+    conditions = params[:values].map do |value|
+      raise OrderAsSpecified::Error, "Cannot order by `nil`" if value.nil?
 
-    order(order_by)
+      "#{table}.#{attribute}='#{value}'"
+    end
+
+    scope = order(conditions.map { |cond| "#{cond} DESC" }.join(", "))
+
+    if distinct_on
+      scope = scope.select("DISTINCT ON (#{conditions.join(', ')}) #{table}.*")
+    end
+
+    scope
   end
 
   private

data/lib/order_as_specified/error.rb

@@ -0,0 +1,4 @@
+module OrderAsSpecified
+  class Error < StandardError
+  end
+end

data/lib/order_as_specified/version.rb

@@ -1,3 +1,3 @@
 module OrderAsSpecified
-  VERSION = "0.1.0"
+  VERSION = "1.0"
 end

data/order_as_specified.gemspec

@@ -19,13 +19,14 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activerecord", "~> 4.0"
+  spec.add_dependency "activerecord", ">= 4.0"
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "codeclimate-test-reporter", "~> 0.4"
   spec.add_development_dependency "overcommit", "~> 0.23"
+  spec.add_development_dependency "pg", ">= 0.18"
   spec.add_development_dependency "rspec", "~> 3.2"
   spec.add_development_dependency "rspec-rails", "~> 3.2"
   spec.add_development_dependency "rubocop", "~> 0.29"
-  spec.add_development_dependency "temping", "~> 3.2"
+  spec.add_development_dependency "sqlite3", ">= 1.3"
 end

data/spec/config/database.yml

@@ -0,0 +1,9 @@
+sqlite3_test:
+  adapter: sqlite3
+  database: ":memory:"
+  timeout: 500
+
+postgresql_test:
+  adapter: postgresql
+  database: order_as_specified_test
+  username: postgres

data/spec/config/test_setup_migration.rb

@@ -0,0 +1,18 @@
+class TestSetupMigration < ActiveRecord::Migration
+  def up
+    return if ActiveRecord::Base.connection.table_exists? :test_classes
+
+    create_table :test_classes do |t|
+      t.string :field
+    end
+
+    create_table :association_test_classes do |t|
+      t.integer :test_class_id
+    end
+  end
+
+  def down
+    drop_table :test_classes
+    drop_table :association_test_classes
+  end
+end

data/spec/order_as_specified_spec.rb

@@ -1,87 +1,5 @@
-require "spec_helper"
-
-RSpec.describe OrderAsSpecified do
-  describe ".order_as_specified" do
-    Temping.create :test_class do
-      with_columns do |t|
-        t.string :field
-      end
-
-      extend OrderAsSpecified
-
-      has_one :association_test_class
-    end
-
-    Temping.create :association_test_class do
-      with_columns do |t|
-        t.integer :test_class_id
-      end
-
-      belongs_to :test_class
-    end
-
-    # Clean up after each test. This is a lot lighter for these few tests than
-    # trying to wrangle with RSpec-Rails to get transactional tests to work.
-    after :each do
-      TestClass.delete_all
-      AssociationTestClass.delete_all
-    end
-
-    let(:shuffled_objects) do
-      5.times.map { |i| TestClass.create(field: "Field #{i}") }.shuffle
-    end
-    let(:shuffled_object_fields) { shuffled_objects.map(&:field) }
-    let(:shuffled_object_ids) { shuffled_objects.map(&:id) }
-    let(:omitted_object) { TestClass.create }
-
-    context "with no table name specified" do
-      subject { TestClass.order_as_specified(field: shuffled_object_fields) }
-
-      it "returns results including unspecified objects" do
-        omitted_object # Build an object that isn't sorted in this list.
-        expect(subject).to include omitted_object
-      end
-
-      it "returns results in the given order" do
-        omitted_object # Build an object that isn't sorted in this list.
-        expect(subject.map(&:id)).
-          to eq [*shuffled_object_ids, omitted_object.id]
-      end
-    end
-
-    context "with another table name specified" do
-      let(:associated_objects) do
-        shuffled_objects.map do |object|
-          AssociationTestClass.create(test_class: object)
-        end
-      end
-      let(:associated_object_ids) { associated_objects.map(&:id) }
-      let(:omitted_associated_object) do
-        AssociationTestClass.create(test_class: omitted_object)
-      end
-
-      subject do
-        TestClass.
-          joins(:association_test_class).
-          order_as_specified(
-            association_test_classes: { id: associated_object_ids }
-          )
-      end
-
-      it "returns results including unspecified objects" do
-        # Build an object that isn't sorted in this list.
-        omitted_associated_object
-
-        expect(subject).to include omitted_object
-      end
-
-      it "returns results in the given order" do
-        # Build an object that isn't sorted in this list.
-        omitted_associated_object
-
-        expect(subject.map(&:id)).
-          to eq [*shuffled_object_ids, omitted_object.id]
-      end
-    end
-  end
-end
+# Instead of defining specs here, we define them in
+# shared/order_as_specified_examples.rb. We then have a different spec file for
+# each supported database adapter, whch runs the shared RSpec tests found in
+# the shared/order_as_specified_examples.rb file, along with any adapter-
+# specific tests.

data/spec/postgresql_spec.rb

@@ -0,0 +1,32 @@
+require "spec_helper"
+require "shared/order_as_specified_examples"
+require "config/test_setup_migration"
+
+RSpec.describe "PostgreSQL" do
+  before :all do
+    ActiveRecord::Base.establish_connection(:postgresql_test)
+    TestSetupMigration.migrate(:up)
+  end
+
+  after(:all) { ActiveRecord::Base.remove_connection }
+
+  include_examples ".order_as_specified"
+
+  context "when using DISTINCT ON" do
+    subject do
+      TestClass.order_as_specified(
+        distinct_on: true,
+        field: shuffled_object_fields
+      )
+    end
+
+    let(:shuffled_objects) do
+      fields = 3.times.map { |i| "Field #{i}" } * 2
+      5.times.map { |i| TestClass.create(field: fields[i]) }.shuffle
+    end
+
+    it "returns distinct objects" do
+      expect(subject.length).to eq 3
+    end
+  end
+end

data/spec/shared/order_as_specified_examples.rb

@@ -0,0 +1,80 @@
+require "support/test_class"
+require "support/association_test_class"
+
+RSpec.shared_examples ".order_as_specified" do
+  # Clean up after each test. This is a lot lighter for these few tests than
+  # trying to wrangle with RSpec-Rails to get transactional tests to work.
+  after :each do
+    TestClass.delete_all
+    AssociationTestClass.delete_all
+  end
+
+  let(:shuffled_objects) do
+    5.times.map { |i| TestClass.create(field: "Field #{i}") }.shuffle
+  end
+  let(:shuffled_object_fields) { shuffled_objects.map(&:field) }
+  let(:shuffled_object_ids) { shuffled_objects.map(&:id) }
+  let(:omitted_object) { TestClass.create(field: "Nothing") }
+
+  context "with no table name specified" do
+    subject { TestClass.order_as_specified(field: shuffled_object_fields) }
+
+    it "returns results including unspecified objects" do
+      omitted_object # Build an object that isn't sorted in this list.
+      expect(subject).to include omitted_object
+    end
+
+    it "returns results in the given order" do
+      omitted_object # Build an object that isn't sorted in this list.
+      expect(subject.map(&:id)).
+        to eq [*shuffled_object_ids, omitted_object.id]
+    end
+
+    context "when the order includes nil" do
+      let(:shuffled_objects) do
+        5.times.map do |i|
+          TestClass.create(field: (i == 0 ? nil : "Field #{i}"))
+        end.shuffle
+      end
+
+      it "raises an error" do
+        expect { subject }.to raise_error(OrderAsSpecified::Error)
+      end
+    end
+  end
+
+  context "with another table name specified" do
+    subject do
+      TestClass.
+        joins(:association_test_class).
+        order_as_specified(
+          association_test_classes: { id: associated_object_ids }
+        )
+    end
+
+    let(:associated_objects) do
+      shuffled_objects.map do |object|
+        AssociationTestClass.create(test_class: object)
+      end
+    end
+    let(:associated_object_ids) { associated_objects.map(&:id) }
+    let(:omitted_associated_object) do
+      AssociationTestClass.create(test_class: omitted_object)
+    end
+
+    it "returns results including unspecified objects" do
+      # Build an object that isn't sorted in this list.
+      omitted_associated_object
+
+      expect(subject).to include omitted_object
+    end
+
+    it "returns results in the given order" do
+      # Build an object that isn't sorted in this list.
+      omitted_associated_object
+
+      expect(subject.map(&:id)).
+        to eq [*shuffled_object_ids, omitted_object.id]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,13 +1,12 @@
 require "codeclimate-test-reporter"
 CodeClimate::TestReporter.start
 
-# Connect to an in-memory database for ActiveRecord tests.
-require "temping"
-ActiveRecord::Base.
-  establish_connection(adapter: "sqlite3", database: ":memory:")
+require "active_record"
 
 require "order_as_specified"
 
+ActiveRecord::Base.configurations = YAML.load_file("spec/config/database.yml")
+
 RSpec.configure do |config|
   # These two settings work together to allow you to limit a spec run
   # to individual examples or groups you care about by tagging them with

data/spec/sqlite3_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+require "shared/order_as_specified_examples"
+require "config/test_setup_migration"
+
+RSpec.describe "SQLite3" do
+  before :all do
+    ActiveRecord::Base.establish_connection(:sqlite3_test)
+    TestSetupMigration.migrate(:up)
+  end
+
+  after(:all) { ActiveRecord::Base.remove_connection }
+
+  include_examples ".order_as_specified"
+end

data/spec/support/association_test_class.rb

@@ -0,0 +1,5 @@
+class AssociationTestClass < ActiveRecord::Base
+  extend OrderAsSpecified
+
+  belongs_to :test_class
+end

data/spec/support/test_class.rb

@@ -0,0 +1,5 @@
+class TestClass < ActiveRecord::Base
+  extend OrderAsSpecified
+
+  has_one :association_test_class
+end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: order_as_specified
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: '1.0'
 platform: ruby
 authors:
 - Jacob Evelyn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-13 00:00:00.000000000 Z
+date: 2016-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
@@ -66,6 +66,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.23'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -109,19 +123,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.29'
 - !ruby/object:Gem::Dependency
-  name: temping
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '1.3'
 description: Obtain ActiveRecord results with a custom ordering with no need to store
   anything in the database.
 email:
@@ -138,10 +152,18 @@ files:
 - LICENSE.txt
 - README.md
 - lib/order_as_specified.rb
+- lib/order_as_specified/error.rb
 - lib/order_as_specified/version.rb
 - order_as_specified.gemspec
+- spec/config/database.yml
+- spec/config/test_setup_migration.rb
 - spec/order_as_specified_spec.rb
+- spec/postgresql_spec.rb
+- spec/shared/order_as_specified_examples.rb
 - spec/spec_helper.rb
+- spec/sqlite3_spec.rb
+- spec/support/association_test_class.rb
+- spec/support/test_class.rb
 homepage: https://github.com/panorama-ed/order_as_specified
 licenses:
 - MIT
@@ -167,5 +189,13 @@ signing_key:
 specification_version: 4
 summary: Add arbitrary ordering to ActiveRecord queries.
 test_files:
+- spec/config/database.yml
+- spec/config/test_setup_migration.rb
 - spec/order_as_specified_spec.rb
+- spec/postgresql_spec.rb
+- spec/shared/order_as_specified_examples.rb
 - spec/spec_helper.rb
+- spec/sqlite3_spec.rb
+- spec/support/association_test_class.rb
+- spec/support/test_class.rb
+has_rdoc: