getto-params 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96670593db76cadfedc85a1ebf7bf846877335d77b7b69a8550540a416fa3f00
-  data.tar.gz: b5af1711451a9b6baaa57ce6b4298a21898dce40bb2a0b3e6402438326e538d5
+  metadata.gz: 6040b7167c38d715e98f1556713c86d809e8fa61e10e10f17cabb92c6045b7ac
+  data.tar.gz: 4ef9fca6bcb60ad1eae3e72145871a226d962f7ffae1e0d37edd33af79430573
 SHA512:
-  metadata.gz: 527145a9352cc46a05a4afee8d3c41615b038fc86b1a1418b5646cbe8f61365fb0febb5c804f7c0044d68fab4d250fc4924d82cc8053de1c199f1f65b7e212aa
-  data.tar.gz: e80d7575cc2d6a79c4501af7e98b6c06412c0f4fa42a748b5e47cdf376ec19f989b9723edb1cc5ba436b2cb3773e7ca2eae7a557dec787c308ea78b8d19cd91e
+  metadata.gz: 0e291c389da36f6882acd05cac84b4ba9b35dc669f38e907527e9194d979ac65ebc9efae0513f14db6a9563a8112080d3b4b3d72c6681720a4187a0e8ad1a66f
+  data.tar.gz: daac1469c983748c45f87ca87597478260b53d146bb323d0966465989bb064eb94e434768c2967448b7d03040eb9b8634b421b4ed8ed867bd8da4126e841cc20

data/.release-version

@@ -1 +1 @@
-1.2.0
+1.3.0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# Version : 1.3.0
+
+add: converter
+
 # Version : 1.2.0
 
 add: not_nil

data/CHANGELOG/1.3.0.md

