dry-monads 1.3.5 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86fbad001116e7a69e01b2f7e8b0c5ee8101a95af73fd9f485880131df364749
-  data.tar.gz: 5d3a4bf072bfcfe22edb31512a4b29b5952c7aaa674af4b1ef546dc8ce39e302
+  metadata.gz: 06e9ae65089e5f79f92b2d1c67d463757dc960af7a7edbd92d527c0fb6cfd997
+  data.tar.gz: 9d49d077c77edd1580bcc0cdd97fce2d527cabd9013b71611340b14ef6dae7d0
 SHA512:
-  metadata.gz: aaa55a8f21b5e84d9b4029a59733a72c4bd21ccfd76430faa4eb39c821860e774e0a94e9fddbecd66a6e0c9c876d7178dc66a2364b85851ecbf56fb8b6ac5e86
-  data.tar.gz: 126cc641f1ba8ba33fd251e63d18668c1360eff70967f86705a333fcd01df95cc3909579a128e270629b4609179db435fdeb0de0d3a5fcdb2ef0693ccc3fcc49
+  metadata.gz: 5720b87b50ce55e727f169e3bf62d4ad23aa0b6779b8086e326b79cf0242b93fc9f89f840f1a3d6718d2401461a19eea6e4f0679e91499816ccf295aee619d1d
+  data.tar.gz: c95f43c4a51dd831d248cae4bc1afa8d226743e295081dfc4bf05a58c2e18aa146afd64dedb415b8189bbf3f2f54c0c0edb9033fb5a9367551f3fb6d88c37374

data/CHANGELOG.md

@@ -1,34 +1,91 @@
-# v1.3.5 2020-01-06
+<!--- DO NOT EDIT THIS FILE - IT'S AUTOMATICALLY GENERATED VIA DEVTOOLS --->
 
