getto-params 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3b3bc21d37c1df6d5a3c69427264aa7c048d7f53d9769c3544245e1e4e6a5335
+  data.tar.gz: 8dc96701b134197b0b9e20170ae707348367c9e9d8c66a3687f10d487953dad0
+SHA512:
+  metadata.gz: 590c763aaa5889b9f5478a005da8cc17f111a020d1a4080d696c558f6d87b5a3b5c06e0ecfbb84421c01b1d1231a7d6c0de9fa0ecc3dab7cafb01e0f1a260ec6
+  data.tar.gz: de5c541ede15940a5b294d99132cbe441cec99efa83d8f8adf2999575f843ffb7805275b449ccac42f342ea592d9a2c894ee4da95146e5050249cc04703cb961

data/.envrc

@@ -0,0 +1,5 @@
+export APP_ROOT=$(pwd)
+
+export DOCKER_WRAPPER_IMAGE_ruby=2.5.1
+
+export GIT_RELEASE_VERSION_FILE=lib/getto/params/version.rb

data/.git_release_request.rc.sh

@@ -0,0 +1,7 @@
+git_release_request_dump_version_local(){
+  bundle
+  git add Gemfile.lock
+}
+git_release_request_after_tag(){
+  git push github master --tags
+}

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/

data/.gitlab-ci.yml

@@ -0,0 +1,12 @@
+image: ruby:2.5.1
+
+cache:
+  paths:
+    - vendor/
+
+test:
+  except:
+    - tags
+  script:
+    - bundle
+    - bundle exec rake

data/.travis.yml

@@ -0,0 +1,12 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.2
+deploy:
+  provider: rubygems
+  gem: getto-params
+  on:
+    tags: true
+  api_key:
+    secure: "ZyXduNzZ7KYXpJ72KLriIiFwVUN9ZEHsKeF0Luvk/PQb9efFewO1xx31BhJi8aYeiAVqY8WdWmbEXUS9CviWiyAhdQhb6Z7CgpnXNbLwBVarlXbAe4KbHxlbHRTf8OeVATw76uaCPafIB3l1tSkrWNhILD+FIHWsUcj4+lH43LA0oLCMB5o79rH1jwHjDVXIatARpVqpwgfoz/KJsVtqaJgIX5vU+ae5D4INCqD5T4mSbTKp4Li32YpMrAxR3IUuPR1CJAcfCLC6Yy0yjGUi7QpbCQkLzjJ0wu1OYq8CjLc8sU+4ifnc7VymWrF3FmvEDi4tjSlU+oFrc2C0tsT9JUUPZDcIlJ6yQ1oJ6uSC9SIYJwTCR/n+yZ6Vk32sqEr90ZLdUyXIZHwk/TaxU0GqFNqyTKFEgzhGZDnxq98AG5PRgu0OIOa1KqPCiyCyIYLa/ffiPjHk++ztv8aTErBkL03gqrNAHXDdXm6uruABP0fl1J7z+MqNFs5zJgHHCSKSiYVPng2VTUuYazaJvup0qlfVVENxV/Bgz52/bz0QMI4OIaWDhC/cky9DPn7k0AcgVDFSdcDzIfZu7jqK2uqssE8lgxzHab9p9oXeTMPJTLVKS8bpLF1yiuCgBOczYLKZBfjT0tY4hiCOmQCfVgaijXj2VwQ7OwzdWhOndROrofM="

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Version : 0.2.0
+
+test: publish by travisci
+

data/CHANGELOG/0.2.0.md

