Di mana menempatkan metode privat di Ruby?

Sebagian besar blog atau tutorial atau buku memiliki metode privat di bagian bawah kelas / modul apa pun. Apakah ini praktik terbaik?

Saya merasa memiliki metode privat jika diperlukan lebih nyaman. Sebagai contoh:

public
def my_method
  # do something
  minion_method
end

private
def minion_method
  # do something
end

public
def next_method
end

Dengan cara ini saya menemukan kode lebih mudah dibaca daripada menggulir ke atas dan ke bawah terus menerus yang sangat menjengkelkan.

Apakah ada yang sangat salah dalam pendekatan ini? Apakah memiliki metode privat di bawah bukan hanya praktik terbaik dan sesuatu yang lain?

Praktik terbaik dalam sudut pandang saya adalah pergi secara berurutan dan mendeklarasikan metode Anda tanpa menjaga privasi dalam sudut pandang.

Pada akhirnya, Anda dapat membuat metode apa pun menjadi pribadi hanya dengan menambahkan: private :xmethod

Contoh:

class Example
 def xmethod
 end

 def ymethod
 end

 def zmethod 
 end

 private :xmethod, :zmethod

end

Apakah ini membenarkan pertanyaan Anda?

Ada juga opsi untuk menambahkan privatedefinisi metode sejak Ruby 2.1.

class Example

 def xmethod
 end

 private def ymethod
 end

 private def zmethod 
 end

end

Melihat definisinya, Anda langsung tahu jika suatu metode bersifat pribadi, di mana pun dalam file itu didefinisikan. Ini sedikit lebih mengetik (jika Anda tidak melengkapi otomatis) dan tidak semua defs Anda akan disejajarkan dengan baik.

Seperti yang telah ditunjukkan orang lain, konvensi adalah meletakkan metode privat di bagian bawah, di bawah satu kelas privat. Namun, Anda mungkin juga harus tahu bahwa banyak programmer menggunakan metode indentasi ganda (4 spasi, bukan 2) untuk ini. Alasannya adalah sering kali Anda tidak melihat "pribadi" di editor teks Anda dan menganggapnya sebagai publik. Lihat ilustrasi di bawah ini:

class FooBar

  def some_public_method
  end

  def another_public_method
  end

private

    def some_private_method
    end

    def another_private method
    end

end

Metode ini akan mencegah Anda dari keharusan untuk menggulir ke atas dan ke bawah dan akan membuat programmer lain lebih nyaman dalam kode Anda.

Saya pikir metode publik adalah semacam antarmuka objek, dan logis untuk menempatkannya di tempat yang paling menonjol yaitu di bagian atas file.

Anda tidak perlu menempatkan publicatau di privateatas setiap metode. Saya biasanya meletakkan semua metode privat saya di bagian bawah kelas saya. Juga, tidak perlu mengatakan secara eksplisit publickarena metode bersifat publik secara default. Sebagai contoh:

class FooBar

  def some_public_method
  end

  def another_public_method
  end

private

  def some_private_method
  end

  def another_private method
  end

end

Saya berasal dari latar belakang java dan saya benci harus menggulir untuk melihat jenis metode. Saya pikir itu gila bahwa seseorang tidak dapat menentukan visibilitas metode per metode tanpa kejelekan. Jadi saya akhirnya memberi komentar #privatesebelum setiap metode menyedot dan kemudian menyatakan private :....

Saya tidak suka menentukan publik atau privat untuk setiap metode. Menempatkan semua metode pribadi di bagian bawah memungkinkan saya memiliki satu contoh "pribadi" per file. Saya kira ini masalah selera.

Salah satu gayanya adalah mengelompokkan metode bersama sehingga Anda hanya menggunakan privatedan paling banyak protectedsekali per kelas. Gaya lainnya adalah menentukan visibilitas tepat setelah definisi metode:

class Example
  def my_private_method
  end
  private :my_private_method

  def my_public_method
  end
end

Sejak Ruby 2.1.0 defmengembalikan nama metode sebagai simbol, jadi gaya yang lebih ramping dimungkinkan:

class Example
  private def my_private_method
  end

  def my_public_method
  end

  protected def my_protected_method
  end

  private_class_method def self.my_private_class_method
  end
end

(Perhatikan bahwa kami menggunakan private_class_methoduntuk metode kelas - jika tidak, kami akan mendapatkannya NameError: undefined methodkarena privatemengharapkan metode instance. Bahkan ketika menggunakannya sebagai makro seperti dalam contoh asli, itu hanya memengaruhi visibilitas metode instance.)

Saya paling suka gaya visibilitas sebaris ini, karena memungkinkan Anda mengatur metode sesuai keinginan. Ini mengurangi risiko menambahkan metode baru di tempat yang salah dan secara tidak sengaja menjadikannya pribadi.

Sedangkan untuk sintaks metode kelas, Anda dapat menanganinya dengan cara ini:

class Example
  private def my_private_method
  end

  class << self
    private def my_private_class_method
    end
  end
end

Dennis punya jawaban yang tepat, yaitu saat menggunakan ruby> = 2.1, awali def dengan private (or protected, public)

Tapi saya percaya bahwa sekarang juga mungkin untuk menggunakan private sebagai blok seperti:

private begin
   def foo
   end
   def bar
   end
end

def zip
end

Saya biasanya memesan metode saya sebagai berikut:

1. Pembuat
2. Metode umum lainnya, dalam urutan abjad
3. private, ditulis hanya sekali
4. Metode pribadi, dalam urutan abjad

Saya menggunakan fitur "pergi ke definisi" di editor saya sehingga ini tidak melibatkan banyak pengguliran, dan dalam kasus apa pun, jika kelas cukup besar sehingga pengguliran menjadi masalah, mungkin harus dipecah menjadi beberapa kelas.