senro 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad674976759b95336fbb1a2f69447f929d3fc9c92946f59d26667ff8686d31e4
-  data.tar.gz: 2495c31d877ceb87a80669706f98ff7addde3c9704f6d52f49e415427686f706
+  metadata.gz: 683bde670ad39736e25d12de38a473ee568ab748d36c1c7b483fcd329578aab9
+  data.tar.gz: c1a3fb5c6c26e275076db973a3ff2819af9d4bc6ea5d8121c894d52ce2bae66a
 SHA512:
-  metadata.gz: 54c8f89254370e335df9d565231d041527b30a0bcf45988eb969baa2eb388d82961f41e58e3d466c9f33d7ec7f10ab22aea1c43129e768765d2f8c46b5ddcadc
-  data.tar.gz: 64ad5d29a171e9296b426fdffd42483d0e108743489ba5c65198114543c0e174210920e20dd3e8636112e448dddf17b29fbccb48a55e4aa974854be814eb566c
+  metadata.gz: 2b62578b935abfc41bf6d864c03372b53d5aca0d816e5430507d13799c647313d38a8626a535423b8c32a05a42baa7bb4e4c696a486769617d2f801431ba7e59
+  data.tar.gz: d3502c40b8c9b9d6577944338272fb51af19698efc9fa008ec7fe0b5b7220d6d64558f156f904e18b8ae941e7beb1eb0487b195ba9a79d8b6938a9f15c27e508

data/README.md

@@ -20,33 +20,31 @@ Or install it yourself as:
     $ gem install senro
 
 ## Usage
-### in plain Ruby
-#### QueryParamsFormatter#sort
-
-```ruby
-puts params[:sort]
-# => '+id,-name'
-
-order_clause = Senro::QueryParamsFormatter.sort(params[:sort])
-
-puts order_clause
-# => 'id ASC, name DESC'
-
-@items = Item.all.order(order_clause)
-```
-
 ### in Rails
 
 ```ruby
 class ApplicationController < ActionController::Base # or ::API class
   include Senro::Controller
   before_action :query_params_formatter_sort
+  before_action :query_params_formatter_query
 end
 
 pp params['sort']
 # => 'id ASC, name DESC'
 pp params['original_sort']
 # => 'id,-name'
+
+# e.g.
+@items = Item.all.order(params['sort'])
+
+
+pp params['q']
+# => { 'query' => 'senro gem', 'status' => { 'is' => ['open', 'close'] } }
+pp params['original_q']
+# => 'is:open is:close senro gem'
+
+# e.g.
+@items = Item.where(title: params['q']['query'], status: params['q']['status']['is'])
 ```
 
 ## Development

data/lib/senro/controller.rb

@@ -10,5 +10,12 @@ module Senro #:nodoc:
       params[:original_sort] = params[:sort].clone
       params[:sort] = Senro::QueryParamsFormatter.sort(params[:sort])
     end
+
+    def query_params_formatter_query
+      return if params[:q].nil? || params[:q] == ''
+
+      params[:original_q] = params[:q].clone
+      params[:q] = Senro::QueryParamsFormatter.query(params[:q])
+    end
   end
 end

data/lib/senro/query_params_formatter.rb

@@ -13,13 +13,34 @@ module Senro
     # @return [String] formated stirng
     def self.sort(param)
       attributes = param.split(',')
-      attributes.map do |attr|
+      attributes.map! do |attr|
         if /^\-/.match(attr).nil?
           "#{attr.strip.gsub(/^\+/, '').underscore} ASC"
         else
           "#{attr.strip.gsub(/^\-/, '').underscore} DESC"
         end
-      end.join(', ')
+      end
+      attributes.join(', ')
+    end
+
+    # Format RESTful API's query params to SQL where clause.
+    #
+    # And convert camel case attributes to snake case one.
+    #
+    # @param param [String] format string. e.g. `is:open is:close senro gem`
+    # @return [String] formated stirng
+    def self.query(param)
+      data = { query: ''.dup, status: {} }
+      elements = param.split(' ')
+      elements.each_with_object(data) do |ele, h|
+        if ele.include? ':'
+          ary = ele.split(':')
+          h[:status][ary[0].underscore.to_sym] =
+            Array(h[:status][ary[0].underscore.to_sym]) << ary[1]
+        else
+          h[:query] << (h[:query] == '' ? ele : " #{ele}")
+        end
+      end
     end
   end
 end

data/lib/senro/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Senro
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: senro
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - WalkerSumida
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-25 00:00:00.000000000 Z
+date: 2020-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler