DRY CRUD के साथ कोड पुनरावृत्ति से छुटकारा पाएं

पटरियों पर रूबी बस मुझे मोहित करती है, लेकिन हाल तक, सीआरयूडी नियंत्रकों की पीढ़ी एक चुनौती थी।

लगभग हमेशा मुझे छंटाई, फ़िल्टरिंग और पृष्ठांकन के साथ सूचियों को लागू करने की आवश्यकता थी, और मुझे रेल में इसे प्राप्त करने का एक मानक तरीका नहीं मिला। मैंने कई विकल्पों की कोशिश की और एक भी व्यक्ति ने मुझे संतुष्ट नहीं किया:

• मानक मचान_कंट्रोलर जनरेटर - इसमें ऐसा कुछ नहीं है, एक साधारण डिजाइन के साथ CRUD
• निफ्टी स्कैफोल्ड - इसके विकास को रोक दिया गया है, लेकिन कोई छानने और छंटाई नहीं है
• DataTable के लिए मणि - जड़ नहीं लिया, यह केवल डेटा का प्रतिनिधित्व प्रदान करता है, और आपको अपने आप को छानने और छांटने के लिए कोड लिखना होगा

लंबे समय तक मुझे Yii फ्रेमवर्क से पसंद किए गए CGridView विजेट के समान कुछ भी नहीं मिला। पहले से ही लगभग अपनी बाइक लिखने की आवश्यकता के लिए इस्तीफा दे दिया, लेकिन DRY CRUD पर ठोकर खाई और इसके उपयोग के अनुभव को साझा करना चाहते हैं। हो सकता है कि कोई इसे उपयोगी समझेगा, या हो सकता है कि कोई आपको और भी उपयुक्त उपकरण बताएगा।

स्थापना

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

gem 'dry_crud', '= 1.7.0' 

रन

 bundle install 

और जनरेटर

 rails generate dry_crud --templates haml --tests rspec 

अवसर प्रदर्शन

एक प्रदर्शन के रूप में, मैंने दो उपयोगकर्ता और पोस्ट मॉडल से एक-से-कई संबंधों से एक एप्लिकेशन बनाया।

 rails generate model User name:string email:string pass:string rails generate model Post author_id:integer title:string content:text is_draft:boolean 

मनुष्यों के लिए अधिक समझने योग्य प्रदर्शन के लिए, to_s पद्धति को परिभाषित किया गया था और निम्नलिखित मॉडल कोड प्राप्त किया गया था:

 #user.rb class User < ActiveRecord::Base attr_accessible :email, :name, :pass has_many :posts def to_s "#{name}" end end #post.rb class Post < ActiveRecord::Base attr_accessible :user_id, :content, :is_draft, :title belongs_to :user def to_s "#{title}" end end 

तब / app / नियंत्रकों फ़ोल्डर में यह एक नियंत्रक फ़ाइल बनाने के लिए पर्याप्त है और इसे CrudController से विरासत में मिला है । आप यह भी निर्दिष्ट कर सकते हैं कि कौन से कॉलम फ़िल्टरिंग प्रदान करते हैं।

 #users_controller.rb class UsersController < CrudController self.search_columns = [:name, :email] end 

यह सब, यह देखने के लिए एक फ़ोल्डर बनाने के लिए भी आवश्यक नहीं है जब तक कि आपको अधिक जटिल कार्यक्षमता की आवश्यकता न हो। हम एप्लिकेशन लॉन्च करते हैं और छंटनी (क्लिक करने योग्य कॉलम) और फ़िल्टरिंग के साथ एक काम कर रहे सीआरयूडी प्राप्त करते हैं (यदि नियंत्रक में self.search_columns स्थापित है) और पेजिनेशन को न्यूनतम प्रयास के साथ खराब किया जा सकता है और यह फ़िल्टर और सॉर्टिंग दोनों के साथ संगत होगा।


