sort_n_params 1.1.0 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65438859688c9289931f4447f73b1939a03058d98360878cb297b62d5c7c2ae4
-  data.tar.gz: 6bf07b3f4bac11774805bb5e2ebc010211b8d0a5b793af7d0d93cf8a7044617f
+  metadata.gz: 0d4ac056564f23114d90e35df4b967adb86fa41078a7ea283b0194bc4185770e
+  data.tar.gz: 3d5ef6cb54e2332663f866fb64b4f4129ce71dcb759e7a07d81591f4305d9947
 SHA512:
-  metadata.gz: ba8e96b6e58098196af8d86789e9b90c43212c5e2727dcd97aa72dc31d90a9231de96de39cf29aab6ab2c50b6c12074ba633120f139a4f45302b8a7efd493bf0
-  data.tar.gz: '026306599ab142c755abb914c495fb57df5f01bf76a18a503c400c11c8b806186fb54d1b11028bf8ab5316151ddb740b2f22b25787f365800ccba1bbf2bf7911'
+  metadata.gz: d3958ff1ccc8458fa980a3372f362663be02b5a812641fc55f2e3c8fcc290038c152045538236290f2fb530bb4fd510c9af45e8c6a35c50c4fb14c4bc3fd1172
+  data.tar.gz: 0f17254708d77572faa51439bafebac85d8b7276a7b060b78bc1e917b9d7a06095edc534983be0508dada603b432dd4e9eb2cde400235ada34cad226d47c19f9

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
@@ -7,7 +9,7 @@ module SortNParams
       def sorting_order(ordering_array, table_name = nil)
         return all if ordering_array.blank?
 
-        all.order(parse_array(ordering_array, table_name))
+        all.order(sanitize_sql_for_order(parse_array(ordering_array, table_name)))
       end
 
       def parse_array(ordering_array, table_name = nil)

data/lib/sort_n_params/sort_helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SortNParams
   module SortHelpers
     def sortable(column, title = nil)
@@ -6,17 +8,29 @@ module SortNParams
         concat(
           link_to(data.title, data.sort_params, class: data.css)
         )
-        concat(
-          link_to(data.sort_params, class: SortNParams.badge_main_class) do
-            "<b>#{data.position}</b><i class='#{data.icon}'></i>".html_safe
-          end
-        ) if data.position.present?
-        concat(
-          link_to(data.clear_params, class: SortNParams.badge_secondary_class) do
-            "<i class='#{SortNParams.sort_clear_class}'></i>".html_safe
-          end
-        ) if data.clear_params.present?
+
+        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,8 +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
@@ -34,13 +36,18 @@ class Sortable
   end
 
   def build_data
-    OpenStruct.new(css: set_css, icon: set_icon, title: @title, position: @column_position, sort_params: @sort_params, clear_params: @clear_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
 
@@ -51,7 +58,7 @@ class Sortable
 
   def set_clear_params
     column_index = @clear_params[:order].find_index(@column)
-    2.times{|x| @clear_params[:order].delete_at(column_index) }
+    2.times { |_x| @clear_params[:order].delete_at(column_index) }
   end
 
   def reset_clear_params
@@ -69,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' ? SortNParams.sort_asc_class : SortNParams.sort_desc_class
+    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,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'sort_n_params/sort_helpers'
 require 'sort_n_params/sortable'
 require 'rails/engine'
@@ -16,7 +18,7 @@ module SortNParams
 
     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,14 +1,15 @@
+# frozen_string_literal: true
+
 Gem::Specification.new do |s|
   s.name        = 'sort_n_params'
-  s.version     = '1.1.0'
-  s.date        = '2019-05-07'
+  s.version     = '1.2.4'
+  s.date        = '2022-06-23'
   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',
@@ -24,14 +25,19 @@ Gem::Specification.new do |s|
   s.homepage =
     'https://github.com/JuannFerrari/sort_n_params'
   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', '~> 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_development_dependency 'sqlite3'
 
-  s.add_dependency('rails'.freeze, ['>= 5.0'])
-  s.add_dependency('nokogiri'.freeze, ['>= 0'])
-  s.add_dependency('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,63 @@
+# frozen_string_literal: true
+
 require 'sort_n_params/concerns/scopes'
+require 'active_record'
+
+class CustomTable < ActiveRecord::Base
+  include SortNParams::Scopes
+end
 
 RSpec.describe SortNParams::Scopes do
-  let(:test_class) do
-    CustomTable = Struct.new(:custom_field) do
-      include SortNParams::Scopes
+  before(:all) { create_tables }
+  after(:all) { drop_tables }
+
+  def create_tables
+    ActiveRecord::Base.connection.create_table :custom_tables do |t|
+      t.text :test_field
     end
   end
 
-  context 'when you pass only an ordering array' do
-    subject { test_class.parse_array(["test_field","asc"]) }
+  def drop_tables
+    ActiveRecord::Base.connection.drop_table :custom_tables
+  end
+
+  let(:test_class) do
+    CustomTable
+  end
 
-    it "builds the array correctly without the table_name param passed" do
-      expect(subject).to eq("custom_tables.test_field asc")
+  describe '#sorting_order' do
+    context 'when you pass only the sorting field with direction asc' do
+      subject { test_class.sorting_order(%w[test_field asc]) }
+
+      it 'builds an order with that field and direction' do
+        expect(subject.explain).to include('ORDER BY custom_tables.test_field asc')
+      end
+    end
+
+    context 'when you pass only the sorting field direction desc' do
+      subject { test_class.sorting_order(%w[test_field desc]) }
+
+      it 'builds an order with that field and direction' do
+        expect(subject.explain).to include('ORDER BY custom_tables.test_field desc')
+      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" ) }
+  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')
+      end
+    end
+
+    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,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'sort_n_params'
 
 RSpec.describe Sortable do

data/spec/spec_helper.rb

@@ -1,7 +1,16 @@
+# frozen_string_literal: true
+
 require 'factory_bot'
 require 'sort_n_params/sortable'
+require 'active_record'
+require 'sqlite3'
 
 RSpec.configure do |config|
   config.include FactoryBot::Syntax::Methods
   FactoryBot.find_definitions
+
+  ActiveRecord::Base.establish_connection(
+    adapter: 'sqlite3',
+    database: ':memory:'
+  )
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sort_n_params
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.4
 platform: ruby
 authors:
 - Juan Francisco Ferrari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-07 00:00:00.000000000 Z
+date: 2022-06-23 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,47 @@ 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: '1.30'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.30'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        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'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +150,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 +184,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".travis.yml"
 - Gemfile
 - LICENSE
 - Rakefile
@@ -152,14 +207,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