lucky_param 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a017ce0d189d7f1c397675300a770e553ef058769f5b8250b451e0c5411bdc10
-  data.tar.gz: 7cab2988621b49fd9c0b0d5075d8301ff554b2c72e403e0e110906b84117fcd5
+  metadata.gz: ccec36d0fcd976004cc8464dde95eaa07c28addad21077dde9081585c53d38ef
+  data.tar.gz: 98a62a979a11ef8f2c35c2963cace3a0e580baf834b22a3ba83049eb3e7f34e2
 SHA512:
-  metadata.gz: 2926ebff40cdf3171069d567d287995bfbb41254903b2ea40266e398ce08645e7d6da9c8a54482c24abb6551eac6a938359f9032437f8d4ef3ccacef83594818
-  data.tar.gz: 8185c5c344ae28cf992a575dce343a29c73748220712176710ff04eea4c1a35ca318c1e82b0466d23d052cadcfe3bda70d9ac9f5b96d49c9c78523486c766964
+  metadata.gz: f5ae2f511f00e5198f52832e8c9d4fb0e1095ad9fd5334924a3c11c4e208acf7a88bd780eb1843ad4d26478b6c69b755eec0b68472c47b87578704c15e39e0c0
+  data.tar.gz: 6c6c7d91ae8c226b796329d659b1d28dc0a9970087c7fc58b0b4f2a3ace1a6bad8f9654ead328ca0df665ae7d0a2b177d8cb1b61796689c76241a498bf794361

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lucky_param (0.1.0)
+    lucky_param (0.1.1)
       rails (>= 4.2)
 
 GEM
@@ -99,7 +99,7 @@ GEM
       method_source
       rake (>= 0.8.7)
       thor (>= 0.19.0, < 2.0)
-    rake (10.5.0)
+    rake (12.3.1)
     sprockets (3.7.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)

data/README.md

@@ -2,28 +2,25 @@
 
 [![Build Status](https://travis-ci.org/shootingfly/lucky_param.svg?branch=master)](https://travis-ci.org/shootingfly/lucky_param)
 
-A simple parameter validation in controller for Rails.
+A simple parameter checker in controller for Rails Api.
 
-Compare to `apipie`, `grape`, it is neccessary to check param in controller.
+### Do Check, Fail Fast
 
 ## Usage
 
+Gemfile
 ```rb
 gem "lucky_param"
 ```
 
-### Define any validator for your app:
 app/controllers/application_controller.rb
 
 ```rb
-class SessionControllers < ApplicationController
+class ApplicationController
   include LuckyParam
 
+  # If necessary, you can overide or define your own parameter checkers.
   LuckyParam::CUSTOM_CHECKER = {
-    Email: [
-      ->(obj) { obj =~ /([0-9a-zA-Z]){6,30}/ },
-      "must be valid email"
-    ],
     Password: [
       ->(obj) { obj =~ /([0-9a-zA-Z]){6,30}/ },
       "must be valid password"
@@ -35,15 +32,30 @@ end
 app/controllers/sessions_controller.rb
 
 ```rb
-class SessionControllers < ApplicationController
+class SessionsController < ApplicationController
   def create
     required :email, :Email
     required :password, :Password
+    optional :nick_name, :String
     render json: 'ok'
   end
 end
 ```
 
+## Internal Checkers
+
+[Checkers](https://github.com/shootingfly/lucky_param/blob/master/lib/lucky_param/checker.rb)
+
+## Contributing
+
+1. Fork it ( https://github.com/shootingfly/lucky_param/fork )
+2. Create your feature branch (git checkout -b my-new-feature)
+3. Make your changes
+4. Run `ruby test/lucky_param_test.rb` to run the tests
+5. Commit your changes (git commit -am 'Add some feature')
+6. Push to the branch (git push origin my-new-feature)
+7. Create a new Pull Request
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/lucky_param/checker.rb

@@ -6,21 +6,21 @@ module LuckyParam
       ->(_obj) { true }
     ],
     String: [
-      ->(obj) { obj =~ /\w/ },
+      ->(obj) { !obj.empty? },
       "must be valid String"
     ],
     Integer: [
-      ->(obj) { obj =~ /\d+/ },
+      ->(obj) { obj.to_i.to_s == obj },
       "must be valid Integer"
     ],
-    Email: [
-      ->(obj) { obj =~ /\A[^@\s]+@([^@\s]+\.)+[^@\s]+\z/ },
-      "must be valid Email"
-    ],
     Float: [
-      ->(obj) { obj =~ /^(-?\d+)(\.\d+)?$/ },
+      ->(obj) { obj.to_f.to_s == obj },
       "must be valid Float"
     ],
+    Email: [
+      ->(obj) { obj =~ /^\w+([-+.]\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$/ },
+      "must be valid Email"
+    ],
     Timestamp: [
       ->(obj) { obj =~ /^(\+|\-)?\d+$/ },
       "must be valid Timestamp"

data/lib/lucky_param/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LuckyParam
-  VERSION = "0.1.0".freeze
+  VERSION = "0.1.1".freeze
 end

data/lib/lucky_param.rb

@@ -5,37 +5,41 @@ require_relative "./lucky_param/checker"
 
 module LuckyParam
   class ParamMissError < StandardError
-    def initialize(column)
-      super "Missing Params: #{column}"
-    end
   end
 
   class ParamFormatError < StandardError
-    def initialize(message)
-      super "Wrong Params Format: #{message}"
-    end
   end
 
-  def required(column, checker_type = :NONE)
-    raise ParamMissError, column unless params.key?(column)
-
-    message = _checker_message(column, checker_type)
-    raise ParamFormatError, message if message
+  class UnknownCheckerError < StandardError
   end
 
-  def optional(column, checker_type = :NONE)
-    return unless params.key?(column)
-
-    message = _checker_message(column, checker_type)
-    raise ParamFormatError, message if message
+  def required(column, checker_type)
+    required_optional(:required, column, checker_type)
   end
 
-  def _checker_message(column, checker_type)
-    checker = CUSTOM_CHECKER[checker_type] if LuckyParam.const_defined?(:CUSTOM_CHECKER)
-    checker ||= CHECKER.fetch(checker_type) {
-      raise "Unknown checker `#{checker_type}`, try to define checker with const `LuckyParam::CUSTOM_CHECKER`"
-    }
-    result = checker[0].call(params[column])
-    result ? nil : checker[1]
+  def optional(column, checker_type)
+    required_optional(:optional, column, checker_type)
   end
+
+  private
+
+    def required_optional(type, column, checker_type)
+      unless params[column]
+        return if type == :optional
+        raise ParamMissError, "Missing Params: #{column}"
+      end
+      message = checker_message(column, checker_type)
+      if message
+        raise ParamFormatError, "Wrong Params Format: #{message}"
+      end
+    end
+
+    def checker_message(column, checker_type)
+      checker = CUSTOM_CHECKER[checker_type] if LuckyParam.const_defined?(:CUSTOM_CHECKER)
+      checker ||= CHECKER.fetch(checker_type) {
+        raise UnknownCheckerError, "Unknown checker `#{checker_type}`, try to define checker with const `LuckyParam::CUSTOM_CHECKER`"
+      }
+      result = checker[0].call(params[column])
+      result ? nil : "#{column} #{checker[1]}"
+    end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lucky_param
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Shooting Fly