sortabl 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7baca944a6f0e4b3e4c0e29515c4815b2ec536b5
+  data.tar.gz: 31383da19f0286990e1221152403a7de85d78c02
+SHA512:
+  metadata.gz: 7933a2a368fd102bed12e92897e3ccc3c695843e6f298a4af341915a1172d3fbf8509057824fb06e937b671727630a1876e6100720b46087d717e8f7500ee56c
+  data.tar.gz: 7e59e61941464ab223a82df9ffa7efa128bb0d4347f74f890a7701349a952444390b2111e6b5c5fdc27255501118436f43bb2833eb18fb489a2b0a7a743558b0

data/README.md

@@ -0,0 +1,75 @@
+# Sortabl
+
+A Rails Plugin to simplify sorting tables.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sortabl'
+```
+
+## Basic Usage
+
+### Controller
+
+```ruby
+@posts = Post.sortabl(sort_by: params[:sort])
+```
+
+And that's it! Records will be sorted by permitted parameter `:sort`. If parameter `:sort` isn't permitted, records will be sorted by primary key. The `default` key can be also set as argument. Like:
+
+```ruby
+@posts = Post.sortable(sort_by: params[:sort], default: :author)
+```
+
+Permitted values can be every attribute of model class followed by `_asc` or `_desc`. For example: `sort: :author_asc`
+If there's an attribute permitted which doesn't exist in model, it falls back to sort by `default` key. Attributes can be limited with `only` and `except`. For example:
+
+```ruby
+@posts = Post.sortabl(sort_by: params[:sort], only: [:title, :author])
+# or
+@posts = Post.sortabl(sort_by: params[:sort], except: [:text])
+```
+
+
+### View
+
+There's also a view helper for rendering table heads:
+
+```erb
+<table>
+	<thead>
+		<%= render_th 'Author', :author, id: 'author-column', class: 'author-column' %>
+	</thead>
+	<tbody>
+		...
+	</tbody>
+</table>
+
+# Will be rendered to:
+<table>
+	<thead>
+		<th id="author-column" class="author-column"><a href="/posts?sort=author_asc">Author<i class="fa fa-sort"></i></a></th>
+		# or
+		<th id="author-column" class="author-column"><a href="/posts?sort=author_desc">Author<i class="fa fa-sort-asc"></i></a></th>
+		# or
+		<th id="author-column" class="author-column"><a href="/posts">Author<i class="fa fa-sort-desc"></i></a></th>
+	</thead>
+	<tbody>
+		...
+	</tbody>
+</table>
+```
+
+Which hyperlink will be rendered, depends on permitted values.
+For now, this gem uses [font-awesome-rails](https://github.com/bokmann/font-awesome-rails) for placing icons. So you may want to install font-awesome gem to your project as well. More icon libaries will be supported in future.
+Gem works also fine with pagination like [will_paginate](https://github.com/mislav/will_paginate).
+
+Happy sorting ;)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/lib/sortabl/sortabl_core.rb

@@ -0,0 +1,60 @@
+module Sortabl
+	module ActiveRecordExtensions
+		module Sortabl
+
+			extend ActiveSupport::Concern
+
+			# class Base
+			module ClassMethods
+
+				def sortabl *args
+					# Init
+					default = args[0][:default].to_s if args
+					only = args[0][:only]
+					except = args[0][:except]
+					sort_params = {}
+
+					raise "Invalid Parameters: Do not use 'only' and 'except' together!" if only.present? and except.present?
+
+					# Set default order attribute
+					# default:
+					#
+					order_by_default = default.present? ? default : self.primary_key
+
+					case true
+						# List only attributes
+						# only:
+						#
+						when only.present?
+							(only.map(&:to_s)).each do |attribute|
+								sort_params[attribute + '_asc'] = "#{attribute} asc"
+								sort_params[attribute + '_desc'] = "#{attribute} desc"
+							end
+
+						# List class attributes without excepts
+						# except:
+						#
+						when except.present?
+							(self.column_names - except.map(&:to_s)).each do |attribute|
+								sort_params[attribute + '_asc'] = "#{attribute} asc"
+								sort_params[attribute + '_desc'] = "#{attribute} desc"
+							end
+
+						# List class attribtues
+						#
+						else
+							self.column_names.each do |attribute|
+								sort_params[attribute + '_asc'] = "#{attribute} asc"
+								sort_params[attribute + '_desc'] = "#{attribute} desc"
+							end
+					end
+
+					# Order class object
+					order((sort_params[args[0][:sort_by]] or "#{order_by_default} asc"))
+				end
+
+			end
+
+		end
+	end
+end

data/lib/sortabl/sortabl_helper.rb

@@ -0,0 +1,44 @@
+module Sortabl
+	module ActionViewExtensions
+		module SortablHelper
+
+			# Renders table head
+			# Uses fontawesome as default icons
+			# <th 'data-sortable': 'attribute_direction'>Name <i class='fa fa-...'></th>
+			#
+			def render_th name, attribute, *args
+
+				# To provide full path with all given params
+				# make a copy of incoming params and override sort_param only
+				sort_params = params.except(:sort)
+
+				# Set default sort path
+				sort_params[:sort] = "#{attribute}_asc"
+
+				# if there is already a sort param set, invert or remove sort direction
+				if params[:sort].present?
+
+					# if sort param match current attribute, change direction
+					if attribute.to_s == params[:sort].gsub(/(_asc$|_desc$)/, '')
+
+						sort_direction = params[:sort].gsub(/^((?!desc$|asc$).)*/, '')
+
+						sort_params[:sort] = "#{attribute}_desc" 	if sort_direction == 'asc'
+						sort_params[:sort] = nil 									if sort_direction == 'desc'
+
+					end
+				end
+
+				# Generate HTML Code
+				html = <<-HTML
+			    <th id="#{args[0][:id] if args.present?}" class="#{args[0][:class] if args.present?}" #{args[0].map{ |k,v| "#{k}='#{v}'" unless (k.to_s =~ /^data-(.*)$/).nil? }.join(' ') if args.present?}>
+			    	<a href='#{url_for(sort_params)}'>#{name}<i class='fa fa-sort#{sort_direction.present? ? "-#{sort_direction}" : ""}'></i></a>
+			    </td>
+		    HTML
+
+		    html.html_safe
+			end
+
+		end
+	end
+end

data/lib/sortabl/version.rb

@@ -0,0 +1,3 @@
+module Sortabl
+  VERSION = "0.1.0"
+end

data/lib/sortabl.rb

@@ -0,0 +1,9 @@
+require "sortabl/version"
+require "sortabl/sortabl_core"
+require "sortabl/sortabl_helper"
+
+# Extend ActiveRecord's functionality
+ActiveRecord::Base.send :include, Sortabl::ActiveRecordExtensions::Sortabl
+
+# You can do this here or in a Railtie
+ActionView::Base.send :include, Sortabl::ActionViewExtensions::SortablHelper

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: sortabl
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Frederic Walch
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Check github repository for more in-depth information.
+email:
+- frederic.walch@informatik.hu-berlin.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/sortabl.rb
+- lib/sortabl/sortabl_core.rb
+- lib/sortabl/sortabl_helper.rb
+- lib/sortabl/version.rb
+homepage: https://github.com/freder1c/sortabl
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Active Record plugin which helps and simplify sorting tables.
+test_files: []