trailblazer-finder 0.1.4 → 0.2.5

data/Gemfile

@@ -1,8 +1,8 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec
 
-gem 'coveralls', require: false
+gem "pry-byebug"
 
 # Had to add this for a bit, since none of the latest changes have been pushed to gems yet
 # gem "trailblazer", github: "trailblazer/trailblazer"

data/LICENSE.txt

@@ -1,23 +1,9 @@
-Copyright (c) 2018 Trailblazer GmbH and contributors, released under the MIT
-license.
+Copyright (c) 2018 Trailblazer GmbH
 
-MIT License
+Trailblazer is an Open Source project licensed under the terms of
+the LGPLv3 license.  Please see <http://www.gnu.org/licenses/lgpl-3.0.html>
+for license text.
 
-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.
+Trailblazer Enterprise has a commercial-friendly license allowing private forks
+and modifications of Trailblazer.  Please see http://trailblazer.to/enterprise/ for
+more detail.  You can find the commercial license terms in COMM-LICENSE.

data/README.md

@@ -1,48 +1,44 @@
+# THIS IS MOSTLY OUT OF DATE
+
+# NEW README AND RELEASE COMING NEXT WEEK
 
 # Trailblazer Finder
 
-Description should come here
+Provides DSL for creating [Trailblazer](https://github.com/trailblazer/trailblazer) based Finder Objects. But it is designed to be used on its own as a separate gem. It was influenced by popular [Ransack](https://github.com/activerecord-hackery/ransack) gem, but in addition to [ActiveRecord](https://github.com/rails/rails/tree/master/activerecord), it can be used with [DataMapper](https://github.com/datamapper) or [Sequel](https://github.com/jeremyevans/sequel). It also integrates with [Kaminari](https://github.com/kaminari/kaminari) or [Will Paginate](https://github.com/mislav/will_paginate), as well as [FriendlyId](https://github.com/norman/friendly_id)
 
-[![Gitter Chat](https://badges.gitter.im/trailblazer/chat.svg)](https://gitter.im/trailblazer/chat) [![Build Status](https://secure.travis-ci.org/trailblazer/trailblazer-finder.svg)](https://travis-ci.org/trailblazer/trailblazer-finder) [![Coverage Status](https://coveralls.io/repos/github/trailblazer/trailblazer-finder/badge.svg?branch=master)](https://coveralls.io/github/trailblazer/trailblazer-finder?branch=master)
+[![Gitter Chat](https://badges.gitter.im/trailblazer/chat.svg)](https://gitter.im/trailblazer/chat) 
+[![Build Status](https://secure.travis-ci.org/trailblazer/trailblazer-finder.svg)](https://travis-ci.org/trailblazer/trailblazer-finder) 
 
 ## Table of Contents
 
 * [Installation](#installation)
-	* [Dependencies](#dependencies)
+  * [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)
-		* [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)
-			* [Active Record Example](#active-record-example)
-		* [DataMapper](#data_mapper)
-			* [Data Mapper Example](#data-mapper-example)
-		* [Sequel](#sequel)
-			* [Sequel Example](#sequel-example)
-		* [Kaminari](#kaminari)
-			* [Kaminari Example](#kaminari-example)
-		* [WillPaginate](#will_paginate)
-			* [Will Paginate Example](#will-paginate-example)
-		* [FriendlyId](#friendly_id)
-			* [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)
+  * [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)
+    * [Predicates](#predicate)
+      * [Predicates Example](#predicates-example)
+    * [Paging](#paging)
+      * [Paging Example](#paging-example)
+    * [Sorting](#sorting)
+      * [Sorting Example](#sorting-example)
+  * [Adapters](#adapters)
+    * [Adapters Example](#adapters-example)
+    * [ActiveRecord](#active_record)
+      * [Active Record Example](#active-record-example)
+    * [Sequel](#sequel)
+      * [Sequel Example](#sequel-example)
+  * [Tips & Tricks](#tips--tricks)
+  * [ORM's are not required](#results-shortcut)
+  * [Passing Entity as Argument](#passing-entity-as-argument)
 * [Contributing](#contributing)
-* [License](#license)
+* [License](LICENSE.txt)
 
 ## Installation
 
@@ -61,6 +57,7 @@ Or install it yourself as:
     $ gem install trailblazer-finder
 
 ### Dependencies
+* [Trailblazer-Activity](https://github.com/trailblazer/trailblazer-activity) - required
 * [Trailblazer](https://github.com/trailblazer/trailblazer) - [actually optional, but requires 2.1+](https://github.com/trailblazer/trailblazer-finder#usable-without-trailblazer)
 
 ## Usage
@@ -70,77 +67,60 @@ Just inherit from the ```Trailblazer::Finder``` class.
 
 Features and adapters are optional. However.
 
-NOTE: features only work if they're specified on top of your Finder class
+NOTE: features are only applied if their options are specified in your finder
 
-An Entity Type is required, but can:
+An Entity (model) is required, but can:
 * be defined in the inherited Finder class
 * be given as an option in the call
 
-Basically for most use cases, Entity Type is the entity/model/array of hashes you wish to use finder on
+Be sure to specify features you wish to use in your finder, before specifying adapters.
+
+Basically for most use cases, Entity is the entity/model/array of hashes you wish to use finder on
 
 #### Finder Example
 
 ```ruby
 class Post::Finder < Trailblazer::Finder
-	# Optional features
-  features Paging, Sorting
+  # Without defining an ORM everything defaults to dealing with hash objects
+  adapters :ActiveRecord
 
   # Optional if you use it as option in the caller, Model/Entity or Array with Hashes
-  entity_type { Post }
-
-  # Without defining an ORM everything defaults to dealing with an
-  # array with Hashes
-  adapters ActiveRecord, Kaminari
+  entity { Post }
 
-  # Pagination settings (remove if not using the Paging feature)
-  per_page 25
-  min_per_page 10
-  max_per_page 100
+  # Pagination settings (don't use it if you don't wish to use paging)
+  paging per_page: 5, min_per_page: 1, max_per_page: 100
 
-  # Sortable attributes (remove if not using the Sorting feature)
-  sortable_by :id, :title, :created_at
-
-  # Runs filter_by to filter results
+  # Property
+  # Set the properties with their respective options
+  #
+  # Params:
+  #  * +name+::         The property name (attribute /column / field - name) (required)
+  #  * +type:+::         Dry Types type, for future validations (required)
+  #
+  #  * Following is optional (don't use it if you do not wish to use sorting)
+  #    * +sortable:+::       Can this property be sorted on? (default: false)
+  #    * +sort_direction:+:: Specify default sort direction (only usable if sortable is true)
+  #                          (default: :desc)
+  property :id, type: Types::Integer
+  property :body, type: Types::String, sortable: true
+  property :title, type: Types::String, sortable: true, sort_direction: :asc
+
+  # Filter By
+  # A simple way to make custom filter methods
   #
   # Params:
-  #  * +attribute+::     The attribute to be filtered on
+  #  * +parameter+::     The parameter to use to call this filter (required)
   #
   #  * Following is optional, matches exact value if not specified
   #    * +with:+::       Filter method defined in Finder class
-  #    * +defined_by:+:: Array of filter Methods defined in Finder class
-  #                      method name: apply_filter_name_with_array_value
   #    * block::         A block can be given with the code to filter with
-  filter_by :id
-  filter_by :body,              with: :apply_body_filter
   filter_by :created_after,     with: :apply_created_after
-  filter_by :created_before,    with: :apply_created_before
-  filter_by :is_hot,            defined_by: %i[true false]
-  filter_by(:title)             { |entity_type, value| entity_type.where title: value }
-  filter_by(:published, false)  do |entity_type, value|
-     value ? entity_type.where('published = false') : entity_type.where('published = true')
-  end
+  filter_by(:created_before)    { |entity, _attribute, value| entity.where('DATE(created_at) <= ?', value) if value.present? }
 
   private
 
-  def apply_body_filter(entity_type, value)
-    return unless value.present?
-    entity_type.where 'lower(body) LIKE ?', Utils::Parse.term(value.downcase)
-  end
-
-  def apply_created_after(entity_type, value)
-    entity_type.where('DATE(created_at) >= ?', value) if value.present?
-  end
-
-  def apply_created_before(entity_type, value)
-    entity_type.where('DATE(created_at) <= ?', value) if value.present?
-  end
-
-  def apply_is_hot_with_true(entity_type)
-    entity_type.where 'views > 100'
-  end
-
-  def apply_is_hot_with_false(entity_type)
-    entity_type.where 'views < 100'
+  def apply_created_after(entity, _attribute, value)
+    entity.where('DATE(created_at) >= ?', value) if value.present?
   end
 end
 ```
@@ -155,7 +135,7 @@ class Post::Index < Trailblazer::Operation
   # Params:
   # +finder_class+:: Finder class to be used
   # +action+:: :all, :single (optional, defaults to :all)
-  # +entity_type+:: Entity/Model or array (optional if specified in Finder Class, overwrites Finder class entity_type)
+  # +entity+:: Entity/Model or array (optional if specified in Finder Class, overwrites Finder class entity)
   step Finder(Post::Finder, :all, Post)
 end
 ```
@@ -167,7 +147,7 @@ class Post::Index < Trailblazer::Operation
 
   # Find all matching results and extend model object with required methods
   def finder!(options, params:, **)
-    options[:finder] = Post::Finder.new(filter: params['f'], page: params['page'], per_page: params['per_page'])
+    options[:finder] = Post::Finder.new(params: params)
   end
 
   # Find first matching row, no method extension on model object
@@ -177,32 +157,26 @@ class Post::Index < Trailblazer::Operation
     apply_id(params)
 
     # No paging, sorting, no methods and only returns the first matched result
-    options[:finder] = Post::Finder.new(filter: params['f']).results.first
+    options[:finder] = Post::Finder.new(params: params).result.first
   end
 
   # Since ID's are usually given directly, patch it into filter
   def apply_id(params)
     return if params[:id].nil?
-    params[:f] = {} unless params.key?('f')
-    params[:f][:id] = params[:id] unless params[:f].key?('id')
+    params[:id_eq] = params[:id] unless params.key?("id")
   end
 end
 ```
 
 When using this, result[:finder] will be extended with (not available for :single row)
 ```ruby
-# accessing filters
-.name                                    # => name filter
-.created_at                              # => created at filter
-
 # accessing results
 .count                                   # => number of found results
-.results?                                # => are there any results found
-.results                                 # => fetched results
+.result?                                # => are there any results found
+.result                                 # => fetched results
 
 # params for url generations
 .params                                  # => filter values
-.params published: false                 # => overwrites the 'published' filter
 ```
 
 
@@ -212,23 +186,22 @@ If Trailblazer isn't loaded, the ties to [Trailblazer](https://github.com/trailb
 
 #### Example without Trailblazer
 ```ruby
-result = Post::Finder.new(filter: params[:f], page: params[:page], per_page: params[:per_page])
+# If entity is specified in your finder
+result = Post::Finder.new(params: params)
+
+# If entity ism't specified in your finder
+result = Post::Finder.new(entity: Post, params: params)
 ```
 
 When using this, result will be extended with (not available for :single row)
 ```ruby
-# accessing filters
-.name                                    # => name filter
-.created_at                              # => created at filter
-
 # accessing results
 .count                                   # => number of found results
-.results?                                # => are there any results found
-.results                                 # => fetched results
+.result?                                # => are there any results found
+.result                                 # => fetched results
 
 # params for url generations
 .params                                  # => filter values
-.params published: false                 # => overwrites the 'published' filter
 ```
 
 ### Example Project
@@ -237,14 +210,9 @@ 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
+### Predicates
 Simple predicate feature, that enables you to have default predicate filters available for the specified fields.
 
 At the moment we support:
@@ -256,63 +224,71 @@ At the moment we support:
 - 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)
-
-#### Predicate Example
+- cont: contains specified value
+- not_cont: does not contain specified value
+- sw: starts with specified value
+- not_sw: does not start with specified value
+- ew: end with specified value
+- not_ew: does not end with specified value
+
+#### Predicates 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
+  entity { Post }
 
-  # 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
+  property :id, type: Types::Integer
+  property :body, type: Types::String
+  property :title, type: Types::String
 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
+# Available Predicate filters with the above example
+id_eq            # => id equals value
+id_not_eq        # => id not equals value
+id_blank         # => id blank value
+id_not_blank     # => id not blank value
+id_lt            # => id less than value (converts value to float)
+id_lte           # => id less than or equal to value (converts value to float)
+id_gt            # => id greater than value (converts value to float)
+id_gte           # => id greater than or equal to value (converts value to float)
+id_cont          # => id contains value
+id_not_cont      # => id does not contain value
+id_sw            # => id starts with
+id_not_sw        # => id does not start with
+id_ew            # => id ends with
+id_not_ew        # => id does not end with
+
+body_eq            # => body equals value
+body_not_eq        # => body not equals value
+body_blank         # => body blank value
+body_not_blank     # => body not blank value
+body_lt            # => body less than value (converts value to float)
+body_lte           # => body less than or equal to value (converts value to float)
+body_gt            # => body greater than value (converts value to float)
+body_gte           # => body greater than or equal to value (converts value to float)
+body_cont          # => body contains value
+body_not_cont      # => body does not contain value
+body_sw            # => body starts with
+body_not_sw        # => body does not start with
+body_ew            # => body ends with
+body_not_ew        # => body does not end with
+
+title_eq            # => title equals value
+title_not_eq        # => title not equals value
+title_blank         # => title blank value
+title_not_blank     # => title not blank value
+title_lt            # => title less than value (converts value to float)
+title_lte           # => title less than or equal to value (converts value to float)
+title_gt            # => title greater than value (converts value to float)
+title_gte           # => title greater than or equal to value (converts value to float)
+title_cont          # => title contains value
+title_not_cont      # => title does not contain value
+title_sw            # => title starts with
+title_not_sw        # => title does not start with
+title_ew            # => title ends with
+title_not_ew        # => title does not end with
 ```
 
 ### Paging
@@ -321,44 +297,40 @@ Really simple pagination feature, which uses the plain ```.limit``` and ```.offs
 #### Paging Example
 ```ruby
 class Post::Finder < Trailblazer::Finder
-  features Paging
-
-  filter_by :name
-  filter_by :category_name
-
-  # per page defaults to 25 (so not required)
-  per_page 10
+  entity { Post }
 
-  # Minimum items per page (not required)
-  min_per_page 5
-
-  # Maximum items per page (not required)
-  max_per_page 100
+  paging per_page: 5, min_per_page: 1, max_per_page: 100
 end
 ```
 
-This feature extends the result[:finder] object with the following methods
-```ruby
-.page                                    # => page number
-.per_page                                # => per page (10)
-.results                                 # => paginated page results
-```
-
 ### Sorting
 Really simple sorting feature, fixing the pain of dealing with sorting attributes and directions. Can sort by multiple columns/directions.
 
 #### Sorting Example
 ```ruby
 class Post::Finder < Trailblazer::Finder
-  features Sorting
+  entity { Post }
 
-  sortable_by :name, :body
+  # Property
+  # Set the properties with their respective options
+  #
+  # Params:
+  #  * +name+::         The property name (attribute /column / field - name) (required)
+  #  * +type:+::         Dry Types type, for future validations (required)
+  #
+  #  * Following is optional (don't use it if you do not wish to use sorting)
+  #    * +sortable:+::       Can this property be sorted on? (default: false)
+  #    * +sort_direction:+:: Specify default sort direction (only usable if sortable is true)
+  #                          (default: :desc)
+  property :id, type: Types::Integer
+  property :body, type: Types::String, sortable: true
+  property :title, type: Types::String, sortable: true, sort_direction: :asc
 end
 ```
 
 This feature extends the result[:finder] object with the following methods
 ```ruby
-.results                                # => Posts sorted by title DESC
+.result                                # => Posts sorted by title DESC
 
 # Smart sort checking
 .sort?('title')                         # => true
@@ -374,19 +346,21 @@ This feature extends the result[:finder] object with the following methods
 # 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 Params for sorting links (add to existing / replace with different direction if exists)
 .add_sort_params_for('title')
 
+# Remove Params for sorting links (remove from existing)
+.remove_sort_params_for('title')
+
 # New Params for sorting links (reset)
 .new_sort_params_for('title')
 ```
 
 ## Adapters
-By default, everything works with an array of hashes. You can change the default behaviour by using adapters. Adapters are not just tied to the ORM's, we also have a few adapters included that make it easier to work along with existing gems such as [Kaminari](https://github.com/kaminari/kaminari), [WillPaginate](https://github.com/mislav/will_paginate/) and [FriendlyId](https://github.com/norman/friendly_id).
+By default, everything works with an array of hashes. You can change the default behaviour by using adapters.
 
 Currently supported ORM's:
 * [ActiveRecord](https://github.com/rails/rails/tree/master/activerecord)
-* [DataMapper](https://github.com/datamapper)
 * [Sequel](https://github.com/jeremyevans/sequel)
 
 You can specify the adapters you wish to use inside your enherited Finder class.
@@ -394,8 +368,7 @@ You can specify the adapters you wish to use inside your enherited Finder class.
 ### Adapters Example
 ```ruby
 class Post::Finder < Trailblazer::Finder
-	# Features, in case you use any, need to be specified before adapters
-  adapters ActiveRecord, Kaminari, FriendlyId
+  adapters :ActiveRecord
 end
 ```
 
@@ -405,19 +378,7 @@ The only thing the [ActiveRecord](https://github.com/rails/rails/tree/master/act
 #### Active Record Example
 ```ruby
 class Post::Finder < Trailblazer::Finder
-	# Features, in case you use any, need to be specified before adapters
-  adapters ActiveRecord
-end
-```
-
-### DataMapper
-The only thing the [DataMapper](https://github.com/datamapper) adapter does, is overwrite one specific method for Paging (limit/offset) and Sorting (order) each, as well as change the default filter behaviour (from select to where). These are overwritten by the adapter to match the specific use case of [DataMapper](https://github.com/datamapper).
-
-#### Data Mapper Example
-```ruby
-class Post::Finder < Trailblazer::Finder
-	# Features, in case you use any, need to be specified before adapters
-  adapters DataMapper
+  adapters :ActiveRecord
 end
 ```
 
@@ -427,96 +388,45 @@ The only thing the [Sequel](https://github.com/jeremyevans/sequel) adapter does,
 #### Sequel Example
 ```ruby
 class Post::Finder < Trailblazer::Finder
-	# Features, in case you use any, need to be specified before adapters
-  adapters Sequel
-end
-```
-
-### Kaminari
-The only thing the [Kaminari](https://github.com/kaminari/kaminari) adapter does, is overwrite one specific method for Paging (limit/offset). These are overwritten by the adapter to match the specific use case of [Kaminari](https://github.com/kaminari/kaminari).
-
-**Note**
-Not usable without the Paging feature enabled, and requires an ORM that's supported by [Kaminari](https://github.com/kaminari/kaminari), directly or by using additional gems.
-
-#### Kaminari Example
-```ruby
-class Post::Finder < Trailblazer::Finder
-  features Paging
-  adapters ActiveRecord, Kaminari
+  adapters :Sequel
 end
 ```
-**Note**
-To use [Kaminari](https://github.com/kaminari/kaminari) in combination with [Cells](https://github.com/trailblazer/cells), you'll currently have to use [kaminari-cells](https://github.com/apotonick/kaminari-cells) and monkey-patch Kaminari by using in an initiliazer:
-```ruby
-Kaminari::Helpers::Paginator.class_eval do
-  def render(&block)
-    instance_eval(&block) if @options[:total_pages] > 1
-  end
-end
-```
-
-### WillPaginate
-The only thing the [WillPaginate](https://github.com/mislav/will_paginate/) adapter does, is overwrite one specific method for Paging (limit/offset). These are overwritten by the adapter to match the specific use case of [WillPaginate](https://github.com/mislav/will_paginate/).
 
-**Note**
-Not usable without the Paging feature enabled, and requires an ORM that's supported by [WillPaginate](https://github.com/mislav/will_paginate/), directly or by using additional gems.
+## Tips & Tricks
+### ORM's are not required
+Not even for the Paging, Predicates and Sorting features.
 
-#### Will Paginate Example
 ```ruby
 class Post::Finder < Trailblazer::Finder
-  features Paging
-  adapters ActiveRecord, WillPaginate
-end
-```
-
-### FriendlyId
-The [FriendlyId](https://github.com/norman/friendly_id) adapter was written cause I personally use it a lot, as well as to show an example of what kind of adapters we could potentially write in the future to compliment the filters with.
-
-Basically the [FriendlyId](https://github.com/norman/friendly_id) adapter adds the following filter, which automatically checks wether the id is an integer or slug and makes sure the right filter is applied on the row set:
-```ruby
-filter_by :id, with: :apply_slug_filter
-```
-
-**Note**
-Currently only tested with ActiveRecord.
-
-**Note**
-Do not set a filter_by for id or slug when using this adapter.
+  entity { fetch_product_as_hashes }
 
-#### Friendly Id Example
-```ruby
-class Post::Finder < Trailblazer::Finder
-	# Features, in case you use any, need to be specified before adapters
-  adapters ActiveRecord, FriendlyId
+  filter_by(:name)     { |entity, _attribute, value| entity.select { |product| product[:name] == value } }
+  filter_by(:category) { |entity, _attribute, value| entity.select { |product| product[:category] == value } }
 end
 ```
 
-## Tips & Tricks
-### ORM's are not required
-Not even for the Paging and Sorting features, however using additional adapters such as Kaminari, WillPaginate and FriendlyId won't work well with this.
+### Overwriting Methods
+You can have fine grained entity, by overwriting ```initialize``` method:
 
 ```ruby
 class Post::Finder < Trailblazer::Finder
-	# Features, in case you use any, need to be specified before adapters
-  entity_type { fetch_product_as_hashes }
+  property :name, type: Types::String
 
-  filter_by(:name)     { |entity_type, value| entity_type.select { |product| product[:name] == value } }
-  filter_by(:category) { |entity_type, value| entity_type.select { |product| product[:category] == value } }
+  def initialize(options = {})
+    super options.merge(entity: Product.visible_to(user))
+  end
 end
 ```
 
-### Overwriting Methods
-You can have fine grained entity_type, by overwriting ```initialize``` method:
+You can have fine grained result set, by overwriting ```fetch_result``` method:
 
 ```ruby
 class Post::Finder < Trailblazer::Finder
-	# Features, in case you use any, need to be specified before adapters
+  property :name, type: Types::String
 
-  filter_by :name
-  filter_by :category_name
-
-  def initialize(user, options = {})
-    super options.merge(entity_type: Product.visible_to(user))
+  def fetch_result
+    super
+    result.merge! test: "I added this"
   end
 end
 ```
@@ -546,28 +456,3 @@ If you are able to, it helps even more if you can fork Trailblazer-Finder on Git
 and add a test that reproduces the error you are experiencing.
 
 For more info on how to report bugs, please see [this article](http://yourbugreportneedsmore.info/).
-
-## License
-Copyright (c) 2018 Trailblazer GmbH and contributors, released under the MIT
-license.
-
-MIT License
-
-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.