add description to Models - closes #6

Author: GarPit

app/assets/javascripts/templates/entries/index.html.slim

@@ -3,7 +3,7 @@
     .widget
       .widget-header
         i.fa.fa-list
-        = Kms::Entry.model_name.human(count: 1.1)
+        | {{ model.description }}
         a.btn.btn-sm.btn-primary.pull-right ui-sref="models.entries.new({modelId: model.id})"
           = I18n.t("add_entry")
       .widget-body.no-padding

app/assets/javascripts/templates/models/form.html.slim

@@ -5,6 +5,10 @@
   label for="collection_name" = Kms::Model.human_attribute_name(:collection_name)
   input#collection_name.form-control type="text" ng-model="model.collection_name"
   small.help-block = I18n.t(:collection_name_field_hint)
+.form-group
+  label for="description" = Kms::Model.human_attribute_name(:description)
+  textarea#description.form-control ng-model="model.description"
+  small.help-block = I18n.t(:description_field_hint)
 .form-group
   label for="label_field" = Kms::Model.human_attribute_name(:label_field)
   select#label_field.form-control ng-model="model.label_field" ng-options="field.liquor_name as field.name for field in model.fields_attributes"

app/controllers/kms/models/models_controller.rb

@@ -1,7 +1,7 @@
 module Kms
   module Models
     class ModelsController < ApplicationController
-      wrap_parameters :model, include: [:kms_model_name, :collection_name, :label_field, :fields_attributes, :allow_creation_using_form]
+      wrap_parameters :model, include: [:kms_model_name, :collection_name, :description, :label_field, :fields_attributes, :allow_creation_using_form]
 
       def index
         render json: Model.all, root: false
@@ -38,7 +38,7 @@ def destroy
       protected
 
       def model_params
-        params.require(:model).permit(:kms_model_name, :collection_name, :label_field, :allow_creation_using_form, fields_attributes: [:id, :name, :liquor_name, :type, :class_name, :_destroy])
+        params.require(:model).permit(:kms_model_name, :collection_name, :description, :label_field, :allow_creation_using_form, fields_attributes: [:id, :name, :liquor_name, :type, :class_name, :_destroy])
       end
 
     end

app/serializers/kms/model_serializer.rb

@@ -1,6 +1,6 @@
 module Kms
   class ModelSerializer < ActiveModel::Serializer
-    attributes :id, :kms_model_name, :collection_name, :label_field, :allow_creation_using_form, :fields_attributes
+    attributes :id, :kms_model_name, :collection_name, :description, :label_field, :allow_creation_using_form, :fields_attributes
 
     has_many :fields_attributes, serializer: Kms::FieldSerializer
 

config/locales/en.yml

@@ -12,6 +12,7 @@ en:
   select_field_type: "Select field type"
   select_model: "Select Model"
   collection_name_field_hint: "You can access model collection like this: models.your_collection_name (ex., models.services)"
+  description_field_hint: "Optional field. Just write some description so everyone would be aware what's the purpose of this Model"
   label_field_hint: "Add at least one Field below. And then you could choose one that would be used for item permalink generation and entries list displaying"
   allow_creation_using_form_field_hint: "On website you can place a form allowing to create model entries"
   has_many_field_placeholder: "Select related objects..."
@@ -55,6 +56,7 @@ en:
       kms/model:
         kms_model_name: "Name"
         collection_name: "Collection name (for Liquor)"
+        description: "Description"
         fields: "Fields"
         label_field: "Label field (used for URL/slug generating)"
         allow_creation_using_form: "Allow creation using form"

config/locales/ru.yml

@@ -12,6 +12,7 @@ ru:
   select_field_type: "Выберите тип свойства"
   select_model: "Выберите модель"
   collection_name_field_hint: "К коллекции можно будет обратиться так: models.your_collection_name (напр., models.services)"
+  description_field_hint: "Необязательное поле. Напишите небольшое описание, чтобы было понятно назначение данной Модели"
   label_field_hint: "Добавьте хотя бы одно Свойство ниже. И затем вы можете выбрать свойство для генерации ссылки на элемент, а так же для отображения элементов в списке"
   allow_creation_using_form_field_hint: "На сайте можно будет разместить форму для создания элементов модели"
   has_many_field_placeholder: "Выберите связанные объекты..."
@@ -54,6 +55,7 @@ ru:
       kms/model:
         kms_model_name: "Название"
         collection_name: "Название коллекции (для Liquor)"
+        description: "Описание"
         fields: "Свойства"
         label_field: "Поле, используемое для генерации ссылок на объекты"
         allow_creation_using_form: "Разрешить создание элементов с помощью форм"

db/migrate/20180122135245_add_description_to_kms_models.rb

@@ -0,0 +1,5 @@
+class AddDescriptionToKmsModels < ActiveRecord::Migration[5.1]
+  def change
+    add_column :kms_models, :description, :text
+  end
+end

spec/controllers/kms/models/models_controller_spec.rb

@@ -34,7 +34,7 @@ module Models
         end
         context 'when valid' do
           it "returns no content" do
-            attributes = { kms_model_name: 'Posts', collection_name: 'posts', allow_creation_using_form: true }
+            attributes = { kms_model_name: 'Posts', collection_name: 'posts', description: 'Posts', allow_creation_using_form: true }
             post :create, params: { model: attributes }, format: :json
             expect(response).to have_http_status(204)
             expect(Kms::Model.last.attributes.symbolize_keys).to include attributes