dry-struct 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61dba90344018c1b2a9cbb58de0a235438958fbbdd5ed3c3effcd075eeae9055
-  data.tar.gz: dd79a872121c6fd07c2cc3635651e11e5073f50b29dca40e041d2bd9ba614458
+  metadata.gz: 33cd05dd51a3310d7ede685ae1ce8631a0955d7563afca7633a7625b9b34dd17
+  data.tar.gz: 182c58865ccb3e74595aa22d6c9730ce8ca0e078d1b6ecb5e8b69e026ce6409d
 SHA512:
-  metadata.gz: ee05a93c33c0dfe02b373cb57cb06fee2c1740c80260ef977ebbf9b182279229705a693c59044e449064472b8f980d9141424575495330bd09b263f6ab47c12b
-  data.tar.gz: 5391764853bbdf1effb65dbc83b7c17c9142fd2b29c877c5eb280b2fbd83b06f65d835251b0126ed62afb0b9f28dc86bbf174b07a362ce797cecd3bd46bba269
+  metadata.gz: 3f5e4f6609b93e80ae775ab556812cc872883eaf423a74ae2e5191d2bef6907152653fa7fe441bb9aab945b7cf9f4ec62dd4d359ffcb88f4e976b8b53fb42ac8
+  data.tar.gz: 4b76e94533ff98f1c1d9d427967a5c19af3d58484a5e785c7eac15d50211d70e4718d35572bb6e89fbafeb9b9f092a73f68e517244676f28d4c7e4854f1a055a

data/.gitignore

@@ -7,5 +7,6 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.log
 
 .DS_Store

data/.travis.yml

@@ -9,11 +9,11 @@ before_install:
 after_success:
   - '[ -d coverage ] && bundle exec codeclimate-test-reporter'
 rvm:
