senro 0.2.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38fdc0c7c7b0b4e1506e130a2b7534b65bc621b8bd558201b53dfc5ccdb6c0a1
-  data.tar.gz: deeb0d935a0426342cb90b01e30ec525f8ec2c5df25dc8fe916e97ff855fa196
+  metadata.gz: d03ec9547965fe074c4c210218e316f029b19a3738a3135446026b12d4cb76d5
+  data.tar.gz: a29643e005abf21e57165cd71129b6b84c5162fb92c23002ad5e63efa5bc6a73
 SHA512:
-  metadata.gz: 2d94d9b1cdb7bc75245b1cd09c40148298bbb1d01ada3a691a74ffcb83350c57af569db4aee592be4dafdae0748ca5b4ec34478b0a9aa43d6e408cbcb26a2da6
-  data.tar.gz: ed0ecffc6f0bf7d1fa0a7fbfe77214f56e18adea847fc41525c76ddac0848cebb1d4a9ef67615887c2c177be95768c662afda464264198f64899774377937e56
+  metadata.gz: 47d1d91c1dd0b612565cdb8007240a122ad8c264214b99124781d6d48ac38f2a36887bd7d94f117ad541417e6b0dbe2e0ca80806c066867fd1e500442e9f4b12
+  data.tar.gz: 633d79e620191f0998b9e8c80959ee7f648a085af65c59e503e125f458ab18d10de4e2c5e34159ddadf678ccd72d859e4b929238ff5ee775062d968673cc1140

data/.github/workflows/build.yml

@@ -0,0 +1,17 @@
+name: build
+on: [push, pull_request]
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.5, 2.6, 2.7, 3.0]
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - run: bin/setup
+    - run: bundle exec rake spec

data/.gitignore

@@ -12,3 +12,6 @@
 
 /vendor/
 Gemfile.lock
+/spec/senro/dummy/tmp/
+/spec/senro/dummy/log/
+spec/senro/dummy/db/test.sqlite3

data/.pryrc

@@ -0,0 +1,7 @@
+if defined?(PryByebug)
+  Pry.commands.alias_command '_c', 'continue'
+  Pry.commands.alias_command '_s', 'step'
+  Pry.commands.alias_command '_n', 'next'
+  Pry.commands.alias_command '_f', 'finish'
+  Pry.commands.alias_command '_w', 'whereami'
+end

data/.rspec

@@ -1,3 +1,3 @@
 --format documentation
 --color
---require spec_helper
+--require rails_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.6.5

data/CHANGELOG.md

