ยกระดับคุณภาพโค้ด Ruby ของคุณด้วย RubyCritic:การวิเคราะห์ด้วยภาพและการปรับปรุงอย่างต่อเนื่อง

RubyCritic จัดทำรายงานแบบภาพโดยเน้นกลิ่นโค้ด โครงสร้างโค้ด ความง่ายในการทดสอบ และความครอบคลุมของการทดสอบในแอปพลิเคชัน Ruby ของคุณ

อยู่ระหว่างการพัฒนา โดยมีเครื่องมือวิเคราะห์โค้ดใหม่ๆ ที่มักถูกนำมาใช้เป็นคุณลักษณะใหม่ การติดตามการเผยแพร่ของ RubyCritic นั้นคุ้มค่าอย่างยิ่ง

บทความนี้จะกล่าวถึงคุณประโยชน์บางประการของ RubyCritic การขึ้นต่อกัน และวิธีการอ่านรายงานโค้ด

ไปกันเลย!

เหตุใดจึงเลือก RubyCritic สำหรับแอปพลิเคชัน Ruby on Rails ของคุณ

คุณควรพิจารณาใช้ RubyCritic หากคุณต้องการตรวจสอบการปรับปรุงโค้ดสำหรับโปรเจ็กต์ของคุณที่เดียว การรวม RubyCritic ไว้ในกระบวนการพัฒนาของคุณจะช่วยลดเวลาที่ทีมพัฒนาใช้ในการทำงานกับหนี้ด้านเทคนิคได้อย่างแน่นอน หนี้ทางเทคนิคส่วนใหญ่จะถูกร่างไว้ในช่วงเวลาการพัฒนา

ประโยชน์บางประการที่ RubyCritic สามารถมอบให้กับโครงการและกระบวนการพัฒนาของคุณ ได้แก่:

• ข้อมูลที่รวมเป็นหนึ่งเดียวในที่เดียว
• รายงานแบบภาพ
• ติดตั้งง่าย
• การกำหนดค่าเป็นศูนย์
• อนุญาตให้ปรับแต่งได้
• สามารถขยายได้ — คุณสามารถทำการบูรณาการโอเพ่นซอร์สของคุณเองได้
• เครื่องมือสร้างป้าย 🎉

เพื่อให้เข้าใจถึงวิธีการทำงานของ RubyCritic มาดูการพึ่งพาภายในที่ใช้ในการสร้างรายงาน

การพึ่งพาภายในใน RubyCritic

เมื่อคุณเพิ่ม RubyCritic ให้กับโปรเจ็กต์ของคุณ การขึ้นต่อกันบางอย่างจะรวมอยู่ด้วย

เรามาเน้นย้ำถึงการพึ่งพาที่ทำให้เวทมนตร์เกิดขึ้น:อัญมณี Reek, Flay และ Flog การขึ้นต่อกันเหล่านี้ทำให้ RubyCritic สามารถแสดงข้อมูลอันมีค่าเกี่ยวกับโค้ดของคุณ การทำความเข้าใจวิธีการทำงานยังทำให้ RubyCritic ใช้งานได้ง่ายขึ้น

Reek:ตรวจจับกลิ่นรหัสใน Ruby

Reek เป็นอัญมณีสำหรับตรวจจับกลิ่นโค้ดใน Ruby กลิ่นเหม็นในโค้ดไม่ได้เกี่ยวกับการระบุโค้ดที่ไม่ถูกต้อง แต่เป็นเรื่องของการวิเคราะห์ว่าโค้ดสามารถเขียนได้ดีขึ้นหรือไม่

การวิเคราะห์ของ Reek ระบุว่า if บางสิ่งบางอย่างสามารถนำไปใช้ในทางอื่นได้ มันไม่ได้แนะนำว่า อย่างไร เนื่องจากกลิ่นโค้ดส่วนใหญ่เกี่ยวข้องกับตรรกะทางธุรกิจและประสบการณ์ของนักพัฒนาเกี่ยวกับภาษา

ตัวอย่างเช่น คุณสามารถเขียน 00 ใหม่ได้อย่างง่ายดาย ข้อความโดยใช้เทคนิคเมตาโปรแกรมมิง อย่างไรก็ตาม วิธีแก้ไขนั้นขึ้นอยู่กับนักพัฒนาตามบริบทของโครงการ ในกรณีนี้ ไม่มีห้องสมุดใดที่สามารถระบุวิธีแก้ปัญหาที่ดีที่สุดได้

Reek ตรวจพบรายการกลิ่นมากมาย โดยจะตรวจสอบและระบุกลิ่นที่เป็นไปได้ใน:

• ชั้นเรียน
• คุณสมบัติ
• วิธีการ
• พารามิเตอร์
• โมดูล
• ตัววนซ้ำ
• การดำเนินการของความหลากหลาย

ด้วยการค้นหากลิ่น คุณสามารถดำเนินการเพื่อทำให้โค้ดของคุณอ่านและบำรุงรักษาได้มากขึ้น

Reek อนุญาตให้กำหนดค่าแบบกำหนดเองเพื่อ:

• ปิดการใช้งานตัวตรวจจับตามประเภท
• ยกเว้นไดเรกทอรีไม่ให้ถูกสแกน
• ใช้ตัวกรองเพื่อปิดเสียงคำเตือน

คุณยังสามารถกำหนดโค้ดเฉพาะเพื่อระงับการสแกน ซึ่งเป็นคุณลักษณะที่มีประโยชน์มากเมื่อโค้ดยังไม่เสร็จสิ้นหรือปรับโครงสร้างใหม่ หรือแม้แต่โค้ดแบบเดิมก็ตาม

มาดูตัวอย่างการทำงานของ Reek กัน ในโค้ดนี้ ข้อยกเว้นถูกกำหนดไว้เพียง 18 .

มันง่ายที่จะจินตนาการว่า 25 หมายถึงข้อยกเว้น แต่จะเกิดอะไรขึ้นถ้าเรามีข้อยกเว้นอื่น ๆ ล่ะ? การระบุอย่างถูกต้องเป็นวิธีที่ดีที่สุดในการรักษาโค้ดที่ดี

Reek จะระบุ 30 เป็น UncommunicativeVariableName และแสดงคำเตือน

Flay:ตรวจสอบการทำซ้ำรหัส Ruby

Flay ระบุความคล้ายคลึงกันของโค้ด Ruby ที่มีโครงสร้าง รวมถึง:

• การตรวจจับความซ้ำซ้อนของโค้ดภายในโปรเจ็กต์
• การตรวจสอบความแตกต่างในระดับโค้ดใดๆ
• การสร้างคะแนนเพื่อวัดว่าโค้ดของคุณดีแค่ไหน (ยิ่งคะแนนต่ำ รหัสก็ยิ่งดี)

หาก Flay รายงานความคล้ายคลึงกันในโค้ดของคุณ แสดงว่าจำเป็นต้องมีการปรับโครงสร้างใหม่ อย่าละเลยสิ่งนี้! รหัสที่ซ้ำกันเป็นประตูสู่ข้อบกพร่อง หากคุณแก้ไขบางอย่างในที่เดียวแต่ลืมเรื่องอื่นไป จุดบกพร่องจะปรากฏขึ้น

เราสามารถตรวจสอบวิธีการทำงานของ Flay ได้โดยการรันมันในซอร์สโค้ดของมันเอง:

Flay ระบุความคล้ายคลึงกันระหว่างสองสิ่งนี้:

โปรดทราบว่าการสะกดของโค้ดนั้นไม่เหมือนกันทุกประการ แต่ฟังก์ชันการทำงานของโค้ดนั้นสามารถปรับเปลี่ยนโครงสร้างใหม่ได้เพื่อหลีกเลี่ยงการทำซ้ำ นั่นคือความมหัศจรรย์ของ Flay!

Flog:ตรวจสอบความซับซ้อนของโค้ดของคุณใน Ruby

Flog ตรวจสอบว่าโค้ดของคุณทดสอบได้ยากเพียงใด โดยจะกำหนดคะแนนความซับซ้อนสำหรับโค้ดแต่ละบรรทัดและสรุปคะแนนสำหรับแต่ละวิธีและคลาส

ยิ่งคะแนนสูง โค้ดของคุณก็ยิ่งจำเป็นต้องได้รับการปรับโครงสร้างใหม่มากขึ้นเท่านั้น เนื่องจากแสดงว่าคุณมีการใช้งานที่ซับซ้อนมาก

มาดูการทำงานของ Flog กัน! การเปลี่ยนแปลงเล็กน้อยอาจทำให้คะแนนของคุณเปลี่ยนแปลงได้

โปรดทราบว่าในส่วนแรกของโค้ด เรามี 45 ตรวจสอบว่าเพิ่มคะแนน 0.4 คะแนน

การพึ่งพา RubyCritic อื่นๆ

RubyCritic ยังใช้การขึ้นต่อกันของรันไทม์อื่นๆ เช่น:

• 57 - นี่เป็นการยกระดับการดีบักแอปพลิเคชัน Ruby ช่วยให้คุณสามารถรันโปรแกรมทีละบรรทัด เพิ่มเบรกพอยต์ ประเมินและติดตามค่าขณะรันไทม์ หากคุณยังคงใช้ 60 สำหรับการดีบัก ถึงเวลาที่คุณจะได้รู้จักคุณสมบัติและคำสั่งของ Byebug แล้ว
• 76 - linter สำหรับโค้ด Ruby ที่ช่วยให้คุณทำตามคำแนะนำสไตล์ที่ใช้โดยชุมชน Ruby หรือแม้แต่ใช้สไตล์โค้ดของคุณเอง การกำหนดมาตรฐานในทีมของคุณและหลีกเลี่ยงความขัดแย้งไร้สาระเกี่ยวกับช่องว่างและแท็บจะมีประโยชน์มาก
• 80 - เครื่องมือตรวจสอบความครอบคลุมของโค้ดแอปพลิเคชัน Ruby คุณสามารถกำหนดค่าให้ทำงานควบคู่ไปกับการทดสอบของคุณได้ โดยจะให้ตัวชี้วัดเกี่ยวกับการครอบคลุมของโค้ด เพื่อให้คุณสามารถระบุสิ่งที่คุณต้องให้ความสนใจและที่ที่จะใช้เวลาของคุณเพื่อสร้างกรณีทดสอบที่ดีขึ้น