sortofil 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5e8184e9c2392eff97ce32bc7b6adebfc72c97b4
+  data.tar.gz: '01387c3d6ac9002adf88d132a9ad3602f9301ace'
+SHA512:
+  metadata.gz: 5c9bdfdc10031c61269e964610860ab1ed923cea9b51cd4abc427e79008dfca4c82346beefd7ec634772f03f09d10e3cc64ae463625ffb1e0c327e21073612d8
+  data.tar.gz: 3e379f420ed934e77d8016a227c49effbd92b1429409ce394f2305abe26d92bb0f10ce3fea2854ed72e41dfb36f2b316e02dcee573ac5262088bc507df6175e8

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Rinat Garifullin
+
+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,135 @@
+# Sortofil
+Sortofil - sort and filter helper for Rails app
+
+Features:
+* sortable table headers
+* restore url query params during session
+
+## Usage
+
+### Sort/filter
+Add this to controller:
+```ruby
+include Sortofilterable
+
+before_action :permit_params
+before_action :set_default_sort_opts
+```
+Customize options (override methods inside controller):
+* Simple case:
+
+```ruby
+def set_default_sort_field
+  @default_sort_field = { nil => :created_at }
+end
+
+def set_default_sort_direction
+  @default_sort_direction = { nil => :desc }
+end
+
+def permit_params
+  @permitted_params = params.permit(sort_params, filter_params,
+                                    pagination_params, :your_additional_param)
+end
+```
+
+* Multiple models per page case:
+
+```ruby
+def set_default_sort_field
+  @default_sort_field = { artists: :first_name, authors: :last_name }
+end
+
+def set_default_sort_direction
+  @default_sort_direction = { artists: :asc, authors: :desc }
+end
+
+def permit_params
+  @permitted_params = params.permit({ artists: sort_params + filter_params,
+                                      authors: sort_params + filter_params },
+                                    pagination_params)
+end
+```
+
+View
+
+* Simple case:
+
+```html
+<table>
+  <thead>
+    <th>
+      <%= render 'layouts/sortable_theader', model: 'artists' %>
+    </th>
+  </thead>
+  <tbody>
+    ...
+  </tbody>
+</table>
+```
+
+* Multiple models per page case:
+
+```html
+<table>
+  <thead>
+    <th>
+      <%= render 'layouts/sortable_theader', model: 'artists', scoped: true,
+                                             url: 'root' %>
+    </th>
+  </thead>
+  <tbody>
+    ...
+  </tbody>
+</table>
+
+<table>
+  <thead>
+    <th>
+      <%= render 'layouts/sortable_theader', model: 'authors', scoped: true,
+                                             url: 'root' %>
+    </th>
+  </thead>
+  <tbody>
+    ...
+  </tbody>
+</table>
+```
+
+### Url restore
+
+Add this to controller:
+```ruby
+include UrlRestorable
+
+before_action do
+  restore_url_params(:your_key)
+end
+```
+
+View
+
+```html
+<%= render 'layouts/restorable_url_params', key: :your_key %>
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sortofil'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install sortofil
+```
+
+
+## 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,27 @@
+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    = 'Sortofil'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/javascripts/filter_restore.js

@@ -0,0 +1,17 @@
+const filterRestore = function filterRestoreUrl() {
+  var str = document.getElementById('url_params').value;
+  if (str) {
+    var updated_url = location.pathname + '?' + encodeURI(str);
+    var page = location.search.match(/page=\d+/);
+    if (page) {
+      updated_url += '&' + page;
+    }
+    history.replaceState({}, document.title, updated_url);
+  }
+};
+
+document.onreadystatechange = function() {
+  if (document.readyState === 'interactive') {
+    filterRestore();
+  }
+};

data/app/controllers/concerns/sortofilterable.rb

@@ -0,0 +1,48 @@
+# Sort and filter
+module Sortofilterable
+  extend ActiveSupport::Concern
+
+  included do
+    private
+
+    def filter_params
+      []
+    end
+
+    def sort_params
+      %i[sort_by direction]
+    end
+
+    def pagination_params
+      %i[page]
+    end
+
+    def set_default_sort_opts
+      set_default_sort_field
+      set_default_sort_direction
+    end
+
+    def set_default_sort_field
+      @default_sort_field = { nil => :id }
+    end
+
+    def set_default_sort_direction
+      @default_sort_direction = { nil => :asc }
+    end
+
+    def sort_field(scope = nil)
+      params.dig(scope, :sort_by) || params[:sort_by] ||
+        @default_sort_field[scope]
+    end
+
+    def sort_direction(scope = nil)
+      params.dig(scope, :direction) || params[:direction] ||
+        @default_sort_direction[scope]
+    end
+
+    def permit_params
+      @permitted_params = params.permit(sort_params, filter_params,
+                                        pagination_params)
+    end
+  end
+end

data/app/controllers/concerns/url_restorable.rb

@@ -0,0 +1,43 @@
+# Restore url query params between requests
+module UrlRestorable
+  extend ActiveSupport::Concern
+
+  included do
+    private
+
+    def restore_url_params(key_prefix)
+      key = "#{key_prefix}_url_params"
+      if @permitted_params
+        params_wo_paging = @permitted_params.reject do |k, _|
+          pagination_params.include?(k.to_sym)
+        end
+      end
+      all_params = params_wo_paging ||
+                   params.permit(filter_params + sort_params)
+
+      if params[:reset_url]
+        if params[:reset_url] == 'all'
+          session[key] = nil
+        else
+          session[key] = Rack::Utils.parse_nested_query(session[key])
+                                    .except(params[:reset_url]).to_query
+        end
+      elsif session[key].blank?
+        session[key] = all_params.to_h.to_query
+      end
+
+      return if session[key].blank?
+
+      new_params = Rack::Utils.parse_nested_query(session[key])
+                              .merge(deep_transform(all_params.to_h))
+      session[key] = new_params.to_query
+      params.merge!(new_params)
+    end
+
+    def deep_transform(hash)
+      hash.transform_values do |val|
+        val.is_a?(String) ? val : val.transform_values { |vv| vv }
+      end
+    end
+  end
+end

data/app/views/layouts/_restorable_url_params.html.erb

@@ -0,0 +1,3 @@
+<%= hidden_field_tag :url_params, session["#{key}_url_params".to_sym] %>
+
+<%= javascript_include_tag 'filter_restore' %>

data/app/views/layouts/_sortable_theader.html.erb

@@ -0,0 +1,56 @@
+<% scope = model.to_sym if defined?(scoped) %>
+
+<% if params.dig(scope, :direction).present? %>
+  <% if params.dig(scope, :direction) == 'asc' %>
+    <% direction = 'asc' %>
+    <% next_direction = 'desc' %>
+  <% else %>
+    <% direction = 'desc' %>
+    <% next_direction = 'asc' %>
+  <% end %>
+<% elsif params[:direction] %>
+  <% direction = params[:direction] %>
+  <% next_direction = direction == 'asc' ? 'desc' : 'asc' %>
+<% else %>
+  <% direction = @default_sort_direction[scope] %>
+  <% next_direction = @default_sort_direction[scope] == :asc ? :desc : :asc %>
+<% end %>
+
+<% if scope %>
+  <% if @permitted_params[scope] %>
+    <% sort_params = { "#{scope}".to_sym => @permitted_params[scope]
+                         .merge(direction: next_direction, sort_by: column) } %>
+  <% else %>
+    <% sort_params = { "#{scope}".to_sym => { direction: next_direction,
+                                              sort_by: column } } %>
+  <% end %>
+<% else %>
+  <% sort_params = @permitted_params.merge(direction: next_direction,
+                                           sort_by: column) %>
+<% end %>
+
+<% i18_scope ||= model %>
+<% header = t("#{i18_scope}.#{scope || model}.#{column}", default: '') %>
+<% if header.empty? %>
+  <% header = Object.const_get(model.singularize.capitalize)
+                    .human_attribute_name(column) %>
+<% end %>
+
+<% url ||= model %>
+<%= link_to url_for([url, params: sort_params.to_h]) do %>
+  <%= header %>
+  <% if params.dig(scope, :sort_by).present? %>
+    <% if params.dig(scope, :sort_by) == column.to_s %>
+      &nbsp;
+      <i class="fa fa-sort-<%= direction %>"></i>
+    <% end %>
+  <% elsif params[:sort_by].present? %>
+    <% if params[:sort_by] == column.to_s %>
+      &nbsp;
+      <i class="fa fa-sort-<%= direction %>"></i>
+    <% end %>
+  <% elsif @default_sort_field[scope] == column %>
+    &nbsp;
+    <i class="fa fa-sort-<%= direction %>"></i>
+  <% end %>
+<% end %>

data/lib/sortofil/engine.rb

@@ -0,0 +1,8 @@
+module Sortofil
+  # Use assets pipeline
+  class Engine < ::Rails::Engine
+    initializer 'Sortofil precompiled assets', group: :all do |app|
+      app.config.assets.precompile += %w[filter_restore.js]
+    end
+  end
+end

data/lib/sortofil/version.rb

@@ -0,0 +1,3 @@
+module Sortofil
+  VERSION = '0.1.0'.freeze
+end

data/lib/sortofil.rb

@@ -0,0 +1,2 @@
+require 'sortofil/engine' if defined? Rails::Railtie
+require 'font-awesome-rails'

data/lib/tasks/sortofil_tasks.rake

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

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: sortofil
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rinat Garifullin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: font-awesome-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: poltergeist
+  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'
+- !ruby/object:Gem::Dependency
+  name: puma
+  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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: Set of sort and filter helpers
+email:
+- ringarifullin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/filter_restore.js
+- app/controllers/concerns/sortofilterable.rb
+- app/controllers/concerns/url_restorable.rb
+- app/views/layouts/_restorable_url_params.html.erb
+- app/views/layouts/_sortable_theader.html.erb
+- lib/sortofil.rb
+- lib/sortofil/engine.rb
+- lib/sortofil/version.rb
+- lib/tasks/sortofil_tasks.rake
+homepage: https://github.com/rgarifullin/sortofil
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Sorting and filtering tool
+test_files: []