liquid-nested-sort 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7cb5f83d18f3c4ce3def897442ccaa8ba84030eacbc44bba5a4d0ac1b5def404
-  data.tar.gz: e8a6bab9cf5492b641b50cad2b986913eec5c9e94d1d30dc351962978cd31db0
+  metadata.gz: f960256f408a36cc9c3f5f0f1be3296aa3a919734716a3d1f25bb043e6a5c443
+  data.tar.gz: a1a35ae637123dd1925a5407d02f151054cdb672d42dae2fa5b1749b9579ae6a
 SHA512:
-  metadata.gz: a8a516483651ec92099adebe1a73045392ddb1db642771f92619a6250ca73addef147f3140e9dd1dda6222601857e1b5b44c1c69b3307f835ace16cd98e1a9fd
-  data.tar.gz: 26a5a00c0ee15b020f07ab86a5fa5d067e5ad50b661e2c56f1d77142bfa2a007f9c9ef077704efb6d12dccb0a3ab1c7a1f15a2828497320b3ca7e029231b2415
+  metadata.gz: a951ded949279e72f38cb86b07594cd7c50a09455e2994a1b688a0e3f720f06c45d3c23bad2767d30b03dfc6e93e96a160fc161770434ffdc683c9f613232ee4
+  data.tar.gz: e57d65ed6c30ebb6103da33d93450a6d5014102849b852fb837e15b862453d946e3c328039e61efba75a5a66e4669d885c9f022a40d970dc3ba6ffecd0c4c232

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rspec', '~> 3.9'

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    liquid-nested-sort (0.1.4)
+      liquid (>= 4.0, < 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    liquid (4.0.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  liquid-nested-sort!
+  rspec (~> 3.9)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2020, Fabio Bonelli
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,28 @@
+# liquid-nested-sort
+
+[![Gem Version](https://img.shields.io/gem/v/liquid-nested-sort.svg)](https://rubygems.org/gems/liquid-nested-sort)
+
+`nested_sort` and `nested_sort_natural`, sort and sort_natural-like filters
+with nested fields support for [Liquid](https://shopify.github.io/liquid/).
+
+## Installation
+
+In the Gemfile
+
+```ruby
+gem 'liquid-nested-sort'
+```
+
+## Usage
+
+```liquid
+{{ places | nested_sort "address.street" }}
+```
+
+```liquid
+{{ places | nested_sort_natural "address.street" }}
+```
+
+## Thanks
+
+This is mostly based on @untra's work (https://github.com/untra).

data/lib/liquid-nested-sort.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'liquid_nested_sort/nested_filters'
+
+Liquid::Template.register_filter(NestedFilters)

data/lib/liquid_nested_sort/nested_filters.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require 'liquid/errors'
+
+module LiquidUtils
+  def self.nil_safe_compare(a, b)
+    if !a.nil? && !b.nil?
+      a <=> b
+    else
+      a.nil? ? 1 : -1
+    end
+  end
+
+  def self.nil_safe_casecmp(a, b)
+    if !a.nil? && !b.nil?
+      a.to_s.casecmp(b.to_s)
+    else
+      a.nil? ? 1 : -1
+    end
+  end
+
+  def self.nested_respond_to?(input, property)
+    return true if property.empty?
+
+    p = property.split('.').first
+    q = property[/#{p}.?([\w.]*)/, 1]
+
+    return nested_respond_to?(input[p], q) if input.respond_to?(:[]) && accepts?(input, p)
+    return nested_respond_to?(input.send(p), q) if input.respond_to?(p)
+
+    false
+  end
+
+  def self.nested_send(input, property)
+    return input if property.empty?
+
+    p = property.split('.').first
+    q = property[/#{p}.?([\w.]*)/, 1]
+
+    return nested_send(input[p], q) if input.respond_to?(:[]) && accepts?(input, p)
+    return nested_send(input.send(p), q) if input.respond_to?(p)
+
+    nil
+  end
+
+  def self.accepts?(input, index)
+    !input[index].nil?
+  rescue TypeError
+    false
+  end
+end
+
+module InputIterator
+  def self.new(input)
+    if input.is_a?(Array)
+      input.flatten
+    elsif input.is_a?(Hash)
+      [input]
+    elsif input.is_a?(Enumerable)
+      input
+    else
+      Array(input)
+    end
+  end
+end
+
+module NestedFilters
+  include Liquid
+
+  def nested_sort(input, property = nil)
+    ary = InputIterator.new(input)
+
+    return [] if ary.empty?
+
+    if property.nil?
+      ary.sort do |a, b|
+        LiquidUtils.nil_safe_compare(a, b)
+      end
+    elsif property.include?('.') && LiquidUtils.nested_respond_to?(ary.first, property)
+      ary.sort do |a, b|
+        LiquidUtils.nil_safe_compare(LiquidUtils.nested_send(a, property), LiquidUtils.nested_send(b, property))
+      end
+    elsif ary.all? { |el| el.respond_to?(:[]) }
+      begin
+        ary.sort { |a, b| LiquidUtils.nil_safe_compare(a[property], b[property]) }
+      rescue TypeError
+        raise Liquid::ArgumentError, "cannot select the property '#{property}'"
+      end
+    end
+  end
+
+  def nested_sort_natural(input, property = nil)
+    ary = InputIterator.new(input)
+
+    return [] if ary.empty?
+
+    if property.nil?
+      ary.sort do |a, b|
+        LiquidUtils.nil_safe_casecmp(a, b)
+      end
+    elsif property.include?('.') && LiquidUtils.nested_respond_to?(ary.first, property)
+      ary.sort do |a, b|
+        LiquidUtils.nil_safe_casecmp(LiquidUtils.nested_send(a, property), LiquidUtils.nested_send(b, property))
+      end
+    elsif ary.all? { |el| el.respond_to?(:[]) }
+      begin
+        ary.sort { |a, b| LiquidUtils.nil_safe_casecmp(a[property], b[property]) }
+      rescue TypeError
+        raise Liquid::ArgumentError, "cannot select the property '#{property}'"
+      end
+    end
+  end
+end

data/liquid-nested-sort.gemspec

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |s|
+  s.name = 'liquid-nested-sort'
+  s.version = '0.1.5'
+  s.date = '2020-09-03'
+
+  s.author = 'Fabio Bonelli'
+  s.email = 'fb@fabiobonelli.it'
+  s.license = 'BSD-3-Clause'
+  s.homepage = 'https://github.com/bfabio/liquid-nested-sort'
+
+  s.summary = 'sort and sort_natural filters with nested fields support for Liquid'
+  s.description =
+    "Liquid's sort and sort_natural don't support nested fields out of the box." \
+    'This gems provides nested_sort and nester_sort_natural.'
+
+  s.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(spec)/!) }
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency('liquid', ['>= 4.0', '< 5.0'])
+  s.required_ruby_version = '~> 2.4'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: liquid-nested-sort
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - Fabio Bonelli
@@ -37,7 +37,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/liquid_nested_sort.rb
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- lib/liquid-nested-sort.rb
+- lib/liquid_nested_sort/nested_filters.rb
+- liquid-nested-sort.gemspec
 homepage: https://github.com/bfabio/liquid-nested-sort
 licenses:
 - BSD-3-Clause

data/lib/liquid_nested_sort.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-module NestedFilter
-  def nested_sort(input, property = nil)
-    ary = InputIterator.new(input, context)
-
-    return [] if ary.empty?
-
-    if property.nil?
-      ary.sort do |a, b|
-        nil_safe_compare(a, b)
-      end
-    elsif ary.all? { |el| el.respond_to?(:[]) }
-      begin
-        ary.sort { |a, b| nil_safe_compare(a[property], b[property]) }
-      rescue TypeError
-        raise_property_error(property)
-      end
-    end
-  end
-
-  def nested_sort_natural(input, property = nil)
-    ary = InputIterator.new(input, context)
-
-    return [] if ary.empty?
-
-    if property.nil?
-      ary.sort do |a, b|
-        nil_safe_compare(a, b)
-      end
-    elsif ary.all? { |el| el.respond_to?(:[]) }
-      begin
-        ary.sort { |a, b| nil_safe_compare(a[property], b[property]) }
-      rescue TypeError
-        raise_property_error(property)
-      end
-    end
-  end
-end
-
-Liquid::Template.register_filter(NestedFilter)