trailblazer-finder 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5026306e94df40bcd37f944f4c532d2ebd4686d6ee086fff5d1e7e1202cc9f7
-  data.tar.gz: b05d37c15a0bc5dc704b5883001a004b5c486da722552a870b89bf9f79eb7c73
+  metadata.gz: f4608d8c90233e27fe50241948f60646d3b68babc3555357291586f83bad3f6e
+  data.tar.gz: 04fd61382d1ba953bbb36f115a7dad6491df8c8b86622593d859b000a16cdf69
 SHA512:
-  metadata.gz: b366ef3762c765f0588ed5a9df87c5860ef292fe66bb05d148ca953dd208f53d58eb9bf1ed0816e9723a1da54f2b2e774a7d2f7ecb5a877a3e991878ec9bb0f8
-  data.tar.gz: f247283b226cd2de4f5ea6e1ca51cb0aa03679e295359dc99e85b5ed80260008a055788719fe280ea7f65716f032ec3b96861224a1a671d679650d224a2818b6
+  metadata.gz: 7723c58c1ecccad895806fde42004a1b74d478ed87020f0ea022f1e146854909c246cb7bd6e64e0bbc3c7f585a29c4bcb3d351b309bcaaa5f4fa52d581c4f219
+  data.tar.gz: 129524c2f2ab3ac5249cdacd941405239a0f1389534b7418005e1b31bb8cba712e49df7454257047fa8a0361d1e4e0098dc2e1dafcd2925ffb77363e0a365c1e

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-03-05 19:59:14 +0100 using RuboCop version 0.53.0.
+# on 2018-03-14 21:09:38 +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
@@ -8,11 +8,9 @@
 
 # Offense count: 1
 # Cop supports --auto-correct.
-# Configuration parameters: Include, TreatCommentsAsGroupSeparators.
-# Include: **/*.gemfile, **/Gemfile, **/gems.rb
-Bundler/OrderedGems:
+Layout/CommentIndentation:
   Exclude:
-    - 'Gemfile'
+    - 'spec/trailblazer/finder/adapters/sequel/predicates_spec.rb'
 
 # Offense count: 1
 # Cop supports --auto-correct.
@@ -20,14 +18,123 @@ Layout/EmptyLines:
   Exclude:
     - 'spec/trailblazer/operation/finder_spec.rb'
 
-# Offense count: 3
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines
+Layout/EmptyLinesAroundModuleBody:
+  Exclude:
+    - 'lib/trailblazer/finder/adapters/sequel/predicates.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: normal, rails
+Layout/IndentationConsistency:
+  Exclude:
+    - 'spec/trailblazer/finder/adapters/sequel/predicates_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: Width, IgnoredPatterns.
+Layout/IndentationWidth:
+  Exclude:
+    - 'spec/trailblazer/finder/adapters/sequel/predicates_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/SpaceAroundKeyword:
+  Exclude:
+    - 'spec/trailblazer/finder/features/predicates_spec.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment.
+Layout/SpaceAroundOperators:
+  Exclude:
+    - 'spec/trailblazer/finder/features/predicates_spec.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces.
+# SupportedStyles: space, no_space
+# SupportedStylesForEmptyBraces: space, no_space
+Layout/SpaceBeforeBlockBraces:
+  Exclude:
+    - 'lib/trailblazer/finder/adapters/sequel/predicates.rb'
+
+# Offense count: 8
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
+# SupportedStyles: space, no_space
+# SupportedStylesForEmptyBraces: space, no_space
+Layout/SpaceInsideBlockBraces:
+  Exclude:
+    - 'lib/trailblazer/finder/adapters/sequel/predicates.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+Layout/SpaceInsideParens:
+  Exclude:
+    - 'lib/trailblazer/finder/utils/splitter.rb'
+
+# Offense count: 5
+# 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
+Lint/DuplicateMethods:
+  Exclude:
+    - 'lib/trailblazer/finder/utils/splitter.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods.
+Lint/UnusedMethodArgument:
+  Exclude:
+    - 'lib/trailblazer/finder/adapters/sequel/predicates.rb'
+
+# Offense count: 2
+Metrics/AbcSize:
+  Max: 18
+
+# Offense count: 8
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 51
+
+# Offense count: 5
 RSpec/DescribeClass:
   Exclude:
+    - 'spec/trailblazer/finder/adapters/sequel/predicates_spec.rb'
     - 'spec/trailblazer/operation/finder_spec.rb'
     - 'spec/trailblazer/operation/paging_spec.rb'
+    - 'spec/trailblazer/operation/predicates_spec.rb'
     - 'spec/trailblazer/operation/sorting_spec.rb'
 
-# Offense count: 14
+# Offense count: 40
+# Configuration parameters: CustomTransform, IgnoredWords.
+RSpec/ExampleWording:
+  Exclude:
+    - '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/operation/predicates_spec.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: prefer_alias, prefer_alias_method
+Style/Alias:
+  Exclude:
+    - 'lib/trailblazer/finder/utils/splitter.rb'
+
+# Offense count: 18
 # Cop supports --auto-correct.
 # Configuration parameters: AutoCorrect, EnforcedStyle.
 # SupportedStyles: nested, compact
@@ -35,18 +142,60 @@ Style/ClassAndModuleChildren:
   Exclude:
     - 'spec/trailblazer/operation/finder_spec.rb'
     - 'spec/trailblazer/operation/paging_spec.rb'
+    - 'spec/trailblazer/operation/predicates_spec.rb'
     - 'spec/trailblazer/operation/sorting_spec.rb'
 
-# Offense count: 10
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/IfUnlessModifier:
+  Exclude:
+    - 'lib/trailblazer/finder/utils/deep_locate.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: IncludeSemanticChanges.
+Style/NonNilCheck:
+  Exclude:
+    - 'lib/trailblazer/finder/predicates.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/ParallelAssignment:
+  Exclude:
+    - 'lib/trailblazer/finder/utils/splitter.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/PerlBackrefs:
+  Exclude:
+    - 'lib/trailblazer/finder/utils/splitter.rb'
+
+# Offense count: 160
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
 # SupportedStyles: single_quotes, double_quotes
 Style/StringLiterals:
   Exclude:
-    - 'Gemfile'
+    - '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/sequel/predicates_spec.rb'
+    - 'spec/trailblazer/finder/features/predicates_spec.rb'
+    - 'spec/trailblazer/operation/predicates_spec.rb'
+
+# Offense count: 16
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, MinSize, WordRegex.
+# SupportedStyles: percent, brackets
+Style/WordArray:
+  Exclude:
+    - '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/operation/predicates_spec.rb'
 
-# Offense count: 89
+# Offense count: 151
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:
-  Max: 128
+  Max: 172

data/CHANGES.md

@@ -1,3 +1,8 @@
+# 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
+* Removed Hashie as dependency and introduced simple version of deep_locate
+
 # 0.1.1
 
 * load options[:model] with result set otherwise loading contracts fails, have to find a nicer solution for this at some point

data/README.md

@@ -18,25 +18,27 @@ Description should come here
     * [Example without Trailblazer](#example-without-trailblazer)
   * [Example Project](#example-project)
   * [Features](#features)
-	* [Paging](#paging)
-      * [Paging Example](#paging-example)
-	* [Sorting](#sorting)
-  	  * [Sorting Example](#sorting-example)
+		* [Predicate](#predicate)
+			* [Predicate Example](#predicate-example)
+		* [Paging](#paging)
+    	* [Paging Example](#paging-example)
+		* [Sorting](#sorting)
+	  	* [Sorting Example](#sorting-example)
   * [Adapters](#adapters)
-	* [Adapters Example](#adapters-example)
-	* [ActiveRecord](#active_record)
+		* [Adapters Example](#adapters-example)
+		* [ActiveRecord](#active_record)
   	  * [Active Record Example](#active-record-example)
-	* [DataMapper](#data_mapper)
+		* [DataMapper](#data_mapper)
   	  * [Data Mapper Example](#data-mapper-example)
-	* [Sequel](#sequel)
+		* [Sequel](#sequel)
   	  * [Sequel Example](#sequel-example)
-	* [Kaminari](#kaminari)
+		* [Kaminari](#kaminari)
   	  * [Kaminari Example](#kaminari-example)
-	* [WillPaginate](#will_paginate)
+		* [WillPaginate](#will_paginate)
   	  * [Will Paginate Example](#will-paginate-example)
-	* [FriendlyId](#friendly_id)
+		* [FriendlyId](#friendly_id)
       * [Friendly Id Example](#friendly-id-example)
-* [Tips & Tricks](#tips--tricks)
+	* [Tips & Tricks](#tips--tricks)
 	* [ORM's are not required](#results-shortcut)
   	* [Passing Entity Type as Argument](#passing-entity_type-as-argument)
 * [Contributing](#contributing)
@@ -59,7 +61,6 @@ Or install it yourself as:
     $ gem install trailblazer-finder
 
 ###
-* [Hashie](https://github.com/intridea/hashie) - used to search deep within hashes/arrays
 * [Trailblazer](https://github.com/trailblazer/trailblazer) - [actually optional, but requires 2.1+](https://github.com/trailblazer/trailblazer-finder#usable-without-trailblazer)
 
 ## Usage
@@ -201,7 +202,7 @@ When using this, result[:finder] will be extended with (not available for :singl
 
 # params for url generations
 .params                                  # => filter values
-.params active: false                    # => overwrites the 'active' filter
+.params published: false                 # => overwrites the 'published' filter
 ```
 
 
@@ -227,20 +228,92 @@ When using this, result will be extended with (not available for :single row)
 
 # params for url generations
 .params                                  # => filter values
-.params active: false                    # => overwrites the 'active' filter
+.params published: false                 # => overwrites the 'published' filter
 ```
 
 ### Example Project
 Coming soon!
 
 ## Features
-Aside of the default filtering behaviour, it offers the following optional features as well.
+Aside of the default filtering behavior, it offers the following optional features as well.
 
 NOTE: FEATURES NEED TO BE SPECIFIED ON TOP OF YOUR CLASS
 
-### Paging
+### Predicate
+Simple predicate feature, that enables you to have default predicate filters available for the specified fields.
+
+At the moment we support:
+- eq: equals to
+- not_eq: not equals to
+- blank: blank (empty/nil/nul)
+- not_blank: not blank (empty/nil/null)
+- lt: less than (value converts to float)
+- lte: less than or equal to (value converts to float)
+- gt: greater than (value converts to float)
+- gte: greater than or equal to (value converts to float)
+
+NOTE: PREDICATES CURRENTLY DO NOT WORK FOR THE OLD DATAMAPPER ADAPTER
+
+#### Predicate Example
+```ruby
+class Post::Finder < Trailblazer::Finder
+	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
+
+  filter_by :name
+	filter_by :published
+  filter_by :category_name
+
+  # per page defaults to 25 (so not required)
+  per_page 10
+
+  # Minimum items per page (not required)
+  min_per_page 5
+
+  # Maximum items per page (not required)
+  max_per_page 100
+end
+```
+
+This feature extends the result[:finder] object with the following methods
+```ruby
+# accessing filters
+.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)
+
+# 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)
+
+# params for url generations
+.params                                  # => filter values
+.params published: false                 # => overwrites the 'published' filter
+```
 
-Really simple pagination plugin, which uses the plain ```.limit``` and ```.offset``` methods.
+### Paging
+Really simple pagination feature, which uses the plain ```.limit``` and ```.offset``` methods.
 
 #### Paging Example
 ```ruby
@@ -268,10 +341,8 @@ This feature extends the result[:finder] object with the following methods
 .results                                 # => paginated page results
 ```
 
-### Sorting Plugin
-
-Fixing the pain of dealing with sorting attributes and directions.
-
+### 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.
 
 #### Sorting Example
 ```ruby

data/lib/trailblazer/finder.rb

@@ -9,11 +9,14 @@ require 'trailblazer/finder/utils/params'
 require 'trailblazer/finder/utils/parse'
 require 'trailblazer/finder/utils/string'
 require 'trailblazer/finder/utils/extra'
+require 'trailblazer/finder/utils/splitter'
+require 'trailblazer/finder/utils/deep_locate'
 require 'trailblazer/finder/base'
 require 'trailblazer/finder/find'
 require 'trailblazer/finder/filter'
 require 'trailblazer/finder/features'
 require 'trailblazer/finder/adapters'
+require 'trailblazer/finder/predicates'
 
 # :nocov:
 require 'trailblazer/operation/finder' if Gem.loaded_specs.key?('trailblazer')

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

@@ -1,5 +1,6 @@
 require 'trailblazer/finder/adapters/active_record/paging'
 require 'trailblazer/finder/adapters/active_record/sorting'
+require 'trailblazer/finder/adapters/active_record/predicates'
 
 module Trailblazer
   class Finder
@@ -8,6 +9,9 @@ module Trailblazer
       module ActiveRecord
         def self.included(base)
           base.extend ClassMethods
+          base.instance_eval do
+            include ActiveRecord::Predicates if defined?(Features::Predicate::ClassMethods)
+          end
         end
 
         module ClassMethods

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

@@ -0,0 +1,42 @@
+module Trailblazer
+  class Finder
+    module Adapters
+      module ActiveRecord
+        # ActiveRecord - Predicate Adapter
+        module Predicates
+          def not_eq(attribute, value, entity_type)
+            entity_type.where.not(attribute => value)
+          end
+
+          def eq(attribute, value, entity_type)
+            entity_type.where(attribute => value)
+          end
+
+          def blank(attribute, _value, entity_type)
+            entity_type.where(attribute.to_sym => [nil, ''])
+          end
+
+          def not_blank(attribute, _value, entity_type)
+            entity_type.where.not(attribute.to_sym => [nil, ''])
+          end
+
+          def gt(attribute, value, entity_type)
+            entity_type.where(["#{attribute} > ?", value.to_f])
+          end
+
+          def gte(attribute, value, entity_type)
+            entity_type.where(["#{attribute} >= ?", value.to_f])
+          end
+
+          def lt(attribute, value, entity_type)
+            entity_type.where(["#{attribute} < ?", value.to_f])
+          end
+
+          def lte(attribute, value, entity_type)
+            entity_type.where(["#{attribute} <= ?", value.to_f])
+          end
+        end
+      end
+    end
+  end
+end