sort_n_params 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bd1573fbc7566ce2ae491362cefd3f22dccde9d976be902997c330da74742b6
-  data.tar.gz: c01022c67d66c8447485447c80e39240f48af5b76b98a01ba78c0cdd1fb4bc44
+  metadata.gz: bf597fdee3ef14cd303a2cc400fef9aa8a85c43ac1aaee3154f97781553db993
+  data.tar.gz: af249d92dd15af32406513f1f090ea51a5fdc57332a86313f5544e0c195ca1dd
 SHA512:
-  metadata.gz: be45cb1183bc65ca216b35db98458d50caf000499e9355f7abe64db6cc0bd9fdcb070332369dc6d40fc71eb046d8ed4906d8e4df308478a13286df7117cb4155
-  data.tar.gz: d7184434ab0d70be2546455201619a0b63e871c317a1b4d1b1f164805533d406d4b02456799ea07c653d2b329d6bbc34bc2c6602c4f75b54ccf50f70a0e6ace2
+  metadata.gz: 4dbfd4f0db84fd233cf2e081b25939b82dfec4648a33f7e1f3eee566c782caeac9dd4e109ce89d0f87484c18dacf626abf5263d1ee102e4dd777fe6b605dff8d
+  data.tar.gz: 3ef307e2e4ffd4b9da726854c45b23adf25dbb9b507a9ecd6d392f7dd6fa9ebeb3295e6c99aff056b49955d47ab97d0fb64207cfe803fb5e4cff561b0fa71c8b

data/lib/sort_n_params/concerns/scopes.rb

@@ -0,0 +1,20 @@
+require 'active_support/concern'
+
+module SortNParams
+  module Scopes
+    extend ActiveSupport::Concern
+    class_methods do
+      def sorting_order(ordering_array)
+        return all if ordering_array.blank?
+
+        all.order(parse_array(ordering_array))
+      end
+
+      def parse_array(ordering_array)
+        ordering_array.each_slice(2).map do |order, direction|
+          "#{name.tableize}.#{order} #{direction}"
+        end.join(', ')
+      end
+    end
+  end
+end

data/lib/sort_n_params/sort_helpers.rb

@@ -0,0 +1,8 @@
+module SortNParams
+  module SortHelpers
+    def sortable(column, title = nil)
+      data = Sortable.new(column, title, params).call
+      link_to "#{data.title} <i class='#{data.icon}'".html_safe, data.sort_params, class: data.css
+    end
+  end
+end

data/lib/sort_n_params/sortable.rb

@@ -0,0 +1,51 @@
+class Sortable
+  DEFAULT_ORDER = 'asc'.freeze
+
+  def initialize(column, title, params)
+    @column = column
+    @title = title || column.titleize
+    @params = params
+    @sort_params = { order: [], filter: @params[:filter] }
+  end
+
+  def call
+    add_previous_order if @params[:order].present?
+    @sort_params[:order].include?(@column) ? revert_order : add_order
+    build_data
+  end
+
+  private
+
+  def add_previous_order
+    @sort_params[:order] << @params[:order]
+    @sort_params[:order].flatten!
+  end
+
+  def build_data
+    OpenStruct.new(css: set_css, icon: set_icon, title: @title, sort_params: @sort_params)
+  end
+
+  def revert_order
+    column_index = @sort_params[:order].find_index(@column)
+    direction = @column == @sort_params[:order].detect { |e| e == @column } &&
+      @sort_params[:order][column_index + 1] == 'asc' ? 'desc' : 'asc'
+    @sort_params[:order][column_index + 1] = direction
+  end
+
+  def add_order
+    @sort_params[:order] << @column
+    @sort_params[:order] << DEFAULT_ORDER
+  end
+
+  def set_css
+    return nil unless @params[:order]
+
+    @column == @params[:order].detect { |e| e == @column } ? 'current' : nil
+  end
+
+  def set_icon
+    if @params[:order] && @params[:order].detect { |e| e == @column } == @column && @params[:order][ @params[:order].find_index(@column) + 1 ]
+      @column == @params[:order].detect { |e| e == @column } && @params[:order][ @params[:order].find_index(@column) + 1 ] == 'asc' ? 'fa fa-sort-up' : 'fa fa-sort-desc'
+    end
+  end
+end

data/spec/sortable_spec.rb

@@ -0,0 +1,94 @@
+require 'pry'
+RSpec.describe Sortable do
+  subject(:data) { Sortable.new('id', 'code', {}).call }
+
+  context 'when builds data for first time' do
+    it 'returns nil class for css' do
+      expect(data.css).to be_nil
+    end
+
+    it 'returns nil class for icon' do
+      expect(data.icon).to be_nil
+    end
+
+    it 'returns title of passed param' do
+      expect(data.title).to eq 'code'
+    end
+
+    it 'returns hash with default order for passed param' do
+      expect(data.sort_params).to be_instance_of Hash
+      expect(data.sort_params[:order]).to eq %w[id asc]
+    end
+  end
+
+  it 'returns nil filter params' do
+    expect(data.sort_params[:filter]).to be_nil
+  end
+
+  it 'titleizes column name if title is nil' do
+    new_data = Sortable.new('id', nil, {}).call
+    expect(new_data.title).to eq 'Id'
+  end
+
+  context 'when order data for first time' do
+    subject(:new_data) do
+      Sortable.new('description',
+                   'description',
+                   order: data.sort_params[:order],
+                   filter: nil).call
+    end
+    subject(:already_ordered) do
+      Sortable.new('description',
+                   'description',
+                   order: new_data.sort_params[:order],
+                   filter: nil).call
+    end
+
+    it 'adds order' do
+      expect(already_ordered.sort_params).to be_instance_of Hash
+      expect(new_data.sort_params[:order]).to eq %w[id asc description asc]
+    end
+
+    it "returns 'current' class for css" do
+      expect(already_ordered.css).to eq 'current'
+    end
+
+    it 'returns fa-sort-up class for icon' do
+      expect(already_ordered.icon).to eq 'fa fa-sort-up'
+    end
+
+    it 'returns title of passed param' do
+      expect(already_ordered.title).to eq 'description'
+    end
+
+    context 'when order already exists' do
+      subject(:twice_ordered) do
+        Sortable.new('description',
+                     'description',
+                     order: already_ordered.sort_params[:order],
+                     filter: nil).call
+      end
+
+      it 'reverts order for first time' do
+        expect(already_ordered.sort_params[:order]).to eq %w[id asc description desc]
+      end
+
+      it 'reverts order for second time' do
+        expect(twice_ordered.sort_params[:order]).to eq %w[id asc description asc]
+      end
+
+      it 'adds new order' do
+        new_order = Sortable.new('name',
+                                 'name',
+                                 order: already_ordered.sort_params[:order],
+                                 filter: nil).call
+        expect(already_ordered.sort_params).to be_instance_of Hash
+        expect(new_order.sort_params[:order]).to eq %w[id asc description desc name asc]
+      end
+
+      it 'returns fa-sort-down class for icon' do
+        expect(twice_ordered.icon).to eq 'fa fa-sort-desc'
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'factory_bot'
+
+RSpec.configure do |config|
+  config.include FactoryBot::Syntax::Methods
+  FactoryBot.find_definitions
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sort_n_params
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Juan Francisco Ferrari
@@ -129,6 +129,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/sort_n_params.rb
+- lib/sort_n_params/concerns/scopes.rb
+- lib/sort_n_params/sort_helpers.rb
+- lib/sort_n_params/sortable.rb
+- spec/sortable_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/JuannFerrari/sort_n_params
 licenses:
 - MIT