tire-multisort 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 47dd158d717fd7f4031f044e6f44a22ef705ba0b
+  data.tar.gz: c012f4c898c95115d5f6ccd60c0133cf138a8999
+SHA512:
+  metadata.gz: 29bf3d7ffaca9349ef1014e9867199f6a4e58ac25f97799b7f0641e4b38ab85a44deded8574841f2992ba0d1250985892945278c2a5b4d4860b91e32c1b01d5e
+  data.tar.gz: 3c2eb527de681d91375a079b4765457ae9717977b37c297a48f370b6e954b64fd4b23b412c317a42fc373446c770eefddc190cbae2a5a6e2f6437d02b8ffcd10

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/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+- "2.0.0"
+- "2.1.0"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tire-multisort.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 igor04
+
+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,130 @@
+# Tire Multisort
+[![Gem Version](https://badge.fury.io/rb/tire-multisort.png)](http://badge.fury.io/rb/tire-multisort)
+[![Code Climate](https://codeclimate.com/github/igor04/tire-multisort/badges/gpa.svg)](https://codeclimate.com/github/igor04/tire-multisort)
+[![Test Coverage](https://codeclimate.com/github/igor04/tire-multisort/badges/coverage.svg)](https://codeclimate.com/github/igor04/tire-multisort)
+[![Build Status](https://travis-ci.org/igor04/tire-multisort.png?branch=master)](https://travis-ci.org/igor04/tire-multisort)
+
+`multi_sort` extended tire `sort` with some abilities
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tire-multisort'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tire-multisort
+
+## Usage
+
+```ruby
+ multi_sort sort, order do
+   by_default :premium
+
+   by :date
+
+   by :name,      :title
+   by :rating,    :subject_rating
+   by :relevance, :_score
+   by :category,  :category_name
+   by :distance,  :_geo_distance, location: "test", unit: 'mi'
+   by :premium,   :premium, :desc
+
+   by_collection  :category,  [:category, :name]
+   by_collection  :premium,   [:premium, :relevance, :name]
+ end
+```
+
+## Checkpoints
+
+- `multi sort` - accept `sort` argument as string `name,rating,date` which
+  will be translated to propper sorting field
+
+- `auto order`
+
+  ```ruby
+    # multi_sort
+    by :date
+  ```
+
+  ```ruby
+    # sort
+    by :date, order
+  ```
+
+- `predefined order` - using predefined order instead `order` parameter
+
+  ```ruby
+    # multi_sort
+    by :date, :asc
+    by :date, invert(order) # helper method (useful for some combination with using `collections`)
+  ```
+
+  ```ruby
+    # sort
+    by :date, :asc
+    by :date, (order == :asc ? :desc : :asc)
+  ```
+
+- `auto check` - run sort just from `collection`, `default` or from `sort` param
+
+  ```ruby
+    # multi_sort
+    by :date
+  ```
+
+  ```ruby
+    # sort
+    if sort == :date
+      by :date, order
+    end
+  ```
+
+
+- `aliasing`
+
+  ```ruby
+    # multi_sort
+    by :name, :title
+  ```
+
+  ```ruby
+    # sort
+    if sort == :name
+      by :title, order
+    end
+  ```
+
+- `collections` - group fiew sort fields to sort collection
+
+  ```ruby
+    # multi_sort
+    by_collection  :category, [:category, :name]
+  ```
+
+  ```ruby
+    # sort
+    if sort == :category
+      by :category, order
+      by :name, order
+    end
+  ```
+
+- `default` - is used if passed sort param is incorrect or missed
+
+  ```ruby
+    by_default :premium
+  ```
+
+## Contributing
+
+1. Fork it ( http://github.com/igor04/tire-multisort/fork )
+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,4 @@
+require 'rspec/core/rake_task'
+
+task :default => :spec
+RSpec::Core::RakeTask.new

data/lib/tire-multisort.rb

@@ -0,0 +1,5 @@
+require "tire-multisort/version"
+
+require "tire"
+require "tire-multisort/tire/search"
+require "tire-multisort/tire/search/multi_sort"

data/lib/tire-multisort/tire/search.rb

@@ -0,0 +1,16 @@
+module Tire
+  module Search
+
+    class Search
+      # sort: "category,name,distance,.." or single "category", :category
+      # order: "asc", :desc
+      # block methods: by, by_default, by_collection
+      #
+      def multi_sort(sort, order, &block)
+        @sort = MultiSort.new(sort, order, &block).to_ary
+
+        self
+      end
+    end
+  end
+end

data/lib/tire-multisort/tire/search/multi_sort.rb

@@ -0,0 +1,96 @@
+module Tire
+  module Search
+
+    # EXAMPLE of using:
+    #
+    #
+    # multi_sort sort, order do
+    #
+    #   by_default :premium
+    #
+    #   by :date
+    #   by :rating,    invert(order)
+    #
+    #   by :name,      :title
+    #   by :rating,    :licensee_rating
+    #   by :relevance, :_score
+    #   by :category,  :category_name
+    #   by :distance,  :_geo_distance, location: "test", unit: 'mi'
+    #   by :premium,   :premium, :desc
+    #
+    #   by_collection  :category,  [:category, :name]
+    #   by_collection  :premium,   [:premium, :relevance, :name]
+    #
+    # end
+    #
+    class MultiSort < Sort
+
+      alias :origin_by :by
+
+      def initialize(sort_param, order, &block)
+        @collections = {}
+        @fields = {}
+
+        super(&block)
+
+        @sort = sort_by(sort_param)
+        @order = order
+        fields_with_order.each { |opts| origin_by *opts }
+      end
+
+      def by_default(sort_param)
+        @default = sort_by(sort_param)
+      end
+
+      def by_collection(sort, collection)
+        if collection.is_a? Array
+          @collections[sort] = collection
+        else
+          raise ArgumentError, "expect Array (got #{collection.class}) for collection param"
+        end
+      end
+
+      def by(sort, *options)
+        if options.blank? || [:desc, :asc].include?(options.first)
+          @fields[sort] = options.unshift(sort)
+        else
+          @fields[sort] = options
+        end
+      end
+
+      def invert(order)
+        order.to_s == 'asc' ? :desc : :asc
+      end
+
+      private
+
+      def add_order_to_field(field)
+        if field.size == 1
+          field.push @order
+        elsif field.last.is_a?(Hash) && !field.last.has_key?(:order)
+          field.last.merge!(order: @order)
+        end
+
+        field
+      end
+
+      def fields_with_order
+        @sort = @default if fields.empty?
+
+        fields.map { |field| add_order_to_field field.dup }
+      end
+
+      def fields
+        collections.map { |name| @fields[name.to_sym] }.compact
+      end
+
+      def collections
+        @sort.size == 1 ? (@collections[@sort.first] || @sort) : @sort
+      end
+
+      def sort_by(param)
+        param.to_s.split(',').map { |s| s.strip.to_sym }
+      end
+    end
+  end
+end

data/lib/tire-multisort/version.rb

@@ -0,0 +1,5 @@
+module Tire
+  module MultiSort
+    VERSION = "0.2.0"
+  end
+end

data/spec/by_collection_method_spec.rb

@@ -0,0 +1,67 @@
+require 'helper'
+
+describe "Tire::Search::MultiSort" do
+  subject(:search) { Tire::Search::Search.new }
+
+  context 'by_collection method' do
+    it 'simple collection' do
+      search.multi_sort(:sort, :asc) do
+        by_default :sort_field
+
+        by :name
+        by :sort_field, :asc
+        by :sort_param2, :sort_field2, :desc
+
+        by_collection :sort,  [:sort_param2, :sort_field, :name]
+        by_collection :sort2, [:name, :sort_field, :sort_param2]
+      end
+
+      expect(search.to_hash[:sort]).to eq [{sort_field2: :desc}, {sort_field: :asc}, {name: :asc}]
+    end
+
+    it 'with the same name as existed sort' do
+      search.multi_sort(:sort, :asc) do
+        by_default :sort_field
+
+        by :sort
+        by :name
+        by :sort_field, :asc
+        by :sort_param2, :sort_field2, :desc
+
+        by_collection :sort,  [:sort_param2, :sort_field, :name]
+      end
+
+      expect(search.to_hash[:sort]).to eq [{sort_field2: :desc}, {sort_field: :asc}, {name: :asc}]
+    end
+
+    it 'ignore with multiple sort' do
+      search.multi_sort('sort,name,sort_param2', :asc) do
+        by_default :sort_field
+
+        by :sort
+        by :name
+        by :sort_field, :asc
+        by :sort_param2, :sort_field2, :desc
+
+        by_collection :sort,  [:sort_param2, :sort_field, :name]
+      end
+
+      expect(search.to_hash[:sort]).to eq [{sort: :asc}, {name: :asc}, {sort_field2: :desc}]
+    end
+
+    it 'with incorrect sort parameter' do
+      search.multi_sort(:sort, :asc) do
+        by_default :sort_field
+
+        by :sort
+        by :name
+        by :sort_field, :asc
+        by :sort_param2, :sort_field2, :desc
+
+        by_collection :sort,  [:sort_param2, :sort_field, :name2]
+      end
+
+      expect(search.to_hash[:sort]).to eq [{sort_field2: :desc}, {sort_field: :asc}]
+    end
+  end
+end

data/spec/by_default_method_spec.rb

@@ -0,0 +1,66 @@
+require 'helper'
+
+describe "Tire::Search::MultiSort" do
+  subject(:search) { Tire::Search::Search.new }
+
+  context 'by_default method' do
+    it 'with invalid sort parameter' do
+      search.multi_sort(:invalid_sort, :asc) do
+        by_default :sort_field
+
+        by :sort_field
+        by :sort_field2
+      end
+
+      expect(search.to_hash[:sort]).to eq [{sort_field: :asc}]
+    end
+
+    it 'with missing sort parameter' do
+      search.multi_sort(nil, :asc) do
+        by_default :sort_field
+
+        by :sort_field
+        by :sort_field2
+      end
+
+      expect(search.to_hash[:sort]).to eq [{sort_field: :asc}]
+    end
+
+    it 'could be redefined' do
+      search.multi_sort(nil, :asc) do
+        by_default :sort_field
+
+        by :sort_field, :asc
+        by :sort_param2, :sort_field2, :desc
+
+        by_default :sort_param2
+      end
+
+      expect(search.to_hash[:sort]).to eq [{sort_field2: :desc}]
+    end
+
+    it 'ignore when sort correct' do
+      search.multi_sort(:sort_param2, :asc) do
+        by_default :sort_field
+
+        by :sort_field, :asc
+        by :sort_param2, :sort_field2, :desc
+      end
+
+      expect(search.to_hash[:sort]).to eq [{sort_field2: :desc}]
+    end
+
+    it 'with sort collection' do
+      search.multi_sort(nil, :asc) do
+        by_default :sort_param3
+
+        by :sort_field
+        by :sort_param2, :sort_field2, :desc
+
+        by_collection :sort_param3,   [:sort_field, :sort_param2]
+      end
+
+      expect(search.to_hash[:sort]).to eq [{sort_field: :asc}, {sort_field2: :desc}]
+    end
+  end
+end

data/spec/by_method_spec.rb

@@ -0,0 +1,99 @@
+require 'helper'
+
+describe "Tire::Search::MultiSort" do
+  subject(:search) { Tire::Search::Search.new }
+
+  context 'by method' do
+    it 'with alias and predefined order' do
+      search.multi_sort(:sort_param, :desc) do
+        by :sort_param,  :sort_field,  :asc
+        by :sort_param2, :sort_field2, :desc
+      end
+
+      expect(search.to_hash[:sort]).to eq [{sort_field: :asc}]
+    end
+
+    it 'with alias' do
+      search.multi_sort(:sort_param, :desc) do
+        by :sort_param,  :sort_field
+        by :sort_param2, :sort_field2
+      end
+
+      expect(search.to_hash[:sort]).to eq [{sort_field: :desc}]
+    end
+
+    it 'without alias and with predefined order' do
+      search.multi_sort(:sort_field, :desc) do
+        by :sort_field, :asc
+        by :sort_field2, :order
+      end
+
+      expect(search.to_hash[:sort]).to eq [{sort_field: :asc}]
+    end
+
+    it 'without alias' do
+      search.multi_sort(:sort_field, :desc) do
+        by :sort_field
+        by :sort_field2
+      end
+
+      expect(search.to_hash[:sort]).to eq [{sort_field: :desc}]
+    end
+
+    it 'with multiple sort' do
+      search.multi_sort('sort_field2,sort_field,sort_param2,sort_param', :desc) do
+        by :sort_field
+        by :sort_field2
+        by :sort_param, :sort_field3
+        by :sort_param2, :sort_field4, :asc
+      end
+
+      expect(search.to_hash[:sort]).to eq [{sort_field2: :desc}, {sort_field: :desc}, {sort_field4: :asc}, {sort_field3: :desc}]
+    end
+
+    it 'with incorrect multiple sort parameter' do
+      search.multi_sort('sort_field0,sort_field,sort_param2,sort_param', :desc) do
+        by :sort_field
+        by :sort_field2
+        by :sort_param, :sort_field3
+        by :sort_param2, :sort_field4, :asc
+      end
+
+      expect(search.to_hash[:sort]).to eq [{sort_field: :desc}, {sort_field4: :asc}, {sort_field3: :desc}]
+    end
+
+    it 'with multiple sort and spaces' do
+      search.multi_sort(' sort_field, sort_param2, sort_param ', :desc) do
+        by :sort_field
+        by :sort_field2
+        by :sort_param, :sort_field3
+        by :sort_param2, :sort_field4, :asc
+      end
+
+      expect(search.to_hash[:sort]).to eq [{sort_field: :desc}, {sort_field4: :asc}, {sort_field3: :desc}]
+    end
+
+    it 'with invert' do
+      order = :asc
+
+      search.multi_sort(:sort_field, order) do
+        by :sort_field, invert(order)
+        by :sort_field2
+        by :sort_param, :sort_field3
+        by :sort_param2, :sort_field4, :asc
+      end
+
+      expect(search.to_hash[:sort]).to eq [{sort_field: :desc}]
+    end
+
+    it 'with additional parameters' do
+      search.multi_sort(:distance, :asc) do
+        by :sort_param, :sort_field3
+        by :sort_param2, :sort_field4, :asc
+        by :distance, :_geo_distance, location: "test", unit: 'mi'
+      end
+
+      expect(search.to_hash[:sort]).to eq  [{_geo_distance: {location: "test", unit: "mi", order: :asc}}]
+    end
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'bundler'
+require "codeclimate-test-reporter"
+
+ENV['CODECLIMATE_REPO_TOKEN'] = '9db5a2e5847018b781c2d42d12ea9b05c4662b2cfad232b356731700da5cc418'
+CodeClimate::TestReporter.start
+require "#{File.dirname(__FILE__)}/../lib/tire-multisort"
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end

data/tire-multisort.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tire-multisort/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tire-multisort"
+  spec.version       = Tire::MultiSort::VERSION
+  spec.authors       = ["igor04"]
+  spec.email         = ["igor.s04g@gmail.com"]
+  spec.summary       = %q{tire sort extension}
+  spec.description   = %q{multi_sort extended tire sort with some abilities}
+  spec.homepage      = "https://github.com/igor04/tire-multisort"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "tire"
+  spec.add_development_dependency "codeclimate-test-reporter"
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: tire-multisort
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- igor04
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: tire
+  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: codeclimate-test-reporter
+  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: multi_sort extended tire sort with some abilities
+email:
+- igor.s04g@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tire-multisort.rb
+- lib/tire-multisort/tire/search.rb
+- lib/tire-multisort/tire/search/multi_sort.rb
+- lib/tire-multisort/version.rb
+- spec/by_collection_method_spec.rb
+- spec/by_default_method_spec.rb
+- spec/by_method_spec.rb
+- spec/helper.rb
+- tire-multisort.gemspec
+homepage: https://github.com/igor04/tire-multisort
+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: tire sort extension
+test_files:
+- spec/by_collection_method_spec.rb
+- spec/by_default_method_spec.rb
+- spec/by_method_spec.rb
+- spec/helper.rb
+has_rdoc: