feat: Add ruby code - chapter "array & linked list" #1158

khoaxuantu · 2024-03-19T11:34:03Z

If this pull request (PR) pertains to Chinese-to-English translation, please confirm that you have read the contribution guidelines and complete the checklist below:

This PR represents the translation of a single, complete document, or contains only bug fixes.
The translation accurately conveys the original meaning and intent of the Chinese version. If deviations exist, I have provided explanatory comments to clarify the reasons.

If this pull request (PR) is associated with coding or code transpilation, please attach the relevant console outputs to the PR and complete the following checklist:

I have thoroughly reviewed the code, focusing on its formatting, comments, indentation, and file headers.
I have confirmed that the code execution outputs are consistent with those produced by the reference code (Python or Java).
The code is designed to be compatible on standard operating systems, including Windows, macOS, and Ubuntu.

- array.rb - linked_list.rb - list.rb - my_list.rb

codes/ruby/chapter_array_and_linkedlist/linked_list.rb

krahets · 2024-03-25T19:23:25Z

codes/ruby/chapter_array_and_linkedlist/array.rb

+Author: Xuan Khoa Tu Nguyen (ngxktuzkai2000@gmail.com)
+=end
+
+# 随机访问元素


Is there another comment format to label the headings?

Is there another comment format to label the headings?

Ruby only supports # for single-line comments. So I think I will place it in a multi-line comment block. For example 🤔

Suggested change

# 随机访问元素

=begin 随机访问元素 =end

or

Suggested change

# 随机访问元素

=begin

随机访问元素

=end

=begin 随机访问元素 =end

I see. Do you think it is a common usage? And what is the industrial standard style of heading comments for Ruby?

=begin 随机访问元素 =end

I see. Do you think it is a common usage? And what is the industrial standard style of heading comments for Ruby?

Actually I barely see this usage in practice. Most of the time when I'm working with Ruby I see people prefer using the second one if they want to write a heading comment

=begin 随机访问元素 =end

It is clear enough to understand that they want to state a heading instead of a normal comment.

But in common, we use multi # more for heading comment of classes/modules/methods because the =begin...=end block only works with no indentation. If it is indented like this, then it will raise syntax error.

=begin 随机访问元素 =end => SyntaxError

If it is ok for you, I will push another commit to resolve your 2 reviews now.

I see. How about ### 随机访问元素 ###? A pythonic solution

I see. How about ### 随机访问元素 ###? A pythonic solution

That's great! We can use it as our own Ruby heading comment convention. With this format, we can even remain compatible with the whole Python sample code.

I would like to briefly summarize the incoming Ruby comment conventions for the project:

Heading comment: ### Heading ###

Inline comment: #

Multiline comment:

# Abc # Xyz # Some thing

File header:

=begin File: Created Time: Author: =end

Classes/modules/methods comment (following Yardoc conventions)

# Generate a linked list from an array # # @param [Array<Integer>] arr # # @return [ListNode] the root of the linked list def generate_from_array(arr) end

Great conclusion!

By the way, we'd like to avoid using the "Classes/modules/methods comment" to reduce the lines of the code.

codes/ruby/chapter_array_and_linkedlist/linked_list.rb

codes/ruby/utils/list_node.rb

krahets · 2024-03-27T06:32:40Z

codes/ruby/utils/print_util.rb

+=end
+
+module Utils
+  class Printer


Remove the class if it is not necessary. (In Java, every method should belong to a class)

I think it'd be good for you to refer to the Python code. It seems like Ruby is more similar to Python.

I see, I wrote them based on the Java files, I will update them based on the Python files instead.

But I see that the method linked_list_to_list in python/modules/list_node.py is different from the code in other programming languages, which are getListNode instead. Which one should I implement for the Ruby?

getListNode() and linked_list_to_list() are both not called in the source code
I'll remove the getListNode() for all the languages.

docs/chapter_array_and_linkedlist/linked_list.md

krahets

Thanks for the clean code! Looking forward to your next PR

krahets · 2024-03-30T19:52:14Z

docs/chapter_array_and_linkedlist/list.md

+
+    ```ruby title="list.rb"
+    # 访问元素
+    num = nums[1]


The comments is not consistent with Python version

krahets · 2024-03-30T19:52:22Z

docs/chapter_array_and_linkedlist/list.md

+    nums << 4
+
+    # 在中间插入元素
+    nums.insert 3, 6


Same as above

krahets · 2024-03-30T19:52:31Z

docs/chapter_array_and_linkedlist/list.md

+    nums.insert 3, 6
+
+    # 删除元素
+    nums.delete_at 3


Same as above

krahets · 2024-03-30T20:02:54Z

@khoaxuantu I've added Ruby code blocks to the document in #1200 and it's more convenient to add the code.

And I found inconsistency of comments between Ruby and Python. Please fix them and carefully check the code.

Moreover, you don't have to add Ruby code to en/docs English version. I'll handle them after completing the Ruby translation.

khoaxuantu · 2024-03-31T02:55:53Z

And I found inconsistency of comments between Ruby and Python. Please fix them and carefully check the code.

Moreover, you don't have to add Ruby code to en/docs English version. I'll handle them after completing the Ruby translation.

Got it! I have opened a new pull request at #1202 to fix the inconsistent comments. Please help me to review it.

feat: add ruby code chapter array & linked list

96e337a

- array.rb - linked_list.rb - list.rb - my_list.rb

khoaxuantu commented Mar 19, 2024

View reviewed changes

codes/ruby/chapter_array_and_linkedlist/linked_list.rb Outdated Show resolved Hide resolved

feat: add ruby code blocks

bf852d3

krahets reviewed Mar 25, 2024

View reviewed changes

Merge branch 'main' into ruby

f9678af

khoaxuantu force-pushed the ruby branch 2 times, most recently from f028f32 to 986571f Compare March 27, 2024 01:59

krahets added the code Code-related label Mar 27, 2024

krahets reviewed Mar 27, 2024

View reviewed changes

codes/ruby/chapter_array_and_linkedlist/linked_list.rb Outdated Show resolved Hide resolved

krahets reviewed Mar 27, 2024

View reviewed changes

codes/ruby/utils/list_node.rb Outdated Show resolved Hide resolved

krahets reviewed Mar 27, 2024

View reviewed changes

docs/chapter_array_and_linkedlist/linked_list.md Outdated Show resolved Hide resolved

chore: fix convention

17c323b

khoaxuantu force-pushed the ruby branch from 986571f to 17c323b Compare March 29, 2024 08:43

khoaxuantu requested a review from krahets March 29, 2024 18:26

krahets approved these changes Mar 30, 2024

View reviewed changes

krahets merged commit 85ca4cc into krahets:main Mar 30, 2024
1 check passed

khoaxuantu deleted the ruby branch March 30, 2024 11:34

krahets reviewed Mar 30, 2024

View reviewed changes

docs/chapter_array_and_linkedlist/list.md

nums << 4

# 在中间插入元素

nums.insert 3, 6

Copy link

Owner

krahets Mar 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above

krahets reviewed Mar 30, 2024

View reviewed changes

docs/chapter_array_and_linkedlist/list.md

nums.insert 3, 6

# 删除元素

nums.delete_at 3

Copy link

Owner

krahets Mar 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above

khoaxuantu mentioned this pull request Apr 9, 2024

Code Transpilation to Ruby (Help Wanted) #1253

Open

59 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add ruby code - chapter "array & linked list" #1158

feat: Add ruby code - chapter "array & linked list" #1158

khoaxuantu commented Mar 19, 2024

krahets Mar 25, 2024

khoaxuantu Mar 26, 2024

krahets Mar 26, 2024

khoaxuantu Mar 26, 2024 •

edited

krahets Mar 26, 2024 •

edited

khoaxuantu Mar 27, 2024

krahets Mar 27, 2024

krahets Mar 27, 2024

krahets Mar 27, 2024 •

edited

khoaxuantu Mar 27, 2024

krahets Mar 30, 2024

krahets left a comment •

edited

krahets Mar 30, 2024

krahets Mar 30, 2024

krahets Mar 30, 2024

krahets commented Mar 30, 2024

khoaxuantu commented Mar 31, 2024

feat: Add ruby code - chapter "array & linked list" #1158

feat: Add ruby code - chapter "array & linked list" #1158

Conversation

khoaxuantu commented Mar 19, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

khoaxuantu Mar 26, 2024 • edited

Choose a reason for hiding this comment

krahets Mar 26, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

krahets Mar 27, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

krahets left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

krahets commented Mar 30, 2024

khoaxuantu commented Mar 31, 2024

khoaxuantu Mar 26, 2024 •

edited

krahets Mar 26, 2024 •

edited

krahets Mar 27, 2024 •

edited

krahets left a comment •

edited