Skip to content

Commit

Permalink
Add {Method,UnboundMethod}#{public?,private?,protected?}
Browse files Browse the repository at this point in the history
These methods allow for checking whether the method has that
visibility.

Implements [Feature ruby#11689]
  • Loading branch information
jeremyevans committed Dec 9, 2021
1 parent 74159f7 commit 2727815
Show file tree
Hide file tree
Showing 3 changed files with 77 additions and 1 deletion.
8 changes: 7 additions & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Note that each entry is kept to a minimum, see links for details.

## Language changes

* The block arguments can be now be anonymous, if the block will
* The block argument can be now be anonymous, if the block will
only be passed to another method. [[Feature #11256]]

```ruby
Expand Down Expand Up @@ -190,6 +190,11 @@ Outstanding ones only.
* MatchData#match_length is added [[Feature #18172]]
* Method/UnboundMethod
* #public?, #private?, #protected have been added to both
Method and UnboundMethod. [[Feature #11689]]
* Module
* Module#prepend now modifies the ancestor chain if the receiver
Expand Down Expand Up @@ -459,6 +464,7 @@ See [the repository](https://github.com/ruby/error_highlight) in detail.
[Bug #4443]: https://bugs.ruby-lang.org/issues/4443
[Feature #6210]: https://bugs.ruby-lang.org/issues/6210
[Feature #11256]: https://bugs.ruby-lang.org/issues/11256
[Feature #11689]: https://bugs.ruby-lang.org/issues/11689
[Feature #12194]: https://bugs.ruby-lang.org/issues/12194
[Feature #12495]: https://bugs.ruby-lang.org/issues/12495
[Feature #12913]: https://bugs.ruby-lang.org/issues/12913
Expand Down
51 changes: 51 additions & 0 deletions proc.c
Original file line number Diff line number Diff line change
Expand Up @@ -3227,6 +3227,51 @@ method_super_method(VALUE method)
return mnew_internal(me, me->owner, iclass, data->recv, mid, rb_obj_class(method), FALSE, FALSE);
}

/*
* call-seq:
* meth.public? -> true or false
*
* Returns whether the method is public.
*/

static VALUE
method_public_p(VALUE method)
{
const struct METHOD *data;
TypedData_Get_Struct(method, struct METHOD, &method_data_type, data);
return RBOOL(METHOD_ENTRY_VISI(data->me) == METHOD_VISI_PUBLIC);
}

/*
* call-seq:
* meth.protected? -> true or false
*
* Returns whether the method is protected.
*/

static VALUE
method_protected_p(VALUE method)
{
const struct METHOD *data;
TypedData_Get_Struct(method, struct METHOD, &method_data_type, data);
return RBOOL(METHOD_ENTRY_VISI(data->me) == METHOD_VISI_PROTECTED);
}

/*
* call-seq:
* meth.private? -> true or false
*
* Returns whether the method is private.
*/

static VALUE
method_private_p(VALUE method)
{
const struct METHOD *data;
TypedData_Get_Struct(method, struct METHOD, &method_data_type, data);
return RBOOL(METHOD_ENTRY_VISI(data->me) == METHOD_VISI_PRIVATE);
}

/*
* call-seq:
* local_jump_error.exit_value -> obj
Expand Down Expand Up @@ -4163,6 +4208,9 @@ Init_Proc(void)
rb_define_method(rb_cMethod, "source_location", rb_method_location, 0);
rb_define_method(rb_cMethod, "parameters", rb_method_parameters, 0);
rb_define_method(rb_cMethod, "super_method", method_super_method, 0);
rb_define_method(rb_cMethod, "public?", method_public_p, 0);
rb_define_method(rb_cMethod, "protected?", method_protected_p, 0);
rb_define_method(rb_cMethod, "private?", method_private_p, 0);
rb_define_method(rb_mKernel, "method", rb_obj_method, 1);
rb_define_method(rb_mKernel, "public_method", rb_obj_public_method, 1);
rb_define_method(rb_mKernel, "singleton_method", rb_obj_singleton_method, 1);
Expand All @@ -4186,6 +4234,9 @@ Init_Proc(void)
rb_define_method(rb_cUnboundMethod, "source_location", rb_method_location, 0);
rb_define_method(rb_cUnboundMethod, "parameters", rb_method_parameters, 0);
rb_define_method(rb_cUnboundMethod, "super_method", method_super_method, 0);
rb_define_method(rb_cUnboundMethod, "public?", method_public_p, 0);
rb_define_method(rb_cUnboundMethod, "protected?", method_protected_p, 0);
rb_define_method(rb_cUnboundMethod, "private?", method_private_p, 0);

/* Module#*_method */
rb_define_method(rb_cModule, "instance_method", rb_mod_instance_method, 1);
Expand Down
19 changes: 19 additions & 0 deletions test/ruby/test_method.rb
Original file line number Diff line number Diff line change
Expand Up @@ -1181,6 +1181,25 @@ def foo
assert_nil(super_method)
end

def test_method_visibility_predicates
v = Visibility.new
assert_equal(true, v.method(:mv1).public?)
assert_equal(true, v.method(:mv2).private?)
assert_equal(true, v.method(:mv3).protected?)
assert_equal(false, v.method(:mv2).public?)
assert_equal(false, v.method(:mv3).private?)
assert_equal(false, v.method(:mv1).protected?)
end

def test_unbound_method_visibility_predicates
assert_equal(true, Visibility.instance_method(:mv1).public?)
assert_equal(true, Visibility.instance_method(:mv2).private?)
assert_equal(true, Visibility.instance_method(:mv3).protected?)
assert_equal(false, Visibility.instance_method(:mv2).public?)
assert_equal(false, Visibility.instance_method(:mv3).private?)
assert_equal(false, Visibility.instance_method(:mv1).protected?)
end

def rest_parameter(*rest)
rest
end
Expand Down

0 comments on commit 2727815

Please sign in to comment.