-## Added
+## 1.4.0 2021-07-20
+
+
+### Added
+
+- `Unit` destructures to an empty array (flash-gordon)
+- When `.value!` called on a `Failure` value the error references to the value (rewritten + flash-gordon)
+  ```ruby
+  begin
+    Failure("oops").value!
+  rescue => error
+    error.receiver # => Failure("oops")
+  end
+  ```
+- `Result#alt_map` for mapping failure values (flash-gordon)
+  ```ruby
+  Failure("oops").alt_map(&:upcase) # => Failure("OOPS")
+  ```
+- `Try#recover` recovers from errors (flash-gordon)
+  ```ruby
+  error = Try { Hash.new.fetch(:missing) }
+  error.recover(KeyError) { 'default' } # => Try::Value("default")
+  ```
+- `Maybe#filter` runs a predicate against the wrapped value. Returns `None` if the result is false (flash-gordon)
+  ```ruby
+  Some(3).filter(&:odd?)  # => Some(3)
+  Some(3).filter(&:even?) # => None
+  # no block given
+  Some(3 == 5).filter     # => None
+  ```
+- `RightBiased#|` is an alias for `#or` (flash-gordon)
+  ```ruby
+  None() | Some(6) | Some(7) # => Some(6)
+  Failure() | Success("one") | Success("two") # => Success("one")
+  ```
+
+### Fixed
+
+- Do notation preserves method visibility (anicholson + flash-gordon)
+
+### Changed
+
+- Coercing `nil` values to `None` with `Some#fmap` is officially deprecated. (flash-gordon)
+Switch to `Some#maybe` when you expect `nil`.
+This behavior will be dropped in 2.0 but you can opt out of warnings for the time being
+  ```ruby
+  Dry::Monads::Maybe.warn_on_implicit_nil_coercion false
+  ```
+- Minimal Ruby version is 2.6
+
+[Compare v1.3.5...v1.4.0](https://github.com/dry-rb/dry-monads/compare/v1.3.5...v1.4.0)
+
+## 1.3.5 2020-01-06
+
+
+### Added
 
 - Smarter keys deconstruction in pattern matching (flash-gordon)
 
+
 [Compare v1.3.4...v1.3.5](https://github.com/dry-rb/dry-monads/compare/v1.3.4...v1.3.5)
 
-# v1.3.4 2019-12-28
+## 1.3.4 2019-12-28
+
 
-## Fixed
+### Fixed
 
 - One more delegation warning happenning in do notation (flash-gordon)
 
+
 [Compare v1.3.3...v1.3.4](https://github.com/dry-rb/dry-monads/compare/v1.3.3...v1.3.4)
 
-# v1.3.3 2019-12-11
+## 1.3.3 2019-12-11
+
 
-## Fixed
+### Fixed
 
 - Incompatibility with Rails. Internal (!) halt exceptions now use mutable backtraces because spring [mutates](https://github.com/rails/spring/blob/ee687859008e947bc905b95121e306e2948d31c9/lib/spring/application.rb#L295-L311) (!) them. For the record, this a bug in Rails (johnmaxwell)
 
-[Compare v1.3.2...v1.3.3](https://github.com/dry-rb/dry-monads/compare/v1.3.2...v1.3.3)
 
-# v1.3.2 2019-11-30
+[Compare v1.3.2...v1.3.3](https://github.com/dry-rb/dry-monads/compare/v1.3.2...v1.3.3)
 
-## Fixed
+## 1.3.2 2019-11-30
 
-- Warnings about keywords from Ruby 2.7 (flash-gordon)
 
-## Added
+### Added
 
 - Pattern matching syntax was improved by implementing `#deconstruct_keys`. Now curly braces aren't necessary when the wrapped value is a Hash (flash-gordon)
   ```ruby
@@ -36,28 +93,30 @@
   in Success(code: 200...300) then :ok
   end
   ```
+- ## Internal
+- Performance of do notation was improved for failing cases (1.2x to 1.3x on synthetic benchmarks) (flash-gordon)
 
-## Internal
+### Fixed
+
+- Warnings about keywords from Ruby 2.7 (flash-gordon)
 
-- Performance of do notation was improved for failing cases (1.2x to 1.3x on synthetic benchmarks) (flash-gordon)
 
 [Compare v1.3.1...v1.3.2](https://github.com/dry-rb/dry-monads/compare/v1.3.1...v1.3.2)
 
-# v1.3.1 2019-09-07
+## 1.3.1 2019-09-07
 
-## Fixed
+
+### Fixed
 
 - Added missing `None#maybe` :sweat_smile: (flash-gordon)
 
-[Compare v1.3.0...v1.3.1](https://github.com/dry-rb/dry-monads/compare/v1.3.0...v1.3.1)
 
-# v1.3.0 2019-08-03
+[Compare v1.3.0...v1.3.1](https://github.com/dry-rb/dry-monads/compare/v1.3.0...v1.3.1)
 
-## BREAKING CHANGES
+## 1.3.0 2019-08-03
 
-- Support for Ruby 2.3 was dropped.
 
-## Added
+### Added
 
 - `Result#either` (waiting-for-dev)
   ```ruby
@@ -101,7 +160,6 @@
     Dry::Monads.Success(a + b)
   end
   ```
-
 - `{Some,Success,Failure}#[]` shortcuts for building arrays wrapped within monadic value (flash-gordon)
   ```ruby
   Success[1, 2] # => Success([1, 2])
@@ -117,7 +175,6 @@
     end
   end # => List[1, 2, 3, 4, 5]
   ```
-
 - Experimental support for pattern matching! :tada: (flash-gordon)
 
   ```ruby
@@ -140,15 +197,13 @@
 
   Keep in mind this feature is experimental and can be changed by 2.7 release. But it rocks already!
 
-[Compare v1.2.0...v1.3.0](https://github.com/dry-rb/dry-monads/compare/v1.2.0...v1.3.0)
 
-# v1.2.0 2019-01-12
+[Compare v1.2.0...v1.3.0](https://github.com/dry-rb/dry-monads/compare/v1.2.0...v1.3.0)
 
-## BREAKING CHANGES
+## 1.2.0 2019-01-12
 
-- Support for Ruby 2.2 was dropped. Ruby 2.2 reached its EOL on March 31, 2018.
 
-## Added
+### Added
 
 - Most of constructors now have `call` alias so you can compose them with Procs nicely if you've switched to Ruby 2.6 (flash-gordon)
   ```ruby
@@ -177,7 +232,6 @@
   List[Some(5), None(), Some(3)].collect.map { |x| x * 2 }
   # => [10, 6]
   ```
-
 - Right-biased monads got `#flatten` and `#and` (falsh-gordon)
 
   `#flatten` removes one level of monadic structure, it's useful when you're dealing with things like `Maybe` of `Maybe` of something:
@@ -209,7 +263,6 @@
   Some(5).and(None()) # => None()
   None().and(Some(5)) # => None()
   ```
-
 - Concise imports with `Dry::Monads.[]`. You're no longer required to require all desired monads and include them one-by-one, the `[]` method handles it for you (flash-gordon)
 
   ```ruby
@@ -234,18 +287,15 @@
     end
   end
   ```
-
 - `Task.failed` is a counterpart of `Task.pure`, accepts an exception and returns a failed task immediately (flash-gordon)
 
-[Compare v1.1.0...v1.2.0](https://github.com/dry-rb/dry-monads/compare/v1.1.0...v1.2.0)
 
-# v1.1.0 2018-10-16
+[Compare v1.1.0...v1.2.0](https://github.com/dry-rb/dry-monads/compare/v1.1.0...v1.2.0)
 
-## Fixed
+## 1.1.0 2018-10-16
 
-- Do notation was made to work nicely with inheritance. This shouldn't break any existing code but if it does please report (flash-gordon)
 
-## Added
+### Added
 
 - `Success()`, `Failure()`, and `Some()` now have `Unit` as a default argument:
 
@@ -261,26 +311,34 @@
   end
   ```
 
-[Compare v1.0.1...v1.1.0](https://github.com/dry-rb/dry-monads/compare/v1.0.1...v1.1.0)
+### Fixed
 
-# v1.0.1 2018-08-11
+- Do notation was made to work nicely with inheritance. This shouldn't break any existing code but if it does please report (flash-gordon)
 
-## Fixed
 
-- Fixed behavior of `List<Validated>#traverse` in presence of `Valid` values (flash-gordon + SunnyMagadan)
+[Compare v1.0.1...v1.1.0](https://github.com/dry-rb/dry-monads/compare/v1.0.1...v1.1.0)
 
-## Added
+## 1.0.1 2018-08-11
+
+
+### Added
 
 - `to_proc` was added to value constructors (flash-gordon)
   ```ruby
   [1, 2, 3].map(&Some) # => [Some(1), Some(2), Some(3)]
   ```
 
+### Fixed
+
+- Fixed behavior of `List<Validated>#traverse` in presence of `Valid` values (flash-gordon + SunnyMagadan)
+
+
 [Compare v1.0.0...v1.0.1](https://github.com/dry-rb/dry-monads/compare/v1.0.0...v1.0.1)
 
-# v1.0.0 2018-06-26
+## 1.0.0 2018-06-26
 
-## Added
+
+### Added
 
 - `do`-like notation (the idea comes from Haskell of course). This is the biggest and most important addition to the release which greatly increases the ergonomics of using monads in Ruby. Basically, almost everything it does is passing a block to a given method. You call `yield` on monads to extract the values. If any operation fails i.e. no value can be extracted, the whole computation is halted and the failing step becomes a result. With `Do` you don't need to chain monadic values with `fmap/bind` and block, everything can be done on a single level of indentation. Here is a more or less real-life example:
 
@@ -332,7 +390,6 @@
   ```
 
   In the code above any `yield` can potentially fail and return the failure reason as a result. In other words, `yield None` acts as `return None`. Internally, `Do` uses exceptions, not `return`, this is somewhat slower but allows to detect failed operations in DB-transactions and roll back the changes which far more useful than an unjustifiable speed boost (flash-gordon)
-
 - The `Task` monad based on `Promise` from the [`concurrent-ruby` gem](https://github.com/ruby-concurrency/concurrent-ruby/). `Task` represents an asynchronous computation which _can be_ (doesn't have to!) run on a separated thread. `Promise` already offers a good API and implemented in a safe manner so `dry-monads` just adds a monad-compatible interface for it. Out of the box, `concurrent-ruby` has three types of executors for running blocks: `:io`, `:fast`, `:immediate`, check out [the docs](http://ruby-concurrency.github.io/concurrent-ruby/root/Concurrent.html#executor-class_method) for details. You can provide your own executor if needed (flash-gordon)
 
   ```ruby
@@ -358,9 +415,7 @@
     Success(create(e, n))
   end
   ```
-
 - `Lazy` is a copy of `Task` that isn't run until you ask for the value _for the first time_. It is guaranteed the evaluation is run at most once as opposed to lazy assignment `||=` which isn't synchronized. `Lazy` is run on the same thread asking for the value (flash-gordon)
-
 - Automatic type inference with `.typed` for lists was deprecated. Instead, typed list builders were added
 
   ```ruby
@@ -369,7 +424,6 @@
   ```
 
   The code above runs two tasks in parallel and automatically combines their results with `traverse` (flash-gordon)
-
 - `Try` got a new call syntax supported in Ruby 2.5+
 
   ```ruby
@@ -377,7 +431,6 @@
   ```
 
   Prior to 2.5, it wasn't possible to pass a block to `[]`.
-
 - The `Validated` “monad” that represents a result of a validation. Suppose, you want to collect all the errors and return them at once. You can't have it with `Result` because when you `traverse` a `List` of `Result`s it returns the first value and this is the correct behavior from the theoretical point of view. `Validated`, in fact, doesn't have a monad instance but provides a useful variant of applicative which concatenates the errors.
 
   ```ruby
@@ -401,13 +454,11 @@
   ```
 
   In the example above an array of `Validated` values is implicitly coerced to `List::Validated`. It's supported because it's useful but don't forget it's all about types so don't mix different types of monads in a single array, the consequences are unclear. You always can be explicit with `List::Validated[validate_name(...), ...]`, choose what you like (flash-gordon).
-
 - `Failure`, `None`, and `Invalid` values now store the line where they were created. One of the biggest downsides of dealing with monadic code is lack of backtraces. If you have a long list of computations and one of them fails how do you know where did it actually happen? Say, you've got `None` and this tells you nothing about _what variable_ was assigned to `None`. It makes sense to use `Result` instead of `Maybe` and use distinct errors everywhere but it doesn't always look good and forces you to think more. TLDR; call `.trace` to get the line where a fail-case was constructed
 
   ```ruby
   Failure(:invalid_name).trace # => app/operations/create_user.rb:43
   ```
-
 - `Dry::Monads::Unit` which can be used as a replacement for `Success(nil)` and in similar situations when you have side effects yet doesn't return anything meaningful as a result. There's also the `.discard` method for mapping any successful result (i.e. `Success(?)`, `Some(?)`, `Value(?)`, etc) to `Unit`.
 
   ```ruby
@@ -417,26 +468,19 @@
     # ... wait for the task to finish ...
     # => Task(valut=Unit)
   ```
-
-## Deprecations
-
+- ## Deprecations
 - `Either`, the former name of `Result`, is now deprecated
-
-## BREAKING CHANGES
-
+- ## BREAKING CHANGES
 - `Either#value` and `Maybe#value` were both droped, use `value_or` or `value!` when you :100: sure it's safe
 - `require 'dry/monads'` doesn't load all monads anymore, use `require 'dry/monads/all'` instead or cherry pick them with `require 'dry/monads/maybe'` etc (timriley)
 
-[Compare v0.4.0...v1.0.0](https://github.com/dry-rb/dry-monads/compare/v0.4.0...v1.0.0)
 
-# v0.4.0 2017-11-11
+[Compare v0.4.0...v1.0.0](https://github.com/dry-rb/dry-monads/compare/v0.4.0...v1.0.0)
 
-## Changed
+## 0.4.0 2017-11-11
 
-- The `Either` monad was renamed to `Result` which sounds less nerdy but better reflects the purpose of the type. `Either::Right` became `Result::Success` and `Either::Left` became `Result::Failure`. This change is backward-compatible overall but you will see the new names when using old `Left` and `Right` methods (citizen428)
-- Consequently, `Try::Success` and `Try::Failure` were renamed to `Try::Value` and `Try::Error` (flash-gordon)
 
-## Added
+### Added
 
 - `Try#or`, works as `Result#or` (flash-gordon)
 - `Maybe#success?` and `Maybe#failure?` (aliases for `#some?` and `#none?`) (flash-gordon)
@@ -451,24 +495,30 @@
     else raise TypeError
     end
   ```
+- ## Deprecated
+- Direct accessing `value` on right-biased monads has been deprecated, use the `value!` method instead. `value!` will raise an exception if it is called on a Failure/None/Error instance (flash-gordon)
 
-## Deprecated
+### Changed
 
-- Direct accessing `value` on right-biased monads has been deprecated, use the `value!` method instead. `value!` will raise an exception if it is called on a Failure/None/Error instance (flash-gordon)
+- The `Either` monad was renamed to `Result` which sounds less nerdy but better reflects the purpose of the type. `Either::Right` became `Result::Success` and `Either::Left` became `Result::Failure`. This change is backward-compatible overall but you will see the new names when using old `Left` and `Right` methods (citizen428)
+- Consequently, `Try::Success` and `Try::Failure` were renamed to `Try::Value` and `Try::Error` (flash-gordon)
 
 [Compare v0.3.1...v0.4.0](https://github.com/dry-rb/dry-monads/compare/v0.3.1...v0.4.0)
 
-# v0.3.1 2017-03-18
+## 0.3.1 2017-03-18
 
-## Fixed
+
+### Fixed
 
 - Fixed unexpected coercing to `Hash` on `.bind` call (flash-gordon)
 
+
 [Compare v0.3.0...v0.3.1](https://github.com/dry-rb/dry-monads/compare/v0.3.0...v0.3.1)
 
-# v0.3.0 2017-03-16
+## 0.3.0 2017-03-16
 
-## Added
+
+### Added
 
 - Added `Either#either` that accepts two callbacks, runs the first if it is `Right` and the second otherwise (nkondratyev)
 - Added `#fmap2` and `#fmap3` for mapping over nested structures like `List Either` and `Either Some` (flash-gordon)
@@ -478,59 +528,69 @@
 - Added `List#traverse` that "flips" the list with an embedded monad (flash-gordon + damncabbage)
 - Added `#tee` for all right-biased monads (flash-gordon)
 
+
 [Compare v0.2.1...v0.3.0](https://github.com/dry-rb/dry-monads/compare/v0.2.1...v0.3.0)
 
-# v0.2.1 2016-11-13
+## 0.2.1 2016-11-13
+
 
-## Added
+### Added
 
 - Added `Either#tee` that is similar to `Object#tap` but executes the block only for `Right` instances (saverio-kantox)
 
-## Fixed
+### Fixed
 
 - `Right(nil).to_maybe` now returns `None` with a warning instead of failing (orisaka)
 - `Some#value_or` doesn't require an argument because `None#value_or` doesn't require it either if a block was passed (flash-gordon)
 
+
 [Compare v0.2.0...v0.2.1](https://github.com/dry-rb/dry-monads/compare/v0.2.0...v0.2.1)
 
-# v0.2.0 2016-09-18
+## 0.2.0 2016-09-18
+
 
-## Added
+### Added
 
 - Added `Maybe#to_json` as an opt-in extension for serialization to JSON (rocknruby)
 - Added `Maybe#value_or` which returns you the underlying value with a fallback in a single method call (dsounded)
 
+
 [Compare v0.1.1...v0.2.0](https://github.com/dry-rb/dry-monads/compare/v0.1.1...v0.2.0)
 
-# v0.1.1 2016-08-25
+## 0.1.1 2016-08-25
 
-## Fixed
+
+### Fixed
 
 - Added explicit requires of `dry-equalizer`. This allows to safely load only specific monads (artofhuman)
 
+
 [Compare v0.1.0...v0.1.1](https://github.com/dry-rb/dry-monads/compare/v0.1.0...v0.1.1)
 
-# v0.1.0 2016-08-23
+## 0.1.0 2016-08-23
+
 
-## Added
+### Added
 
 - Support for passing extra arguments to the block in `.bind` and `.fmap` (flash-gordon)
 
-## Changed
+### Changed
 
 - Dropped MRI 2.0 support (flash-gordon)
 
 [Compare v0.0.2...v0.1.0](https://github.com/dry-rb/dry-monads/compare/v0.0.2...v0.1.0)
 
-# v0.0.2 2016-06-29
+## 0.0.2 2016-06-29
 
-## Added
+
+### Added
 
 - Added `Either#to_either` so that you can rely on duck-typing when you work with different types of monads (timriley)
 - Added `Maybe#to_maybe` for consistency with `#to_either` (flash-gordon)
 
+
 [Compare v0.0.1...v0.0.2](https://github.com/dry-rb/dry-monads/compare/v0.0.1...v0.0.2)
 
-# v0.0.1 2016-05-02
+## 0.0.1 2016-05-02
 
 Initial release containing `Either`, `Maybe`, and `Try` monads.