taipo 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5583e28b7b31de0e646bbdf2f03f274417946935
-  data.tar.gz: 5b9d14b293cabde611addc66b7857c2a16a46929
+  metadata.gz: 47a30b8ff6c187495ba01a26d23e30af086686d9
+  data.tar.gz: b8b8473c03c6f3bcebe33ea60e9c41e59359e45d
 SHA512:
-  metadata.gz: b9c8e5d7fc2d9a419fb91cb82d063e2c4e294ba5b43677546557a133b9e0dbae420c3984f499381ae4e4d54157eb254fa0106720e6e44c2b271bacb34a97e487
-  data.tar.gz: 84aee96a5489147d14e7d2ed37ae66dbbbf8f7a6d9e12a365c4fb901160e91d6a58f6bbd6e5d59d03bbe3183b07030215fb5f0c5f74b644f28b88dbcddc3c885
+  metadata.gz: 6523770dc0da188909c896d2f9f005af8aed1aa7f11e75a48c8a3eee8d80838e7e88a333ea0cff45e2a18fad3a5f0e2b9d15463222a47ffff74e35cb2dbb6fde
+  data.tar.gz: 1abfe9da9fcf22d927afe9b8b7c14e7a3fd0b4ecca5c004a071d39c57d501640509496696a19d1d77c84328351d646ef17bff10660e768bed611fb2ca61a155a

data/.simplecov

@@ -0,0 +1,3 @@
+SimpleCov.start 'rails' do
+  add_filter "/vendor/"
+end

data/.travis.yml

@@ -0,0 +1,14 @@
+env:
+ global:
+   - CC_TEST_REPORTER_ID=787a2f89b15c637323c7340d65ec17e898ac44480706b4b4122ea040c2a88f1d
+language: ruby
+rvm:
+ - 2.4.1
+before_script:
+ - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+ - chmod +x ./cc-test-reporter
+ - ./cc-test-reporter before-build
+script:
+ - bundle exec rake test
+after_script:
+ - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/LICENSE.md

@@ -1,6 +1,6 @@
 This is free and unencumbered software released into the public domain.
 
-Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commerciaL, and by any means.
+Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
 
 In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.
 

data/README.md

