sortabl 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6c4af3f0e56418608ff656d0f7b6ab202a36ef5
-  data.tar.gz: a33bedac5421960f53ee0f27b8dc75bac744592d
+  metadata.gz: bc5b7d426b26777c5cbe848607372226a88e9373
+  data.tar.gz: 09680458a7901a7b4a1bfc6210fa67a23e7ac927
 SHA512:
-  metadata.gz: 67ce18ed70f06f3b3469245e7e080439005d667dbc5fbeea7358e46fb8341ae0570252203761646734622662d7ecd39d3a10cbf5522dd0a40f7cd3c56bd72d12
-  data.tar.gz: 4d8334f0ce2a0ac8bd694a6c5bfaf9dcef4d60e3f241eef3087f53cf64f82254f68ae1bad46b7993417bd57c9795a73eca5ef4e119b7166607a43a495027888e
+  metadata.gz: 38d58995baff555155b23b02b5020037fe92d15cd322b04731e2202b4f0801616bcd7da4872226b945b2fab012ef1fbc713913b3c60fb0157a1799c57d9fb8f8
+  data.tar.gz: c4373fd8cffee63ee7029ad0f18031f93cfd510a5b1af26962a0dd8de578dda095033c71a41f559b21f5245a91f6ca097126cd73f1d7aed8b3ec910115c57cf1

metadata

@@ -1,57 +1,75 @@
 --- !ruby/object:Gem::Specification
 name: sortabl
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Frederic Walch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-02 00:00:00.000000000 Z
+date: 2016-07-29 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'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: actionview
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -100,12 +118,7 @@ email:
 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
+files: []
 homepage: https://github.com/freder1c/sortabl
 licenses:
 - MIT

data/README.md

@@ -1,106 +0,0 @@
-# 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])
-```
-
-
-### 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/sortabl_core.rb

@@ -1,45 +0,0 @@
-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("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
-
-          # 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
-
-          # Convert param_value to symbol
-          sort_column = { column_name.to_sym => direction.to_sym } if column_name.present? and direction.present?
-
-          # Order class object
-          order((sort_column or order_by_default))
-        end
-
-      end
-
-    end
-  end
-end

data/lib/sortabl/sortabl_helper.rb

@@ -1,45 +0,0 @@
-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.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

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

data/lib/sortabl.rb

@@ -1,9 +0,0 @@
-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