@@ -0,0 +1,32 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+---
+
+## [0.6.0] - 2021-05-17
+### Fixed
+- [#12](https://github.com/walkersumida/senro/pull/12) Change response values when params are empty
+
+### Security
+- [#9](https://github.com/walkersumida/senro/pull/9) Update rake gem
+
+## [0.5.1] - 2020-04-16
+### Fixed
+- [#8](https://github.com/walkersumida/senro/pull/8) Fix a datetime status bug
+
+## [0.5.0] - 2020-04-16
+### Changed
+- [#7](https://github.com/walkersumida/senro/pull/7) Change return values from string to hash
+
+## [0.4] - 2020-02-22
+### Added
+- [#6](https://github.com/walkersumida/senro/pull/6) Add `query_params_formatter_query` method
+
+## [0.3] - 2020-01-19
+### Added
+- [#4](https://github.com/walkersumida/senro/pull/4) Add `query_params_formatter_sort` method

data/Gemfile

@@ -4,3 +4,5 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in senro.gemspec
 gemspec
+
+gem 'pry-byebug', platforms: :ruby

data/README.md

@@ -1,6 +1,6 @@
 # Senro
 
-[![Build Status](https://travis-ci.org/walkersumida/senro.svg?branch=master)](https://travis-ci.org/walkersumida/senro)
+![Build Status](https://github.com/walkersumida/senro/workflows/build/badge.svg?branch=master)
 [![Gem Version](https://badge.fury.io/rb/senro.svg)](https://badge.fury.io/rb/senro)
 
 ## Installation
@@ -20,18 +20,46 @@ Or install it yourself as:
     $ gem install senro
 
 ## Usage
-### QueryParamsFormatter#sort
+### in Rails
+#### format sort
 
 ```ruby
-puts params[:sort]
-# => '+id,-name'
+class ApplicationController < ActionController::Base # or ::API class
+  include Senro::Controller
+  before_action :query_params_formatter_sort
+end
 
-order_clause = Senro::QueryParamsFormatter.sort(params[:sort])
 
-puts order_clause
-# => 'id ASC, name DESC'
+pp params['sort']
+# => { id: 'asc', name: 'desc' }
+pp params['original_sort']
+# => 'id,-name'
 
-@items = Item.all.order(order_clause)
+# e.g. in ActiveRecord
+@items = Item.all.order(params['sort'])
+
+# e.g. in Mongoid
+@items = Item.all.order_by(params['sort'])
+```
+
+#### format query
+
+```ruby
+class ApplicationController < ActionController::Base # or ::API class
+  include Senro::Controller
+  before_action :query_params_formatter_query
+end
+
+
+pp params['q']
+# => { 'query' => 'senro gem', 'status' => { 'type' => ['pr'], 'is' => ['open'], 'label' => ['bug', 'ready'] } }
+pp params['original_q']
+# => 'type:pr is:open label:bug label:ready senro gem'
+
+# e.g.
+@items = Item.where(title: params['q']['query'],
+                    type: params['q']['status']['type'],
+                    status: params['q']['status']['is'])
 ```
 
 ## Development

data/lib/senro.rb

@@ -2,6 +2,7 @@ require 'active_support/core_ext'
 
 require "senro/version"
 require 'senro/query_params_formatter'
+require 'senro/controller'
 
 module Senro
 end

data/lib/senro/controller.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Senro #:nodoc:
+  module Controller
+    include Senro::QueryParamsFormatter
+
+    def query_params_formatter_sort
+      params[:original_sort] = params[:sort].clone
+      params[:sort] = Senro::QueryParamsFormatter.sort(params[:sort])
+    end
+
+    def query_params_formatter_query
+      params[:original_q] = params[:q].clone
+      params[:q] = Senro::QueryParamsFormatter.query(params[:q])
+    end
+  end
+end

data/lib/senro/query_params_formatter.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Senro
-  class QueryParamsFormatter
+  module QueryParamsFormatter
     # Format RESTful API's query params to SQL order clause.
     # +: asc
     # -: desc
@@ -12,14 +12,39 @@ module Senro
     # @param param [String] format string. e.g. `+id,-name`
     # @return [String] formated stirng
     def self.sort(param)
+      return {} if param.blank?
+
       attributes = param.split(',')
-      attributes.map do |attr|
+      attributes.each_with_object({}) do |attr, hash|
         if /^\-/.match(attr).nil?
-          "#{attr.strip.gsub(/^\+/, '').underscore} ASC"
+          hash[attr.strip.gsub(/^\+/, '').underscore.to_sym] = 'asc'
+        else
+          hash[attr.strip.gsub(/^\-/, '').underscore.to_sym] = 'desc'
+        end
+      end
+    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: {} }
+
+      return data if param.blank?
+
+      elements = param.split(' ')
+      elements.each_with_object(data) do |ele, h|
+        if ele.include? ':'
+          ary = ele.split(':', 2)
+          h[:status][ary[0].underscore.to_sym] =
+            Array(h[:status][ary[0].underscore.to_sym]) << ary[1]
         else
-          "#{attr.strip.gsub(/^\-/, '').underscore} DESC"
+          h[:query] << (h[:query] == '' ? ele : " #{ele}")
         end
-      end.join(', ')
+      end
     end
   end
 end

data/lib/senro/version.rb

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

data/senro.gemspec

@@ -23,10 +23,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "rspec-rails", '~> 4.0'
+  spec.add_development_dependency "rails", ">= 5"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency 'pry'
 
   spec.required_ruby_version = '>= 2.5'
   spec.add_runtime_dependency('activesupport', '>= 5')
+  spec.add_runtime_dependency('actionpack', '>= 5')
 end

metadata

@@ -1,57 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: senro
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.6.0
 platform: ruby
 authors:
 - WalkerSumida
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-01-19 00:00:00.000000000 Z
+date: 2021-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: '3.0'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
 description: Library for RESTful API
 email:
 - walkersumida@gmail.com
@@ -73,9 +115,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build.yml"
 - ".gitignore"
+- ".pryrc"
 - ".rspec"
-- ".travis.yml"
+- ".ruby-version"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Dockerfile
 - Gemfile
@@ -86,6 +131,7 @@ files:
 - bin/setup
 - docker-compose.yml
 - lib/senro.rb
+- lib/senro/controller.rb
 - lib/senro/query_params_formatter.rb
 - lib/senro/version.rb
 - senro.gemspec
@@ -93,7 +139,7 @@ homepage: https://github.com/walkersumida/senro
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -109,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Library for RESTful API
 test_files: []

data/.travis.yml

@@ -1,17 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.5
-  - 2.6
-
-before_install:
-  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
-  - gem install bundler -v 1.17.2
-
-before_script:
-  - docker-compose up -d
-
-after_script:
-  - docker-compose down