Changed all is_? method names to ? #268

stephenandersondev · 2021-07-07T04:08:46Z

Summary

Changed all is_*? method names to *? on the following:

is_empty? to empty?
is_simple? to simple?
is_closed? to closed?
is_point? to point?
is_ring? to ring?
is_capi_geos? to capi_geos?
is_ffi_geos? to ffi_geos?
is_geos? to goes?

Closes #264

Changed all is_*? method names to *?

stephenandersondev · 2021-07-07T04:10:04Z

This is my first open-source contribution ever, so please let me know if I've missed any steps. Thanks!

keithdoggett · 2021-07-09T18:43:45Z

@stephenandersondev thanks for submitting this I think this looks good, but I'll take a deeper look soon. @BuonOmo do you think we should alias all the methods to accept the is_*? form as well? It would be good for backwards compatibility.

Also @stephenandersondev this is going to be part of our V3 release, so this needs to be merged into the v3-dev branch.

stephenandersondev · 2021-07-09T22:49:25Z

@keithdoggett Just changed the branch to v3-dev, thanks for the heads up!

BuonOmo · 2021-07-10T16:55:14Z

This is my first open-source contribution ever, so please let me know if I've missed any steps. Thanks!

Thank you for doing it there!

@stephenandersondev thanks for submitting this I think this looks good, but I'll take a deeper look soon. @BuonOmo do you think we should alias all the methods to accept the is_*? form as well? It would be good for backwards compatibility.

@keithdoggett @stephenandersondev I thought a bit about it, and I think we can do some easier transition for users, that would even allow us to merge this in v2.

I'm thinking about keep is_* methods as well for a transition period, yet printing a deprecation warning. For instance:

def is_simple?
	warn "is_*? methods are deprecated, please use the *? counterpart, will be removed in v3" unless ENV["RGEO_SILENCE_DEPRECATION"]

	simple?
end

Of course, this might also be done using metaprogramming (for instance with method_missing), yet I'm not sure this is necessary.

What do you think about that idea, and @stephenandersondev could you implement it in this PR? 🙂

stephenandersondev · 2021-07-11T21:36:17Z

@BuonOmo Yes I can definitely implement this PR, I will have it ready shortly 👍

create alias methods

stephenandersondev · 2021-07-14T03:12:26Z

@BuonOmo I got the alias methods put in, have a couple of questions though:

I didn't see a branch that referenced v2 so I assumed it was master since it's the current version? Let me know if otherwise and I can change it.
I wasn't sure if we needed to add the alias methods to the tests? If so, let me know what you think that should look like and I'll get it in.

BuonOmo

@stephenandersondev thank you for the addition.

I didn't see a branch that referenced v2 so I assumed it was master since it's the current version? Let me know if otherwise and I can change it.

You're right, v2 is the current version, we're using the master branch.

I wasn't sure if we needed to add the alias methods to the tests? If so, let me know what you think that should look like and I'll get it in.

IMHo, that is not needed.

I've one last review concerning the geos capi, unfortunately we need alias for those methods as well. I've adressed which methods and where they should be aliased. I can do it and push to your branch later if you don't have more time 🙂 (I'll let you decide though, your branch, your ownership!)

After that I think we'll be ready to ship.

BuonOmo · 2021-07-14T09:33:30Z

ext/geos_c_impl/geometry.c

+  rb_define_method(geos_geometry_methods, "empty?", method_geometry_is_empty, 0);
+  rb_define_method(geos_geometry_methods, "simple?", method_geometry_is_simple, 0);


The geos methods do not implement Feature base methods in v2 unfortunately.

Hence we also need to create the deprecation warning. You can do that one in ruby, in lib/rgeo/geos/capi_feature_classes.rb :)

BuonOmo · 2021-07-14T09:33:42Z

ext/geos_c_impl/geometry_collection.c

@@ -623,7 +623,7 @@ void rgeo_init_geos_geometry_collection(RGeo_Globals* globals)
  geos_multi_line_string_methods = rb_define_module_under(globals->geos_module, "CAPIMultiLineStringMethods");
  rb_define_method(geos_multi_line_string_methods, "geometry_type", method_multi_line_string_geometry_type, 0);
  rb_define_method(geos_multi_line_string_methods, "length", method_multi_line_string_length, 0);
-  rb_define_method(geos_multi_line_string_methods, "is_closed?", method_multi_line_string_is_closed, 0);
+  rb_define_method(geos_multi_line_string_methods, "closed?", method_multi_line_string_is_closed, 0);


Same here unfortunately

BuonOmo · 2021-07-14T09:33:57Z

ext/geos_c_impl/line_string.c

+  rb_define_method(geos_line_string_methods, "closed?", method_line_string_is_closed, 0);
+  rb_define_method(geos_line_string_methods, "ring?", method_line_string_is_ring, 0);


I think this will work?

stephenandersondev · 2021-07-17T16:57:23Z

So sorry about that @BuonOmo. I'm admittedly very new to RGeo and this is my first time ever looking at C code 😅 I think I got the aliasing right? Although, you may mean to alias do the aliasing on the ruby side which is where I would add the warning back in at? If this is wrong (which I feel it is) would you be able to do one as an example? I would be happy to do the rest 🙂 Sorry again, still learning this stuff.

BuonOmo · 2021-07-18T10:14:50Z

@stephenandersondev no problem, I'll give you some pointers.

Let's try with the empty? GEOS method for instance. The idea will be to implement is_empty? on the ruby side, to have something simpler to code. Performances will not be an issue anyway for such a trivial task (proxying to the actual empty? method).

We first need to know where the method is implemented. The line below gives us this information:

rb_define_method(geos_geometry_methods, "empty?", method_geometry_is_empty, 0);

^{[`rb_define_method` reference](https://github.com/ruby/ruby/blob/HEAD/doc/extension.rdoc#method-and-singleton-method-definition-)}

We can see it is defined under geos_geometry_methods. And this correspond to the ruby module XX::CAPIGeometryMethods according to:

geos_geometry_methods = rb_define_module_under(globals->geos_module, "CAPIGeometryMethods");

This module can be found when searching the project, and you'll most likely end up in lib/rgeo/geos/capi_feature_classes.rb, you now know you can define the method here:

module RGeo
  module Geos
    module CAPIGeometryMethods # :nodoc:
      include Feature::Instance

      def is_empty?
        warn "support..."
        empty?
      end
...

Is that clear enough? If not, I'll just takeover this last bit and you'll see my commit as an example 🙂

Make suggested corrections on aliasing

stephenandersondev · 2021-07-18T16:37:04Z

@BuonOmo Thank you so much for taking the time to clarify this for me, I learned something new because of it 😄 I believe this last commit I pushed does the trick. Please let me know if otherwise. Thanks again for your help!

BuonOmo

LGTM!

BuonOmo · 2021-07-19T12:52:28Z

@keithdoggett do you want to process to one last review?

BuonOmo · 2021-07-19T12:54:32Z

Oh, my bad, rubocop is not passing anymore, @stephenandersondev the trick is to disable the Naming/PredicateName cop (see https://docs.rubocop.org/rubocop/1.3/configuration.html#disabling-cops-within-source-code)

Disable Naming/PredicateName cop

stephenandersondev · 2021-07-19T14:01:31Z

So sorry about that 🤦🏻 Just committed the disabling of it. Thank you so much for your patience and guidance on this!

BuonOmo · 2021-07-19T16:08:20Z

@stephenandersondev sorry I should have been a bit clearer.... I think that this should be inlined:

def is_simple? # rubocop:disable Naming/PredicateName

This will ensure that when getting rid of every is_ method, we'll also get rid of that comment. Moreover, it tells a ready why this comment is here.

Make magic comments inline

stephenandersondev · 2021-07-19T20:22:37Z

@BuonOmo Oops sorry about that, they're inline now 👍🏻

keithdoggett

Thanks for the work @stephenandersondev and @BuonOmo! These look good for the most part. My only suggestion is that we don't modify the History.md file because that's supposed to reflect historical changes that happened and probably shouldn't be modified only appended to.

keithdoggett · 2021-07-20T12:55:38Z

History.md

-*   The class shuffle in 0.3.14 broke RGeo::Geos.is_geos? and similar. Fixed.
+*   The class shuffle in 0.3.14 broke RGeo::Geos.geos? and similar. Fixed.


Not sure we should change this since it's describing a past change.

keithdoggett · 2021-07-20T12:55:53Z

History.md

-    LineString#is_simple? (which should now allow LinearRing to work).
+    LineString#simple? (which should now allow LinearRing to work).


Not sure we should change this since it's describing a past change.

revert History.md

stephenandersondev · 2021-07-20T17:14:21Z

@keithdoggett Ahhh that's a great point. I just reverted them back. Thanks for the head up!

keithdoggett

Awesome, thanks @stephenandersondev! LGTM

@BuonOmo should be good to merge as is unless you want to squash the commits first.

BuonOmo · 2021-07-20T23:51:14Z

Merged! Thanks again @stephenandersondev :)

stephenandersondev · 2021-07-20T23:54:09Z

Thank you both! I look forward to working with you again :)

BuonOmo · 2021-07-22T09:30:31Z

well if you see something on which you could work on the roadmap, go ahead 🙂

stephenandersondev added 10 commits July 6, 2021 22:09

Changed all occurrences of is_empty? to empty?

9531bb8

Changed all occurrences of is_simple? to simple?

50b4f46

Changed all occurrences of is_closed? to closed?

cc2aea1

Changed all occurrences of is_point? to point?

2ca48e7

Changed all occurrences of is_ring? to ring?

4aea23c

Changed all occurrences of is_capi_geos? to capi_geos?

4b40351

Changed all occurrences of is_ffi_geos? to ffi_geos?

fe1dde5

Changed all occurrences of is_geos? to geos?

fc9c00c

Changed mind on test names

36b9db1

Merge pull request #1 from stephenandersondev/264-remove-is

79b0017

Changed all is_*? method names to *?

stephenandersondev changed the base branch from master to v3-dev July 9, 2021 22:46

stephenandersondev changed the base branch from v3-dev to master July 14, 2021 01:46

stephenandersondev added 2 commits July 13, 2021 21:45

create alias methods

10fad24

Merge pull request #2 from stephenandersondev/264-remove-is

47a5559

create alias methods

BuonOmo reviewed Jul 14, 2021

View reviewed changes

stephenandersondev added 2 commits July 17, 2021 11:50

I think this will work?

b7de930

Merge pull request #3 from stephenandersondev/264-remove-is

3556e88

I think this will work?

stephenandersondev added 2 commits July 18, 2021 11:32

Think I got it this time

dfde394

Merge pull request #4 from stephenandersondev/264-remove-is

e040332

Make suggested corrections on aliasing

BuonOmo approved these changes Jul 19, 2021

View reviewed changes

stephenandersondev added 2 commits July 19, 2021 08:58

disable Naming/PredicateName cop

b01f3d3

Merge pull request #5 from stephenandersondev/264-remove-is

0213315

Disable Naming/PredicateName cop

stephenandersondev added 2 commits July 19, 2021 15:21

make magic comments inline

20eb5be

Merge pull request #6 from stephenandersondev/264-remove-is

bb2549b

Make magic comments inline

keithdoggett reviewed Jul 20, 2021

View reviewed changes

stephenandersondev added 2 commits July 20, 2021 12:12

revert History.md

bd67d7d

Merge pull request #7 from stephenandersondev/264-remove-is

c499716

revert History.md

keithdoggett approved these changes Jul 20, 2021

View reviewed changes

BuonOmo merged commit 334f908 into rgeo:master Jul 20, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Changed all is_? method names to ? #268

Changed all is_? method names to ? #268

stephenandersondev commented Jul 7, 2021

stephenandersondev commented Jul 7, 2021 •

edited

keithdoggett commented Jul 9, 2021

stephenandersondev commented Jul 9, 2021

BuonOmo commented Jul 10, 2021 •

edited

stephenandersondev commented Jul 11, 2021

stephenandersondev commented Jul 14, 2021

BuonOmo left a comment

BuonOmo Jul 14, 2021

BuonOmo Jul 14, 2021

BuonOmo Jul 14, 2021

stephenandersondev commented Jul 17, 2021

BuonOmo commented Jul 18, 2021

stephenandersondev commented Jul 18, 2021 •

edited

BuonOmo left a comment

BuonOmo commented Jul 19, 2021

BuonOmo commented Jul 19, 2021

stephenandersondev commented Jul 19, 2021

BuonOmo commented Jul 19, 2021

stephenandersondev commented Jul 19, 2021

keithdoggett left a comment

keithdoggett Jul 20, 2021

keithdoggett Jul 20, 2021

stephenandersondev commented Jul 20, 2021

keithdoggett left a comment

BuonOmo commented Jul 20, 2021

stephenandersondev commented Jul 20, 2021

BuonOmo commented Jul 22, 2021

		rb_define_method(geos_geometry_methods, "empty?", method_geometry_is_empty, 0);
		rb_define_method(geos_geometry_methods, "simple?", method_geometry_is_simple, 0);

		rb_define_method(geos_line_string_methods, "closed?", method_line_string_is_closed, 0);
		rb_define_method(geos_line_string_methods, "ring?", method_line_string_is_ring, 0);

		* The class shuffle in 0.3.14 broke RGeo::Geos.is_geos? and similar. Fixed.
		* The class shuffle in 0.3.14 broke RGeo::Geos.geos? and similar. Fixed.

		LineString#is_simple? (which should now allow LinearRing to work).
		LineString#simple? (which should now allow LinearRing to work).

Changed all is_*? method names to *? #268

Changed all is_*? method names to *? #268

Conversation

stephenandersondev commented Jul 7, 2021

Summary

stephenandersondev commented Jul 7, 2021 • edited

keithdoggett commented Jul 9, 2021

stephenandersondev commented Jul 9, 2021

BuonOmo commented Jul 10, 2021 • edited

stephenandersondev commented Jul 11, 2021

stephenandersondev commented Jul 14, 2021

BuonOmo left a comment

Choose a reason for hiding this comment

BuonOmo Jul 14, 2021

Choose a reason for hiding this comment

BuonOmo Jul 14, 2021

Choose a reason for hiding this comment

BuonOmo Jul 14, 2021

Choose a reason for hiding this comment

stephenandersondev commented Jul 17, 2021

BuonOmo commented Jul 18, 2021

stephenandersondev commented Jul 18, 2021 • edited

BuonOmo left a comment

Choose a reason for hiding this comment

BuonOmo commented Jul 19, 2021

BuonOmo commented Jul 19, 2021

stephenandersondev commented Jul 19, 2021

BuonOmo commented Jul 19, 2021

stephenandersondev commented Jul 19, 2021

keithdoggett left a comment

Choose a reason for hiding this comment

keithdoggett Jul 20, 2021

Choose a reason for hiding this comment

keithdoggett Jul 20, 2021

Choose a reason for hiding this comment

stephenandersondev commented Jul 20, 2021

keithdoggett left a comment

Choose a reason for hiding this comment

BuonOmo commented Jul 20, 2021

stephenandersondev commented Jul 20, 2021

BuonOmo commented Jul 22, 2021

Changed all is_? method names to ? #268

Changed all is_? method names to ? #268

stephenandersondev commented Jul 7, 2021 •

edited

BuonOmo commented Jul 10, 2021 •

edited

stephenandersondev commented Jul 18, 2021 •

edited