-  - 2.2.9
-  - 2.3.6
-  - 2.4.3
-  - 2.5.0
-  - jruby-9.1.15.0
+  - 2.2.10
+  - 2.3.7
+  - 2.4.4
+  - 2.5.1
+  - jruby-9.2.0.0
 env:
   global:
     - COVERAGE=true

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+# v0.6.0 2018-10-24
+
+## BREAKING CHANGES
+
+* `Struct.attribute?` in the old sense is deprecated, use `has_attribute?` as a replacement
+
+## Added
+
+* `Struct.attribute?` is an easy way to define omittable attributes (flash-gordon):
+
+  ```ruby
+  class User < Dry::Struct
+    attribute  :name,  Types::Strict::String
+    attribute? :email, Types::Strict::String
+  end
+  # User.new(name: 'John') # => #<User name="John">
+  ```
+
+## Fixed
+
+* `Struct#to_h` recursively converts hash values to hashes, this was done to be consistent with current behavior for arrays (oeoeaio + ZimbiX)
+
+[Compare v0.5.1...v0.6.0](https://github.com/dry-rb/dry-struct/compare/v0.5.1...v0.6.0)
+
 # v0.5.1 2018-08-11
 
 ## Fixed

data/dry-struct.gemspec

@@ -17,6 +17,8 @@ Gem::Specification.new do |spec|
   # delete this section to allow pushing this gem to any host.
   if spec.respond_to?(:metadata)
     spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+    spec.metadata['changelog_uri'] = 'https://github.com/dry-rb/dry-struct/blob/master/CHANGELOG.md'
+    spec.metadata['source_code_uri'] = 'https://github.com/dry-rb/dry-struct'
   else
     raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
   end

data/lib/dry/struct.rb

@@ -167,8 +167,8 @@ module Dry
     #   )
     #     #=> #<Book title="Web Development with ROM and Roda" subtitle="2nd edition">
     #
-    #   rom_n_roda.new(subtitle: '3nd edition')
-    #     #=> #<Book title="Web Development with ROM and Roda" subtitle="3nd edition">
+    #   rom_n_roda.new(subtitle: '3rd edition')
+    #     #=> #<Book title="Web Development with ROM and Roda" subtitle="3rd edition">
     def new(changeset)
       self.class[__attributes__.merge(changeset)]
     end

data/lib/dry/struct/class_interface.rb

@@ -100,17 +100,37 @@ module Dry
       #   ruby.celebrities[1].name #=> 'Aaron Patterson'
       #   ruby.celebrities[1].pseudonym #=> 'tenderlove'
       def attribute(name, type = nil, &block)
-        if block
-          type = Dry::Types[type] if type.is_a?(String)
-          type = struct_builder.(name, type, &block)
-        elsif type.nil?
-          raise(
-            ArgumentError,
-            'you must supply a type or a block to `Dry::Struct.attribute`'
+        attributes(name => build_type(name, type, &block))
+      end
+
+      # Adds an omittable (key is not required on initialization) attribute for this {Struct}
+      #
+      # @example
+      #   class User < Dry::Struct
+      #     attribute  :name,  Types::Strict::String
+      #     attribute? :email, Types::Strict::String
+      #   end
+      #
+      #   User.new(name: 'John') # => #<User name="John">
+      #
+      # @param [Symbol] name name of the defined attribute
+      # @param [Dry::Types::Definition, nil] type or superclass of nested type
+      # @return [Dry::Struct]
+      #
+      def attribute?(*args, &block)
+        if args.size == 1 && block.nil?
+          Dry::Core::Deprecations.warn(
+            'Dry::Struct.attribute? is deprecated for checking attribute presence, '\
+            'use has_attribute? instead',
+            tag: :'dry-struct'
           )
-        end
 
-        attributes(name => type)
+          has_attribute?(args[0])
+        else
+          name, type = args
+
+          attribute(name, build_type(name, type, &block).meta(omittable: true))
+        end
       end
 
       # @param [Hash{Symbol => Dry::Types::Definition}] new_schema
@@ -297,7 +317,7 @@ module Dry
       #
       # @param [Symbol] key Attribute name
       # @return [Boolean]
-      def attribute?(key)
+      def has_attribute?(key)
         schema.key?(key)
       end
 
@@ -361,6 +381,30 @@ module Dry
         type.is_a?(Class) && type <= Struct
       end
       private :struct?
+
+      # Constructs a type
+      #
+      # @return [Dry::Types::Type, Dry::Struct]
+      def build_type(name, type, &block)
+        type_object =
+          if type.is_a?(String)
+            Dry::Types[type]
+          elsif block.nil? && type.nil?
+            raise(
+              ArgumentError,
+              'you must supply a type or a block to `Dry::Struct.attribute`'
+            )
+          else
+            type
+          end
+
+        if block
+          struct_builder.(name, type_object, &block)
+        else
+          type_object
+        end
+      end
+      private :build_type
     end
   end
 end

data/lib/dry/struct/hashify.rb

@@ -7,7 +7,11 @@ module Dry
       # @return [Hash, Array]
       def self.[](value)
         if value.respond_to?(:to_hash)
-          value.to_hash
+          if RUBY_VERSION >= '2.4'
+            value.to_hash.transform_values { |v| self[v] }
+          else
+            value.to_hash.each_with_object({}) { |(k, v), h| h[k] = self[v] }
+          end
         elsif value.respond_to?(:to_ary)
           value.to_ary.map { |item| self[item] }
         else

data/lib/dry/struct/version.rb

@@ -1,6 +1,6 @@
 module Dry
   class Struct
     # @private
-    VERSION = '0.5.1'.freeze
+    VERSION = '0.6.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-struct
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-11 00:00:00.000000000 Z
+date: 2018-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-equalizer
@@ -162,11 +162,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
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
+  changelog_uri: https://github.com/dry-rb/dry-struct/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/dry-rb/dry-struct
 post_install_message: 
 rdoc_options: []
 require_paths: