mongoid_sortable 0.0.2

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/.rbenv-gemsets

@@ -0,0 +1 @@
+mongoid_sortable_gem

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mongoid_sortable.gemspec
+gemspec
+
+group :test do
+  gem 'rake'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Egor Lynko
+
+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,81 @@
+# MongoidSortable
+[![Build Status](https://travis-ci.org/flexoid/mongoid_sortable.png?branch=master)](https://travis-ci.org/flexoid/mongoid_sortable)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mongoid_sortable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid_sortable
+
+## Usage
+
+#### Model code:
+```ruby
+class Book
+  include Mongoid::Document
+  include MongoidSortable::Sorting
+  
+  sortable_by :title, :created_at
+end
+```
+
+#### Controller code:
+```ruby
+@books = Book.all
+```
+
+#### View code:
+```ruby
+# Generates ?order_by=created_at_asc or ?order_by=created_at_desc
+# depending on current @book criteria order
+sorting_link(@book, :created_at, 'Book Timestamp')
+
+# Customize link
+sorting_link(@book, :created_at, 'Book Timestamp') do |name, path, current_order, is_active|
+  # Whatever you want to generate based on block parameters
+end
+```
+
+By default, sorting link has html classes *sorting_link asc/desc* 
+and *active* if sorting by that field is enabled now.
+
+* * *
+
+#### There is ability to customize queries generation.
+```ruby
+sortable_by :domestic_gross, :foreign_gross do |gross_type|
+  "movie_details.grosses.#{gross_type}"
+end
+```
+Using this with `domestic_gross_desc`, for example, 
+generates desceting sorting by `movie_details.grosses.domestic_gross_desc` field.
+It can be used to get rid of long url parameters which reflects your internal document structure.
+
+Also you can set block that will be used to generate sorting field 
+for all parameters that don't match to explicit `sortable_by`
+```ruby
+default_sorting do |param|
+  "movie_details.#{param}"
+end
+```
+So, for example, `sorting(order_by: ticket_cost_asc)` will generate query 
+with ascenting `movie_details.ticket_cost` sorting.
+
+Of course, you can add more complicated logic inside of `sortable_by` and `default_sorting` block, 
+all that you need is to return string with field name.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/mongoid_sortable.rb

@@ -0,0 +1,8 @@
+require "mongoid_sortable/version"
+
+require 'mongoid_sortable/sorting'
+require 'mongoid_sortable/settings'
+
+if defined?(Rails)
+  require 'mongoid_sortable/railtie'
+end

data/lib/mongoid_sortable/helpers/sorting_helper.rb

@@ -0,0 +1,26 @@
+module MongoidSortable
+  module Helpers
+    module SortingHelper
+      def sorting_link(sorting_criteria, field, name = nil, &block)
+        path_method = :"#{sorting_criteria.model_name.pluralize.underscore}_path"
+        current_order_value = sorting_criteria.options.sort.try(:[], field.to_s)
+        current_order = (current_order_value == 1) ? :asc : :desc
+
+        html_options = {class: "sorting-link #{current_order}"}
+        html_options[:class] += ' ' + 'active' if current_order_value
+
+        new_order = (current_order == :asc || !current_order_value) ? :desc : :asc
+
+        path = Rails.application.routes.url_helpers.
+          public_send(path_method, order_by: "#{field}_#{new_order}")
+        name ||= sorting_criteria.klass.human_attribute_name(field)
+
+        if block_given?
+          capture(name, path, current_order.to_s, !!current_order_value, &block)
+        else
+          link_to name, path, html_options
+        end
+      end
+    end
+  end
+end

data/lib/mongoid_sortable/railtie.rb

@@ -0,0 +1,9 @@
+require 'mongoid_sortable/helpers/sorting_helper'
+
+module MongoidSortable
+  class Railtie < Rails::Railtie
+    initializer "mongoid_sortable.helpers" do
+      ActionView::Base.send :include, Helpers::SortingHelper
+    end
+  end
+end

data/lib/mongoid_sortable/settings.rb

@@ -0,0 +1,23 @@
+module MongoidSortable
+  class Settings
+    attr_accessor :fields
+    attr_accessor :sort_generation_blocks
+
+    def initialize
+      self.fields = []
+      self.sort_generation_blocks = {}
+    end
+
+    def add_fields(fields, &block)
+      self.fields.concat(fields).uniq!
+      add_block_to_fields(fields, &block) if block_given?
+    end
+
+    private
+    def add_block_to_fields(fields, &block)
+      fields.each do |field|
+        self.sort_generation_blocks.merge!(field => block)
+      end
+    end
+  end
+end

data/lib/mongoid_sortable/sorting.rb

@@ -0,0 +1,49 @@
+module MongoidSortable
+  module Sorting
+    extend ActiveSupport::Concern
+
+    included do
+      cattr_accessor :sortable_settings do
+        Settings.new
+      end
+    end
+
+    module ClassMethods
+      def sortable_by(*fields, &block)
+        self.sortable_settings.add_fields(fields.flatten.map(&:to_sym), &block)
+      end
+
+      def default_sorting(&block)
+        sortable_by(:__default__, &block)
+      end
+
+      def sorting(params)
+        new_criteria = criteria
+        if params && params[:order_by]
+          prepare_sort_params(params).each do |field, order|
+            new_criteria = new_criteria.order_by(field => order)
+          end
+        end
+        new_criteria
+      end
+
+      private
+      def prepare_sort_params(params)
+        fields = self.sortable_settings.fields
+        sort_blocks = self.sortable_settings.sort_generation_blocks
+
+        [params[:order_by].match(/(.*)_(asc|desc)/)[1..2].map(&:to_sym)].map do |field, order|
+          if field.in? fields
+            if field.in? sort_blocks
+              [sort_blocks[field][field], order]
+            else
+              [field, order]
+            end
+          elsif fields.include? :__default__
+            [sort_blocks[:__default__][field], order]
+          end
+        end.compact
+      end
+    end
+  end
+end

data/lib/mongoid_sortable/version.rb

@@ -0,0 +1,3 @@
+module MongoidSortable
+  VERSION = "0.0.2"
+end

data/mongoid_sortable.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongoid_sortable/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "mongoid_sortable"
+  gem.version       = MongoidSortable::VERSION
+  gem.authors       = ["Egor Lynko"]
+  gem.email         = ["flexoid@gmail.com"]
+  gem.description   = %q{Provides methods to sort mongoid collections.}
+  gem.summary       = %q{Helper methods to sort mongoid collections on views}
+  gem.homepage      = ""
+
+  gem.add_dependency('mongoid')
+  gem.add_development_dependency('rspec')
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/spec/mongoid_sortable/settings_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe MongoidSortable::Settings do
+  let(:settings) { MongoidSortable::Settings.new }
+
+  describe "fields accessor" do
+    it "exists" do
+      expect(settings).to be_respond_to(:fields)
+      expect(settings).to be_respond_to(:fields=)
+    end
+
+    it "has correct defauld value" do
+      expect(settings.fields).to eq([])
+    end
+  end
+
+  describe "#add_fields" do
+    it "adds new usual fields" do
+      settings.add_fields([:year, :genre])
+      expect(settings.fields).to eq([:year, :genre])
+
+      settings.add_fields([:director])
+      expect(settings.fields).to eq([:year, :genre, :director])
+    end
+
+    it "adds new fields with block" do
+      settings.add_fields([:premiere_date]) do |field|
+        "information.#{field}"
+      end
+      expect(settings.fields).to eq([:premiere_date])
+      expect(settings.sort_generation_blocks[:premiere_date].call(:premiere_date)).
+        to eq('information.premiere_date')
+    end
+  end
+end

data/spec/mongoid_sortable/sorting_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+describe MongoidSortable::Sorting do
+  let(:movie_klass) do
+    Class.new do
+      include Mongoid::Document
+      include MongoidSortable::Sorting
+    end
+  end
+  let(:movie) { movie_klass.new }
+
+  describe "settings accessor" do
+    it "exist in class" do
+      expect(movie_klass.respond_to?(:sortable_settings)).to be_true
+      expect(movie_klass.respond_to?(:sortable_settings=)).to be_true
+    end
+
+    it "exist in class" do
+      expect(movie.respond_to?(:sortable_settings)).to be_true
+      expect(movie.respond_to?(:sortable_settings=)).to be_true
+    end
+
+    it "returns correct default value" do
+      expect(movie_klass.sortable_settings).to be_is_a(MongoidSortable::Settings)
+    end
+  end
+
+  describe "#sortable_by" do
+    before(:each) do
+      movie_klass.instance_eval do
+        sortable_by :director, :rating
+      end
+    end
+    let(:settings) { movie_klass.sortable_settings }
+
+    it "adds fields available for sorting" do
+      MongoidSortable::Settings.any_instance.should_receive(:add_fields).with([:year])
+      movie_klass.instance_eval do
+        sortable_by :year
+      end
+    end
+
+    it "adds fields with block for custom order generation" do
+      MongoidSortable::Settings.any_instance.should_receive(:add_fields).with([:domestic_gross, :foreign_gross])
+      movie_klass.instance_eval do
+        sortable_by :domestic_gross, :foreign_gross do |gross|
+          "grosses.#{gross}"
+        end
+      end
+    end
+  end
+
+  describe "#default_sorting" do
+    it "adds special :__default__ field to available for ordering list" do
+      MongoidSortable::Settings.any_instance.should_receive(:add_fields).with([:__default__])
+      movie_klass.instance_eval do
+        default_sorting do |param|
+          "additional_params.#{param}"
+        end
+      end
+    end
+  end
+
+  describe "#sorting" do
+    it "forms ordered query for usual field" do
+      movie_klass.instance_eval do
+        sortable_by :year
+      end
+      params = {order_by: 'year_asc'}
+      expect(movie_klass.sorting(params).options.sort).to eq('year' => 1)
+    end
+
+    it "forms ordered query for nested field" do
+      movie_klass.instance_eval do
+        sortable_by 'grosses.foreign_gross'
+      end
+      params = {order_by: 'grosses.foreign_gross_desc'}
+      expect(movie_klass.sorting(params).options.sort).to eq('grosses.foreign_gross' => -1)
+    end
+
+    it "forms ordered query for field with block" do
+      movie_klass.instance_eval do
+        sortable_by :domestic_gross, :foreign_gross do |gross|
+          "grosses.#{gross}"
+        end
+      end
+      params = {order_by: 'domestic_gross_desc'}
+      expect(movie_klass.sorting(params).options.sort).to eq('grosses.domestic_gross' => -1)
+    end
+
+    it "forms ordered query with default sorting block" do
+      movie_klass.instance_eval do
+        default_sorting do |param|
+          "additional_params.#{param}"
+        end
+      end
+      params = {order_by: 'ticket_cost_asc'}
+      expect(movie_klass.sorting(params).options.sort).to eq('additional_params.ticket_cost' => 1)
+    end
+
+    it "forms query without sorting options" do
+      params = {}
+      expect(movie_klass.sorting(params).options.sort).to be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require 'active_support/all'
+require 'mongoid'
+require 'mongoid_sortable'

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: mongoid_sortable
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Egor Lynko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides methods to sort mongoid collections.
+email:
+- flexoid@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rbenv-gemsets
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mongoid_sortable.rb
+- lib/mongoid_sortable/helpers/sorting_helper.rb
+- lib/mongoid_sortable/railtie.rb
+- lib/mongoid_sortable/settings.rb
+- lib/mongoid_sortable/sorting.rb
+- lib/mongoid_sortable/version.rb
+- mongoid_sortable.gemspec
+- spec/mongoid_sortable/settings_spec.rb
+- spec/mongoid_sortable/sorting_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Helper methods to sort mongoid collections on views
+test_files:
+- spec/mongoid_sortable/settings_spec.rb
+- spec/mongoid_sortable/sorting_spec.rb
+- spec/spec_helper.rb