trailblazer-finder 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4608d8c90233e27fe50241948f60646d3b68babc3555357291586f83bad3f6e
-  data.tar.gz: 04fd61382d1ba953bbb36f115a7dad6491df8c8b86622593d859b000a16cdf69
+  metadata.gz: 2dbad15894d9e56c23ebe4428acfd379f5854f8948e67073ebde8c898814c1cc
+  data.tar.gz: f265dd84d1b25458fa630823c7c526628017d79e786e5bb362a043f75d864295
 SHA512:
-  metadata.gz: 7723c58c1ecccad895806fde42004a1b74d478ed87020f0ea022f1e146854909c246cb7bd6e64e0bbc3c7f585a29c4bcb3d351b309bcaaa5f4fa52d581c4f219
-  data.tar.gz: 129524c2f2ab3ac5249cdacd941405239a0f1389534b7418005e1b31bb8cba712e49df7454257047fa8a0361d1e4e0098dc2e1dafcd2925ffb77363e0a365c1e
+  metadata.gz: 2ae3bf32a2ece475570a67222bd371e5092df9a56bf6a195da185d6071e6877da9dc946ad3b00eed0cdefe357aab85a56b2f50eba3c0e63acc06df8f9c346354
+  data.tar.gz: 3aca9b67986a6c62a8c7173bc0bf34b9238b55046dc537865405f70e75e3de6b98bb72c98e39839fd8338085ce978013380f9ff4903590010cb1ba8b514f6f9d

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-03-14 21:09:38 +0100 using RuboCop version 0.53.0.
+# on 2018-03-17 03:54:36 +0100 using RuboCop version 0.53.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -18,6 +18,15 @@ Layout/EmptyLines:
   Exclude:
     - 'spec/trailblazer/operation/finder_spec.rb'
 
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: empty_lines, no_empty_lines
+Layout/EmptyLinesAroundBlockBody:
+  Exclude:
+    - 'spec/trailblazer/finder/adapters/active_record/sorting_spec.rb'
+    - 'spec/trailblazer/finder/features/sorting_spec.rb'
+
 # Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle.
@@ -78,13 +87,12 @@ Layout/SpaceInsideParens:
   Exclude:
     - 'lib/trailblazer/finder/utils/splitter.rb'
 
-# Offense count: 5
+# Offense count: 4
 # Cop supports --auto-correct.
 Layout/TrailingWhitespace:
   Exclude:
     - 'lib/trailblazer/finder/filter.rb'
     - 'spec/trailblazer/finder/adapters/active_record/base_spec.rb'
-    - 'spec/trailblazer/finder/adapters/data_mapper/base_spec.rb'
     - 'spec/trailblazer/finder/adapters/sequel/base_spec.rb'
 
 # Offense count: 1
@@ -99,19 +107,21 @@ Lint/UnusedMethodArgument:
   Exclude:
     - 'lib/trailblazer/finder/adapters/sequel/predicates.rb'
 
-# Offense count: 2
+# Offense count: 3
 Metrics/AbcSize:
-  Max: 18
+  Max: 17
 
-# Offense count: 8
+# Offense count: 9
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 51
 
-# Offense count: 5
+# Offense count: 7
 RSpec/DescribeClass:
   Exclude:
+    - 'spec/trailblazer/finder/adapters/active_record/sorting_spec.rb'
     - 'spec/trailblazer/finder/adapters/sequel/predicates_spec.rb'
+    - 'spec/trailblazer/finder/adapters/sequel/sorting_spec.rb'
     - 'spec/trailblazer/operation/finder_spec.rb'
     - 'spec/trailblazer/operation/paging_spec.rb'
     - 'spec/trailblazer/operation/predicates_spec.rb'
@@ -170,20 +180,20 @@ Style/PerlBackrefs:
   Exclude:
     - 'lib/trailblazer/finder/utils/splitter.rb'
 
-# Offense count: 160
+# Offense count: 153
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
 # SupportedStyles: single_quotes, double_quotes
 Style/StringLiterals:
   Exclude:
     - 'lib/trailblazer/finder/adapters/sequel/predicates.rb'
-    - 'lib/trailblazer/finder/features/predicate.rb'
     - 'spec/trailblazer/finder/adapters/active_record/predicates_spec.rb'
+    - 'spec/trailblazer/finder/adapters/active_record/sorting_spec.rb'
     - 'spec/trailblazer/finder/adapters/sequel/predicates_spec.rb'
     - 'spec/trailblazer/finder/features/predicates_spec.rb'
     - 'spec/trailblazer/operation/predicates_spec.rb'
 
-# Offense count: 16
+# Offense count: 20
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, MinSize, WordRegex.
 # SupportedStyles: percent, brackets
@@ -192,9 +202,10 @@ Style/WordArray:
     - 'spec/trailblazer/finder/adapters/active_record/predicates_spec.rb'
     - 'spec/trailblazer/finder/adapters/sequel/predicates_spec.rb'
     - 'spec/trailblazer/finder/features/predicates_spec.rb'
+    - 'spec/trailblazer/finder/features/sorting_spec.rb'
     - 'spec/trailblazer/operation/predicates_spec.rb'
 
-# Offense count: 151
+# Offense count: 174
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:

data/.travis.yml

@@ -3,8 +3,6 @@ before_install:
   - gem install bundler
 matrix:
   include:
-    - rvm: 2.1
-      gemfile: Gemfile
     - rvm: 2.2
       gemfile: Gemfile
     - rvm: 2.3.1

data/CHANGES.md

@@ -1,3 +1,7 @@
+# 0.1.3
+* Added sorting by multiple columns/directions for Hash, ActiveRecord and Sequel. Temporarily disabled sorting for DataMapper Adapter until i can find the time this weekend to update that Adapter as well.
+* Due to the above, a big change in the way sorting works, and which methods are available for it
+
 # 0.1.2
 
 * Predicate feature introduced, doesn't work for old datamapper adapter yet. Default predicates covered for now: eq, not_eq, blank, not_blank, lt, lte, gt, gte

data/README.md

@@ -10,37 +10,37 @@ Description should come here
 * [Installation](#installation)
 	* [Dependencies](#dependencies)
 * [Usage](#usage)
-  * [Finder](#finder)
-	* [Finder Example](#finder-example)
-  * [Operation](#operation)
-  	* [Operation Example](#operation-example)
-  * [Usable without Trailblazer](#usable-without-trailblazer)
-    * [Example without Trailblazer](#example-without-trailblazer)
-  * [Example Project](#example-project)
-  * [Features](#features)
+	* [Finder](#finder)
+		* [Finder Example](#finder-example)
+	* [Operation](#operation)
+		* [Operation Example](#operation-example)
+	* [Usable without Trailblazer](#usable-without-trailblazer)
+		* [Example without Trailblazer](#example-without-trailblazer)
+	* [Example Project](#example-project)
+	* [Features](#features)
 		* [Predicate](#predicate)
 			* [Predicate Example](#predicate-example)
 		* [Paging](#paging)
-    	* [Paging Example](#paging-example)
+			* [Paging Example](#paging-example)
 		* [Sorting](#sorting)
-	  	* [Sorting Example](#sorting-example)
-  * [Adapters](#adapters)
+			* [Sorting Example](#sorting-example)
+	* [Adapters](#adapters)
 		* [Adapters Example](#adapters-example)
 		* [ActiveRecord](#active_record)
-  	  * [Active Record Example](#active-record-example)
+			* [Active Record Example](#active-record-example)
 		* [DataMapper](#data_mapper)
-  	  * [Data Mapper Example](#data-mapper-example)
+			* [Data Mapper Example](#data-mapper-example)
 		* [Sequel](#sequel)
-  	  * [Sequel Example](#sequel-example)
+			* [Sequel Example](#sequel-example)
 		* [Kaminari](#kaminari)
-  	  * [Kaminari Example](#kaminari-example)
+			* [Kaminari Example](#kaminari-example)
 		* [WillPaginate](#will_paginate)
-  	  * [Will Paginate Example](#will-paginate-example)
+			* [Will Paginate Example](#will-paginate-example)
 		* [FriendlyId](#friendly_id)
-      * [Friendly Id Example](#friendly-id-example)
+			* [Friendly Id Example](#friendly-id-example)
 	* [Tips & Tricks](#tips--tricks)
 	* [ORM's are not required](#results-shortcut)
-  	* [Passing Entity Type as Argument](#passing-entity_type-as-argument)
+	* [Passing Entity Type as Argument](#passing-entity_type-as-argument)
 * [Contributing](#contributing)
 * [License](#license)
 
@@ -60,7 +60,7 @@ Or install it yourself as:
 
     $ gem install trailblazer-finder
 
-###
+### Dependencies
 * [Trailblazer](https://github.com/trailblazer/trailblazer) - [actually optional, but requires 2.1+](https://github.com/trailblazer/trailblazer-finder#usable-without-trailblazer)
 
 ## Usage
@@ -237,6 +237,11 @@ Coming soon!
 ## Features
 Aside of the default filtering behavior, it offers the following optional features as well.
 
+Just for the record, you can comma seperate features and load multiple by doing
+```ruby
+features Sorting, Paging, Predicate
+```
+
 NOTE: FEATURES NEED TO BE SPECIFIED ON TOP OF YOUR CLASS
 
 ### Predicate
@@ -257,13 +262,13 @@ NOTE: PREDICATES CURRENTLY DO NOT WORK FOR THE OLD DATAMAPPER ADAPTER
 #### Predicate Example
 ```ruby
 class Post::Finder < Trailblazer::Finder
-	features Predicate
+  features Predicate
 
-	# Specify the fields you want predicates enabled for, mind you these fields need to exist on your entity_type
-	predicates_for :name, :category_name
+  # Specify the fields you want predicates enabled for, mind you these fields need to exist on your entity_type
+  predicates_for :name, :category_name
 
   filter_by :name
-	filter_by :published
+  filter_by :published
   filter_by :category_name
 
   # per page defaults to 25 (so not required)
@@ -280,36 +285,36 @@ end
 This feature extends the result[:finder] object with the following methods
 ```ruby
 # accessing filters
-.name                                    # => name filter
-.created_at                              # => created at filter
+.name							# => name filter
+.created_at						# => created at filter
 
 # Predicate filters
-.name_eq																 # => name equals filter
-.name_not_eq														 # => name not equals filter
-.name_blank 														 # => name blank filter
-.name_not_blank													 # => name not blank filter
-.name_lt																 # => name less than filter (converts value to float)
-.name_lte																 # => name less than or equal to filter (converts value to float)
-.name_gt																 # => name greater than filter (converts value to float)
-.name_gte																 # => name greater than or equal to filter (converts value to float)
-.category_name_eq												 # => category name equals filter
-.category_name_not_eq										 # => category name not equals filter
-.category_name_blank 										 # => category name blank filter
-.category_name_not_blank								 # => category name not blank filter
-.category_name_lt												 # => category name less than filter (converts value to float)
-.category_name_lte											 # => category name less than or equal to filter (converts value to float)
-.category_name_gt												 # => category name greater than filter (converts value to float)
-.category_name_gte											 # => category name greater than or equal to filter (converts value to float)
+.name_eq						# => name equals filter
+.name_not_eq					# => name not equals filter
+.name_blank 					# => name blank filter
+.name_not_blank					# => name not blank filter
+.name_lt						# => name less than filter (converts value to float)
+.name_lte						# => name less than or equal to filter (converts value to float)
+.name_gt						# => name greater than filter (converts value to float)
+.name_gte						# => name greater than or equal to filter (converts value to float)
+.category_name_eq				# => category name equals filter
+.category_name_not_eq			# => category name not equals filter
+.category_name_blank 			# => category name blank filter
+.category_name_not_blank		# => category name not blank filter
+.category_name_lt				# => category name less than filter (converts value to float)
+.category_name_lte				# => category name less than or equal to filter (converts value to float)
+.category_name_gt				# => category name greater than filter (converts value to float)
+.category_name_gte				# => category name greater than or equal to filter (converts value to float)
 
 # accessing results
-.count                                   # => number of found results
-.results?                                # => are there any results found
-.results                                 # => fetched results
-.all 																		 # => if needed, use it to get dataset (sequel for example requires you use it in some cases)
+.count							# => number of found results
+.results?						# => are there any results found
+.results						# => fetched results
+.all 							# => if needed, use it to get dataset (sequel for example requires you use it in some cases)
 
 # params for url generations
-.params                                  # => filter values
-.params published: false                 # => overwrites the 'published' filter
+.params							# => filter values
+.params published: false 		# => overwrites the 'published' filter
 ```
 
 ### Paging
@@ -318,7 +323,7 @@ Really simple pagination feature, which uses the plain ```.limit``` and ```.offs
 #### Paging Example
 ```ruby
 class Post::Finder < Trailblazer::Finder
-	features Paging
+  features Paging
 
   filter_by :name
   filter_by :category_name
@@ -342,12 +347,14 @@ This feature extends the result[:finder] object with the following methods
 ```
 
 ### Sorting
-Really simple sorting feature, fixing the pain of dealing with sorting attributes and directions. For the moment only sorting by a single attribute works, we're working on making it possible to sort by multiple attributes.
+Really simple sorting feature, fixing the pain of dealing with sorting attributes and directions. Can sort by multiple columns/directions.
+
+NOTE: AS OF 0.1.3 TEMPORARY NOT WORKING FOR DATAMAPPER ADAPTER, WE ARE WORKING ON FIXING IT
 
 #### Sorting Example
 ```ruby
 class Post::Finder < Trailblazer::Finder
-	features Sorting
+  features Sorting
 
   sortable_by :name, :body
 end
@@ -356,21 +363,26 @@ end
 This feature extends the result[:finder] object with the following methods
 ```ruby
 .results                                # => Posts sorted by title DESC
-.sort_attribute                         # => 'title'
-.sort_direction                         # => 'desc'
 
 # Smart sort checking
 .sort?('title')                         # => true
-.sort?('title desc')                    # => true
-.sort?('title asc')                     # => false
 
-# Helpers for dealing with reversing sort direction
-.reverted_sort_direction                # => 'asc'
+# Helpers for seeing current sort direction
 .sort_direction_for('title')            # => 'asc'
-.sort_direction_for('body')             # => 'desc'
+.sort_direction_for('body')           # => 'desc'
 
-# Params for sorting links
+# Helpers for seeing reversing sort direction
+.reverse_sort_direction_for('title')            # => 'desc'
+.reverse_sort_direction_for('body')          # => 'asc'
+
+# Params for sorting links (new if none exists, existing params if exists)
 .sort_params_for('title')
+
+# Add Params for sorting links (add to existing / replace with different direction)
+.add_sort_params_for('title')
+
+# New Params for sorting links (reset)
+.new_sort_params_for('title')
 ```
 
 ## Adapters

data/lib/trailblazer/finder/adapters/active_record/sorting.rb

@@ -10,8 +10,12 @@ module Trailblazer
 
           private
 
-          def sort_it(entity_type, sort_attribute, sort_direction)
-            entity_type.order sort_attribute.to_s => sort_direction
+          def sort_it(entity_type, sort_attributes)
+            entity_type.order(sort_attributes)
+          end
+
+          def sort_orders(sort_attr, sort_dir)
+            { sort_attr.to_s => sort_dir }
           end
         end
       end

data/lib/trailblazer/finder/adapters/data_mapper.rb

@@ -1,5 +1,5 @@
 require 'trailblazer/finder/adapters/data_mapper/paging'
-require 'trailblazer/finder/adapters/data_mapper/sorting'
+# require 'trailblazer/finder/adapters/data_mapper/sorting'
 
 module Trailblazer
   class Finder
@@ -23,7 +23,7 @@ module Trailblazer
         end
 
         include Paging if defined?(Features::Paging::ClassMethods)
-        include Sorting if defined?(Features::Sorting::ClassMethods)
+        # include Sorting if defined?(Features::Sorting::ClassMethods)
       end
     end
   end

data/lib/trailblazer/finder/adapters/data_mapper/sorting.rb

@@ -1,25 +1,25 @@
-module Trailblazer
-  class Finder
-    module Adapters
-      module DataMapper
-        # Sequel - Sorting Adapter
-        module Sorting
-          def self.included(base)
-            base.extend Features::Sorting::ClassMethods
-          end
-
-          private
-
-          def sort_it(entity_type, sort_attribute, sort_direction)
-            case sort_direction
-            when 'asc', 'ascending'
-              entity_type.all(order: [sort_attribute.to_sym.asc])
-            when 'desc', 'descending'
-              entity_type.all(order: [sort_attribute.to_sym.desc])
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# module Trailblazer
+#   class Finder
+#     module Adapters
+#       module DataMapper
+#         # Sequel - Sorting Adapter
+#         module Sorting
+#           def self.included(base)
+#             base.extend Features::Sorting::ClassMethods
+#           end
+#
+#           private
+#
+#           def sort_it(entity_type, sort_attribute, sort_direction)
+#             case sort_direction
+#             when 'asc', 'ascending'
+#               entity_type.all(order: [sort_attribute.to_sym.asc])
+#             when 'desc', 'descending'
+#               entity_type.all(order: [sort_attribute.to_sym.desc])
+#             end
+#           end
+#         end
+#       end
+#     end
+#   end
+# end

data/lib/trailblazer/finder/adapters/sequel/sorting.rb

@@ -10,13 +10,15 @@ module Trailblazer
 
           private
 
-          def sort_it(entity_type, sort_attribute, sort_direction)
-            case sort_direction
-            when 'asc', 'ascending'
-              entity_type.order(sort_attribute.to_sym)
-            when 'desc', 'descending'
-              entity_type.reverse(sort_attribute.to_sym)
-            end
+          def sort_orders(sort_attr, sort_dir)
+            ::Sequel.send sort_dir, sort_attr.to_sym
+          end
+
+          def sort_it(entity_type, sort_attributes)
+            result = []
+            result << [:order, sort_attributes.first] if sort_attributes.is_a? Array
+            sort_attributes.drop(1).each { |x| result << [:order_append, x] }
+            result.inject(entity_type) { |obj, method_and_args| obj.send(*method_and_args) }
           end
         end
       end