Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Normalize Temperature arithmetic #550

Merged
merged 6 commits into from
Nov 8, 2018
Merged

Conversation

angularsen
Copy link
Owner

Fixes #518

  • Generate default arithmetic (no special case returning TemperatureDelta)
  • Remove Multiply() and Divide() methods
  • Remove custom - operator overload
  • Add Temperature.ToDelta(other) instance method
  • Add TemperatureDelta.FromTemperatures(left, right) static method

@angularsen angularsen requested a review from tmilnthorp November 4, 2018 11:24
@angularsen
Copy link
Owner Author

@Mobz87 If you could look over this too, that would be great!

@angularsen angularsen added this to the 4.0 milestone Nov 4, 2018
@angularsen angularsen mentioned this pull request Nov 4, 2018
25 tasks
public static TemperatureDelta FromTemperatures(Temperature left, Temperature right)
{
// TemperatureDeltaUnit enum has identical values to TemperatureUnit, so we can simply cast between them
return new TemperatureDelta(left.Value - right.As(left.Unit), (TemperatureDeltaUnit)left.Unit);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A straight enum cast relies on the ordering in the json file. Perhaps a switch would be better?

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess, I figured since they were generated it would be safe. How about instead enum value ToString() and enum parse? Then it will throw if they are not identical.

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tmilnthorp Pushed new commit with a new ToDeltaUnit() method.

Use ToString() and Enum.Parse() to get slightly more
robust conversion without having to generate a switch
statement for all cases.
@angularsen
Copy link
Owner Author

Self-merging this now just to get a beta nuget out. @tmilnthorp Please let me know if you have some reservations on my latest change.

@angularsen angularsen merged commit b0361ba into v4 Nov 8, 2018
@angularsen angularsen deleted the v4-temperature-arithmetic branch November 8, 2018 20:13
angularsen added a commit that referenced this pull request Nov 16, 2018
This reverts commit b0361ba.

Per discussion in:
#560 (comment)

We can't justify this change just yet, we need to know if the majority
of our userbase expects this new Temperature arithmetic or the old one.
@angularsen angularsen mentioned this pull request Nov 16, 2018
@angularsen
Copy link
Owner Author

Reverted #550 in 71bc0a8.

@angularsen angularsen mentioned this pull request Nov 22, 2018
angularsen added a commit that referenced this pull request Dec 16, 2018
# 4.0.0 Release
This PR will serve as the list of items to complete and it will be updated to show the progress before finally merged into `master` when completed. We all have busy schedules, so **if you want to help move this work forward then that is much appreciated!** 

## The main theme is to reduce binary size
In two years it has grown from 280 kB to 1.4 MB and a lot of it is due to unnecessary syntactic sugar with many method overloads for various number types and nullable types - for every of our 800+ units! It simply adds up to a big total.

These items are chosen from #180, trying to include as many of the low hanging fruits as possible, while still keeping the list short and realistic to complete in a reasonably short time - we are all busy in our daily lives. We can always have more major version bumps later than trying to perfect it all now.

## Feature complete before November, merged before mid-December
I would like to aim for a "beta" pre-release nuget sometime in October with all the items completed, so we can have some time to test it before releasing the final, stable 4.0.0 version before Christmas holidays.
We should have the work items list more or less final before Monday, October 8th.

## Changes
#### Added
- [x] UnitSystem with a different meaning, now defines the base units for a unit system (#524)

#### Removed
- [x] Replace netstandard1.0 target with netstandard2.0, to avoid the extra dependencies (#477)
- [x] Remove code marked as `[Obsolete]`, such as `VolumeUnit.Teaspoon`  (#490)
- [x] Remove nullable `From` factory methods (#483)
- [x] Remove extension methods on _nullable_ number types (#483)
- [x] Remove all number extension methods (#497)
- [x] Remove `Length2d`, replaced by `Area` (#501)
- [x] Remove static methods on `UnitSystem`, should use `UnitSystem.Default` instead (#496)
- [x] Remove unit parameter from `ToString()` methods (#546)

#### Changed
- [x] Throw exception on NaN values in static constructor methods, like `FromMeters()` (#502, see #176 (comment))
- [x] Throw if unit was not specified when constructing quantities, (#499 - #389 (comment))
- [x] Stricter parsing (#343 and #180 (comment))
- [x] Remove unit parameter from `ToString()` methods (#546)
- [x] Change Temperature arithmetic back to use base unit Kelvin (#550, see #518)

#### Renamed
- [x] Correct SingularName for some Flow unit definitions (#494, see #360)
- [x] Split/rename UnitSystem into UnitParser, GlobalConfiguration, UnitAbbreviationsCache (#511)

#### Fixed
- [x] Search for any TODO comments in the code to address, remove comment and either fix or create issue (5d24432)
- [x] Update README with v4 changes #498
- [x] Do not try/catch in UnitConverter.Try-methods (#506)
- [x] Do not try/catch in `Length.TryParse()` and for other quantities (#507)
- [x] Add/update changelog in wiki for v4 with some summary copied from this issue, some v3 to v4 migration instructions and briefly explain why some stuff were removed

## Milestones
- [x] Finalize work items list (Monday, October 8)
- [x] Release 4.0.0-beta1, feature complete (Wednesday, October 31)
- [ ] ~Show release notes and upgrade guide when upgrading to 4.x nuget, if possible~
- [x] Release 4.0.0 (Monday, December 17)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants