dry-initializer 2.3.0 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2272ada187c2b221d758533b4cc63f37ea067aca
-  data.tar.gz: 80af7ae1bc35c976fc275a33b02bc0647ba1dd32
+SHA256:
+  metadata.gz: f5d079daa17830b65177c99533e1b7f280bb4aee14dbcba097ba8c40de273abd
+  data.tar.gz: a59b00abe9c741b764152a6213ff40c29adbdf27094ecebbaaf766b2e056aa99
 SHA512:
-  metadata.gz: 8507dde97e618b0b1ad710def44309be4bc48db87268c8757e3fdc8ceb4e8515a75e7b216c8076ee37e61a03bdeeaf818589ba934904b74bb5a8713a73d1ede8
-  data.tar.gz: 78cc7f411b550ace24555d6c489d5cbf18e3ead3c9fc46140c4f6563b68786152cead5e845db76c13c44855a73d9e4dd595e0f39f617a2fcb70f31ed6c43cb6f
+  metadata.gz: 4fee1158d5ddd7bfca050f61788ee7012bf0a0f424239095ea649c6dd34ba47b157627efe7261f9e5fdaef405654b589addd26990a912b72cd0f76e339003754
+  data.tar.gz: 64a5e73606be0a238d0dba9173d32f90d8366d0aae64edf378dd851705a07d4ede0906ed241cc85ff9cb9b5c5f3fe9734bfb77d53fb6fc71bf29565b8607c388

data/.codeclimate.yml

@@ -1,23 +1,12 @@
----
-engines:
+# this file is managed by dry-rb/devtools project
+
+version: "2"
+
+exclude_patterns:
+  - "benchmarks/"
+  - "examples/"
+  - "spec/"
+
+plugins:
   rubocop:
     enabled: true
-    checks:
-      Rubocop/Style/FrozenStringLiteralComment:
-        enabled: false
-      Rubocop/Style/PercentLiteralDelimiters:
-        enabled: false
-      Rubocop/Lint/UnderscorePrefixedVariableName:
-        enabled: false
-  duplication:
-    enabled: true
-    config:
-      languages:
-        - ruby
-exclude_paths:
-- "benchmarks/**/*"
-- "spec/**/*"
-- "lib/tasks/**/*"
-ratings:
-   paths:
-   - "lib/**/*"

data/.github/ISSUE_TEMPLATE/----please-don-t-ask-for-support-via-issues.md

@@ -0,0 +1,10 @@
+---
+name: "⚠️  Please don't ask for support via issues"
+about: See CONTRIBUTING.md for more information
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+

data/.github/ISSUE_TEMPLATE/---bug-report.md

@@ -0,0 +1,34 @@
+---
+name: "\U0001F41B Bug report"
+about: See CONTRIBUTING.md for more information
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Before you submit this: WE ONLY ACCEPT BUG REPORTS AND FEATURE REQUESTS**
+
+For more information see [our contribution guidelines](https://github.com/rom-rb/rom/blob/master/CONTRIBUTING.md)
+
+**Before you report**
+
+:warning: If you have a problem related to a schema, please **report it under [dry-schema issues](https://github.com/dry-rb/dry-schema/issues/new?assignees=&labels=bug&template=---bug-report.md&title=)** instead.
+
+**Describe the bug**
+
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+
+Provide detailed steps to reproduce, an executable script would be best.
+
+**Expected behavior**
+
+A clear and concise description of what you expected to happen.
+
+**Your environment**
+
+- Affects my production application: **YES/NO**
+- Ruby version: ...
+- OS: ...

data/.github/ISSUE_TEMPLATE/---feature-request.md

@@ -0,0 +1,18 @@
+---
+name: "\U0001F6E0 Feature request"
+about: See CONTRIBUTING.md for more information
+title: ''
+labels: feature
+assignees: ''
+
+---
+
+Summary of what the feature is supposed to do.
+
+## Examples
+
+Code examples showing how the feature could be used.
+
+## Resources
+
+Additional information, like a link to the discussion forum thread where the feature was discussed etc.

data/.github/workflows/custom_ci.yml

@@ -0,0 +1,74 @@
+name: ci
+
+on:
+  push:
+    paths:
+      - .github/workflows/custom_ci.yml
+      - lib/**
+      - spec/**
+      - Gemfile
+      - "*.gemspec"
+
+jobs:
+  tests-mri:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["2.6.x", "2.5.x", "2.4.x", "2.3.x"]
+        include:
+          - ruby: "2.6.x"
+            coverage: "true"
+    steps:
+      - uses: actions/checkout@v1
+      - name: Set up Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{matrix.ruby}}
+      - name: Download test reporter
+        if: "matrix.coverage == 'true'"
+        run: |
+          mkdir -p tmp/
+          curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./tmp/cc-test-reporter
+          chmod +x ./tmp/cc-test-reporter
+          ./tmp/cc-test-reporter before-build
+      - name: Run all tests
+        env:
+          CI: "true"
+          COVERAGE: ${{matrix.coverage}}
+        run: |
+          gem install bundler
+          bundle config set without 'tools docs benchmarks'
+          bundle install --jobs 4 --retry 3
+          bundle exec rake
+      - name: Send coverage results
+        if: "matrix.coverage == 'true'"
+        env:
+          CC_TEST_REPORTER_ID: ${{secrets.CC_TEST_REPORTER_ID}}
+          GIT_COMMIT_SHA: ${{github.sha}}
+          GIT_BRANCH: ${{github.ref}}
+          GIT_COMMITTED_AT: ${{github.event.head_commit.timestamp}}
+        run: |
+          GIT_BRANCH=`ruby -e "puts ENV['GITHUB_REF'].split('/', 3).last"` \
+          GIT_COMMITTED_AT=`ruby -r time -e "puts Time.iso8601(ENV['GIT_COMMITTED_AT']).to_i"` \
+          ./tmp/cc-test-reporter after-build
+
+  tests-others:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        image: ["jruby:9.2.8", "ruby:rc"]
+    container:
+      image: ${{matrix.image}}
+    steps:
+      - uses: actions/checkout@v1
+      - name: Install git
+        run: |
+          apt-get update
+          apt-get install -y --no-install-recommends git
+      - name: Run all tests
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3 --without tools docs benchmarks
+          bundle exec rspec

data/.github/workflows/docsite.yml

@@ -0,0 +1,34 @@
+# this file is managed by dry-rb/devtools project
+
+name: docsite
+
+on:
+  push:
+    paths:
+      - docsite/**
+      - .github/workflows/docsite.yml
+    branches:
+      - master
+      - release-**
+    tags:
+
+jobs:
+  update-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: Set up Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: "2.6.x"
+      - name: Install dependencies
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3 --without benchmarks sql
+      - name: Symlink ossy
+        run: mkdir -p bin && ln -sf "$(bundle show ossy)/bin/ossy" bin/ossy
+      - name: Trigger dry-rb.org deploy
+        env:
+          GITHUB_LOGIN: dry-bot
+          GITHUB_TOKEN: ${{ secrets.GH_PAT }}
+        run: bin/ossy github workflow dry-rb/dry-rb.org ci

data/.github/workflows/sync_configs.yml

@@ -0,0 +1,34 @@
+# this file is managed by dry-rb/devtools project
+
+name: sync_configs
+
+on:
+  repository_dispatch:
+
+jobs:
+  sync-configs:
+    runs-on: ubuntu-latest
+    if: github.event.action == 'sync_configs'
+    steps:
+      - uses: actions/checkout@v1
+      - name: Update configuration files from devtools
+        env:
+          GITHUB_LOGIN: dry-bot
+          GITHUB_TOKEN: ${{ secrets.GH_PAT }}
+        run: |
+          git clone https://github.com/dry-rb/devtools.git tmp/devtools
+
+          if [ -f ".github/workflows/custom_ci.yml" ]; then
+            rsync -av --exclude '.github/workflows/ci.yml' tmp/devtools/shared/ . ;
+          else
+            rsync -av tmp/devtools/shared/ . ;
+          fi
+
+          git config --local user.email "dry-bot@dry-rb.org"
+          git config --local user.name "dry-bot"
+          git add -A
+          git commit -m "[devtools] config sync" || echo "nothing changed"
+      - name: Push changes
+        uses: ad-m/github-push-action@master
+        with:
+          github_token: ${{ secrets.GH_PAT }}

data/.gitignore

@@ -8,3 +8,5 @@
 /spec/reports/
 /tmp/
 /*.gem
+
+.vscode

data/.rspec

@@ -1,4 +1,4 @@
---format documentation
 --color
 --require spec_helper
---warnings
+--order random
+

data/.rubocop.yml

@@ -1,51 +1,89 @@
----
+# this file is managed by dry-rb/devtools project
+
 AllCops:
-  DisplayCopNames:    true
-  DisplayStyleGuide:  true
-  StyleGuideCopsOnly: true
-  TargetRubyVersion:  2.3
-  Exclude:
-    - lib/tasks/*.rake
+  TargetRubyVersion: 2.4
+
+Style/EachWithObject:
+  Enabled: false
 
-Bundler/DuplicatedGem:
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/Alias:
   Enabled: false
 
-Style/CaseEquality:
+Style/LambdaCall:
   Enabled: false
 
-Style/ClassVars:
+Style/StabbyLambdaParentheses:
   Enabled: false
 
-Style/ClassAndModuleChildren:
+Style/FormatString:
   Enabled: false
 
 Style/Documentation:
   Enabled: false
 
-Style/DoubleNegation:
+Layout/SpaceInLambdaLiteral:
   Enabled: false
 
-Style/FileName:
-  Exclude:
-    - lib/dry-initializer.rb
+Layout/MultilineMethodCallIndentation:
+  Enabled: true
+  EnforcedStyle: indented
 
-Style/Lambda:
-  Exclude:
-    - spec/**/*.rb
+Metrics/LineLength:
+  Max: 100
 
-Style/LambdaCall:
+Metrics/MethodLength:
+  Max: 22
+
+Metrics/ClassLength:
+  Max: 150
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: true
+  Max: 10
+
+Lint/BooleanSymbol:
+  Enabled: false
+
+Style/AccessModifierDeclarations:
+  Enabled: false
+
+Style/BlockDelimiters:
   Enabled: false
 
-Style/RescueModified:
+Layout/IndentFirstArrayElement:
+  EnforcedStyle: consistent
+
+Style/ClassAndModuleChildren:
   Exclude:
-    - spec/**/*.rb
+    - "spec/**/*_spec.rb"
 
-Style/Semicolon:
+Lint/HandleExceptions:
   Exclude:
-    - spec/**/*.rb
+    - "spec/spec_helper.rb"
 
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
+Naming/FileName:
+  Exclude:
+    - "lib/dry-*.rb"
+
+Style/SymbolArray:
+  Exclude:
+    - "spec/**/*_spec.rb"
+
+Style/ConditionalAssignment:
+  Enabled: false
+
+Naming/MethodName:
+  Enabled: false
 
-Style/StringLiteralsInInterpolation:
-  EnforcedStyle: double_quotes
+Style/AsciiComments:
+  Enabled: false

data/CHANGELOG.md

@@ -5,6 +5,145 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [3.0.2] [2019-11-07]
+
+### Fixed
+
+- Warnings about keyword arguments (flash-gordon)
+
+## [3.0.1] [2019-04-15]
+
+### Fixed
+
+- Usage of underscored names of `option`-s and `param`-s (nepalez)
+
+  You can use any sequence of underscores except for in nested types.
+  In nested types single underscores can be used to split alphanumeric
+  parts only.
+
+  ```ruby
+  class Test
+    extend Dry::Initializer
+
+    # Proper usage
+    option :foo_bar do
+      option :__foo__, proc(&:to_s)
+    end
+  end
+
+    # Improper usage
+    option :__foo__ do
+      # ...
+    end
+
+    option :foo__bar do
+      # ...
+    end
+  end
+  ```
+
+  This restriction is necessary because we constantize option/param names
+  when defining nested structs.
+
+## [3.0.0] [2019-04-14]
+
+### Added
+
+- Support of wrapped types/coercers (nepalez)
+
+  ```ruby
+  class Test
+    # Wrap type to the array
+    param :foo, [proc(&:to_s)]
+  end
+
+  # And the value will be wrapped as well
+  test = Test.new(42)
+  test.foo # => ["42"]
+  ```
+
+- It works with several layers of nesting (nepalez)
+
+  ```ruby
+  class Test
+    # Wrap type to the array
+    param :foo, [[proc(&:to_s)]]
+  end
+
+  # And the value will be wrapped as well
+  test = Test.new(42)
+  test.foo # => [["42"]]
+  ```
+
+- Support of nested types/coercers (nepalez)
+
+  ```ruby
+  class Test
+    param :foo do
+      option :bar do
+        option :baz, proc(&:to_s)
+      end
+    end
+  end
+
+  test = Test.new(bar: { "baz" => 42 })
+  test.foo.bar.baz # => "42"
+  ```
+
+- Wrapped/nested combinations are supported as well (nepalez)
+
+  ```ruby
+  class Test
+    param :foo, [] do
+      option :bar, proc(&:to_s)
+    end
+  end
+
+  test = Test.new(bar: 42)
+  test.foo.first.bar # => "42"
+  ```
+
+## [2.7.0] Unreleazed
+
+### Fixed
+
+- Roll back master to the state of [2.5.0].
+
+  Somehow distinction between `@default_null` and `@null` variables
+  in the `Dry::Initializer::Builders` broken the `rom` library.
+
+  The version [2.6.0] has been yanked on rubygems, so the master
+  was rolled back to the previous state until the reason for
+  the incompatibility become clear (bjeanes, nepalez)
+
+## [2.6.0] [2018-09-09] (YANKED)
+
+## [2.5.0] [2018-08-17]
+
+### Fixed
+
+- `nil` coercion (belousovAV)
+
+  When default value is `nil` instead of `Dry::Initializer::UNDEFINED`,
+  the coercion should be applied to any value, including `nil`, because
+  we cannot distinct "undefined" `nil` from the "assigned" `nil` value.
+
+## [2.4.0] [2018-02-01]
+
+### Added
+- Dispatchers for adding syntax sugar to `param` and `options` (nepalez)
+
+  ```ruby
+  # Converts `integer: true` to `type: proc(&:to_i)`
+  dispatcher = ->(op) { op[:integer] ? op.merge(type: proc(&:to_i)) : op }
+  # Register a dispatcher
+  Dry::Initializer::Dispatchers << dispatcher
+  # Use syntax sugar
+  class User
+    param :id, integer: true # same as param :id, proc(&:to_i)
+  end
+  ```
+
 ## [2.3.0] [2017-09-19]
 
 ### Added
@@ -15,7 +154,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
   ```ruby
   class Location < String
     attr_reader :parameter # refers back to its parameter
-  
+
     def initialize(name, parameter)
       super(name)
       @parameter = parameter
@@ -303,7 +442,7 @@ and to @gzigzigzeo for persuading me to do this refactoring.
 
 ### Added
 - No-undefined configuration of the initializer (nepalez, flash-gordon)
-  
+
   You can either extend or include module `Dry::Initializer` with additional option
   `[undefined: false]`. This time `nil` will be assigned instead of
   `Dry::Initializer::UNDEFINED`. Readers becomes faster because there is no need
@@ -351,18 +490,20 @@ and to @gzigzigzeo for persuading me to do this refactoring.
 ### Added
 - enhancement via `Dry::Initializer::Attribute.dispatchers` registry (nepalez)
 
-    # Register dispatcher for `:string` option
-    Dry::Initializer::Attribute.dispatchers << ->(string: nil, **op) do
-      string ? op.merge(type: proc(&:to_s)) : op
-    end
+  ```ruby
+  # Register dispatcher for `:string` option
+  Dry::Initializer::Attribute.dispatchers << ->(string: nil, **op) do
+    string ? op.merge(type: proc(&:to_s)) : op
+  end
 
-    # Now you can use the `:string` key for `param` and `option`
-    class User
-      extend Dry::Initializer
-      param :name, string: true
-    end
+  # Now you can use the `:string` key for `param` and `option`
+  class User
+    extend Dry::Initializer
+    param :name, string: true
+  end
 
-    User.new(:Andy).name # => "Andy"
+  User.new(:Andy).name # => "Andy"
+  ```
 
 ### Changed
 - optimize assignments for performance (nepalez)
@@ -413,7 +554,7 @@ In this version the code has been rewritten for simplicity
 
 ### Internal
 - Refactor the way [#initializer] method is (re)defined (nepalez)
-  
+
   When you extend class with `Dry::Initializer::Mixin`, the initializer is
   defined not "inside" the class per se, but inside the included module. The
   reference to that module is stored as class-level `__initializer_mixin__`.
@@ -741,3 +882,9 @@ First public release
 [2.1.0]: https://github.com/dry-rb/dry-initializer/compare/v2.0.0...v2.1.0
 [2.2.0]: https://github.com/dry-rb/dry-initializer/compare/v2.1.0...v2.2.0
 [2.3.0]: https://github.com/dry-rb/dry-initializer/compare/v2.2.0...v2.3.0
+[2.4.0]: https://github.com/dry-rb/dry-initializer/compare/v2.3.0...v2.4.0
+[2.6.0]: https://github.com/dry-rb/dry-initializer/compare/v2.4.0...v2.5.0
+[2.6.0]: https://github.com/dry-rb/dry-initializer/compare/v2.5.0...v2.6.0
+[3.0.0]: https://github.com/dry-rb/dry-initializer/compare/v2.5.0...v3.0.0
+[3.0.1]: https://github.com/dry-rb/dry-initializer/compare/v3.0.0...v3.0.1
+[3.0.2]: https://github.com/dry-rb/dry-initializer/compare/v3.0.1...v3.0.2