sortabl 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc5b7d426b26777c5cbe848607372226a88e9373
-  data.tar.gz: 09680458a7901a7b4a1bfc6210fa67a23e7ac927
+  metadata.gz: 6552e6114146c0cc491795f78cd3f0f1ac2aa6eb
+  data.tar.gz: 8e7e1d4f7152d281b8dac36e425d6fd638ead641
 SHA512:
-  metadata.gz: 38d58995baff555155b23b02b5020037fe92d15cd322b04731e2202b4f0801616bcd7da4872226b945b2fab012ef1fbc713913b3c60fb0157a1799c57d9fb8f8
-  data.tar.gz: c4373fd8cffee63ee7029ad0f18031f93cfd510a5b1af26962a0dd8de578dda095033c71a41f559b21f5245a91f6ca097126cd73f1d7aed8b3ec910115c57cf1
+  metadata.gz: 1b9e88c7c059746cbd2a658cff301d44ec16f4c67591e1bcff19f2d7d569518cb5bfefc94b5dada03e9d440a037fdec4d095cb0ac18100e33c9098b0593f1345
+  data.tar.gz: 6fe778b7169244eaf6da36650c82be5b50f2b19c7adfc365f583047f9f98cff0cf4300fbf3a5b6b02ad67d20c0686999ad6481d132a56fcf4369b6530926a6fe

data/README.md

@@ -0,0 +1,109 @@
+# Sortabl
+
+A Rails Plugin to simplify sorting tables.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sortabl'
+```
+
+## Basic Usage
+
+### Controller
+
+#### Default
+
+```ruby
+@posts = Post.sortabl(params[:sortabl])
+```
+
+And that's it! Records will be sorted by permitted parameter `:sortabl`. If parameter `:sortabl` isn't permitted, records will be sorted by primary key. If you don't want to sort by primary key as default, you can set another one by:
+
+```ruby
+@posts = Post.sortabl(params[:sortabl], default: [author: :asc])
+```
+
+Even default multiple columns sort is possible:
+
+```ruby
+@posts = Post.sortabl(params[:sortabl], default: [author: :asc, created_at: :desc])
+```
+
+#### Limeted Attributes
+
+Permitted values can be an 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(params[:sortabl], only: [:title, :author])
+# or
+@posts = Post.sortabl(params[:sortabl], except: [:text])
+```
+
+#### Sort by associations
+
+
+
+### View
+
+#### Link Helper
+
+There's also a link helper, which generates needed urls. It works just like you would expect from rails default link_to helper. But instead of hand over a path, just place the desired column name. The helper will do the rest for you:
+
+```erb
+<table>
+  <thead>
+    <th><%= sortabl_link 'Author', :author, id: 'author-column', class: 'author-column' %></th>
+  </thead>
+  <tbody>
+    ...
+  </tbody>
+</table>
+
+# Will be rendered to:
+<table>
+  <thead>
+    <th><a id="author-column" class="sortabl author-column" href="/posts?sortabl=author_asc">Author</a></th>
+    # or
+    <th><a id="author-column" class="sortabl asc author-column" href="/posts?sortabl=author_desc">Author</a></th>
+    # or
+    <th><a id="author-column" class="sortabl desc author-column" href="/posts">Author</a></th>
+  </thead>
+  <tbody>
+    ...
+  </tbody>
+</table>
+```
+
+This link helper can be placed anywhere in the view. There is no need, that it has to be placed in table head. Furthermore you can use `sortabl_link` as block too.
+
+```erb
+<%= sortabl_link :author, id: 'author-column', class: 'author-column' do %>
+  <p>Author</p>
+<% end %>
+```
+
+#### Parameter
+
+By default, `sortabl_link` will generate `:sortabl` as parameter into the url. If you need to change name of the parameter, you can do so by simply:
+
+```ruby
+# In view
+<%= sortabl_link 'Author', :author, sort_param: :my_custom_sort_param %>
+
+# In controller
+@posts = Post.sortabl(params[:my_custom_sort_param], only: [:title, :author])
+```
+
+Which hyperlink will be rendered, depends on permitted values.
+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.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
+
+# Extend ActionViews's functionality
+ActionView::Base.send :include, Sortabl::ActionViewExtensions::SortablHelper

data/lib/sortabl/sortabl_core.rb

@@ -0,0 +1,53 @@
+module Sortabl
+  module ActiveRecordExtensions
+    module Sortabl
+
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+
+        def sortabl parameter, *args
+
+          # Init
+          unless args.empty?
+            default = args[0][:default]
+            only = args[0][:only]
+            except = args[0][:except]
+          end
+
+          raise ArgumentError.new("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
+
+          # Extract column name and direction from parameter
+          if parameter.present?
+            column_name = parameter.to_s.gsub(/(_asc$|_desc$)/, '')
+            direction = parameter.to_s.gsub(/^((?!desc$|asc$).)*/, '')
+
+            # Sort by default if column_name is not included in only or column_name is included in except
+            return order((order_by_default)) if only.present? and !only.include? column_name.to_sym
+            return order((order_by_default)) if except.present? and except.include? column_name.to_sym
+          end
+
+          if column_name.present? and direction.present?
+            if column_name.include? "."
+              # Sort by associated column
+              # Note: alias attributes not supported yet
+              sort_column = "#{column_name} #{direction}"
+            else
+              # Convert param_value to symbol to support alias attributes
+              sort_column = { column_name.to_sym => direction.to_sym }
+            end
+          end
+
+          # Order class object
+          order((sort_column or order_by_default))
+        end
+
+      end
+
+    end
+  end
+end

data/lib/sortabl/sortabl_helper.rb

@@ -0,0 +1,45 @@
+module Sortabl
+  module ActionViewExtensions
+    module SortablHelper
+
+      # Renders sortabl link
+      #
+      def sortabl_link(name = nil, attribute = nil, html_options = nil, &block)
+        html_options, attribute, name = attribute, name, block if block_given?
+        html_options = html_options || {}
+
+        # Support custom sort_param
+        # If sort_param isn't given, fall back to :sortabl as param
+        sort_param = html_options[:sort_param] || :sortabl
+        html_options.except!(:sort_param)
+
+        # Remove current sortabl param from url and add default sortabl param
+        sortabl_params = params.permit!.except(sort_param)
+        sortabl_params[sort_param] = "#{attribute}_asc"
+
+        # If there was already a sortabl param, invert direction or remove sortabl param
+        if params[sort_param].present?
+          if attribute.to_s == params[sort_param].gsub(/(_asc$|_desc$)/, '')
+            sort_direction = params[sort_param].gsub(/^((?!desc$|asc$).)*/, '')
+
+            sortabl_params[sort_param] = "#{attribute}_desc"  if sort_direction == 'asc'
+            sortabl_params[sort_param] = nil                  if sort_direction == 'desc'
+          end
+        end
+
+        # Add sortabl html class to html_options
+        html_options[:class] = 'sortabl' + (sort_direction.present? ? " #{sort_direction}" : "") + (html_options[:class].present? ? " #{html_options[:class]}" : "")
+
+        # Support remote true
+        html_options.except!(:remote).merge!({'data-remote': 'true'}) if html_options[:remote]
+
+        # Generate url from params
+        url = url_for(sortabl_params)
+        html_options["href".freeze] ||= url
+
+        content_tag("a".freeze, name || url, html_options, &block)
+      end
+
+    end
+  end
+end

data/lib/sortabl/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sortabl
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Frederic Walch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-29 00:00:00.000000000 Z
+date: 2017-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -74,42 +74,42 @@ dependencies:
   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.
@@ -118,7 +118,12 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-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
@@ -139,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Active Record plugin which helps and simplify sorting tables.