@@ -0,0 +1,9 @@
+# Version : 0.2.0
+
+test: publish by travisci
+
+## commits
+
+* fix: README
+* fix: README
+* fix: README

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in getto-params.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    getto-params (0.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    docile (1.3.1)
+    json (2.1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  getto-params!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  simplecov (~> 0.16)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 shun@getto.systems
+
+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,304 @@
+# getto-params
+
+[rubygems: getto-params](https://rubygems.org/gems/getto-params)
+
+Validate parameters like strong-parameters(rails)
+
+```ruby
+require "getto/params"
+
+Getto::Params.new.validate(params) do |v|
+  v.hash(
+    "name"  => v.combine([v.string, v.not_empty]){|val|
+      raise ArgumentError, "name should be not empty string: #{val}"
+    },
+    "token" => v.combine([v.string, v.allow_empty(v.length(5))]),
+    "key"   => v.equal("KEY"),
+    "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})]),
+    "number" => v.match_integer,
+    "bool"  => v.match_bool,
+    "hash"  => v.hash(
+      "array" => v.array(v.string),
+      "keys" => v.array_include(["key1","key2","key3"]),
+      "params" => v.hash(
+        "key" => v.integer,
+        "bool" => v.bool,
+      ),
+    ),
+    "object" => v.hash_strict(
+      "key" => v.integer,
+      "bool" => v.bool,
+    ),
+  )
+end
+# => true  : success
+# => false : fail
+```
+
+- misc: format parameters for search
+
+```ruby
+require "getto/params/search"
+
+Getto::Params::Search.new(
+  page:  1,
+  limit: 1000,
+  sort: "name.asc",
+  query: {
+    "name.cont" => "search",
+  },
+).to_h do |search|
+  search.sort do |s|
+    s.straight :name
+  end
+  search.query do |q|
+    q.search "name.cont", &q.not_empty
+  end
+end
+# => {
+#   limit: 1000,
+#   offset: 0,
+#   sort: {
+#     column: :name,
+#     order: true,
+#   },
+#   query: {
+#     "name.cont": "search",
+#   },
+# }
+```
+
+
+###### Table of Contents
+
+- [Requirements](#Requirements)
+- [Usage](#Usage)
+- [License](#License)
+
+<a id="Requirements"></a>
+## Requirements
+
+- developed on ruby: 2.5.1
+
+
+<a id="Usage"></a>
+## Usage
+
+```ruby
+require "getto/params"
+
+Getto::Params.new.validate(params) do |v|
+  # argument `params` should be hash
+  v.hash(
+    # should be String
+    "key" => v.string,
+
+    # should be Integer
+    "key" => v.integer,
+
+    # should be Boolean
+    "key" => v.bool,
+
+
+    # should be equal to "value"
+    "key" => v.equal("value"),
+
+    # should be equal to "value1" or "value2"
+    "key" => v.in(["value1","value2"]),
+
+    # should not be empty
+    "key" => v.not_empty,
+
+    # length should be 10,
+    "key" => v.length(10),
+
+    # should match %r{example}
+    "key" => v.match(%r{example}),
+
+    # should match integer (value is string, but seem to be a Integer)
+    "key" => v.match_integer,
+
+    # downcase should be equal to "true" or "false"
+    "key" => v.match_bool,
+
+
+    # should be hash includes :key that value is string
+    "key" => v.hash(
+      key: v.string,
+    ),
+
+    # should be hash only includes :key that value is string
+    "key" => v.hash_strict(
+      key: v.string,
+    ),
+
+
+    # should be array that has string value
+    "key" => v.array(v.string),
+
+    # should be array that has "value1" or "value2"
+    "key" => v.array_include(["value1","value2"])
+
+
+    # should be match integer if value is not empty
+    "key" => v.allow_empty(v.match_integer),
+
+
+    # validate string and not_empty
+    "key" => v.combine([v.string, v.not_empty]),
+
+
+    # raise error if valudation failed
+    "key" => v.string{|val| raise ArgumentError, "key should be string: #{val}" }
+  )
+end
+# => true  : success
+# => false : fail
+```
+
+
+### Getto::Params::Search
+
+Format parameters for search api
+
+```ruby
+require "getto/params/search"
+
+Getto::Params::Search.new(
+  page:  1,
+  limit: 1000,
+  sort: "name.asc",
+  query: {
+    "name.cont" => "search",
+  },
+).to_h do |search|
+
+  search.sort do |s|
+    # sort name as straight order
+    s.straight :name
+
+    # sort name as invert order
+    s.invert :name
+  end
+
+  search.query do |q|
+    # search "name.cont" if value not empty
+    q.search "name.cont", &q.not_empty
+
+    # search "name.in" if any values not empty
+    q.search "name.in", &q.not_all_empty
+  end
+
+end
+```
+
+#### sort order
+
+- straight order
+
+```ruby
+search.sort do |s|
+  # sort name as straight order
+  s.straight :name
+end
+
+# sort: "name.asc"
+# => sort: {
+#   column: :name,
+#   order: true, # asc => true
+# }
+
+# sort: "name.desc"
+# => sort: {
+#   column: :name,
+#   order: false, # desc => false
+# }
+```
+
+- invert order
+
+```ruby
+search.sort do |s|
+  # sort name as invert order
+  s.invert :name
+end
+
+# sort: "name.asc"
+# => sort: {
+#   column: :name,
+#   order: false, # asc => false
+# }
+
+# sort: "name.desc"
+# => sort: {
+#   column: :name,
+#   order: true, # desc => true
+# }
+```
+
+#### search condition
+
+- not empty
+
+```ruby
+search.query do |q|
+  q.search "name.cont", &q.not_empty
+end
+
+# query: { "name.cont" => "" }
+# => query: {
+# }
+
+# query: { "name.cont" => "search" }
+# => query: {
+#   "name.cont": "search",
+# }
+```
+
+- not all empty
+
+```ruby
+search.query do |q|
+  q.search "name.in", &q.not_all_empty
+end
+
+# query: { "name.in" => [""] }
+# => query: {
+# }
+
+# query: { "name.in" => ["value1","value2"] }
+# => query: {
+#   "name.in": ["value1","value2"],
+# }
+```
+
+
+## Install
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'getto-params'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install getto-params
+```
+
+
+<a id="License"></a>
+## License
+
+getto/params is licensed under the [MIT](LICENSE) license.
+
+Copyright &copy; since 2018 shun@getto.systems

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/getto-params.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "getto/params/version"
+
+Gem::Specification.new do |spec|
+  spec.required_ruby_version = ">= 2.5.1"
+
+  spec.name          = "getto-params"
+  spec.version       = Getto::Params::VERSION
+  spec.authors       = ["shun@getto.systems"]
+  spec.email         = ["shun@getto.systems"]
+
+  spec.summary       = %q{validation and format params}
+  spec.description   = %q{Validate parameters like strong-parameters(rails)}
+  spec.homepage      = "https://github.com/getto-systems/getto-params"
+  spec.license       = "MIT"
+
+  # 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.extra_rdoc_files = ['README.md', 'LICENSE']
+  spec.rdoc_options = %w[--title Getto::Params --main README.md]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "simplecov", "~> 0.16"
+end

data/lib/getto/params.rb

@@ -0,0 +1,116 @@
+module Getto
+  class Params
+    def initialize(factory=Validator::Factory.new)
+      @factory = factory
+    end
+
+    def validate(params)
+      yield(@factory).call(params)
+    end
+
+    class Validator
+      def initialize(func,&failed)
+        @func = func
+        @failed = failed
+      end
+
+      def call(params)
+        @func.call(params).tap{|is_valid|
+          unless is_valid
+            @failed && @failed.call(params)
+          end
+        }
+      end
+
+      class Factory
+        def integer(&block)
+          Validator.new(->(value){ value.is_a? Integer }, &block)
+        end
+
+        def string(&block)
+          Validator.new(->(value){ value.is_a? String }, &block)
+        end
+
+        def bool(&block)
+          Validator.new(->(value){ value == true || value == false }, &block)
+        end
+
+
+        def equal(val,&block)
+          Validator.new(->(value){ value == val }, &block)
+        end
+
+        def in(values,&block)
+          Validator.new(->(value){ values.include?(value) }, &block)
+        end
+
+        def not_empty(&block)
+          Validator.new(->(value){ not value.empty? }, &block)
+        end
+
+        def length(length,&block)
+          Validator.new(->(value){ value && value.length == length }, &block)
+        end
+
+        def match(pattern,&block)
+          Validator.new(->(value){ value && value.match?(pattern) }, &block)
+        end
+
+        def match_integer(&block)
+          Validator.new(->(value){ value && value.to_i.to_s == value }, &block)
+        end
+
+        def match_bool(&block)
+          Validator.new(->(value){ value && ["true","false"].include?(value.to_s.downcase) }, &block)
+        end
+
+
+        def hash(spec,&block)
+          Validator.new(->(value){
+            value && spec.all?{|key,validator|
+              value.has_key?(key) && validator.call(value[key])
+            }
+          }, &block)
+        end
+
+        def hash_strict(spec,&block)
+          Validator.new(->(value){
+            validators = spec.dup
+            value && value.all?{|key,val|
+              validators.delete(key).tap{|validator|
+                break validator ? validator.call(val) : false
+              }
+            } && validators.empty?
+          }, &block)
+        end
+
+
+        def array(validator,&block)
+          Validator.new(->(value){
+            value && value.is_a?(Array) && value.all?{|val| validator.call(val)}
+          }, &block)
+        end
+
+        def array_include(values,&block)
+          Validator.new(->(value){
+            value && value.is_a?(Array) && value.all?{|val| values.include?(val)}
+          }, &block)
+        end
+
+
+        def combine(validators,&block)
+          Validator.new(->(value){
+            validators.all?{|validator| validator.call(value)}
+          }, &block)
+        end
+
+
+        def allow_empty(validator,&block)
+          Validator.new(->(value){
+            value.empty? or validator.call(value)
+          }, &block)
+        end
+      end
+    end
+  end
+end

data/lib/getto/params/search.rb

@@ -0,0 +1,129 @@
+module Getto
+  class Params
+    class Search
+      def initialize(page:, limit:, sort:, query:)
+        @page = Page.new(page: page, limit: limit)
+        @sort = Sort.new(sort: sort)
+        @query = Query.new(query: query)
+      end
+
+      def to_h
+        @page.to_h.tap{|result|
+          yield Worker.new(sort: @sort, query: @query, result: result)
+        }
+      end
+
+      class Worker
+        def initialize(sort:, query:, result:)
+          @sort = sort
+          @query = query
+          @result = result
+        end
+
+        def sort(&block)
+          @result.merge!(sort: @sort.to_h(&block))
+        end
+
+        def query(&block)
+          @result.merge!(query: @query.to_h(&block))
+        end
+      end
+
+      class Page
+        def initialize(page:, limit:)
+          @page  = page
+          @limit = limit
+        end
+
+        def to_h
+          {
+            limit: @limit,
+            offset: (@page.to_i - 1) * @limit,
+          }
+        end
+      end
+
+      class Sort
+        def initialize(sort:)
+          @sort = [sort.split(".")].to_h
+        end
+
+        def to_h
+          spec = {}
+          yield Order.new(spec)
+
+          result = {
+            column: nil,
+            order: true,
+          }
+
+          spec.map{|key,is_straight|
+            if sort = @sort[key]
+              result[:column] = key.to_sym
+              result[:order] =
+                if sort == "asc"
+                  is_straight
+                else
+                  not is_straight
+                end
+            end
+          }
+
+          result
+        end
+
+        class Order
+          def initialize(columns)
+            @columns = columns
+          end
+
+          def straight(column)
+            @columns[column.to_s] = true
+          end
+
+          def invert(column)
+            @columns[column.to_s] = false
+          end
+        end
+      end
+
+      class Query
+        def initialize(query:)
+          @query = query
+        end
+
+        def to_h
+          spec = {}
+          yield Checker.new(spec)
+
+          spec.map{|key,checker|
+            if search = @query[key]
+              if checker.call(search)
+                [key.to_sym, search]
+              end
+            end
+          }.compact.to_h
+        end
+
+        class Checker
+          def initialize(columns)
+            @columns = columns
+          end
+
+          def search(column,&checker)
+            @columns[column.to_s] = checker
+          end
+
+
+          def not_empty
+            ->(search){ not search.empty? }
+          end
+
+          def not_all_empty
+            ->(search){ not search.all?(&:empty?) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/getto/params/version.rb

@@ -0,0 +1,5 @@
+module Getto
+  class Params
+    VERSION = "0.2.0"
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: getto-params
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- shun@getto.systems
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+description: Validate parameters like strong-parameters(rails)
+email:
+- shun@getto.systems
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- ".envrc"
+- ".git_release_request.rc.sh"
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CHANGELOG/0.2.0.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- getto-params.gemspec
+- lib/getto/params.rb
+- lib/getto/params/search.rb
+- lib/getto/params/version.rb
+homepage: https://github.com/getto-systems/getto-params
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--title"
+- Getto::Params
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: validation and format params
+test_files: []