Ruby wrapper for parser by rajithv · Pull Request #60 · symengine/symengine.rb

rajithv · 2016-07-08T14:26:46Z

No description provided.

isuruf · 2016-07-08T14:50:20Z

Can you add some tests?

…to parser

zverok · 2016-07-08T17:42:53Z

spec/symengine_spec.rb

+    subject { SymEngine::parse('123 + 321') }
+
+    it { is_expected.to be_a SymEngine::Integer }
+    it { is_expected.to eq 444 }


What will be if there's erroneous/unparseable input? (And, BTW, what input, if any is considered erroneous or unparseable by symengine?)

@zverok I did think about that. In C++ code it will throw errors for unparseable code. Checking that may almost be equivalent to doing the parsing. There are 4 errors,

Expected token!

Invalid symbol or number!

Mismatching parantheses!

Operator inconsistency!

Catching the exceptions from the C++ code and throwing ruby exceptions will be covered in the weeks 9 and 10. So this issue will be solved then.

As of now, I wanted the tests to merely confirm that the Ruby wrapper is communicating successfully with the cwrapper. Actually the same idea was behind the matrix wrapper tests.

Got it. I just always became suspicious when I see tests for success and not tests for fail :)
In fact, I always prefer to add empty contexts for such a deferred tests pathes, like this:

context "When there is parsing error" do # TODO: will be covered on weeks 9-10 end

Though, I'm not insisting, currently.

That's a quite nice way to make it clear!

I'll keep this as it is, because week 9 is just one week away from now, probably I will start working on it even earlier.

rajithv · 2016-07-31T10:15:17Z

@isuruf can we merge this now, that the symengine/symengine#1044 has ParseError, so exception catching regarding Parser can be done in #63 with other exceptions?

isuruf · 2016-08-21T03:07:25Z

Can you resolve conflicts and add tests for parser errors?

…to parser

isuruf · 2016-08-21T15:09:46Z

spec/symengine_spec.rb

  end
+
+  describe 'parse' do
+    subject { SymEngine::parse('123 + 321') }


Since these specs act as documentation, can you add more strings for parsing?
eg.

x + (y * 3 - 5)

x ** y + f(x)

sin(x) + cos(y) / 2

1 / 2 + 3 / 2

1 + 2 * 2

tan(0) - sqrt(2)

I would like to add a few more to this list

5+-3

5--3

All Without spaces
And

5++3 or something like this to raise an error.

rajithv · 2016-08-22T15:55:54Z

@isuruf @abinashmeher999 please review.

abinashmeher999 · 2016-08-22T22:48:57Z

spec/symengine_spec.rb

+  end
+
+  it 'gives parse errors' do
+    expect { SymEngine::parse('12a + n34a9') }.to raise_error(RuntimeError)


IMO the error message should be checked too since we don't have specific exception for ParseError.

Why not to add ParseError as a specific exception? That seems worthwhile.

Found just the thing that explains creating custom exceptions from Ruby C API: http://clalance.blogspot.in/2011/01/writing-ruby-extensions-in-c-part-5.html

You don't have to create new exceptions.

SYMENGINE_RUNTIME_ERROR - rb_eRuntimeError

SYMENGINE_DIV_BY_ZERO - rb_eZeroDivError

SYMENGINE_NOT_IMPLEMENTED - rb_eNotImpError

SYMENGINE_PARSE_ERROR - rb_eSyntaxError

SYMENGINE_UNDEFINED - rb_eFloatDomainError ?? (I'm not sure what SYMENGINE_UNDEFINED is. Is this supposed to be a Domain error?)

I partially agree to the above. While RuntimeError and ZeroDivisionError should be used, our code atleast shouldn't raise NotImplementedError and SyntaxError. The latter ones are ScriptErrors and not StandardErrors.
This post explains why it would be abuse of NotImplementedError. SyntaxError is not a right fit since it is raised while encountering invalid Ruby code. If the user wants to handle a parse error, (s)he will have to handle SyntaxError and that would also lead to unwanted silencing of the actual syntax error in the source code.

Also there is the technical problem that a rescue clause by default only catches the StandardErrors. It is highly advised that custom application level exceptions be derived from StandardError.

For SYMENGINE_UNDEFINED it can be just StandardError.

I just checked SciRuby/nmatrix repo and they use NotImplementedError and IOError (instead of SyntaxError)

rajithv · 2016-08-24T04:51:12Z

@certik @abinashmeher999 @isuruf should I make another PR to continue this work after the GSoC period? Because the submission guidelines asked not to change the submitted material after submission. Pls advice on this.

abinashmeher999 · 2016-08-24T08:17:53Z

I assume the submission guidelines mention about putting in the exact amount of work that was achieved during the GSoC period. That you have mentioned in the blog post already. As long as you are not changing the contents and the amount of work achieved, you won't be violating any rules. Correct me If I am wrong.

You can keep the new exception making part for another PR. I think we can go ahead with merging this. Just a few more changes that have been suggested and we will be good to go.

isuruf · 2016-10-08T09:51:27Z

@rajithv, do you have time to finish this PR? If not, can you enable edits from maintainers?

certik · 2016-10-11T18:03:18Z

@rajithv ping.

rajithv · 2016-10-12T16:45:08Z

@isuruf @certik I will find sometime to complete this PR

Ruby wrapper for parser

588fa76

rajithv added 3 commits July 8, 2016 20:37

Update symengine version

cf77487

testing parse method

300c769

Merge branch 'master' of https://github.com/symengine/symengine.rb in…

5980a4a

…to parser

zverok reviewed Jul 8, 2016
View reviewed changes

rajithv added 2 commits August 21, 2016 19:14

Merge branch 'master' of https://github.com/symengine/symengine.rb in…

a2f88e2

…to parser

Exception Handling and test with parse error

c20e7a0

isuruf reviewed Aug 21, 2016
View reviewed changes

Added more tests for parser

7e9ca53

abinashmeher999 reviewed Aug 22, 2016
View reviewed changes

isuruf added this to the Release 0.1.0 milestone Oct 8, 2016

Conversation

rajithv commented Jul 8, 2016

Uh oh!

isuruf commented Jul 8, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rajithv commented Jul 31, 2016

Uh oh!

isuruf commented Aug 21, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rajithv commented Aug 22, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

isuruf Aug 24, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rajithv commented Aug 24, 2016

Uh oh!

abinashmeher999 commented Aug 24, 2016

Uh oh!

isuruf commented Oct 8, 2016

Uh oh!

certik commented Oct 11, 2016

Uh oh!

rajithv commented Oct 12, 2016

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

isuruf Aug 24, 2016 •

edited

Loading