dry-struct 1.0.0 → 1.6.0

data/lib/dry/struct/struct_builder.rb

@@ -1,28 +1,41 @@
-require 'dry/types/compiler'
+# frozen_string_literal: true
 
 module Dry
   class Struct
     # @private
-    class StructBuilder < Dry::Types::Compiler
+    class StructBuilder < Compiler
       attr_reader :struct
 
       def initialize(struct)
-        super(Dry::Types)
+        super(Types)
         @struct = struct
       end
 
       # @param [Symbol|String] attr_name the name of the nested type
-      # @param [Dry::Struct,Dry::Types::Type::Array] type the superclass of the nested struct
+      # @param [Dry::Struct,Dry::Types::Type::Array,Undefined] type the superclass
+      #                                                        of the nested struct
       # @yield the body of the nested struct
       def call(attr_name, type, &block)
         const_name = const_name(type, attr_name)
         check_name(const_name)
 
-        new_type = Class.new(parent(type), &block)
+        builder = self
+        parent = parent(type)
+
+        new_type = ::Class.new(Undefined.default(parent, struct.abstract_class)) do
+          if Undefined.equal?(parent)
+            schema builder.struct.schema.clear
+          end
+
+          class_exec(&block)
+        end
+
         struct.const_set(const_name, new_type)
 
         if array?(type)
           type.of(new_type)
+        elsif optional?(type)
+          new_type.optional
         else
           new_type
         end
@@ -30,37 +43,46 @@ module Dry
 
       private
 
+      def type?(type)
+        type.is_a?(Types::Type)
+      end
+
       def array?(type)
-        type.is_a?(Types::Type) && type.primitive.equal?(Array)
+        type?(type) && !type.optional? && type.primitive.equal?(::Array)
+      end
+
+      def optional?(type)
+        type?(type) && type.optional?
       end
 
       def parent(type)
         if array?(type)
           visit(type.to_ast)
+        elsif optional?(type)
+          type.right
         else
-          type || default_superclass
+          type
         end
       end
 
-      def default_superclass
-        struct < Value ? Value : Struct
-      end
-
       def const_name(type, attr_name)
-        snake_name = if array?(type)
-                       Dry::Core::Inflector.singularize(attr_name)
-                     else
-                       attr_name
-                     end
-
-        Dry::Core::Inflector.camelize(snake_name)
+        snake_name =
+          if array?(type)
+            Core::Inflector.singularize(attr_name)
+          else
+            attr_name
+          end
+
+        Core::Inflector.camelize(snake_name)
       end
 
       def check_name(name)
-        raise(
-          Struct::Error,
-          "Can't create nested attribute - `#{struct}::#{name}` already defined"
-        ) if struct.const_defined?(name, false)
+        if struct.const_defined?(name, false)
+          raise(
+            Error,
+            "Can't create nested attribute - `#{struct}::#{name}` already defined"
+          )
+        end
       end
 
       def visit_constrained(node)
@@ -70,11 +92,11 @@ module Dry
 
       def visit_array(node)
         member, * = node
-        member
+        visit(member)
       end
 
       def visit_nominal(*)
-        default_superclass
+        Undefined
       end
 
       def visit_constructor(node)

data/lib/dry/struct/sum.rb

@@ -1,5 +1,4 @@
-require 'dry/types/sum'
-require 'dry/types/printer'
+# frozen_string_literal: true
 
 module Dry
   class Struct
@@ -12,9 +11,10 @@ module Dry
           right.try_struct(input) { super }
         end
       end
+
       # @param [Hash{Symbol => Object},Dry::Struct] input
       # @yieldparam [Dry::Types::Result::Failure] failure
-      # @yieldreturn [Dry::Types::ResultResult]
+      # @yieldreturn [Dry::Types::Result]
       # @return [Dry::Types::Result]
       def try(input)
         if input.is_a?(Struct)
@@ -43,9 +43,9 @@ module Dry
       protected
 
       # @private
-      def try_struct(input)
+      def try_struct(input, &block)
         left.try_struct(input) do
-          right.try_struct(input) { yield }
+          right.try_struct(input, &block)
         end
       end
     end

