sort_n_params 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3f307d6ddad0f5a1e8e040e906a73710961f643471c0f0bf3bb460aa31350cb
-  data.tar.gz: 248dde93d3390424fc37c005d3abb5fc10c7f68874a256481d077043cd1fb91c
+  metadata.gz: 65438859688c9289931f4447f73b1939a03058d98360878cb297b62d5c7c2ae4
+  data.tar.gz: 6bf07b3f4bac11774805bb5e2ebc010211b8d0a5b793af7d0d93cf8a7044617f
 SHA512:
-  metadata.gz: 1d6a9e82cda9abdcada1d1e6a00ce4fc70f0282ce4805d0a1494c79193d5143e4bb80ecab214e87695ce98440f9799aa03327d346fb7a8ee32429e2c9c64db41
-  data.tar.gz: 8a332365f8017aadbc47a25d1e2ebf4f5e8c42018b4484dd81b9128b0a114d0fe0f71aed7c7fb43ac57bfa0ac38dd7deda3c09f7ca1d8b61f9ce317a31ad2273
+  metadata.gz: ba8e96b6e58098196af8d86789e9b90c43212c5e2727dcd97aa72dc31d90a9231de96de39cf29aab6ab2c50b6c12074ba633120f139a4f45302b8a7efd493bf0
+  data.tar.gz: '026306599ab142c755abb914c495fb57df5f01bf76a18a503c400c11c8b806186fb54d1b11028bf8ab5316151ddb740b2f22b25787f365800ccba1bbf2bf7911'

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+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/LICENSE

@@ -0,0 +1,17 @@
+Copyright 2019 Juan Francisco Ferrari
+
+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/Rakefile

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

data/lib/sort_n_params.rb

@@ -3,6 +3,14 @@ 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'
 

data/lib/sort_n_params/concerns/scopes.rb

@@ -0,0 +1,31 @@
+require 'active_support/concern'
+
+module SortNParams
+  module Scopes
+    extend ActiveSupport::Concern
+    class_methods do
+      def sorting_order(ordering_array, table_name = nil)
+        return all if ordering_array.blank?
+
+        all.order(parse_array(ordering_array, table_name))
+      end
+
+      def parse_array(ordering_array, table_name = nil)
+        table = table_name || name.tableize
+
+        ordering_array.each_slice(2).map do |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

@@ -0,0 +1,22 @@
+module SortNParams
+  module SortHelpers
+    def sortable(column, title = nil)
+      data = Sortable.new(column, title, params).call
+      capture do
+        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?
+      end
+    end
+  end
+end

data/lib/sort_n_params/sortable.rb

@@ -0,0 +1,76 @@
+require 'ostruct'
+require 'sort_n_params'
+
+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 unless @params[:order].nil?
+    if @sort_params[:order].include?(@column)
+      revert_order
+      set_clear_params
+      set_position
+    else
+      add_order
+      reset_clear_params
+    end
+
+    build_data
+  end
+
+  private
+
+  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, 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'
+    @sort_params[:order][column_index + 1] = direction
+  end
+
+  def add_order
+    @sort_params[:order] << @column
+    @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]
+
+    @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' ? SortNParams.sort_asc_class : SortNParams.sort_desc_class
+    end
+  end
+end

data/sort_n_params.gemspec

@@ -0,0 +1,37 @@
+Gem::Specification.new do |s|
+  s.name        = 'sort_n_params'
+  s.version     = '1.1.0'
+  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.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 =
+    'https://github.com/JuannFerrari/sort_n_params'
+  s.license = 'MIT'
+
+  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_dependency('rails'.freeze, ['>= 5.0'])
+  s.add_dependency('nokogiri'.freeze, ['>= 0'])
+  s.add_dependency('rake'.freeze, ['>= 12.3.3'])
+end

data/spec/concerns/scopes_spec.rb

@@ -0,0 +1,25 @@
+require 'sort_n_params/concerns/scopes'
+
+RSpec.describe SortNParams::Scopes do
+  let(:test_class) do
+    CustomTable = Struct.new(:custom_field) do
+      include SortNParams::Scopes
+    end
+  end
+
+  context 'when you pass only an ordering array' do
+    subject { test_class.parse_array(["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(["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")
+    end
+  end
+end

data/spec/sortable_spec.rb

@@ -0,0 +1,95 @@
+require 'sort_n_params'
+
+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 SortNParams.sort_asc_class
+    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 SortNParams.sort_desc_class
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'factory_bot'
+require 'sort_n_params/sortable'
+
+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.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Juan Francisco Ferrari
@@ -56,16 +56,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -84,14 +84,14 @@ dependencies:
   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
@@ -112,24 +112,35 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: 12.3.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: 12.3.3
 description: Make your html <tables> sortables with N <th> parameters this gem.
 email: juannferrari@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- Rakefile
 - lib/sort_n_params.rb
-homepage: https://rubygems.org/gems/sort_n_params
+- lib/sort_n_params/concerns/scopes.rb
+- lib/sort_n_params/sort_helpers.rb
+- lib/sort_n_params/sortable.rb
+- sort_n_params.gemspec
+- spec/concerns/scopes_spec.rb
+- spec/sortable_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/JuannFerrari/sort_n_params
 licenses:
 - MIT
 metadata: {}
@@ -148,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Sort N Params