safe_type 0.0.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a67c63237e5cf69ced4be0ee3a485f7ff3fba588
-  data.tar.gz: f92d5b559d4a2cbf322187f2f4eef1d17d7967a5
+  metadata.gz: b5ef8f748c40fe69ebe9bde7525c18a26227e922
+  data.tar.gz: c5dbba13dd9778bc27048e4f78ad80f1a81d8c80
 SHA512:
-  metadata.gz: 6fab8fcf295c05a748678d0ed5f4770797f8b83c3d637fe5e70eedb0fd62f405f8703577a4dd2cfb7f45efb515437c8bc7064f6f993c945a2dc80c5d84db519d
-  data.tar.gz: 311fe81e529e0f948cbefadf8d2efea6cd992897a692468c253579f50ad2606f663c890bad05d22037da850a55d76abf4dcd46ef6a879fc503b2bd527ea3f756
+  metadata.gz: 18b50e3f3ffdd15d9fb98242ddd44e32777c9f7add2a9c3539177c5226e2934092a98832f284107fa9168a06ba84fcc899a05dd4c8147beb5850857c140816f3
+  data.tar.gz: b4a87e49171f26eff48bda4bee778780fd67c5b3e45e199ddf6f4d5fbd1189db5405ae8fccb52a512cf55ec2a7007dbb18a3b0b0bed030462c2ee97e413dbb52

data/README.md

@@ -1,5 +1,6 @@
+---
 SafeType
