query_filters 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6aee43e678bb4ae2a21c29cc93d3931b1f7f8cd8519a8b46560796c4c8f106c0
+  data.tar.gz: c266c3f356d6ffe661c196ad021e08248c49c4f22dbbc6056ec909dc4d86864b
+SHA512:
+  metadata.gz: 5b3bb31bb4f553d91b2d1c968312890cf7b57a96533257d8875f9cf615f74e2ed2f3df9aff89706d2949b351665adfd352b9d7595db642b38210b85f3f6fa083
+  data.tar.gz: 64c810e03fd7556422261404fa4e209dcd2a7f3779466640073ab1fd026e0d834a88681b65b23869c1a1250cfb865839fc7de14270d7b65e4a5feef10852ea33

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+gems.locked

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Sergey Besedin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,87 @@
+# QueryFilters
+
+Hello there! You can use this tiny library to parse pretty query strings to pretty hashes or arrays.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'query_filters'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install query_filters
+
+## Usage
+
+```
+QueryFilters.parse('date_gteq=20-11-2018,date_lteq=20-12-2018')
+```
+
+Produces:
+
+```
+{ 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')
+```
+
+Produces:
+
+```
+{
+  date_gteq: '20-11-2018',
+  date_lteq: '20-12-2018',
+  posts: { title: 'what about dogs', order: 'date_desc' }
+}
+```
+
+### Configuration
+
+You can configure parser through options:
+
+```
+QueryFilters.parse('posts/title=what about dogs;posts/order=title_desc',
+  nesting_separator: '/',
+  assignment_separator: ':',
+  filters_separator: ';',
+  symbolize_keys: false
+)
+```
+
+Produces:
+
+```
+{"posts"=>{"title"=>"what about dogs", "order"=>"title_desc"}}
+```
+
+Default options are:
+
+* nesting_separator `:`
+* assignment_separator `=`
+* filters_separator `,`
+* symbolize_keys `true`
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kressh/query_filters.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "query_filters"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gems.rb

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in query_filters.gemspec
+gemspec

data/lib/query_filters.rb

@@ -0,0 +1,12 @@
+require 'query_filters/version'
+
+require 'query_filters/parser'
+require 'query_filters/query'
+
+module QueryFilters
+  class ParseError < StandardError; end
+
+  def self.parse(query, options = {})
+    Query.new(query, options).to_hash
+  end
+end

data/lib/query_filters/parser.rb

@@ -0,0 +1,61 @@
+require 'active_support/core_ext/hash/deep_merge'
+require 'forwardable'
+
+module QueryFilters
+  class Parser
+    extend ::Forwardable
+
+    DEFAULT_OPTIONS = {
+      nesting_separator: ':',
+      assignment_separator: '=',
+      filters_separator: ',',
+      symbolize_keys: true
+    }.freeze
+
+    attr_reader :query, :options, :filters
+
+    def_delegator :query, :query_string
+
+    def initialize(query, options = {})
+      @query = query
+      @options = DEFAULT_OPTIONS.merge(options)
+      parse
+    end
+
+    def parse
+      @filters = query_string.split(options[:filters_separator]).map do |filter|
+        parse_filter(filter)
+      end
+      self
+    end
+
+    def to_hash
+      filters_hash = {}
+      filters.each { |filter| filters_hash.deep_merge!(filter) }
+      filters_hash
+    end
+
+    private
+
+    def parse_filter(filter)
+      key, value = split_filter(filter)
+      keys = key.split(options[:nesting_separator])
+
+      keys = keys.map(&:to_sym) if options[:symbolize_keys]
+
+      nested_hash_from_array(keys + [value])
+    end
+
+    def split_filter(filter)
+      filter.split(options[:assignment_separator])
+    end
+
+    def nested_hash_from_array(array)
+      if array.size == 1
+        array.first
+      else
+        { array.shift => nested_hash_from_array(array) }
+      end
+    end
+  end
+end

data/lib/query_filters/query.rb

@@ -0,0 +1,20 @@
+require 'forwardable'
+
+module QueryFilters
+  class Query
+    extend ::Forwardable
+
+    attr_accessor :query_string, :options
+
+    def_delegators :parser, :to_hash, :parse
+
+    def initialize(query_string, options = {})
+      @options      = options
+      @query_string = query_string
+    end
+
+    def parser
+      Parser.new(self, options)
+    end
+  end
+end

data/lib/query_filters/version.rb

@@ -0,0 +1,3 @@
+module QueryFilters
+  VERSION = "0.1.0"
+end

data/query_filters.gemspec

@@ -0,0 +1,44 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'query_filters/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'query_filters'
+  spec.version       = QueryFilters::VERSION
+  spec.authors       = ['Sergey Besedin']
+  spec.email         = ['kr3ssh@pm.me']
+
+  spec.summary       = 'Parse filters (or something else) from pretty human readable query string to hash'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/kressh/query_filters.git'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = spec.homepage
+    spec.metadata['changelog_uri'] = 'https://github.com/kressh/query_filters/master/tree/CHANGELOG.md'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  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'
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: query_filters
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sergey Besedin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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'
+description: Parse filters (or something else) from pretty human readable query string
+  to hash
+email:
+- kr3ssh@pm.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gems.rb
+- lib/query_filters.rb
+- lib/query_filters/parser.rb
+- lib/query_filters/query.rb
+- lib/query_filters/version.rb
+- query_filters.gemspec
+homepage: https://github.com/kressh/query_filters.git
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  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: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Parse filters (or something else) from pretty human readable query string
+  to hash
+test_files: []