sorted-activerecord 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc58014f05b2a80f9238bb33d98e76e3dec941c5
-  data.tar.gz: 1ead6ecd557dd19f0c3a03ee11a154fc90c86665
+  metadata.gz: dad88b26febe4a092e3832ecf4a981590629768e
+  data.tar.gz: 59a3842b4e0a927c118054c0bca71cdb1259bbc5
 SHA512:
-  metadata.gz: f7a8c3e36ddc370b777204b0eb58fbcc3851d59d4532c8b3295c939fc5f4dac841a3269677e6d6cdaca959e597b0abf388feec5ae1e72bcb298bd737d2c84317
-  data.tar.gz: 1379753406f3ea0d17e7046487417b8572d13bb899e7aadfb5a15d0fd433dee73010a8451e608847b74dcb097b8ec09cd3bb9cb5511f477aee1ec2f51c7691b3
+  metadata.gz: 5384beb8cc7de376e714fc8d5fcb8cc9feb75d354fa820ee2373fccb6d80a879b2418691c5ddc5a36d47969f87f0507ae39c7977e11c99b97a80c3900abf1671
+  data.tar.gz: 922d9586a74b8345f5011fe48c8f5233cd05a78b682faf835e87c6344a9115da962d69360aa0eed9fbfe7abd20a6a5b5444402cfec5e651afcb20b6072b44216

data/Rakefile

@@ -9,4 +9,4 @@ end
 
 RuboCop::RakeTask.new
 
-task default: %w(rubocop spec)
+task default: %w(spec rubocop)

data/lib/sorted/{activerecord → active_record}/builder.rb

@@ -8,6 +8,7 @@ module Sorted
       attr_reader :set
 
       def initialize(sort: [], order: [], whitelist: [])
+        @return_hash = true
         uri = parse_sort(sort)
         if whitelist.length > 0
           uri = ::Sorted::Set.new(uri.select { |o| whitelist.include?(o[0]) })
@@ -32,6 +33,7 @@ module Sorted
         return ::Sorted::Set.new if order.nil?
         case order.class.name
         when 'String'
+          @return_hash = false
           ::Sorted::SQLQuery.parse(order)
         when 'Array'
           parse(order)
@@ -46,6 +48,7 @@ module Sorted
           when 'Hash'
             memo = memo + parse(value.to_a)
           when 'String'
+            @return_hash = false
             memo = memo + ::Sorted::SQLQuery.parse(value)
           when 'Symbol'
             memo = memo << [value.to_s, 'asc']
@@ -63,6 +66,10 @@ module Sorted
       def to_hash
         @set.to_a.inject({}) { |a, e| a.merge(Hash[e[0].to_sym, e[1].to_sym]) }
       end
+
+      def to_sql
+        @return_hash ? to_hash : ::Sorted::SQLQuery.encode(@set)
+      end
     end
   end
 end

data/lib/sorted/{activerecord → active_record}/helper.rb

@@ -1,6 +1,6 @@
 require 'active_record'
 require 'active_support/concern'
-require 'sorted/activerecord/builder'
+require 'sorted/active_record/builder'
 
 module Sorted
   module ActiveRecord
@@ -12,14 +12,14 @@ module Sorted
           builder = ::Sorted::ActiveRecord::Builder.new(sort: sort,
                                                         order: order,
                                                         whitelist: whitelist)
-          order(builder.to_hash)
+          order(builder.to_sql)
         end
 
         def self.resorted(sort: [], order: [], whitelist: [])
           builder = ::Sorted::ActiveRecord::Builder.new(sort: sort,
                                                         order: order,
                                                         whitelist: whitelist)
-          reorder(builder.to_hash)
+          reorder(builder.to_sql)
         end
       end
     end

data/lib/sorted/{activerecord → active_record}/railtie.rb

@@ -1,11 +1,11 @@
 require 'rails'
 require 'rails/railtie'
-require 'sorted/activerecord/helper'
+require 'sorted/active_record/helper'
 
 module Sorted
   module ActiveRecord
     class Railtie < ::Rails::Railtie
