fetcheable_on_api 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6f6a27e74d75387bd75d978d8992ef31d2338c4b94685323f006efc42161400
-  data.tar.gz: 506acb6f864eec138f3f91ce4715de0b86caaf603cffd3ec32d822888e1002df
+  metadata.gz: 936c435eaac09ab3f50c5fe2fc650df5f857f99077a3a7cd24c9a7cbfa16bbeb
+  data.tar.gz: 5f029dd6d1fe43c945f0740b947ce0242444a6d6b21a556bc93c6c43295f02fd
 SHA512:
-  metadata.gz: bea41ab188e81170e282027ed91c0fec55dc13e0c94b8ebd59cdbd819a00eb0809454d1f4660520077f3fb70614d837ac6a842e5084d7fd78145d23b05d47425
-  data.tar.gz: deeaaba6a658b4ec43ebbc29a4478166212576997a293d131992ecb3937e7dd4dc36e477ba5f54fcbc36a6fa127f5df1f98deff0a090cb00d75a308ce6dc165a
+  metadata.gz: 5e11946ac5da7685b8a10e5638fd05c9dd5d55f5cf95309ccd2398e4b597ccd324ce68b3bdb307b8ed305500797f8a758af2c1b805ffdd671e7ad3ca407810bc
+  data.tar.gz: f60417bd41596796aba7191c24a5dcd2b077945b50ae11dccee646a8d0c6feb539b7b8aa5198e96b83b6eb19c0079f36f1ffefd28d83baadbeb21b37adeb2156

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    fetcheable_on_api (0.1.4)
+    fetcheable_on_api (0.2.2)
       activesupport (>= 4.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.1)
+    activesupport (5.2.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -63,4 +63,4 @@ DEPENDENCIES
   rubocop (~> 0.59.2)
 
 BUNDLED WITH
-   1.16.6
+   1.17.1

data/lib/fetcheable_on_api.rb

@@ -8,10 +8,16 @@ require 'fetcheable_on_api/version'
 require 'active_support'
 require 'date'
 
+# Detects params from url and apply
+# filters/sort/paginations to your classes.
 module FetcheableOnApi
   #
   # Configuration
   #
+  # Configures global settings for FetcheableOnApi
+  #   FetcheableOnApi.configure do |config|
+  #     config.pagination_default_size = 25
+  #   end
   class << self
     attr_accessor :configuration
   end
@@ -50,6 +56,7 @@ module FetcheableOnApi
   #
   protected
 
+  # Apply filters, sort and page on a collection.
   def apply_fetcheable(collection)
     collection = apply_filters(collection)
     collection = apply_sort(collection)
@@ -57,26 +64,40 @@ module FetcheableOnApi
     apply_pagination(collection)
   end
 
-  def foa_valid_parameters!(*keys, foa_permitted_types: foa_default_permitted_types)
-    raise FetcheableOnApi::ArgumentError.new(
-      "Incorrect type #{params.dig(*keys).class} for params #{keys}"
-    ) unless foa_valid_params_types(*keys, foa_permitted_types: foa_permitted_types)
+  # Checks if the type of arguments is included in the permitted types
+  def foa_valid_parameters!(
+    *keys, foa_permitted_types: foa_default_permitted_types
+  )
+    return if foa_valid_params_types(
+      *keys,
+      foa_permitted_types: foa_permitted_types
+    )
+
+    raise FetcheableOnApi::ArgumentError,
+          "Incorrect type #{params.dig(*keys).class} for params #{keys}"
   end
 
-  def foa_valid_params_types(*keys, foa_permitted_types: foa_default_permitted_types)
+  def foa_valid_params_types(
+    *keys, foa_permitted_types: foa_default_permitted_types
+  )
     foa_permitted_types.inject(false) do |res, type|
       res || foa_valid_params_type(params.dig(*keys), type)
     end
   end
 
+  # Returns true if class is the class of value,
+  # or if class is one of the superclasses of value
+  # or modules included in value.
   def foa_valid_params_type(value, type)
     value.is_a?(type)
   end
 
+  # Types allowed by default.
   def foa_default_permitted_types
     [ActionController::Parameters, Hash]
   end
 
+  # Convert string to datetime.
   def foa_string_to_datetime(string)
     DateTime.strptime(string, '%s')
   end

data/lib/fetcheable_on_api/configuration.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module FetcheableOnApi
+  # Default configuration
   class Configuration
     attr_accessor :pagination_default_size
 

data/lib/fetcheable_on_api/filtreable.rb

@@ -1,31 +1,32 @@
 # frozen_string_literal: true
 
 module FetcheableOnApi
+  # Applying the filter to a collection.
   module Filtreable
     #
     # Supports
     #
-    PREDICATES_WITH_ARRAY = [
-      :does_not_match_all,
-      :does_not_match_any,
-      :eq_all,
-      :eq_any,
-      :gt_all,
-      :gt_any,
-      :gteq_all,
-      :gteq_any,
-      :in_all,
-      :in_any,
-      :lt_all,
-      :lt_any,
-      :lteq_all,
-      :lteq_any,
-      :matches_all,
-      :matches_any,
-      :not_eq_all,
-      :not_eq_any,
-      :not_in_all,
-      :not_in_any
+    PREDICATES_WITH_ARRAY = %i[
+      does_not_match_all
+      does_not_match_any
+      eq_all
+      eq_any
+      gt_all
+      gt_any
+      gteq_all
+      gteq_any
+      in_all
+      in_any
+      lt_all
+      lt_any
+      lteq_all
+      lteq_any
+      matches_all
+      matches_any
+      not_eq_all
+      not_eq_any
+      not_in_all
+      not_in_any
     ].freeze
 
     #
@@ -39,6 +40,7 @@ module FetcheableOnApi
       end
     end
 
+    # Detects url parameters and applies the filter
     module ClassMethods
       def filter_by(*attrs)
         options = attrs.extract_options!
@@ -52,7 +54,7 @@ module FetcheableOnApi
             as: options[:as] || attr
           }
 
-          filters_configuration[attr] = filters_configuration[attr].merge(options)
+          filters_configuration[attr].merge!(options)
         end
       end
     end
@@ -66,24 +68,16 @@ module FetcheableOnApi
     #
     protected
 
-    # def try_parse_array(values, format)
-    #   array = JSON.parse(values)
-    #   array.map! { |el| foa_string_to_datetime(el.to_s) } if format == :datetime
-
-    #   [array]
-    # rescue JSON::ParserError
-    #   nil
+    # def convert_to_datetime(array)
+    #   array.map { |el| foa_string_to_datetime(el.to_s) }
     # end
 
-    def convert_to_datetime(array)
-      array.map { |el| foa_string_to_datetime(el.to_s) }
-    end
-
     def valid_keys
       keys = filters_configuration.keys
       keys.each_with_index do |key, index|
         predicate = filters_configuration[key.to_sym].fetch(:with, :ilike)
-        next if predicate.respond_to?(:call) || PREDICATES_WITH_ARRAY.exclude?(predicate.to_sym)
+        next if predicate.respond_to?(:call) ||
+                PREDICATES_WITH_ARRAY.exclude?(predicate.to_sym)
 
         keys[index] = { key => [] }
       end
@@ -93,6 +87,7 @@ module FetcheableOnApi
 
     def apply_filters(collection)
       return collection if params[:filter].blank?
+
       foa_valid_parameters!(:filter)
 
       filter_params = params.require(:filter)
@@ -118,6 +113,7 @@ module FetcheableOnApi
       collection.where(filtering.flatten.compact.inject(:and))
     end
 
+    # Apply arel predicate on collection
     def predicates(predicate, collection, klass, column_name, value)
       case predicate
       when :between
@@ -187,12 +183,16 @@ module FetcheableOnApi
       when :not_in_any
         klass.arel_table[column_name].not_in_any(value)
       else
-        raise ArgumentError, "unsupported predicate `#{predicate}`" unless predicate.respond_to?(:call)
+        unless predicate.respond_to?(:call)
+          raise ArgumentError,
+                "unsupported predicate `#{predicate}`"
+        end
 
         predicate.call(collection, value)
       end
     end
 
+    # Types allowed by default for filter action.
     def foa_default_permitted_types
       [ActionController::Parameters, Hash, Array]
     end

data/lib/fetcheable_on_api/pagineable.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module FetcheableOnApi
+  # Application of a pagination on a collection
   module Pagineable
     #
     # Supports
@@ -21,22 +22,34 @@ module FetcheableOnApi
 
     def apply_pagination(collection)
       return collection if params[:page].blank?
+
       foa_valid_parameters!(:page)
 
-      limit = params[:page].fetch(
-        :size,
-        FetcheableOnApi.configuration.pagination_default_size
-      ).to_i
+      limit, offset, count, page = extract_pagination_informations(collection)
+      define_header_pagination(limit, count, page)
 
-      offset = (params[:page].fetch(:number, 1).to_i - 1) * limit
-      count  = collection.except(:offset, :limit, :order).count
+      collection.limit(limit).offset(offset)
+    end
+
+    private
 
-      response.headers['Pagination-Current-Page'] = params[:page].fetch(:number, 1)
+    def define_header_pagination(limit, count, page)
+      response.headers['Pagination-Current-Page'] = page
       response.headers['Pagination-Per']          = limit
       response.headers['Pagination-Total-Pages']  = 1 + (count / limit).ceil
       response.headers['Pagination-Total-Count']  = count
+    end
 
-      collection.limit(limit).offset(offset)
+    def extract_pagination_informations(collection)
+      limit = params[:page].fetch(
+        :size, FetcheableOnApi.configuration.pagination_default_size
+      ).to_i
+
+      page   = params[:page].fetch(:number, 1).to_i
+      offset = (page - 1) * limit
+      count  = collection.except(:offset, :limit, :order).count
+
+      [limit, offset, count, page]
     end
   end
 end

data/lib/fetcheable_on_api/sortable.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module FetcheableOnApi
+  # Application of a sorting on a collection
   module Sortable
     #
     # Supports
@@ -8,7 +9,7 @@ module FetcheableOnApi
     SORT_ORDER = {
       '+' => :asc,
       '-' => :desc
-    }
+    }.freeze
 
     #
     # Public class methods
@@ -16,11 +17,12 @@ module FetcheableOnApi
     def self.included(base)
       base.class_eval do
         extend ClassMethods
-        class_attribute :sorts_configuration, :instance_writer => false
+        class_attribute :sorts_configuration, instance_writer: false
         self.sorts_configuration = {}
       end
     end
 
+    # Detects url parameters and applies sorting
     module ClassMethods
       def sort_by(*attrs)
         options = attrs.extract_options!
@@ -33,7 +35,7 @@ module FetcheableOnApi
             as: attr
           }
 
-          sorts_configuration[attr] = self.sorts_configuration[attr].merge(options)
+          sorts_configuration[attr] = sorts_configuration[attr].merge(options)
         end
       end
     end
@@ -49,30 +51,57 @@ module FetcheableOnApi
 
     def apply_sort(collection)
       return collection if params[:sort].blank?
-      foa_valid_parameters!(:sort, foa_permitted_types: [String])
-
-      ordering = []
 
-      clean_params(params[:sort]).each do |attr|
-        klass = sorts_configuration[attr.to_sym].fetch(:class_name, collection.klass)
-        field = sorts_configuration[attr.to_sym].fetch(:as, attr.to_sym).to_s
-        next unless klass.attribute_names.include?(field)
+      foa_valid_parameters!(:sort, foa_permitted_types: [String])
 
-        sort_sign = (attr =~ /\A[+-]/) ? attr.slice!(0) : '+'
-        ordering << klass
-                      .arel_table[field]
-                      .send(SORT_ORDER[sort_sign])
+      ordering = format_params(params[:sort]).map do |attr_name, sort_method|
+        arel_sort(attr_name, sort_method)
       end
 
-      collection.order(ordering)
+      collection.order(ordering.compact)
     end
 
     private
 
-    def clean_params(params)
+    def arel_sort(attr_name, sort_method)
+      return if sorts_configuration[attr_name].blank?
+
+      klass = class_for(attr_name, collection)
+      field = field_for(attr_name)
+      return unless belong_to_attributes_for?(klass, field)
+
+      klass.arel_table[field].send(sort_method)
+    end
+
+    def class_for(attr_name, collection)
+      sorts_configuration[attr_name].fetch(:class_name, collection.klass)
+    end
+
+    def field_for(attr_name)
+      sorts_configuration[attr_name].fetch(:as, attr_name).to_s
+    end
+
+    def belong_to_attributes_for?(klass, field)
+      klass.attribute_names.include?(field)
+    end
+
+    #
+    # input: "-email,first_name"
+    # return: { email: :desc, first_name: :asc }
+    #
+    def format_params(params)
+      res = {}
+
       params
         .split(',')
-        .select { |e| sorts_configuration.keys.map(&:to_s).include?(e) }
+        .each do |attribute|
+          res[attribute.to_sym] = SORT_ORDER[sort_sign(attribute)]
+        end
+      res
+    end
+
+    def sort_sign(attribute)
+      attribute =~ /\A[+-]/ ? attribute.slice!(0) : '+'
     end
   end
 end

data/lib/fetcheable_on_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FetcheableOnApi
-  VERSION = '0.2.1'.freeze
+  VERSION = '0.2.2'.freeze
 end

data/lib/generators/fetcheable_on_api/install_generator.rb

@@ -1,11 +1,13 @@
 module FetcheableOnApi
   module Generators
+    # Create conf file
     class InstallGenerator < Rails::Generators::Base
-      source_root File.expand_path("../../templates", __FILE__)
-      desc "Creates FetcheableOnApi initializer for your application"
+      source_root File.expand_path('../templates', __dir__)
+      desc 'Creates FetcheableOnApi initializer for your application'
 
       def copy_initializer
-        template "fetcheable_on_api_initializer.rb", "config/initializers/fetcheable_on_api.rb"
+        template 'fetcheable_on_api_initializer.rb',
+                 'config/initializers/fetcheable_on_api.rb'
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fetcheable_on_api
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Fabien
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-08 00:00:00.000000000 Z
+date: 2019-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport