active_record_sorting 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c2e7222d5e6379d7a1c1375cd90f25e3a36be2f1
+  data.tar.gz: a5afbea4b3def66de8bb6b1aa63e53c5711f6c59
+SHA512:
+  metadata.gz: f20ad9907cf243c055ef785e38206dbddef16542416cad19dcd6f976ab181e4ad1195052f99ccaffa446aac431c7e34a3b594a9fa3d1e7e777e493ca452d5bf5
+  data.tar.gz: 22867b2abe95559e6d051b40e74ce1c7de04a6e5f3d696e75453be81fcdc9fa406c39e975ca851fea3e90f06a241eac9e4331b1914e25139ebb63d2aa785d4ce

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in active_record_sorting.gemspec
+gemspec
+
+gem 'activesupport'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 yratanov
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,73 @@
+# ActiveRecordSorting
+
+Simple gem to sort your records keeping model clean
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'active_record_sorting'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_record_sorting
+
+## Why?
+
+Usually when your application grows your models become a mess of different kind of logic (scopes, auth, everything).
+And usually you need to provide an API for sorting. 
+Of course you add some magic Concerns and use it like this `User.sort(order)` and add custom orders' logic right in your model class. 
+But if you care about you code being clean and follow single responsibility principle then you need this gem to extract sorting logic out of the model. 
+
+## Usage
+
+1. Create sorting class:
+```ruby
+# app/sortings
+require 'active_record_sorting/base'
+ 
+class UserSorting < ActiveRecordSorting::Base
+  named_sorting_orders :full_name
+
+  def full_name(order)
+    scope.order(first_name: order, last_name: order)
+  end   
+end
+```
+2. In your controller:
+```ruby
+def index
+ @users = UserSorting.sort(User, params[:sort]).page(params[:page])
+end
+```
+Possible values of `sort` param: `'id_asc', 'created_at_desc', 'relation.column_asc', 'named_order_asc'`
+
+You can also define basic sorting class if you don't want to create it for each model:
+
+```ruby
+# app/sorting/sorting
+
+require 'active_record_sorting/base'
+ 
+class Sorting < ActiveRecordSorting::Base
+end
+```
+
+Usage: 
+
+```ruby
+Sorting.sort(User, params[:sort])
+
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/active_record_sorting.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_record_sorting/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_record_sorting"
+  spec.version       = ActiveRecordSorting::VERSION
+  spec.authors       = ["yratanov"]
+  spec.email         = ["organium@gmail.com"]
+  spec.description   = 'Simple gem for Rails Active Record sorting'
+  spec.summary       = 'Extract you sorting logic to separate object'
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "activerecord"
+  spec.add_development_dependency "sqlite3"
+end

data/lib/active_record_sorting/base.rb

@@ -0,0 +1,70 @@
+require 'active_support/core_ext/class/attribute_accessors'
+
+module ActiveRecordSorting
+  class Base
+    cattr_accessor(:sorting_orders) { [] }
+
+    attr_accessor :scope
+
+    # If simple order like "id_asc" is not enough, you can create complicated orders using this method.
+    # @param sortings Array
+    def self.named_sorting_orders(*sortings)
+      self.sorting_orders = sortings
+    end
+
+    def initialize(scope)
+      @scope = scope
+    end
+
+    def self.sort(scope, order)
+      new(scope).sort(order)
+    end
+
+    # Parses +sort_order+, applies sorting to scope and return it.
+    # @param sort_order String Examples: 'id_asc', 'created_at_desc', 'relation.column_asc', 'named_order_asc'
+    def sort(sort_order)
+      return scope unless sort_order.present?
+
+      column, direction = parse_order sort_order
+
+      if sorting_orders.include? column.to_sym
+        send column.to_sym, direction
+      elsif scope.column_names.include?(column)
+        column_sorting(column, direction)
+      else
+        relation_sorting(column, direction)
+      end
+    end
+
+    private
+
+    def sorting_orders
+      self.class.sorting_orders
+    end
+
+    def parse_order(sort_order)
+      sort_array = sort_order.split('_')
+      direction = sort_array.pop
+      unless %w(desc asc).include? direction.downcase
+        raise "Invalid direction '#{direction}'"
+      end
+      column = sort_array.join('_')
+      [column, direction]
+    end
+
+    def relation_sorting(column, direction)
+      relation, attribute = column.split '.'
+      association = scope.reflect_on_association(relation.to_sym)
+      if association.present?
+        scope.includes(association.name).
+          order("#{association.table_name}.#{attribute} #{direction}")
+      else
+        scope
+      end
+    end
+
+    def column_sorting(column, direction)
+      scope.order("#{scope.table_name}.#{column} #{direction}")
+    end
+  end
+end

data/lib/active_record_sorting/version.rb

@@ -0,0 +1,3 @@
+module ActiveRecordSorting
+  VERSION = "0.0.1"
+end

data/lib/active_record_sorting.rb

@@ -0,0 +1,5 @@
+require "active_record_sorting/version"
+
+module ActiveRecordSorting
+  # Your code goes here...
+end

data/spec/active_record_sorting/base_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+require 'active_record_sorting/base'
+
+describe ActiveRecordSorting::Base do
+  context '.named_sorting_orders' do
+    subject { described_class }
+
+    context 'default value' do
+      it { expect(subject.sorting_orders).to eq([]) }
+    end
+
+    context 'is set' do
+      before do
+        subject.named_sorting_orders :some_named_order, :some_named_order_2
+      end
+
+      it { expect(subject.sorting_orders).to eq [:some_named_order, :some_named_order_2] }
+    end
+  end
+
+  context '#sort' do
+    subject { described_class.new(scope) }
+    let(:scope) { User }
+
+    context 'no sorting order' do
+      it 'should return scope' do
+        expect(subject.sort(nil)).to eq scope
+      end
+    end
+
+    context 'named sorting order' do
+      before do
+        described_class.named_sorting_orders :named_order
+      end
+
+      let(:new_scope) { double }
+
+      it 'call custom named scope' do
+        expect(subject).to receive(:named_order).with('asc').and_return(new_scope)
+        expect(subject.sort('named_order_asc')).to eq new_scope
+      end
+    end
+
+    context 'simple column ordering' do
+      let(:new_scope) { double }
+
+      it 'call custom named scope' do
+        expect(scope).to receive(:order).with('users.name desc').and_return new_scope
+        expect(subject.sort('name_desc')).to eq new_scope
+      end
+    end
+
+    context 'relation ordering' do
+      let(:new_scope) { double }
+
+      it 'call custom named scope' do
+        expect(scope).to receive(:includes).with(:group).and_return new_scope
+        expect(new_scope).to receive(:order).with('groups.name asc').and_return new_scope
+        expect(subject.sort('group.name_asc')).to eq new_scope
+      end
+
+      context 'relation doesnt exist' do
+        it 'should return scope' do
+          expect(subject.sort('unknown_model.name_asc')).to eq scope
+        end
+      end
+    end
+  end
+end

data/spec/fixtures/group.rb

@@ -0,0 +1,2 @@
+class Group < ActiveRecord::Base
+end

data/spec/fixtures/schema.rb

@@ -0,0 +1,18 @@
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :users, :force => true do |t|
+    t.string :name
+    t.integer :age
+    t.integer :group_id
+
+    t.timestamps
+  end
+
+  create_table :groups, :force => true do |t|
+    t.string :name
+
+    t.timestamps
+  end
+
+end

data/spec/fixtures/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  belongs_to :group
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'active_record_sorting'
+require 'active_record'
+
+ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
+
+require 'fixtures/schema'
+require 'fixtures/group'
+require 'fixtures/user'

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: active_record_sorting
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- yratanov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: rspec
+  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: activerecord
+  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: sqlite3
+  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: Simple gem for Rails Active Record sorting
+email:
+- organium@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_record_sorting.gemspec
+- lib/active_record_sorting.rb
+- lib/active_record_sorting/base.rb
+- lib/active_record_sorting/version.rb
+- spec/active_record_sorting/base_spec.rb
+- spec/fixtures/group.rb
+- spec/fixtures/schema.rb
+- spec/fixtures/user.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Extract you sorting logic to separate object
+test_files:
+- spec/active_record_sorting/base_spec.rb
+- spec/fixtures/group.rb
+- spec/fixtures/schema.rb
+- spec/fixtures/user.rb
+- spec/spec_helper.rb