orderable2 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 59d76b8dcf698b6b2e6fbfee7b6b96cee201918e
+  data.tar.gz: 88b254c8f472f62a9e34422129a573b9a31778b9
+SHA512:
+  metadata.gz: 20ee516e198007afdc41c88d19a759843285acfbc5b37cb58e0e96a691c6226067c6f269a04353808fcf507a2dfeefad2987f6160abcfc4ee77732579b4dfff0
+  data.tar.gz: 7c00d66ca944aba80e803ef2f64ef292f3feef2990e4d5613daa30abec6f24a78587c9ad20dc2a8c19fb88a6261363171dab279d1fabbd5bb4448e1da3ffaca3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Lukas_Skywalker
+
+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,107 @@
+# Orderable2
+
+ User defined sorting of ActiveRecord queries for Rails 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'orderable2'
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+## Usage
+
+### Controllers
+
+* Include the gem in the controller you wish to be sortable
+
+```ruby
+class UsersController < ApplicationController
+  include Orderable2
+
+  [...]
+end
+```
+
+* Order your collection using the `sort_order` method
+
+```ruby
+class UsersController < ApplicationController
+  include Orderable2
+
+  def index
+    @users = User.all.order(sort_order)
+  end
+end
+```
+
+This uses the order provided in the params or falls back to ordering by ascending ID if no order parameter is present in the request.
+
+You can also override the default order in the sort_order call:
+
+```ruby
+class UsersController < ApplicationController
+  include Orderable2
+
+  def index
+    @users = User.all.order(sort_order(email: :asc, id: :asc))
+  end
+end
+```
+
+This would sort by ascending email and ascending ID if no ordering params are present in the request.
+
+To set the ordering using request parameters, set a parameter named `order` containing a sorting definition in the following format:
+
+```
+attribute:direction
+```
+
+For example:
+
+```
+country:asc
+```
+
+Multiple columns may be defined by separating them by comma:
+
+```
+country:asc,id:asc
+```
+
+So, to create a link that sorts users by country, you could use the following
+
+```ruby
+users_path(order: 'country:asc')
+```
+
+### Views
+
+Orderable2 includes view helpers that simplify usage in the views.
+
+In order to print the label of a table column or filter, use the following helper
+
+```ruby
+<%= orderable_for :country %>
+```
+
+This automatically creates the necessary label and displays the current sort order using &uarr; or &darr;. Clicking on the label reorders by that column.
+
+By default, the helper lets you sort by multiple columns, for example username ASC, country DESC. If you wish to disable this behaviour and only allow sorting based on a single column, use the `single` option:
+
+```ruby
+<%= orderable_for :country, single: true %>
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/code-fabrik/orderable2.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,23 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Orderable2'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+

data/lib/orderable2.rb

@@ -0,0 +1,22 @@
+require 'orderable2/railtie' if defined?(Rails)
+
+module Orderable2
+  extend ActiveSupport::Concern
+
+  def sort_order(order = nil)
+    calculate_order(order)
+  end
+
+  private
+
+  def calculate_order(default_order = nil)
+    if params[:order]
+      params[:order].split(',').map do |stmt|
+        stmt_array = stmt.split(':')
+        { stmt_array.first.to_sym => stmt_array.last.to_sym }
+      end.reduce({}, :merge)
+    else
+      default_order || { id: :asc }
+    end
+  end
+end

data/lib/orderable2/orderable_helper.rb

@@ -0,0 +1,37 @@
+module OrderableHelper
+  def orderable_for(attr, options = {})
+    label = I18n.t("orderable.#{attr}", default: attr.to_s.humanize)
+    sort_params = params[:order] || ''
+
+    this_clauses, other_clauses = sort_params.split(',').partition do |sort_param|
+      sort_param.split(':').first == attr.to_s
+    end
+
+    this_clause = this_clauses.first
+    this_clause ||= ''
+
+    direction = this_clause.split(':').last
+
+    if direction.nil?
+      arrow = ''
+      next_dir = "#{attr}:asc"
+    elsif direction == 'asc'
+      arrow = '↑'
+      next_dir = "#{attr}:desc"
+    elsif direction == 'desc'
+      arrow = '↓'
+      next_dir = ''
+    else
+      raise StandardError, direction
+    end
+    label = label + ' ' + arrow
+
+    if options[:single]
+      new_order = [next_dir]
+    else
+      new_order = other_clauses + [next_dir]
+    end
+
+    link_to label.html_safe, request.query_parameters.merge(order: new_order.join(','))
+  end
+end

data/lib/orderable2/railtie.rb

@@ -0,0 +1,11 @@
+require 'orderable2/orderable_helper'
+
+module Orderable2
+  class Railtie < Rails::Railtie
+    initializer "orderable2.orderable_helper" do
+      ActiveSupport.on_load(:action_view) do
+        include OrderableHelper
+      end
+    end
+  end
+end

data/lib/orderable2/version.rb

@@ -0,0 +1,3 @@
+module Orderable2
+  VERSION = '0.1.0'
+end

data/lib/tasks/orderable2_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :orderable2 do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: orderable2
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lukas_Skywalker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: pg
+  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: Allows to set the order of AR queries using URL parameters
+email:
+- lukas.diener@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/orderable2.rb
+- lib/orderable2/orderable_helper.rb
+- lib/orderable2/railtie.rb
+- lib/orderable2/version.rb
+- lib/tasks/orderable2_tasks.rake
+homepage: https://code-fabrik.ch/gems/orderable2
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Let users define order rules for records
+test_files: []
+has_rdoc: