|
| 1 | +# Changelog |
| 2 | + |
| 3 | +All notable changes to this project will be documented in this file. |
| 4 | + |
| 5 | +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), |
| 6 | +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). |
| 7 | + |
| 8 | +## [Unreleased] |
| 9 | + |
| 10 | +### Added |
| 11 | + |
| 12 | +- Accept any Enumerable (not just Hash or Array) as form data input for both |
| 13 | + `Multipart` and `Urlencoded` encoders. This enables lazy enumerators and |
| 14 | + custom collections as input. |
| 15 | +- `FormData.ensure_data` for coercing input to an Enumerable of key-value pairs. |
| 16 | +- Array of pairs input for `Multipart`, allowing duplicate parameter names and |
| 17 | + preserved ordering. |
| 18 | +- Array of pairs input for `Urlencoded`, preserving duplicate keys. |
| 19 | +- RBS type signatures for all public and private APIs. |
| 20 | +- `sig/` directory shipped in the gem for downstream type checking. |
| 21 | +- `homepage_uri`, `source_code_uri`, `bug_tracker_uri`, and `documentation_uri` |
| 22 | + gemspec metadata. |
| 23 | + |
| 24 | +### Changed |
| 25 | + |
| 26 | +- Default urlencoded encoder replaced with a custom implementation that supports |
| 27 | + nested Hashes and Arrays (e.g., `{foo: {bar: "baz"}}` encodes as |
| 28 | + `foo[bar]=baz`). Previously used `URI.encode_www_form`. |
| 29 | +- `FormData.ensure_hash` no longer treats `nil` as a special case; `nil.to_h` |
| 30 | + returns `{}` which is used instead. |
| 31 | + |
| 32 | +### Removed |
| 33 | + |
| 34 | +- Ruby < 3.2 support. |
| 35 | +- Explicit JRuby support. |
| 36 | + |
| 37 | +## [2.3.0] - 2020-03-08 |
| 38 | + |
| 39 | +### Added |
| 40 | + |
| 41 | +- Per-instance encoder for `HTTP::FormData::Urlencoded`. |
| 42 | + ([#29](https://github.com/httprb/form_data/pull/29) by [@summera]) |
| 43 | + |
| 44 | +## [2.2.0] - 2020-01-09 |
| 45 | + |
| 46 | +### Fixed |
| 47 | + |
| 48 | +- Ruby 2.7 compatibility. |
| 49 | + ([#28](https://github.com/httprb/form_data/pull/28) by [@janko]) |
| 50 | + |
| 51 | +## [2.1.1] - 2018-06-01 |
| 52 | + |
| 53 | +### Added |
| 54 | + |
| 55 | +- Allow overriding urlencoded form data encoder. |
| 56 | + ([#23](https://github.com/httprb/form_data/pull/23) by [@FabienChaynes]) |
| 57 | + |
| 58 | +## [2.1.0] - 2018-03-05 |
| 59 | + |
| 60 | +### Fixed |
| 61 | + |
| 62 | +- Rewind content at the end of `Readable#to_s`. |
| 63 | + ([#21](https://github.com/httprb/form_data/pull/21) by [@janko-m]) |
| 64 | +- Buffer encoding. |
| 65 | + ([#19](https://github.com/httprb/form_data/pull/19) by [@HoneyryderChuck]) |
| 66 | + |
| 67 | +## [2.0.0] - 2017-10-01 |
| 68 | + |
| 69 | +### Fixed |
| 70 | + |
| 71 | +- Add CRLF character to end of multipart body. |
| 72 | + ([#17](https://github.com/httprb/form_data/pull/17) by [@mhickman]) |
| 73 | + |
| 74 | +## [2.0.0.pre2] - 2017-05-11 |
| 75 | + |
| 76 | +### Added |
| 77 | + |
| 78 | +- Streaming for urlencoded form data. |
| 79 | + ([#14](https://github.com/httprb/form_data/pull/14) by [@janko-m]) |
| 80 | + |
| 81 | +## [2.0.0.pre1] - 2017-05-10 |
| 82 | + |
| 83 | +### Added |
| 84 | + |
| 85 | +- Form data streaming. |
| 86 | + ([#12](https://github.com/httprb/form_data.rb/pull/12) by [@janko-m]) |
| 87 | + |
| 88 | +## [1.0.2] - 2017-05-08 |
| 89 | + |
| 90 | +### Added |
| 91 | + |
| 92 | +- Allow setting Content-Type on non-file parts. |
| 93 | + ([#5](https://github.com/httprb/form_data.rb/issues/5) by [@abotalov]) |
| 94 | +- Creation of file parts without filename. |
| 95 | + ([#6](https://github.com/httprb/form_data.rb/issues/6) by [@abotalov]) |
| 96 | + |
| 97 | +### Deprecated |
| 98 | + |
| 99 | +- `HTTP::FormData::File#mime_type`. Use `#content_type` instead. |
| 100 | + ([#11](https://github.com/httprb/form_data.rb/pull/11) by [@ixti]) |
| 101 | + |
| 102 | +## [1.0.1] - 2015-03-31 |
| 103 | + |
| 104 | +### Fixed |
| 105 | + |
| 106 | +- Usage of URI module. |
| 107 | + |
| 108 | +## [1.0.0] - 2015-01-04 |
| 109 | + |
| 110 | +### Changed |
| 111 | + |
| 112 | +- Gem renamed to `http-form_data` as `FormData` is no longer a top-level |
| 113 | + constant: `FormData` → `HTTP::FormData`. |
| 114 | + |
| 115 | +## [0.1.0] - 2015-01-02 |
| 116 | + |
| 117 | +### Added |
| 118 | + |
| 119 | +- `nil` support to `FormData#ensure_hash`. |
| 120 | + |
| 121 | +### Changed |
| 122 | + |
| 123 | +- Moved repo under `httprb` organization on GitHub. |
| 124 | + |
| 125 | +## [0.0.1] - 2014-12-15 |
| 126 | + |
| 127 | +### Added |
| 128 | + |
| 129 | +- Initial release. |
| 130 | + |
| 131 | +[Unreleased]: https://github.com/httprb/form_data/compare/v2.3.0...HEAD |
| 132 | +[2.3.0]: https://github.com/httprb/form_data/compare/v2.2.0...v2.3.0 |
| 133 | +[2.2.0]: https://github.com/httprb/form_data/compare/v2.1.1...v2.2.0 |
| 134 | +[2.1.1]: https://github.com/httprb/form_data/compare/v2.1.0...v2.1.1 |
| 135 | +[2.1.0]: https://github.com/httprb/form_data/compare/v2.0.0...v2.1.0 |
| 136 | +[2.0.0]: https://github.com/httprb/form_data/compare/v2.0.0.pre2...v2.0.0 |
| 137 | +[2.0.0.pre2]: https://github.com/httprb/form_data/compare/v2.0.0.pre1...v2.0.0.pre2 |
| 138 | +[2.0.0.pre1]: https://github.com/httprb/form_data/compare/v1.0.2...v2.0.0.pre1 |
| 139 | +[1.0.2]: https://github.com/httprb/form_data/compare/v1.0.1...v1.0.2 |
| 140 | +[1.0.1]: https://github.com/httprb/form_data/compare/v1.0.0...v1.0.1 |
| 141 | +[1.0.0]: https://github.com/httprb/form_data/compare/v0.1.0...v1.0.0 |
| 142 | +[0.1.0]: https://github.com/httprb/form_data/compare/v0.0.1...v0.1.0 |
| 143 | +[0.0.1]: https://github.com/httprb/form_data/releases/tag/v0.0.1 |
| 144 | + |
| 145 | +[@abotalov]: https://github.com/abotalov |
| 146 | +[@FabienChaynes]: https://github.com/FabienChaynes |
| 147 | +[@HoneyryderChuck]: https://github.com/HoneyryderChuck |
| 148 | +[@ixti]: https://github.com/ixti |
| 149 | +[@janko]: https://github.com/janko |
| 150 | +[@janko-m]: https://github.com/janko-m |
| 151 | +[@mhickman]: https://github.com/mhickman |
| 152 | +[@summera]: https://github.com/summera |
0 commit comments