rails_flexible_sorting 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1af6b0108199dd25e47d94a8f0cbeb4b4f0c2d932c20f1b5c94fbb6ca2bb46fd
-  data.tar.gz: db3f2a139a2934f1d5561709fa0d9e06f279a8b3b3cff6c528b0d9c0acb3a5d4
+  metadata.gz: 244b204e49fa2de839259919c3f13e3bd51529982270c96ae01bb2fe4d027883
+  data.tar.gz: d74868461a9410dddd9a94db9cd9dde54b51692b082b3ed81adeef770929fe58
 SHA512:
-  metadata.gz: 16d966fcf846d2f5ce78e4b7a48bab9beea98d1b158c8d4d19de025d624194d6aa0d92519b97223be42e90c68d32f96ddfe34051b403e2f0dd38b25de41a7344
-  data.tar.gz: 813d644febf6b448b7c28a8a8f750aaed368e3ee494f21b1e0570fe56bfb9fd90e29398faa9b97d4fe3bf178d10745cd98e1d9c817018750ad20b110f01e2cea
+  metadata.gz: 4e6e5964437041df7b4bca58e39a4d78bb97ee3788af52397535d0e11df4db59b603af99a054c090fd51af54a9b527179a61dc4249d5784ae55ab0e7f9b290c9
+  data.tar.gz: 294bf3a90feed2df35af3b906c34556d1399a5424b5d96454cfd4951eca29bac0fe34e9e10ef12a10687ac5b86434d6b569f2f6cb0993a1c54eba5acbb1f6788

data/README.md

@@ -0,0 +1,71 @@
+# FlexibleSorting
+
+## Description
+Simple gem for sorting data in HTML tables
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "rails_flexible_sorting"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_flexible_sorting
+
+## Usage
+
+```
+class User < ApplicationRecord
+  include FlexibleSorting::Model
+  
+  belongs_to :service
+  scope :sorted_by_service, -> { all.sort_by { |service| service.method } }
+
+  sortable :id, :updated_at, :email
+  sortable :profile_name, -> { joins(:profile) }, column: "profiles.name"
+  sortable :network, -> { sorted_by_service }, virtual: true
+  sortable :company, -> (obj, name) { obj.company_label_for(name) }, virtual: true, as_instance_method: true
+  sortable :state, -> (obj) { obj.state_label }, virtual: true, as_instance_method: true
+
+  def company_label_for(name)
+    # do something and return value
+  end
+
+  def state_label
+    # do something and return value
+  end  
+end
+```
+
+In Views
+
+```
+<th><%= sortable :email, default: true %></th>
+<th><%= sortable :updated_at, direction: :desc %></th>
+<th>
+  <%= sortable :profile_name do %>
+    Custom label
+  <% end %>
+</th>
+```
+If you want customize how arrows are generated copy `views/lexible_sorting/_label.html.erb`
+and change how you want.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/madmax/sortable-for-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SortableForRails project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/madmax/sortable-for-rails/blob/master/CODE_OF_CONDUCT.md).

data/app/helpers/flexible_sorting/sortable_helper.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module FlexibleSorting::SortableHelper
+  def sortable(column, default: false, direction: :asc, scope: nil, **options, &block)
+    current = column.to_s == params[:sort] || params[:sort].blank? && default
+    current_direction = (params[:direction] || direction).to_s
+
+    new_direction = direction.to_s
+    if current
+      new_direction = current_direction.to_s == "asc" ? "desc" : "asc"
+    end
+
+    url = url_for params.permit!.merge(sort: column, direction: new_direction)
+
+    link_to(url, options) do
+      label = block_given? ? capture(&block) : column
+      sortable_label_for(label, current, current_direction, scope)
+    end
+  end
+
+  def sortable_label_for(label, active, direction, scope)
+    render "flexible_sorting/label", label: label, active: active, direction: direction, scope: scope
+  end
+end

