dry-types 0.9.2 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a297bd87145c7fe1400121a10e4a1909c70248a2
-  data.tar.gz: 6de4360daa4b430468a47ab49473536075a4da7d
+  metadata.gz: b5aba3a0d92022b867e134a072196692b4f0d837
+  data.tar.gz: d2a5c7e8b8c489ec5b507a92f92be026e7337d78
 SHA512:
-  metadata.gz: eb09ba97edd602648519073dac33d3cf4044fe28745ae42f384e37ec40ec9649f0a140b76fddbc04adc661fe34512b6cfad6d638cc633231fcb58be72207dd9a
-  data.tar.gz: a73f58d044ed8c05aa820c86350bd3ae08a9ed93d838ef13c7fbb5b726579d9d268371e3d2a5d467b549d905761d9cdb136818c030d57eb2d55b06aab3f7bd11
+  metadata.gz: b5c1a092cf9a157bdcbecc6aec42fa6731ab1e9a9067c81bb7e109a7516393128c0c183ceb4d589258bea87631da55735e38a4b44860f005ea2230b43985e406
+  data.tar.gz: 706d91386ba41582d7eb927237790bf51c0790fc909b248b9a70c851070fb0f49e897e54098f51891fcd5afdd2ee7311fffb6deff7e8b9061b1b6b2135802743

data/.travis.yml

@@ -1,21 +1,25 @@
 language: ruby
-sudo: false
+dist: trusty
+sudo: required
 cache: bundler
 bundler_args: --without benchmarks tools
+after_success:
+  - '[ "$TRAVIS_RUBY_VERSION" = "2.3.1" ] && [ "$TRAVIS_BRANCH" = "master" ] && bundle exec codeclimate-test-reporter'
 script:
   - bundle exec rake
 rvm:
-  - 2.1.10
-  - 2.2.5
-  - 2.3.1
+  - 2.1
+  - 2.2
+  - 2.3
   - jruby-9.1.5.0
-  - rbx-3.60
+  - rbx-3
 env:
   global:
+    - COVERAGE=true
     - JRUBY_OPTS='--dev -J-Xmx1024M'
 matrix:
   allow_failures:
-    - rvm: rbx-3.60
+    - rvm: rbx-3
 notifications:
   email: false
   webhooks:

data/.yardopts

@@ -0,0 +1,5 @@
+--title 'dry-types'
+--markup markdown
+--readme README.md
+--private
+lib/**/*.rb

data/CHANGELOG.md

@@ -1,4 +1,12 @@
-# v0.9.2 to-be-released
+# v0.9.3 2016-12-03
+
+## Fixed
+
+* Updated to dry-core >= 0.2.1 (ruby warnings are gone) (flash-gordon)
+
+[Compare v0.9.2...v0.9.3](https://github.com/dryrb/dry-types/compare/v0.9.2...v0.9.3)
+
+# v0.9.2 2016-11-13
 
 ## Added
 

data/Gemfile

@@ -3,7 +3,10 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  gem "codeclimate-test-reporter", platform: :rbx, require: false
+  platform :mri do
+    gem "codeclimate-test-reporter", require: false
+    gem 'simplecov', require: false
+  end
 end
 
 group :tools do

data/Rakefile

@@ -13,3 +13,7 @@ task :run_specs do
 end
 
 task default: :run_specs
+
+require 'yard'
+require 'yard/rake/yardoc_task'
+YARD::Rake::YardocTask.new(:doc)

data/dry-types.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.1.0"
 
   spec.add_runtime_dependency 'concurrent-ruby', '~> 1.0'
-  spec.add_runtime_dependency 'dry-core', '~> 0.2'
+  spec.add_runtime_dependency 'dry-core', '~> 0.2', '>= 0.2.1'
   spec.add_runtime_dependency 'dry-container', '~> 0.3'
   spec.add_runtime_dependency 'dry-equalizer', '~> 0.2'
   spec.add_runtime_dependency 'dry-configurable', '~> 0.1'
@@ -40,4 +40,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 11.0"
   spec.add_development_dependency "rspec", "~> 3.3"
   spec.add_development_dependency 'dry-monads', '~> 0.2'
+  spec.add_development_dependency 'yard', '~> 0.9.5'
 end

data/lib/dry/types.rb

@@ -8,6 +8,7 @@ require 'concurrent'
 require 'dry-container'
 require 'dry-equalizer'
 require 'dry/core/extensions'
+require 'dry/core/constants'
 
 require 'dry/types/version'
 require 'dry/types/container'
@@ -20,17 +21,22 @@ module Dry
   module Types
     extend Dry::Configurable
     extend Dry::Core::Extensions
+    include Dry::Core::Constants
 
+    # @!attribute [r] namespace
+    #   @return [Container{String => Definition}]
     setting :namespace, self
 
     TYPE_SPEC_REGEX = %r[(.+)<(.+)>].freeze
 
+    # @return [Module]
     def self.module
       namespace = Module.new
       define_constants(namespace, type_keys)
       namespace
     end
 
+    # @deprecated Include {Dry::Types.module} instead
     def self.finalize
       warn 'Dry::Types.finalize and configuring namespace is deprecated. Just'\
        ' do `include Dry::Types.module` in places where you want to have access'\
@@ -39,19 +45,30 @@ module Dry
       define_constants(config.namespace, type_keys)
     end
 
+    # @return [Container{String => Definition}]
     def self.container
       @container ||= Container.new
     end
 
+    # @param [String] name
+    # @param [Definition] type
+    # @param [#call] block
+    # @return [Container{String => Definition}]
     def self.register(name, type = nil, &block)
       container.register(name, type || block.call)
     end
 
+    # Registers given +klass+ in {#container} using +meth+ constructor
+    # @param [Class] klass
+    # @param [Symbol] meth
+    # @return [Container{String => Definition}]
     def self.register_class(klass, meth = :new)
       type = Definition.new(klass).constructor(klass.method(meth))
       container.register(identifier(klass), type)
     end
 
+    # @param [String] name
+    # @return [Definition]
     def self.[](name)
       type_map.fetch_or_store(name) do
         case name
@@ -76,6 +93,9 @@ module Dry
       end
     end
 
+    # @param [Container{String => Definition}] namespace
+    # @param [<String>] identifiers
+    # @return [<Definition>]
     def self.define_constants(namespace, identifiers)
       names = identifiers.map do |id|
         parts = id.split('.')
@@ -91,14 +111,19 @@ module Dry
       end
     end
 
+    # @param [#to_s] klass
+    # @return [String]
     def self.identifier(klass)
       Inflecto.underscore(klass).tr('/', '.')
     end
 
+    # @return [Concurrent::Map]
     def self.type_map
       @type_map ||= Concurrent::Map.new
     end
 
+    # List of type keys defined in {Dry::Types.container}
+    # @return [<String>]
     def self.type_keys
       container._container.keys
     end

data/lib/dry/types/array.rb

@@ -3,6 +3,8 @@ require 'dry/types/array/member'
 module Dry
   module Types
     class Array < Definition
+      # @param [Definition] type
+      # @return [Array::Member]
       def member(type)
         member =
           case type

data/lib/dry/types/array/member.rb

@@ -2,22 +2,36 @@ module Dry
   module Types
     class Array < Definition
       class Member < Array
+        # @return [Definition]
         attr_reader :member
 
+        # @param [Class] primitive
+        # @param [Hash] options
+        # @option options [Definition] :member
         def initialize(primitive, options = {})
           @member = options.fetch(:member)
           super
         end
 
+        # @param [Object] input
+        # @param [Symbol] meth
+        # @return [Array]
         def call(input, meth = :call)
           input.map { |el| member.__send__(meth, el) }
         end
         alias_method :[], :call
 
-        def valid?(type)
-          super && type.all? { |el| member.valid?(el) }
+        # @param [Array, #all?] value
+        # @return [Boolean]
+        def valid?(value)
+          super && value.all? { |el| member.valid?(el) }
         end
 
+        # @param [Array, Object] input
+        # @param [#call] block
+        # @yieldparam [Failure] failure
+        # @yieldreturn [Result]
+        # @return [Result]
         def try(input, &block)
           if input.is_a?(::Array)
             result = call(input, :try)

data/lib/dry/types/builder.rb

@@ -1,27 +1,35 @@
-require 'dry/core/constants'
-
 module Dry
   module Types
     module Builder
       include Dry::Core::Constants
 
+      # @return [Constrained]
       def constrained_type
         Constrained
       end
 
+      # @param [Definition] other
+      # @return [Sum, Sum::Constrained]
       def |(other)
         klass = constrained? && other.constrained? ? Sum::Constrained : Sum
         klass.new(self, other)
       end
 
+      # @return [Sum]
       def optional
         Types['strict.nil'] | self
       end
 
+      # @param [Hash] options constraining rule (see {Types.Rule})
+      # @return [Constrained]
       def constrained(options)
         constrained_type.new(self, rule: Types.Rule(options))
       end
 
+      # @param [Object] input
+      # @param [#call] block
+      # @raise [ConstraintError]
+      # @return [Default]
       def default(input = Undefined, &block)
         value = input == Undefined ? block : input
 
@@ -32,14 +40,21 @@ module Dry
         end
       end
 
+      # @param [Array] values
+      # @return [Enum]
       def enum(*values)
         Enum.new(constrained(included_in: values), values: values)
       end
 
+      # @return [Safe]
       def safe
         Safe.new(self)
       end
 
+      # @param [#call] constructor
+      # @param [Hash] options
+      # @param [#call] block
+      # @return [Constructor]
       def constructor(constructor = nil, **options, &block)
         Constructor.new(with(options), fn: constructor || block)
       end

data/lib/dry/types/coercions.rb

@@ -1,14 +1,17 @@
-require 'dry/core/constants'
-
 module Dry
   module Types
     module Coercions
       include Dry::Core::Constants
 
+      # @param [String] input
+      # @return [String?]
       def to_nil(input)
         input unless empty_str?(input)
       end
 
+      # @param [#to_str, Object] input
+      # @return [Date, Object]
+      # @see Date.parse
       def to_date(input)
         return input unless input.respond_to?(:to_str)
         Date.parse(input)
@@ -16,6 +19,9 @@ module Dry
         input
       end
 
+      # @param [#to_str, Object] input
+      # @return [DateTime, Object]
+      # @see DateTime.parse
       def to_date_time(input)
         return input unless input.respond_to?(:to_str)
         DateTime.parse(input)
@@ -23,6 +29,9 @@ module Dry
         input
       end
 
+      # @param [#to_str, Object] input
+      # @return [Time, Object]
+      # @see Time.parse
       def to_time(input)
         return input unless input.respond_to?(:to_str)
         Time.parse(input)
@@ -32,6 +41,9 @@ module Dry
 
       private
 
+      # Checks whether String is empty
+      # @param [String, Object] value
+      # @return [Boolean]
       def empty_str?(value)
         EMPTY_STRING.eql?(value)
       end

data/lib/dry/types/coercions/form.rb

@@ -11,14 +11,24 @@ module Dry
 
         extend Coercions
 
+        # @param [String, Object] input
+        # @return [Boolean?]
+        # @see TRUE_VALUES
+        # @see FALSE_VALUES
         def self.to_true(input)
           BOOLEAN_MAP.fetch(input.to_s, input)
         end
 
+        # @param [String, Object] input
+        # @return [Boolean?]
+        # @see TRUE_VALUES
+        # @see FALSE_VALUES
         def self.to_false(input)
           BOOLEAN_MAP.fetch(input.to_s, input)
         end
 
+        # @param [#to_int, #to_i, Object] input
+        # @return [Integer?, Object]
         def self.to_int(input)
           if empty_str?(input)
             nil
@@ -29,6 +39,8 @@ module Dry
           input
         end
 
+        # @param [#to_f, Object] input
+        # @return [Float?, Object]
         def self.to_float(input)
           if empty_str?(input)
             nil
@@ -39,6 +51,8 @@ module Dry
           input
         end
 
+        # @param [#to_d, Object] input
+        # @return [BigDecimal?, Object]
         def self.to_decimal(input)
           result = to_float(input)
 
@@ -49,10 +63,14 @@ module Dry
           end
         end
 
+        # @param [Array, '', Object] input
+        # @return [Array, Object]
         def self.to_ary(input)
           empty_str?(input) ? [] : input
         end
 
+        # @param [Hash, '', Object] input
+        # @return [Hash]
         def self.to_hash(input)
           empty_str?(input) ? {} : input
         end

data/lib/dry/types/coercions/json.rb

@@ -9,6 +9,8 @@ module Dry
       module JSON
         extend Coercions
 
+        # @param [#to_d, Object] input
+        # @return [BigDecimal?]
         def self.to_decimal(input)
           input.to_d unless empty_str?(input)
         end

data/lib/dry/types/constrained.rb

@@ -9,13 +9,19 @@ module Dry
       include Decorator
       include Builder
 
+      # @return [Dry::Logic::Rule]
       attr_reader :rule
 
+      # @param [Definition] type
+      # @param [Hash] options
       def initialize(type, options)
         super
         @rule = options.fetch(:rule)
       end
 
+      # @param [Object] input
+      # @return [Object]
+      # @raise [ConstraintError]
       def call(input)
         try(input) do |result|
           raise ConstraintError.new(result, input)
@@ -23,6 +29,11 @@ module Dry
       end
       alias_method :[], :call
 
+      # @param [Object] input
+      # @param [#call] block
+      # @yieldparam [Failure] failure
+      # @yieldreturn [Result]
+      # @return [Result]
       def try(input, &block)
         result = rule.(input)
 
@@ -34,20 +45,30 @@ module Dry
         end
       end
 
+      # @param [Object] value
+      # @return [Boolean]
       def valid?(value)
         rule.(value).success? && type.valid?(value)
       end
 
+      # @param [Hash] options
+      #   The options hash provided to {Types.Rule} and combined
+      #   using {&} with previous {#rule}
+      # @return [Constrained]
+      # @see Dry::Logic::Operators#and
       def constrained(options)
         with(rule: rule & Types.Rule(options))
       end
 
+      # @return [true]
       def constrained?
         true
       end
 
       private
 
+      # @param [Object] response
+      # @return [Boolean]
       def decorate?(response)
         super || response.kind_of?(Constructor)
       end