-      config.after_initialize do |_app|
+      initializer 'sorted' do |_app|
         ActiveSupport.on_load(:active_record) do
           include Sorted::ActiveRecord::Helper
         end

data/lib/sorted/active_record/version.rb

@@ -0,0 +1,5 @@
+module Sorted
+  module ActiveRecord
+    VERSION = '0.1.2'
+  end
+end

data/lib/sorted/active_record.rb

@@ -0,0 +1,8 @@
+begin
+  require 'rails'
+rescue LoadError
+  #do nothing
+end
+
+require 'sorted/active_record/version'
+require 'sorted/active_record/railtie' if defined?(Rails)

data/lib/sorted/activerecord.rb

@@ -1,2 +1 @@
-require 'sorted/activerecord/version'
-require 'sorted/activerecord/railtie' if defined?(Rails::Railtie)
+require 'sorted/active_record'

data/sorted-activerecord.gemspec

@@ -1,11 +1,11 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'sorted/activerecord/version'
+require 'sorted/active_record/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'sorted-activerecord'
-  spec.version       = Sorted::Activerecord::VERSION
+  spec.version       = Sorted::ActiveRecord::VERSION
   spec.authors       = ['Rufus Post']
   spec.email         = ['Rufus.Post@team.telstra.com']
   spec.summary       = 'Activerecord scoped for sorted.'

data/spec/sorted/active_record_spec.rb

@@ -0,0 +1,126 @@
+require 'spec_helper'
+require 'active_record'
+require 'sorted/active_record/helper'
+
+ActiveRecord::Base.send(:include, Sorted::ActiveRecord::Helper)
+
+describe Sorted::ActiveRecord do
+  class Post < ActiveRecord::Base
+    establish_connection adapter: 'sqlite3', database: ':memory:'
+
+    connection.create_table table_name, force: true do |t|
+      t.string :name
+    end
+
+    belongs_to :user
+
+    scope :page, -> { limit(50) }
+  end
+
+  class User < ActiveRecord::Base
+    establish_connection adapter: 'sqlite3', database: ':memory:'
+
+    connection.create_table table_name, force: true do |t|
+      t.string :name
+    end
+
+    has_many :posts
+
+    scope :page, -> { limit(50) }
+  end
+
+  let(:subject) { Post }
+
+  it 'should integrate with ActiveRecord::Base sorted' do
+    expect(subject.respond_to?(:sorted)).to eq(true)
+  end
+
+  it 'should integrate with ActiveRecord::Base resorted' do
+    expect(subject.respond_to?(:resorted)).to eq(true)
+  end
+
+  it 'should integrate with ActiveRecord::Relation sorted' do
+    expect(subject.references(:user).includes(:user).respond_to?(:sorted)).to eq(true)
+  end
+
+  it 'should allow symbols for order' do
+    expected = subject.order(:created_at).to_sql
+    actual = subject.sorted(order: [:created_at]).to_sql
+    expect(actual).to match(expected)
+  end
+
+  it 'should allow strings for order' do
+    expected = subject.order('created_at').to_sql
+    actual = subject.sorted(order: ['created_at']).to_sql
+    expect(actual).to match(expected)
+  end
+
+  it 'should allow hash as order' do
+    expected = subject.order({ created_at: :desc }).to_sql
+    actual = subject.sorted(order: [{ created_at: :desc }]).to_sql
+    expect(actual).to match(expected)
+  end
+
+  it 'should allow hash as sort' do
+    expected = subject.order({ created_at: :desc }).to_sql
+    actual = subject.sorted(sort: [{ created_at: :desc }]).to_sql
+    expect(actual).to match(expected)
+  end
+
+  it 'should allow symbols and hash as order' do
+    expected = subject.order(:orders_count, { created_at: :desc }).to_sql
+    actual = subject.sorted(sort: [:orders_count, { created_at: :desc }]).to_sql
+    expect(actual).to match(expected)
+  end
+
+  it 'should allow sql' do
+    expected = subject.order('orders_count ASC, created_at DESC').to_sql
+    actual = subject.sorted(order: 'orders_count ASC, created_at DESC').to_sql
+    expect(actual).to match(expected)
+  end
+
+  it 'should allow uri' do
+    expected = subject.order(orders_count: :asc, created_at: :desc).to_sql
+    actual = subject.sorted(sort: 'orders_count_asc!created_at_desc').to_sql
+    expect(actual).to match(expected)
+  end
+
+  it 'should allow an array of sql' do
+    expected = subject.order('orders_count ASC', 'created_at DESC').to_sql
+    actual = subject.sorted(order: ['orders_count ASC', 'created_at DESC']).to_sql
+    expect(actual).to match(expected)
+  end
+
+  it 'should play nice with other scopes' do
+    expected = subject.where(name: 'bob').page.order('name ASC').to_sql
+    actual = subject.where(name: 'bob').page.sorted(order: 'name ASC').to_sql
+    expect(actual).to match(expected)
+  end
+
+  it 'should override the provided order' do
+    expected = subject.page.where(name: 'bob').order(:id).order('name DESC').reorder('name ASC').to_sql
+    actual = subject.page.where(name: 'bob').order(:id).sorted(order: 'name DESC').resorted(order: 'name ASC').to_sql
+    expect(actual).to match(expected)
+  end
+
+  it 'should work with whitelist' do
+    expected = subject.order(created_at: :desc).to_sql
+    expect(subject.sorted(sort: 'orders_count_asc!created_at_desc',
+                          whitelist: %(created_at)).to_sql).to match(expected)
+  end
+
+  it 'should not parse custom order strings' do
+    relation = subject.references(:user).includes(:user)
+    expected = relation.order('users.name ASC').to_sql
+    actual = relation.sorted(order: 'users.name ASC').to_sql
+    expect(actual).to match(expected)
+  end
+
+  it 'should not raise error with nil value' do
+    expect(-> { subject.sorted(sort: nil) }).to_not raise_error
+  end
+
+  it 'should not raise error with empty string' do
+    expect(-> { subject.sorted(sort: '') }).to_not raise_error
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sorted-activerecord
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Rufus Post
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-01 00:00:00.000000000 Z
+date: 2015-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -166,13 +166,14 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/sorted/active_record.rb
+- lib/sorted/active_record/builder.rb
+- lib/sorted/active_record/helper.rb
+- lib/sorted/active_record/railtie.rb
+- lib/sorted/active_record/version.rb
 - lib/sorted/activerecord.rb
