yard_types 0.1.1 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0369d77a792080e158ad1f24d780bc21a84ec3ff
+  data.tar.gz: 4ce73e430052d5988d0083d7c07b6b4499d2b6d7
+SHA512:
+  metadata.gz: 155a4ae5f178b5b3b04d06a4d7c161b15d514500254dba0160006e65f3def7672e7cfd0940d98ce5e62ecd5fecb8fff690374f69f46315829436f100f6aad4c3
+  data.tar.gz: d94dabcce7a961141a7de4f26a00363f5112f61fb56d7b16f10a33306641d6d2066d7d6461ca41112865a621e46f0c0812fde2a19f0530a5dcefcf34dcd79867

data/.yardopts

@@ -0,0 +1,2 @@
+--title "yard_types"
+--markup markdown

data/lib/yard_types.rb

@@ -18,7 +18,7 @@ module YardTypes
     end
   end
 
-  # Returned from {YardTypes.validate} when a type check succeeds,
+  # Returned from {YardTypes.check} when a type check succeeds,
   # providing the particular type which satisfied the
   # {TypeConstraint}.
   class Success < Result
@@ -27,7 +27,7 @@ module YardTypes
     end
   end
 
-  # Returned from {YardTypes.validate} when a type check fails,
+  # Returned from {YardTypes.check} when a type check fails,
   # providing a reference to the {TypeConstraint} and a means of
   # generating error messages describing the error.
   class Failure < Result
@@ -52,13 +52,12 @@ module YardTypes
   end
 
   # Parses a type identifier with {#parse}, then validates that the
-  # given +obj+ satisfies the type constraint.
+  # given `obj` satisfies the type constraint.
   #
   # @param type [String, Array<String>] A YARD type description; see {#parse}.
   # @param obj [Object] Any object.
   # @return [Result] success or failure.
-  # @todo deprecate; rename it +check+ to match everything else.
-  def validate(type, obj)
+  def check(type, obj)
     constraint = parse(type)
     if constraint.check(obj)
       Success.new

data/lib/yard_types/types.rb

@@ -13,9 +13,9 @@ module YardTypes
     end
   end
 
-  # A +TypeConstraint+ specifies the set of acceptable types
+  # A `TypeConstraint` specifies the set of acceptable types
   # which can satisfy the constraint. Parsing any YARD type
-  # description will return a +TypeConstraint+ instance.
+  # description will return a `TypeConstraint` instance.
   #
   # @see YardTypes.parse
   class TypeConstraint
@@ -28,7 +28,7 @@ module YardTypes
     end
 
     # @param i [Fixnum]
-    # @return [Type] the type at index +i+
+    # @return [Type] the type at index `i`
     # @todo deprecate this; remnant from original TDD'd API.
     def [](i)
       accepted_types[i]
@@ -41,13 +41,13 @@ module YardTypes
     end
 
     # @param obj [Object] Any object.
-    # @return [Type, nil] The first type which matched +obj+,
-    #   or +nil+ if none.
+    # @return [Type, nil] the first type which matched `obj`,
+    #   or `nil` if none.
     def check(obj)
       accepted_types.find { |t| t.check(obj) }
     end
 
-    # @return [String] A YARD type string describing this set of
+    # @return [String] a YARD type string describing this set of
     #   types.
     def to_s
       accepted_types.map(&:to_s).join(', ')
@@ -96,15 +96,15 @@ module YardTypes
     end
   end
 
-  # A {DuckType} constraint is specified as +#some_message+,
+  # A {DuckType} constraint is specified as `#some_message`,
   # and indicates that the object must respond to the method
-  # +some_message+.
+  # `some_message`.
   class DuckType < Type
     # @return [String] The method the object must respond to;
-    #   this does not include the leading +#+ character.
+    #   this does not include the leading `#` character.
     attr_reader :message
 
-    # @param name [String] The YARD identifier, eg +#some_message+.
+    # @param name [String] The YARD identifier, eg `#some_message`.
     def initialize(name)
       @name    = name
       @message = name[1..-1]
@@ -116,22 +116,22 @@ module YardTypes
     end
 
     # @param (see Type#check)
-    # @return [Boolean] +true+ if the object responds to +message+.
+    # @return [Boolean] `true` if the object responds to `message`.
     def check(obj)
       obj.respond_to? message
     end
   end
 
-  # A {KindType} constraint is specified as +SomeModule+ or
-  # +SomeClass+, and indicates that the object must be a kind of that
+  # A {KindType} constraint is specified as `SomeModule` or
+  # `SomeClass`, and indicates that the object must be a kind of that
   # module.
   class KindType < Type
     # Type checks a given object. Special consideration is given to
-    # the pseudo-class +Boolean+, which does not actually exist in Ruby,
-    # but is commonly used to mean +TrueClass, FalseClass+.
+    # the pseudo-class `Boolean`, which does not actually exist in Ruby,
+    # but is commonly used to mean `TrueClass, FalseClass`.
     #
     # @param (see Type#check)
-    # @return [Boolean] +true+ if +obj.kind_of?(constant)+.
+    # @return [Boolean] `true` if `obj.kind_of?(constant)`.
     def check(obj)
       if name == 'Boolean'
         obj == true || obj == false
@@ -145,7 +145,7 @@ module YardTypes
       name
     end
 
-    # @return [Module] the constant specified by +name+.
+    # @return [Module] the constant specified by `name`.
     # @raise [TypeError] if the constant is neither a module nor a class
     # @raise [NameError] if the specified constant could not be loaded.
     def constant
@@ -165,14 +165,14 @@ module YardTypes
   end
 
   # A {LiteralType} constraint is specified by the name of one of YARD's
-  # supported "literals": +true+, +false+, +nil+, +void+, and +self+, and
+  # supported "literals": `true`, `false`, `nil`, `void`, and `self`, and
   # indicates that the object must be exactly one of those values.
   #
-  # However, +void+ and +self+ have no particular meaning: +void+ is typically
+  # However, `void` and `self` have no particular meaning: `void` is typically
   # used solely to specify that a method returns no meaningful types; and
-  # +self+ is used to specify that a method returns its receiver, generally
+  # `self` is used to specify that a method returns its receiver, generally
   # to indicate that calls can be chained. All values type check as valid
-  # objects for +void+ and +self+ literals.
+  # objects for `void` and `self` literals.
   class LiteralType < Type
     # @return [Array<String>] the list of supported literal identifiers.
     def self.names
@@ -185,9 +185,9 @@ module YardTypes
     end
 
     # @param (see Type#check)
-    # @return [Boolean] +true+ if the object is exactly +true+, +false+, or
-    #   +nil+ (depending on the value of +name+); for +void+ and +self+
-    #   types, this method *always* returns +true+.
+    # @return [Boolean] `true` if the object is exactly `true`, `false`, or
+    #   `nil` (depending on the value of `name`); for `void` and `self`
+    #   types, this method *always* returns `true`.
     # @raise [NotImplementedError] if an unsupported literal name is to be
     #   tested against.
     def check(obj)
@@ -201,12 +201,12 @@ module YardTypes
     end
   end
 
-  # A {CollectionType} is specified with the syntax +Kind<Some, #thing>+, and
-  # indicates that the object is a kind of +Kind+, containing only objects which
-  # type check against +Some+ or +#thing+.
+  # A {CollectionType} is specified with the syntax `Kind<Some, #thing>`, and
+  # indicates that the object is a kind of `Kind`, containing only objects which
+  # type check against `Some` or `#thing`.
   #
   # @todo The current implementation of type checking here requires that the collection
-  #   respond to +all?+; this may not be ideal.
+  #   respond to `all?`; this may not be ideal.
   class CollectionType < Type
     include OrList
 
@@ -233,8 +233,8 @@ module YardTypes
     end
 
     # @param (see Type#check)
-    # @return [Boolean] +true+ if the object is both a kind of +name+, and all of
-    #   its contents (if any) are of the types in +types+. Any combination, order,
+    # @return [Boolean] `true` if the object is both a kind of `name`, and all of
+    #   its contents (if any) are of the types in `types`. Any combination, order,
     #   and count of content types is acceptable.
     def check(obj)
       return false unless KindType.new(name).check(obj)
@@ -246,12 +246,12 @@ module YardTypes
     end
   end
 
-  # A {TupleType} is specified with the syntax +(Some, Types, #here)+, and indicates
+  # A {TupleType} is specified with the syntax `(Some, Types, #here)`, and indicates
   # that the contents of the collection must be exactly that size, and each element
   # must be of the exact type specified for that index.
   #
   # @todo The current implementation of type checking here requires that the collection
-  #   respond to both +length+ and +[]+; this may not be ideal.
+  #   respond to both `length` and `[]`; this may not be ideal.
   class TupleType < CollectionType
     def initialize(name, types)
       @name  = name == '<generic-tuple>' ? nil : name
@@ -272,9 +272,9 @@ module YardTypes
     end
 
     # @param (see Type#check)
-    # @return [Boolean] +true+ if the collection's +length+ is exactly the length of
-    #   the expected +types+, and each element with the collection is of the type
-    #   specified for that index by +types+.
+    # @return [Boolean] `true` if the collection's `length` is exactly the length of
+    #   the expected `types`, and each element with the collection is of the type
+    #   specified for that index by `types`.
     def check(obj)
       return false unless name.nil? || KindType.new(name).check(obj)
       return false unless obj.respond_to?(:length) && obj.respond_to?(:[])
@@ -287,20 +287,20 @@ module YardTypes
     end
   end
 
-  # A {HashType} is specified with the syntax +{KeyType =>
-  # ValueType}+, and indicates that all keys in the hash must be of
-  # type +KeyType+, and all values must be of type +ValueType+.
+  # A {HashType} is specified with the syntax `{KeyType => ValueType}`,
+  # and indicates that all keys in the hash must be of type
+  # `KeyType`, and all values must be of type `ValueType`.
   #
-  # An alternate syntax for {HashType} is also available as +Hash<A,
-  # B>+, but its usage is not recommended; it is less capable than the
-  # +{A => B}+ syntax, as some inner type constraints can not be
+  # An alternate syntax for {HashType} is also available as `Hash<A, B>`,
+  # but its usage is not recommended; it is less capable than the
+  # `{A => B}` syntax, as some inner type constraints can not be
   # parsed reliably.
   #
   # A {HashType} actually only requires that the object respond to
-  # both +keys+ and +values+; it should be capable of type checking
+  # both `keys` and `values`; it should be capable of type checking
   # any object which conforms to that interface.
   #
-  # @todo Enforce kind, eg +HashWithIndifferentAccess{#to_sym => Array}+,
+  # @todo Enforce kind, eg `HashWithIndifferentAccess{#to_sym => Array}`,
   #   in case you _really_ care that it's indifferent. Maybe?
   class HashType < Type
     include OrList
@@ -321,7 +321,7 @@ module YardTypes
     end
 
     # Unlike the other types, {HashType} can result from two alternate syntaxes;
-    # however, this method will *only* return the +{A => B}+ syntax.
+    # however, this method will *only* return the `{A => B}` syntax.
     #
     # @return (see Type#to_s)
     def to_s
@@ -340,9 +340,9 @@ module YardTypes
     end
 
     # @param (see Type#check)
-    # @return [Boolean] +true+ if the object responds to both +keys+ and +values+,
-    #   and every key type checks against a type in +key_types+, and every value
-    #   type checks against a type in +value_types+.
+    # @return [Boolean] `true` if the object responds to both `keys` and `values`,
+    #   and every key type checks against a type in `key_types`, and every value
+    #   type checks against a type in `value_types`.
     def check(obj)
       return false unless obj.respond_to?(:keys) && obj.respond_to?(:values)
       obj.keys.all? { |key| key_types.any? { |t| t.check(key) } } &&

data/lib/yard_types/version.rb

@@ -1,3 +1,3 @@
 module YardTypes
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/spec/type_checking_spec.rb

@@ -4,7 +4,7 @@ require 'set'
 describe YardTypes, 'type checking' do
   matcher :type_check do |obj|
     match do |type|
-      result = YardTypes.validate(type, obj)
+      result = YardTypes.check(type, obj)
       result.success?
     end
 

data/yard_type.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Kyle Hargraves"]
   spec.email         = ["pd@krh.me"]
   spec.summary       = %q{Parse and validate objects against YARD type descriptions.}
-  spec.description   = %q{Your API docs say you return Array<#to_date>, but do you really?}
+  spec.description   = %q{Your API docs say you return an Array of Result objects, but do you really?}
   spec.homepage      = "https://github.com/pd/yard_types"
   spec.license       = "MIT"
 
@@ -24,4 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "simplecov", "~> 0.7.1"
   spec.add_development_dependency "pry", "> 0"
   spec.add_development_dependency "coveralls", "> 0"
+  spec.add_development_dependency "yard", "~> 0.8"
 end

metadata

@@ -1,121 +1,123 @@
 --- !ruby/object:Gem::Specification
 name: yard_types
 version: !ruby/object:Gem::Version
-  version: 0.1.1
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Kyle Hargraves
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-20 00:00:00.000000000 Z
+date: 2014-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.1
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: '0'
-description: Your API docs say you return Array<#to_date>, but do you really?
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Your API docs say you return an Array of Result objects, but do you really?
 email:
 - pd@krh.me
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
+- ".yardopts"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -133,33 +135,26 @@ files:
 homepage: https://github.com/pd/yard_types
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1195132354547834267
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1195132354547834267
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23.2
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Parse and validate objects against YARD type descriptions.
 test_files:
 - spec/errors_spec.rb
@@ -167,3 +162,4 @@ test_files:
 - spec/spec_helper.rb
 - spec/type_checking_spec.rb
 - spec/types_spec.rb
+has_rdoc: