sortable_by 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b73a5ddc646d2e3c337439264cb4ca123aa3e30e
+  data.tar.gz: 5790ac2d41f873ebaffe8e2a20a7329ee667f180
+SHA512:
+  metadata.gz: fd6f579e3c5b90e976c23be7f5c03192d5fa816e1dbf7ee466d7df1ea02b13ab3eae36275fec8b6fa2278c791c68b16511f706ac36a0105415f2c62e12317d02
+  data.tar.gz: ec9f53443ec60403476953b6f8beabf3982ea7342f5134adf725f1ce3c247d07ce4af80fdb29379308fc22470022676ba6f007f2a4f4a93385bd526247b504cb

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Greg Woods
+
+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,70 @@
+# SortableBy
+
+Add sortable table headers to your views and connect them to ActiveRecord queries in your controller.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sortable_by'
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+### Example Usage
+
+In your view, the `sortable_table_header` helper method will generate a `<thead>` element with header tags.
+
+```erb
+<%= sortable_table_header :users_path do |t| %>
+  <%= t.sortable :full_name %>
+  <%= t.sortable :email %>
+  <%= t.sortable :birth_date %>
+  <%= t.header :favorite_color %>
+  <th>Plain HTML is fine too</th>
+<% end %>
+```
+
+See [table_helper.rb](./app/helpers/sortable_by/table_helper.rb) for options.
+
+In your controller, use the `sortable_by` method to configure sorting attributes.
+
+```ruby
+class MyController < ApplicationController
+  # Configure the sortable attributes
+  sortable_by :email,                               # A basic sort
+              full_name: [:last_name, :first_name], # This will sort on two columns
+              birth_date: 'birth_dates.date :dir',  # This will sort on a joined table
+              default: :email                       # The sort to use when none is passed
+              direction: :desc                      # Initial sort direction (defaults to :asc)
+
+  def index
+    # Call #sortable_query to produce an ActiveRecord compatible sorting hash
+    MyModel.where(...).order(sortable_query)
+  end
+end
+```
+
+See [params.rb](./app/controllers/concerns/sortable_by/params.rb) for options.
+
+### Icon Support
+
+[Font Awesome](http://fontawesome.io) and [Glyphicons](http://getbootstrap.com/components/#glyphicons) are both supported by default. You can also add your own icon strategy.
+
+```ruby
+module SortableBy::IconStrategy
+  def self.custom(context, dir)
+    "test: #{dir}"
+  end
+end
+```
+
+```erb
+<%= sortable_table_header :users_path, icon: :custom do |t| %>
+  ...
+<% end %>
+```

data/Rakefile

@@ -0,0 +1,32 @@
+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    = 'SortableBy'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+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/controllers/concerns/sortable_by/params.rb

@@ -0,0 +1,83 @@
+module SortableBy
+  module Params
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      attr_accessor :default_sort_attribute
+      attr_accessor :default_sort_dir
+      attr_accessor :sortable_mapping
+
+      # Define attributes you wish to sort by
+      #
+      # This optional configuration method tells the the sortable
+      # helpers how they should map attributes to queries. For
+      # example a "name" sort might need to sort on first and last
+      # name attributes
+      #
+      # The `default` argument, if passed, will determine the
+      # attribute used when no sort param has been passed
+      #
+      # Usage:
+      #
+      # sortable_by :email, name: [:last_name, :first_name]
+      #             default: :email,
+      #             direction: :asc
+      #
+      #
+      def sortable_by(*attributes, **options)
+        @default_sort_attribute = options.delete(:default)
+        @default_sort_dir = options.delete(:direction) || :asc
+        @sortable_mapping = options.merge(attributes.map { |att| [att, att] }.to_h)
+      end
+    end
+
+    # Return the current sort direction
+    #
+    # Defaults to :default_sort_dir for all values other than 'asc' or 'desc'
+    #
+    def sort_direction
+      if ['asc', 'desc'].include?(params[:dir])
+        params[:dir].to_sym
+      else
+        self.class.default_sort_dir
+      end
+    end
+
+    # Return the current sort param
+    #
+    def sort_attribute
+      params[:sort].try(:to_sym) || self.class.default_sort_attribute
+    end
+
+    # Return a hash that can be used in an ActiveRecord order query
+    #
+    # Example:
+    #   MyModel.where(...).order(sortable_query).paginate(...)
+    #
+    def sortable_query
+      return unless sort_attribute
+      normalize_sort_value(
+        sort_attribute,
+        sort_direction
+      )
+    end
+
+    # Translate the sort_by and direction into a sortable hash
+    #
+    def normalize_sort_value(sort_by, direction)
+      mapping = self.class.sortable_mapping[sort_by]
+      if mapping.is_a? Symbol
+        { mapping => sort_direction }
+      elsif mapping.is_a? String
+        mapping.gsub(':dir', sort_direction.to_s)
+      elsif mapping.is_a? Array
+        mapping.map { |att| [att, direction] }.to_h
+      elsif mapping.is_a? Proc
+        mapping.call(direction)
+      else
+        logger.debug("WARNING: Sort attribute '#{sort_by}' is not recognized. Did you mean to pass it to sortable_by?")
+        nil
+      end
+    end
+  end
+end

data/app/helpers/sortable_by/table_helper.rb

@@ -0,0 +1,37 @@
+module SortableBy
+  module TableHelper
+
+    # Build a table header for a model
+    #
+    # * path_helper: The helper method you want to use to generate URLs.
+    # * model: The class we should use for translations (optional)
+    # * permit: Array of request params that are forwarded to the sort links
+    #
+    # Example:
+    #
+    # <%= sortable_header :admin_users_path, model: User do |t| %>
+    #   <%= t.sortable :name %>
+    #   <%= t.sortable :email %>
+    #   <%= t.header :last_login %>
+    #   <th></th>
+    # <% end %>
+    #
+    # Header labels will be pulled from en.yml. To provide a different
+    # label pass the label: option
+    #
+    # Example:
+    #
+    # <%= t.header :name, label: 'Full Name' %>
+    #
+    def sortable_table_header(path_helper, model: nil, permit: [], icon: SortableBy.icon_strategy, &block)
+      header = SortableBy::TableHeader.new(
+        path_helper: path_helper,
+        model: model,
+        params: params.permit(permit.concat(SortableBy.params_list)),
+        context: self,
+        icon: icon)
+      header.capture(block) if block
+      header.to_html
+    end
+  end
+end

data/lib/sortable_by.rb

@@ -0,0 +1,6 @@
+require 'sortable_by/engine'
+
+module SortableBy
+  require 'sortable_by/configuration'
+  require 'sortable_by/table_header'
+end

data/lib/sortable_by/configuration.rb

@@ -0,0 +1,11 @@
+module SortableBy
+  include ActiveSupport::Configurable
+
+  config_accessor :params_list, :icon_strategy
+
+  # List of params to white list
+  self.params_list = [:sort, :dir, :search, :tab]
+
+  # Default icon strategy to be used
+  self.icon_strategy = :glyph
+end

data/lib/sortable_by/engine.rb

@@ -0,0 +1,7 @@
+module SortableBy
+  class Engine < ::Rails::Engine
+    initializer :controller do
+      ActionController::Base.send(:include, SortableBy::Params)
+    end
+  end
+end

data/lib/sortable_by/table_header.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module SortableBy
+  class TableHeader
+    attr_reader :context
+    attr_accessor :header_html
+
+    # Forward view helper methods to the view context
+    delegate :concat, :content_tag, :link_to, to: :context
+
+    def initialize(path_helper:, model: nil, params: {}, context:, icon:)
+      @path_helper = path_helper
+      @model = model
+      @params = params
+      @context = context
+      @icon = icon.to_sym
+    end
+
+    def capture(block)
+      @html = context.capture do
+        block.call(self)
+      end
+    end
+
+    def sortable(attribute, label: nil)
+      content_tag :th, class: classes_for_attribute(attribute) do
+        concat(link_to_for_attribute(attribute, label))
+        concat(sort_arrow_for_attribute(attribute))
+      end
+    end
+
+    def header(attribute, label: nil)
+      label ||= translated_attribute(attribute)
+      content_tag :th, label
+    end
+
+    def to_row
+      content_tag(:tr, @html)
+    end
+
+    def to_html
+      content_tag :thead, to_row, class: 'tb-table-header'
+    end
+
+    private
+
+    def translated_attribute(attribute)
+      if @model
+        @model.human_attribute_name(attribute)
+      else
+        context.t(attribute)
+      end
+    end
+
+    def current_direction
+      @params[:dir] || 'asc'
+    end
+
+    def inverted_direction
+      current_direction == 'asc' ? 'desc' : 'asc'
+    end
+
+    def determine_direction(attribute)
+      if @params[:sort].nil? || @params[:sort] != attribute.to_s
+        'asc'
+      else
+        inverted_direction
+      end
+    end
+
+    def classes_for_attribute(attribute)
+      classes = ['sortable']
+      if @params[:sort] == attribute.to_s
+        classes << 'sortable-active'
+        classes << "sortable-#{current_direction}"
+      end
+      classes.join(' ')
+    end
+
+    def link_to_for_attribute(attribute, label)
+      label ||= translated_attribute(attribute)
+      path = context.send(
+        @path_helper,
+        @params.merge(sort: attribute, dir: determine_direction(attribute))
+      )
+      link_to(label, path)
+    end
+
+    def sort_arrow_for_attribute(attribute)
+      return '' unless @params[:sort] == attribute.to_s
+      IconStrategy.send(@icon, context, current_direction) if IconStrategy.respond_to?(@icon)
+    end
+  end
+
+  module IconStrategy
+
+    def self.fontawesome(context, dir)
+      icon_class = dir == 'asc' ? 'fa-caret-up' : 'fa-caret-down'
+      context.content_tag :i, '', class: "fa #{icon_class}"
+    end
+
+    def self.glyph(context, dir)
+      icon_class = dir == 'asc' ? 'up' : 'down'
+      context.content_tag(:span, '', class: "glyphicon glyphicon-arrow-#{icon_class}")
+    end
+  end
+end

data/lib/sortable_by/version.rb

@@ -0,0 +1,3 @@
+module SortableBy
+  VERSION = '1.0'.freeze
+end

data/lib/tasks/sortable_by_tasks.rake

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

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: sortable_by
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Greg Woods
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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: rspec-rails
+  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: database_cleaner
+  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: simplecov
+  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: rubocop
+  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: This gem adds capabilities to create sortable table headersconnect those
+  headers to a back end ActiveRecord sort query
+email:
+- greg.woods@moserit.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/concerns/sortable_by/params.rb
+- app/helpers/sortable_by/table_helper.rb
+- lib/sortable_by.rb
+- lib/sortable_by/configuration.rb
+- lib/sortable_by/engine.rb
+- lib/sortable_by/table_header.rb
+- lib/sortable_by/version.rb
+- lib/tasks/sortable_by_tasks.rake
+homepage: https://github.com/moser-inc/sortable_by
+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: Simple tool for sorting tables of data in rails
+test_files: []