From: merch-redmine@... Date: 2019-10-29T21:51:11+00:00 Subject: [ruby-core:95584] [Ruby master Feature#16276] For consideration: "private do...end" / "protected do...end" Issue #16276 has been updated by jeremyevans0 (Jeremy Evans). Eregon (Benoit Daloze) wrote: > Also worth noting that `private def` actually defines two methods, one public and then a copy of it as private, overriding the public one in the method table. I don't think this is true. `private :method` only adds an entry (zsuper method) to the method table if the method is not defined in the current class (i.e. it is defined in a superclass or included module). If the method is defined directly in the class, it just updates the visibility flag on the existing method table entry. Since `def` always defines in the current class, `private def` should not be defining two methods. Regarding the feature, I think if we didn't have the current scope visibility behavior when calling `private` with no arguments, this would be a reasonable approach for implementing the behavior. However, I don't think it is worth adding as an alternative approach. ---------------------------------------- Feature #16276: For consideration: "private do...end" / "protected do...end" https://bugs.ruby-lang.org/issues/16276#change-82372 * Author: adh1003 (Andrew Hodgkinson) * Status: Open * Priority: Normal * Assignee: * Target version: ---------------------------------------- Private or protected declarations in Ruby classes are problematic. The single, standalone `public`, `private` or `protected` statements cause all following methods - *except* "private" class methods, notably - to have that protection level. It is not idiomatic in Ruby to indent method definitions after such declarations, so it becomes at a glance very hard to see what a method's protection level is when just diving into a piece of source code. One must carefully scroll *up* the code searching for a relevant declaration (easily missed, when everything's at the same indentation level) or have an IDE sufficiently advanced to give you that information automatically (and none of the lightweight editors I prefer personally have yet to support this). Forcibly indenting code after declarations helps, but most Ruby developers find this unfamiliar and most auto-formatters/linters will reset it or, at best, complain. Further, the difficulty in defining private *class* methods or constants tells us that perhaps there's more we should do here - but of course, we want to maintain backwards compatibility. On the face of it, I can't see much in the way of allowing the `public`, `private` or `protected` declarations to - *optionally* - support a block-like syntax. ``` class Foo # ...there may be prior old-school public/private/protected declarations... def method_at_whatever_traditional_ruby_protection_level_applies puts "I'm traditional" end private do def some_private_instance_method puts "I'm private" end def self.some_private_class_method puts "I'm also private - principle of least surprise" end NO_NEED_FOR_PRIVATE_CONSTANT_DECLARATIONS_EITHER = "private" end def another_method_at_whatever_traditional_ruby_protection_level_applies puts "I'm also traditional" end end ``` My suggestion here confines all `public do...end`, `protected do...end` or `private do...end` protections strictly to the confines of the block alone. Outside the block - both before and after - traditional Ruby protection semantics apply, allowing one to add new block-based protection-enclosed method declarations inside any existing code base without fear of accidentally changing the protection level of any methods defined below the new block. As noted in the pseudocode above, we can clean up some of the issues around the special syntax needed for "private constants", too. I see a lot of wins in here but I'm aware I may be na�ve - for example, arising unanswered questions include: * Is the use of a block-like syntax making unwarranted assumptions about what the Ruby compiler can do during its various parsing phases? * Does the use of a block-like syntax imply we should support things like Procs too? (I *think* probably not - I see this as just syntax sugar to provide a new feature reusing a familiar idiom but without diving down any other rabbit holes, at least not in the first implementation) I've no idea how one would go about implementing this inside Ruby Core, as I've never tackled that before. If someone is keen to pick up the feature, great! Alternatively, if a rough idea of how it *might* be implemented could be sketched out, then I might be able to have a go at implementation myself and submit a PR - assuming anyone is keen on the idea in the first place `:-)` -- https://bugs.ruby-lang.org/ Unsubscribe: