activerecord-sort 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9ad6ad083d32b5354b090af30d25fb20c5b43c74
+  data.tar.gz: 9cbb97bae8eefbae937cf0ebc82154fbae1020e8
+SHA512:
+  metadata.gz: 589a24220b64270fc59cb5e75f286fb51858150a451f1f4d464a3c45137c163c0d4e02f64d6946181b77fc41fce2a46cda96db965fb379349c5aaf09c17147bf
+  data.tar.gz: 63024dc5a854cf4f18ddadc8d5e13e6816ce671c2fcf9a7cdef34ad636b18ed63642330447401bcb750b81885b989bcf0828f6b63dc226aa0e193c6f08c9a4e7

data/README.md

@@ -0,0 +1,2 @@
+# activerecord-sort
+A safe way to accept user parameters and order against your ActiveRecord Models

data/ext/active_record/base.rb

@@ -0,0 +1,120 @@
+class ActiveRecord::Base
+  class << self
+
+    # ordering:
+    # :id
+    # :name, :id
+    # :id => :desc
+    # :id => {:desc => :nulls_last}
+    # :listings => :id
+    # :listings => {:id => {:asc => :nulls_first}}
+    def sort(*ordering)
+      resource = all
+      ordering.compact!
+      ordering.flatten!
+      return resource if ordering.size == 0
+      
+      ordering.each do |order|
+        order = sort_order_to_column_and_options(order)
+
+        order.each do |column_or_relation, options|
+          if self.column_names.include?(column_or_relation.to_s)
+            resource = resource.sort_for_column(column_or_relation, options)
+          elsif reflect_on_association(column_or_relation.to_sym)
+            resource = resource.select(resource.klass.arel_table[Arel::Nodes::SqlLiteral.new('*')])
+            resource = resource.sort_for_relation(column_or_relation.to_sym, options)
+          else
+            raise ActiveRecord::StatementInvalid.new("Unkown column #{column_or_relation}")
+          end
+        end
+      end
+
+      resource
+    end
+
+    def sort_for_column(column, options)
+      column = self.arel_table[column.to_s.underscore]
+      direction = (options.is_a?(Hash) ? options.keys.first.to_sym : options.to_s.downcase.to_sym)
+
+      nulls = (options.is_a?(Hash) ? options.values.first.to_sym : nil)
+      if direction == :desc
+        self.order(Arel::Nodes::Descending.new(column, nulls))
+      elsif direction == :asc || direction == :''
+        self.order(Arel::Nodes::Ascending.new(column, nulls))
+      else
+        raise ActiveRecord::StatementInvalid.new("Unkown ordering #{direction}")
+      end
+    end
+
+    def sort_for_relation(relation, options)
+      resource = self
+      relation = reflect_on_association(relation)
+
+      if relation.macro == :has_many
+        options = [options] if !options.is_a?(Array)
+
+        options.each do |order|
+          order = sort_order_to_column_and_options(order)
+          order.each do |column, options|
+            column = relation.klass.arel_table[column]
+            direction = (options.is_a?(Hash) ? options.keys.first.to_sym : options.to_s.downcase.to_sym)
+
+            nulls = (options.is_a?(Hash) ? options.values.first.to_sym : nil)
+            if direction == :desc
+              # aggregation = Arel::Nodes::Max.new([column], "max_#{relation.name}_#{column.name}")
+              # order = Arel::Nodes::Descending.new(Arel::Nodes::SqlLiteral.new("max_#{relation.name}_#{column.name}"), nulls)
+
+              if relation.options[:through]
+                resource = resource.joins(relation.options[:through] => relation.source_reflection_name)
+              else
+                resource = resource.joins(relation.name)
+              end
+              # resource = resource.select(aggregation)
+              # resource = resource.order(order)
+              resource = resource.order(Arel::Nodes::Descending.new(column, nulls))
+            else
+              # aggregation = Arel::Nodes::Min.new([column], "min_#{relation.name}_#{column.name}")
+              order = Arel::Nodes::Ascending.new(Arel::Nodes::SqlLiteral.new("min_#{relation.name}_#{column.name}"), nulls)
+
+              resource = resource.joins(relation.name)
+              # resource = resource.select(aggregation)
+              # resource = resource.order(order)
+              resource = resource.order(Arel::Nodes::Ascending.new(column, nulls))
+            end
+          end
+        end
+      elsif relation.macro == :belongs_to || relation.macro == :has_one
+        options = [options] if !options.is_a?(Array)
+
+        options.each do |order|
+          order = sort_order_to_column_and_options(order)
+          order.each do |column, options|
+            column = relation.klass.arel_table[column]
+            direction = (options.is_a?(Hash) ? options.keys.first.to_sym : options.to_s.downcase.to_sym)
+
+            nulls = (options.is_a?(Hash) ? options.values.first.to_sym : nil)
+            if direction == :asc
+              order = Arel::Nodes::Ascending.new(column, nulls)
+            else
+              order = Arel::Nodes::Descending.new(column, nulls)
+            end
+
+            resource = resource.joins(relation.name)
+            resource = resource.order(order)
+          end
+        end
+      end
+
+      resource
+    end
+
+    def sort_order_to_column_and_options(column)
+      if column.is_a?(Symbol)
+        [column]
+      else
+        column
+      end
+    end
+
+  end
+end