data/app/views/flexible_sorting/_label.html.erb

@@ -0,0 +1,13 @@
+<% if label.is_a?(Symbol) %>
+  <%= t label, scope: scope %>
+<% else %>
+  <%= label %>
+<% end %>
+
+<% if active %>
+  <% if direction == "asc" %>
+    <i class="fas fa-chevron-up"></i>
+  <% else %>
+    <i class="fas fa-chevron-down"></i>
+  <% end %>
+<% end %>

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rails_flexible_sorting"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/flexible_sorting.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+module FlexibleSorting
+  module Model
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def sortable(*args)
+        @sortable ||= []
+        @sortable << args unless args.empty?
+        @sortable
+      end
+
+      def sorting(column, direction = :asc, args = [])
+        FlexibleSorting::Sort.new(self, column, direction, args).all
+      end
+    end
+  end
+
+  class Column
+    attr_reader :name, :column, :scope, :virtual, :as_instance_method, :method_args
+    def initialize(name, scope = nil, column: name, virtual: false, as_instance_method: false)
+      @name = name
+      @column = column
+      @scope = scope
+      @virtual = virtual
+      @as_instance_method = as_instance_method
+    end
+  end
+
+  class Sort
+    attr_reader :scope
+
+    def initialize(scope, column, direction, args = [])
+      @scope = scope
+      @column = column
+      @direction = direction
+      @args = args
+    end
+
+    def columns
+      @columns = create_columns
+    end
+
+    def all
+      all = scope.all
+
+      if column
+        if column.scope.is_a?(Proc) && column.virtual && column.as_instance_method
+          all = all.sort_by { |e| column.scope.call(*[e, *args]) }
+        elsif column.scope.present?
+          all = all.merge(column.scope)
+        end
+
+        if column.virtual
+          all.reverse! if direction == "desc"
+        else
+          all = all.order("#{column.column} #{direction}")
+        end
+      end
+
+      all
+    end
+
+    def direction
+      @direction.to_s == "desc" ? "desc" : "asc"
+    end
+
+    def column
+      columns[@column.to_s]&.first
+    end
+
+    def create_columns
+      scope.sortable.flat_map do |columns|
+        columns = [columns] unless columns.all? { |column| column.is_a?(Symbol) }
+        columns.map { |column| Column.new(*column) }
+      end.group_by { |column| column.name.to_s }
+    end
+
+    private
+
+    attr_reader :args
+  end
+end

data/lib/rails_flexible_sorting.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "flexible_sorting"
+
+module RailsFlexibleSorting
+  class Engine < Rails::Engine
+  end
+end

data/rails_flexible_sorting.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_flexible_sorting"
+  spec.version       = "1.0.2"
+  spec.authors       = ["Marcin Brysz"]
+  spec.email         = ["bryszmarcin@gmail.com"]
+
+  spec.summary       = %q{Allow easy sorting tables tables in rails}
+  spec.description   = %q{Allow easy sorting tables tables in rails}
+  spec.homepage      = "https://github.com/Marcin81/rails_flexible_sorting"
+  spec.license       = "MIT"
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", ">= 5.2"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_flexible_sorting
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Marcin Brysz
@@ -72,12 +72,21 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
-homepage: https://rubygems.org/gems/rails_flexible_sorting
+files:
+- README.md
+- app/helpers/flexible_sorting/sortable_helper.rb
+- app/views/flexible_sorting/_label.html.erb
+- bin/console
+- bin/setup
+- lib/flexible_sorting.rb
+- lib/rails_flexible_sorting.rb
+- rails_flexible_sorting-1.0.1.gem
+- rails_flexible_sorting.gemspec
+homepage: https://github.com/Marcin81/rails_flexible_sorting
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://rubygems.org/gems/rails_flexible_sorting
+  homepage_uri: https://github.com/Marcin81/rails_flexible_sorting
 post_install_message: 
 rdoc_options: []
 require_paths: