[ruby-core:61696] [CommonRuby - Feature #9678] [Open] New heredoc syntax

[ruby-core:61696] [CommonRuby - Feature #9678] [Open] New heredoc syntax

[alexey.muranov]

Issue #9678 has been reported by Alexey Muranov.

----------------------------------------
Feature #9678: New heredoc syntax
https://bugs.ruby-lang.org/issues/9678

* Author: Alexey Muranov
* Status: Open
* Priority: Normal
* Assignee: 
* Category: 
* Target version: 
----------------------------------------
For whatever it is worth, i've just had this idea of a new heredoc syntax for some programming language:

    class C
      def f(x)
        print >>Message1 + >>Message2
    Message1:
    > Literal text
    > ------------
    > Here text.
    >
    Message2:
    >> Text with interpolation and escapes
    >> -----------------------------------
    >> Here text with interpolation: #{ x }.
    >>
      end
    end



-- 
https://bugs.ruby-lang.org/

[ruby-core:61697] [CommonRuby - Feature #9678] New heredoc syntax

[nobu]

Issue #9678 has been updated by Nobuyoshi Nakada.


And the expected output?

----------------------------------------
Feature #9678: New heredoc syntax
https://bugs.ruby-lang.org/issues/9678#change-45946

* Author: Alexey Muranov
* Status: Open
* Priority: Normal
* Assignee: 
* Category: 
* Target version: 
----------------------------------------
For whatever it is worth, i've just had this idea of a new heredoc syntax for some programming language:

    class C
      def f(x)
        print >>Message1 + >>Message2
    Message1:
    > Literal text
    > ------------
    > Here text.
    >
    Message2:
    >> Text with interpolation and escapes
    >> -----------------------------------
    >> Here text with interpolation: #{ x }.
    >>
      end
    end



-- 
https://bugs.ruby-lang.org/

[ruby-core:61698] [CommonRuby - Feature #9678] New heredoc syntax

[alexey.muranov]

Issue #9678 has been updated by Alexey Muranov.


Sorry, of course:

    f(42)

i would expect to output

    Literal text
    ------------
    Here text.
  
    Text with interpolation and escapes
    -----------------------------------
    Here text with interpolation: 42.

----------------------------------------
Feature #9678: New heredoc syntax
https://bugs.ruby-lang.org/issues/9678#change-45947

* Author: Alexey Muranov
* Status: Open
* Priority: Normal
* Assignee: 
* Category: 
* Target version: 
----------------------------------------
For whatever it is worth, i've just had this idea of a new heredoc syntax for some programming language:

    class C
      def f(x)
        print >>Message1 + >>Message2
    Message1:
    > Literal text
    > ------------
    > Here text.
    >
    Message2:
    >> Text with interpolation and escapes
    >> -----------------------------------
    >> Here text with interpolation: #{ x }.
    >>
      end
    end



-- 
https://bugs.ruby-lang.org/

[ruby-core:61699] [CommonRuby - Feature #9678] New heredoc syntax

[alexey.muranov]

Issue #9678 has been updated by Alexey Muranov.


IMO, this would allow a program with heredocs to be easily readable without having to indent heredocs.  Especially if editor's syntax highlighting will highlight `>` and `>>`.

----------------------------------------
Feature #9678: New heredoc syntax
https://bugs.ruby-lang.org/issues/9678#change-45948

* Author: Alexey Muranov
* Status: Open
* Priority: Normal
* Assignee: 
* Category: 
* Target version: 
----------------------------------------
For whatever it is worth, i've just had this idea of a new heredoc syntax for some programming language:

    class C
      def f(x)
        print >>Message1 + >>Message2
    Message1:
    > Literal text
    > ------------
    > Here text.
    >
    Message2:
    >> Text with interpolation and escapes
    >> -----------------------------------
    >> Here text with interpolation: #{ x }.
    >>
      end
    end



-- 
https://bugs.ruby-lang.org/

[ruby-core:61700] [CommonRuby - Feature #9678] New heredoc syntax

[alexey.muranov]

Issue #9678 has been updated by Alexey Muranov.


In fact, to be able to use text blocks without terminating "new line" character, something like this can be uses:

    print %("#{ >>MSG1 }"\n) + >>MSG2 + >>MSG3
    MSG1:
    > Some text not ending with NewLine character
    MSG2:
    > Some more text, with NewLine at the end
    >-
    MSG3:
    > And more text, without NewLine

Output:

    "Some text not ending in NewLine character"
    Some more text, with NewLine at the end
    And more text

----------------------------------------
Feature #9678: New heredoc syntax
https://bugs.ruby-lang.org/issues/9678#change-45949

* Author: Alexey Muranov
* Status: Open
* Priority: Normal
* Assignee: 
* Category: 
* Target version: 
----------------------------------------
For whatever it is worth, i've just had this idea of a new heredoc syntax for some programming language:

    class C
      def f(x)
        print >>Message1 + >>Message2
    Message1:
    > Literal text
    > ------------
    > Here text.
    >
    Message2:
    >> Text with interpolation and escapes
    >> -----------------------------------
    >> Here text with interpolation: #{ x }.
    >>
      end
    end



-- 
https://bugs.ruby-lang.org/

[ruby-core:61709] [CommonRuby - Feature #9678] [Feedback] New heredoc syntax

[nobu]

Issue #9678 has been updated by Nobuyoshi Nakada.

Status changed from Open to Feedback

Could you summarize your proposal concretely?

----------------------------------------
Feature #9678: New heredoc syntax
https://bugs.ruby-lang.org/issues/9678#change-45954

* Author: Alexey Muranov
* Status: Feedback
* Priority: Normal
* Assignee: 
* Category: 
* Target version: 
----------------------------------------
For whatever it is worth, i've just had this idea of a new heredoc syntax for some programming language:

    class C
      def f(x)
        print >>Message1 + >>Message2
    Message1:
    > Literal text
    > ------------
    > Here text.
    >
    Message2:
    >> Text with interpolation and escapes
    >> -----------------------------------
    >> Here text with interpolation: #{ x }.
    >>
      end
    end



-- 
https://bugs.ruby-lang.org/

[ruby-core:61714] [CommonRuby - Feature #9678] New heredoc syntax

[alexey.muranov]

Issue #9678 has been updated by Alexey Muranov.


I will, but want first to look closer into existing heredoc syntaxes.  I will appreciate any comments.

----------------------------------------
Feature #9678: New heredoc syntax
https://bugs.ruby-lang.org/issues/9678#change-45958

* Author: Alexey Muranov
* Status: Feedback
* Priority: Normal
* Assignee: 
* Category: 
* Target version: 
----------------------------------------
For whatever it is worth, i've just had this idea of a new heredoc syntax for some programming language:

    class C
      def f(x)
        print >>Message1 + >>Message2
    Message1:
    > Literal text
    > ------------
    > Here text.
    >
    Message2:
    >> Text with interpolation and escapes
    >> -----------------------------------
    >> Here text with interpolation: #{ x }.
    >>
      end
    end



-- 
https://bugs.ruby-lang.org/

[ruby-core:61716] [CommonRuby - Feature #9678] New heredoc syntax

[alexey.muranov]

Issue #9678 has been updated by Alexey Muranov.


I try to summarize again, hopefully better, and with a bit different syntax.

### Example

    class C
      def f(x)
        print <<Message1: + <<Message2: + <<Message3:
    Message1:
    > 1. Some text
    >    without any intepolation (#{ x }) or escape sequences (\n)
    >
    Message2:
    >> 2. Some text\
    >>    with interpolation (#{ x }) and escape sequences.\n
    Message3:
    >> 3. Some mixed text: \
    > #{ x } is replaced with
    >> #{ x }
      end
    end

    C.new.f(42)

should print

    1. Some text
       without any intepolation (#{ x }) or escape sequences (\n)

    2. Some text   with interpolation (42) and escape sequences.

    3. Some mixed text: #{ x } is replaced with
    42

### Explanation

In each line preceeded with single `>`, the leading `>` and one space are
removed, and the rest is interpreted as a single-quoted string:

    > <line content>

is the same as

    '<line content>
    '

In each line preceeded with `>>`, the leading `>>` and one space are
removed, and the rest is interpreted as a double-quoted string:

    >> <line content>

is the same as

    "<line content>
    "

Then lines are concatenated.

I hope my proposal is more clear now.

----------------------------------------
Feature #9678: New heredoc syntax
https://bugs.ruby-lang.org/issues/9678#change-45959

* Author: Alexey Muranov
* Status: Feedback
* Priority: Normal
* Assignee: 
* Category: 
* Target version: 
----------------------------------------
For whatever it is worth, i've just had this idea of a new heredoc syntax for some programming language:

    class C
      def f(x)
        print >>Message1 + >>Message2
    Message1:
    > Literal text
    > ------------
    > Here text.
    >
    Message2:
    >> Text with interpolation and escapes
    >> -----------------------------------
    >> Here text with interpolation: #{ x }.
    >>
      end
    end



-- 
https://bugs.ruby-lang.org/

[ruby-core:61727] [CommonRuby - Feature #9678] New heredoc syntax

[rr.rosas]

Issue #9678 has been updated by Rodrigo Rosenfeld Rosas.


Is it possible to start the '>' anywhere besides the first char?

~~~
def my_method
  a = <<Message1:
  Message1:
    > Some
    > content
end

~~~

Or even something anonymous like:

~~~
def my_method
  a = <<:
    > Some
    > content
end
~~~

----------------------------------------
Feature #9678: New heredoc syntax
https://bugs.ruby-lang.org/issues/9678#change-45967

* Author: Alexey Muranov
* Status: Feedback
* Priority: Normal
* Assignee: 
* Category: 
* Target version: 
----------------------------------------
For whatever it is worth, i've just had this idea of a new heredoc syntax for some programming language:

    class C
      def f(x)
        print >>Message1 + >>Message2
    Message1:
    > Literal text
    > ------------
    > Here text.
    >
    Message2:
    >> Text with interpolation and escapes
    >> -----------------------------------
    >> Here text with interpolation: #{ x }.
    >>
      end
    end



-- 
https://bugs.ruby-lang.org/

[ruby-core:61729] [CommonRuby - Feature #9678] New heredoc syntax

[alexey.muranov]

Issue #9678 has been updated by Alexey Muranov.


Rodrigo Rosenfeld Rosas wrote:
> Is it possible to start the '>' anywhere besides the first char?

Good point, why not.  My motivation was however to be able to write heredocs without indentation in a nice and clear way.

I have just thought of proposing exactly the same "anonymous" syntax.

----------------------------------------
Feature #9678: New heredoc syntax
https://bugs.ruby-lang.org/issues/9678#change-45969

* Author: Alexey Muranov
* Status: Feedback
* Priority: Normal
* Assignee: 
* Category: 
* Target version: 
----------------------------------------
For whatever it is worth, i've just had this idea of a new heredoc syntax for some programming language:

    class C
      def f(x)
        print >>Message1 + >>Message2
    Message1:
    > Literal text
    > ------------
    > Here text.
    >
    Message2:
    >> Text with interpolation and escapes
    >> -----------------------------------
    >> Here text with interpolation: #{ x }.
    >>
      end
    end



-- 
https://bugs.ruby-lang.org/

[ruby-core:61730] [CommonRuby - Feature #9678] New heredoc syntax

[rr.rosas]

Issue #9678 has been updated by Rodrigo Rosenfeld Rosas.


What should the scope for interpolation be?

~~~
def my_method
  a = 1
  b = <<:message
end

a = 2
message:
<< #{a}

my_method # what is the output?
~~~

----------------------------------------
Feature #9678: New heredoc syntax
https://bugs.ruby-lang.org/issues/9678#change-45970

* Author: Alexey Muranov
* Status: Feedback
* Priority: Normal
* Assignee: 
* Category: 
* Target version: 
----------------------------------------
For whatever it is worth, i've just had this idea of a new heredoc syntax for some programming language:

    class C
      def f(x)
        print >>Message1 + >>Message2
    Message1:
    > Literal text
    > ------------
    > Here text.
    >
    Message2:
    >> Text with interpolation and escapes
    >> -----------------------------------
    >> Here text with interpolation: #{ x }.
    >>
      end
    end



-- 
https://bugs.ruby-lang.org/

[ruby-core:61731] [CommonRuby - Feature #9678] New heredoc syntax

[alexey.muranov]

Issue #9678 has been updated by Alexey Muranov.


Rodrigo Rosenfeld Rosas wrote:
> What should the scope for interpolation be?

I had thought about it, but i did not see a better option than to require the heredoc to be defined immediately after the line where it is used, as usual.

----------------------------------------
Feature #9678: New heredoc syntax
https://bugs.ruby-lang.org/issues/9678#change-45971

* Author: Alexey Muranov
* Status: Feedback
* Priority: Normal
* Assignee: 
* Category: 
* Target version: 
----------------------------------------
For whatever it is worth, i've just had this idea of a new heredoc syntax for some programming language:

    class C
      def f(x)
        print >>Message1 + >>Message2
    Message1:
    > Literal text
    > ------------
    > Here text.
    >
    Message2:
    >> Text with interpolation and escapes
    >> -----------------------------------
    >> Here text with interpolation: #{ x }.
    >>
      end
    end



-- 
https://bugs.ruby-lang.org/

[ruby-core:61732] [CommonRuby - Feature #9678] New heredoc syntax

[alexey.muranov]

Issue #9678 has been updated by Alexey Muranov.


Yes, it has to be defined immediately, otherwise it would be impossible to reuse the same heredoc "identifier" (`Message:`).

----------------------------------------
Feature #9678: New heredoc syntax
https://bugs.ruby-lang.org/issues/9678#change-45972

* Author: Alexey Muranov
* Status: Feedback
* Priority: Normal
* Assignee: 
* Category: 
* Target version: 
----------------------------------------
For whatever it is worth, i've just had this idea of a new heredoc syntax for some programming language:

    class C
      def f(x)
        print >>Message1 + >>Message2
    Message1:
    > Literal text
    > ------------
    > Here text.
    >
    Message2:
    >> Text with interpolation and escapes
    >> -----------------------------------
    >> Here text with interpolation: #{ x }.
    >>
      end
    end



-- 
https://bugs.ruby-lang.org/

[ruby-core:61740] [CommonRuby - Feature #9678] New heredoc syntax

[alexey.muranov]

Issue #9678 has been updated by Alexey Muranov.


Some use case for fun:

      system <<:
    > ./configure
    > make
    > make install

----------------------------------------
Feature #9678: New heredoc syntax
https://bugs.ruby-lang.org/issues/9678#change-45980

* Author: Alexey Muranov
* Status: Feedback
* Priority: Normal
* Assignee: 
* Category: 
* Target version: 
----------------------------------------
For whatever it is worth, i've just had this idea of a new heredoc syntax for some programming language:

    class C
      def f(x)
        print >>Message1 + >>Message2
    Message1:
    > Literal text
    > ------------
    > Here text.
    >
    Message2:
    >> Text with interpolation and escapes
    >> -----------------------------------
    >> Here text with interpolation: #{ x }.
    >>
      end
    end



-- 
https://bugs.ruby-lang.org/

[ruby-core:61863] [CommonRuby - Feature #9678] New heredoc syntax

[alexey.muranov]

Issue #9678 has been updated by Alexey Muranov.


I have just realized this would cause a difficulty with pasting code into `irb`.  This would not be the first, however -- the following cannot be pasted into `irb` either:

    class C
      def f
        1
      end
    end

    puts C.new
      .f

----------------------------------------
Feature #9678: New heredoc syntax
https://bugs.ruby-lang.org/issues/9678#change-46082

* Author: Alexey Muranov
* Status: Feedback
* Priority: Normal
* Assignee: 
* Category: 
* Target version: 
----------------------------------------
For whatever it is worth, i've just had this idea of a new heredoc syntax for some programming language:

    class C
      def f(x)
        print >>Message1 + >>Message2
    Message1:
    > Literal text
    > ------------
    > Here text.
    >
    Message2:
    >> Text with interpolation and escapes
    >> -----------------------------------
    >> Here text with interpolation: #{ x }.
    >>
      end
    end



-- 
https://bugs.ruby-lang.org/