query_filters 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6aee43e678bb4ae2a21c29cc93d3931b1f7f8cd8519a8b46560796c4c8f106c0
-  data.tar.gz: c266c3f356d6ffe661c196ad021e08248c49c4f22dbbc6056ec909dc4d86864b
+  metadata.gz: 5385e549bd5b1d0d1f2f00a1e4fa50aff65faa9aa10bab4a721438fc8cff8543
+  data.tar.gz: 9ef158597791824b4486d4cfb1662b478014765c071d6f0e182109d19abc871b
 SHA512:
-  metadata.gz: 5b3bb31bb4f553d91b2d1c968312890cf7b57a96533257d8875f9cf615f74e2ed2f3df9aff89706d2949b351665adfd352b9d7595db642b38210b85f3f6fa083
-  data.tar.gz: 64c810e03fd7556422261404fa4e209dcd2a7f3779466640073ab1fd026e0d834a88681b65b23869c1a1250cfb865839fc7de14270d7b65e4a5feef10852ea33
+  metadata.gz: 23278b8374d3d8d68a24f4d94d5c5a2c71fd3b6c695c1b22ae4a197057858423498d963d32308f5438a222b5cee11abc080af7df87b5d56a5772ff812e8a79ec
+  data.tar.gz: d4403b5294c833a7090743948b1a1f4bc6c07d1de9474d9175ef666c569eca55b7a6cf674d0432ecb65c73c0e9a23fac634f4ee01b9ad24ed4c076a245082da3

data/README.md

@@ -20,25 +20,25 @@ Or install it yourself as:
 
 ## Usage
 
-```
+```ruby
 QueryFilters.parse('date_gteq=20-11-2018,date_lteq=20-12-2018')
 ```
 
 Produces:
 
-```
+```ruby
 { date_gteq: '20-11-2018', date_lteq: '20-12-2018' }
 ```
 
 ### Nested params
 
-```
-QueryFilters.parse('date_gteq=20-11-2018,date_lteq=20-12-2018,posts:title=what about dogs,posts:order=title_desc')
+```ruby
+QueryFilters.parse('date_gteq=20-11-2018,date_lteq=20-12-2018,posts:title=what about dogs,posts:order=date_desc')
 ```
 
 Produces:
 
-```
+```ruby
 {
   date_gteq: '20-11-2018',
   date_lteq: '20-12-2018',
@@ -50,8 +50,8 @@ Produces:
 
 You can configure parser through options:
 
-```
-QueryFilters.parse('posts/title=what about dogs;posts/order=title_desc',
+```ruby
+QueryFilters.parse('posts/title:what about dogs;posts/order:title_desc',
   nesting_separator: '/',
   assignment_separator: ':',
   filters_separator: ';',
@@ -61,7 +61,7 @@ QueryFilters.parse('posts/title=what about dogs;posts/order=title_desc',
 
 Produces:
 
-```
+```ruby
 {"posts"=>{"title"=>"what about dogs", "order"=>"title_desc"}}
 ```
 

data/Rakefile

@@ -1,6 +1,7 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
 
-RSpec::Core::RakeTask.new(:spec)
+task default: :test
 
-task :default => :spec
+task :test do
+  Dir.glob('./test/*_test.rb').shuffle.each { |file| require file }
+end

data/lib/query_filters/parser.rb

@@ -22,6 +22,7 @@ module QueryFilters
       parse
     end
 
+    # @return [self]
     def parse
       @filters = query_string.split(options[:filters_separator]).map do |filter|
         parse_filter(filter)
@@ -29,6 +30,7 @@ module QueryFilters
       self
     end
 
+    # @return [Hash]
     def to_hash
       filters_hash = {}
       filters.each { |filter| filters_hash.deep_merge!(filter) }
@@ -37,6 +39,8 @@ module QueryFilters
 
     private
 
+    # @param filter [String]
+    # @return [Hash]
     def parse_filter(filter)
       key, value = split_filter(filter)
       keys = key.split(options[:nesting_separator])
@@ -46,10 +50,12 @@ module QueryFilters
       nested_hash_from_array(keys + [value])
     end
 
+    # @return [Array<String>]
     def split_filter(filter)
       filter.split(options[:assignment_separator])
     end
 
+    # @return [Hash]
     def nested_hash_from_array(array)
       if array.size == 1
         array.first

data/lib/query_filters/query.rb

@@ -13,6 +13,7 @@ module QueryFilters
       @query_string = query_string
     end
 
+    # @return [QueryFilters::Parser]
     def parser
       Parser.new(self, options)
     end

data/lib/query_filters/version.rb

@@ -1,3 +1,3 @@
 module QueryFilters
-  VERSION = "0.1.0"
+  VERSION = '0.2.0'.freeze
 end

data/lib/query_filters.rb

@@ -6,6 +6,9 @@ require 'query_filters/query'
 module QueryFilters
   class ParseError < StandardError; end
 
+  # @param query [String]
+  # @param options [Hash]
+  # @return [Hash]
   def self.parse(query, options = {})
     Query.new(query, options).to_hash
   end

data/query_filters.gemspec

@@ -39,6 +39,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activesupport', '>= 4.0'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'rake',    '~> 10.0'
-  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'rake',    '>= 13.0'
+  spec.add_development_dependency 'minitest', '~> 5.14'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: query_filters
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Sergey Besedin
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-04-02 00:00:00.000000000 Z
+date: 2021-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -42,30 +42,30 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.14'
 description: Parse filters (or something else) from pretty human readable query string
   to hash
 email:
@@ -94,7 +94,7 @@ metadata:
   homepage_uri: https://github.com/kressh/query_filters.git
   source_code_uri: https://github.com/kressh/query_filters.git
   changelog_uri: https://github.com/kressh/query_filters/master/tree/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -109,8 +109,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.14
+signing_key:
 specification_version: 4
 summary: Parse filters (or something else) from pretty human readable query string
   to hash