@@ -0,0 +1,13 @@
+# Version : 1.3.0
+
+add: converter
+
+## commits
+
+* fix: readme
+* fix: readme
+* fix: readme
+* fix: readme
+* fix: readme
+* add: converter
+* fix: readme

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    getto-params (1.2.0)
+    getto-params (1.3.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -17,6 +17,8 @@ Getto::Params.new.validate(params) do |v|
     "str1"  => v.in(["param1","param2"]),
     "str2"  => v.in(["param1","param2"]),
     "tel"   => v.combine([v.string, v.match(%r{\A[0-9]+-[0-9]+-[0-9]+\Z})]),
+    "date"  => v.combine([v.string, v.match_date]),
+    "data"  => v.not_nil,
     "number" => v.match_integer,
     "bool"  => v.match_bool,
     "hash"  => v.hash(
@@ -42,6 +44,8 @@ end
 ```ruby
 require "getto/params/search"
 
+time = Time # respond to `parse`
+
 Getto::Params::Search.new(
   page:  1,
   limit: 1000,
@@ -49,14 +53,28 @@ Getto::Params::Search.new(
   query: {
     "name.cont" => "search",
     "value.eq"  => "value1",
+    "date.lteq" => "2018-10-01",
+    "time.gteq" => "2018-10-01",
+    "time.lteq" => "2018-10-01",
   },
 ).to_h do |search|
   search.sort do |s|
     s.straight :name
   end
+
+  search.convert do |c|
+    c.convert "date.lteq", &c.to_date
+    c.convert "time.gteq", &c.to_beginning_of_day(time)
+    c.convert "time.lteq", &c.to_end_of_day(time)
+  end
+
   search.query do |q|
     q.search "name.cont", &q.not_empty
-    q.search("name.cont"){|val| ["value1","value2"].include? val }
+    q.search("value.eq"){|val| ["value1","value2"].include? val }
+
+    q.search "date.lteq", &q.not_nil
+    q.search "time.gteq", &q.not_nil
+    q.search "time.lteq", &q.not_nil
   end
 end
 # => {
@@ -69,6 +87,9 @@ end
 #   query: {
 #     "name.cont": "search",
 #     "value.eq":  "value1",
+#     "date.lteq":  Date.parse("2018-10-01"),
+#     "time.gteq":  Time.parse("2018-10-01 00:00:00"),
+#     "time.lteq":  Time.parse("2018-10-01 23:59:59"),
 #   },
 # }
 ```
@@ -126,6 +147,9 @@ Getto::Params.new.validate(params) do |v|
     # downcase should be equal to "true" or "false"
     "key" => v.match_bool,
 
+    # should match date
+    "key" => v.match_date,
+
 
     # should be hash includes :key that value is string
     "key" => v.hash(
@@ -152,6 +176,9 @@ Getto::Params.new.validate(params) do |v|
     # validate string and not_empty
     "key" => v.combine([v.string, v.not_empty]),
 
+    # validate not_nil
+    "key" => v.not_nil,
+
 
     # raise error if valudation failed
     "key" => v.string{|val| raise ArgumentError, "key should be string: #{val}" }
@@ -169,6 +196,8 @@ Format parameters for search api
 ```ruby
 require "getto/params/search"
 
+time = Time # respond to `parse`
+
 Getto::Params::Search.new(
   page:  1,
   limit: 1000,
@@ -186,6 +215,12 @@ Getto::Params::Search.new(
     s.invert :name
   end
 
+  search.convert do |c|
+    c.convert "date.lteq", &c.to_date
+    c.convert "time.gteq", &c.to_beginning_of_day(time)
+    c.convert "time.lteq", &c.to_end_of_day(time)
+  end
+
   search.query do |q|
     # search "name.cont" if value not empty
     q.search "name.cont", &q.not_empty
@@ -257,6 +292,62 @@ end
 # }
 ```
 
+#### convert query
+
+- to date
+
+```ruby
+search.convert do |c|
+  c.convert "date.lteq", &c.to_date
+end
+
+# query: { "date.lteq" => "invalid date" }
+# => query: {
+#   "date.lteq" => nil,
+# }
+
+# query: { "date.lteq" => "2018-10-01" }
+# => query: {
+#   "date.lteq" => Date.parse("2018-10-01"),
+# }
+```
+
+- to beginning of day, to end of day
+
+```ruby
+time = Time # respond to `parse`
+
+search.convert do |c|
+  c.convert "time.gteq", &c.to_beginning_of_day(time)
+  c.convert "time.lteq", &c.to_end_of_day(time)
+end
+
+# query: { "time.gteq" => "invalid date", "time.lteq" => "invalid date" }
+# => query: {
+#   "time.gteq" => nil,
+#   "time.lteq" => nil,
+# }
+
+# query: { "time.gteq" => "2018-10-01", "time.lteq" => "2018-10-01" }
+# => query: {
+#   "time.gteq" => Date.parse("2018-10-01 00:00:00"),
+#   "time.lteq" => Date.parse("2018-10-01 23:59:59"),
+# }
+```
+
+- convert by block
+
+```ruby
+search.convert do |c|
+  c.convert("name.cont"){|search| search.upcase }
+end
+
+# query: { "name.cont" => "search" }
+# => query: {
+#   "name.cont" => "SEARCH",
+# }
+```
+
 #### search condition
 
 - not empty
@@ -276,6 +367,23 @@ end
 # }
 ```
 
+- not nil
+
+```ruby
+search.query do |q|
+  q.search "name.cont", &q.not_nil
+end
+
+# query: { "name.cont" => nil }
+# => query: {
+# }
+
+# query: { "name.cont" => "search" }
+# => query: {
+#   "name.cont": "search",
+# }
+```
+
 - not all empty
 
 ```ruby

data/lib/getto/params/search.rb

@@ -8,24 +8,28 @@ module Getto
       end
 
       def to_h
-        @page.to_h.tap{|result|
-          yield Worker.new(sort: @sort, query: @query, result: result)
-        }
+        worker = Worker.new
+        yield worker
+
+        @page.to_h
+          .merge(sort: @sort.to_h(sort: worker.instance_variable_get(:@sort)))
+          .merge(query: @query.to_h(
+            convert: worker.instance_variable_get(:@convert),
+            check:   worker.instance_variable_get(:@check),
+          ))
       end
 
       class Worker
-        def initialize(sort:, query:, result:)
-          @sort = sort
-          @query = query
-          @result = result
+        def sort(&block)
+          @sort = block
         end
 
-        def sort(&block)
-          @result.merge!(sort: @sort.to_h(&block))
+        def convert(&block)
+          @convert = block
         end
 
         def query(&block)
-          @result.merge!(query: @query.to_h(&block))
+          @check = block
         end
       end
 
@@ -48,9 +52,11 @@ module Getto
           @sort = [sort.split(".")].to_h
         end
 
-        def to_h
+        def to_h(sort:)
           spec = {}
-          yield Order.new(spec)
+          if sort
+            sort.call Order.new(spec)
+          end
 
           result = {
             column: nil,
@@ -92,17 +98,73 @@ module Getto
           @query = query
         end
 
-        def to_h
-          spec = {}
-          yield Checker.new(spec)
+        def to_h(convert:, check:)
+          converters = {}
+          if convert
+            convert.call Converter.new(converters)
+          end
 
-          spec.map{|key,checker|
-            if search = @query[key]
+          checkers = {}
+          if check
+            check.call Checker.new(checkers)
+          end
+
+          query = @query.map{|key,search|
+            if converter = converters[key.to_s]
+              [key.to_s, converter.call(search)]
+            else
+              [key.to_s, search]
+            end
+          }.to_h
+
+          checkers.map{|key,checker|
+            if search = query[key]
               if checker.call(search)
-                [key.to_sym, search]
+                [key, search]
               end
             end
-          }.compact.to_h
+          }.compact.to_h.transform_keys(&:to_sym)
+        end
+
+        class Converter
+          def initialize(columns)
+            @columns = columns
+          end
+
+          def convert(column,&converter)
+            @columns[column.to_s] = converter
+          end
+
+
+          def to_date
+            ->(search) {
+              begin
+                ::Date.parse(search)
+              rescue ArgumentError
+                nil
+              end
+            }
+          end
+
+          def to_beginning_of_day(time)
+            ->(search){
+              begin
+                time.parse(search).to_date.to_time
+              rescue ArgumentError
+                nil
+              end
+            }
+          end
+
+          def to_end_of_day(time)
+            ->(search){
+              begin
+                (time.parse(search).to_date + 1).to_time - 1
+              rescue ArgumentError
+                nil
+              end
+            }
+          end
         end
 
         class Checker
@@ -119,6 +181,10 @@ module Getto
             ->(search){ not search.empty? }
           end
 
+          def not_nil
+            ->(search){ not search.nil? }
+          end
+
           def not_all_empty
             ->(search){ not search.all?(&:empty?) }
           end

data/lib/getto/params/version.rb

@@ -1,5 +1,5 @@
 module Getto
   class Params
-    VERSION = "1.2.0"
+    VERSION = "1.3.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: getto-params
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - shun@getto.systems
@@ -94,6 +94,7 @@ files:
 - CHANGELOG/1.1.1.md
 - CHANGELOG/1.1.2.md
 - CHANGELOG/1.2.0.md
+- CHANGELOG/1.3.0.md
 - Gemfile
 - Gemfile.lock
 - LICENSE