Skip to content

Commit 75b912f

Browse files
committed
Update changelog for v0.5.0
1 parent f9c491b commit 75b912f

File tree

1 file changed

+78
-0
lines changed

1 file changed

+78
-0
lines changed

CHANGELOG.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,83 @@
11
# Changelog
22

3+
## 0.5.0 - 2020-06-18
4+
5+
### Breaking changes
6+
7+
* Do some reorganizing and rename some concepts in the code: "operational
8+
sequencer" changes to "operation tree builder" and "operation sequence"
9+
changes to "operation tree". Although super_diff is not yet at 1.0, this does
10+
result in breaking changes to the API, so:
11+
12+
* If you are inheriting from `SuperDiff::OperationalSequencers::*`, you will
13+
want to now inherit from `SuperDiff::OperationTreeBuilders::*`.
14+
* If you are inheriting from `SuperDiff::OperationSequence::*`, you will
15+
want to now inherit from `SuperDiff::OperationTrees::*`.
16+
* If you are configuring the gem by saying:
17+
18+
``` ruby
19+
SuperDiff::RSpec.configuration do |config|
20+
config.add_extra_operational_sequencer_class(SomeClass)
21+
config.add_extra_operation_sequence_class(SomeClass)
22+
end
23+
```
24+
25+
you will want to change this to:
26+
27+
``` ruby
28+
SuperDiff::RSpec.configuration do |config|
29+
config.add_extra_operation_tree_builder_class(SomeClass)
30+
config.add_extra_operation_tree_class(SomeClass)
31+
end
32+
```
33+
34+
([#84], [#85])
35+
36+
[#84]: https://github.com/mcmire/super_diff/pull/84
37+
[#85]: https://github.com/mcmire/super_diff/pull/85
38+
39+
### Features
40+
41+
* Add inspectors for `an_instance_of`, `a_kind_of`, and `a_value_within`.
42+
([#74])
43+
44+
[#74]: https://github.com/mcmire/super_diff/pull/74
45+
46+
### Bug fixes
47+
48+
* Get rid of warnings produced on Ruby 2.7.1. ([#71])
49+
* Fix diff produced by (incorrect) usage of `have_attributes` with a hash as the
50+
actual value. ([#76])
51+
52+
[#71]: https://github.com/mcmire/super_diff/pull/71
53+
[#76]: https://github.com/mcmire/super_diff/pull/76
54+
55+
### Improvements
56+
57+
* Move configuration so that instead of using
58+
59+
``` ruby
60+
SuperDiff::RSpec.configure do |config|
61+
# ...
62+
end
63+
```
64+
65+
you can now say:
66+
67+
``` ruby
68+
SuperDiff.configure do |config|
69+
# ...
70+
end
71+
```
72+
73+
([#80])
74+
75+
* Update diff between two hashes so that original ordering of keys is preserved.
76+
([#81])
77+
78+
[#80]: https://github.com/mcmire/super_diff/pull/81
79+
[#81]: https://github.com/mcmire/super_diff/pull/81
80+
381
## 0.4.2 - 2020-02-11
482

583
### Bug fixes

0 commit comments

Comments
 (0)