taipo 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4be2ae174cd1d29fb2d7e4088ca69c9da0aecfb3
-  data.tar.gz: ac87cf9977ef502fe802459da7ea0855587fecc2
+  metadata.gz: 5ae496b6a69d19aceb9f158a587cb7c2f7d0faa1
+  data.tar.gz: ec0096547e644b51f8759529a246b273ff5354e8
 SHA512:
-  metadata.gz: bafc5ce5e262afe6a17ca0bb06476ba4f2120d337de2e44b9bef5d0814ce556466d70a0efbe99c9df7095e0588cba45db874328d1d0dab73a03e140887f5a85c
-  data.tar.gz: b67fcb77105810336e8616b83a188115ddcde6ecc202221960a5c7e299be3a61a49e7b03e85a22cd998301a15c6cf456c7f0ba374b2986f2c2d2744db5db77d3
+  metadata.gz: cb51c506c37aaaca6232488649b8cf59246ea2a3f69e7efb5230b677e1c8d32e276949126202325ebea6c9e8f4d5f652287a47e0a6aa6afd08c23da0f4cd86eb
+  data.tar.gz: 6c1b5b0bb7512d4829167bb5d8400f204fb114cedf16350a0099f71a43a54139a5908c16f08d9a513f9ce23c6c4bbc80b0f4a29c1cd2289411f048bd295006c6

data/README.md

@@ -102,6 +102,14 @@ It's possible to specify a duck type by writing the instance method (or methods)
 check types, a: '#to_s', b: '(#foo, #bar)'
 ```
 
+#### Optional Types
+
+If `nil` is permitted as a value, the optional shorthand `?` can be appended to the end of a class name to form an optional type. Collections and constraints can follow as usual.
+
+```ruby
+check types, a: 'String?', b: 'Array?<Integer>', c: 'Integer?(min: 0)'
+```
+
 ### Collections
 
 Taipo can also check whether a variable has a collection of elements of the specified child type. A child type can consist of the same components as any other type (ie. a name, collection, constraint, sum).

data/lib/taipo/check.rb

@@ -88,6 +88,8 @@ module Taipo
         unless collect_invalids || is_match
           if Taipo::instance_method? v
             msg = "Object '#{k}' does not respond to #{v}."
+          elsif Taipo::symbol? v
+            msg = "Object '#{k}' is not equal to #{v}."
           elsif arg.is_a? Enumerable
             type_def = Taipo.object_to_type_def arg
             msg = "Object '#{k}' is #{type_def} but expected #{v}."

data/lib/taipo/parser.rb

@@ -35,7 +35,7 @@ module Taipo
 
         case c
         when '|'
-          unless attached? previous # content.empty? # Previous character must have been '>' or ')'.
+          unless attached? previous # Previous character must have been '>' or ')'.
             el = Taipo::TypeElement.new name: content
             content = ''
             elements = stack.pop
@@ -51,7 +51,7 @@ module Taipo
           first_component = Array.new
           stack.push first_component
         when '>'
-          if attached? previous # content.empty? # Previous character must have been '>' or ')'.
+          if attached? previous # Previous character must have been '>' or ')'.
             last_component = stack.pop
           else
             el = Taipo::TypeElement.new name: content.strip

data/lib/taipo/parser/validater.rb

@@ -36,6 +36,18 @@ module Taipo
     # parentheses can be omitted. For defining duck types that respond to
     # multiple methods, the parentheses are required.
     #
+    # ==== Optional Types
+    #
+    #   'String?', 'Array<Integer?>', 'Symbol?|String?'
+    #
+    # It is possible to specify an 'optional' type by appending a question mark
+    # to the name of the type. This shorthand functions similarly to defining a
+    # sum type with NilClass (the implementation of how optional types are
+    # checked is slightly different, however; see {Taipo::TypeElement#match?}).
+    # It is not possible to define an optional duck type. For that, either the
+    # implicit Object class should be specified (and then made optional), or a
+    # sum type should be used.
+    #
     # === Collections
     #
     #   'Array<Integer>', 'Hash<Symbol, String>', 'Array<Array<Float>>'

data/lib/taipo/type_element.rb

@@ -136,6 +136,7 @@ module Taipo
     # @since 1.0.0
     # @api private
     def match?(arg)
+      return true if optional? && arg.nil?
       match_class?(arg) && match_constraints?(arg) && match_child_type?(arg)
     end
 
@@ -150,12 +151,13 @@ module Taipo
     # @since 1.0.0
     # @api private
     def match_class?(arg)
-      if @name == 'Boolean'
+      actual_name = (optional?) ? @name[0..-2] : @name
+      if actual_name == 'Boolean'
         arg.is_a?(TrueClass) || arg.is_a?(FalseClass)
       else
-        msg = "Class to match #{@name} is not defined"
-        raise Taipo::SyntaxError, msg unless Object.const_defined?(@name)
-        arg.is_a? Object.const_get(@name)
+        msg = "Class to match #{actual_name} is not defined"
+        raise Taipo::SyntaxError, msg unless Object.const_defined?(actual_name)
+        arg.is_a? Object.const_get(actual_name)
       end
     end
 
@@ -174,7 +176,7 @@ module Taipo
       return false if !self_childless && arg_childless
 
       arg.all? do |a|
-        if a.is_a?(Array) # The elements of this collection have components
+        if !arg.is_a?(Array) && a.is_a?(Array)
           a.each.with_index.reduce(nil) do |memo,(component,index)|
             result = @child_type[index].any? { |c| c.match? component }
             (memo.nil?) ? result : memo && result
@@ -201,6 +203,22 @@ module Taipo
       end
     end
 
+    # Check whether this element is an optional
+    #
+    # An optional type is a variation on a normal type that also matches +nil+.
+    # Taipo borrows the syntax used in some other languages of denoting
+    # optional types by appending a question mark to the end of the class name.
+    #
+    # @note This merely checks whether +@name+ ends in a question mark.
+    #
+    # @return [Boolean] the result
+    #
+    # @since 1.3.0
+    # @api private
+    def optional?
+      @name[-1] == '?'
+    end
+
     # Return the String representation of this TypeElement
     #
     # @since 1.1.0

data/lib/taipo/type_element/child_type.rb

@@ -8,7 +8,12 @@ module Taipo
 
       # Initialize a new collection
       #
-      # @param components [Array<Taipo::TypeElement>] the components that will make up the ChildType
+      # @note The +components+ argument is two-dimensional array because the
+      #   element returned by an enumerator for a collection can consist of
+      #   multiple elements (eg. a Hash, where it consists of two elements).
+      #
+      # @param components [Array<Array<Taipo::TypeElement>>] the components that
+      #   will make up the ChildType
       #
       # @since 1.0.0
       # @api private

data/lib/taipo/version.rb

@@ -1,3 +1,3 @@
 module Taipo
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: taipo
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Michael Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-23 00:00:00.000000000 Z
+date: 2018-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler