dry-struct 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0cc9fef4b32f2b57bac889a7f5ca759795b650dd
-  data.tar.gz: be8ff9b280bcc8d0afdccf28d39453b7060e13d3
+  metadata.gz: 223d319c97aced13759a063d7d19d0afc7eeff56
+  data.tar.gz: '09b4aecf6acb6981e71e9e98a8f3049e9e5b4ff6'
 SHA512:
-  metadata.gz: f8c76b9683ad51451060a3c388741598aedcac78946b0f979c8928fef1a3e6f4300c211438f3d3ca6490c23525730d051ffb7c2a808fd5e1b322474e91b20e9a
-  data.tar.gz: 0d8dc1bc47204f422ee104d60ee732e7bb276e3441ec255303f3a794f2718be0eb63bea2beda822c08a40a1a04a864d097171c4becaede57d7ffa701794a17fd
+  metadata.gz: 52ef521bf80136eb363dc53adb98e21f1b379fa7697edadf9e4f882e32a2334948beb316f997fa5c11fabb871674b40f86fd373b254253bb879e6a0db516e63e
+  data.tar.gz: f2fac5903962ee469f009a566fabd77fc8c0e9470222ef9a78fd63db6916a1b0e36958e34c0c083e5e146e11398dfdf567c7dfbefd18f82bfd03338cba8822bd

data/.travis.yml

@@ -11,15 +11,11 @@ rvm:
   - 2.2.7
   - 2.3.3
   - 2.4.1
-  - rbx-3
-  - jruby-9.1.8.0
+  - jruby-9.1.10.0
 env:
   global:
     - COVERAGE=true
     - JRUBY_OPTS='--dev -J-Xmx1024M'
-matrix:
-  allow_failures:
-    - rvm: rbx-3
 notifications:
   email: false
   webhooks:

data/CHANGELOG.md

@@ -1,4 +1,14 @@
-master
+# v0.3.1 to-be-released
+
+## Added
+
+* `Struct.constructor` that makes dry-struct more aligned with dry-types; now you can have a struct with a custom constructor that will be called _before_ calling the `new` method (v-kolesnikov)
+* `Struct.attribute?` and `Struct.attribute_names` for introspecting struct attributes (flash-gordon)
+* `Struct#__new__` is a safe-to-use-in-gems alias for `Struct#new` (flash-gordon)
+
+[Compare v0.3.0...master](https://github.com/dry-rb/dry-struct/compare/v0.3.0...master)
+
+# v0.3.0 2017-05-05
 
 ## Added
 
@@ -13,7 +23,7 @@ master
 
 * `.new` without arguments doesn't use nil as an input for non-default types anymore (flash-gordon)
 
-[Compare v0.2.1...master](https://github.com/dry-rb/dry-struct/compare/v0.2.1...master)
+[Compare v0.2.1...v0.3.0](https://github.com/dry-rb/dry-struct/compare/v0.2.1...v0.3.0)
 
 # v0.2.1 2017-02-27
 

data/CONTRIBUTING.md

@@ -0,0 +1,29 @@
+# Issue Guidelines
+
+## Reporting bugs
+
+If you found a bug, report an issue and describe what's the expected behavior versus what actually happens. If the bug causes a crash, attach a full backtrace. If possible, a reproduction script showing the problem is highly appreciated.
+
+## Reporting feature requests
+
+Report a feature request **only after discussing it first on [discuss.dry-rb.org](https://discuss.dry-rb.org)** where it was accepted. Please provide a concise description of the feature, don't link to a discussion thread, and instead summarize what was discussed.
+
+## Reporting questions, support requests, ideas, concerns etc.
+
+**PLEASE DON'T** - use [discuss.dry-rb.org](http://discuss.dry-rb.org) instead.
+
+# Pull Request Guidelines
+
+A Pull Request will only be accepted if it addresses a specific issue that was reported previously, or fixes typos, mistakes in documentation etc.
+
+Other requirements:
+
+1) Do not open a pull request if you can't provide tests along with it. If you have problems writing tests, ask for help in the related issue.
+2) Follow the style conventions of the surrounding code. In most cases, this is standard ruby style.
+3) Add API documentation if it's a new feature
+4) Update API documentation if it changes an existing feature
+5) Bonus points for sending a PR to [github.com/dry-rb/dry-rb.org](github.com/dry-rb/dry-rb.org) which updates user documentation and guides
+
+# Asking for help
+
+If these guidelines aren't helpful, and you're stuck, please post a message on [discuss.dry-rb.org](https://discuss.dry-rb.org).

data/lib/dry/struct.rb

@@ -1,3 +1,4 @@
+require 'dry/core/constants'
 require 'dry-types'
 
 require 'dry/struct/version'
@@ -56,6 +57,7 @@ module Dry
   #   refactoring.title #=> 'Refactoring'
   #   refactoring.subtitle #=> 'Improving the Design of Existing Code'
   class Struct
+    include Dry::Core::Constants
     extend ClassInterface
 
     # {Dry::Types::Hash} subclass with specific behaviour defined for
@@ -64,6 +66,10 @@ module Dry
     defines :input
     input Types['coercible.hash']
 
+    # @return [Hash{Symbol => Dry::Types::Definition, Dry::Struct}]
+    defines :schema
+    schema EMPTY_HASH
+
     # Sets or retrieves {#constructor} type as a symbol
     #
     # @note All examples below assume that you have defined {Struct} with
@@ -227,9 +233,30 @@ module Dry
     end
     alias_method :to_h, :to_hash
 
+    # Create a copy of {Dry::Struct} with overriden attributes
+    #
+    # @param [Hash{Symbol => Object}] changeset
+    #
+    # @return [Struct]
+    #
+    # @example
+    #   class Book < Dry::Struct
+    #     attribute :title, Types::Strict::String
+    #     attribute :subtitle, Types::Strict::String.optional
+    #   end
+    #
+    #   rom_n_roda = Book.new(
+    #     title: 'Web Development with ROM and Roda',
+    #     subtitle: '2nd edition'
+    #   )
+    #     #=> #<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">
     def new(changeset)
       self.class[to_hash.merge(changeset)]
     end
+    alias_method :__new__, :new
   end
 end
 

data/lib/dry/struct/class_interface.rb

@@ -2,6 +2,7 @@ require 'dry/core/class_attributes'
 require 'dry/equalizer'
 
 require 'dry/struct/errors'
+require 'dry/struct/constructor'
 
 module Dry
   class Struct
@@ -11,20 +12,12 @@ module Dry
 
       include Dry::Types::Builder
 
-      # @param [Module] base
-      def self.extended(base)
-        base.instance_variable_set(:@schema, EMPTY_HASH)
-      end
-
       # @param [Class] klass
       def inherited(klass)
         super
 
-        klass.instance_variable_set(:@schema, EMPTY_HASH)
         klass.equalizer Equalizer.new(*schema.keys)
         klass.send(:include, klass.equalizer)
-
-        klass.attributes(EMPTY_HASH) unless equal?(Struct)
       end
 
       # Adds an attribute for this {Struct} with given `name` and `type`
@@ -69,9 +62,7 @@ module Dry
       def attributes(new_schema)
         check_schema_duplication(new_schema)
 
-        prev_schema = schema
-
-        @schema = prev_schema.merge(new_schema)
+        schema schema.merge(new_schema)
         input Types['coercible.hash'].public_send(constructor_type, schema)
 
         attr_reader(*new_schema.keys)
@@ -90,12 +81,6 @@ module Dry
       end
       private :check_schema_duplication
 
-      # @return [Hash{Symbol => Dry::Types::Definition, Dry::Struct}]
-      def schema
-        super_schema = superclass.respond_to?(:schema) ? superclass.schema : EMPTY_HASH
-        super_schema.merge(@schema)
-      end
-
       # @param [Hash{Symbol => Object},Dry::Struct] attributes
       # @raise [Struct::Error] if the given attributes don't conform {#schema}
       #   with given {#constructor_type}
@@ -110,7 +95,7 @@ module Dry
       end
 
       # Calls type constructor. The behavior is identical to `.new` but returns
-      # returns the input back if it's a subclass of the struct.
+      # the input back if it's a subclass of the struct.
       #
       # @param [Hash{Symbol => Object},Dry::Struct] attributes
       # @return [Dry::Struct]
@@ -120,6 +105,14 @@ module Dry
       end
       alias_method :[], :call
 
+      # @param [#call,nil] constructor
+      # @param [Hash] options
+      # @param [#call,nil] block
+      # @return [Dry::Struct::Constructor]
+      def constructor(constructor = nil, **_options, &block)
+        Struct::Constructor.new(self, fn: constructor || block)
+      end
+
       # Retrieves default attributes from defined {.schema}.
       # Used in a {Struct} constructor if no attributes provided to {.new}
       #
@@ -194,6 +187,21 @@ module Dry
       def optional?
         false
       end
+
+      # Checks if this {Struct} has the given attribute
+      #
+      # @param [Symbol] key Attribute name
+      # @return [Boolean]
+      def attribute?(key)
+        schema.key?(key)
+      end
+
+      # Gets the list of attribute names
+      #
+      # @return [Array<Symbol>]
+      def attribute_names
+        schema.keys
+      end
     end
   end
 end

data/lib/dry/struct/constructor.rb

@@ -0,0 +1,28 @@
+module Dry
+  class Struct
+    class Constructor
+      include Dry::Equalizer(:type)
+
+      # @return [#call]
+      attr_reader :fn
+
+      # @return [#call]
+      attr_reader :type
+
+      # @param [Struct] type
+      # @param [Hash] options
+      # @param [#call, nil] block
+      def initialize(type, options = {}, &block)
+        @type = type
+        @fn = options.fetch(:fn, block)
+      end
+
+      # @param [Object] input
+      # @return [Object]
+      def call(input)
+        type[fn[input]]
+      end
+      alias_method :[], :call
+    end
+  end
+end

data/lib/dry/struct/version.rb

@@ -1,5 +1,5 @@
 module Dry
   class Struct
-    VERSION = '0.3.0'.freeze
+    VERSION = '0.3.1'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-struct
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-05 00:00:00.000000000 Z
+date: 2017-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-equalizer
@@ -154,6 +154,7 @@ files:
 - ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md
@@ -166,6 +167,7 @@ files:
 - lib/dry-struct.rb
 - lib/dry/struct.rb
 - lib/dry/struct/class_interface.rb
+- lib/dry/struct/constructor.rb
 - lib/dry/struct/errors.rb
 - lib/dry/struct/hashify.rb
 - lib/dry/struct/value.rb