data/lib/dry/struct/value.rb

@@ -1,14 +1,18 @@
-require 'ice_nine'
+# frozen_string_literal: true
+
+require "ice_nine"
 
 module Dry
   class Struct
+    extend Core::Deprecations[:"dry-struct"]
+
     # {Value} objects behave like {Struct}s but *deeply frozen*
     # using [`ice_nine`](https://github.com/dkubb/ice_nine)
     #
     # @example
     #   class Location < Dry::Struct::Value
-    #     attribute :lat, Types::Strict::Float
-    #     attribute :lng, Types::Strict::Float
+    #     attribute :lat, Types::Float
+    #     attribute :lng, Types::Float
     #   end
     #
     #   loc1 = Location.new(lat: 1.23, lng: 4.56)
@@ -20,12 +24,16 @@ module Dry
     #
     # @see https://github.com/dkubb/ice_nine
     class Value < self
+      abstract
+
       # @param (see ClassInterface#new)
       # @return [Value]
       # @see https://github.com/dkubb/ice_nine
       def self.new(*)
-        IceNine.deep_freeze(super)
+        ::IceNine.deep_freeze(super)
       end
     end
+
+    deprecate_constant :Value
   end
 end

data/lib/dry/struct/version.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module Dry
   class Struct
     # @private
-    VERSION = '1.0.0'.freeze
+    VERSION = "1.6.0"
   end
 end

data/lib/dry/struct.rb

@@ -1,13 +1,13 @@
-require 'dry-types'
-require 'dry-equalizer'
-require 'dry/core/extensions'
-require 'dry/core/constants'
+# frozen_string_literal: true
 
-require 'dry/struct/version'
-require 'dry/struct/errors'
-require 'dry/struct/class_interface'
-require 'dry/struct/hashify'
-require 'dry/struct/struct_builder'
+require "weakref"
+
+require "dry/core"
+require "dry/types"
+
+require "dry/struct/class_interface"
+require "dry/struct/errors"
+require "dry/struct/version"
 
 module Dry
   # Constructor method for easily creating a {Dry::Struct}.
@@ -16,21 +16,21 @@ module Dry
   #   require 'dry-struct'
   #
   #   module Types
-  #     include Dry.Types
+  #     include Dry.Types()
   #   end
   #
-  #   Person = Dry.Struct(name: Types::Strict::String, age: Types::Strict::Int)
+  #   Person = Dry.Struct(name: Types::String, age: Types::Integer)
   #   matz = Person.new(name: "Matz", age: 52)
   #   matz.name #=> "Matz"
   #   matz.age #=> 52
   #
-  #   Test = Dry.Struct(expected: Types::Strict::String) { input(input.strict) }
+  #   Test = Dry.Struct(expected: Types::String) { schema(schema.strict) }
   #   Test[expected: "foo", unexpected: "bar"]
   #   #=> Dry::Struct::Error: [Test.new] unexpected keys [:unexpected] in Hash input
   def self.Struct(attributes = Dry::Core::Constants::EMPTY_HASH, &block)
     Class.new(Dry::Struct) do
       attributes.each { |a, type| attribute a, type }
-      instance_eval(&block) if block
+      module_eval(&block) if block
     end
   end
 
@@ -60,7 +60,7 @@ module Dry
   #   require 'dry-struct'
   #
   #   module Types
-  #     include Dry.Types
+  #     include Dry.Types()
   #   end
   #
   #   class Book < Dry::Struct
@@ -82,18 +82,41 @@ module Dry
   #   refactoring.title #=> 'Refactoring'
   #   refactoring.subtitle #=> 'Improving the Design of Existing Code'
   class Struct
-    extend Dry::Core::Extensions
-    include Dry::Core::Constants
+    extend Core::Extensions
+    include Core::Constants
     extend ClassInterface
+    extend Core::Deprecations[:"dry-struct"]
+
+    class << self
+      # override `Dry::Types::Builder#prepend`
+      define_method(:prepend, ::Module.method(:prepend))
+
+      def loader
+        @loader ||= ::Zeitwerk::Loader.new.tap do |loader|
+          root = ::File.expand_path("..", __dir__)
+          loader.tag = "dry-struct"
+          loader.inflector = ::Zeitwerk::GemInflector.new("#{root}/dry-struct.rb")
+          loader.push_dir(root)
+          loader.ignore(
+            "#{root}/dry-struct.rb",
+            "#{root}/dry/struct/{class_interface,errors,extensions,printer,value,version}.rb",
+            "#{root}/dry/struct/extensions"
+          )
+        end
+      end
+    end
+
+    loader.setup
 
-    include Dry::Equalizer(:__attributes__)
+    include ::Dry::Equalizer(:__attributes__, inspect: false, immutable: true)
 
     # {Dry::Types::Hash::Schema} subclass with specific behaviour defined for
     # @return [Dry::Types::Hash::Schema]
     defines :schema
-    schema Types['coercible.hash'].schema(EMPTY_HASH)
+    schema Types["coercible.hash"].schema(EMPTY_HASH)
 
-    @meta = EMPTY_HASH
+    defines :abstract_class
+    abstract
 
     # @!attribute [Hash{Symbol => Object}] attributes
     attr_reader :attributes
@@ -111,8 +134,8 @@ module Dry
     #
     # @example
     #   class Book < Dry::Struct
-    #     attribute :title, Types::Strict::String
-    #     attribute :subtitle, Types::Strict::String.optional
+    #     attribute :title, Types::String
+    #     attribute :subtitle, Types::String.optional
     #   end
     #
     #   rom_n_roda = Book.new(
@@ -122,7 +145,7 @@ module Dry
     #   rom_n_roda[:title] #=> 'Web Development with ROM and Roda'
     #   rom_n_roda[:subtitle] #=> nil
     def [](name)
-      @attributes.fetch(name) { raise MissingAttributeError.new(name) }
+      @attributes.fetch(name) { raise MissingAttributeError, name }
     end
 
     # Converts the {Dry::Struct} to a hash with keys representing
@@ -132,8 +155,8 @@ module Dry
     #
     # @example
     #   class Book < Dry::Struct
-    #     attribute :title, Types::Strict::String
-    #     attribute :subtitle, Types::Strict::String.optional
+    #     attribute :title, Types::String
+    #     attribute :subtitle, Types::String.optional
     #   end
     #
     #   rom_n_roda = Book.new(
@@ -142,12 +165,13 @@ module Dry
     #   )
     #   rom_n_roda.to_hash
     #     #=> {title: 'Web Development with ROM and Roda', subtitle: nil}
-    def to_hash
+    def to_h
       self.class.schema.each_with_object({}) do |key, result|
         result[key.name] = Hashify[self[key.name]] if attributes.key?(key.name)
       end
     end
-    alias_method :to_h, :to_hash
+    # TODO: remove in 2.0
+    alias_method :to_hash, :to_h
 
     # Create a copy of {Dry::Struct} with overriden attributes
     #
@@ -157,8 +181,8 @@ module Dry
     #
     # @example
     #   class Book < Dry::Struct
-    #     attribute :title, Types::Strict::String
-    #     attribute :subtitle, Types::Strict::String.optional
+    #     attribute :title, Types::String
+    #     attribute :subtitle, Types::String.optional
     #   end
     #
     #   rom_n_roda = Book.new(
@@ -170,10 +194,14 @@ module Dry
     #   rom_n_roda.new(subtitle: '3rd edition')
     #     #=> #<Book title="Web Development with ROM and Roda" subtitle="3rd edition">
     def new(changeset)
-      new_attributes = self.class.schema.apply(changeset, skip_missing: true, resolve_defaults: false)
+      new_attributes = self.class.schema.apply(
+        changeset,
+        skip_missing: true,
+        resolve_defaults: false
+      )
       self.class.load(__attributes__.merge(new_attributes))
-    rescue Types::SchemaError, Types::MissingKeyError, Types::UnknownKeysError => error
-      raise Struct::Error, "[#{self}.new] #{error}"
+    rescue Types::SchemaError, Types::MissingKeyError, Types::UnknownKeysError => e
+      raise Error, "[#{self}.new] #{e}"
     end
     alias_method :__new__, :new
 
@@ -181,11 +209,18 @@ module Dry
     def inspect
       klass = self.class
       attrs = klass.attribute_names.map { |key| " #{key}=#{@attributes[key].inspect}" }.join
-      "#<#{ klass.name || klass.inspect }#{ attrs }>"
+      "#<#{klass.name || klass.inspect}#{attrs}>"
+    end
+
+    # Pattern matching support
+    #
+    # @api private
+    def deconstruct_keys(_keys)
+      attributes
     end
   end
 end
 
-require 'dry/struct/value'
-require 'dry/struct/extensions'
-require 'dry/struct/printer'
+require "dry/struct/extensions"
+require "dry/struct/printer"
+require "dry/struct/value"

data/lib/dry-struct.rb

@@ -1 +1,3 @@
-require 'dry/struct'
+# frozen_string_literal: true
+
+require "dry/struct"

metadata

@@ -1,77 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: dry-struct
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2019-04-23 00:00:00.000000000 Z
+date: 2022-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: dry-equalizer
+  name: dry-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: dry-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
-  name: dry-core
+  name: ice_nine
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.4.3
+        version: '0.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.4.3
+        version: '0.11'
 - !ruby/object:Gem::Dependency
-  name: ice_nine
+  name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '2.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -90,71 +96,59 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.5
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.5
-description: Typed structs and value objects.
+        version: '0'
+description: Typed structs and value objects
 email:
 - piotr.solnica@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- ".yardopts"
 - CHANGELOG.md
-- CONTRIBUTING.md
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
-- benchmarks/basic.rb
-- benchmarks/constrained.rb
-- benchmarks/profile_instantiation.rb
-- benchmarks/setup.rb
-- bin/console
-- bin/setup
 - dry-struct.gemspec
 - lib/dry-struct.rb
 - lib/dry/struct.rb
 - lib/dry/struct/class_interface.rb
+- lib/dry/struct/compiler.rb
 - lib/dry/struct/constructor.rb
 - lib/dry/struct/errors.rb
 - lib/dry/struct/extensions.rb
@@ -165,14 +159,14 @@ files:
 - lib/dry/struct/sum.rb
 - lib/dry/struct/value.rb
 - lib/dry/struct/version.rb
-- log/.gitkeep
-homepage: https://github.com/dry-rb/dry-struct
+homepage: https://dry-rb.org/gems/dry-struct
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  changelog_uri: https://github.com/dry-rb/dry-struct/blob/master/CHANGELOG.md
+  changelog_uri: https://github.com/dry-rb/dry-struct/blob/main/CHANGELOG.md
   source_code_uri: https://github.com/dry-rb/dry-struct
+  bug_tracker_uri: https://github.com/dry-rb/dry-struct/issues
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -181,15 +175,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
-summary: Typed structs and value objects.
+summary: Typed structs and value objects
 test_files: []

data/.gitignore

@@ -1,12 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.log
-
-.DS_Store

data/.rspec

@@ -1,2 +0,0 @@
---color
---require ./spec/spec_helper

data/.travis.yml

@@ -1,29 +0,0 @@
-language: ruby
-dist: trusty
-sudo: required
-bundler_args: --without benchmarks tools
-script:
-  - bundle exec rake spec
-after_success:
-  - '[ -d coverage ] && bundle exec codeclimate-test-reporter'
-rvm:
-  - 2.4.5
-  - 2.5.5
-  - 2.6.3
-  - jruby-9.2.7.0
-  - truffleruby
-env:
-  global:
-    - COVERAGE=true
-    - JRUBY_OPTS='--dev -J-Xmx1024M'
-matrix:
-  allow_failures:
-    - rvm: truffleruby
-notifications:
-  email: false
-  webhooks:
-    urls:
-      - https://webhooks.gitter.im/e/19098b4253a72c9796db
-    on_success: change  # options: [always|never|change] default: always
-    on_failure: always  # options: [always|never|change] default: always
-    on_start: false     # default: false