Rails/configuring

من موسوعة حسوب
< Rails
مراجعة 15:24، 9 مارس 2019 بواسطة جميل-بيلوني (نقاش | مساهمات) (أنشأ الصفحة ب'ضبط تطبيقات ريلز يغطي هذا الدليل ميزات الضبط والتهيئة المتاحة لتطبيقات ريلز. بعد قراءة هذا ا...')
(فرق) → مراجعة أقدم | المراجعة الحالية (فرق) | مراجعة أحدث ← (فرق)
اذهب إلى التنقل اذهب إلى البحث

ضبط تطبيقات ريلز

يغطي هذا الدليل ميزات الضبط والتهيئة المتاحة لتطبيقات ريلز. بعد قراءة هذا الدليل، ستتعلم:

  • كيفية ضبط سلوك تطبيقات ريلز.
  • كيفية إضافة شيفرة مصدريّة إضافية لتنفيذها وقت بدء تشغيل التطبيق.

مواقع شيفرة التهيئة والضبط

يوفر ريلز أربعة مواضع رئيسيّة لوضع الشيفرة المصدريّة للتهيئة:

  • config/application.rb
  • ملفات الضبط (configuration) الخاصة بالبيئة
  • المهيآت (Initializers)
  • ما بعد المهيآت (After-initializers)

تشغيل شيفرة برمجية قبل ريلز

في الحدث النادر الذي يحتاج تطبيقك لتشغيل بعض الشيفرات البرمجية قبل تحميل ريلز نفسه، ضعها قبل استدعاء require 'rails/all'‎ في config/application.rb.

إعداد مكونات ريلز

بشكل عام، تعني مهمة إعداد ريلز إعداد مكونات ريلز بالإضافة إلى ريلز نفسه، يسمح لك ملف الضبط config/application.rb وملفات الضبط الخاصة بالبيئة (مثل الملف config/environments/production.rb) بتحديد الإعدادات المتنوّعة التي تريد تمريرها إلى كافة المكونات.

على سبيل المثال، يمكنك إضافة هذا الإعداد إلى الملف config/application.rb:

config.time_zone = 'Central Time (US & Canada)'

هذه إعدادات لريلز نفسه، إذا كنت ترغب في تمرير الإعدادات إلى مكونات Rails فرديّة، فيمكنك القيام بذلك عبر نفس كائن الضبط في config/application.rb:

config.active_record.schema_format = :ruby

سيستخدم ريلز هذا الإعداد لضبط السجل الفعال.

إعدادات ريلز العامة

ستُستدعى توابع الإعدادات هذه على الكائن Rails::Railtie مثل صنف فرعي من Rails::Engine أو Rails::Application.

  • config.after_initialize: يأخذ الكتلة التي سيتم تنفيذها بعدما ينتهي ريلز من تهيئة التطبيق، ويتضمّن هذا تهيئة الإطار نفسه، والمحركات، وجميع مهيئات التطبيق في config/initializers، لاحظ أن هذه الكتلة ستُنفَّذ لمهام البداية، وهي مفيدة لضبط القيم المعدّة بواسطة مهيئات أخرى:
config.after_initialize do
  ActionView::Base.sanitized_allowed_tags.delete 'div'
end
  • config.asset_host: يعيّن المضيف للأصول (assets)، وهو مفيدة عندما يُستخدم CDN لاستضافة الأصول أو عندما تريد العمل حول قيود التزامن المضمنة في المتصفحات باستخدام أسماء النطاقات المستعارة المختلفة. وهي نسخة مختصرة لـ config.action_controller.asset_host.
  • config.autoload_once_paths: يقبل مصفوفة من المسارات التي سيحمل ريلز تلقائيًّا الثوابت منها التي لن تمسح لكل طلب، وهي مناسبة إذا كان config.cache_classes يساوي false، والتي هي الحالة الافتراضيّة لوضع التطوير. وخلاف ذلك، يحدث كل التحميل التلقائي مرّة واحدة فقط، ويجب أن تكون جميع عناصر هذه المصفوفة في autoload_paths. بشكل افتراضي هي مصفوفة فارغة.
  • config.autoload_paths: يقبل مصفوفة من المسارات التي يحمل ريلز بشكل تلقائي الثوابت منها، وبشكل افتراضي هي جميع المجلدات داخل app، ولم يعد من المستحسن ضبط هذا، راجع الثوابت المحملة والمعاد تحميلها تلقائيًّا.
  • config.cache_classes: يتحكم ما إذا كان يجب إعادة تحميل أصناف التطبيق والوحدات في كل طلب، وبشكل افتراضي تكون قيمتها false في وضع التطوير و true  في أوضاع الاختبار والإنتاج.
  • config.beginning_of_week: يعيّن بداية الأسبوع الافتراضيّة للتطبيق، وهو يقبل رمزًا يمثِّل يوم أسبوع صحيح (على سبيل المثال ‎:monday).
  • config.cache_store: يضبط أي تخزين مؤقت يراد استخدامه في ريلز. تتضمن الخيارات أحد الرموز التالية: ‎:memory_store، أو ‎:file_store، أو ‎:mem_cache_store، أو ‎:null_store أو كائن يطبّق واجهة برمجة التطبيقات لذاكرة التخزين المؤقت، ويكون افتراضيًا مساويًا إلى ‎:file_store.
  • config.colorize_logging: يحدد استخدام رموز ألوان ANSI أو لا عند تسجيل المعلومات، وقيمته الافتراضية هي true.
  • config.consider_all_requests_local: هو راية. إذا كان مساوي للقيمة true، فأي خطأ سيؤدي إلى تفريغ معلومات التنقيح في استجابة HTTP، وسيعّرض متحكم Rails::Info سياق وقت التشغيل للتطبيق في ‎/rails/info/properties. وقيمته true بشكل افتراضي في وضع التطوير والاختبار، و false في وضع الإنتاج. وللتحكم به بشكل دقيق، اضبط هذه الراية إلى القيمة false ونفّذ local_request?‎ في المتحكم لتحديد أي طلبات يجب توفير معلومات التنقيح على الأخطاء.
  • config.console: يسمح لك بتعيين الصنف الذي سيُستخدم كطرفية عند تنفيذ rails console، ومن الأفضل تنفيذه في الكتلة console.
console do
  # فقط console تستدعى هذه الكتلة عند تنفيذ
  # هنا pry وبذلك يمكننا بأمان طلب
  require "pry"
  config.console = Pry
end
  • config.eager_load: عندما تكون قيمته true، ستحمّل جميع تسجيلات config.eager_load_namespaces بشكل حثيث. ويتضمن هذا تطبيقك، والمحركات، وأطر ريلز وأي مجالات أسماء مسجلة (registered namespace) أخرى.
  • config.eager_load_namespaces: يسّجل مجالات الأسماء التي ستحمّل بشكل حثيث عندما يكون config.eager_load مساويًا إلى القيمة true. يجب أن تستجيب جميع مجالات الأسماء إلى التابع eager_load!‎.
  • config.eager_load_paths: يقبل مصفوفة من المسارات التي سيحمّل ريلز منها عند بدء التشغيل بشكل حثيث إذا كانت أصناف ذاكرة التخزين المؤقت مفعّلة. تُعيَّن قيمته الافتراضية إلى كل مجلد في المجلد app الخاصة بالتطبيق.
  • config.enable_dependency_loading: عندما يكون true، فسيُفعَّل التحميل التلقائي، حتى إذا كان التطبيق محمل بشكل حثيث وكان config.cache_classes مضبوطًا إلى القيمة true. قيمته الافتراضية هي false.
  • config.encoding: تعمل على إعداد الترميز على مستوى التطبيق، وهي بشكل افتراضي تساوي UTF-8.
  • config.exceptions_app: تعيّن استثناءات التطبيق المستدعية بواسطة الوسيط ShowException عند حدوث الاستثناء. قيمته الافتراضية هي ActionDispatch::PublicExceptions.new(Rails.public_path)‎.
  • config.debug_exception_response_format: تعيّن التنسيق المستخدم في الاستجابات عند حدوث الأخطاء في وضع التطوير. قيمته الافتراضية هي: ‎:api لتطبيقات ذات الواجهة البرمجية فقط و ‎:default للتطبيقات العادية.
  • config.file_watcher: هو الصنف المستخدم للكشف عن تحديثات الملف في نظام الملفات عندما يكون config.reload_classes_only_on_change مضبوطًا إلى القيمة true. ويأتي ريلز مع ActiveSupport::FileUpdateChecker - الافتراضي -، و ActiveSupport::EventedFileUpdateChecker (يعتمد هذا على الجوهرة listen) ويجب أن تتوافق الأصناف المخصصة مع واجهة برمجة التطبيقات ActiveSupport::FileUpdateChecker.
  • config.filter_parameters: يُستخدم لتصفيّة المعاملات التي لا تريد عرضها في السجلات، مثل كلمات المرور وأرقام بطاقات الائتمان، وبشكل افتراضي، يصفي ريلز كلمات المرور عن طريق إضافة Rails.application.config.filter_parameters += [:password]‎ في config/initializers/filter_parameter_logging.rb. وتعمل عملية ترشيح المعاملات من خلال مطابقة التعبير النمطي بشكل جزئي.
  • config.force_ssl: يجبر جميع الطلبات أن تُخدم عبر HTTPS عن طريق استخدام الوسيط ActionDispatch::SSL، ويعيّن config.action_mailer.default_url_options ليكون { protocol: 'https'‎ }. ويمكن ضبط ذلك عن طريق الإعداد config.ssl_options، - يمكنك مراجعة توثيق ActionDispatch::SSL لمزيد من المعلومات.
  • config.log_formatter: يعّرف منسّق مسجّل ريلز، وهذا الخيار الافتراضي لنسخة ActiveSupport::Logger::SimpleFormatter لجميع الأوضاع، وإذا عيّنت قيمة للإعداد config.logger، فيجب عليك أن تمرر قيمة المنسّق (formatter) إلى المسجّل قبل تغليفه في النسخة ActiveSupport::TaggedLogging، ولن يفعل ريلز ذلك بالنيابة عنك.
  • config.log_level: يعرّف مستوى تفصيل مسجّل ريلز. القيمة الافتراضية هي ‎:debug لجميع البيئات، ومستويات السجل المتوافرة هي: ‎:debug، و ‎:info، و ‎:warn، و ‎:error، و ‎:fatal، و ‎:unknown.
  • config.log_tags: يقبل قائمة من: التوابع التي يستجيب لها كائن الطلب request، أو كائن من النوع Proc يقبل كائن الطلب request، أو شيئًا يستجيب إلى to_s. هذا يجعل من وضع علامة على أسطر السجل أسهل مع تنقيح المعلومات مثل النطاق الفرعي و معرّف الطلب - وكلاهما مفيد للغاية في تنقيح تطبيقات متعددة المستخدمين في بيئة الإنتاج.
  • config.logger: هو السجل الذي سيُستخدم لـ Rails.logger وأي تسجيل ريلز ذا صلة مثل ActiveRecord::Base.logger. القيمة الافتراضية له هي نسخة من ActiveSupport::TaggedLogging الذي يغلف نسخة من ActiveSupport::Logger والتي ستُسجَّل مخرجاته في المجلد log/. يمكنك توفير مسجّل مخصّص، وللحصول على التوافق الكامل، يجب عليك اتباع هذه الإرشادات:
    • لإعتماد منسّق، يجب عليك تعيين منسّق بشكل يدوي من قيمة الضبط config.log_formatter إلى المُسجّل.
    • لدعم السجلات الموسومة (tagged logs)، يجب تغليف النسخة log مع ActiveSupport::TaggedLogging.
    • لدعم الوضه الصامت (silencing)، يجب أن يتضمّن المسجّل الوحدات LoggerSilence و ActiveSupport::LoggerThreadSafeLevel. الصنف ActiveSupport::Logger متضمن بالفعل في هذه الوحدات.
class MyLogger < ::Logger
  include ActiveSupport::LoggerThreadSafeLevel
  include LoggerSilence
end
 
mylogger           = MyLogger.new(STDOUT)
mylogger.formatter = config.log_formatter
config.logger      = ActiveSupport::TaggedLogging.new(mylogger)
  • config.middleware: يسمح لك بتهيئة وسيط التطبيق، ولقد غطيّنا هذا بالتفصيل في قسم ضبط الوسيط في الأسفل.
  • config.reload_classes_only_on_change: يتيح لك تفعيل أو تعطيل إعادة تحميل الأصناف فقط عندما تتغيّر الملفات المتعقبة. وهو بشكل افتراضي يتعقّب كل شيء على مسارات إعادة التحميل ويُعيّن إلى القيمة true، وإذا كان config.cache_classes هو true، فسيُتجاهل هذا الخيار.
  • secret_key_base: يُستخدَم لتحديد المفتاح الذي يسمح بالتحقق من جلسات التطبيق ضد المفتاح الآمن المعروف لمنع التلاعب. يحصل التطبيق على مفتاح تم إنشاؤه عشوائيًا في بيئات الاختبار والتطوير، ويجب على البيئات الاخرى تعيين واحد في config/credentials.yml.enc.
  • config.public_file_server.enabled: يضبط ريلز لخدمة ملفات ثابتة من المجلّد العام، وتكون قيمته true بشكل افتراضي، لكن في بيئة الإنتاج تكون false لأنه  يجب على البرنامج الخادم (على سبيل المثال Apache أو NGINX) الذي يُستخدَم لتشغيل التطبيق أن يخدّم الملفات الثابتة بدلًا من ذلك. فإذا كنت تشغّل أو تجرّب التطبيق في وضع الإنتاج باستخدام WEBrick (لا يوصى باستخدام WEBrick في الإنتاج)، عين القيمة true لهذا الخيار، وإلا، فلن تتمكّن من استخدام التخزين المؤقت للصفحة وطلب الملفات الموجودة ضمن الدليل العام.
  • config.session_store: يعيّن الصنف الذي يجب استخدامه لتخزين الجلسة، والقيم المحتملة له هي ‎:cookie_store (القيمة الافتراضية)، و ‎:mem_cache_store و ‎:disabled. وهذا الأخير يخبر ريلز بعدم التعامل مع الجلسات. بشكل افتراضي مخزن ملفات تعريف الارتباط مع اسم التطبيق كمفتاح للجلّسة، ويمكن تحديد مخازن الجلسات المخصّصة:
config.session_store :my_custom_store

يجب تعرف هذا المخزن كـ ActionDispatch::Session::MyCustomStore.

  • config.time_zone: يعيّن المنطقة الزمنيّة الافتراضيّة للتطبيق ويفعّل المنطقة الزمنيّة للسجل الفعال.

ضبط الأصول (Assets)

  • config.assets.enabled: هو راية تتحكّم في تمكين خط الأنابيب (pipeline) الخاص بالأصول، وقيمته true بشكل افتراضي.
  • config.assets.css_compressor: يعرّف ضاغط شيفرة CSS المراد استعماله، ويكون sass-rails بشكل افتراضي، والقيمة البديلة الفريدة في الوقت الحالي هي ‎:yui والتي تستخدم الجوهرة yui-compressor.
  • config.assets.js_compressor: يعرّف ضاغط شيفرة JavaScript المراد استخدامه، والقيم المحتملة له هي ‎:closure، و ‎:uglifier، و ‎:yui والتي تتطلّب استخدام الجواهر closure-compiler أو uglifier أو yui-compressor على التوالي.
  • config.assets.gzip: هو راية تمكّن من إنشاء إصدار نسخة مضغوطة بملف gzip من الأصول المترّجمة جنبًا إلى جنب مع الأصول الغير مضغوطة (non-gzipped). قيمته الافتراضية هي true.
  • config.assets.paths: يحتوي على المسارات المستخدمة للبحث عن الأصول، سيؤدي إضافة المسارات إلى خيار الضبط هذا إلى استخدام هذه المسارات في البحث عن الأصول.
  • config.assets.precompile: يسمح لك بتحديد أصول إضافيّة (بخلاف application.css و application.js) والتي يجب تحويلها إلى أصول مفسرة مسبقًا (precompiled) عند تنفيذ الأمر rake assets:precompile.
  • config.assets.unknown_asset_fallback: يتيح لك تعديل سلوك خط أنابيب الأصول عندما لا يكون الأصل في خط الأنابيب، إذا كنت تستخدم sprockets-rails 3.2.0 أو إصدار أحدث منه. القيمة الافتراضية هي false.
  • config.assets.prefix: يعرّف البادئة حيث تكون الأصول موجودة فيه، وهي ‎/assets بشكل افتراضي.
  • config.assets.manifest: تعرّف المسار الكامل ليُستخدم في ملف بيان (precompiler) للأصول. وهو بشكل افتراضي ملف يسمى manifest-<random>.json في مجلّد config.assets.prefix ضمن المجلد العام.
  • config.assets.digest: يتيح لك استخدام بصمات SHA256 في أسماء الأصول، وهو true بشكل افتراضي.
  • config.assets.debug: يعطّل سَلسَلة وضغط الأصول، وهو true بشكل افتراضي في development.rb.
  • config.assets.version: عبارة على سلسلة نصيّة اختياريّة تُستخدم في توليد SHA256 hash، ويمكن تغيير هذا لإجبار جميع الملفات على أن تكون معاد تصريفها (recompiled).
  • config.assets.compile: هو متغير منطقي يمكن استخدامه لتشغيل تجميع الحي لـ Sprockets في الإنتاج.
  • config.assets.logger: يقبل مسجلًا يتطابق مع واجهة Log4r أو مع صنف روبي Logger الافتراضي، وهو بشكل افتراضي يملك نفس ضبطات في config.logger، وعندما تكون قيمة config.assets.logger تساوي false، فسيتوقّف تسجيل الأصول.
  • config.assets.quiet: يعطّل تسجيل طلبات الأصول، وهو true بشكل افتراضي في development.rb.

ضبط المولدات

يسمح لك ريلز بتغيير المولدات التي تُستخدم مع أسلوب config.generators، ويأخذ هذا الأسلوب كتلة:

config.generators do |g|
  g.orm :active_record
  g.test_framework :test_unit
end

هذه هي المجموعة الكاملة من الأساليب التي يمكن استخدامها في هذه الكتلة كالتالي:

  • assets: تسمح لك بإنشاء الأصول عند توليد السقالة، وهي true بشكل افتراضي.
  • force_plural: يسمح لك بوضع أسماء النموذج بصيغة الجمع، وهي false بشكل افتراضي.
  • helper: يعرّف ما إذا كان سيتم توليد المساعدين، وهو true بشكل افتراضي.
  • integration_tool: تعرّف ما هي أداة التكامل التي يمكن استخدامها لإنشاء اختبارات التكامل، وهي ‎:test_unit بشكل افتراضي.
  • system_tests: يعرّف الأداة التي يجب استخدامها لتوليد اختبارات النظام، وهي ‎:test_unit بشكل افتراضي.
  • javascripts: يشغّل الخطاف (hook) لملفات JavaScript في المولدات. ويُستخدم في ريلز عند عمل المولّد scaffold. قيمته الافتراضية هي: true.
  • javascript_engine: يضبط المحرّك المراد استخدامه (على سبيل المثال coffee) عند توليد الأصول، وهو بشكل افتراضي ‎:js.
  • orm: يعرّف أي تقنية ORM يراد استعمالها. القيمة الافتراضية هي false وسيستخدم بذلك السجل الفعال.
  • resource_controller: يعرّف المولّد الذي سيُستخدم لتوليد المتحكم عند استخدام rails generate resource ويساوي ‎:controller بشكل افتراضي.
  • resource_route: يعرّف ما إذا كان يجب توليد تعريف مسار المورد (resource) أو لا، وهو true بشكل افتراضي.
  • scaffold_controller: يختلف عن resource_controller، إذ يحدّد أي من المولدات سيُستخدم لتوليد متحكم ذي سقالة (scaffolded controller) عند استخدام rails generate scaffold وهو ‎:scaffold_controller بشكل افتراضي.
  • stylesheets: يشغّل الخطاف (hook) لأوراق الأنماط (stylesheets) في المولدات، ويُستخدم في ريلز عند عمل المولّد scaffold، لكن يمكن استخدام هذا الخطاف في مولدات أخرى كذلك، وهو true بشكل افتراضي.
  • stylesheet_engine: يضبط محرّك أوراق الأنماط (مثل sass) الذي يجب استخدامه عند توليد الأصول، وهو ‎:css بشكل افتراضي.
  • scaffold_stylesheet: ينشئ scaffold.css عند توليد مورد دي سقالة، وهو true بشكل افتراضي.
  • test_framework: يعرّف أي إطار اختبار يجب استخدامه، وهو false وسيستخدم Minitest بشكل افتراضي.
  • template_engine: يعرّف محرك القوالب المراد استخدامه، مثل ERB أو Haml، وهو ‎:erb بشكل افتراضي.

ضبط البرمجيات الوسيطة

يأتي كل تطبيق ريلز مع مجموعة قياسيّة من البرامج الوسيطة (middleware) التي تُستخدم في هذا الترتيب في بيئة التطوير:

  • ActionDispatch::SSL: يفرض أن يُخدم كل طلب باستخدام HTTPS، وهو مفعّل إذا كان config.force_ssl يساوي true، ويمكن ضبط الخيارات الممرّرت إلى هذا عن طريق تعيين config.ssl_options.
  • ActionDispatch::Static: يُستخدم لخدمة الأصول الثابتة، وهو معطّل إذا كان config.public_file_server.enabled يساوي false. عيّن config.public_file_server.index_name إذا أردت تخديم ملف فهرس مجلد ثابت لا يسمى index، فعل سبيل المثال، لتخديم main.html بدلًا من index.html لطلبات المجلد. اضبط config.public_file_server.index_name إلى "main".
  • ActionDispatch::Executor: يسمح بإعادة تحميل شيفرة البرمجية الخاصة بالخيط، وهو معطّل إذا كان config.allow_concurrency يساوي false، مما يؤدي إلى تحميل Rack::Lock، ويلف هذا الأخير التطبيق في كائن المزامنة بحيث يمكن الاتصال به فقط بواسطة خيط واحد في كل مرّة.
  • ActiveSupport::Cache::Strategy::LocalCac يعمل كذاكرة تخزين أساسيّة لدعم ذاكرة التخزين المؤقت، وهذه الذاكرة ليست خيطًا آمنًا، وتعمل كذاكرة تخزين مؤقت للخيط الواحدة.
  • Rack::Runtime: يعيّن الترويسة X-Runtime التي تحتوي على الوقت (بالثواني) المنقضى لتنفيذ الطلب.
  • Rails::Rack::Logger: يخطر السجلات بأن الطلب قد بدأ. وبعد اكتمال الطلب، تُمسَح جميع السجلات.
  • ActionDispatch::ShowExceptions: ينقذ (rescues) أي استثناء يعاد من خلال التطبيق ويعرض صفحات استثناء لطيفة إذا كان الطلب محليًا أو إذا كان config.consider_all_requests_local يساوي true. وإذا كان الضبط config.action_dispatch.show_exceptions يساوي false، فسترمى الاستثناءات بصرف النظر عن ذلك.
  • ActionDispatch::RequestId: يجعل الترويسة X-Request-Id الفريدة متاحة إلى الاستجابة ويفعّل التابع ActionDispatch::Request.uuid.
  • ActionDispatch::RemoteIp يتحقق من هجمات انتحال IP ويحصل على client_ip صالح من ترويسات الطلبات، وهو قابل للضبط باستخدام الخيارين config.action_dispatch.ip_spoofing_check و config.action_dispatch.trusted_proxies.
  • Rack::Sendfile: يعالج الاستجابات التي يُخدَّم نصفها من ملف ويستبدله بالترويسة X-Sendfile الخاصة بالخادم. وهو قابل للضبط باستخدام config.action_dispatch.x_sendfile_header.
  • ActionDispatch::Callbacks يشغّل ردود النداء (callbacks) للتحضير قبل تخديم الطلب.
  • ActionDispatch::Cookies: يعيّن ملفات تعريف الإرتباط للطلب.
  • ActionDispatch::Session::CookieStore: هو المسؤول عن تخزين جلسة العمل في ملفات تعريف الارتباط، ويمكن استخدام وسيط بديل لهذا من خلال تغيير config.action_controller.session_store إلى قيمة بديلة. وبالإضافة إلى ذلك، يمكن تكون الخيارات الممرّرت باستخدام config.action_controller.session_options.
  • ActionDispatch::Flash: يُعدّ مفاتيح الوصول اللحظي (flash keys)، وهو متاح فقط في حالة تعيين config.action_controller.session_store إلى قيمة.
  • Rack::MethodOverride يسمح للأسلوب بإعادة كتابته (overridden) إذا عيّن params[:_method]‎، وتدعم هذه الوسيطة أنواع التوابع HTTP و PATCH وPUT و DELETE.
  • Rack::Head يحوّل طلبات HEAD إلى طلبات GET ويخدّمهم.

