miscellany 0.1.17 → 0.1.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8272b6520386bb2e45ef6a4ae8cc6c2c349e465ca8eea10867df3c42c80c7c3
-  data.tar.gz: aeb81bc5bb198c2f64589c1d416369bd101de5d1db074682e40f66247c2035d5
+  metadata.gz: e919c60e03780d5fab1a21ae6d528482db21d5a4fcfbc176b4808cc1d9acdc77
+  data.tar.gz: c9ecbbbb69e28e8fbef7aa9efe93db1cab9576634ede5ad2dc698180c1743dda
 SHA512:
-  metadata.gz: 3f6ac9e74cacbdb4dd5d990a47c72608181eb005b4a9c3de81b46666bf314a246fa799c29d97753519822318740adf32fa2db63450d2d70e2abc4fb4a38c09de
-  data.tar.gz: 99f033c54af54257ef660e889f34f683e080fe4e16baeb9d1f201fcf0091561c6d2fd5d26b582a57b9ab91b2d7c0fd3c8e72f8fc8e02f7425b0a395b4bcc7e9f
+  metadata.gz: 7468e0d150c79e5ebfb5760648e97699c7b88340c68b7eaa530c58e512ee982eb1d2b44c2599b374a7348a5b9cefe7d7037603a98aa5a8a895f18bac6d4efe84
+  data.tar.gz: 0a7dfb9250e3f686d88f7c2932cbd1a8b07f0a38ae4d3e491e98ee4c14a22126bcf3defd58227130fe3a43f8cd7d0b5dbaf002f6ded24fd187706b445fcce28e

data/lib/miscellany/controller/sliced_response.rb

@@ -7,8 +7,8 @@ module Miscellany
     include HttpErrorHandling
 
     # Deprecated
-    def slice_results(queryset, **kwargs)
-      @sliced_data = sliced_json(queryset, **kwargs) { |x| x }
+    def slice_results(*args, **kwargs, &blk)
+      @sliced_data = sliced_json(*args, **kwargs, &blk)
     end
 
     def sliced_json(
@@ -219,7 +219,7 @@ module Miscellany
 
       def sort_sql
         sorts = [ *Array(self.sort) ]
-        sorts << options[:sort_parser]&.default
+        sorts.push(*options[:sort_parser]&.default_sorts)
         sorts.compact!
 
         return nil unless sorts.present?

data/lib/miscellany/sort_lang.rb

@@ -23,10 +23,25 @@ module Miscellany
     end
 
     def self.sqlize(sorts)
+      seen_sorts = Set.new
+
+      # Only include each sort key/"column" once
+      sorts = sorts.select do |sort|
+        sid = sort[:key] || sort[:column]
+        next true unless sid.present?
+
+        if seen_sorts.include?(sid)
+          false
+        else
+          seen_sorts << sid
+          true
+        end
+      end
+
       sorts.map do |sort|
         order = sort[:order] || 'ASC'
         if sort[:column].is_a?(Proc)
-          sort[:column].call(qset, order)
+          sort[:column].call(order)
         else
           desired_nulls = (sort[:nulls] || :low).to_s.downcase.to_sym
           nulls = case desired_nulls
@@ -45,12 +60,20 @@ module Miscellany
     class Parser
       class SortParsingError < StandardError; end
 
+      attr_reader :default_sorts
+
       def initialize(valid_sorts, default: nil)
-        @sorts_map = normalize_sort_options(valid_sorts, default: default)
-      end
+        @sorts_map = normalize_sort_options(valid_sorts)
+
+        @default_sorts = []
 
-      def default
-        @sorts_map[:default]
+        parsed_defaults = normalize_sort_options(Array(default))
+        parsed_defaults.each do |k,v|
+          @sorts_map[k] ||= v
+        end
+        @default_sorts = parsed_defaults.keys.map do |k|
+          @sorts_map[k]
+        end
       end
 
       def valid?(sortstr)
@@ -80,39 +103,31 @@ module Miscellany
           sort
         end
 
-        sorts << self.default if default == :append || default && !sorts.compact.present?
+        if default == :append || default && !sorts.compact.present?
+          sorts.push(*self.default_sorts)
+        end
 
         sorts.compact.presence
       end
 
       protected
 
-      def normalize_sort_options(sorts, default: nil)
+      def normalize_sort_options(sorts)
         norm_sorts = { }
 
         sorts.each do |s|
           if s.is_a?(Hash)
             s.each do |k,v|
+              k = k.to_s
               sort_hash = normalize_sort(v, key: k)
               norm_sorts[k] = sort_hash
             end
           else
             sort_hash = normalize_sort(s)
             norm_sorts[sort_hash[:column]] = sort_hash
-            # default ||= sort_hash
           end
         end
 
-        if default.present?
-          norm_default = normalize_sort(default)
-          reference = norm_sorts[norm_default[:key].to_s] || norm_default
-          norm_sorts[:default] = {
-            key: reference[:key],
-            column: reference[:column],
-            order: norm_default[:order] || reference[:order],
-          }
-        end
-
         norm_sorts
       end
 

data/lib/miscellany/version.rb

@@ -1,3 +1,3 @@
 module Miscellany
-  VERSION = "0.1.17".freeze
+  VERSION = "0.1.19".freeze
 end

data/spec/miscellany/sliced_response_spec.rb

@@ -129,6 +129,19 @@ describe Miscellany::SlicedResponse do
 
       expect(subject.sliced_json(ARModel.all, { page: "all" }, allow_all: true, **slice_config)).to be_a Hash
     end
+
+    context "with Hash-based valid_sorts" do
+      let(:source) { ARModel.all }
+
+      before(:each) do
+        slice_config[:valid_sorts] = [
+          title: ->(dir) { "title #{dir}" }
+        ]
+      end
+
+      include_examples "basic functionality"
+      include_examples "sortable"
+    end
   end
 
   describe "#bearcat_as_sliced_json" do

data/spec/miscellany/sort_lang_spec.rb

@@ -0,0 +1,124 @@
+
+require 'spec_helper'
+
+describe Miscellany::SortLang do
+
+  describe ".normalize_sort" do
+    it "accepts Hash KV pairs" do
+      expect(Miscellany::SortLang.normalize_sort(["key", { column: "created_at", order: "ASC" }])).to eql({
+        column: "created_at", force_order: false, key: "created_at", order: "ASC"
+      })
+    end
+
+    it "accepts strings" do
+      expect(Miscellany::SortLang.normalize_sort("created_at")).to eql({
+        column: "created_at", force_order: false, key: "created_at"
+      })
+      expect(Miscellany::SortLang.normalize_sort("created_at ASC")).to eql({
+        column: "created_at", force_order: false, key: "created_at", order: "ASC"
+      })
+      expect(Miscellany::SortLang.normalize_sort("created_at ASC!")).to eql({
+        column: "created_at", force_order: true, key: "created_at", order: "ASC"
+      })
+    end
+
+    it "accepts Procs" do
+      logic = ->(x) { "created_at #{x}" }
+      expect(Miscellany::SortLang.normalize_sort(logic, key: "k")).to eql({
+        column: logic, key: "k"
+      })
+    end
+  end
+
+  describe ".sqlize" do
+    it "only includes each sort key once" do
+      expect(Miscellany::SortLang.sqlize([
+        { column: "created_at", order: "ASC" },
+        { column: "created_at", order: "DESC" },
+      ])).to eql "created_at ASC NULLS FIRST"
+    end
+
+    describe "nulls: option" do
+      it "accepts a nulls: option" do
+        expect(Miscellany::SortLang.sqlize([
+          { column: "created_at", order: "ASC", nulls: :last },
+        ])).to eql "created_at ASC NULLS LAST"
+      end
+
+      it "nulls: :high works" do
+        expect(Miscellany::SortLang.sqlize([
+          { column: "created_at", order: "ASC", nulls: :high },
+        ])).to eql "created_at ASC NULLS LAST"
+        expect(Miscellany::SortLang.sqlize([
+          { column: "created_at", order: "DESC", nulls: :high },
+        ])).to eql "created_at DESC NULLS FIRST"
+      end
+
+      it "nulls: :low works" do
+        expect(Miscellany::SortLang.sqlize([
+          { column: "created_at", order: "ASC", nulls: :low },
+        ])).to eql "created_at ASC NULLS FIRST"
+        expect(Miscellany::SortLang.sqlize([
+          { column: "created_at", order: "DESC", nulls: :low },
+        ])).to eql "created_at DESC NULLS LAST"
+      end
+    end
+  end
+
+  describe Miscellany::SortLang::Parser do
+    let(:valid_sorts) {[
+      "title", "created_at"
+    ]}
+    let(:default_sort) { "title" }
+
+    let(:subject) { Miscellany::SortLang::Parser.new(valid_sorts, default: default_sort) }
+
+    context "with multiple default sorts" do
+      let(:default_sort) { ["title", "created_at"] }
+
+      it "includes each" do
+        expect(subject.parse(nil)).to eql [
+          {:column=>"title", :force_order=>false, :key=>"title"},
+          {:column=>"created_at", :force_order=>false, :key=>"created_at"},
+        ]
+      end
+    end
+
+    describe "#parse" do
+      it "excludes uknown sorts" do
+        expect(subject.parse("updated_at")).to eql [
+          {:column=>"title", :force_order=>false, :key=>"title"},
+        ]
+      end
+
+      it "considers force_order" do
+        subject = Miscellany::SortLang::Parser.new([ "title ASC!" ])
+        expect(subject.parse("title DESC")).to eql [
+          {:column=>"title", :force_order=>true, :key=>"title", :order=>"ASC"},
+        ]
+      end
+
+      it "returns the default sort if no sort is given" do
+        expect(subject.parse("")).to eql [
+          {:column=>"title", :force_order=>false, :key=>"title"},
+        ]
+        expect(subject.parse("", default: true)).to eql [
+          {:column=>"title", :force_order=>false, :key=>"title"},
+        ]
+      end
+
+      it "appends the default sort" do
+        expect(subject.parse("created_at", default: :append)).to eql [
+          {:column=>"created_at", :force_order=>false, :key=>"created_at"},
+          {:column=>"title", :force_order=>false, :key=>"title"},
+        ]
+      end
+
+      it "excludes the default sort" do
+        expect(subject.parse("created_at", default: false)).to eql [
+          {:column=>"created_at", :force_order=>false, :key=>"created_at"},
+        ]
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: miscellany
 version: !ruby/object:Gem::Version
-  version: 0.1.17
+  version: 0.1.19
 platform: ruby
 authors:
 - Ethan Knapp
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-29 00:00:00.000000000 Z
+date: 2023-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -149,6 +149,7 @@ files:
 - spec/miscellany/goldiload_value_spec.rb
 - spec/miscellany/param_validator_spec.rb
 - spec/miscellany/sliced_response_spec.rb
+- spec/miscellany/sort_lang_spec.rb
 - spec/spec_helper.rb
 homepage: https://instructure.com
 licenses: []
@@ -174,6 +175,7 @@ specification_version: 4
 summary: Gem for a bunch of random, re-usable Rails Concerns & Helpers
 test_files:
 - spec/db/database.yml
+- spec/miscellany/sort_lang_spec.rb
 - spec/miscellany/arbitrary_prefetch_spec.rb
 - spec/miscellany/sliced_response_spec.rb
 - spec/miscellany/param_validator_spec.rb