संपादन फ़ॉर्म ने भी निराश नहीं किया, यह प्रत्येक फ़ील्ड के प्रकार को निर्धारित करता है और बूलियन, स्ट्रिंग और टेक्स्ट फ़ील्ड के लिए उपयुक्त नियंत्रण का उपयोग करता है, साथ ही साथ संबंध लिंक के लिए:

और हां, यह सब अनुकूलित किया जा सकता है!

ट्विटर बूटस्ट्रैप कनेक्शन

मेरी कई परियोजनाओं में ट्विटर बूटस्ट्रैप और DRY CRUD का उपयोग बहुत ही सरल है, बस ट्विटर-बूटस्ट्रैप-रेल रत्न को कनेक्ट करें , इसे एक जनरेटर के साथ स्थापित करें

 rails generate bootstrap:install less 

एप्लिकेशन / विचार / लेआउट / crud.html.haml और /app/assets/stylesheets/sample.scss हटाएं और /app/views/layouts/application.html फिर से लिखें । रुचि रखने वाला कोई भी व्यक्ति प्रोजेक्ट का सोर्स कोड देख सकता है।
परिणामस्वरूप, हमें एक पहचानने योग्य डिज़ाइन मिलता है:

कॉलम छिपाएं

यदि उदाहरण के लिए आपको सभी नियंत्रकों में create_at और updated_at कॉलम को छिपाने की आवश्यकता है, तो बस बेस क्लास हेल्पर को बदलें।

 #/app/helpers/list_helper.rb def default_attrs attrs = model_class.column_names.collect(&:to_sym) attrs - [:id, :position, :password, :created_at, :updated_at] #<   end 

कॉलम सेट बदलें

अब उपयोगकर्ताओं में, पास कॉलम छिपाएँ और create_at जोड़ें। ऐसा करने के लिए, फ़ोल्डर / एप्लिकेशन / विचार / उपयोगकर्ता बनाएं और साझा किए गए आंशिक /app/views/crud/_form.html.hamed को कॉपी करें
पहली और एकमात्र पंक्ति = crud_table उन स्तंभों की सूची जोड़ें = crud_table जिन्हें हम देखना चाहते हैं:

 = crud_table :name, :email, :created_at 

परिणाम:

स्वरूपण सेल सामग्री

डिफ़ॉल्ट रूप से, पोस्ट की सामग्री पूर्ण रूप से प्रदर्शित होती है:

इसे 100 वर्णों पर ट्रिम करने के लिए, बस हेल्पर में format_ विधि बनाएं

 #/app/helpers/post_helper.rb module PostHelper def format_content(post) truncate(post.content, :length => 100, :omission => '...') end end 

परिणाम:

स्थानीयकरण

आप रेल L18n की क्षमताओं का उपयोग करके दृश्य को बदले बिना खेतों के लिए लेबल बदल सकते हैं। ऐसा करने के लिए, डिफ़ॉल्ट भाषा सेट करें:

 #/config/application.rb .... module DryCrudSample class Application < Rails::Application ... I18n.default_locale = :ru end end 

भाषा फ़ाइलों को उत्पन्न करने के लिए, मैंने "l18n_generator" मणि का उपयोग किया

 #Gemfile group :development do gem 'i18n_generators' end 

रेल-आई 18 एन भंडार से स्थानीय फ़ाइल डाउनलोड करें

 rails generate i18n_locale ru 

अनुवाद फ़ाइल /config/locales/en_crud.yml की प्रतिलिपि बनाएँ DRY CRUD की स्थापना के दौरान ru_crud.yml और अनुवाद करें।
हमारे मॉडल के लिए एक YAML फ़ाइल बनाएँ

 rails generate i18n_translation ru 

हमें फ़ाइल /config/locales/translation_ru.yml मिलती है जिसे मैं ru_models.yml का नाम देना पसंद करता हूं
यह केवल हमारे मॉडल के क्षेत्रों के लिए वांछित नाम लिखने के लिए बनी हुई है

एप्लिकेशन को पुनरारंभ करने के बाद, हमें एक स्थानीय इंटरफ़ेस मिलता है:

संपादन के बाद व्यवहार में परिवर्तन

चित्र खत्म हो गए हैं, एक गहरा समायोजन शुरू होता है।
डिफ़ॉल्ट रूप से, किसी प्रविष्टि को सफलतापूर्वक बनाने या संपादित करने के बाद, इस प्रविष्टि ("शो" एक्शन) को देखने के लिए एक रीडायरेक्ट होता है। मैं "इंडेक्स" समाधान के रीडायरेक्ट से अधिक परिचित था:

 #/app/controllers/crud_controller.rb def update(options = {}, &block) assign_attributes updated = with_callbacks(:update, :save) { entry.save } #respond_with(entry, options.reverse_merge(:success => updated), &block) #<-  respond_with(entry, options.reverse_merge(:success => updated, :location=> index_url), &block) # end 

create विधि में भी इसी तरह के प्रतिस्थापन की आवश्यकता थी।

फिर परियोजना में, रिकॉर्ड को संपादित करने के बाद, अपने स्वयं के संपादन फॉर्म में वापस आना आवश्यक था। हमारे पोस्ट कंट्रोलर में इसे लागू करने के लिए, आपको केवल उस update विधि को फिर से परिभाषित करना होगा जिसमें वांछित URL ट्रांसफर किया जा सके:

 #/app/controllers/posts_controller.rb def update super location: edit_post_path(params[:id]) end 

कार्रवाई कॉलम में बटन जोड़ना

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

 #routes.rb resources :posts do get :clone, :on => :member end 

इस क्रिया को कॉपी किए गए रिकॉर्ड की id प्राप्त करनी होगी और पहले से भरे हुए फ़ील्ड के साथ निर्माण फॉर्म प्रदर्शित करना होगा। सबमिट फॉर्म create एक्शन पर होंगे।
मैंने बेस क्लास में मॉडल क्लोनिंग कोड रखा:

 #/app/controllers/crud_controller.rb def duplicate_entry() set_model_ivar( find_entry.dup() ) end 

बटन पीढ़ी कोड सहायक में स्थित है:

 #/app/helpers/crud_helper.rb def action_col_clone(table, &block) action_col(table) do |e| link_table_action('list-alt', action_path(e, &block)) #       end end 

दृश्य में कॉलम स्थान पर एक नया बटन जोड़ने के लिए कोड:

 #/app/views/posts/_list.html.haml = crud_table :title, :content, :is_draft do |t| - action_col_clone t do |e| - clone_post_path e #     

सब कुछ काम कर गया। केवल दो फ़ंक्शन जोड़े गए हैं, और अब आप पूरे प्रोजेक्ट में केवल एक लाइन में "क्लोन" बटन जोड़ सकते हैं!

निष्कर्ष

वास्तव में, "डीप_क्लोनबल" रत्न का उपयोग करके, आप इसकी निर्भरता के साथ ActiveRecord की नकल कर सकते हैं। और फॉर्म में आप न केवल रिकॉर्ड को संपादित कर सकते हैं, बल्कि इसके संबंधित "has_many" के माध्यम से भी कर सकते हैं। और फिल्टर को और अधिक जटिल बनाने के लिए, न केवल एक टेक्स्टफील्ड, बल्कि कई चयन। और यह सब काफी सरल है, आंशिक रूप से प्रलेखन में वर्णित है, आंशिक रूप से स्रोत कोड के अध्ययन से समझ में आता है।

मैं इस नतीजे पर पहुंचा कि DRY CRUD बहुत लचीला और शक्तिशाली है।

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

संदर्भ

मणि DRY CRUD के लिए निर्देश
गिटहब नमूना स्रोत