senro 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38fdc0c7c7b0b4e1506e130a2b7534b65bc621b8bd558201b53dfc5ccdb6c0a1
-  data.tar.gz: deeb0d935a0426342cb90b01e30ec525f8ec2c5df25dc8fe916e97ff855fa196
+  metadata.gz: ad674976759b95336fbb1a2f69447f929d3fc9c92946f59d26667ff8686d31e4
+  data.tar.gz: 2495c31d877ceb87a80669706f98ff7addde3c9704f6d52f49e415427686f706
 SHA512:
-  metadata.gz: 2d94d9b1cdb7bc75245b1cd09c40148298bbb1d01ada3a691a74ffcb83350c57af569db4aee592be4dafdae0748ca5b4ec34478b0a9aa43d6e408cbcb26a2da6
-  data.tar.gz: ed0ecffc6f0bf7d1fa0a7fbfe77214f56e18adea847fc41525c76ddac0848cebb1d4a9ef67615887c2c177be95768c662afda464264198f64899774377937e56
+  metadata.gz: 54c8f89254370e335df9d565231d041527b30a0bcf45988eb969baa2eb388d82961f41e58e3d466c9f33d7ec7f10ab22aea1c43129e768765d2f8c46b5ddcadc
+  data.tar.gz: 64ad5d29a171e9296b426fdffd42483d0e108743489ba5c65198114543c0e174210920e20dd3e8636112e448dddf17b29fbccb48a55e4aa974854be814eb566c

data/.gitignore

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

data/.rspec

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

data/README.md

@@ -20,7 +20,8 @@ Or install it yourself as:
     $ gem install senro
 
 ## Usage
-### QueryParamsFormatter#sort
+### in plain Ruby
+#### QueryParamsFormatter#sort
 
 ```ruby
 puts params[:sort]
@@ -34,6 +35,20 @@ puts order_clause
 @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
+end
+
+pp params['sort']
+# => 'id ASC, name DESC'
+pp params['original_sort']
+# => 'id,-name'
+```
+
 ## Development
 
 - Run `docker-compose up --build` to set up.

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,14 @@
+# frozen_string_literal: true
+
+module Senro #:nodoc:
+  module Controller
+    include Senro::QueryParamsFormatter
+
+    def query_params_formatter_sort
+      return if params[:sort].nil? || params[:sort] == ''
+
+      params[:original_sort] = params[:sort].clone
+      params[:sort] = Senro::QueryParamsFormatter.sort(params[:sort])
+    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

data/lib/senro/version.rb

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

data/senro.gemspec

@@ -25,8 +25,12 @@ Gem::Specification.new do |spec|
 
   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 "rspec-rails", '~> 3.9'
+  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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: senro
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - WalkerSumida
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-19 00:00:00.000000000 Z
+date: 2020-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,19 +39,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        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: '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 +108,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
@@ -86,6 +142,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