taipo 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4f4c74c97181b0db2c4555454d0a4ae4d9af758
-  data.tar.gz: 97107b60d9e683fbc0a3ca53c6e27ae98c2fe62a
+  metadata.gz: 4be2ae174cd1d29fb2d7e4088ca69c9da0aecfb3
+  data.tar.gz: ac87cf9977ef502fe802459da7ea0855587fecc2
 SHA512:
-  metadata.gz: 67e4ab2d84f29b578f15668788edbef1eae23a5cc31962ebb5184667288bfa27e934c7679be11425ee7a051cc75a7d4edd778a3c6e57a65486f10491777fe062
-  data.tar.gz: 0ac0f1d1f47ecbee80543f27ec8b9c50107eddba5445e0dfa00a17c59aae180b9f00b69186b5497c00ad0634b3c52104e52b79cbf203ba19a6189e6ad5682de8
+  metadata.gz: bafc5ce5e262afe6a17ca0bb06476ba4f2120d337de2e44b9bef5d0814ce556466d70a0efbe99c9df7095e0588cba45db874328d1d0dab73a03e140887f5a85c
+  data.tar.gz: b67fcb77105810336e8616b83a188115ddcde6ecc202221960a5c7e299be3a61a49e7b03e85a22cd998301a15c6cf456c7f0ba374b2986f2c2d2744db5db77d3

data/README.md

@@ -12,9 +12,9 @@ Taipo is a simple library for checking the types of variables.
 
 ## Overview
 
-When we deal with variables in our code, we have certain expectations about what those variables can and can’t do.
+When we deal with variables in our code, we have certain expectations about what those variables can and can't do.
 
-Taipo provides a simple way to make those expectations explicit. If an expectation isn’t met, Taipo can either raise an exception or return the problematic variables for us to handle.
+Taipo provides a simple way to make those expectations explicit. If an expectation isn't met, Taipo can either raise an exception or return the problematic variables for us to handle.
 
 ## Installation
 
@@ -27,23 +27,23 @@ Taipo provides two methods in the `Taipo::Check` module that we can mix into our
 ### #check
 
 ```ruby
-require ‘taipo’
+require 'taipo'
 
 class Foo
   include Taipo::Check
 
   def double(val)
-    check types, val: ‘Integer’
+    check types, val: 'Integer'
     val * 2
   end
 end
 
 foo = Foo.new
 foo.double 5      #=> 10
-foo.double ‘Oops’ #=> Taipo::TypeError
+foo.double 'Oops' #=> Taipo::TypeError
 ```
 
-The method `#check` will raise an exception as soon as one of its arguments doesn’t match its type definition.
+The method `#check` will raise an exception as soon as one of its arguments doesn't match its type definition.
 
 [More information about `#check`][rdc] is available in the documentation.
 
@@ -52,24 +52,24 @@ The method `#check` will raise an exception as soon as one of its arguments does
 ### #review
 
 ```ruby
-require ‘taipo’
+require 'taipo'
 
 class Foo
   include Taipo::Check
 
   def add(x, y)
-    errors = review types, x: ‘Integer’, y: ‘Integer’
+    errors = review types, x: 'Integer', y: 'Integer'
     if errors.empty?
       x + y
     else
-      ‘Oops’
+      'Oops'
     end
   end
 end
 
 foo = Foo.new
 foo.add 4, 5      #=> 9
-foo.add 2, ‘OK’   #=> ‘Oops’
+foo.add 2, 'OK'   #=> 'Oops'
 ```
 
 The method `#review` will put the invalid arguments into an array and return that to the user. If there are no errors, the array is empty.
@@ -88,7 +88,7 @@ The information in this README is only meant as an introduction. [More informati
 
 ### Names
 
-The simplest case is to write the name of a class. For example, `’String’`. Inherited class names can also be used.
+The simplest case is to write the name of a class. For example, `'String'`. Inherited class names can also be used.
 
 ```ruby
 check types, a: 'String', b: 'Numeric'
@@ -126,19 +126,27 @@ Type definitions can be combined to form sum types. Sum types consist of two or
 check types, a: 'String|Float', b: 'Boolean|Array<String|Hash<Symbol,Point>|Array<String>>', c: 'Integer(max: 100)|Float(max: 100)'
 ```
 
+#### Enums
+
+It's possible to approximate an enum by writing a sum type consisting of Symbols.
+
+```ruby
+check types, a: ':foo|:bar', b: ':one|:two|:three'
+```
+
 ## Requirements
 
 Taipo has been tested with Ruby version 2.4.2.
 
 ## Bugs
 
-Found a bug? I’d love to know about it. The best way is to report them in the [Issues section][ghi] on GitHub.
+Found a bug? I'd love to know about it. The best way is to report them in the [Issues section][ghi] on GitHub.
 
 [ghi]: https://github.com/pyrmont/taipo/issues
 
 ## Contributing
 
-If you’re interested in contributing to Taipo, feel free to fork and submit a pull request.
+If you're interested in contributing to Taipo, feel free to fork and submit a pull request.
 
 ## Versioning
 
@@ -159,4 +167,4 @@ Taipo began as, and remains primarily, an exercise to improve my programming ski
 
 Taipo is released into the public domain. See [LICENSE.md][lc] for more details.
 
-[lc]: https://github.com/pyrmont/taipo/blob/master/LICENSE.md
+[lc]: https://github.com/pyrmont/taipo/blob/master/LICENSE.md

data/lib/taipo.rb

@@ -70,7 +70,7 @@ module Taipo
   # @note All this does is check whether the given string begins with a hash
   #   symbol.
   #
-  # @param str [String] the method name to check
+  # @param str [String] the string to check
   #
   # @return [Boolean] the result
   #
@@ -85,7 +85,7 @@ module Taipo
   # @note This assume that each element returned by Enumerator#each has the same
   #   number of components.
   #
-  # @param arg [Object] the object
+  # @param obj [Object] the object
   #
   # @return [String] a type definition of the object
   #
@@ -123,9 +123,23 @@ module Taipo
     end
   end
 
+  # Check if a string is the name of a symbol
+  #
+  # @note All this does is check whether the given string begins with a colon.
+  #
+  # @param str [String] the string to check
+  #
+  # @return [Boolean] the result
+  #
+  # @since 1.2.0
+  # @api private
+  def self.symbol?(str)
+    str[0] == ':'
+  end
+
   # Return a String representation of an array of {Taipo::TypeElement}
   #
-  # @param arg [Array<Taipo::TypeElement>] the array of {Taipo::TypeElement}
+  # @param types [Array<Taipo::TypeElement>] the array of {Taipo::TypeElement}
   #
   # @return [String] the String representation
   #

data/lib/taipo/parser.rb

@@ -22,6 +22,7 @@ module Taipo
       Taipo::Parser::Validater.validate str
 
       content = ''
+      previous = ''
       is_fallthrough = false
       fallthroughs = [ '/', '"' ]
       closing_symbol = ''
@@ -34,12 +35,13 @@ module Taipo
 
         case c
         when '|'
-          next if content.empty? # Previous character must have been '>' or ')'.
-          el = Taipo::TypeElement.new name: content
-          content = ''
-          elements = stack.pop
-          elements.push el
-          stack.push elements
+          unless attached? previous # content.empty? # Previous character must have been '>' or ')'.
+            el = Taipo::TypeElement.new name: content
+            content = ''
+            elements = stack.pop
+            elements.push el
+            stack.push elements
+          end
         when '<'
           el = Taipo::TypeElement.new name: content
           content = ''
@@ -49,7 +51,7 @@ module Taipo
           first_component = Array.new
           stack.push first_component
         when '>'
-          if content.empty? # Previous character must have been '>' or ')'.
+          if attached? previous # content.empty? # Previous character must have been '>' or ')'.
             last_component = stack.pop
           else
             el = Taipo::TypeElement.new name: content.strip
@@ -65,7 +67,10 @@ module Taipo
           elements.push parent_el
           stack.push elements
         when '('
-          if content.empty? # Previous character must have been '>'.
+          if unattached? previous
+            el = Taipo::TypeElement.new name: 'Object'
+            content = ''
+          elsif attached_collection? previous # Previous character must have been '>'.
             elements = stack.pop
             el = elements.pop
             stack.push elements
@@ -77,8 +82,8 @@ module Taipo
           cst_collection = Array.new
           stack.push cst_collection
         when '#'
-          if bare_method_constraint? stack
-            content = content + '#'
+          if unattached? previous 
+            content = '#'
           else
             cst = Taipo::TypeElement::Constraint.new
             content = ''
@@ -87,11 +92,18 @@ module Taipo
             stack.push cst_collection
           end
         when ':'
-          cst = Taipo::TypeElement::Constraint.new name: content.strip
-          content = ''
-          cst_collection = stack.pop
-          cst_collection.push cst
-          stack.push cst_collection
+          if unattached? previous 
+            content = ':'
+          elsif content.strip.empty?
+            content = ':'
+          else
+            content = content
+            cst = Taipo::TypeElement::Constraint.new name: content.strip
+            content = ''
+            cst_collection = stack.pop
+            cst_collection.push cst
+            stack.push cst_collection
+          end
         when ',' # We could be inside a collection or a set of constraints
           if inside_collection? stack
             previous_component = stack.pop
@@ -132,6 +144,7 @@ module Taipo
           end
           content = content + c
         end
+        previous = c
       end
 
       unless content.empty?
@@ -143,6 +156,37 @@ module Taipo
 
       stack.pop
     end
+  
+    # Check whether the current element is 'attached' to anything
+    #
+    # This check is performed by checking whether +char+ is the final character
+    # in a collection or constraint.
+    #
+    # @param char [String] the character to use in the test
+    #
+    # @return [Boolean] the result
+    #
+    # @since 1.2.0
+    # @api private
+    def self.attached?(char)
+      char == '>' || char == ')'
+    end
+
+    # Check whether the current element is 'attached' to a collection
+    #
+    # Like {self.attached?}, this check is performed by checking +char+. In
+    # this case, the check is whether +char+ is the final character in a
+    # collection.
+    #
+    # @param char [String] the character to use in the test
+    #
+    # @return [Boolean] the result
+    #
+    # @since 1.2.0
+    # @api private
+    def self.attached_collection?(char)
+      char == '>'
+    end
 
     # Check if the parser is inside a collection
     #
@@ -156,16 +200,19 @@ module Taipo
       stack[-2]&.class == Taipo::TypeElement::ChildType
     end
 
-    # Check if this constraint is only a method
+    # Check whether the current element is 'unattached' to anything
     #
-    # @param stack [Array] the stack of parsed elements
+    # This check checks whether +char+ represents the beginning of a discrete
+    # type definition.
+    #
+    # @param char [String] the character to use in the test
     #
     # @return [Boolean] the result
     #
-    # @since 1.0.0
+    # @since 1.2.0
     # @api private
-    def self.bare_method_constraint?(stack)
-      stack[-2]&.class != Taipo::TypeElement
+    def self.unattached?(char)
+      char.empty? || char == '|' || char == '<'
     end
   end
 end

data/lib/taipo/parser/validater.rb

@@ -103,6 +103,15 @@ module Taipo
     # The sum comprises two or more type definitions, each separated by a bar
     # (ie. +|+).
     #
+    # ==== Enums
+    #
+    #   ':foo|:bar', ':one|:two|:three'
+    #
+    # It's possible to approximate the enum idiom available in many languages
+    # by creating a sum type consisting of Symbols. As a convenience, Taipo 
+    # parses these values as constraints on the Object class. In other words, 
+    # +':foo|:bar'+ is really +'Object(val: :foo)|Object(val: :bar)'+.
+    #
     # @since 1.0.0
     module Validater
 
@@ -132,7 +141,7 @@ module Taipo
         chars = str.chars
         str_length = chars.size
 
-        state.prohibit_all except: [ :hsh, :oth ]
+        state.prohibit_all except: [ :lpr, :hsh, :cln, :oth ]
 
         while (i < str_length)
           msg = "The string '#{str}' has an error here: #{str[0, i+1]}"
@@ -142,11 +151,11 @@ module Taipo
             raise Taipo::SyntaxError, msg unless conditions.all?
             state.enable :lab
             state.enable :lpr
-            state.prohibit_all except: [ :hsh, :oth ]
+            state.prohibit_all except: [ :lpr, :hsh, :cln, :oth ]
           when '<' # lab
             conditions = [ state.allowed?(:lab) ]
             raise Taipo::SyntaxError, msg unless conditions.all?
-            state.prohibit_all except: [ :hsh, :oth ]
+            state.prohibit_all except: [ :lpr, :hsh, :cln, :oth ]
             state.increment :angle
           when '>' # rab
             conditions = [ state.allowed?(:rab), state.inside?(:angle) ]
@@ -176,10 +185,20 @@ module Taipo
               state.decrement :const
             end
           when ':' # cln
-            conditions = [ state.allowed?(:cln), state.inside?(:paren) ]
+            conditions = [ state.allowed?(:cln) ]
             raise Taipo::SyntaxError, msg unless conditions.all?
-            state.prohibit_all except: [ :sls, :qut, :spc, :oth ]
-            state.decrement :const
+            if state.outside? :paren
+              state.disable :lab
+              state.disable :lpr
+              state.prohibit_all except: [ :oth ]
+            else
+              if state.count(:const) == 0 # This is a symbol.
+                state.prohibit_all except: [ :qut, :oth ]
+              else
+                state.prohibit_all except: [ :cln, :sls, :qut, :spc, :oth ]
+                state.decrement :const
+              end
+            end
           when '/' #sls
             conditions = [ state.allowed?(:sls), state.inside?(:paren),
                            state.outside?(:const) ]
@@ -201,11 +220,15 @@ module Taipo
           when ' ' # spc
             conditions = [ state.allowed?(:spc) ]
             raise Taipo::SyntaxError, msg unless conditions.all?
-            state.prohibit_all except: [ :hsh, :sls, :qut, :oth ]
+            state.prohibit_all except: [ :hsh, :cln, :sls, :qut, :oth ]
           else # oth
             conditions = [ state.allowed?(:oth) ]
             raise Taipo::SyntaxError, msg unless conditions.all?
-            state.allow_all except: [ :hsh, :spc ]
+            if state.inside? :paren
+              state.allow_all except: [ :hsh, :spc ]
+            else
+              state.allow_all except: [ :hsh, :cln, :spc ]
+            end
           end
           i += 1
         end

data/lib/taipo/type_element.rb

@@ -40,7 +40,7 @@ module Taipo
     #   wrong type
     # @raise [::ArgumentError] if +name+, +child_type+ or +constraints+ was
     #   blank or empty, or +child_type+ or +constraints+ was non-nil and this
-    #   is a duck type (ie. a method the type responds to)
+    #   is a duck type (ie. a method the type responds to) or a symbol
     #
     # @since 1.0.0
     # @api private
@@ -61,15 +61,19 @@ module Taipo
       msg = 'Argument constraints was empty.'
       raise ::ArgumentError, msg if constraints&.empty?
 
-      if Taipo.instance_method? name
+      if Taipo.instance_method?(name) || Taipo.symbol?(name)
         msg = 'Argument child_type should have been nil.'
         raise ::ArgumentError, msg unless child_type.nil?
         msg = 'Argument constraints should have been nil.'
         raise ::ArgumentError, msg unless constraints.nil?
 
-        constraints = [
-          Taipo::TypeElement::Constraint.new(name: nil, value: name[1..-1])
-        ]
+        constraints = if Taipo.instance_method? name
+                        [Taipo::TypeElement::Constraint.new(name: nil, 
+                                                            value: name[1..-1])]  
+                      elsif Taipo.symbol? name
+                        [Taipo::TypeElement::Constraint.new(name: 'val',
+                                                            value: name)]
+                      end
         name = 'Object'
       end
       @name = name
@@ -214,6 +218,5 @@ module Taipo
                         end
       name_str + child_type_str + constraints_str
     end
-
   end
 end

data/lib/taipo/type_element/constraint.rb

@@ -44,7 +44,13 @@ module Taipo
         msg = 'Argument name was an empty string.'
         raise ::ArgumentError, msg if name&.empty?
 
-        @name = (name.nil?) ? Constraint::METHOD : name
+        @name = if name.nil?
+                  Constraint::METHOD
+                elsif name == ':'
+                  'val'
+                else
+                  name
+                end
         @value = self.parse_value value
       end
 
@@ -79,6 +85,8 @@ module Taipo
         when 'val'
           if @value[0] == '"' && @value[-1] == '"'
             arg.to_s == @value.slice(1..-2)
+          elsif arg.is_a? Symbol
+            ":" + arg.to_s == @value
           else
             arg.to_s == @value
           end

data/lib/taipo/version.rb

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

metadata

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