sort_n_params 1.0.4 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1699472fa73140a298c054ba1cf30a75c1f08a38cfa991d2b0d738bed8b707a0
-  data.tar.gz: fa259494066c8118ce818a88169b771631550bd8b20dbf39c3966230abc24c54
+  metadata.gz: 5546d17da19b3cfb15a26cb4cd14fc684545af3f743ea175d28947b0511f9758
+  data.tar.gz: 449f77325f1afb0e71ba03276bb07d095e9d00348882d50c69788e4c4902685d
 SHA512:
-  metadata.gz: 4b7d0e7c550936f4f85a2312935b138490dcce4f252240465b28eac3e4c7268fa87a089607824af3165934abdb1a8e59fdb2f5412e8684c45e6b8980fc666814
-  data.tar.gz: 8f406482183c6f110e9eb13a30a0fbbfe85052c5c235b4e0d3366d879632de367c561b06b984184cef0ca01f737aa81a1f2288d2506663beb477d5e061b69eee
+  metadata.gz: 350e519cb57c72ba5b7541f8802bba8436a57905b8adb2c293c09d1892c50e23c646a5280f1469a0c5b56e34929bc9c745d5c08a348224c95ff588d526691afc
+  data.tar.gz: 0a314e2fcdc8998dfe14fa42ceead8114474f5dccf101112bc7243d265ba56d3f22dd2f8b6e6f00d0111fa90b8d3281e3eeb8e6dd7d653abec71f9976d596ea3

data/Gemfile

@@ -1,6 +1,8 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in invoice_client.gemspec
 gemspec

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/lib/sort_n_params/concerns/scopes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/concern'
 
 module SortNParams
@@ -14,9 +16,18 @@ module SortNParams
         table = table_name || name.tableize
 
         ordering_array.each_slice(2).map do |order, direction|
-          "#{table}.#{order} #{direction}"
+          table_custom, order_custom = get_field_order(table, order)
+          "#{table_custom}.#{order_custom} #{direction}"
         end.join(', ')
       end
+
+      private
+
+      def get_field_order(table, order)
+        return [table, order] if order.split('.').one?
+
+        order.split('.')
+      end
     end
   end
 end

data/lib/sort_n_params/sort_helpers.rb

@@ -1,8 +1,36 @@
+# frozen_string_literal: true
+
 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
+      capture do
+        concat(
+          link_to(data.title, data.sort_params, class: data.css)
+        )
+
+        concat_position(data) if data.position.present?
+
+        concat_clear_params(data) if data.clear_params.present?
+      end
+    end
+
+    private
+
+    def concat_position(data)
+      concat(
+        link_to(data.sort_params, class: SortNParams.badge_main_class) do
+          "<b>#{data.position}</b><i class='#{data.icon}'></i>".html_safe
+        end
+      )
+    end
+
+    def concat_clear_params(data)
+      concat(
+        link_to(data.clear_params, class: SortNParams.badge_secondary_class) do
+          "<i class='#{SortNParams.sort_clear_class}'></i>".html_safe
+        end
+      )
     end
   end
 end

data/lib/sort_n_params/sortable.rb

@@ -1,5 +1,10 @@
+# frozen_string_literal: true
+
+require 'ostruct'
+require 'sort_n_params'
+
 class Sortable
-  DEFAULT_ORDER = 'asc'.freeze
+  DEFAULT_ORDER = 'asc'
 
   def initialize(column, title, params)
     @column = column
@@ -10,7 +15,15 @@ class Sortable
 
   def call
     add_previous_order unless @params[:order].nil?
-    @sort_params[:order].include?(@column) ? revert_order : add_order
+    if @sort_params[:order].include?(@column)
+      revert_order
+      set_clear_params
+      set_position
+    else
+      add_order
+      reset_clear_params
+    end
+
     build_data
   end
 
@@ -19,16 +32,22 @@ class Sortable
   def add_previous_order
     @sort_params[:order] << @params[:order]
     @sort_params[:order].flatten!
+    @clear_params = Marshal.load(Marshal.dump(@sort_params))
   end
 
   def build_data
-    OpenStruct.new(css: set_css, icon: set_icon, title: @title, sort_params: @sort_params)
+    OpenStruct.new(css: set_css, icon: set_icon, title: @title, position: @column_position, sort_params: @sort_params,
+                   clear_params: @clear_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'
+    direction = if @column == @sort_params[:order].detect { |e| e == @column } &&
+                   @sort_params[:order][column_index + 1] == 'asc'
+                  'desc'
+                else
+                  'asc'
+                end
     @sort_params[:order][column_index + 1] = direction
   end
 
@@ -37,6 +56,19 @@ class Sortable
     @sort_params[:order] << DEFAULT_ORDER
   end
 
+  def set_clear_params
+    column_index = @clear_params[:order].find_index(@column)
+    2.times { |_x| @clear_params[:order].delete_at(column_index) }
+  end
+
+  def reset_clear_params
+    @clear_params = nil
+  end
+
+  def set_position
+    @column_position = @sort_params[:order].each_slice(2).map(&:first).find_index(@column) + 1
+  end
+
   def set_css
     return nil unless @params[:order]
 
@@ -44,8 +76,20 @@ class Sortable
   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'
+    return unless order_param_exists?
+
+    if @column == order_column && @params[:order][ @params[:order].find_index(@column) + 1 ] == 'asc'
+      SortNParams.sort_asc_class
+    else
+      SortNParams.sort_desc_class
     end
   end
+
+  def order_param_exists?
+    @params[:order] && @column == order_column && @params[:order][ @params[:order].find_index(@column) + 1 ]
+  end
+
+  def order_column
+    @params[:order].detect { |e| e == @column }
+  end
 end

data/lib/sort_n_params.rb

@@ -1,14 +1,24 @@
+# frozen_string_literal: true
+
 require 'sort_n_params/sort_helpers'
 require 'sort_n_params/sortable'
 require 'rails/engine'
 
 module SortNParams
+  class << self
+    attr_accessor :badge_main_class,
+                  :badge_secondary_class,
+                  :sort_asc_class,
+                  :sort_desc_class,
+                  :sort_clear_class
+  end
+
   class Engine < ::Rails::Engine
     require 'sort_n_params/concerns/scopes'
 
     initializer 'sort_n_params.initialize' do |_app|
       ActiveSupport.on_load :action_view do
-        ActionView::Base.send :include, SortNParams::SortHelpers
+        ActionView::Base.include SortNParams::SortHelpers
       end
     end
   end

data/sort_n_params.gemspec

@@ -1,38 +1,42 @@
+# frozen_string_literal: true
+
 Gem::Specification.new do |s|
   s.name        = 'sort_n_params'
-  s.version     = '1.0.4'
-  s.date        = '2019-05-07'
-  s.summary     = "Sort N Params"
-  s.description = "Make your html <tables> sortables with N <th> parameters this gem."
-  s.authors     = ["Juan Francisco Ferrari"]
+  s.version     = '1.2.3'
+  s.date        = '2022-06-22'
+  s.summary     = 'Sort N Params'
+  s.description = 'Make your html <tables> sortables with N <th> parameters this gem.'
+  s.authors     = ['Juan Francisco Ferrari']
   s.email       = 'juannferrari@gmail.com'
-  s.require_paths = ["lib"]
-  s.files       = [
-    ".travis.yml",
-    "Gemfile",
-    "LICENSE",
-    "Rakefile",
-    "sort_n_params.gemspec",
-    "lib/sort_n_params.rb",
-    "lib/sort_n_params/sortable.rb",
-    "lib/sort_n_params/sort_helpers.rb",
-    "lib/sort_n_params/concerns/scopes.rb",
-    "spec/concerns/scopes_spec.rb",
-    "spec/spec_helper.rb",
-    "spec/sortable_spec.rb"
-    ]
-  s.homepage    =
+  s.require_paths = ['lib']
+  s.files = [
+    'Gemfile',
+    'LICENSE',
+    'Rakefile',
+    'sort_n_params.gemspec',
+    'lib/sort_n_params.rb',
+    'lib/sort_n_params/sortable.rb',
+    'lib/sort_n_params/sort_helpers.rb',
+    'lib/sort_n_params/concerns/scopes.rb',
+    'spec/concerns/scopes_spec.rb',
+    'spec/spec_helper.rb',
+    'spec/sortable_spec.rb'
+  ]
+  s.homepage =
     'https://github.com/JuannFerrari/sort_n_params'
-  s.license       = 'MIT'
-
+  s.license = 'MIT'
+  s.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
 
-  s.add_development_dependency "bundler"
-  s.add_development_dependency "factory_bot", "~> 4.0"
-  s.add_development_dependency "pry-byebug"
-  s.add_development_dependency "rake", ">= 12.3.3"
-  s.add_development_dependency "rspec", "~> 3.0"
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'factory_bot', '~> 4.0'
+  s.add_development_dependency 'pry', '~> 0.13.1'
+  s.add_development_dependency 'pry-byebug'
+  s.add_development_dependency 'rake', '>= 12.3.3'
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'rubocop', '~> 1.30'
+  s.add_development_dependency 'rubocop-rails'
 
-  s.add_dependency(%q<rails>.freeze, ["~> 5.0"])
-  s.add_dependency(%q<nokogiri>.freeze, [">= 0"])
-  s.add_dependency(%q<rake>.freeze, [">= 12.3.3"])
+  s.add_dependency('nokogiri', ['>= 0'])
+  s.add_dependency('rails', ['>= 7.0'])
+  s.add_dependency('rake', ['>= 12.3.3'])
 end

data/spec/concerns/scopes_spec.rb

@@ -1,25 +1,31 @@
+# frozen_string_literal: true
+
 require 'sort_n_params/concerns/scopes'
 
+CustomTable = Struct.new(:custom_field) do
+  include SortNParams::Scopes
+end
+
 RSpec.describe SortNParams::Scopes do
   let(:test_class) do
-    CustomTable = Struct.new(:custom_field) do
-      include SortNParams::Scopes
-    end
+    CustomTable
   end
 
-  context 'when you pass only an ordering array' do
-    subject { test_class.parse_array(["test_field","asc"]) }
+  describe '#parse_array' do
+    context 'when you pass only an ordering array' do
+      subject { test_class.parse_array(%w[test_field asc]) }
 
-    it "builds the array correctly without the table_name param passed" do
-      expect(subject).to eq("custom_tables.test_field asc")
+      it 'builds the array correctly without the table_name param passed' do
+        expect(subject).to eq('custom_tables.test_field asc')
+      end
     end
-  end
 
-  context 'when you pass both ordering array and table name' do
-    subject { test_class.parse_array(["test_field","asc"], "another_table_name" ) }
+    context 'when you pass both ordering array and table name' do
+      subject { test_class.parse_array(%w[test_field asc], 'another_table_name') }
 
-    it "builds the array correctly with the table_name param passed" do
-      expect(subject).to eq("another_table_name.test_field asc")
+      it 'builds the array correctly with the table_name param passed' do
+        expect(subject).to eq('another_table_name.test_field asc')
+      end
     end
   end
-end
+end

data/spec/sortable_spec.rb

@@ -1,4 +1,7 @@
-require 'pry'
+# frozen_string_literal: true
+
+require 'sort_n_params'
+
 RSpec.describe Sortable do
   subject(:data) { Sortable.new('id', 'code', {}).call }
 
@@ -54,7 +57,7 @@ RSpec.describe Sortable do
     end
 
     it 'returns fa-sort-up class for icon' do
-      expect(already_ordered.icon).to eq 'fa fa-sort-up'
+      expect(already_ordered.icon).to eq SortNParams.sort_asc_class
     end
 
     it 'returns title of passed param' do
@@ -87,7 +90,7 @@ RSpec.describe Sortable do
       end
 
       it 'returns fa-sort-down class for icon' do
-        expect(twice_ordered.icon).to eq 'fa fa-sort-desc'
+        expect(twice_ordered.icon).to eq SortNParams.sort_desc_class
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 require 'factory_bot'
 require 'sort_n_params/sortable'
 
 RSpec.configure do |config|
   config.include FactoryBot::Syntax::Methods
   FactoryBot.find_definitions
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sort_n_params
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.2.3
 platform: ruby
 authors:
 - Juan Francisco Ferrari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-07 00:00:00.000000000 Z
+date: 2022-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -81,19 +95,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :runtime
+        version: '1.30'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '1.30'
+- !ruby/object:Gem::Dependency
+  name: rubocop-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: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -128,7 +170,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".travis.yml"
 - Gemfile
 - LICENSE
 - Rakefile
@@ -152,14 +193,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Sort N Params

data/.travis.yml

@@ -1,9 +0,0 @@
-language: ruby
-rvm:
-  - 2.6.1
-before_install:
-   - gem update --system
-   - gem install bundler
-script:
-   - bundle install
-   - bundle exec rake spec