Thoughs on Ruby libraries design

Transcript

1. Thoughts on Ruby libraries design 1
2. Library • Fulfils its purpose • No negative effects on the target code • (Optional) Simple and extendable code 2
3. • Libraries may conflict with other parts of your code • Clash top-level constant names • Incompatible versions of mutual dependencies • Change the target code process behaviour Negative effects 3
4. Dependencies 4
5. Dependencies 5
6. Version locking 6
7. • Versioning is important: • Change-logs • Semantic versioning • Back-porting • Optimistic vs. Pessimistic version lock Dependencies 7
8. Top-level constants 8
9. Integration 9
10. Faraday::Typheus 10
11. Faraday::Typheus 11
12. Faraday::Typheus 12
17. Ran for 2 hrs 3 min 3sec. Total time 10 hrs 16 min 5 sec 17
18. Environment variables • The process attribute • Should not be used inside a library code directly 18
19. Environment variables 19
21. Example: Redis 21
22. Example: Redis 22
23. Optional dependency 23
24. Core extensions 24
25. vs. Core extensions 25
30. Consider harmful • Extra dependencies • Out of scope work (configuration of 3-rd libs) • Process modification (at_exit, signal traps) • Singleton and/or global (class level) configuration • Monkey patches • Common names of top-level modules 30
31. Thanks! 31 re.vkolesnikov@gmail.com Moscow 2019