dry-types 0.9.0 → 0.15.0

data/lib/dry/types/sum.rb

@@ -3,74 +3,136 @@ require 'dry/types/options'
 module Dry
   module Types
     class Sum
-      include Dry::Equalizer(:left, :right, :options)
+      include Type
       include Builder
       include Options
+      include Printable
+      include Dry::Equalizer(:left, :right, :options, :meta, inspect: false)
 
+      # @return [Type]
       attr_reader :left
 
+      # @return [Type]
       attr_reader :right
 
       class Constrained < Sum
+        # @return [Dry::Logic::Operations::Or]
         def rule
           left.rule | right.rule
         end
 
+        # @return [true]
         def constrained?
           true
         end
+
+        # @param [Object] input
+        # @return [Object]
+        # @raise [ConstraintError] if given +input+ not passing {#try}
+        def call(input)
+          try(input) { |result|
+            raise ConstraintError.new(result, input)
+          }.input
+        end
+        alias_method :[], :call
       end
 
+      # @param [Type] left
+      # @param [Type] right
+      # @param [Hash] options
       def initialize(left, right, options = {})
         super
         @left, @right = left, right
         freeze
       end
 
+      # @return [String]
       def name
         [left, right].map(&:name).join(' | ')
       end
 
+      # @return [false]
       def default?
         false
       end
 
-      def maybe?
+      # @return [false]
+      def constrained?
         false
       end
 
-      def constrained?
-        false
+      # @return [Boolean]
+      def optional?
+        primitive?(nil)
       end
 
+      # @param [Object] input
+      # @return [Object]
       def call(input)
-        try(input) do |result|
-          raise ConstraintError.new(result, input)
-        end.input
+        try(input).input
       end
       alias_method :[], :call
 
       def try(input, &block)
-        result = left.try(input) do
-          right.try(input)
+        left.try(input) do
+          right.try(input) do |failure|
+            if block_given?
+              yield(failure)
+            else
+              failure
+            end
+          end
         end
+      end
 
-        return result if result.success?
+      def success(input)
+        if left.valid?(input)
+          left.success(input)
+        elsif right.valid?(input)
+          right.success(input)
+        else
+          raise ArgumentError, "Invalid success value '#{input}' for #{inspect}"
+        end
+      end
 
-        if block
-          yield(result)
+      def failure(input, _error = nil)
+        if !left.valid?(input)
+          left.failure(input, left.try(input).error)
         else
-          result
+          right.failure(input, right.try(input).error)
         end
       end
 
+      # @param [Object] value
+      # @return [Boolean]
       def primitive?(value)
         left.primitive?(value) || right.primitive?(value)
       end
 
+      # @param [Object] value
+      # @return [Boolean]
       def valid?(value)
         left.valid?(value) || right.valid?(value)
       end
+      alias_method :===, :valid?
+
+      # @api public
+      #
+      # @see Nominal#to_ast
+      def to_ast(meta: true)
+        [:sum, [left.to_ast(meta: meta), right.to_ast(meta: meta), meta ? self.meta : EMPTY_HASH]]
+      end
+
+      # @param [Hash] options
+      # @return [Constrained,Sum]
+      # @see Builder#constrained
+      def constrained(options)
+        if optional?
+          right.constrained(options).optional
+        else
+          super
+        end
+      end
     end
   end
 end

data/lib/dry/types/type.rb

@@ -0,0 +1,6 @@
+module Dry
+  module Types
+    module Type
+    end
+  end
+end

data/lib/dry/types/version.rb

@@ -1,5 +1,5 @@
 module Dry
   module Types
-    VERSION = '0.9.0'.freeze
+    VERSION = '0.15.0'.freeze
   end
 end

data/lib/dry/types.rb

@@ -2,56 +2,68 @@ require 'bigdecimal'
 require 'date'
 require 'set'
 
-require 'inflecto'
 require 'concurrent'
 
 require 'dry-container'
 require 'dry-equalizer'
 require 'dry/core/extensions'
+require 'dry/core/constants'
+require 'dry/core/class_attributes'
 
 require 'dry/types/version'
 require 'dry/types/container'
-require 'dry/types/definition'
+require 'dry/types/inflector'
+require 'dry/types/type'
+require 'dry/types/printable'
+require 'dry/types/nominal'
 require 'dry/types/constructor'
+require 'dry/types/module'
 
 require 'dry/types/errors'
 
 module Dry
   module Types
-    extend Dry::Configurable
     extend Dry::Core::Extensions
-
-    setting :namespace, self
+    extend Dry::Core::ClassAttributes
+    extend Dry::Core::Deprecations[:'dry-types']
+    include Dry::Core::Constants
 
     TYPE_SPEC_REGEX = %r[(.+)<(.+)>].freeze
 
-    def self.module
-      namespace = Module.new
-      define_constants(namespace, type_keys)
-      namespace
+    # @see Dry.Types
+    def self.module(*namespaces, default: :nominal, **aliases)
+      Module.new(container, *namespaces, default: default, **aliases)
     end
+    deprecate_class_method :module, message: <<~DEPRECATION
+      Use Dry.Types() instead. Beware, it exports strict types by default, for old behavior use Dry.Types(default: :nominal). See more options in the changelog
+    DEPRECATION
 
-    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'\
-       ' to built-in types'
-
-      define_constants(config.namespace, type_keys)
+    # @api private
+    def self.included(*)
+      raise RuntimeError, "Import Dry.Types, not Dry::Types"
     end
 
+    # @return [Container{String => Nominal}]
     def self.container
       @container ||= Container.new
     end
 
-    def self.register(name, type = nil, &block)
-      container.register(name, type || block.call)
+    # @api private
+    def self.registered?(class_or_identifier)
+      container.key?(identifier(class_or_identifier))
     end
 
-    def self.register_class(klass, meth = :new)
-      type = Definition.new(klass).constructor(klass.method(meth))
-      container.register(identifier(klass), type)
+    # @param [String] name
+    # @param [Type] type
+    # @param [#call,nil] block
+    # @return [Container{String => Nominal}]
+    # @api private
+    def self.register(name, type = nil, &block)
+      container.register(name, type || block.call)
     end
 
+    # @param [String,Class] name
+    # @return [Type,Class]
     def self.[](name)
       type_map.fetch_or_store(name) do
         case name
@@ -60,7 +72,7 @@ module Dry
 
           if result
             type_id, member_id = result[1..2]
-            container[type_id].member(self[member_id])
+            container[type_id].of(self[member_id])
           else
             container[name]
           end
@@ -76,34 +88,88 @@ module Dry
       end
     end
 
-    def self.define_constants(namespace, identifiers)
-      names = identifiers.map do |id|
-        parts = id.split('.')
-        [Inflecto.camelize(parts.pop), parts.map(&Inflecto.method(:camelize))]
-      end
-
-      names.map do |(klass, parts)|
-        mod = parts.reduce(namespace) do |a, e|
-          a.constants.include?(e.to_sym) ? a.const_get(e) : a.const_set(e, Module.new)
-        end
-
-        mod.const_set(klass, self[identifier((parts + [klass]).join('::'))])
-      end
-    end
-
+    # @param [#to_s] klass
+    # @return [String]
     def self.identifier(klass)
-      Inflecto.underscore(klass).tr('/', '.')
+      Inflector.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
+      container.keys
     end
+
+    # @api private
+    def self.const_missing(const)
+      underscored = Inflector.underscore(const)
+
+      if container.keys.any? { |key| key.split('.')[0] == underscored }
+        raise NameError,
+              'dry-types does not define constants for default types. '\
+              'You can access the predefined types with [], e.g. Dry::Types["strict.integer"] '\
+              'or generate a module with types using Dry::Types.module'
+      else
+        super
+      end
+    end
+  end
+
+  # Export registered types as a module with constants
+  #
+  # @example no options
+  #
+  #   module Types
+  #     # imports all types as constants, uses modules for namespaces
+  #     include Dry::Types.module
+  #   end
+  #   # nominal types are exported by default
+  #   Types::Integer
+  #   # => #<Dry::Types[Nominal<Integer>]>
+  #   Types::Strict::Integer
+  #   # => #<Dry::Types[Constrained<Nominal<Integer> rule=[type?(Integer)]>]>
+  #
+  # @example changing default types
+  #
+  #   module Types
+  #     include Dry::Types(default: :strict)
+  #   end
+  #   Types::Integer
+  #   # => #<Dry::Types[Constrained<Nominal<Integer> rule=[type?(Integer)]>]>
+  #
+  # @example cherry-picking namespaces
+  #
+  #   module Types
+  #     include Dry::Types.module(:strict, :coercible)
+  #   end
+  #   # cherry-picking discards default types,
+  #   # provide the :default option along with the list of
+  #   # namespaces if you want the to be exported
+  #   Types.constants # => [:Coercible, :Strict]
+  #
+  # @example custom names
+  #   module Types
+  #     include Dry::Types.module(coercible: :Kernel)
+  #   end
+  #   Types::Kernel::Integer
+  #   # => #<Dry::Types[Constructor<Nominal<Integer> fn=Kernel.Integer>]>
+  #
+  # @param [Array<Symbol>] namespaces List of type namespaces to export
+  # @param [Symbol] default Default namespace to export
+  # @param [Hash{Symbol => Symbol}] aliases Optional renamings, like strict: :Draconian
+  # @return [Dry::Types::Module]
+  #
+  # @see Dry::types::Module
+  def self.Types(*namespaces, default: Types::Undefined, **aliases)
+    Types::Module.new(Types.container, *namespaces, default: default, **aliases)
   end
 end
 
 require 'dry/types/core' # load built-in types
 require 'dry/types/extensions'
+require 'dry/types/printer'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-types
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-21 00:00:00.000000000 Z
+date: 2019-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -30,110 +30,108 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-- !ruby/object:Gem::Dependency
-  name: dry-container
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+        version: '0.4'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 0.4.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.4
 - !ruby/object:Gem::Dependency
-  name: dry-equalizer
+  name: dry-inflector
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
-  name: dry-configurable
+  name: dry-container
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
-  name: dry-logic
+  name: dry-equalizer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.2.2
 - !ruby/object:Gem::Dependency
-  name: inflecto
+  name: dry-logic
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: '0.5'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: '0.5'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -176,6 +174,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.5
 description: Type system for Ruby supporting coercions, constraints and complex types
   like structs, value objects, enums etc.
 email:
@@ -184,10 +196,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
+- ".yardopts"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md
@@ -196,12 +212,15 @@ files:
 - dry-types.gemspec
 - lib/dry-types.rb
 - lib/dry/types.rb
+- lib/dry/types/any.rb
 - lib/dry/types/array.rb
 - lib/dry/types/array/member.rb
 - lib/dry/types/builder.rb
+- lib/dry/types/builder_methods.rb
 - lib/dry/types/coercions.rb
-- lib/dry/types/coercions/form.rb
 - lib/dry/types/coercions/json.rb
+- lib/dry/types/coercions/params.rb
+- lib/dry/types/compat.rb
 - lib/dry/types/compiler.rb
 - lib/dry/types/constrained.rb
 - lib/dry/types/constrained/coercible.rb
@@ -211,26 +230,39 @@ files:
 - lib/dry/types/core.rb
 - lib/dry/types/decorator.rb
 - lib/dry/types/default.rb
-- lib/dry/types/definition.rb
 - lib/dry/types/enum.rb
 - lib/dry/types/errors.rb
 - lib/dry/types/extensions.rb
 - lib/dry/types/extensions/maybe.rb
-- lib/dry/types/form.rb
+- lib/dry/types/fn_container.rb
 - lib/dry/types/hash.rb
-- lib/dry/types/hash/schema.rb
+- lib/dry/types/hash/constructor.rb
+- lib/dry/types/inflector.rb
 - lib/dry/types/json.rb
+- lib/dry/types/map.rb
+- lib/dry/types/module.rb
+- lib/dry/types/nominal.rb
 - lib/dry/types/options.rb
+- lib/dry/types/params.rb
+- lib/dry/types/printable.rb
+- lib/dry/types/printer.rb
 - lib/dry/types/result.rb
 - lib/dry/types/safe.rb
+- lib/dry/types/schema.rb
+- lib/dry/types/schema/key.rb
+- lib/dry/types/spec/types.rb
 - lib/dry/types/sum.rb
+- lib/dry/types/type.rb
 - lib/dry/types/version.rb
-- lib/spec/dry/types.rb
-homepage: https://github.com/dryrb/dry-types
+- log/.gitkeep
+homepage: https://github.com/dry-rb/dry-types
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
+  changelog_uri: https://github.com/dry-rb/dry-types/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/dry-rb/dry-types
+  bug_tracker_uri: https://github.com/dry-rb/dry-types/issues
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -239,15 +271,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Type system for Ruby supporting coercions, constraints and complex types