`ocean.core.Verify` #214

mihails-strasuns-sociomantic · 2017-08-16T10:08:01Z

Starting point for #212

gavin-norman-sociomantic · 2017-08-16T10:09:36Z

src/ocean/core/Verify.d

+
+module ocean.core.Verify;
+
+import ocean.meta.


gavin-norman-sociomantic · 2017-08-16T10:10:14Z

src/ocean/core/Verify.d

+
+public void verify ( bool ok, lazy istring msg,
+    istring file = __FILE__, int line = __LINE__ )
+{


Empty body?

gavin-norman-sociomantic · 2017-08-16T10:11:06Z

Ah parts of the 2nd commit need to be squashed into the 1st.

codecov · 2017-08-16T10:12:44Z

Codecov Report

Merging #214 into v2.x.x will increase coverage by <.01%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           v2.x.x     #214      +/-   ##
==========================================
+ Coverage   68.19%   68.19%   +<.01%     
==========================================
  Files         466      467       +1     
  Lines       40564    40569       +5     
==========================================
+ Hits        27662    27668       +6     
+ Misses      12902    12901       -1

mihails-strasuns-sociomantic · 2017-08-16T10:12:48Z

Oops, should be fixed now.

nemanja-boric-sociomantic · 2017-08-16T10:12:51Z

src/ocean/core/Verify.d

+///
+unittest
+{
+    try


testThrown?

Extra import, thus avoided.

Yes, I was just going to say that 👍

Not really a usage example. I'd remove the ///

nemanja-boric-sociomantic · 2017-08-16T11:09:51Z

src/ocean/core/Verify.d

+    be used in place of `assert` freely without introducing cyclic imports.
+
+    Copyright:
+        Copyright (c) 2017 Sociomantic Labs GmbH.


nitpick, copyright should be verbatim:

Copyright (c) 2017 sociomantic labs GmbH. All rights reserved

(apparently, it's case sensitive)

leandro-lucarella-sociomantic · 2017-08-16T12:19:38Z

relnotes/verify.feature.md

+* `ocean.core.Verify`
+
+  New module with a single function, `verify`, intended to serve as drop-in
+  replacement for `assert` to comply to Sociomantic assert/enforce policies.


I would explain the reasons for it a bit more, or at least link to the relevant issue where it is explained.

AFAIK out assert-vs-enforce guide is not available in public place anywhere. Would be nice to do that so it can be linked.

Would https://github.com/sociomantic-tsunami/neptune be a good place for it (or is it purely versioning related)?

Looks like it is only versioning related. Its README says:

Neptune is a set of guidelines and tools to help developers and users to implement a versioning scheme based on SemVer.

Yes, neptune is 100% about out usage of SemVer and related tools. General coding guidelines don't fit there.

Maybe in https://github.com/sociomantic-tsunami/sociomantic or https://github.com/sociomantic-tsunami/tsunami?

Former looks applicable 👍

sociomantic-tsunami/sociomantic#2

leandro-lucarella-sociomantic · 2017-08-16T12:38:32Z

src/ocean/core/Verify.d

+
+*******************************************************************************/
+
+public class SanityException : Exception


I don't want to start a bike shed war, but I wonder why you didn't go for ProgrammingException or if there was any discussion about the name.

There was no specific discussion, I picked the name because I was already using this name in other places to name things with such purpose. I believe it is a more generic and thus correct term than ProgrammingException because cases when we would want to use it may also detect architecture issues or serious violations from trusted input source (like DHT).

leandro-lucarella-sociomantic · 2017-08-16T12:39:27Z

src/ocean/task/Scheduler.d

@@ -30,6 +30,7 @@ import core.thread;

 import ocean.transition;
 import ocean.core.Enforce;


Is enforce still needed here?

Yep, there are also regular exceptions in scheduler.

mihails-strasuns-sociomantic · 2017-08-17T12:59:13Z

Updated with a bit more extensive release notes and fixed copyright/ddoc.

mihails-strasuns-sociomantic · 2017-08-21T09:35:05Z

@gavin-norman-sociomantic it was added per your request so please do the honors of final acceptance ;)

gavin-norman-sociomantic · 2017-08-21T10:19:37Z

relnotes/verify.feature.md

+
+  New module with a single function, `verify`, intended to serve as drop-in
+  replacement for `assert` to comply to [Sociomantic assert/enforce
+  policies](https://github.com/sociomantic-tsunami/sociomantic/blob/master/Code/assert_vs_enforce.md)


Has this url been discussed? As this is at the top level of sociomantic-tsunami, I would have thought some indication of which programming language this relates to would be good.

We'll need to adapt the guidelines to specifically address usage of assert vs enforce vs verify, but we can do that later.

Has this url been discussed?

I expected to get some suggestion how to name it from @dylan-cromwell-sociomantic but he merged it with this URL :P

Adapting guideline is planned after this is merged.

he merged it with this URL :P

404, though...?

Oops, md vs rst. Updating.

@mihails-strasuns-sociomantic @gavin-norman-sociomantic normally I would take more time to discuss the structure but I trust your judgement and simply don't have the bandwidth right now. Please do propose a language-based structure if need be.

👍 We can discuss a better structure. The main thing is that we have it in tsunami now.

Yup, awesome. I think that relying on me (one person) for reviewing structure of things even in that single repo is going to be too much of a bottleneck considering that we would want me to continue to focus on the overall strategy and setup of the program itself. But of course, if you like to discuss or need any feedback at all, I am super happy to comply, just poke me!

Fixes sociomantic-tsunami#213

mihails-strasuns-sociomantic requested review from leandro-lucarella-sociomantic and gavin-norman-sociomantic August 16, 2017 10:08

mihails-strasuns-sociomantic added this to the v2.10.0 milestone Aug 16, 2017

mihails-strasuns-sociomantic added the type-feature label Aug 16, 2017

gavin-norman-sociomantic reviewed Aug 16, 2017

View reviewed changes

mihails-strasuns-sociomantic force-pushed the verify branch from 48387f5 to 1510ade Compare August 16, 2017 10:12

nemanja-boric-sociomantic reviewed Aug 16, 2017

View reviewed changes

mihails-strasuns-sociomantic force-pushed the verify branch from 1510ade to 6fdb331 Compare August 16, 2017 10:13

nemanja-boric-sociomantic reviewed Aug 16, 2017

View reviewed changes

leandro-lucarella-sociomantic reviewed Aug 16, 2017

View reviewed changes

mihails-strasuns-sociomantic force-pushed the verify branch from 6fdb331 to 0b7e0a8 Compare August 17, 2017 12:58

mihails-strasuns-sociomantic assigned gavin-norman-sociomantic Aug 21, 2017

gavin-norman-sociomantic reviewed Aug 21, 2017

View reviewed changes

mihails-strasuns-sociomantic added 2 commits August 21, 2017 13:43

Implement ocean.core.Verify

5ed6c7a

Fixes sociomantic-tsunami#213

Switch ocean.task to using verify

4a650bf

mihails-strasuns-sociomantic force-pushed the verify branch from 0b7e0a8 to 4a650bf Compare August 21, 2017 10:43

gavin-norman-sociomantic mentioned this pull request Aug 21, 2017

Update D error handling doc sociomantic-tsunami/sociomantic#4

Closed

gavin-norman-sociomantic approved these changes Aug 21, 2017

View reviewed changes

gavin-norman-sociomantic merged commit 9985e44 into sociomantic-tsunami:v2.x.x Aug 21, 2017

mihails-strasuns-sociomantic deleted the verify branch September 22, 2017 10:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`ocean.core.Verify` #214

`ocean.core.Verify` #214

mihails-strasuns-sociomantic commented Aug 16, 2017

gavin-norman-sociomantic Aug 16, 2017

gavin-norman-sociomantic Aug 16, 2017

gavin-norman-sociomantic commented Aug 16, 2017

codecov bot commented Aug 16, 2017 •

edited

Loading

mihails-strasuns-sociomantic commented Aug 16, 2017

nemanja-boric-sociomantic Aug 16, 2017

mihails-strasuns-sociomantic Aug 16, 2017

nemanja-boric-sociomantic Aug 16, 2017

gavin-norman-sociomantic Aug 16, 2017

nemanja-boric-sociomantic Aug 16, 2017

nemanja-boric-sociomantic Aug 16, 2017

leandro-lucarella-sociomantic Aug 16, 2017

mihails-strasuns-sociomantic Aug 16, 2017

gautam-kotian-sociomantic Aug 16, 2017

gautam-kotian-sociomantic Aug 16, 2017

mihails-strasuns-sociomantic Aug 16, 2017

gautam-kotian-sociomantic Aug 16, 2017

mihails-strasuns-sociomantic Aug 17, 2017

mihails-strasuns-sociomantic Aug 17, 2017

leandro-lucarella-sociomantic Aug 16, 2017

mihails-strasuns-sociomantic Aug 16, 2017

leandro-lucarella-sociomantic Aug 16, 2017

mihails-strasuns-sociomantic Aug 17, 2017

mihails-strasuns-sociomantic commented Aug 17, 2017 •

edited

Loading

mihails-strasuns-sociomantic commented Aug 21, 2017

gavin-norman-sociomantic Aug 21, 2017

gavin-norman-sociomantic Aug 21, 2017

mihails-strasuns-sociomantic Aug 21, 2017

gavin-norman-sociomantic Aug 21, 2017

mihails-strasuns-sociomantic Aug 21, 2017

mihails-strasuns-sociomantic Aug 21, 2017

dylan-cromwell-sociomantic Aug 21, 2017

gavin-norman-sociomantic Aug 21, 2017

dylan-cromwell-sociomantic Aug 21, 2017


		*******************************************************************************/

		public class SanityException : Exception

		@@ -30,6 +30,7 @@ import core.thread;

		import ocean.transition;
		import ocean.core.Enforce;

ocean.core.Verify #214

ocean.core.Verify #214

Conversation

mihails-strasuns-sociomantic commented Aug 16, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gavin-norman-sociomantic commented Aug 16, 2017

codecov bot commented Aug 16, 2017 • edited Loading

Codecov Report

mihails-strasuns-sociomantic commented Aug 16, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mihails-strasuns-sociomantic commented Aug 17, 2017 • edited Loading

mihails-strasuns-sociomantic commented Aug 21, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

`ocean.core.Verify` #214

`ocean.core.Verify` #214

codecov bot commented Aug 16, 2017 •

edited

Loading

mihails-strasuns-sociomantic commented Aug 17, 2017 •

edited

Loading