🧝 🏈 🤲🏾 सैंडी मेट्ज़ डेवलपर दिशानिर्देश 🤰 ▪️ 😠

इस साल जनवरी में, Sandi Metz ने रूबी रोग पॉडकास्ट पर डेवलपर्स के लिए अपने नियम पेश किए। उसी समय, मेरी टीम और मैंने एक नई परियोजना शुरू की। यह लेख उस अनुभव का वर्णन करता है जो हमने अपने नए प्रोजेक्ट में इन नियमों को लागू करके प्राप्त किया है।

नियम

कक्षाओं में कोड की 100 से अधिक लाइनें नहीं हो सकती हैं।
विधियाँ कोड की 5 पंक्तियों से अधिक लंबी नहीं हो सकती हैं।
आप एक विधि में 4 से अधिक पैरामीटर पारित नहीं कर सकते। हैश मान को भी पैरामीटर माना जाता है।
नियंत्रणकर्ता केवल एक वस्तु को देख सकते हैं। इसलिए, एक दृश्य केवल एक चर के एक उदाहरण के बारे में जान सकता है और केवल इस ऑब्जेक्ट को संदेश भेजना चाहिए ( @object.collaborator.value मान्य नहीं है)।

नियम कब तोड़ने हैं

सैंड्री को पैराफेयर करने के लिए, "आप नियमों को तभी तोड़ सकते हैं जब आपके पास अच्छे कारण हों, या आपका प्रोग्रामिंग पार्टनर स्वीकृत हो।" आपको अपने प्रोग्रामिंग पार्टनर या अपने कोड की समीक्षा करने वाले व्यक्ति से अनुमति लेनी चाहिए।

इसे अपरिवर्तनीय नियम संख्या 0 होने दें।

100 स्ट्रिंग कक्षाएं

इस तथ्य के बावजूद कि हमारे पास बड़ी संख्या में निजी तरीके थे, कक्षाओं को छोटा रखना काफी आसान था। इसने हमें अपनी कक्षाओं की बहुत सामान्य जिम्मेदारी को परिभाषित करने और यह समझने के लिए प्रेरित किया कि किस कोड को जारी किया जाना चाहिए।

यह चश्मा पर भी लागू होता है। एक मामला था जब हमें एक फ़ाइल मिली जो इस सीमा से अधिक थी। उन्होंने हमें यह महसूस करने में मदद की कि हम कई विशेषताओं का परीक्षण कर रहे हैं। इस फाइल को कई स्पेक्स में विभाजित करने का फैसला किया गया था, जो सुविधाओं पर अधिक ध्यान केंद्रित करती हैं।

हम इस निष्कर्ष पर पहुंचे कि जब हम 100 लाइनों की सीमा से अधिक हो जाते हैं तो git diff हमें जरूरी नहीं दिखाता है।

प्रति विधि कोड की 5 लाइनें

विधि का पांच-पंक्ति प्रतिबंध सबसे दिलचस्प नियम है।
हम सहमत थे कि 'अगर', 'और', 'अंत' भी माना जाता है। दो शाखाओं वाली 'यदि' ब्लॉक में, प्रत्येक शाखा को एक पंक्ति में फिट होना चाहिए।

उदाहरण के लिए:

 def validate_actor if actor_type == 'Group' user_must_belong_to_group elsif actor_type == 'User' user_must_be_the_same_as_actor end end

5 पंक्तियों की गारंटी है कि हम 'एल्सिफ़' के साथ 'और' का उपयोग नहीं करेंगे।

प्रति शाखा एक पंक्ति की सीमा ने हमें वांछित परिणाम प्राप्त करने के लिए अच्छी तरह से डिज़ाइन किए गए नामों के साथ निजी तरीकों का उपयोग करने के लिए प्रेरित किया। निजी तरीके उत्कृष्ट दस्तावेज हैं। उन्हें बहुत स्पष्ट नामों की आवश्यकता है, जिससे हमें लगता है कि किस कोड पर प्रकाश डाला जाना चाहिए।

प्रति विधि अधिकतम 4 तर्क

रेल में इस नियम का आवेदन हमारे लिए एक महान परीक्षा बन गया है, विशेषकर विचारों में।

देखें सहायकों, जैसे कि 'link_to' या 'form_for', को सही ढंग से काम करने के लिए कई मापदंडों की आवश्यकता हो सकती है। बेशक, हमने पारित तर्कों की संख्या को सीमित करने के प्रयास किए, लेकिन कभी-कभी हम नियम 0 पर लौट आए और अगर हमें बेहतर रास्ता नहीं मिला तो उन्हें छोड़ दिया।

नियंत्रक में अधिकांश एक वस्तु पर उदाहरण

एक नए प्रोजेक्ट को शुरू करने से पहले इस नियम ने हमें सबसे ज्यादा हैरान किया। अक्सर हमें प्रति पृष्ठ एक से अधिक प्रकार की वस्तु की आवश्यकता होती है। उदाहरण के लिए, मुख पृष्ठ पर, हमें एक गतिविधि फ़ीड और एक सूचना काउंटर की आवश्यकता है।

हमने इस समस्या को फेकडे डिज़ाइन पैटर्न के माध्यम से हल किया। और ऐसा लग रहा था:

app / facades / dashboard.rb:

 class Dashboard def initialize(user) @user = user end def new_status @new_status ||= Status.new end def statuses Status.for(user) end def notifications @notifications ||= user.notifications end private attr_reader :user end

ऐप / कंट्रोलर / डैशबोर्ड_कंट्रोलर.बीआर:

 class DashboardsController < ApplicationController before_filter :authorize def show @dashboard = Dashboard.new(current_user) end end

ऐप / विचार / डैशबोर्ड / शो.html.erb:

 <%= render 'profile' %> <%= render 'groups', groups: @dashboard.group %> <%= render 'statuses/form', status: @dashboard.new_status %> <%= render 'statuses', statuses: @dashboard.statuses %>

'डैशबोर्ड' क्लास इंटरेक्टिव यूजर ऑब्जेक्ट रखने के लिए एक सामान्य इंटरफ़ेस प्रदान करता है, और हम पहले ही इसका ऑब्जेक्ट प्रेजेंटेशन टेम्प्लेट में पास कर देते हैं।

हम इस बात पर सहमत थे कि नियंत्रक में चरों को याद करना इस सीमा को प्रभावित नहीं करता है। और वे इस तथ्य को प्रतिबिंबित करने के लिए अप्रयुक्त चर के रूप में अंडरस्कोर के रूप में एक उपसर्ग जोड़ने के लिए सहमत हुए कि वे टेम्पलेट में उपयोग के लिए अभिप्रेत हैं:

 def calculate @_result_of_expensive_calculation ||= SuperCalculator.get_started(thing) end

अभूतपूर्व सफलता!

हमने हाल ही में अपने प्रयोग को सफल माना, इसे हमारी शोध मेलिंग सूची में प्रकाशित किया , और इन नियमों को हमारे सर्वोत्तम अभ्यास गाइड में शामिल किया ।

सैंडी मेट्ज़ डेवलपर दिशानिर्देश