إلى جانب هذه البرمجيات الوسيطة المعتادة، يمكنك إضافة البرمجيات الوسيطة الخاصة بك باستخدام التابع config.middleware.use:

config.middleware.use Magical::Unicorns

سيضع هذا وسيطة Magical::Unicorns في نهاية المكدّس، يمكنك استخدام insert_before إذا كنت ترغب في إضافة برامج وسيطة قبل الأخرى.

config.middleware.insert_before Rack::Head, Magical::Unicorns

أو يمكنك إدراج وسيطة في موقع محدد باستخدام الفهارس، فعلى سبيل المثال، إذا كنت تريد إدراج وسيطة Magical::Unicorns في أعلى المكدّس، فيمكنك القيام بذلك كالتالي:

config.middleware.insert_before 0, Magical::Unicorns

هنالك أيضًا insert_after والتي تدرج الوسيطة بعد الأخرى:

config.middleware.insert_after Rack::Head, Magical::Unicorns

يمكن أيضًا تبديل الوسائط واستبدالها:

config.middleware.swap ActionController::Failsafe, Lifo::Failsafe

يمكنك أيضًا إزالتها من المكدس تمامًا:

config.middleware.delete Rack::MethodOverride

ضبط الواجهة البرمجية لتدويل ريلز (i18n)

يتم تفويض جميع خيارات الضبط إلى المكتبة I18n.

  • config.i18n.available_locales: تعرض القوائم البيضاء للمحليات (locale) المتوفّرة للتطبيق. وهي بشكل افتراضي لجميع مفاتيح المحليّة الموجودة في الملفات المحليّة، وهي في لاعادة ‎:en في التطبيق الجديد.
  • config.i18n.default_locale: تعيّن المحلي الافتراضي للتطبيق المستخدم في I18n، وهي بشكل افتراضي تساوي ‎:en.
  • config.i18n.enforce_available_locales: يضمن أن جميع المحليات التي مرّت عبر I18n قد أُعلن عنها في قائمة available_locales، وسيرمي استثناء I18n::InvalidLocale عند إعداد محلي غير متوفّر، وهي بشكل افتراضي true، ومن المستحسن عدم تعطيل هذا الخيار ما لم يكن مطلوبًا بشدّة، حيث يعمل هذا كمقياس أمان ضد تعيين أي محلي غير صالح من المدخلات المستخدم.
  • config.i18n.load_path: يعيّن المسار الذي يستخدمه ريلز للبحث عن الملفات المحليّة، وهي بشكل افتراضي تساوي config/locales/*.{yml,rb}‎.
  • config.i18n.fallbacks: يعيّن السلوك الاحتياطي للترجمات المفقودة، وهذه 3 أمثلة استخدام لهذا الخيار:
    • يمكنك تعيين الخيار على true لاستخدام المحلي الافتراضي:
config.i18n.fallbacks = true
    • أو يمكنك تعيين مجموعة من المحليات، كالتالي:
config.i18n.fallbacks = [:tr, :en]
    • أو يمكنك تعيين محليات اللجوء بشكل فردي، فعلى سبيل المثال، إذا أردت استخدام ‎:tr لـ ‎:az و ‎:de، و ‎:en لـ ‎:da كلجوء، فيمكنك فعل ذلك على طريق:
config.i18n.fallbacks = { az: :tr, da: [:de, :en] }
# أو
config.i18n.fallbacks.map = { az: :tr, da: [:de, :en] }

ضبط السجل الفعال

يتضمّن config.active_record مجموعة متنوّعة من خيارات الضبط:

  • Config.active_record.logger يقبل مسجلًا يتطابق مع واجهة Log4r أو صنف Ruby Logger الافتراضي، والتي تمرر بعد ذلك إلى أي اتصالات قاعدة بيانات جديدة تم إنشاؤها، يمكنك استرداد هذا السجل من خلال استدعاء logger إنا في صنف نموذج السجل النشك أو في مثيل نموذج السجل النشط، ويمكنك تعيينه nil لتعطيل التسجيل.
  • Config.active_record.primary_key_prefix_type يتيح لك ضبط تسمية أعمدة المفاتيح الأساسيّة، افتراضيًا، يفترض Rails أن أعمدة المفاتيح الأساسيّة تسمى id (وليس هنالك حاجة لتعيين هذا الخيار)، ويوجد خيارات آخران:
    • :table_name ليُنشئ المفتاح الرئيسي للصنف Customer customerid.
    • :table_name_with_underscore سيُنشئ المفتاح الأساسي للصنف Customer هو customer_id.
  • Config.active_record.table_name_prefix يتيح لك تعيين سلسلة عموميّة (global) لارفاقها بأسماء الجداول، إذا قمت تعيين هذا إلى northwest_ فإن صنف Customer سيبحث عن northwest_customers كجدول له، وبشكل افتراضي يساوي سلسلة نصيّة فارغة.
  • Config.active_record.table_name_suffix يتيح لك تعيين سلسلة عموميّة (global) لإلحاقها بأسماء الجداول، إذا قمت تعيين هذا إلى _northwest فإن صنف Customer سيبحث عن customers_northwest كجدول له، وبشكل افتراضي يساوي سلسلة نصيّة فارغة.
  • Config.active_record.schema_migrations_table_name يتيح لك تعيين سلسلة نصيّة لاستخدامها كاسم جدول ترحيلات المخطط.
  • Config.active_record.internal_metadata_table_name يتيح لك تعيين سلسلة نصيّة لاستخدامها كاسم جدول البيانات الأوليّة الداخلية.
  • Config.active_record.protected_environments يتيح لك تعيين مصفوفة من أسماء البيئات التي ينبعي فيها حظر الإجراءات التدميريّة.
  • Config.active_record.pluralize_table_names يحدد ما إذا كان Rails سيبحث عن أسماء الجداول المفرد أو الجمع في قاعدة البيانات، إذا تم تعيينها على true (الافتراضي)، فسيستخدم صنف Customer جدول customers وإذا كانت false، فسيستخدم صنف Customer جدول customer.
  • Config.active_record.default_timezone يحدد ما إذا كان سيُستخدم Time.local (إذا عيّنت على :local) أو Time.utc (إذا عيّنت على :utc) عند سحب التواريخ والأوقات من قاعدة البيانات، وهي بشكل افتراضي :utc.
  • Config.active_record.schema_format تتحكم في التنسيق تفريغ مخطط قاعدة البيانات إلى ملف، والخيارات هي :ruby (الافتراضي) لإصدار مستقل لقاعدة البيانات يعتمد على عمليات الترحيل، أو :sql لمجموعة من عبارات SQL (التي يمكن أن تعتمد على قاعدة البيانات).
  • Config.active_record.error_on_ignored_order يحدد ما إذا كان ينبغي رفع الخطأ إذا تم تجاهل ترتيب الاستعلام أثناء استعلام مجموعة واحدة، الخيارات هي true (رفع خطأ) أو false (تحذير)، وبشكل افتراضي تساوي false.
  • Config.active_record.timestamped_migrations تتحكم ما إذا كان يتم ترقيم عمليات التهجير باستخدام أرقام مسلسلة أو مع طوابع زمنيّة (timestamps)، بشكل افتراضي تساوي true، ولاستخدام timestamps، والتي يفضل استخدامها إذا كان هنالك العديد من المطورين الذي يعملون على نفس التطبيق.
  • Config.active_record.lock_optimistically يتحكم ما إذا كان السجل النشط سيستخدم تأمينًا متفائلًا (optimistic locking) وهو true بشكل افتراضي.
  • Config.active_record.cache_timestamp_format يتحكم في تنسيق قيمة الختم الزمني (timestamp) في مفتاح ذاكرة التخزين المؤقت، وبشكل افتراضي يساوي :nsec.
  • Config.active_record.record_timestamps هو قيمة منطقيّة تتحكّم في ما إذا كان هنالك ختم زمني على عمليات الإنشاء والتحديث في نموذج، وهو بشكل افتراضي true.
  • Config.active_record.partial_writes هو قيمة منطقيّة وتتحكّم ما إذا كانت تُستخدم عمليات الكتابة الجزئية أم لا (بمعنى ما إذا كانت التحديثات تعيّن السمات المتسخة dirty). لاحظ أنه عند استخدام عمليات الكتابة الجزئية يجب عليك استخدام التأمين المتفائل config.active_record.lock_optimistically نظرًا لأن التحديثات المتزامنة قد تكتب سمات استنادًا إلى حالة قراءة تالفة. بشكل افتراضي يساوي true.
  • Config.active_record.maintain_test_schema هي قيمة منطقيّة تتحكم في ما إذا كان السجل النشط يجب أن يحاول تحديث مخطط قاعدة بيانات الاختبار test مع db/schema.rb (أو db/structure.sql) عند تشغيل الاختبارات، بشكل افتراضي يساوي true.
  • Config.active_record.dump_schema_after_migration هو علم flag يتحكّم في ما إذا كان يجب أن يحدث تفريغ المخطّط (db/schema.rb أو db/structure.sql) عند تشغيل عمليات التهجير، ويعيّ، هذا على false في config/environments/production.rb المنشئ بواسطة Rails، والقيمة الافتراضيّة هي true إذا لم يعيّن هذا الضبط.
  • Config.active_record.dump_schemas يتحكّم في ما هي مخططات قاعدة البيانات التي ستفرّغ عند استدعاء db:structure:dump. الخيارات هي: :schema_search_path (وهو الافتراضي) والذي يفرّغ أي مخططات مدرجة في schema_search_path، :all والذي يفرّغ دائمًا جميع المخططات بغض النظر عن schema_search_path أو سلسلة نصيّة من المخططات المفصولة بفواصل.
  • Config.active_record.belongs_to_required_by_default هي قيمة منطقيّة وتتحكّم في ما إذا كان السجل يفشل في التحقق (validation) إذا لم يكن هنالك belongs_to association.
  • Config.active_record.warn_on_records_fetched_greater_than يتيح تعيين حد تحذير لحجم نتيجة الاستعلام، إذا تجاوز عدد السجلات التي تم إرجاعها بواسطة استعلام الحد، فسيُسجّل تحذير، ويمكن استخدام هذا لتحديد الاستعلامات التي تتسبب في حدوث انتفاخ في الذاكرة.
  • Config.active_record.index_nested_attribute_errors يسمح للأخطاء في علاقات has_many المتداخلة أن تُعرض مع فهرس بالإضافة إلى الخطأ، بشكل افتراضي يساوي false.
  • Config.active_record.use_schema_cache_dump يتيح للمستخدمين الحصول على معلومات التخزين المؤقت للمخطط من db/schema_cache.yml (المنشئ بواسطة bin/rails db:schema:cache:dump) بدلًا من الاضطرار إلى إرسال استعلام إلى قاعدة البيانات للحصول على هذه المعلومات. بشكل افتراضي يساوي true.

يضيف محوّل MySQL خيار ضبط إضافي آخر:

  • ActiveRecord::ConnectionAdapters::Mysql2Adapter.emulate_booleans يتحكّم ما إذا السجل النشط يعتمر جميع أعمدة tinyint(1) كقيم منطقيّة. بشكل افتراضي يساوي true.

يضيف محوّل SQLite3Adapter خيار ضبط إضافي آخر:

  • ActiveRecord::ConnectionAdapters::SQLite3Adapter.represent_boolean_as_integer يشير ما إذا ما إذا كانت القيم المنطقية المخزنة في قواعد بيانات sqlite3 كـ 1 و 0 أو 't' و 'f'، وإن ترك ActiveRecord::ConnectionAdapters::SQLite3Adapter.represent_boolean_as_integer لـ false هو شيء سيء، فلقد استخدمن قواعد بيانات SQLite 't' و 'f' لسلسلة القيم المنطقيّة ويجب أن تحتوي على البيانات القديمة تم تحويلها إلى 1 و0 (التسلسل المنطقي الأصلي) قبل تعيين هذا العلم إلى true، ويمكن التحويل عن طريق إعداد مهمة Rake التي تشغّل:

ExampleModel.where("boolean_column = 't'").update_all(boolean_column: 1)

ExampleModel.where("boolean_column = 'f'").update_all(boolean_column: 0)

لجميع النماذج وجميع الأعمدة المنطقيّة، يجب بعدها تعيين العلم على true بإضافة ما يلي إلى ملف application.rb:

```ruby

Rails.application.config.active_record.sqlite3.represent_boolean_as_integer = true

```

يضيف مفرّغ المخطط خيار ضبط إضافي آخر:

  • ActiveRecord::SchemaDumper.ignore_tables يقبل مصفوفة من الجداول التي لا يجب تضمينها في أي ملف مخطط تم إنشاؤه.

ضبط متحكم الإجراء

يتضمّن config.action_controller عددًا من إعدادات الضبط:

  • Config.action_controller.asset_host يعيّن المضيف للأصول، وهو مفيد عند استخدام CDN لاستضافة الأصول بدلًا من خادم التطبيق نفسه.
  • Config.action_controller.perform_caching يكوّن ما إذا كان يجب أن يقوم التطبيق بتنفيذ ميزات التخزين المؤقت التي يوفرها مكون متحكم الإجراء أو لا، وهي false في وضع التطوير و true في وضع الإنتاج.
  • Config.action_controller.default_static_extension يكوّن الملحق المستخدم في صفحات التخزين المؤقت، وهي بشكل افتراضي .html.
  • Config.action_controller.include_all_helpers يكوّن ما إذا كان جميع مساعدي العروض متوفرين في كل مكان أو تحديد نطاقها إلى المتحكم المقابل، في حالة تعيين false، فستكون أساليب UsersHelper متوفّرة فقط لعروض المصدّرة كجزء من UsersController. وإذا كان true، فإن توابع UsersHelper متوفّرة في كل مكان، وإن سلوك الضبط الافتراضي (عندما لا يعيّن، هذا الخيار بشكل صريح كـ true أو false) هو أن كافة مساعدي العروض متوفّرة لكل متحكّم.
  • Config.action_controller.logger يقبل مسجلًا مطابقًا لواجهة Log4r أو صنف روبي Logger الافتراضي، والذي يُستخدم بعد ذلك لتسجيل المعلومات من متحكم الإجراء. اضبطه على nil لتعطيل التسجيل.
  • Config.action_controller.request_forgery_protection_token يعيّن اسم معامل الرمز المميّز لـ RequestForgery، وإن استدعاء protect_from_forgery يعيّن :authenticity_token بشكل افتراضي.
  • Config.action_controller.allow_forgery_protection يفعّل أو يعطّل حماية CSRF، وهو بشكل افتراضي false في وضع الاختبار وtrue في جميع الأوضاع الأخرى.
  • Config.action_controller.forgery_protection_origin_check يكوّن ما إذا كان يجب التحقق من رأس HTTP Origin ضد أصل الموقع كدفاع CSRF إضافي.
  • Config.action_controller.per_form_csrf_tokens يكوّن ما إذا كانت رموز CSRF صالحة فقط للأسلوب/الإجراء الذي تم إنشاؤه له.
  • Config.action_controller.default_protect_from_forgery يحدد إضافة حماية التزوير على ActionController:Base، وهو false بشكل افتراضي، ولكنه مفعّل عند تحميل الإعدادات الافتراضيّة لـ Rails 5.2.
  • Config.action_controller.relative_url_root يمكن استخدامه لإخبار Rails أنك تنشر إلى دليل فرعي، بشكل افتراضي يساوي ENV['RAILS_RELATIVE_URL_ROOT'].
  • Config.action_controller.permit_all_parameters يعيّن السماح لجميع المعاملات بالتعيين الشامل بشكل افتراضي. بشكل افتراضي يساوي false.
  • Config.action_controller.action_on_unpermitted_parameters يفعّل التسجيل أو رفع استثناء إذا تم العثور على معاملات غير مسموح بها بشكل صريح، إضبط :log أو :raise لتفعيله، والقيمة الافتراضيّة هي :log في أوضاع التطوير والاختبار، وهي false في جميع الأوضاع الأخرى.
  • Config.action_controller.always_permitted_parameters تعيّن قائمة بالمعاملات المسموح بها بشكل افتراضي. القيم الافتراضيّة هي ['controller', 'action'].
  • Config.action_controller.enable_fragment_cache_logging يحدد ما إذا كان سيتم أجزاء القراءة والكتابة لذاكرة التخزين المؤقت في شكل مطنب كالتالي:

Read fragment views/v1/2914079/v1/2914079/recordings/70182313-20160225015037000000/d0bdf2974e1ef6d31685c3b392ad0b74 (0.6ms)

Rendered messages/_message.html.erb in 1.2 ms [cache hit]

Write fragment views/v1/2914079/v1/2914079/recordings/70182313-20160225015037000000/3b4e249ac9d168c617e32e84b99218b5 (1.1ms)

Rendered recordings/threads/_thread.html.erb in 1.5 ms [cache miss]

افتراضيًا، يتم تعيينه على false مما ينتج عنه المخرجات التالية:

```

Rendered messages/_message.html.erb in 1.2 ms [cache hit]

Rendered recordings/threads/_thread.html.erb in 1.5 ms [cache miss]

```

ضبط إرسال الإجراء

  • Config.action_dispatch.session_store يعيّن اسم المخزن لبيانات الجلسة، وهو بشكل افتراضي :cookie_store وتتضمن الخيارات الصالحة الأخرى :active_record_store أو :mem_cache_store أو اسم الصنف المخصص الخاص بك.
  • Config.action_dispatch.default_headers هو hash مع رؤوس HTTP التي تم تعيينها بشكل افتراضي في كل استجابة. بشكل افتراضي، معرّفة على أنها:

config.action_dispatch.default_headers = {

 'X-Frame-Options' => 'SAMEORIGIN',

 'X-XSS-Protection' => '1; mode=block',

 'X-Content-Type-Options' => 'nosniff',

 'X-Download-Options' => 'noopen',

 'X-Permitted-Cross-Domain-Policies' => 'none',

 'Referrer-Policy' => 'strict-origin-when-cross-origin'

}

  • Config.action_dispatch.default_charset يحدد مجموعة الأعرف الافتراضيّة لكافة عمليات العرض. يساوي nil بشكل افتراضي.
  • Config.action_dispatch.tld_length يعيّن طول TLD (نطاق المستوى الأعلى) للتطبيق، وهو 1 بشكل افتراضي.
  • Config.action_dispatch.ignore_accept_header يُستخدم لتحديد ما إذا كان ستتجاهل قبول رؤوس من الطلب، وهو بشكل افتراضي false.
  • Config.action_dispatch.x_sendfile_header يحدد رأس X-Sendfile المحدد للخادم، وهو مفيد لتسريع إرسال الملفات من الخادم، على سبيل المثال، يمكن تعيينه 'X-Sendfile' لأباتشي.
  • Config.action_dispatch.http_auth_salt يحدد قيمة الملح HTTP Auth، وهي بشكل افتراضي 'http authentication'.
  • Config.action_dispatch.signed_cookie_salt يعيّن قيمة ملح ملفات تعريف الارتباط signed، وهو يساوي بشكل افتراضي 'signed cookie'.
  • Config.action_dispatch.encrypted_cookie_salt يعيّن قيمة ملح لملفات تعريف الارتباط المشفّرة، وهو يساوي بشكل افتراضي 'encrypted cookie'.
  • Config.action_dispatch.encrypted_signed_cookie_salt يعيّن قيمة ملح لملفات تعريف الارتباط      signedالمشفّرة، وهو يساوي بشكل افتراضي 'signed encrypted cookie'.
  • config.action_dispatch.authenticated_encrypted_cookie_salt يعيّن قيمة ملح لملفات تعريف الارتباط الموثقة المشفّرة، وهو يساوي بشكل افتراضي 'authenticated encrypted cookie'
  • Config.action_dispatch.encrypted_cookie_cipher يعيّن الشيفرات المراد استخدامها في ملفات تعريف الارتباط المشفّرة، وهو بشكل افتراضي "aes-256-gcm".
  • Config.action_dispatch.signed_cookie_digest يعيّن digest ليُستخدم في ملفات تعريف الارتباط signed، وهو "SHA1" بشكل افتراضي.
  • Config.action_dispatch.cookies_rotations يسمح بتدوير الأسرار، التشفيرات، وdigest لملفات تعريف الارتباط المشفّرة و signed.
  • Config.action_dispatch.use_authenticated_cookie_encryption يتحكّم ما إذا كانت ملفات تعريف الارتباط مشفّرة وsigned تستخدم تشفير AES-256-GCM أو تشفير AES-256-CBC القديم، وهو true بشكل افتراضي.
  • Config.action_dispatch.perform_deep_munge يكوّن ما إذا كان يجب تنفيذ تابع deep_munge على المعاملات، أنظر دليل الأمن لمزيد من المعلومات، وهو true بشكل افتراضي.
  • Config.action_dispatch.rescue_responses يكوّن الاستثناءات التي عيّنت لحالة HTTP، وهي تقبل hash ويمكنك تحديد أزواج من استثناء/حالة، وهو بشكل افتراضي معرّف على أنه:

config.action_dispatch.rescue_responses = {

 'ActionController::RoutingError'            => :not_found,

 'AbstractController::ActionNotFound'        => :not_found,

 'ActionController::MethodNotAllowed'        => :method_not_allowed,

 'ActionController::UnknownHttpMethod'       => :method_not_allowed,

 'ActionController::NotImplemented'          => :not_implemented,

 'ActionController::UnknownFormat'           => :not_acceptable,

 'ActionController::InvalidAuthenticityToken'   => :unprocessable_entity,

 'ActionController::InvalidCrossOriginRequest'  => :unprocessable_entity,

 'ActionDispatch::Http::Parameters::ParseError' => :bad_request,

 'ActionController::BadRequest'              => :bad_request,

 'ActionController::ParameterMissing'        => :bad_request,

 'Rack::QueryParser::ParameterTypeError'     => :bad_request,

 'Rack::QueryParser::InvalidParameterError' => :bad_request,

 'ActiveRecord::RecordNotFound'              => :not_found,

 'ActiveRecord::StaleObjectError'            => :conflict,

 'ActiveRecord::RecordInvalid'               => :unprocessable_entity,

 'ActiveRecord::RecordNotSaved'              => :unprocessable_entity

}

سيُعيّن أي استثناء لم يكوّن إلى خطأ داخلي في الخادم 500 (Internal Server Error).

  • ActionDispatch::Callbacks.before تأخذ كتلة من التعليمات البرمجيّة لتشغيلها قبل الطلب.
  • ActionDispatch::Callbacks.after تأخذ كتلة من التعليمات البرمجيّة لتشغيلها بعد الطلب.

ضبط عرض الإجراء

يتضمن config.action_view مجموعة صغيرة من إعدادات الضبط:

  • Config.action_view.cache_template_loading يتحكّم في ما إذا كان يجب إعادة تحميل القوالب في كل طلب أو لا، وهو بشكل افتراضي مثل config.cache_classes.
  • Config.action_view.field_error_proc يوفّر مولّد HTML لعرض الأخطاء التي تأتي من نموذج نشط (Active Model)، وهو بشكل افتراضي:

Proc.new do |html_tag, instance|

 %Q(<div class="field_with_errors">#{html_tag}</div>).html_safe

End

  • Config.action_view.default_form_builder يخبر Rails أي منشئ نموذج يستخدمه بشكل افتراضي، وهو بشكل افتراضي ActionView::Helpers::FormBuilder، إذا أردت تحميل صنف منشئ النموذج بعد التهيئة (لكي يعاد تحميله على كل طلب قيّد التطوير)، يمكنك تمريره كسلسة نصيّة.
  • Config.action_view.logger يقبل مسجل يتطابق مع واجهة Log4r أو صنف Ruby Logger الافتراضي، والذي يُستخدم بعد ذلك لتسجيل المعلومات من عرض الإجراء. اضبطه على nil لتعطيل التسجيل.
  • Config.action_view.erb_trim_mode يسمح باستخدام وضع trim من قبل ERB، وهو بشكل افتراضي "-"، والذي يعمل على تشذيب مسافات الذيل والسطر الجديد عند استخدام <%= -%> أو <%= =%>. راجع وثائق Erubis لمزيد من المعلومات.
  • Config.action_view.embed_authenticity_token_in_remote_forms يسمح لك بتعيين السلوك الافتراضي لـ authenticity_token في النماذج مع remote:true، وهو false بشكل افتراضي، مما يعني أن النماذج البعيدة لن تتضمن authenticity_token وهو أمر مفيد عندما تخزّن أجزاء النموذج بشكل مؤقت في الذاكرة. تحصل النماذج البعيدة على المصادقة من وسم meta، لذلك لا يكون الدمج ضروريًا إلا إذا رغبت بدعم المتصفحات بدون جافاسكربت، وفي مثل هذه الحالة، يمكنك تمرير authenticity_token: true كخيار النموذج أو تعيين إعداد الضبط هذا على true.
  • Config.action_view.prefix_partial_path_with_controller_namespace يحدد ما إذا كان يتم البحث عن أجزاء من دليل فرعي أم لا في القوالب المصدّرة من متحكمات فضاء التسمية، فعلى سبيل المثال، متحكم يسمى Admin::ArticlesController الذي يصدّر هذا القالب:

<%= render @article %>

الإعداد الافتراضي هو true، والذي يستخدم الجزء الموجود في /admin/articles/_article.erb، وعند تعيين القيمة إلى false فسيصدّر /articles/_article.erb والذي هو نفس السلوك التصدير من متحكم ليس من فضاء الاسم مثل ArticlesController.

  • Config.action_view.raise_on_missing_translations يحدد ما إذا كان يجب رفع خطأ للترجمات المفقودة.
  • Config.action_view.automatically_disable_submit_tag يحدد ما إذا كان يجب تعطيل submit_tag عند النقر، وهو بشكل افتراضي true.
  • Config.action_view.debug_missing_translation يحدد ما إذا كان سيلف مفتاح الترجمات المفقودة في وسم <span> أو لا، وهو true بشكل افتراضي.
  • Config.action_view.form_with_generates_remote_forms يحدد ما إذا كان form_with يولّد نماذج عن بعد أم لا، وهو true بشكل افتراضي.
  • Config.action_view.form_with_generates_ids يحدد ما إذا كان form_with ينشئ معرفات على المدخلات، وهو true بشكل افتراضي.

ضبط Mailer إجراء

هنالك عدد من الإعدادات المتاحة على config.action_mailer:

  • Config.action_mailer.logger يقبل مسجلًا مطابقًا لواجهة Log4r أو صنف Ruby Logger الافتراضي، والذي يُستخدم بعد ذلك لتسجيل المعلومات من Mailer الإجراء. اضبطه على nil لتعطيل التسجيل.
  • Config.action_mailer.smtp_settings يتيح ضبط تفصيلي لتابع :smtp للتسليم، وهو يقبل hash من الخيارات، والتي يمكن أن تشمل أي من هذه الخيارات:
    • :address - تسمح لك باستخدام خادم بريد بعيد، كل ما عليك فعله هو تغيير إعداد "localhost" الافتراضي.
    • :port - في حالة عدم عمل خادم البريد الخاص على المنفذ 25، يمكنك تغييره.
    • :domain - إذا أردت تحديد نطاق HELO، فيمكنك القيام بذلك هنا.
    • :user_name - إذا كان خادم البريد الخاص بك يتطلّب الاستيثاق، فعيّن اسم المستخدم في هذا الإعداد.
    • :password - إذا كان خادم البريد الخاص بك يتطلّب المصادقة، فعيّن كلمة المرور في هذا الإعداد.
    • :authentication - إذا كان خادم البريد الخاص بك يتطلّب المصادقة، فعليك تحديد نوع المصادقة هنا، وهو رمز وهو واحد من :plain، :login، :cram_md5.
    • :enable_starttls_auto - يكتشف ما إذا تم تمكين STARTTLS في خادم SMTP الخاص بك ويبدأ في استخدامه، وهو true بشكل افتراضي.
    • :openssl_verify_mode - عند استخدام TLS، يمكنك ضبط كيفية قيام OpenSSL بالتحقق من الشهادة، وهذا مفيد إذا أردت التحقق من صحة شهادة self-signed أو/و wildcard. يمكن أن يكون هذا أحد ثوابت التحقق من OpenSSL وهي :none أو :peer -- أو الثابت مباشرةً OpenSSL::SSL::VERIFY_NONE أو OpenSSL::SSL::VERIFY_PEER على التوالي.
    • :ssl/:tls - لتمكين اتصال SMTP ليستخدم SMTP/TLS (SMTPS: SMTP عبر اتصال TLS مباشر).
  • Config.action_mailer.sendmail_settings يسمح ضبط مفصّل لتابع تسليم sendmail، وهي تقبل Hash من الخيارات، والتي يمكن أن تشكل أي من هذه الخيارات:
    • :location - موقع sendmail التنفيذي، وهو بشكل افتراضي /usr/sbin/sendmail.
    • :arguments - معاملات سطر الأوامر، بشكل افتراضي يساوي -i.
  • Config.action_mailer.raise_delivery_errors يحدد ما إذا كان سيُرفع خطأ في تعذّر إكمال تسليم البريد الإلكتروني، وهو true بشكل افتراضي.
  • Config.action_mailer.delivery_method يحدد تابع التسليم وهو :smtp بشكل افتراضي. راجع قسم الضبط في دليل Action Mailer للمزيد من المعلومات.
  • Config.action_mailer.perform_deliveries يحدد إذا كان البريد سيُسلّم بالفعل وهو true بشكل افتراضي، ومن المستحسن تعيينه على false للاختبار.
  • Config.action_mailer.default_options يكوّن الإعدادات الافتراضيّة لـ Mailer الإجراء بشكل افتراضي، ويُستخدم لتعيين الخيارات مثل from أو reply_to لكل mailer، وهو افتراضي لـ:

mime_version:  "1.0",

charset:    "UTF-8",

content_type: "text/plain",

parts_order:  ["text/plain", "text/enriched", "text/html"]

  • عيّن hash لتعيين خيارات إضافيّة:

config.action_mailer.default_options = {

 from: "noreply@example.com"

}

  • Config.action_mailer.observers مراقبي السجل الذين سيتم إبلاغهم عند تسليم البريد.

config.action_mailer.observers = ["MailObserver"]

  • Config.action_mailer.interceptors معترضات السجل والتي سيتم استدعاؤهم قبل ارسال البريد.

config.action_mailer.interceptors = ["MailInterceptor"]

  • Config.action_mailer.preview_path يحدد موقع معاينات البريد الالكتروني.

config.action_mailer.preview_path = "#{Rails.root}/lib/mailer_previews"

  • Config.action_mailer.show_previews يفعّل أو يعطّل معاينات البريد، وهو true بشكل افتراضي في وضع التطوير.

config.action_mailer.show_previews = false

  • Config.action_mailer.deliver_later_queue_name يحدد اسم الطابور (queue) للمرسلين، وهو بشكل افتراضي mailers.
  • Config.action_mailer.perform_caching يحدد ما إذا كان يجب أن تقوم قوالب الإرسال بإجراء تخزين مؤقت للأجزاء أو لا، وهو false بشكل افتراضي في جميع البيئات.

إعداد دعم النشط

هنالك عدة خيارات ضبط متاحة في Active Support:

  • Config.active_support.bare يفعّل أو يعطّل تحميل active_support/all عند تشغيل Rails، وهو nil بشكل افتراضي، مما يعني تحميل active_support/all.
  • Config.active_support.test_order يعيّن الترتيب الذي من خلاله تنفّذ حالات الاختبار. القيم المحتملة هي :random و:sorted. وبشكل افتراضي :random.
  • Config.active_support.escape_html_entities_in_json يفعّل أو يعطّل تهريب كيانات HTML في سَلسَلة JSON، وهو true بشكل افتراضي.
  • Config.active_support.use_standard_json_time_format يفعّل أو يعطّل سلسلة التواريخ إلى تنسيق ISO 8601، وهو true افتراضيًا.
  • Config.active_support.time_precision يعيّن دقة قيمة الوقت التي تم ترميزها. وهو 3 افتراضيًا.
  • Config.active_support.use_sha1_digests يحدد ما إذا كنت ستستخدم SHA-1 بدلًا من MD5 لتوليد digests غير حساسة، مثل رأس ETag، وهي false افتراضيًا.
  • Config.active_support.use_authenticated_message_encryption تحدد ما إذا كان سيُستخدم تشفير المصادق AES-256-GCM كتشفير افتراضي لتشفير الرسائل بدلًا من AES-256-CBC. هو false افتراضيًا لكنه يكون true عند تحميل الإعداد الافتراضيّة لـ Rails 5.2.
  • ActiveSupport::Logger.silencer يعيّن false لتعطيل القدرة على إسكات التسجيل في كتلة، وهو true افتراضيًا.
  • ActiveSupport::Cache::Store.logger يحدد المسجل لاستخدامه داخل عمليات التخزين في ذاكرة التخزين المؤقتة.
  • ActiveSupport::Deprecation.behavior أداة ضبط بديلة لـ config.active_support.deprecation الذي يكوّن سلوك تحذيرات الإهمال في Rails.
  • ActiveSupport::Deprecation.silence يأخذ كتلةيتم فيها إسكات كافة تحذيرات الإهمال.
  • ActiveSupport::Deprecation.silenced يعيّن ما إذا كان ستعرض تحذيرات الإهمال أو لا.

ضبط وظيفة نشطة

يوفّر config.active_job خيارات الضبط التاليّة:

  • Config.active_job.queue_adapter يعيّن المحولّل لواجهة الطابور. إن المحوّل الافتراضي هو :async. للحصول على قائمة محدّثة من المحولات المضمنة، راجع وثائق واجهة برمجة التطبيقات لـ ActiveJob::QueueAdapters.

# Be sure to have the adapter's gem in your Gemfile

# and follow the adapter's specific installation

# and deployment instructions.

config.active_job.queue_adapter = :sidekiq

  • Config.active_job.default_queue_name يمكن استخدامه لتغيير اسم قائمة الطابور الافتراضيّة والذي هو "default" افتراضيًا.

config.active_job.default_queue_name = :medium_priority

  • Config.active_job.queue_name_prefix يسمح لك بتعيين بادئة اسم اختياريّة للطابور غير فارغة لجميع الوظائف. فارغة وغير مستعملة بشكل افتراضي.

يعمل الضبط التالي على ترتيب وظيفة محددة في طابور production_high_priority عند تشغيله في الإنتاج:

config.active_job.queue_name_prefix = Rails.env

class GuestsCleanupJob < ActiveJob::Base

 queue_as :high_priority

 #....

end

  • Config.active_job.queue_name_delimiter يملك قيمة افتراضيّة '_'. إذا عيّنت queue_name_prefix، فإن queue_name_delimiter سيرتبط باسم الطابور الذي يملك بادئة والذي لا يملكها.

سيضع الضبط التالي الوظيفة المعروضة في طابور video_server.low_priority:

# prefix must be set for delimiter to be used

config.active_job.queue_name_prefix = 'video_server'

config.active_job.queue_name_delimiter = '.'

class EncoderJob < ActiveJob::Base

 queue_as :low_priority

 #....

End

  • Config.active_job.logger يقبل مسجلًا مطابقًا لواجهة Log4r أو صنف Ruby Logger الافتراضي، والذي سيُستخدم بعد ذلك لتسجيل المعلومات من الوظيفة النشطة. يمكنك استرداد هذا السجل عن طريق استدعاء logger على أي صنف Active Job أو مثيل Active Job. اضبطه على nil لتعطيل التسجيل.

ضبط كابل الإجراء

  • Config.action_cable.url يقبل سلسلة نصيّة لـ URL الخاص بالمكان الذي تستضيف فيه خادم Action Cable. يمكنك استخدام هذا الخيار إذا كنت تشغّل خوادم Action Cable المنفصلة عن التطبيق الرئيسي.
  • Config.action_cable.mount_path يقبل سلسلة نصيّة لمكان وصل Action Cable، كجزء من عملية الخادم الرئيسيّة. وهو يساوي بشكل افتراضي /cable ويمكنك تعيينه كـ nil حتى لا يوصل Action Cable كجزء من خادم Rails العادي.

ضبط التخزين النشط

يوفّر config.active_storage خيارات الضبط التالية:

  • Config.active_storage.analyzers يقبل مصفوفة من الأصناف التي تشير إلى محللات المتاحة لنقط (blob) Active Storage، وهو بشكل افتراضي يساوي [ActiveStorage::Analyzer::ImageAnalyzer, ActiveStorage::Analyzer::VideoAnalyzer]. هذا الأول يمكنه استخراج عرض وارتفاع صورة blob، ويمكن للأخير استخلاص العرض والارتفاع والمدة والزاوية ونسبة العرض إلى الإرتفاع لفيديو blob.
  • Config.active_storage.previewers يقبل مصفوفة من الأصناف التي تشير إلى معاينات الصور المتوفرة في Active Storage blobs. وهو بشكل افتراضي [ActiveStorage::Previewer::PDFPreviewer, ActiveStorage::Previewer::VideoPreviewer]. يمكن للأول أن يولّد صورة مصغّرة من الصفحة الأولى من PDF blob وأما الأخير فمن الإطار المناسب لفيديو blob.
  • Config.active_storage.paths يقبل hash من الخيارات التي تشير إلى مواقع أوامر previewer/analyzer. وهو يساوي بشكل افتراضي إلى {}، مما يعني أنه سيبحث عن الاوامر في المسار الافتراضي، ويمكن أن يتضمّن أيًا من هذه الخيارات:
    • :ffprobe - موقع ملف ffprobe التنفيذي.
    • :mutool - موقع ملف mutool التنفيذي.
    • :ffmpeg - موقع ملف ffmpeg التنفيذي.

config.active_storage.paths[:ffprobe] = '/usr/local/bin/ffprobe'

  • Config.active_storage.variable_content_types يقبل مصفوفة من السلاسل النصيّة التي تشير إلى أنواع المحتوى التي يمكن لـ Active Storage تحويلها من خلال ImageMagick. وهو بشكل افتراضي يساوي %w(image/png image/gif image/jpg image/jpeg image/vnd.adobe.photoshop image/vnd.microsoft.icon).
  • Config.active_storage.content_types_to_serve_as_binary يقبل مصفوفة من السلاسل النصية التي تشير إلى أنواع المحتوى التي سيخدمها Active Storage دائمًا كمُرفق (attachment)، بدلا من مضمنة (inline)، وهو بشكل افتراضي يساوي %w(text/html text/javascript image/svg+xml application/postscript application/x-shockwave-flash text/xml application/xml application/xhtml+xml).
  • Config.active_storage.queue يمكن أن يُستخدم لتعيين اسم طابور Active Job المستخدم لأداء مهام مثل تحليل محتوى blob أو تطهير المدوّنة.

config.active_storage.queue = :low_priority

  • Config.active_storage.logger يمكن أن يُستخدم لتعيين أداة التسجيل التي يستخدمها Active Storage، وهو يقبل مسجلًا يتطابق مع واجهة Log4r أو مع صنف Ruby Logger الافتراضي.

config.active_storage.logger = ActiveSupport::Logger.new(STDOUT)

ضبط قاعدة البيانات

بما أن كل تطبيق Rails تقريبًا سيتصل بقاعدة بيانات، فيمكنك الاتصال بقاعدة البيانات عن طريق تحديد متغيّر البيئة ENV['DATABASE_URL'] أو باستخدام ملف ضبط يسمى config/database.yml.

ويمكنك باستخدام ملف config/database.yml تحديد جميع المعلومات اللازمة للوصول إلى قاعدة بياناتك:

development:

 adapter: postgresql

 database: blog_development

 pool: 5

سيتصل هذا بقاعدة بيانات تدعى blog_development باستخدام محوّل postgresql، ويمكن تخزين هذه المعلومات نفسها في عنوان URL وتوفيرها عبر متغير البيئة كالتالي:

> puts ENV['DATABASE_URL']

postgresql://localhost/blog_development?pool=5

يحتوي ملف config/database.yml على أقسام لثلاث بيئات مختلفة يمكن تشغيل Rails فيها افتراضيًا:

  • تُستخدم بيئة التطوير في الحاسوب المحلي/التطوير أثناء تفاعلك بدويًا مع التطبيق.
  • تُستخدم بيئة الاختبار عند تشغيل الاختبارات التلقائيّة.
  • تُستخدم بيئة الإنتاج عند نشر التطبيق الخاص بك حتى يستخدمه الجميع.

إذا أردت، فيمكنك تحديد عنوان URL داخل ملف config/database.yml.

development:

 url: postgresql://localhost/blog_development?pool=5

يمكن أن يحتوي ملف config/database.yml على وسوم ERB <%= %> وسيقيّم أي شيء داخل هذه الوسوم على أنه شيفرة روبي، ويمكنك استخدام هذا لسحب البيانات من متغيّر بيئة أو لإجراء العمليات الحسابيّة لإنشاء معلومة الاتصال المطلوبة.

تنبيه: لا تحتاج إلى تحديث ضبطات قاعدة البيانات يدويًا، إذا نظرّت إلى خيارات مولّد التطبيق، سترى أن أحد هذه الخيارات يدعى --database، ويسمح لك هذا باختيار محوّل من قائمة قواعد البيانات العلائقيّة الأكثر استخدامًا، ويمكنك حتى تشغيل المولّد بشكل متكرّر: cd .. && rails new blog --database=mysql وعند تأكيد الكتابة فوق ملف config/database.yml سيتكوّن التطبيق لـ MySQL بدلًا من SQLite وستجد في ما يلي أمثلة تفصيليّة لاتصالات قواعد البيانات الشائعة.

تفضيلات الاتصال

نظرًا لوجود طريقتين لضبط الاتصال (باستخدام config/database.yml أو باستخدام متغيّر البيئة) فمن المهم فهم كيفية تفاعلهما.

إذا كان لديك ملف config/database.yml فارغ لكن كان ENV['DATABASE_URL'] موجود، فسيتصل Rails بقاعدة البيانات عبر متغيّر البيئة الخاص بك:

$ cat config/database.yml

$ echo $DATABASE_URL

postgresql://localhost/my_database

إذا كان لديك ملف config/database.yml ولكن ليس ENV['DATABASE_URL'] فسيُستخدم هذا الملف للاتصال بقاعدة البيانات الخاصة بك:

$ cat config/database.yml

development:

 adapter: postgresql

 database: my_database

 host: localhost

$ echo $DATABASE_URL

إذا كان لديك كلًا من config/database.yml وENV['DATABASE_URL'] فسيدمج Rails الضبط معًا، ولفهم هذا بشكل أفضل، يجب أن نرى بعض الأمثلة.

عندما توفّر معلومات الاتصال المكررّة، سيأخذ متغيّر البيئة الأولويّة:

$ cat config/database.yml

development:

 adapter: sqlite3

 database: NOT_my_database

 host: localhost

$ echo $DATABASE_URL

postgresql://localhost/my_database

$ bin/rails runner 'puts ActiveRecord::Base.configurations'

{"development"=>{"adapter"=>"postgresql", "host"=>"localhost", "database"=>"my_database"}}

هنا يتطابق adapter وhost وdatabase مع المعلومات المتوفّرة في ENV['DATABASE_URL'].

إذا تم توفير معلومات غير مكرّرة ستحصل على جميع القيم الفريدة، وسيأخذ متغيّر النظام الأسبقيّة في حالة أي تعارضات.

$ cat config/database.yml

development:

 adapter: sqlite3

 pool: 5

$ echo $DATABASE_URL

postgresql://localhost/my_database

$ bin/rails runner 'puts ActiveRecord::Base.configurations'

{"development"=>{"adapter"=>"postgresql", "host"=>"localhost", "database"=>"my_database", "pool"=>5}}

بما أن pool ليس في المعلومات المقدمّة في ENV['DATABASE_URL']، فستدمج معلوماته، وبما أن adapter مكرّر، فستفوز معلومات اتصال ENV['DATABASE_URL'].

تتمثّل الطريقة الوحيدة لعدم استخدام معلومات الاتصال بشكل صريح في ENV['DATABASE_URL'] في تحديد اتصال URL صريح باستخدم المفتاح الفرعي "url":

$ cat config/database.yml

development:

 url: sqlite3:NOT_my_database

$ echo $DATABASE_URL

postgresql://localhost/my_database

$ bin/rails runner 'puts ActiveRecord::Base.configurations'

{"development"=>{"adapter"=>"sqlite3", "database"=>"NOT_my_database"}}

يتجاهل هنا معلومات الاتصال في ENV['DATABASE_URL']، لاحظ اختلاف adapter واسم قاعدة البيانات.

نظرًا لأنه من الممكن تضمين ERB في config/database.yml، فمن الأفضل أن تظهر بوضوح أنك تستخدم ENV['DATABASE_URL'] للاتصال بقاعدة البيانات، وهذا مفيد بشكل خاص في الإنتاج لأنه يجب أن لا تودع الأسرار مثل كلمة مرور قاعدة البيانات إلى متحكّم المصدر الخاص بك (مثل Git).

$ cat config/database.yml

production:

 url: <%= ENV['DATABASE_URL'] %>

أصبح السلوك الآن واضح، أننا لا نستخدم سوى معلومات الاتصال في ENV['DATABASE_URL'].

ضبط قاعدة بيانات SQLite3

يأتي Rails مع دعم مضمّن لـ SQLite3، وهو تطبيق قاعدة بيانات خفيف بدون خوادم، وبما أن بيئة انتاج مزدحم قد تفرط في تحميل SQLite، فإنه يعمل بشكل جيّد من أجل التطوير والاختبار، ويفترض Rails افتراضيًا استخدام قاعدة بيانات SQLite عند إنشاء مشروع جديد، لكن يمكنك دائمًا تغييره لاحقًا.

في ما يلي قسم ملف الضبط الافتراضي (config/database.yml) مع معلومات الاتصال لبيئة التطوير:

development:

 adapter: sqlite3

 database: db/development.sqlite3

 pool: 5

 timeout: 5000

ملاحظة: يستخدم Rails قواعد بيانات SQLite3 لتخزين البيانات بشكل افتراضي لأن قاعدة البيانات لا تحتاج إلى ضبط، ويدعم Rails MySQL (بما في ذلك MariaDB) أيضًا و PostgreSQL "خارج الصندوق" ولديه ملحقات للعديد من أنظمة قواعد البيانات، وإذا كنت تستخدم قاعدة البيانات في بيئة الإنتاج، فغالبا ما يكون Rails محوّل لها.

ضبط قاعدة بيانات MySQL أو MariaDB

إذا اخترّت استخدام MySQL أو MariaDB بدلًا من SQLite3،  فسيبدو ملف config/database.yml مختلف قليلًا، وهذا هو قسم التطوير الخاص به:

development:

 adapter: mysql2

 encoding: utf8

 database: blog_development

 pool: 5

 username: root

 password:

 socket: /tmp/mysql.sock

إذا كانت قاعدة بياناتك تملك مستخدم جذر مع كلمة مرور فارغ، فسيعّمل هذا الضبط لك، وخلاف ذلك، يجب عليك تغيير اسم المستخدم وكلمة المرور في قسم التطوير.

ضبط قاعدة بيانات PostgreSQL

إذا اخترت استخدام PostgreSQL، فيجب تخصيص ملف config/database.yml لاستخدام قواعد بيانات PostgreSQL:

development:

 adapter: postgresql

 encoding: unicode

 database: blog_development

 pool: 5

يتم تمكين البيانات المعدّة (Prepared Statements) بشكل افتراضي في PostgreSQL، ويمكنك تعطيل ذلك عن طريق تعيين prepared_statements إلى false:

production:

 adapter: postgresql

 prepared_statements: false

إذا كان مفعّل، سيُنشئ Active Record 1000 بيان معّد لاتصال قاعدة البيانات بشكل افتراضي، ولتعديل هذا السلوك، يمكنك تعيين statement_limit إلى قيمة مختلفة:

production:

 adapter: postgresql

 statement_limit: 200

كلما زادت البيانات المعّدة استخدامًا كلما زدات الذاكرة التي تتطلّبها قاعدة البيانات الخاص لك، وإذا وصلت قاعدة بيانات PostgreSQl لحدود الذاكرة، فجرّب تقليل statement_limit أو تعطيل العبارات المعّدة.

ضبط قاعدة بيانات SQLite3 لمنصة JRuby

إذا اخترت استخدام SQLite3 وأنت تستخدم JRuby، فسيبدو ملف config/database.yml مختلفًا قليلًا، وهذا شكل قسم التطوير:

development:

 adapter: jdbcsqlite3

 database: db/development.sqlite3

ضبط قاعدة بيانات MySQL أو MariaDB لمنصة JRuby

إذا اخترت استخدام MySQL أو MariaDB  وأنت تستخدم JRuby، فسيبدو ملف config/database.yml مختلفًا قليلًا، وهذا شكل قسم التطوير:

development:

 adapter: jdbcmysql

 database: blog_development

 username: root

 Password:

ضبط قاعدة بيانات PostgreSQL لمنصة JRuby

إذا اخترت استخدام PostgreSQL  وأنت تستخدم JRuby، فسيبدو ملف config/database.yml مختلفًا قليلًا، وهذا شكل قسم التطوير:

development:

 adapter: jdbcpostgresql

 encoding: unicode

 database: blog_development

 username: blog

 Password:

غيّر اسم المستخدم وكلمة المرور في قسم التطوير بالشكل المناسب.

إنشاء بيئات Rails

يأتي Rails مع 3 بيئات: "التطوير" و "الاختبار" و "الإنتاج"، وفي حين أن هذه كافية لمعظم حالات الاستخدام، فهنالك ظروف تحتاج فيها إلى المزيد من البيئات.

تخيّل أن لديك خادمًا يشبه بيئة الإنتاج لكنه يُستخدم فقط للاختبار، يطلق على هذا الخادم اسم "خادم التدريج " - "staging server"، ولتعريف بيئة تسمى "staging" لهذا الخادم، أنشئ ملف باسم config/environments/staging.rb ويرجى استخدام محتويات أي ملف موجود في config/environments كنقطة بداية وعدّل بعدها كما تريد.

هذه البيئة لا تختلف عن الافتراضيّة، ابدء الخادم باستخدام rails server -e staging ووحدة تحكم مع rails console -e staging, Rails.env.staging? تعمل أيضًا …

النشر إلى دليل فرعي (جذر url نسبي)

يفترض Rails بشكل افتراضي أن التطبيق يعمل في الجذر (على سبيل المثال /) ويشرح لك هذا القسم كيفيّة تشغيل التطبيق الخاص بك داخل مجلّد.

لنفترض أننا نريد نشر تطبيقنا على "/app1"، يحتاج Rails إلى معرفة هذا المجلّد لإنشاء المسارات المناسبة:

config.relative_url_root = "/app1"

وبدلًا من ذلك، يمكنك ضبط متغيّر البيئة RAILS_RELATIVE_URL_ROOT.

سيضيف Rails الآن "/app1" عند إنشاء الروابط.

استخدام Passenger

يسهّل Passenger هذه العمليّة، يمكنك العثور على الضبط المناسب في دليل Passenger.

استخدام وكيل عكسي

يتمتع نشر تطبيقك باستخدام وكيل عكسي (Reverse Proxy) بمزايا كثيرة، فهي تسمح لك بمزيد من التحكم في الخادم الخاص بك عن طريق وضع المكونات المطلوبة في تطبيقك في طبقات.

يمكن استخدام العديد من خوادم الويب الحديثة كخادم وكيل لتحقيق التوازن بين عناصر الجهات الخارجيّة مثل خوادم التخزين المؤقت أو خوادم التطبيقات.

وأحد هذه التطبيقات التي يمكنك تشغيلها خلف الخادم العكسي هو Unicorn.

في هذه الحالة، ستحتاج إلى ضبط خادم الوكيل (NGINX، Apache ...) إلى قبول الاتصالات من تطبيق الخادم (Unicorn)، وبشكل افتراضي سيستمع Unicorn إلى اتصالات TCP على المنفذ 8080، لكن يمكنك تغيير المنفذ أو ضبطة لاستخدام sockets بدلًا من ذلك.

يمكنك العثور على المزيد من المعلومات في Unicorn readme وفهم الفلسفة الكامنة وراء ذلك.

بمجرّد ضبط خادم التطبيق، يجب عليك توجيه طلبات الوكيل إليه عن طريق ضبط خادم الويب بشكل مناسب، على سبيل المثال، قد يتضمّن NGINX الخاص بك التالي:

upstream application_server {

 server 0.0.0.0:8080;

}

server {

 listen 80;

 server_name localhost;

 root /root/path/to/your_app/public;

 try_files $uri/index.html $uri.html @app;

 location @app {

proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

proxy_set_header Host $http_host;

proxy_redirect off;

proxy_pass http://application_server;

 }

 # some other configuration

}

تأكد من قراءة وثائق NGINX للحصول على أحدث المعلومات.

إعدادات بيئة Rails

يمكن أيضًا ضبط بعض أجزاء Rails خارجيًا من خلال توفير متغيرات البيئة، ويتعرّف على المتغيرات البيئة التالية من خلال أجزاء مختلفة من Rails:

  • ENV["RAILS_ENV"] تعرّف بيئة Rails (production، development و test ...) والتي سيعمل Rails تحتها.
  • ENV["RAILS_RELATIVE_URL_ROOT"] يستخدم بواسطة رمز التوجيه للتعرّف على عناوين URL عند نشر تطبيقك إلى مجلّد فرعي.
  • ENV["RAILS_CACHE_ID"] وENV["RAILS_APP_VERSION"] يُستخدمان لإنشاء مفاتيح ذاكرة تخزين مؤقت موسّعة في شيفرة التخزين المؤقت لـ Rails، ويسمح هذا لك بأن يكون لديك عدة مخازن منفصلة من نفس التطبيق.

استخدام ملفات Initializer

بعد تحميل الإطار وبقية gems في تطبيقك، يتحوّل Rails لتحميل Initializers، وهذا الأخير هو أي ملف روبي مخزّن تحت config/initializers في تطبيقك، ويمكنك استخدام Initializers، للاحتفاظ بإعدادات الضبط التي يجب إجراؤها بعد تحميل جميع الأطر وgems، مثل خيارات الإعداد لهذه الأجزاء.

ملاحظة: يمكنك استخدام المجلدات الفرعيّة لتنظيم Initializers الخاصة بك إذا أردت ذلك، لأن Rails سينظر إلى التسلسل الهرمي بأكملة من مجلد Initializers إلى الداخل.

تنبيه: يبنما يدعم Rails ترقيم أسماء ملفات Initializers لأغراضي ترتيب التحميل، فإن الأسلوب الأفضل هو وضع أي شيفرة برمجية مطلوبة للتحميل بترتيب معيّن داخل نفس الملف، ويقلل هذا تذرّع اسم الملف، ويجعل التبعيات أكثر وضوحاً، ويمكن أن يساعد في طرح مفاهيم جديدة داخل تطبيقك.

أحداث التهيئة

يحتوي Rails على 5 أحداث تهيئة يمكن ربطها (مدرجة بترتيب التشغيل):

  • Before_configuration: يشتغل هذا بمجرّد أن يرث ثابت التطبيق من Rails::Application، وتقيّم استدعاءات config قبل حدوث ذلك.
  • Before_initialize: يشتغل هذا مباشرةً قبل حدوث عملية التهيئة الخاصة بالتطبيق باستخدام :bootstrap_hook initializer بالقرب من بداية عملية تهيئة Rails.
  • To_prepare: يشتغل بعد تشغيل initializer لجميع Railties (بما في ذلك التطبيق نفسه)، لكن قبل eager loading وبناء كومة الوسيط. الأهم من ذلك، سيعمل على كل طلب في التطوير، لكن مرة واحدة (أثناء التشغيل) في الإنتاج والاختبار.
  • Before_eager_load: يشتغل هذا مباشرةً قبل حدوث eager loading، والذي هو السلوك الافتراضي لبيئة الإنتاج وليس لبيئة التطوير.
  • After_initialize: يشتغل مباشرةً بعد تهيئة التطبيق، وبعد تشغيل مهئيات التطبيق في config/initializers.

لتعريف حد لهذه hooks، استخدم صياغة الكتلة داخل الصنف الفرعي Rails::Application أو Rails::Railtie أو Rails::Engine:

module YourApp

 class Application < Rails::Application

config.before_initialize do

  # initialization code goes here

end

 end

End

بدلًا من ذلك، يمكنك إجراء ذلك من خلال تابع config في كائن Rails.application:

Rails.application.config.before_initialize do

 # initialization code goes here

End

تحذير: لم تعدّ بعد بعض أجزاء التطبيق، ولا سيما التوجيه، في النقطة التي تُستدعى فيها كتلة after_initialize.

Rails::Railtie#initializer

يحتوي Rails على العديد من initializers التي تعمل عند بدء التشغيل والتي تم تعريفها كافة باستخدام التابع initializer من Rails::Railtie. وهذا مثال على مهيئ set_helpers_path من Action Controller:

initializer "action_controller.set_helpers_path" do |app|

 ActionController::Helpers.helpers_path = app.helpers_paths

End

يأخذ التابع initializer ثلاثة معاملات حيث أن الأول هو اسم المهيئ والثاني هو hash اختياري (غير معروض هنا) والثالث هو كتلة، يمكن تحديد مفتاح :before في hash الخيارات لتحديد المهيئ الجديد الذي يجب تشغيله أولًا، ومفتاح :after سيحدد المهيئ لتشغيل هذا المهيئ فيما بعد.

ستشتغل المهيئات المعرّفة باستخدام تابع initializer بالترتيب الذي تم تعريفها فيه، باستثناء تلك التي تستخدم توابع :before و:after.

تحذير: يمكنك وضع المهيئ الخاص بك قبل أو بعد أي مهيئ آخر في السلسلة، طالما أنه منطقي، لنفترض أن لديك 4 مهيئات تسمى من "one" إلى "four" (معرّفة بهذا الترتيب) ولقد عرّفت "four" لتعمل قبل "four" لكن بعد "three" وهذا ليس منطقيًا ولن يتمكن Rails من تحديد ترتيب المهيئ الخاص بك.

يعتبر معامل الكتلة لتابع initializer هو مثيل من التطبيق نفسه، ولذا يمكنن الوصول إلى ضبطه باستخدام تابع config كما في المثال.

بما أن Rails::Application يرث من Rails::Railtie (بشكل غير مباشر)، يمكنك استخدام تابع initializer فيconfig/application.rb لتعريف المهيئات للتطبيق.

المهيئات

فيما يلي قائمة شاملة لجميع المهيئات الموجودة في Rails بالترتيب الذي تم تعريفهم (وبالتالي تشغيلها ما لم يُنص على خلاف ذلك).

  • Load_environment_hook: يعمل كماسك للمكان (placeholder) بحيث يمكن تعريف :load_environment_config ليشتغل قبله.
  • Load_active_support: يتطلّب active_support/dependencies الذي يعد الأساس لـ Active Support، وهو يتطلّب اخياريًا active_support/all إذا كان config.active_support.bare غير صادق (un-truthful) وهو الإعداد الافتراضي.
  • Initialize_logger: يهيئ المسجّل (كائن ActiveSupport::Logger) للتطبيق ويجعله يمكن الوصول إليه في Rails.logger، بشرط أن لا يوجود مهيئ مدرج قبل هذه النقطة عرّف Rails.logger.
  • Initialize_cache: إذا لم يعّد Rails.cache بعد فهيئ ذاكرة التخزين المؤقت بالرجوع إلى القيمة الموجودة في config.cache_store وخزّن النتائج كـ Rails.cache، إذا كان الكائن يستجيب لتابع الوسيط، يُدرج الوسيط الخاص به قبل Rack::Runtime في كومة الوسيط.
  • Set_clear_dependencies_hook: هذا المهيئ - الذي يعمل فقط في حالة كان cache_classes يساوي false - يستخدم ActionDispatch::Callbacks.after لإزالة الثوابت المشار إليها أثناء الطلب من مساحة الكائن بحيث يعاد تحميلها أثناء الطلب التالي.
  • Initialize_dependency_mechanism: إذا كان config.cache_classes يساوي true، يكوّن ActiveSupport::Dependencies.mechanism لتطلب التبعيات بدلًا من تحميلها.
  • Bootstrap_hook: يشغّل جميع كتل before_initialize المكوّنة.
  • I18n.callbacks: في بيئة التطوير، عيّن رد نظام to_prepare الذي سيستدعي I18n.reload! إذا تغيّرت أي من المحليات منذ آخر طلب، وفي وضع الإنتاج، سيشتغل هذا الاستدعاء فقط عند الطلب الأول.
  • Active_support.deprecation_behavior: يُعدّ تقارير الإهمال للبيئات، وهو بشكل افتراضي :log للتطوير و:notify للإنتاج و :stderr للإختبار، وإذا لم تعيّن قيمة لـ config.active_support.deprecation فسيطالب هذا المهيئ المستخدم بضبط هذا السطر في ملف config/environments الخاص بالبيئة الحالية. يمكن ضبطه إلى مصفوفة من القيم.
  • Active_support.initialize_time_zone: يعيّن المنطقة الزمنيّة الافتراضيّة للتطبيق استنادًا إلى إعداد config.time_zone والذي يساوي افتراضيًا "UTC".
  • Active_support.initialize_beginning_of_week: يعيّن بداية الأسبوع للتطبيق استنادًا إلى إعداد config.beginning_of_week والذي يساوي افتراضيًا :monday.
  • Active_support.set_configs: يُعد Active Support باستخدام الإعدادت الموجودة في config.active_support عن طريق إرسال أسماء التوابع كـ setters إلى ActiveSupport وتمرير القيم من خلالها.
  • Action_dispatch.configure: ضبط ActionDispatch::Http::URL.tld_length لتعيين قيمة config.action_dispatch.tld_length.
  • Action_view.set_configs: إعداد Action View عن طريق استخدام الإعدادات الموجودة في config.action_view عن طريق إرسال أسماء التوابع كـ setters إلى ActionView::Base وتمرير القيم من خلالها.
  • Action_controller.assets_config: تهيئة config.actions_controller.assets_dir إلى مجلّد التطبيق العام إذا لم يكوّن بشكل صريح.
  • Action_controller.set_helpers_path: يعيّن helpers_path الخاص بـ Action Controller إلى helpers_path الخاص بالتطبيق.
  • Action_controller.parameters_config: يكوّن خيارات معاملات قويّة لـ ActionController::Parameters.
  • Action_controller.set_configs: يعّد Action Controller عن طريق استخدام الإعدادات الموجودة في config.action_controller عن طريق إرسال أسماء التوابع كـ setters إلى ActionController::Base وتمرير القيم من خلالها.
  • Action_controller.compile_config_methods: يهيئ التوابع لإعدادات config المحددة بحيث تكون أسرع في الوصول.
  • Active_record.initialize_timezone: يعيّن ActiveRecord::Base.time_zone_aware_attributes إلى true كما يعّد ActiveRecord::Base.default_timezone إلى UTC. عند قراءة السمات من قاعدة البيانات، ستحوّل إلى المنطقة الزمنيّة المحددة بواسطة Time.zone.
  • Active_record.logger: يعيّن ActiveRecord::Base.logger - إذا لم يُعيّن بالفعل - إلى Rails.logger.
  • Active_record.migration_error: يعد الوسيطات للتأكد من وجود عمليات تهجير معلّقة.
  • Active_record.check_schema_cache_dump: يحمّل ملف تفريغ التخزين المؤقت للمخطّط إذا هيئ بالفعل وكان متاحًا.
  • Active_record.warn_on_records_fetched_greater_than: يُمكّن التحذيرات عند تُرجع الاستعلامات عدد كبير من السجلات.
  • Active_record.set_configs: يُعّد Active Record عن طريق استخدام الإعدادات الموجودة في config.active_record عن طريق ارسال أسماء التوابع كـ setters إلى ActiveRecord::Base وتمرير القيم من خلالها.
  • Active_record.initialize_database: يحمّل إعدادات قاعدة البيانات (افتراضيًا) من config/database.yml ويُنشئ اتصال للبيئة الحاليّة.
  • Active_record.log_runtime: يضمّن ActiveRecord::Railties::ControllerRuntime الذي هو المسؤول عن الإبلاغ عن الوقت الذي يستغرقه استدعاءات Active Record  لعودة الطلب إلى logger.
  • Active_record.set_reloader_hooks: يعيد تعيين جميع الاتصالات القابلة لإعادة التحميل إلى قاعدة البيانات في حالة تعيين config.cache_classes كـ false.
  • Active_record.add_watchable_files: يضيف ملفات schema.rb و structure.sql إلى الملفات المراقبة.
  • Active_job.logger: يعيّن ActiveJob::Base.logger - إذا لم تضبط بالفعل - إلى Rails.logger.
  • Active_job.set_configs: يُعّد Active Job عن طريق استخدام الإعدادات الموجودة في config.active_job عن طريق ارسال أسماء التوابع كـ setters إلى ActiveJob::Base وتمرير القيم من خلالها.
  • Action_mailer.logger: يعيّن ActionMailer::Base.logger - إذا لم تضبط بالفعل - إلى Rails.logger.
  • Action_mailer.set_configs: يعد Action Mailer عن طريق استخدام الإعدادات الموجودة في config.action_mailer عن طريق ارسال أسماء التوابع كـ setters إلى ActionMailer::Base وتمرير القيم من خلالها.
  • Action_mailer.compile_config_methods: يهيئ التوابع لإعدادات config المحددة بحيث يكون الوصول إليها أسرع.
  • Set_load_path: يعمل هذا المهيئ قبل bootstrap_hook ويضيف المسارات المحددة بواسطة config.load_paths وجميع مسارات التحميل التلقائي إلى $LOAD_PATH.
  • Set_autoload_paths: يعمل هذا المهيئ قبل bootstrap_hook ويضيف جميع مجلدات app الفرعية والمسارات المحددة بواسطة config.autoload_paths وconfig.eager_load_paths وconfig.autoload_once_paths إلى ActiveSupport::Dependencies.autoload_paths.
  • Add_routing_paths: تحميل (بشكل افتراضي) جميع ملفات config/routes.rb (في التطبيق و railties بما في ذلك المحركات) وإعداد المسارات للتطبيق.
  • Add_locales: يضيف الملفات في config/locales (من التطبيق وrailties والمحركات) إلى I18n.load_path مما يتيح الترجمات في هذه الملفات.
  • Add_view_paths: يضيف مجلد app/views من التطبيق وrailties والمحركات إلى مسار البحث لملفات العرض للتطبيق.
  • Load_environment_config: تحميل ملف config/environments للبيئة الحاليّة.
  • Prepend_helpers_path: يضيف مجلّد app/helpers من التطبيق وrailties والمحركات إلى مسار البحث للمساعدين للتطبيق.
  • Load_config_initializers: تحميل جميع ملفات روبي من config/initializers في التطبيق وrailties والمحركات، يمكن استخدام الملفات الموجودة في هذا المجلّد لاستيعاب إعدادات الضبط التي يجب إجراؤها بعد تحميل جميع إطارات العمل.
  • Engines_blank_point: يوفر نقطة في التهيئة (point-in-initialization) للربط إذا كنت ترغب في القيام بأي شيء قبل تحميل المحركات، بعد هذه النقطة، ستشتغل جميع مهيئات railtie والمحرك.
  • Add_generator_templates: إيجاد القوالب للمولدات في lib/templates للتطبيق، railties والمحركات ويضيف هذه إلى إعداد config.generators.templates الذي سيجّعل القوالب متاحة لجميع المولدات للإشارة إليها.
  • Ensure_autoload_once_paths_as_subset: التأكد أن config.autoload_once_paths لا يحتوي إلا على مسارات من config.autoload_paths وإذا كان يحتوي على مسارات إضافيّة، فسيرفع استثناء.
  • Add_to_prepare_blocks: تضاف الكتلة لجميع استدعاءات config.to_prepare في التطبيق أو railtie أو المحرك إلى ردود النداء to_prepare لـ Action Dispatch والتي ستشتغل لكل طلب في التطوير أو قبل أول طلب في الإنتاج.
  • Add_builtin_route: إذا كان التطبيق قيد التشغيل في بيئة التطوير، فسيؤدي ذلك إلى إلحاق مسار لـ rails/info/properties إلى مسارات التطبيق، ويوفّر هذا المسار معلومات تفصيليّة مثل إصدار Rails وروبي لـ public/index.html في تطبيق Rails الافتراضي.
  • Build_middleware_stack: بناء كومة وسيط للتطبيق، ويرّجع كائن يملك تابع call التي تأخذ كائن بيئة Rack للطلب.
  • Eager_load!: إذا كان config.eager_load يساوي true، فستشتغل خطافات config.before_eager_load ومن ثم استدعاءات eager_load! التي ستحمّل جميع config.eager_load_namespaces.
  • Finisher_hook: يوفّر خطافًا بعد اكتمال تهيئة عملية التطبيق، بالإضافة إلى تشغيل جميع كتل config.after_initialize للتطبيق وrailties والمحركات.
  • Set_routes_reloader_hook: يكوّن Action Dispatch لإعادة تحميل ملف المسارات باستخدام ActiveSupport::Callbacks.to_run.
  • Disable_dependency_loading: يعطّل تحميل التبعيّة التلقائي إذا لم يعيّن config.eager_load على true.

تجميع قواعد البيانات

تدار اتصالات قواعد بيانات Active Record عن طريق ActiveRecord::ConnectionAdapters::ConnectionPool الذي يضمن تزامن مجمع الاتصالات كميّة الوصول الخيوط إلى عدد محدود من اتصالات قاعدة البيانات، الحد الافتراضي لهذا هو 5 ويمكن ضبطه في database.yml.

development:

 adapter: sqlite3

 database: db/development.sqlite3

 pool: 5

 timeout: 5000

نظرًا لأنه يتعامل مع تجمع الاتصالات داخل Active Record افتراضيًا، يجب أن تعمل جميع خوادم التطبيقات (Thin، Puma، Unicorn ….) بنفس الطريقة، إن قاعدة بيانات مجمع الاتصالات فارغ افتراضيًا، كلما زاد الطلب على الاتصالات، سيؤدي إلى ضبطها حتى تصل إلى حد مجمع الاتصالات.

أي طلب سيتحقق من الاتصال المطلوب إلى قاعدة البيانات في المرة الأولى  وفي نهاية الطلب، سيتحقق من إرجاع الاتصال، وهذا يعني أن فتحة الاتصال الإضافية ستتوفّر مرة أخرى للطلب التالي في قائمة الانتظار.

إذا حاولت استخدام اتصالات أكثر من تلك المتاحة، فسيحظرك Active Record وسينتظر اتصال من المجمع، وإذا لم يتمكن من الحصول على اتصال، فسيرمي خطأ انتهاء المهلة تشبه لتلك الموجودة أدناه.

ActiveRecord::ConnectionTimeoutError - could not obtain a database connection within 5.000 seconds (waited 5.000 seconds)

إذا حصلت على الخطأ أعلاه، فقد ترغب في زيادة حجم مجمع الاتصال عن طريق زيادة خيار pool في database.yml.

ملاحظة: إذا كنت تعمل في بيئة متعددة الخيوط، فقد تكون هنالك فرصة لأن العديد من الخيوط قد تصل إلى عدة اتصالات في نفس الوقت، وبناءًا على تحميل الطلب الحالي، قد يكون لديك العديد من الخيوط التي تتنافس على عدد محدود من الاتصالات.

الضبط المخصًص

يمكنك ضبط الشيفرة البرمجية الخاصة بك من خلال كائن ضبط Rails مع ضبط مخصص تحت إما مساحة الاسم config.x أو config مباشرةً، والفرق الرئيسي بين هذيّن هو أنه يجب أن تستخدم config.x إذا كنت تعرّف ضبط متداخل (مثلًا: config.x.nested.nested.hi) وconfig لضبط مستوى واحد (مثلًا: config.hello).

config.x.payment_processing.schedule = :daily

config.x.payment_processing.retries  = 3

config.super_debugger = true

هذه نقاط الضبط متاحة بعد ذلك من خلال كائن الضبط:

Rails.configuration.x.payment_processing.schedule # => :daily

Rails.configuration.x.payment_processing.retries  # => 3

Rails.configuration.x.payment_processing.not_set  # => nil

Rails.configuration.super_debugger             # => true

يمكنك أيضًا استخدام Rails::Application.config_for لتحميل ملفات الضبط بأكملها:

# config/payment.yml:

production:

 environment: production

 merchant_id: production_merchant_id

 public_key:  production_public_key

 private_key: production_private_key

development:

 environment: sandbox

 merchant_id: development_merchant_id

 public_key:  development_public_key

 private_key: development_private_key

# config/application.rb

module MyApp

 class Application < Rails::Application

config.payment = config_for(:payment)

 end

End

Rails.configuration.payment['merchant_id'] # => production_merchant_id or development_merchant_id

فهرسة محركات البحث

في بعض الأحيان، قد ترغب في منع ظهور بعض صفحات تطبيقك على مواقع البحث من Google أو Bing أو Yahoo أو Duck Duck Go، تعمل برامج الروبوتات التي تفهرس هذه المواقع أولًأ على تحليل ملف http://your-site.com/robots.txt لمعرفة الصفحات التي يُسمح لها بفهرستها.

ينشئ Rails هذا الملف داخل مجلد /public وافتراضيًا، يسمح لمحركات البحث بفهرسة جميع صفحات تطبيقك، وإذا كنت ترغب في حظر فهرسة في جميع صفحات تطبيقك، فاستخدم هذا:

User-agent: *

Disallow: /

لحظر فهرسة صفحات محدّدة فقط، فمن الضروري استخدام صياغة أكثر تعقيدًا، تعلّم ذلك على الوثائق الرسميّة.

رصد نظام الملفات المنفذة

عند تحميل  gem الاستماع، فإن Rails يستخدم مراقب نظام الملفات منفذة للكشف على التغييرات عندما يكون config.cache_classes يساوي false:

group :development do

 gem 'listen', '>= 3.0.5', '< 3.2'

end

خلاف ذلك، في كل طلب، يمر Rails على شجرة التطبيق للتأكد ما إذا قد تغيّر أي شيء.

لا توجد حاجة إلى gem إضافيّة في لينكس وماك، ولكن بعضها مطلوب لـ *BSD و ويندوز.

لاحظ أن بعض أجهزة الإعداد غير مدعومة.

https://guides.rubyonrails.org/configuring.html

مجلوبة من "https://wiki.hsoub.com/index.php?title=Rails/configuring&oldid=28069"