data/ext/arel/nodes/ascending.rb

@@ -0,0 +1,15 @@
+module Arel
+  module Nodes
+    class Ascending < Ordering
+
+      attr_accessor :nulls
+
+      def initialize expr, nulls=nil
+        super(expr)
+        @expr = expr
+        @nulls = nulls
+      end
+
+    end
+  end
+end

data/ext/arel/nodes/descending.rb

@@ -0,0 +1,16 @@
+module Arel
+  module Nodes
+    class Descending < Ordering
+
+      attr_accessor :nulls
+
+      def initialize expr, nulls=nil
+        super(expr)
+        @expr = expr
+        @nulls = nulls
+      end
+
+    end
+
+  end
+end

data/ext/arel/order_predications.rb

@@ -0,0 +1,14 @@
+# Ordering with :nulls_last, :nulls_first options
+module Arel
+  module OrderPredications
+
+    def asc(nulls=nil)
+      Nodes::Ascending.new self, nulls
+    end
+
+    def desc(nulls=nil)
+      Nodes::Descending.new self, nulls
+    end
+
+  end
+end

data/ext/arel/visitors/postgresql.rb

@@ -0,0 +1,24 @@
+module Arel
+  module Visitors
+    class PostgreSQL
+      private
+      
+      def visit_Arel_Nodes_Ascending o, collector
+        case o.nulls
+        when :nulls_first then visit(o.expr, collector) << ' ASC NULLS FIRST'
+        when :nulls_last  then visit(o.expr, collector) << ' ASC NULLS LAST'
+        else visit(o.expr, collector) << ' ASC'
+        end
+      end
+
+      def visit_Arel_Nodes_Descending o, collector
+        case o.nulls
+        when :nulls_first then visit(o.expr, collector) << ' DESC NULLS FIRST'
+        when :nulls_last  then visit(o.expr, collector) << ' DESC NULLS LAST'
+        else visit(o.expr, collector) << ' DESC'
+        end
+      end
+      
+    end
+  end
+end

data/lib/active_record/sort.rb

@@ -0,0 +1,7 @@
+require 'active_record'
+
+require File.expand_path(File.join(__FILE__, '../../../ext/arel/order_predications'))
+require File.expand_path(File.join(__FILE__, '../../../ext/arel/nodes/ascending'))
+require File.expand_path(File.join(__FILE__, '../../../ext/arel/nodes/descending'))
+require File.expand_path(File.join(__FILE__, '../../../ext/arel/visitors/postgresql'))
+require File.expand_path(File.join(__FILE__, '../../../ext/active_record/base'))

data/lib/active_record/sort/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module Sort
+    VERSION = '1.0.0'
+  end
+end

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-sort
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jon Bracy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.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
+    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: minitest
+  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: 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: simplecov
+  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: factory_girl_rails
+  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: faker
+  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: A safe way to accept user parameters and order against your ActiveRecord
+  Models
+email:
+- jonbracy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- ext/active_record/base.rb
+- ext/arel/nodes/ascending.rb
+- ext/arel/nodes/descending.rb
+- ext/arel/order_predications.rb
+- ext/arel/visitors/postgresql.rb
+- lib/active_record/sort.rb
+- lib/active_record/sort/version.rb
+homepage: https://github.com/malomalo/activerecord-sort
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A safe way to accept user parameters and order against your ActiveRecord
+  Models
+test_files: []