-- lib/sorted/activerecord/builder.rb
-- lib/sorted/activerecord/helper.rb
-- lib/sorted/activerecord/railtie.rb
-- lib/sorted/activerecord/version.rb
 - sorted-activerecord.gemspec
-- spec/sorted/activerecord_spec.rb
+- spec/sorted/active_record_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
@@ -199,5 +200,5 @@ signing_key:
 specification_version: 4
 summary: Activerecord scoped for sorted.
 test_files:
-- spec/sorted/activerecord_spec.rb
+- spec/sorted/active_record_spec.rb
 - spec/spec_helper.rb

data/lib/sorted/activerecord/version.rb

@@ -1,5 +0,0 @@
-module Sorted
-  module Activerecord
-    VERSION = '0.1.1'
-  end
-end

data/spec/sorted/activerecord_spec.rb

@@ -1,91 +0,0 @@
-require 'spec_helper'
-require 'active_record'
-require 'sorted/activerecord/helper'
-
-ActiveRecord::Base.send(:include, Sorted::ActiveRecord::Helper)
-
-describe Sorted::ActiveRecord do
-  class SortedActiveRecordTest < ActiveRecord::Base
-    establish_connection adapter: 'sqlite3', database: ':memory:'
-
-    connection.create_table table_name, force: true do |t|
-      t.string :name
-    end
-
-    scope :page, -> { limit(50) }
-  end
-
-  let(:subject) { SortedActiveRecordTest }
-
-  it 'should integrate with ActiveRecord::Base' do
-    expect(subject.respond_to?(:sorted)).to eq(true)
-    expect(subject.respond_to?(:resorted)).to eq(true)
-  end
-
-  it 'should allow symbols and strings order' do
-    order_by = 'ORDER BY "sorted_active_record_tests"."created_at" ASC'
-    expect(subject.sorted(order: [:created_at]).to_sql).to match(order_by)
-    expect(subject.sorted(order: ['created_at']).to_sql).to match(order_by)
-  end
-
-  it 'should allow symbols and strings as sort' do
-    order_by = 'ORDER BY "sorted_active_record_tests"."created_at" ASC'
-    expect(subject.sorted(sort: [:created_at]).to_sql).to match(order_by)
-    expect(subject.sorted(sort: ['created_at']).to_sql).to match(order_by)
-  end
-
-  it 'should allow hash as order' do
-    order_by = 'ORDER BY "sorted_active_record_tests"."created_at" DESC'
-    expect(subject.sorted(order: [{ created_at: :desc }]).to_sql).to match(order_by)
-  end
-
-  it 'should allow hash as sort' do
-    order_by = 'ORDER BY "sorted_active_record_tests"."created_at" DESC'
-    expect(subject.sorted(sort: [{ created_at: :desc }]).to_sql).to match(order_by)
-  end
-
-  it 'should allow symbols and hash as order' do
-    order_by = 'ORDER BY "sorted_active_record_tests"."orders_count" ASC, "sorted_active_record_tests"."created_at" DESC'
-    expect(subject.sorted(order: [:orders_count, { created_at: :desc }]).to_sql).to match(order_by)
-  end
-
-  it 'should allow sql' do
-    order_by = 'ORDER BY "sorted_active_record_tests"."orders_count" ASC, "sorted_active_record_tests"."created_at" DESC'
-    expect(subject.sorted(order: 'orders_count ASC, created_at DESC').to_sql).to match(order_by)
-  end
-
-  it 'should allow uri' do
-    order_by = 'ORDER BY "sorted_active_record_tests"."orders_count" ASC, "sorted_active_record_tests"."created_at" DESC'
-    expect(subject.sorted(sort: 'orders_count_asc!created_at_desc').to_sql).to match(order_by)
-  end
-
-  it 'should allow an array of sql' do
-    order_by = 'ORDER BY "sorted_active_record_tests"."orders_count" ASC, "sorted_active_record_tests"."created_at" DESC'
-    expect(subject.sorted(order: ['orders_count ASC', 'created_at DESC']).to_sql).to match(order_by)
-  end
-
-  it 'should play nice with other scopes' do
-    sql = "SELECT  \"sorted_active_record_tests\".* FROM \"sorted_active_record_tests\" WHERE \"sorted_active_record_tests\".\"name\" = 'bob'  ORDER BY \"sorted_active_record_tests\".\"name\" ASC LIMIT 50"
-    expect(subject.where(name: 'bob').page.sorted(order: 'name ASC').to_sql).to eq(sql)
-    expect(subject.page.sorted(order: 'name ASC').where(name: 'bob').to_sql).to eq(sql)
-  end
-
-  it 'should override the provided order' do
-    sql = "SELECT  \"sorted_active_record_tests\".* FROM \"sorted_active_record_tests\" WHERE \"sorted_active_record_tests\".\"name\" = 'bob'  ORDER BY \"sorted_active_record_tests\".\"name\" ASC LIMIT 50"
-    expect(subject.page.where(name: 'bob').order(:id).sorted(order: 'name DESC').resorted(order: 'name ASC').to_sql).to eq(sql)
-  end
-
-  it 'should work with whitelist' do
-    order_by = 'ORDER BY "sorted_active_record_tests"."created_at" DESC'
-    expect(subject.sorted(sort: 'orders_count_asc!created_at_desc',
-                          whitelist: %(created_at)).to_sql).to match(order_by)
-  end
-
-  it 'should not raise error with nil value' do
-    expect(-> { subject.sorted(sort: nil) }).to_not raise_error
-  end
-
-  it 'should not raise error with empty string' do
-    expect(-> { subject.sorted(sort: '') }).to_not raise_error
-  end
-end