ruby-core@ruby-lang.org archive (unofficial mirror)
 help / color / mirror / Atom feed
* [ruby-core:120445] [Ruby master Feature#20993] Allow `class <constant-path> = <expression>` syntax
@ 2024-12-30 10:35 byroot (Jean Boussier) via ruby-core
  2024-12-30 13:05 ` [ruby-core:120447] " nobu (Nobuyoshi Nakada) via ruby-core
  2025-01-09  4:22 ` [ruby-core:120562] " matz (Yukihiro Matsumoto) via ruby-core
  0 siblings, 2 replies; 3+ messages in thread
From: byroot (Jean Boussier) via ruby-core @ 2024-12-30 10:35 UTC (permalink / raw)
  To: ruby-core; +Cc: byroot (Jean Boussier)

Issue #20993 has been reported by byroot (Jean Boussier).

----------------------------------------
Feature #20993: Allow `class <constant-path> = <expression>` syntax
https://bugs.ruby-lang.org/issues/20993

* Author: byroot (Jean Boussier)
* Status: Open
----------------------------------------
This is meant as a solution for: https://bugs.ruby-lang.org/issues/20943

## Context

When using `Struct.new` or `Data.define`, you often see one of these patterns:

```ruby
class MyStruct < Struct.new(:foo, :bar)
  # ...
end
```

Or:

```ruby
MyStruct = Struct.new(:foo, :bar) do
  # ...
end
```

The first one is OK, but not ideal because `MyStruct` inherits from an anonymous class. That's not that big of a deal, but it's an extra, generally useless class:

```ruby
>> MyClass.ancestors
=> [MyClass, #<Class:0x000000012a811548>, Struct, ...]
```

The second one is OK too, but can lead to two mistakes.

First, since it doesn't create a nesting, if you assign a constant, it won't be set where you expect it.
```ruby
MyStruct = Struct.new(:foo) do
  BAR = 1 # This sets Object::BAR, not MyStruct::BAR
end
```

The second potential issue is that the class only get named after the block complete, so some `inherited` or `included` hooks that rely on the
class name may break.

## Proposal

The "ideal" way to define a `Struct` or `Data` would be:

```ruby
MyStruct = Struct.new(:foo, :bar)
class MyStruct
  # body
end
```

But it's a bit awkward.

Given that `class <constant-path> < <expression>` is valid, this makes me think we could also accept `class <constant-path> = <expression>` such as:

```ruby
class MyStruct = Struct.new(:foo, :bar)
  # body
end
```

Would be valid syntax and the recommended way to define `Struct` and `Data` classes.

Of course `module <constant-path> = <expression>` would be valid as well.

If the expression doesn't return the expected type (either `Class` or `Module`), it would raise a `TypeError`.




-- 
https://bugs.ruby-lang.org/
 ______________________________________________
 ruby-core mailing list -- ruby-core@ml.ruby-lang.org
 To unsubscribe send an email to ruby-core-leave@ml.ruby-lang.org
 ruby-core info -- https://ml.ruby-lang.org/mailman3/lists/ruby-core.ml.ruby-lang.org/

^ permalink raw reply	[flat|nested] 3+ messages in thread

* [ruby-core:120447] [Ruby master Feature#20993] Allow `class <constant-path> = <expression>` syntax
  2024-12-30 10:35 [ruby-core:120445] [Ruby master Feature#20993] Allow `class <constant-path> = <expression>` syntax byroot (Jean Boussier) via ruby-core
@ 2024-12-30 13:05 ` nobu (Nobuyoshi Nakada) via ruby-core
  2025-01-09  4:22 ` [ruby-core:120562] " matz (Yukihiro Matsumoto) via ruby-core
  1 sibling, 0 replies; 3+ messages in thread
From: nobu (Nobuyoshi Nakada) via ruby-core @ 2024-12-30 13:05 UTC (permalink / raw)
  To: ruby-core; +Cc: nobu (Nobuyoshi Nakada)

Issue #20993 has been updated by nobu (Nobuyoshi Nakada).

File feature-20993.diff added

```ruby
class MyStruct = Struct.new(:foo, :bar)
  p instance_methods(false) #=> [:foo=, :bar=, :foo, :bar]
end
```


----------------------------------------
Feature #20993: Allow `class <constant-path> = <expression>` syntax
https://bugs.ruby-lang.org/issues/20993#change-111227

* Author: byroot (Jean Boussier)
* Status: Open
----------------------------------------
This is meant as a solution for: https://bugs.ruby-lang.org/issues/20943

## Context

When using `Struct.new` or `Data.define`, you often see one of these patterns:

```ruby
class MyStruct < Struct.new(:foo, :bar)
  # ...
end
```

Or:

```ruby
MyStruct = Struct.new(:foo, :bar) do
  # ...
end
```

The first one is OK, but not ideal because `MyStruct` inherits from an anonymous class. That's not that big of a deal, but it's an extra, generally useless class:

```ruby
>> MyClass.ancestors
=> [MyClass, #<Class:0x000000012a811548>, Struct, ...]
```

The second one is OK too, but can lead to two mistakes.

First, since it doesn't create a nesting, if you assign a constant, it won't be set where you expect it.
```ruby
MyStruct = Struct.new(:foo) do
  BAR = 1 # This sets Object::BAR, not MyStruct::BAR
end
```

The second potential issue is that the class only get named after the block complete, so some `inherited` or `included` hooks that rely on the
class name may break.

## Proposal

The "ideal" way to define a `Struct` or `Data` would be:

```ruby
MyStruct = Struct.new(:foo, :bar)
class MyStruct
  # body
end
```

But it's a bit awkward.

Given that `class <constant-path> < <expression>` is valid, this makes me think we could also accept `class <constant-path> = <expression>` such as:

```ruby
class MyStruct = Struct.new(:foo, :bar)
  # body
end
```

Would be valid syntax and the recommended way to define `Struct` and `Data` classes.

Of course `module <constant-path> = <expression>` would be valid as well.

If the expression doesn't return the expected type (either `Class` or `Module`), it would raise a `TypeError`.


---Files--------------------------------
feature-20993.diff (3.51 KB)


-- 
https://bugs.ruby-lang.org/
 ______________________________________________
 ruby-core mailing list -- ruby-core@ml.ruby-lang.org
 To unsubscribe send an email to ruby-core-leave@ml.ruby-lang.org
 ruby-core info -- https://ml.ruby-lang.org/mailman3/lists/ruby-core.ml.ruby-lang.org/

^ permalink raw reply	[flat|nested] 3+ messages in thread

* [ruby-core:120562] [Ruby master Feature#20993] Allow `class <constant-path> = <expression>` syntax
  2024-12-30 10:35 [ruby-core:120445] [Ruby master Feature#20993] Allow `class <constant-path> = <expression>` syntax byroot (Jean Boussier) via ruby-core
  2024-12-30 13:05 ` [ruby-core:120447] " nobu (Nobuyoshi Nakada) via ruby-core
@ 2025-01-09  4:22 ` matz (Yukihiro Matsumoto) via ruby-core
  1 sibling, 0 replies; 3+ messages in thread
From: matz (Yukihiro Matsumoto) via ruby-core @ 2025-01-09  4:22 UTC (permalink / raw)
  To: ruby-core; +Cc: matz (Yukihiro Matsumoto)

Issue #20993 has been updated by matz (Yukihiro Matsumoto).

Status changed from Open to Rejected

This is a too trivial issue to add new syntax. I suggest the following (I know the difference, but it works OK, doesn't it?)

```ruby
MyStruct = Struct.new(:foo, :bar)
class MyStruct
  ...
end

# or

class MyStruct < Struct.new(:foo, :bar)
  ...
end
````

Matz.


----------------------------------------
Feature #20993: Allow `class <constant-path> = <expression>` syntax
https://bugs.ruby-lang.org/issues/20993#change-111380

* Author: byroot (Jean Boussier)
* Status: Rejected
----------------------------------------
This is meant as a solution for: https://bugs.ruby-lang.org/issues/20943

## Context

When using `Struct.new` or `Data.define`, you often see one of these patterns:

```ruby
class MyStruct < Struct.new(:foo, :bar)
  # ...
end
```

Or:

```ruby
MyStruct = Struct.new(:foo, :bar) do
  # ...
end
```

The first one is OK, but not ideal because `MyStruct` inherits from an anonymous class. That's not that big of a deal, but it's an extra, generally useless class:

```ruby
>> MyClass.ancestors
=> [MyClass, #<Class:0x000000012a811548>, Struct, ...]
```

The second one is OK too, but can lead to two mistakes.

First, since it doesn't create a nesting, if you assign a constant, it won't be set where you expect it.
```ruby
MyStruct = Struct.new(:foo) do
  BAR = 1 # This sets Object::BAR, not MyStruct::BAR
end
```

The second potential issue is that the class only get named after the block complete, so some `inherited` or `included` hooks that rely on the
class name may break.

## Proposal

The "ideal" way to define a `Struct` or `Data` would be:

```ruby
MyStruct = Struct.new(:foo, :bar)
class MyStruct
  # body
end
```

But it's a bit awkward.

Given that `class <constant-path> < <expression>` is valid, this makes me think we could also accept `class <constant-path> = <expression>` such as:

```ruby
class MyStruct = Struct.new(:foo, :bar)
  # body
end
```

Would be valid syntax and the recommended way to define `Struct` and `Data` classes.

Of course `module <constant-path> = <expression>` would be valid as well.

If the expression doesn't return the expected type (either `Class` or `Module`), it would raise a `TypeError`.


---Files--------------------------------
feature-20993.diff (3.51 KB)


-- 
https://bugs.ruby-lang.org/
 ______________________________________________
 ruby-core mailing list -- ruby-core@ml.ruby-lang.org
 To unsubscribe send an email to ruby-core-leave@ml.ruby-lang.org
 ruby-core info -- https://ml.ruby-lang.org/mailman3/lists/ruby-core.ml.ruby-lang.org/

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2025-01-09  4:23 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2024-12-30 10:35 [ruby-core:120445] [Ruby master Feature#20993] Allow `class <constant-path> = <expression>` syntax byroot (Jean Boussier) via ruby-core
2024-12-30 13:05 ` [ruby-core:120447] " nobu (Nobuyoshi Nakada) via ruby-core
2025-01-09  4:22 ` [ruby-core:120562] " matz (Yukihiro Matsumoto) via ruby-core

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).