fetcheable_on_api 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6219549e8a0f5504952d5ef35cefff9cc5e4fecc5a0999d63e9d27f5af9f0e6
-  data.tar.gz: 9ccff3a7b58b450aa033659bd5ad5378541c204340d57aa09433edcca08c1b12
+  metadata.gz: 74add540213b83da4a66b0659825527d544b188886486eca78205f19788a3f4a
+  data.tar.gz: 607fd13d633c56609925a94d609ac0584ad1b63ace98c420aff7e2191da4a701
 SHA512:
-  metadata.gz: ec44cfa6a0ed5e2d0993b7e4527113c65a79386ed3e7f5047990a7d4e4c01cd3c8205451319fe3398056c8b566222973e52f0d4f15dc9b1d6f54c7c918131720
-  data.tar.gz: 56439e23285b03eb1218cb5538f798efda9e4317a324c052ce7e9d82a56b9bc5968b26d4a7111222a75e985fb89773fa1f4cc3443226a40cdad2973877bbda2b
+  metadata.gz: 4be9be92db3e5c4daf9be7c044f4426fbe7a07ddc3342f0b9934fbd4fe91f3af87e6af626a1a17b47f5bc9208c9e8a04102e80d29afaf38af840623e53a1e215
+  data.tar.gz: 813718d44919c9b51e8168914cda8fb2956e44e256829461bcc7b1d5e067ccbfa8c74a4120573f5f1905d397570cbe26ed2e34e0afd1f05e17d561718b86f551

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fetcheable_on_api (0.2.2)
+    fetcheable_on_api (0.2.4)
       activesupport (>= 4.1)
 
 GEM
@@ -13,9 +13,9 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     ast (2.4.0)
-    concurrent-ruby (1.1.3)
+    concurrent-ruby (1.1.4)
     diff-lcs (1.3)
-    i18n (1.1.1)
+    i18n (1.5.3)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.1)
     minitest (5.11.3)
@@ -63,4 +63,4 @@ DEPENDENCIES
   rubocop (~> 0.59.2)
 
 BUNDLED WITH
-   1.17.1
+   1.17.3

data/README.md

@@ -329,7 +329,7 @@ end
 
 ```bash
 $ curl -X GET \
-  'http://localhost:3000/questions?sort=position'
+  'http://localhost:3000/questions?sort=answer'
 
 [
     {

data/lib/fetcheable_on_api/configuration.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 module FetcheableOnApi
-  # Default configuration
+  # FetcheableOnApi configuration object.
+  #
   class Configuration
+    # @attribute [Integer] Default pagination size
     attr_accessor :pagination_default_size
 
     def initialize

data/lib/fetcheable_on_api/{filtreable.rb → filterable.rb}

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 module FetcheableOnApi
-  # Applying the filter to a collection.
-  module Filtreable
+  # Filterable implements `filter` parameter support.
+  module Filterable
     #
-    # Supports
+    # Predicates supported for filtering.
     #
     PREDICATES_WITH_ARRAY = %i[
       does_not_match_all
@@ -40,8 +40,16 @@ module FetcheableOnApi
       end
     end
 
-    # Detects url parameters and applies the filter
+    # Class methods made available to your controllers.
     module ClassMethods
+      # Define a filterable attribute.
+      #
+      # @see FetcheableOnApi::Filterable::PREDICATES_WITH_ARRAY
+      #
+      # @param attrs [Array] options to define one or more filters.
+      # @option attrs [String, nil] :as Alias the filtered attribute
+      # @option attrs [String, nil] :class_name Override the class of the filter target
+      # @option attrs [String, nil] :with Use a specific predicate
       def filter_by(*attrs)
         options = attrs.extract_options!
         options.symbolize_keys!
@@ -51,7 +59,7 @@ module FetcheableOnApi
 
         attrs.each do |attr|
           filters_configuration[attr] ||= {
-            as: options[:as] || attr
+            as: options[:as] || attr,
           }
 
           filters_configuration[attr].merge!(options)
@@ -68,10 +76,6 @@ module FetcheableOnApi
     #
     protected
 
-    # 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|
@@ -79,7 +83,7 @@ module FetcheableOnApi
         next if predicate.respond_to?(:call) ||
                 PREDICATES_WITH_ARRAY.exclude?(predicate.to_sym)
 
-        keys[index] = { key => [] }
+        keys[index] = {key => []}
       end
 
       keys
@@ -95,17 +99,17 @@ module FetcheableOnApi
                             .to_hash
 
       filtering = filter_params.map do |column, values|
-        format      = filters_configuration[column.to_sym].fetch(:format, :string)
+        format = filters_configuration[column.to_sym].fetch(:format, :string)
         column_name = filters_configuration[column.to_sym].fetch(:as, column)
-        klass       = filters_configuration[column.to_sym].fetch(:class_name, collection.klass)
-        predicate   = filters_configuration[column.to_sym].fetch(:with, :ilike)
+        klass = filters_configuration[column.to_sym].fetch(:class_name, collection.klass)
+        predicate = filters_configuration[column.to_sym].fetch(:with, :ilike)
 
         if values.is_a?(String)
-          values.split(',').map do |value|
+          values.split(",").map do |value|
             predicates(predicate, collection, klass, column_name, value)
           end.inject(:or)
         else
-          values.map! { |el| el.split(',') }
+          values.map! { |el| el.split(",") }
           predicates(predicate, collection, klass, column_name, values)
         end
       end

data/lib/fetcheable_on_api/pageable.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module FetcheableOnApi
+  # Pageable implements pagination support.
+  #
+  # It handles the controller parameters:
+  #
+  # - <code>page[:number]</code> the requested page (default: 1).
+  # - <code>page[:size]</code> number of records per page.
+  #
+  # If no <code>page</code> parameter is present on the request, the full collection is
+  # returned.
+  #
+  # The following pagination information is add to the response headers:
+  #
+  # - <code>Pagination-Current-Page</code> the page that is returned.
+  # - <code>Pagination-Per</code> the number of records included in the page.
+  # - <code>Pagination-Total-Pages</code> the total number of pages available.
+  # - <code>Pagination-Total-Count</code> the total number of records available.
+  #
+  module Pageable
+    #
+    # Supports
+    #
+
+    #
+    # Public class methods
+    #
+
+    #
+    # Public instance methods
+    #
+
+    #
+    # Protected instance methods
+    #
+    protected
+
+    def apply_pagination(collection)
+      return collection if params[:page].blank?
+
+      foa_valid_parameters!(:page)
+
+      limit, offset, count, page = extract_pagination_informations(collection)
+      define_header_pagination(limit, count, page)
+
+      collection.limit(limit).offset(offset)
+    end
+
+    private
+
+    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
+
+    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,10 +1,10 @@
 # frozen_string_literal: true
 
 module FetcheableOnApi
-  # Application of a sorting on a collection
+  # Sortable implements `pagination` support.
   module Sortable
     #
-    # Supports
+    # Map of symbol to sorting direction supported by the module.
     #
     SORT_ORDER = {
       "+" => :asc,
@@ -22,8 +22,15 @@ module FetcheableOnApi
       end
     end
 
-    # Detects url parameters and applies sorting
+    # Class methods made available to your controllers.
     module ClassMethods
+      # Define one ore more sortable attribute configurations.
+      #
+      # @param attrs [Array] options to define one or more sorting
+      #   configurations.
+      # @option attrs [String, nil] :as Alias the sorted attribute
+      # @option attrs [true, false, nil] :with Wether to sort on the lowercase
+      #   attribute value.
       def sort_by(*attrs)
         options = attrs.extract_options!
         options.symbolize_keys!

data/lib/fetcheable_on_api/version.rb

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

data/lib/fetcheable_on_api.rb

@@ -1,31 +1,36 @@
 # frozen_string_literal: true
 
-require 'fetcheable_on_api/configuration'
-require 'fetcheable_on_api/filtreable'
-require 'fetcheable_on_api/pagineable'
-require 'fetcheable_on_api/sortable'
-require 'fetcheable_on_api/version'
-require 'active_support'
-require 'date'
-
-# Detects params from url and apply
-# filters/sort/paginations to your classes.
+require "fetcheable_on_api/configuration"
+require "fetcheable_on_api/filterable"
+require "fetcheable_on_api/pageable"
+require "fetcheable_on_api/sortable"
+require "fetcheable_on_api/version"
+require "active_support"
+require "date"
+
+# FetcheableOnApi provides standardized sorting, filtering and pagination for
+# you API controllers.
+#
 module FetcheableOnApi
   #
-  # Configuration
+  # Global configuration settings for FetcheableOnApi
   #
-  # Configures global settings for FetcheableOnApi
-  #   FetcheableOnApi.configure do |config|
-  #     config.pagination_default_size = 25
-  #   end
-  class << self
-    attr_accessor :configuration
-  end
-
+  # @example Set default pagination size
+  #   FetcheableOnApi.configuration.pagination_default_size = 25
+  #
+  # @return [Configuration] The global configuration instance
   def self.configuration
     @configuration ||= Configuration.new
   end
 
+  # Configure FetcheableOnApi using a block.
+  #
+  # @example Set default pagination size
+  #   FetcheableOnApi.configure do |config|
+  #     config.pagination_default_size = 25
+  #   end
+  #
+  # @yield [Configuration] Gives the global instance to the block.
   def self.configure
     yield(configuration)
   end
@@ -33,7 +38,7 @@ module FetcheableOnApi
   #
   # Supports
   #
-  ArgumentError       = Class.new(ArgumentError)
+  ArgumentError = Class.new(ArgumentError)
   NotImplementedError = Class.new(NotImplementedError)
 
   #
@@ -41,9 +46,9 @@ module FetcheableOnApi
   #
   def self.included(klass)
     klass.class_eval do
-      include Filtreable
+      include Filterable
       include Sortable
-      include Pagineable
+      include Pageable
     end
   end
 
@@ -66,11 +71,10 @@ module FetcheableOnApi
 
   # Checks if the type of arguments is included in the permitted types
   def foa_valid_parameters!(
-    *keys, foa_permitted_types: foa_default_permitted_types
-  )
+                            *keys, foa_permitted_types: foa_default_permitted_types)
     return if foa_valid_params_types(
       *keys,
-      foa_permitted_types: foa_permitted_types
+    foa_permitted_types: foa_permitted_types,
     )
 
     raise FetcheableOnApi::ArgumentError,
@@ -78,8 +82,7 @@ module FetcheableOnApi
   end
 
   def foa_valid_params_types(
-    *keys, foa_permitted_types: foa_default_permitted_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
@@ -99,7 +102,7 @@ module FetcheableOnApi
 
   # Convert string to datetime.
   def foa_string_to_datetime(string)
-    DateTime.strptime(string, '%s')
+    DateTime.strptime(string, "%s")
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fetcheable_on_api
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Fabien
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-24 00:00:00.000000000 Z
+date: 2019-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -95,8 +95,8 @@ files:
 - Rakefile
 - lib/fetcheable_on_api.rb
 - lib/fetcheable_on_api/configuration.rb
-- lib/fetcheable_on_api/filtreable.rb
-- lib/fetcheable_on_api/pagineable.rb
+- lib/fetcheable_on_api/filterable.rb
+- lib/fetcheable_on_api/pageable.rb
 - lib/fetcheable_on_api/sortable.rb
 - lib/fetcheable_on_api/version.rb
 - lib/generators/fetcheable_on_api/install_generator.rb

data/lib/fetcheable_on_api/pagineable.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-module FetcheableOnApi
-  # Application of a pagination on a collection
-  module Pagineable
-    #
-    # Supports
-    #
-
-    #
-    # Public class methods
-    #
-
-    #
-    # Public instance methods
-    #
-
-    #
-    # Protected instance methods
-    #
-    protected
-
-    def apply_pagination(collection)
-      return collection if params[:page].blank?
-
-      foa_valid_parameters!(:page)
-
-      limit, offset, count, page = extract_pagination_informations(collection)
-      define_header_pagination(limit, count, page)
-
-      collection.limit(limit).offset(offset)
-    end
-
-    private
-
-    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
-
-    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