@@ -1,4 +1,6 @@
 [![Gem Version](https://badge.fury.io/rb/taipo.svg)](https://badge.fury.io/rb/taipo) [![Inline docs](http://inch-ci.org/github/pyrmont/taipo.svg?branch=master)](http://inch-ci.org/github/pyrmont/taipo)
+[![Build Status](https://travis-ci.org/pyrmont/taipo.svg?branch=master)](https://travis-ci.org/pyrmont/taipo)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/7b5dcb371ee422b27f0c/test_coverage)](https://codeclimate.com/github/pyrmont/taipo/test_coverage)
 
 # Taipo
 
@@ -138,6 +140,12 @@ Found a bug? I’d love to know about it. The best way is to report them in the
 
 If you’re interested in contributing to Taipo, feel free to fork and submit a pull request.
 
+## Versioning
+
+Taipo uses [Semantic Versioning 2.0.0][sv2].
+
+[sv2]: http://semver.org/
+
 ## Colophon
 
 Taipo began as, and remains primarily, an exercise to improve my programming skills. If Taipo has piqued your interest in adding type checks to Ruby, consider some of the other options, such as [Contracts][cnt], [Rtype][rty], [Rubype][rub] or [Sig][sig].

data/lib/taipo/check.rb

@@ -13,8 +13,13 @@ module Taipo
     # Syntactic sugar to allow a user to write +check types,...+ and +review
     # types,...+
     #
-    # @since 1.0.0
-    alias types binding
+    # The alias is written with underscores in order to support making aliasing
+    # with the keyword +types+ optional (since it's possible the user wishes to
+    # use this keyword for other purposes).
+    #
+    # @since 1.1.0
+    # @api private
+    alias __types__ binding
 
     # Check whether the given arguments match the given type definition in the
     # given context
@@ -39,7 +44,7 @@ module Taipo
     # @since 1.0.0
     #
     # @example
-    #   require 'taipo/taipo'
+    #   require 'taipo'
     #
     #   class A
     #     include Taipo::Check
@@ -57,10 +62,10 @@ module Taipo
     #
     #   a = A.new()
     #   a.foo('Hello world!')     #=> "Hello world!"
-    #   a.bar('Goodbye world!')   #=> raise Taipo::TypeError
+    #   a.bar('Goodbye world!')   #=> Taipo::TypeError
     def check(context, collect_invalids = false, **checks)
       msg = "The first argument to this method must be of type Binding."
-      raise TypeError, msg unless context.is_a? Binding
+      raise ::TypeError, msg unless context.is_a? Binding
 
       checks.reduce(Array.new) do |memo,(k,v)|
         arg = if k[0] == '@' && self.instance_variable_defined?(k)
@@ -84,8 +89,8 @@ module Taipo
           if Taipo::instance_method? v
             msg = "Object '#{k}' does not respond to #{v}."
           elsif arg.is_a? Enumerable
-            type_string = arg.class.name + Taipo.child_types_string(arg)
-            msg = "Object '#{k}' is #{type_string} but expected #{v}."
+            type_def = Taipo.object_to_type_def arg
+            msg = "Object '#{k}' is #{type_def} but expected #{v}."
           else
             msg = "Object '#{k}' is #{arg.class.name} but expected #{v}."
           end
@@ -113,5 +118,34 @@ module Taipo
     def review(context, **checks)
       self.check(context, true, checks)
     end
+
+    # Perform operations if this module is extended
+    #
+    # This is the callback called by Ruby when a module is included. In this
+    # case, the callback will alias the method +__types__+ as +types+ if
+    # {Taipo.alias?} returns true.
+    #
+    # @param extender [Class|Module] the class or module extending this module
+    #
+    # @since 1.1.0
+    # @api private
+    def self.extended(extender)
+      extender.singleton_class.send(:alias_method, :types, :__types__) if
+        Taipo.alias?
+    end
+
+    # Perform operations if this module is included
+    #
+    # This is the callback called by Ruby when a module is included. In this
+    # case, the callback will alias the method +__types__+ as +types+ if
+    # {Taipo.alias?} returns true.
+    #
+    # @param includer [Class|Module] the class or module including this module
+    #
+    # @since 1.1.0
+    # @api private
+    def self.included(includer)
+      includer.send(:alias_method, :types, :__types__) if Taipo.alias?
+    end
   end
-end
+end

data/lib/taipo/parser/validater.rb

@@ -23,7 +23,18 @@ module Taipo
     # One special case is where the name is left blank. The validater will
     # accept this as valid. {Taipo::Parser} will implictly add the name
     # 'Object' when parsing the type definition. This allows a clean syntax for
-    # duck types (which are really constraints on the class Object).
+    # duck types (discussed in further detail below).
+    #
+    # ==== Duck Types
+    #
+    #   '#to_s', '(#foo, #bar)'
+    #
+    # As noted above, duck types can be specified by using a blank name. Duck
+    # types are really constraints (discussed in further detail below) on the
+    # class Object. While normally constraints need to be enclosed in
+    # parentheses, if there is a blank name and only one method constraint, the
+    # parentheses can be omitted. For defining duck types that respond to
+    # multiple methods, the parentheses are required.
     #
     # === Collections
     #

data/lib/taipo/type_element/child_type.rb

@@ -11,10 +11,24 @@ module Taipo
       # @param components [Array<Taipo::TypeElement>] the components that will make up the ChildType
       #
       # @since 1.0.0
-      # @api private 
+      # @api private
       def initialize(components = nil)
         components.each { |c| self.push c } unless components.nil?
       end
+
+      # Return the String representation of this ChildType
+      #
+      # @since 1.1.0
+      # @api private
+      def to_s
+        inner = self.reduce(nil) do |memo_e,component|
+                  el = component.reduce(nil) do |memo_c,c|
+                         (memo_c.nil?) ? c.to_s : memo_c + '|' + c.to_s
+                       end
+                  (memo_e.nil?) ? el : memo_e + ',' + el
+                end
+        '<' + inner + '>'
+      end
     end
   end
 end

data/lib/taipo/type_element.rb

@@ -196,5 +196,24 @@ module Taipo
         c.constrain?(arg)
       end
     end
+
+    # Return the String representation of this TypeElement
+    #
+    # @since 1.1.0
+    # @api private
+    def to_s
+      name_str = @name
+      child_type_str = (@child_type.nil?) ? '' : @child_type.to_s
+      constraints_str = if @constraints.nil?
+                          ''
+                        else
+                          inner = @constraints.reduce('') do |memo,c|
+                                    (memo == '') ? c.to_s : memo + ',' + c.to_s
+                                  end
+                          '(' + inner + ')'
+                        end
+      name_str + child_type_str + constraints_str
+    end
+
   end
 end

data/lib/taipo/version.rb

@@ -1,3 +1,3 @@
 module Taipo
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/lib/taipo.rb

@@ -11,19 +11,58 @@ require 'taipo/parser'
 # By including the module {Taipo::Check}, a user can call the
 # {Taipo::Check#check} or {Taipo::Check#review} methods in their classes
 # whenever a guard statement is necessary. Expectations are written as type
-# definitions that can specify the type of the variable (including sum types)
-# and the types of any elements it contains, all subject to a given constraints
-# (see {Taipo::Parser::Validater} for the full syntax).
+# definitions. A type definition contains the name of the type and the type
+# definitions of any elements it contains (if it is enumerable). Optional
+# constraints may be specified and sum types are also possible. See
+# {Taipo::Parser::Validater} for the full syntax.
 #
-# As syntactic sugar, the {Taipo::Check} module also aliases +Kernel#binding+
-# with the keyword +types+. This allows the user to call {Taipo::Check#check}
-# and {Taipo::Check#review} by writing +check types, ...+ and
-# +review types, ...+ respectively.
+# Taipo works by:
+# 1. extracting the values of the arguments to be checked from a Binding;
+# 2. transforming the type definitions provided as Strings into an array of
+#    {Taipo::TypeElement} instances; and
+# 3. checking whether the argument's value matches any of the instances of
+#    {Taipo::TypeElement} in the array.
+#
+# As syntactic sugar, the {Taipo::Check} module will by default alias
+# +Kernel#binding+ with the keyword +types+. This allows the user to call
+# {Taipo::Check#check} by writing +check types+ (with a similar syntax for
+# {Taipo::Check#review}). If the user does not want to alias, they can set
+# {Taipo.alias=} to +false+ before including or extending {Taipo::Check}.
 #
 # @since 1.0.0
 # @see https://github.com/pyrmont/taipo
 module Taipo
 
+  # The setting for whether +Kernel#binding+ should be aliased with the keyword
+  # +types+.
+  #
+  # @since 1.1.0
+  # @api private
+  @@alias = true
+
+  # Set whether +Kernel#binding+ should be aliased with the keyword +types+.
+  #
+  # @param v [Boolean] Whether to alias
+  #
+  # @since 1.1.0
+  # @api private
+  def self.alias=(v)
+    msg = "The argument to this method must be a Boolean."
+    raise ::TypeError, msg unless v.is_a?(TrueClass) || v.is_a?(FalseClass)
+
+    @@alias = v
+  end
+
+  # Check whether +Kernel#binding+ should be aliased with the keyword +types+.
+  #
+  # @return [Boolean] the result
+  #
+  # @since 1.1.0
+  # @api private
+  def self.alias?
+    @@alias
+  end
+
   # Check if a string is the name of an instance method
   #
   # @note All this does is check whether the given string begins with a hash
@@ -39,17 +78,60 @@ module Taipo
     str[0] == '#'
   end
 
-  # Convert an array into a type definition for the types of the elements in the array
+  # Return the type definition for an object
   #
-  # @param arg [Array] the array of elements
+  # @note This assume that each element returned by Enumerator#each has the same
+  #   number of components.
   #
-  # @return [String] a type definition of the types in the array
+  # @param arg [Object] the object
   #
-  # @since 1.0.0
+  # @return [String] a type definition of the object
+  #
+  # @since 1.1.0
+  # @api private
+  def self.object_to_type_def(obj)
+    return obj.class.name unless obj.is_a? Enumerable
+
+    if obj.is_a? Array
+      element_types = Hash.new
+      obj.each { |o| element_types[self.object_to_type_def(o)] = true }
+      if element_types.empty?
+        obj.class.name
+      else
+        obj.class.name + '<' + element_types.keys.join('|') + '>'
+      end
+    else
+      element_types = Array.new
+      obj.each.with_index do |element,index_e|
+        element.each.with_index do |component,index_c|
+          element_types[index_c] = Hash.new if index_e == 0
+          c_type = self.object_to_type_def(component)
+          element_types[index_c][c_type] = true
+        end
+      end
+      inner = element_types.reduce('') do |memo,e|
+        e_type = e.keys.join('|')
+        (memo == '') ? e_type : memo + ',' + e_type
+      end
+      if element_types.empty?
+        obj.class.name
+      else
+        obj.class.name + '<' + inner + '>'
+      end
+    end
+  end
+
+  # Return a String representation of an array of {Taipo::TypeElement}
+  #
+  # @param arg [Array<Taipo::TypeElement>] the array of {Taipo::TypeElement}
+  #
+  # @return [String] the String representation
+  #
+  # @since 1.1.0
   # @api private
-  def self.child_types_string(arg)
-    child_types = Hash.new
-    arg.each { |a| child_types[a.class.name] = true }
-    '<' + child_types.keys.join('|') + '>'
+  def self.types_to_s(types)
+    types.reduce('') do |memo,t|
+      (memo == '') ? t.to_s : memo + '|' + t.to_s
+    end
   end
-end
+end

data/taipo.gemspec

@@ -25,5 +25,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "minitest", "~> 5.10.3"
   spec.add_development_dependency "minitest-reporters", "~> 1.1.19"
   spec.add_development_dependency "shoulda-context", "~> 1.2.0"
+  spec.add_development_dependency "simplecov", "~> 0.15.1"
   spec.add_development_dependency "yard", "~> 0.9.12"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: taipo
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Michael Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-19 00:00:00.000000000 Z
+date: 2018-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.1
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -104,6 +118,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".simplecov"
+- ".travis.yml"
 - Gemfile
 - LICENSE.md
 - README.md