json_api_filter 0.1.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b8ea65bebb5e2456a2009eea40099f2f000a4bc9c83ed79d3d4207c7b86cbdf
-  data.tar.gz: eaaa75be388a45dd56755d47a94956597befeb4db09bd15de5ec8832b047fdef
+  metadata.gz: a0e5c959706685cf6cc047d4824c7ed0e0c35778b6b952aa3b305e5e0eb40f13
+  data.tar.gz: 3a87503e2341ae745d0ec6b5154049c95b0a28b527aeb8903ed000e53685bf3b
 SHA512:
-  metadata.gz: 2c383c8c9602a81549fcc45b016b262e07d99c16c90239fcd390057503dbb3773a3ed07ccf86b06157a65b85f0d86e1742dd7465ab9c1c5bd46a0a48c46e8790
-  data.tar.gz: 3c52afa46d6f74466f561af5a7f896a77af6b41440c8b2cac75f11c87a19f1fe26c61bdac86521853dddc8d415b257179a7d65be394083444ad2c6d82b0b4134
+  metadata.gz: fee62197e5d3814185e35f7935b76daba4c96dcabd2e655e250512f3267e8295512fffe16301df3b18b089c4eb5b5cbed1a120793dd60518929aa666ba16b5e2
+  data.tar.gz: c183c0a031bac479dfa66baf3cb90a9ef6735719c7dc61a12fcbda50412a0239e5dcd6ca4ebd3ddffae23588f9cd90793123a79cd2a44107723a9f869b5d4b2f

data/.gitignore

@@ -9,4 +9,7 @@
 
 # rspec failure tracking
 .rspec_status
-/.idea/
+/.idea/
+/spec/dummy/db/development.sqlite3
+/spec/dummy/db/test.sqlite3
+/spec/dummy/log/

data/.travis.yml

@@ -5,3 +5,6 @@ cache: bundler
 rvm:
   - 2.6.3
 before_install: gem install bundler -v 1.17.2
+script:
+  - (cd spec/dummy && RAILS_ENV=test bundle exec rails db:setup)
+  - bundle exec rspec

data/Gemfile.lock

@@ -1,39 +1,161 @@
 PATH
   remote: .
   specs:
-    json_api_filter (0.1.1)
+    json_api_filter (0.2)
       activesupport (>= 3.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.3)
+    actioncable (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activestorage (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      mail (>= 2.7.1)
+    actionmailer (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      actionview (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.3.1)
+      actionview (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activestorage (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.3.1)
+      activesupport (= 6.1.3.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.3.1)
+      activesupport (= 6.1.3.1)
+      globalid (>= 0.3.6)
+    activemodel (6.1.3.1)
+      activesupport (= 6.1.3.1)
+    activerecord (6.1.3.1)
+      activemodel (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+    activestorage (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      marcel (~> 1.0.0)
+      mini_mime (~> 1.0.2)
+    activesupport (6.1.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
+    builder (3.2.4)
+    byebug (11.1.3)
     concurrent-ruby (1.1.8)
-    diff-lcs (1.3)
-    i18n (1.8.9)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    erubi (1.10.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
+    loofah (2.9.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.1)
+    method_source (1.0.0)
+    mini_mime (1.0.3)
+    mini_portile2 (2.5.0)
     minitest (5.14.4)
-    rake (13.0.1)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.0)
-      rspec-support (~> 3.9.0)
-    rspec-expectations (3.9.0)
+    nio4r (2.5.7)
+    nokogiri (1.11.2)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    racc (1.5.2)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.1.3.1)
+      actioncable (= 6.1.3.1)
+      actionmailbox (= 6.1.3.1)
+      actionmailer (= 6.1.3.1)
+      actionpack (= 6.1.3.1)
+      actiontext (= 6.1.3.1)
+      actionview (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activemodel (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activestorage (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      bundler (>= 1.15.0)
+      railties (= 6.1.3.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (~> 1.0)
+    rake (13.0.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.0)
+      rspec-support (~> 3.10.0)
+    rspec-rails (5.0.1)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      railties (>= 5.2)
+      rspec-core (~> 3.10)
+      rspec-expectations (~> 3.10)
+      rspec-mocks (~> 3.10)
+      rspec-support (~> 3.10)
+    rspec-support (3.10.2)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.2)
+    thor (1.1.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
+    websocket-driver (0.7.3)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
     zeitwerk (2.4.2)
 
 PLATFORMS
@@ -41,9 +163,13 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.16)
+  byebug
   json_api_filter!
+  rails
   rake (~> 13.0)
-  rspec (~> 3.0)
+  rspec (>= 3.0)
+  rspec-rails
+  sqlite3
 
 BUNDLED WITH
    1.17.2

data/README.md

@@ -1,8 +1,10 @@
 # JsonApiFilter
 
-Filter for rails controller based on JsonAPI spec: `/books?filter[library_id]=1,2&filter[author_id]=12`
+Filter for rails controller based on JsonAPI spec: `/books?filter[library_id]=1,2&filter[author_id][eq]=12&filter[created_at][gt]=2021-02-02`
 
+[![Maintainability](https://api.codeclimate.com/v1/badges/f620f88131ea9d8ff650/maintainability)](https://codeclimate.com/github/Blaked84/json_api_filter/maintainability)
 [![Gem Version](https://badge.fury.io/rb/json_api_filter.svg)](https://badge.fury.io/rb/json_api_filter)
+[![Build Status](https://travis-ci.com/Blaked84/json_api_filter.svg?branch=master)](https://travis-ci.com/Blaked84/json_api_filter)
 
 ## Installation
 
@@ -13,27 +15,30 @@ gem 'json_api_filter'
 ```
 
 And then execute:
-
-    $ bundle
+```bash
+$ bundle
+```
 
 Or install it yourself as:
-
-    $ gem install json_api_filter
+```bash
+$ gem install json_api_filter
+```
 
 ## Usage
 
 ### Quick start
 
-To filter this request `/books?filter[library_id]=1,2&filter[author_id]=12`
+To filter this request `/books?filter[library_id]=1,2&filter[author_id]=12&search=Lord of the ring`
 
 ```ruby
 class Book < ApplicationController
 
   include JsonApiFilter
   permitted_filters  %i[library_id author_id]
+  permitted_searches :user_search
   
   def index
-    @books = Book.all.where(attr_filter(params))
+    @books = json_api_filter(Book, params)
   end
     
 end
@@ -41,7 +46,27 @@ end
 ```
 
 - `permitted_filters` let you define allowed attributes to filter on (mandatory)
-- `filter_by_attr(params)` return a hash with the filter from the request params
+- `permitted_searches` let you define the allowed search method defined in you model what will be called if you pass `search` params in your request (can be a pg_search scope)
+- `json_api_filter(scope, params)` return an active record relation (`Book::` in this example)
+  
+## Migration from 0.1
+0.2.x version is not compatible with 0.1
+In your controller, you will have to replace all occurrences of `attr_filter` as bellow :
+
+### Before
+```ruby
+def index 
+  @books = Book.all.where(attr_filter(params))
+end
+```
+
+### After
+```ruby
+def index
+  @books = json_api_filter(Book, params)
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/json_api_filter.gemspec

@@ -37,6 +37,10 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec", ">= 3.0"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency 'rails'
+  spec.add_development_dependency 'byebug'
   spec.add_dependency "activesupport", ">= 3.0.0"
 end

data/lib/json_api_filter.rb

@@ -1,6 +1,14 @@
 require "json_api_filter/version"
-require "json_api_filter/filters"
-require "json_api_filter/filter_by"
+require "json_api_filter/auto_join"
+require "json_api_filter/dispatch"
+require "json_api_filter/filter_attributes"
+require "json_api_filter/value_parser"
+require "json_api_filter/field_filters/base"
+require "json_api_filter/field_filters/matcher"
+require "json_api_filter/field_filters/compare"
+require "json_api_filter/field_filters/searcher"
+require "json_api_filter/field_filters/sorter"
+require "json_api_filter/field_filters/pagination"
 require "active_support/concern"
 require "active_support/core_ext/object/blank"
 
@@ -13,16 +21,19 @@ module JsonApiFilter
 
   extend ::ActiveSupport::Concern
   included do
-
-    def attr_filter(query_params = params)
+  
+    # @param [ActiveRecord::Base] scope
+    def json_api_filter(scope, query_params = params)
       unless self.class.json_api_permitted_filters.present?
         raise ::JsonApiFilter::MissingPermittedFilterError
       end
 
-      ::JsonApiFilter::Filters.new(
-        self.class.json_api_permitted_filters,
-        query_params
-      ).to_hash
+      ::JsonApiFilter::Dispatch.new(
+        scope,
+        query_params,
+        allowed_filters: self.class.json_api_permitted_filters,
+        allowed_searches: self.class.json_api_permitted_searches
+      ).process
     end
 
     def self.permitted_filters(val)
@@ -34,5 +45,15 @@ module JsonApiFilter
     def self.json_api_permitted_filters
       []
     end
+
+    def self.permitted_searches(global, **columns)
+      define_singleton_method(:json_api_permitted_searches) do
+        { global: global, columns: columns }
+      end
+    end
+
+    def self.json_api_permitted_searches
+      {}
+    end
   end
 end

data/lib/json_api_filter/auto_join.rb

@@ -0,0 +1,18 @@
+module JsonApiFilter
+  class AutoJoin
+  
+    attr_reader :association_name, :scope
+    
+    # @param [ActiveRecord::Base, ActiveRecord_Relation] scope
+    # @param [String, Symbol] association_name
+    def initialize(scope, association_name)
+      @association_name = association_name
+      @scope = scope
+    end
+    
+    def predicate
+      scope.joins(association_name.to_sym)
+    end
+    
+  end
+end

data/lib/json_api_filter/dispatch.rb

@@ -0,0 +1,112 @@
+module JsonApiFilter
+  class Dispatch
+  
+    attr_reader :params, :scope, :allowed_filters, :allowed_searches
+    
+    # @param [ActiveRecord::Base] scope
+    # @param [Hash, ActionController::Parameters] params
+    # @param [Array<Symbol>] allowed_filters
+    def initialize(scope, params, allowed_filters:, allowed_searches:)
+      @params = params
+      @scope = scope
+      @allowed_filters = allowed_filters
+      @allowed_searches = allowed_searches
+    end
+
+    # @return [ActiveRecord_Relation]
+    def process
+      @scope = [
+        scope.all,
+        sort_predicate,
+        filters_predicate,
+        search_predicate,
+        join_predicate,
+      ].compact.reduce(&:merge)
+      return scope if params[:pagination].nil?
+      scope.merge(pagination_predicate)
+    end
+    
+    private
+    
+    # @return [ActiveRecord::Base, NilClass]
+    def filters_predicate
+      #TODO: split this method
+      parser_params.fetch('filter', {}).map do |key, value|
+        next unless filters.include?(key)
+
+        if nested_filters.include?(key.to_sym)
+          next ::JsonApiFilter::FieldFilters::Matcher.new(
+            scope,
+            {key => value},
+            association: true
+          )
+        end
+
+        if value.class != ActiveSupport::HashWithIndifferentAccess
+          next ::JsonApiFilter::FieldFilters::Matcher.new(scope, {key => value})
+        end
+        
+        ::JsonApiFilter::FieldFilters::Compare.new(
+          scope,
+          {key => value},
+          allowed_searches: allowed_searches
+        )
+      end.compact.map(&:predicate).reduce(&:merge)
+    end
+
+    # @return [ActiveRecord::Base, NilClass]
+    def sort_predicate
+      sort = parser_params[:sort]
+      return nil if sort.blank?
+      
+      ::JsonApiFilter::FieldFilters::Sorter.new(scope, sort).predicate
+    end
+
+    # @return [ActiveRecord::Base, NilClass]
+    def search_predicate
+      return nil if parser_params[:search].blank?
+      return nil if allowed_searches[:global].nil?
+      
+      ::JsonApiFilter::FieldFilters::Searcher.new(
+        scope,
+        {allowed_searches[:global] => parser_params[:search]}
+      ).predicate
+    end
+
+    # @return [ActiveRecord::Base, NilClass]
+    def pagination_predicate
+      return nil if parser_params[:pagination].nil?
+      
+      ::JsonApiFilter::FieldFilters::Pagination.new(
+        scope,
+        parser_params[:pagination]
+      ).predicate
+    end
+
+    # @return [ActiveRecord::Base, NilClass]
+    def join_predicate
+      parser_params.fetch('filter', {}).map do |key, value|
+        next unless nested_filters.include?(key.to_sym)
+        
+        ::JsonApiFilter::AutoJoin.new(scope, key)
+      end.compact.map(&:predicate).reduce(&:merge)
+    end
+    
+    # @return [Hash]
+    def parser_params
+      return params.to_unsafe_h if params.class == ActionController::Parameters
+      
+      params
+    end
+    
+    # @return [Hash]
+    def filters
+      FilterAttributes.new(allowed_filters, parser_params[:filter]).process
+    end
+
+    def nested_filters
+      FilterAttributes.new(allowed_filters, parser_params[:filter]).nested_allowed_filter
+    end
+    
+  end
+end

data/lib/json_api_filter/field_filters/base.rb

@@ -0,0 +1,18 @@
+module JsonApiFilter
+  module FieldFilters
+    class Base
+      
+      attr_reader :scope, :values, :association
+
+      # @param [ActiveRecord::Base] scope
+      # @param [Hash] values
+      # @param [Boolean] association
+      def initialize(scope, values, association: false )
+        @scope = scope
+        @values = values
+        @association = association
+      end
+    
+    end
+  end
+end

data/lib/json_api_filter/field_filters/compare.rb

@@ -0,0 +1,54 @@
+
+module JsonApiFilter
+  module FieldFilters
+    class Compare < Base
+
+      attr_reader :allowed_searches
+
+      def initialize(scope, values, allowed_searches:)
+        super(scope, values)
+        @allowed_searches = allowed_searches
+      end
+  
+      # @return [ActiveRecord_Relation]
+      def predicate
+        column = values.keys.first
+        filter = values.first[1]
+        filter.map do |key, value|
+          if !WHERE_METHODS[key.to_sym].nil?
+            compare(column, key, value)
+          elsif key == "search"
+            next unless allowed_searches[:columns].keys.include?(column.to_sym)
+            ::JsonApiFilter::FieldFilters::Searcher.new(
+              scope,
+              {allowed_searches[:columns][column.to_sym] => value}
+            ).predicate
+          else
+            nil
+          end
+        end.compact.reduce(&:merge)
+      end
+      
+      private
+      
+      WHERE_METHODS = {
+        eq: "=",
+        ne: "!=",
+        gt: ">",
+        ge: ">=",
+        lt: "<",
+        le: "<=",
+      }
+      
+      def compare(column, method, value)
+        if WHERE_METHODS[method.to_sym] == "="
+          # prefer this method for eq as it implicitely transforms enum into their integer representation
+          scope.where(column => value)
+        else
+          scope.where("#{column} #{WHERE_METHODS[method.to_sym]} ?", value)
+        end
+      end
+    
+    end
+  end
+end

data/lib/json_api_filter/field_filters/matcher.rb

@@ -0,0 +1,35 @@
+module JsonApiFilter
+  module FieldFilters
+    class Matcher < Base
+  
+      # @return [ActiveRecord_Relation]
+      def predicate
+        
+        values.map do |key, value|
+          scope.where(
+            key_translation(key) => ::JsonApiFilter::ValueParser.parse(value)
+          )
+        end.reduce(&:merge)
+      end
+      
+      private
+
+      #TODO: move to another class
+      def key_translation(key)
+        return key unless association
+        
+        table_name(key)
+      end
+      
+      # @return [ActiveRecord::Base]
+      def model_klass
+        scope.try(:klass) || scope
+      end
+
+      def table_name(association_name)
+        model_klass.reflections[association_name.to_s].table_name
+      end
+    
+    end
+  end
+end

data/lib/json_api_filter/field_filters/pagination.rb

@@ -0,0 +1,19 @@
+module JsonApiFilter
+  module FieldFilters
+    class Pagination < Base
+  
+      # @return [ActiveRecord_Relation]
+      def predicate
+        page = values["page"]
+        per_page = values["perPage"]
+        result = scope
+        unless page.nil? || per_page.nil? || per_page == "-1"
+          result = result.limit(per_page.to_i)
+          result = result.offset((page.to_i - 1) * per_page.to_i)
+        end
+        result
+      end
+
+    end
+  end
+end

data/lib/json_api_filter/field_filters/searcher.rb

@@ -0,0 +1,12 @@
+module JsonApiFilter
+  module FieldFilters
+    class Searcher < Base
+  
+      # @return [ActiveRecord_Relation]
+      def predicate
+        scope.send(values.keys.first, values.values.first)
+      end
+
+    end
+  end
+end

data/lib/json_api_filter/field_filters/sorter.rb

@@ -0,0 +1,19 @@
+module JsonApiFilter
+  module FieldFilters
+    class Sorter < Base
+  
+      # @return [ActiveRecord_Relation]
+      def predicate
+        return nil if values["by"].nil?
+        scope.order(values["by"] => order)
+      end
+
+      private
+
+      def order
+        ActiveModel::Type::Boolean.new.cast(values["desc"]) ? :desc : :asc
+      end
+    
+    end
+  end
+end

data/lib/json_api_filter/filter_attributes.rb

@@ -0,0 +1,36 @@
+module JsonApiFilter
+  class FilterAttributes
+    attr_reader :allowed_filters, :params
+
+    
+    # @param [ActiveSupport::HashWithIndifferentAccess, Hash] allowed_filters
+    # @param [ActiveSupport::HashWithIndifferentAccess, Hash] params
+    def initialize(allowed_filters, params)
+      @allowed_filters = allowed_filters
+      @params = params
+    end
+    
+    # @return [ActiveSupport::HashWithIndifferentAccess, Hash]
+    def process
+      params.select do |k,v|
+        allowed_filters.include?(k.to_sym) ||
+          allowed_filters.include?(k.to_s) ||
+          nested_allowed_filter.include?(k.to_sym) ||
+          nested_allowed_filter.include?(k.to_s)
+      end
+    end
+    
+    # Keys of nested allowed filters
+    # only one level of nesting supported
+    #
+    # @example
+    #   for: permitted_filters [:id, :author, :name, users: [:id]]
+    #   it returns: :users
+    #
+    # @return [Array<Symbol>]
+    def nested_allowed_filter
+      allowed_filters.select{|f| f.class == Hash}.map(&:keys).flatten
+    end
+  end
+end
+

data/lib/json_api_filter/value_parser.rb

@@ -0,0 +1,37 @@
+module JsonApiFilter
+  class ValueParser
+    
+    attr_reader :value
+    
+    # @param [String, Hash, HashWithIndifferentAccess] value
+    def initialize(value)
+      @value = value
+    end
+    
+    # Transform string of coma separated values to Array
+    #
+    # @example
+    #   "1,2,3" #=> [1,2,3]
+    #
+    # @param [String, Hash, HashWithIndifferentAccess] value
+    # @return [Array]
+    def self.parse(value)
+      new(value).indifferent_parse
+    end
+    
+    def indifferent_parse
+      return parse if value.is_a? String
+      parse_hash if value.is_a? HashWithIndifferentAccess
+    end
+    
+    def parse
+      return [value] unless value.include?(",")
+      value.split(',')
+    end
+    
+    def parse_hash
+      value.map{|k,v| {k => self.class.parse(v)}}.reduce(&:merge)
+    end
+  
+  end
+end

data/lib/json_api_filter/version.rb

@@ -1,3 +1,3 @@
 module JsonApiFilter
-  VERSION = "0.1.1"
+  VERSION = "0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_api_filter
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: '0.2'
 platform: ruby
 authors:
 - Blaked
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-25 00:00:00.000000000 Z
+date: 2021-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,16 +42,72 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -86,8 +142,16 @@ files:
 - bin/setup
 - json_api_filter.gemspec
 - lib/json_api_filter.rb
-- lib/json_api_filter/filter_by.rb
-- lib/json_api_filter/filters.rb
+- lib/json_api_filter/auto_join.rb
+- lib/json_api_filter/dispatch.rb
+- lib/json_api_filter/field_filters/base.rb
+- lib/json_api_filter/field_filters/compare.rb
+- lib/json_api_filter/field_filters/matcher.rb
+- lib/json_api_filter/field_filters/pagination.rb
+- lib/json_api_filter/field_filters/searcher.rb
+- lib/json_api_filter/field_filters/sorter.rb
+- lib/json_api_filter/filter_attributes.rb
+- lib/json_api_filter/value_parser.rb
 - lib/json_api_filter/version.rb
 homepage: https://github.com/Blaked84/json_api_filter
 licenses:

data/lib/json_api_filter/filter_by.rb

@@ -1,29 +0,0 @@
-module JsonApiFilter
-  class FilterBy
-
-    attr_reader :attr, :value
-
-    def initialize(attr, value)
-      @attr = attr
-      @value = value
-    end
-
-    def to_hash
-      return {} unless parsed_value.present?
-
-      { key.to_sym => parsed_value }
-    end
-
-    private
-
-    def key
-      attr.to_sym
-    end
-
-    def parsed_value
-      value.split(',')
-    end
-  end
-end
-
-

data/lib/json_api_filter/filters.rb

@@ -1,24 +0,0 @@
-module JsonApiFilter
-  class Filters
-    attr_reader :allowed_filters, :params
-
-    def initialize(allowed_filters, params)
-      @allowed_filters = allowed_filters
-      @params = params
-    end
-
-    def to_hash
-      filters.inject(:merge)
-    end
-
-    private
-
-    def filters
-      allowed_filters.map do |attr|
-        value = params.fetch(:filter, {}).fetch(attr, "")
-        ::JsonApiFilter::FilterBy.new(attr, value).to_hash
-      end
-    end
-  end
-end
-