-======
+---
 [![Gem Version](https://badge.fury.io/rb/safe_type.svg)](https://badge.fury.io/rb/safe_type)
 [![Build Status](https://travis-ci.org/chanzuckerberg/safe_type.svg?branch=master)](https://travis-ci.org/chanzuckerberg/safe_type)
 [![Maintainability](https://api.codeclimate.com/v1/badges/7fbc9a4038b86ef639e1/maintainability)](https://codeclimate.com/github/chanzuckerberg/safe_type/maintainability)
@@ -48,8 +49,8 @@ SAFE_ENV[:BUILD_NUM]        # => 123
 ```
 ## Routing Parameters
 ```ruby
-class FallSemester < SafeType::Date
-  # implement validate method
+class FallSemesterStartDate < SafeType::Date
+  # implement `is_valid?` method
 end
 
 current_year = Date.today.year
@@ -113,7 +114,7 @@ class Response < SafeType::Rule
   end
 end
 
-Response["https://API_URI"]   # => #<ResponseType:0x000056005b3e7518>
+Response.coerce("https://API_URI")   # => #<ResponseType:0x000056005b3e7518>
 ```
 
 # Overview 
@@ -151,19 +152,24 @@ Rules can be bundled together as elements in an array or values in a hash.
 - `SafeType::coerce!` coerces the object in place. The unspecified fields will not be modified.
 Note `SafeType::coerce!` cannot be used on a simple object, otherwise it will raise `SafeType::InvalidRuleError`. 
 
-To apply the rule on a simple object, we can call `[]` method as well.
+To apply the rule on a simple object, we can call the `coerce` method as well.
 ```ruby
-SafeType::Integer.default["1"]    # => 1
-SafeType::Integer["1"]            # => 1
+SafeType::Integer.default.coerce("1")    # => 1
+SafeType::Integer.coerce("1")            # => 1
 ```
-For the *SafeType* primitive types, apply the rule on the class itself will use the default rule.
+Note those two examples are equivalent:
+```ruby
+SafeType::coerce(ENV["PORT"], SafeType::Integer.default(3000))
+SafeType::Integer.default(3000).coerce(ENV["PORT"])
+``` 
+For the *SafeType* primitive types, applying the rule on the class itself will use the default rule.
 
 ## Customized Types
 We can inherit from a `SafeType::Rule` to create a customized type.
 We can override following methods if needed:
 - Override `initialize` to change the default values, types, or add more attributes.
 - Override `before` to update the input before convert. This method should take the input and return it after processing.
-- Override `validate` to check the value after convert. This method should take the input and return `true` or `false`.
+- Override `is_valid?` to check the value after convert. This method should take the input and return `true` or `false`.
 - Override `after` to update the input after validate. This method should take the input and return it after processing.
 - Override `handle_exceptions` to change the behavior of exceptions handling (e.g: send to the logger, or no exception) 
 - Override `default` or `strict` to modify the default and strict rule.

data/lib/safe_type.rb

@@ -13,7 +13,7 @@ require 'safe_type/primitive/time'
 module SafeType
   class << self
     def coerce(input, rule)
-      return rule[input] if rule.is_a?(SafeType::Rule)
+      return rule.coerce(input) if rule.is_a?(SafeType::Rule)
       if rule.class == ::Hash
         result = {}
         rule.each do |key, val|

data/lib/safe_type/primitive/date.rb

@@ -6,7 +6,7 @@ module SafeType
       super
     end
 
-    def validate(input)
+    def is_valid?(input)
       return false unless @from.nil? || input >= @from
       return false unless @to.nil? || input <= @to
       super

data/lib/safe_type/primitive/date_time.rb

@@ -6,7 +6,7 @@ module SafeType
       super
     end
 
-    def validate(input)
+    def is_valid?(input)
       return false unless @from.nil? || input >= @from
       return false unless @to.nil? || input <= @to
       super

data/lib/safe_type/primitive/float.rb

@@ -6,7 +6,7 @@ module SafeType
       super
     end
 
-    def validate(input)
+    def is_valid?(input)
       return false unless @min.nil? || input >= @min
       return false unless @max.nil? || input <= @max
       super

data/lib/safe_type/primitive/integer.rb

@@ -6,7 +6,7 @@ module SafeType
       super
     end
 
-    def validate(input)
+    def is_valid?(input)
       return false unless @min.nil? || input >= @min
       return false unless @max.nil? || input <= @max
       super

data/lib/safe_type/primitive/string.rb

@@ -6,7 +6,7 @@ module SafeType
       super
     end
 
-    def validate(input)
+    def is_valid?(input)
       return false unless @min_length.nil? || input.length >= @min_length
       return false unless @max_length.nil? || input.length <= @max_length
       super

data/lib/safe_type/primitive/symbol.rb

@@ -6,7 +6,7 @@ module SafeType
       super
     end
 
-    def validate(input)
+    def is_valid?(input)
       return false unless @min_length.nil? || input.length >= @min_length
       return false unless @max_length.nil? || input.length <= @max_length
       super

data/lib/safe_type/primitive/time.rb

@@ -6,7 +6,7 @@ module SafeType
       super
     end
 
-    def validate(input)
+    def is_valid?(input)
       return false unless @from.nil? || input >= @from
       return false unless @to.nil? || input <= @to
       super

data/lib/safe_type/rule.rb

@@ -12,7 +12,7 @@ module SafeType
       @default = default
     end
 
-    def validate(input)
+    def is_valid?(input)
       true
     end
 
@@ -28,8 +28,8 @@ module SafeType
       raise SafeType::CoercionError
     end
 
-    def self.[](input)
-      default[input]
+    def self.coerce(input)
+      default.coerce(input)
     end
 
     def self.default
@@ -40,11 +40,11 @@ module SafeType
       new(required: true)
     end
 
-    def [](input)
+    def coerce(input)
       raise SafeType::EmptyValueError if input.nil? && @required
       input = before(input)
       input = Converter.to_type(input, @type)
-      raise SafeType::ValidationError unless validate(input)
+      raise SafeType::ValidationError unless is_valid?(input)
       result = after(input)
       raise SafeType::EmptyValueError if result.nil? && @required
       return @default if result.nil?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: safe_type
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Donald Dong
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-13 00:00:00.000000000 Z
+date: 2018-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake