orden 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 45437893eb15d9e3966e3b9275b80503b52a163a
+  data.tar.gz: 97eeaf7ed7448abae3912d3c6fa466623a8f8f65
+SHA512:
+  metadata.gz: 6cba4fb2a2728569ab9d4fccbebdd03daa1f58ead935968f02620a2e7bd6d8c66fc47ff7d84752cb7ffdb04dfecf93356ee9bbe7cbbde52f5c81857bf61a089a
+  data.tar.gz: f30491fa3939427b7677a4ed96dfd3db05bc13825b98c1527f57e2de788c004e7a005e9eaf71e74e9a3a7b010931850bdc7d4ad81bae381e1fd0a6b193a9a162

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.5

data/Gemfile

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

data/README.md

@@ -0,0 +1,90 @@
+# Orden
+
+A simple library (~ 40 LOC) to generate sorting links via
+query strings for example: `http://www.example.com/?sort_attr=id&sort_dir=asc`.
+
+The only dependency of this library is *Rack* so it should work in your Rack
+compatible framework of choice (Cuba, Rails, Roda, Sinatra, etc).
+
+The typical use case for the library is column sorting on html tables.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'orden'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install orden
+
+## Usage
+
+You need to instantiate an `Orden` object in the context of the current
+request, for this you need to pass a Rack::Request or similiar (Roda typical '`r`'
+object, `request` object inside a Rails controller, etc).
+
+```ruby
+Orden.new([request_object], [default sort attr], [default order (asc/desc)])
+```
+
+For example:
+
+```ruby
+@sorter = Orden.new(r, "id", "desc")
+```
+
+In your views you can now call:
+
+```ruby
+@sorter.sort_path([attr])
+```
+
+For example in a table header:
+
+```eruby
+<th><a href="<%= @sorter.sort_path "id" %>">ID</a></th>
+<th><a href="<%= @sorter.sort_path "name" %>">Name</a></th>
+```
+
+and it will generate the expected path to sort your results using that
+attribute for example (/users?sort_attr=id&sort_dir=asc).
+
+## Security
+
+Take into account that this library does not apply any type of sanitation to
+the received parameters. Typically sorting attributes should be filtered or
+white listed someway before applying them to an SQL query or equivalent.
+
+For example you can create a helper such as:
+
+```ruby
+module SortHelper
+  def sort_sql(sorter, attr_whitelist)
+    if attr_whitelist.include?(sorter.current_attribute)
+      "#{sorter.current_attribute} #{sorter.current_direction}"
+    else
+      "#{sorter.default_attr} #{sorter.default_dir}"
+    end
+  end
+end
+```
+
+and the use it in an ActiveRecord query:
+
+```ruby
+@sorter = Orden.new(req, "id", "desc")
+@users = User.order(sort_sql(@sorter, User::SORTABLE_ATTRIBUTES)).
+```
+
+Please take this as an example, this code may not be secure.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/manuca/orden.

data/Rakefile

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

data/lib/orden.rb

@@ -0,0 +1,43 @@
+require "orden/version"
+require 'rack/utils'
+
+class Orden
+  attr_reader :default_attr, :default_dir
+
+  def initialize(request, default_attr, default_dir = "asc")
+    @request      = request
+    @default_attr = default_attr
+    @default_dir  = default_dir
+  end
+
+  def current_attribute
+    query_hash["sort_attr"] ? query_hash["sort_attr"] : default_attr
+  end
+
+  def current_direction
+    query_hash["sort_dir"] ? query_hash["sort_dir"] : default_dir
+  end
+
+  def sort_path(attr)
+    h = query_hash.dup
+    h["sort_attr"] = attr
+
+    if attr == current_attribute
+      h["sort_dir"] = opposite(current_direction)
+    else
+      h["sort_dir"] = "asc"
+    end
+
+    "#{@request.path}?#{Rack::Utils.build_query(h)}"
+  end
+
+  private
+
+  def opposite(direction)
+    direction == "asc" ? "desc" : "asc"
+  end
+
+  def query_hash
+    @_query_hash ||= Rack::Utils.parse_query(@request.query_string)
+  end
+end

data/lib/orden/version.rb

@@ -0,0 +1,3 @@
+class Orden
+  VERSION = "0.1.1"
+end

data/orden.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'orden/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "orden"
+  spec.version       = Orden::VERSION
+  spec.authors       = ["Manuel Barros Reyes"]
+  spec.email         = ["manuca@gmail.com"]
+
+  spec.description   = %q{A tiny helper to sort columns in Rack apps}
+  spec.summary       = %q{It relies exclusively on Rack to parse and rewrite query strings so no extra dependencies are required}
+  spec.homepage      = "https://github.com/manuca/orden"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rack", "~> 1.6"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: orden
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Manuel Barros Reyes
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: A tiny helper to sort columns in Rack apps
+email:
+- manuca@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- lib/orden.rb
+- lib/orden/version.rb
+- orden.gemspec
+homepage: https://github.com/manuca/orden
+licenses: []
+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.5
+signing_key: 
+specification_version: 4
+summary: It relies exclusively on Rack to parse and rewrite query strings so no extra
+  dependencies are required
+test_files: []