active_queryable 0.3.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca76d46d098d260a1f59a1fd6e50d59cbab69eb95ba87f25470ccb08aa3050f2
-  data.tar.gz: 9562f2b4d7a4cce6ba1ba6bb070c6e6d9cf031d6205bf1006e5b5c1f21566ed4
+  metadata.gz: c25dd06549532fe641c473358fea0eb2b504e2b17c4dc72ac0e872e79ed17457
+  data.tar.gz: 2458c9d3dac13e9a56cc7df37131a8b1e2d0c0b30687f928cd9970ff93c9498b
 SHA512:
-  metadata.gz: 5ec24780124afa2fd02e2d6bdf9a4f54f6dd980c8852adc43c4ae37144f887d54eccbdebf5e8d50765b3cc3e051762f4c1e62f7006a3a5385d5ed6962e3ce22f
-  data.tar.gz: aaf987e005a9f87b39ae00f63adaf7791a11b0facc962ae2f9b70e541e74f7b0281e1d71e6428ba71b97c7ba924dd20cf08b126e960430f9ecf8ef88d0ec9d0d
+  metadata.gz: 96b0c2d39034f8a646936efca9ed2a5744587ce826ba7f3a1ca7dce1a33de3966fc697502825aac74fbbffe1ee692d914c568090cab6ea592df756a4d05fafba
+  data.tar.gz: 00d9697d742d1cf31317ce7769b36619c1e06e8c2044de59b1ab15b13bc0c695e2409f0817590e0720b725951010cf004e02db29eeb29aba77a767e3e524f01a

data/lib/active_queryable/version.rb

@@ -2,5 +2,5 @@
 
 module ActiveQueryable
   # @return [String] the version of the gem
-  VERSION = '0.3.1'
+  VERSION = '0.4.1'
 end

data/lib/active_queryable.rb

@@ -70,6 +70,7 @@ module ActiveQueryable
       queryable_configure_options(options)
 
       scope :query_by, ->(params) { queryable_scope(params) }
+      scope :of_ids, ->(ids) { where(id: ids) }
       scope :of_not, ->(ids) { where.not(id: ids) }
     end
 
@@ -89,7 +90,7 @@ module ActiveQueryable
     # @return [void]
     def expand_queryable(options)
       self._queryable_expandable_filter_keys ||= []
-      self._queryable_expandable_filter_keys += ((options[:filter] || [])).map(&:to_sym)
+      self._queryable_expandable_filter_keys += (options[:filter] || []).map(&:to_sym)
     end
 
     # @param params [Hash,ActionController::Parameters]
@@ -102,9 +103,7 @@ module ActiveQueryable
     def queryable_scope(params)
       params = params.to_unsafe_h if params.respond_to? :to_unsafe_h
       params = params.with_indifferent_access if params.respond_to?(:with_indifferent_access)
-      params.each_key do |k|
-        QUERYABLE_VALID_PARAMS.include?(k.to_sym) || Rails.logger.error("Invalid key #{k} in queryable")
-      end
+      queryable_log_unpermitted_params(params)
 
       order_params = queryable_validate_order_params(params[:sort])
       query = queryable_parse_order_scope(order_params, self)
@@ -114,6 +113,18 @@ module ActiveQueryable
 
     private
 
+    # @param params [Hash,ActionController::Parameters]
+    # @return [void]
+    def queryable_log_unpermitted_params(params)
+      params.each_key do |k|
+        next if QUERYABLE_VALID_PARAMS.include?(k.to_sym)
+
+        Rails.logger.debug(
+          "Unsupported key `#{k}` passed to `query_by` will be ignored. Allowed keys: #{QUERYABLE_VALID_PARAMS.join(', ')}"
+        )
+      end
+    end
+
     # @option options [Hash<Symbol,Symbol>] :order { id: :asc }
     # @option options [Integer] :page 1
     # @option options [Integer] :per 25
@@ -123,7 +134,7 @@ module ActiveQueryable
       self._queryable_default_order = options[:order] || { id: :asc }
       self._queryable_default_page = options[:page] || 1
       self._queryable_default_per = options[:per] || 25
-      self._queryable_filter_keys = (((options[:filter] || [])).map(&:to_sym))
+      self._queryable_filter_keys = ((options[:filter] || []).map(&:to_sym))
     end
 
     # @param params [Hash,ActionController::Parameters]
@@ -165,7 +176,7 @@ module ActiveQueryable
       page_params = {}
       if params[:page].respond_to?(:dig)
         page_params[:page] = params.dig(:page, :number) || _queryable_default_page
-        page_params[:per] = params.dig(:page, :size) || params[:per] || _queryable_default_per
+        page_params[:per] = params.dig(:page, :size) || _queryable_default_per
       else
         page_params[:page] = params[:page] || _queryable_default_page
         page_params[:per] = params[:per] || _queryable_default_per

data/spec/active_queryable/pagination_spec.rb

@@ -16,8 +16,8 @@ describe 'Pagination' do
     expect(query.to_sql).to include('LIMIT 2 OFFSET 2')
   end
 
-  it 'ignores invalid values of page' do
+  it 'ignores per when page is an object' do
     query = Person.query_by(page: {}, per: 20)
-    expect(query.to_sql).to include('LIMIT 20 OFFSET 0')
+    expect(query.to_sql).to include('LIMIT 25 OFFSET 0')
   end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
+require 'logger'
 require 'active_support'
 require 'rspec'
 require 'active_record'

data/spec/support/schema.rb

@@ -1,9 +1,30 @@
 require 'active_record'
 
-ActiveRecord::Base.establish_connection(
-  adapter: 'sqlite3',
-  database: ':memory:'
-)
+if ENV['ACTIVE_RECORD_ADAPTER'] == 'mysql'
+  puts 'Running on MySQL...'
+  ActiveRecord::Base.establish_connection(
+    adapter: 'mysql2',
+    host: ENV['DB_HOST'] || '127.0.0.1',
+    username: ENV['DB_USERNAME'] || 'root',
+    password: ENV['DB_PASSWORD'],
+    database: 'acts_as_nosql'
+  )
+elsif ENV['ACTIVE_RECORD_ADAPTER'] == 'postgresql'
+  puts 'Running on PostgreSQL...'
+  ActiveRecord::Base.establish_connection(
+    adapter: 'postgresql',
+    database: 'acts_as_nosql',
+    host: ENV['DB_HOST'] || '127.0.0.1',
+    username: ENV['DB_USERNAME'] || ENV['POSTGRES_USER'] || 'postgres',
+    password: ENV['DB_PASSWORD'] || ENV['POSTGRES_PASSWORD']
+  )
+else
+  puts 'Running on SQLite...'
+  ActiveRecord::Base.establish_connection(
+    adapter: 'sqlite3',
+    database: ':memory:'
+  )
+end
 
 class Common < ActiveRecord::Base
   self.abstract_class = true

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: active_queryable
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.1
 platform: ruby
 authors:
 - Mònade
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2019-12-16 00:00:00.000000000 Z
@@ -16,20 +16,40 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: kaminari-activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -91,7 +111,7 @@ homepage: https://rubygems.org/gems/active_queryable
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -99,15 +119,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
-signing_key: 
+rubygems_version: 3.4.6
+signing_key:
 specification_version: 4
 summary: Gem to make easier model's filtering, sorting and pagination
 test_files: