cck_forms 3.0.1 → 3.1.0

data/lib/cck_forms/parameter_type_class/base.rb

@@ -1,53 +1,46 @@
-# Базовая примесь для всех типов полей. Определяет всякие помогайки. Ее нужно включать методом include во все типы,
-# например, String, Checkboxes и т. п.
+# Base module for all field types. Is included in type classes like Album, Image etc.
 #
 #   class CckForms::ParameterTypeClass::NewType
 #     include CckForms::ParameterTypeClass::Base
-#
-#     def self.name
-#       'Новый тип'
-#     end
 #   end
 #
-#   CckForms::ParameterTypeClass::NewType.name            # 'Новый тип', берется из CckForms::ParameterTypeClass::NewType::name
-#
-# Использование типов:
+# Standalone usage of real classes:
 #
 #   field :cover_photo, type: CckForms::ParameterTypeClass::Image
-#   field :gallery, type: CckForms::ParameterTypeClass::Album
+#   field :gallery,     type: CckForms::ParameterTypeClass::Album
 #   field :description, type: CckForms::ParameterTypeClass::Text
 #
-# Что есть в базовом типе:
+# Base module includes:
 #
-#   1) все помощники УРЛов вида edit_article_path, включаемые через include Rails.application.routes.url_helpers;
+#   1) URL helpers like edit_article_path accessible via include Rails.application.routes.url_helpers;
 #
-#   2) методы cck_param и value, которые возвращают текущий параметр (module CckForms::*::Parameter) и его значение;
+#   2) methods cck_param & value returning current CCK parameter (module CckForms::*::Parameter) and his current value;
 #
-#   3) методы with_cck_param(param) do ... и with_value(value) do ..., которые устанавливают соотв, значения методов
-#      cck_param/value на время выполнения блока (еще есть with_cck_param_and_value(param, value) do ...);
+#   3) methods with_cck_param(param) do ..., with_value(value) do ... and with_cck_param_and_value(param, value) do ...
+#      which set the corresponding values for the block duration;
 #
-#   4) динамический метод (через method_missing и respond_to?) ..._with_value(value, args*), который делает то же,
-#      что и with_value, но для вызова 1 метода;
+#   4) dynamic method (via method_missing & respond_to?) ..._with_value(value, args*) which is basically the same as
+#      with_value do... but for one method invocation only: foo_with_value(v) <=> with_value(v) { foo }
 #
-#   5) set_value_in_hash(hash), который кладет value в hash[:value];
+#   5) utility set_value_in_hash(hash) placing value in hash[:value];
 #
-#   6) помощники для получения ХТМЛ ID form(_builder)?_name_to_id;
+#   6) utilities to get HTML ID: form(_builder)?_name_to_id;
 #
-#   7) методы для потребителей (типизированных объектов):
+#   7) methods to be consumed by the type classes:
 #
-#        self.code            - код типа из имени модуля (CckForms::ParameterType::RichText -> rich_text)
-#        self.name            - имя типа ("Cтрока")
+#        self.code  - type code (e.g. rich_text for CckForms::ParameterType::RichText)
+#        self.name  - type name (e.g. "A text string")
 #
 module CckForms::ParameterTypeClass::Base
   extend ActiveSupport::Concern
 
   included do
-    # Кое-где понадобятся помогайки-пути, сразу их включим.
     include Rails.application.routes.url_helpers
 
     attr_accessor :value
     attr_reader :valid_values_class_name, :cck_parameter
 
+    # Store options into instance variables like @valid_values and so on
     def initialize(options)
       options = options.symbolize_keys
 
@@ -70,14 +63,20 @@ module CckForms::ParameterTypeClass::Base
 
 
   module ClassMethods
+    # Called on a class to construct its instance from a MongoDB Hash.
+    # By default simply create a new object.
     def demongoize(something_from_database)
       new value: demongoize_value(something_from_database)
     end
 
+    # Only converts a value from MongoDB to its in-memory (Ruby) form.
+    # By default, return the value itself.
     def demongoize_value(value, parameter_type_class=nil)
       value
     end
 
+    # Called on an class to get a MongoDB Hash form of an instance object.
+    # By default simply calls mongoize of the instance.
     def mongoize(object)
       case object
       when self then object.mongoize
@@ -87,43 +86,38 @@ module CckForms::ParameterTypeClass::Base
       end
     end
 
-    # Возвращает строку с яваскриптовым кодом для выполнения в БД кода emit операции map-reduce на поле данного типа.
-    # Поскольку у различных типов данные в БД хранятся по-разному, и вообще понятие "текущего значения этого типа"
-    # различается, мы вынуждены отдельно описывать операцию emit, там где это необходимо. Смысл в том, чтобы этот метод
-    # вызвал emit для каждого хранимого значения.
+    # Returns Javascript emit function body to be used as a part of map/reduce "emit" step, see
+    # http://docs.mongodb.org/manual/applications/map-reduce/
     #
-    # Пример: есть поле city типа checkboxes, хранящее список городов, то-есть объекты, описываемые этим полем,
-    # могут быть в разных городах. Если мы хотим сделать группировочный запрос (частный случай map-reduce) в БД, чтобы,
-    # например, подсчитать кол-во объектов в городах, мы не можем просто сделать emit для всего поля city, поскольку
-    # оно содержит список городов. Мы должны вызывать emit для каждого элемента массива (т. е., для каждого идентификатора
-    # города). Генерацией этого кода и занимается этот метод.
+    # The reason for this is every type class has its own notion of "current value" and stores it specifically. Say,
+    # Checkboxes store an array of values and if we want to get distinct values we need a way to extract each "single
+    # value" from this array.
     #
-    # В частности, он используется при подсчете популярных значения различных полей (сколько объявлений, поданых
-    # в разные города, и т. п.)
+    # Example: imagine a field "city" of type Checkboxes. To make an aggregate query (a subtype of map-reduce)
+    # to count objects in different cities, for example, we can not run emit for the field as a whole since it is an
+    # array. We must call emit for each array value, that is for each city ID. This method does exactly this.
     #
-    # По-умолчанию, считаем, что значение, хранимое в поле "#{feild_name}" атомарно, и вызываем  emit для него.
+    # In particular, it is used in counting popular values (like "give me a list of cities sorted by the number of
+    # host objects (ads? companies?) in them").
     #
-    # Подробнее про map-reduce см. http://docs.mongodb.org/manual/applications/map-reduce/
+    # By default considers a value in "#{feild_name}" atomic and call emit for it.
     def emit_map_reduce(feild_name)
       field_name = 'this.' + feild_name
       "if(#{field_name} && #{field_name} != '') emit(#{field_name}, 1)"
     end
 
-    # Конвертирует имя элемента формы в ID, например facility[cck_params][1][value] -> facility_cck_params_1_value.
+    # Converts input name intp HTML ID, e.g. facility[cck_params][1][value] -> facility_cck_params_1_value.
     def form_name_to_id(name)
       name.gsub(/\]\[|[^-a-zA-Z0-9:.]/, '_').sub(/_\z/, '')
     end
 
-    # Методы, которые нужны наследникам (CckForms::ParameterTypeClass::*) для отображения, сортировки и прочей настройки самих типов.
-    # Эти методы не нужны обычным объектам - пользователям типов.
-
     # CckForms::ParameterTypeClass::Checkboxes -> 'checkboxes'
     # CckForms::ParameterTypeClass::RichText -> 'rich_text'
     def code
       self.to_s.demodulize.underscore
     end
 
-    # Имя типа, например, для select>option[value]
+    # A type name, e.g. "A text string"
     def name
       nil
     end
@@ -131,7 +125,7 @@ module CckForms::ParameterTypeClass::Base
 
 
 
-  # Загрузит все классы-наследники.
+  # Load all type classes
   # TODO: relies on all classes to reside in this class' directory
   def self.load_type_classes
     return if @type_classes_loaded
@@ -146,10 +140,9 @@ module CckForms::ParameterTypeClass::Base
 
 
 
-  # "Нормальные" методы, которые будут доступны всем пользователям данного модуля.
+  # Usual methods available to type classes (consumers of this module)
 
-  # -> [[key1, value1], [key2, value2], ...]
-  # Нужен для построения ХТМЛ СЕЛЕКТов.
+  # Generates valid_values in form consumable to SELECT helper builders: [[key1, value1], [key2, value2], ...]
   def valid_values_enum
     valid_values = self.valid_values
     return [] if valid_values.blank?
@@ -161,13 +154,12 @@ module CckForms::ParameterTypeClass::Base
     result
   end
 
-  # -> "georgian: грузинская, albanian: албанская"
-  # Нужен для построения ХТМЛа и строк.
+  # Generates valid values as a comma-separated string: "georgian: грузинская, albanian: албанская" (for HTML puproses)
   def valid_values_as_string
     valid_values_enum.map { |enum| "#{enum[1]}: #{enum[0]}" }.join "\n"
   end
 
-  # Чтобы получать данные из форм и сохранять в БД. Использовать во вьюхах:
+  # Convert HTML form back into Hash again:
   #   = f.text_field :valid_values_as_string
   def valid_values_as_string=(string)
     new_valid_values = {}
@@ -178,13 +170,12 @@ module CckForms::ParameterTypeClass::Base
     self.valid_values = new_valid_values
   end
 
-  # Вернет класс, указанный как valid_values_class_name.
   # "City" -> City
   def valid_values_class
     if valid_values_class_name.present?
       if valid_values_class_name.is_a? Class
         valid_values_class_name
-      else # если это не строка, то пусть будет выборошено исключение
+      else # raises exception if this is not a string
         valid_values_class_name.constantize
       end
     else
@@ -192,13 +183,13 @@ module CckForms::ParameterTypeClass::Base
     end
   end
 
-  # Существует ли valid_values_class?
+  # Is valid_values_class exist at all?
   def valid_values_class?
     not valid_values_class.nil?
   end
 
-  # Если valid_values пустой, и есть valid_values_class, запишет в valid_values все значения
-  # из valid_values_class. Считает, что класс похож на ActiveRecord, и значения берет из all.
+  # If valid_values is empty and valid_values_class is not, extracts all values from this class into valid_values.
+  # Makes use of ActiveRecord-like method .all for this
   def valid_values
     @valid_values ||= begin
       if vv_class = valid_values_class
@@ -209,39 +200,43 @@ module CckForms::ParameterTypeClass::Base
     end
   end
 
-  # Строит форму редактирования. Просто input:text со всеми переданными опциями (значение можно определить через
-  # options[:value]).
+  # Builds an edit form in HTML.
+  # By default an input:text (value can be set via options[:value]).
   def build_form(form_builder, options)
     set_value_in_hash options
     form_builder.text_field :value, options
   end
 
-  # Вернем в виде HTML
+  # HTML form of a type class.
+  # By default to_s.
   def to_html(options = nil)
     to_s options
   end
 
-  # Чтобы принимать аргумент options
+  # Redefines to allow passing of options.
+  # By default, call to_s on the current value.
   def to_s(options = nil)
     value.to_s
   end
 
-  # Отображение для страниц "было-стало" в админках и пр. (например, тип "карта" можнет вернуть ХТМЛ картинки-миниатюры).
+  # Was-became HTML for admin panels etc. (like a type image with map preview for Map).
   def to_diff_value(options = nil)
     to_html options
   end
 
-  # Формируем поисковый запрос для монго на основе запроса (типа мини-DSL язык запроса, свой для каждого типа).
+  # Transforms DSL-like query (specific to each type) into Mongoid query.
+  # By default use simple where(field: query.to_s).
   def search(selectable, field, query)
     selectable.where(field => query.to_s)
   end
 
-  # Нужен для Rails.application.routes.url_helpers
+  # For Rails.application.routes.url_helpers
   def default_url_options
     {}
   end
 
-  # Реализация перобразования в/из Монго по умолчанию: берем то, что в value
+  # Transforms the value into MongoDB form.
+  # By default returns the value itself.
   def mongoize
     value
   end
@@ -263,12 +258,12 @@ module CckForms::ParameterTypeClass::Base
     options[:value] = value unless options.has_key? :value
   end
 
-  # См. ClassMethod.form_name_to_id
+  # See ClassMethod.form_name_to_id
   def form_name_to_id(name)
     self.class.form_name_to_id name
   end
 
-  # Конвертирует имя элемента формы из FormBuilder, см. form_name_to_id.
+  # Converts FormBuilder name to ID, see form_name_to_id
   def form_builder_name_to_id(form_builder, suffix = '')
     form_name_to_id([form_builder.options[:namespace], form_builder.object_name].compact.join('_') + suffix)
   end

data/lib/cck_forms/parameter_type_class/boolean.rb

@@ -1,3 +1,5 @@
+# Represents a single checkbox.
+#
 class CckForms::ParameterTypeClass::Boolean
   include CckForms::ParameterTypeClass::Base
 
@@ -5,18 +7,22 @@ class CckForms::ParameterTypeClass::Boolean
     'Галочка (да/нет)'
   end
 
+  # Is it true?
   def value?
     value.present? && value != '0'
   end
 
+  # Anything -> boolean
   def mongoize
     value?
   end
 
+  # 'yes/no' string
   def to_s(options = nil)
     value? ? 'да' : 'нет'
   end
 
+  # Checkbox HTML
   def build_form(form_builder, options)
     set_value_in_hash options
     form_builder.check_box :value, options.merge(value: 1, checked: value?)

data/lib/cck_forms/parameter_type_class/checkboxes.rb

@@ -1,3 +1,5 @@
+# Represents a series of checkboxes. The values are take from valid_values, see base.rb
+#
 class CckForms::ParameterTypeClass::Checkboxes
   include CckForms::ParameterTypeClass::Base
 
@@ -25,7 +27,7 @@ class CckForms::ParameterTypeClass::Checkboxes
   end
 
   # ['kazakh', 'english'] -> {'kazakh' => 1, 'russain' => 0, 'english' => 1}
-  # (такой формат нужен формам)
+  # (for for builders)
   def self.demongoize_value(value, parameter_type_class=nil)
     value.present? or return {}
 
@@ -36,13 +38,14 @@ class CckForms::ParameterTypeClass::Checkboxes
     end
   end
 
-  # Перечислим все отмеченные элементы в строку.
-  # options[:block]  - задает шаблон sprintf для каждого вхождения
-  # options[:only]   - массив, оставить только эти ключи (можно передать одно, без массива)
-  # options[:except] - :only наоборот
-  # options[:glue]   - используем его вместо ', ' для склейки значений
-  # options[:short]  - по-возможности сокращать: если указаны все варианты, то вернется строка вида "выбрано все"
-  #                  - или "все, кроме xxx", если не выбран только xxx
+  # Comma-separated list of checked entries. Options:
+  #
+  #   block   - sprintf template for each entry
+  #   only    - leave only these keys (array/string)
+  #   except  - reverse of :only
+  #   glue    - use instead of ', ' for .join
+  #   short   - make the string shorter, if possible: if all variants are checked, returns string "all selected"
+  #             if few are not checked, returns "all except xxx, yyy, ..."
   def to_s(options = nil)
     checked_keys, checked_elements = [], []
     return '' if value.blank?
@@ -92,6 +95,10 @@ class CckForms::ParameterTypeClass::Checkboxes
     checked_elements.join glue
   end
 
+  # Construct Mongoid query from our internal. If query is a Hash, find all objects where field has ALL of the Hash keys.
+  # Key 'all' selected all objects.
+  #
+  # Otherwise, use usual where(field => query).
   def search(selectable, field, query)
     if query.respond_to? :each_pair
       keys = []
@@ -112,11 +119,11 @@ class CckForms::ParameterTypeClass::Checkboxes
     selectable
   end
 
-  # Составим строку для map-reduce, чтобы emit вызывался на каждом отмеченном значении, например, в документе хранится:
+  # Construct emit func for map/reduce to emit on each array value in MongoDB. For example, for object:
   #
   #   cck_params.city: ['almaty', 'astana']
   #
-  # Мы вызовем emit('almaty', 1); emit('astana', 1).
+  # we will emit('almaty', 1); emit('astana', 1).
   def self.emit_map_reduce(field_name)
     field_name = 'this.' + field_name
     return "if(#{field_name} && #{field_name} instanceof Array) {
@@ -126,11 +133,15 @@ class CckForms::ParameterTypeClass::Checkboxes
     }"
   end
 
-  # options[:block] - задает шаблон sprintf для каждого чекбокса (input, label)
-  # options[:map]   - задает преобразование (ключ-значение) текстов в подписях, например, 'длинный текст' => 'кор. ткст'
-  # options[:data]  - задает data-атрибуты для тэга label, по ключу из valid_values (capital: {almaty: 'yes', astana: 'no'})
-  # options[:as]    - если :select, то показать не в виде чекбоксов, а в виде выпадайки
-  # options[:only]  - только этот ключ (ключи)
+  # options:
+  #
+  #   block   - sprintf template for each entry (input, label)
+  #   map     - convert entry labels, e.g. 'long label text' => 'sh.txt'
+  #   data    - data-attrs for label, Hash (e.g. capital: {almaty: 'yes', astana: 'no'})
+  #   as      - if :select, construct a SELECT, not a checkboxes list
+  #   only    - see #to_s
+  #   except  - see #to_s
+  #   for     - if :search, do not add false-value checkbox
   def build_form(form_builder, options)
     return '' unless valid_values.is_a?(Hash) || valid_values.is_a?(Array)
 
@@ -176,6 +187,11 @@ class CckForms::ParameterTypeClass::Checkboxes
 
   private
 
+  # options:
+  #
+  #   only      - see #to_s
+  #   except    - see #to_s
+  #   required  - HTML required attr
   def build_select_form(form_builder, options)
     set_value_in_hash options
 

data/lib/cck_forms/parameter_type_class/date.rb

@@ -1,3 +1,5 @@
+# Represents a single date.
+#
 class CckForms::ParameterTypeClass::Date
   include CckForms::ParameterTypeClass::Base
   include CckForms::DateTime
@@ -6,11 +8,13 @@ class CckForms::ParameterTypeClass::Date
     'Дата'
   end
 
+  # Date SELECT
   def build_form(form_builder, options)
     set_value_in_hash options
     self.class.build_date_form(form_builder, options)
   end
 
+  # Date SELECT as a set of 3 SELECTS: year, month, date
   def self.build_date_form(form_builder, options, type = '')
     val =  options[:value].is_a?(Hash) ? options[:value][type] : options[:value]
     val = CckForms::ParameterTypeClass::Time::date_object_from_what_stored_in_database(val)
@@ -19,6 +23,7 @@ class CckForms::ParameterTypeClass::Date
     ('<div class="form-inline">%s</div>' % form_builder.fields_for(:value) { |datetime_builder| datetime_builder.date_select type, form_element_options, form_element_html}).html_safe
   end
 
+  # "12.12.2012"
   def to_s(options = nil)
     if value.is_a? Time
       the_value = {

data/lib/cck_forms/parameter_type_class/date_range.rb

@@ -1,3 +1,5 @@
+# Represents a pair of date SELECTs (date range).
+#
 class CckForms::ParameterTypeClass::DateRange
   include CckForms::ParameterTypeClass::Base
 
@@ -5,6 +7,7 @@ class CckForms::ParameterTypeClass::DateRange
     'Диапазон между двумя датами'
   end
 
+  # Converts input hash of type {from: ..., till: ...} to MongoDB format
   def mongoize
     value_from_form = value
     return nil if value_from_form.blank?
@@ -21,6 +24,7 @@ class CckForms::ParameterTypeClass::DateRange
     db_representation
   end
 
+  # 2 date SELECTs
   def build_form(form_builder, options)
     result = []
     set_value_in_hash options
@@ -32,6 +36,9 @@ class CckForms::ParameterTypeClass::DateRange
     result.join.html_safe
   end
 
+  # "from 21.12.2012"
+  # "till 22.12.2012"
+  # "21.12.2012 - 22.12.2012"
   def to_s
     return '' unless value.present? && value.is_a?(Hash)
     types = {}
@@ -49,5 +56,4 @@ class CckForms::ParameterTypeClass::DateRange
     end
 
   end
-
-end
+end

data/lib/cck_forms/parameter_type_class/date_time.rb

@@ -1,3 +1,5 @@
+# Represents a single date & time.
+#
 class CckForms::ParameterTypeClass::DateTime
   include CckForms::ParameterTypeClass::Base
   include CckForms::DateTime
@@ -6,6 +8,7 @@ class CckForms::ParameterTypeClass::DateTime
     'Дата и время'
   end
 
+  # Date and time SELECTs
   def build_form(form_builder, options)
     set_value_in_hash options
     value = CckForms::ParameterTypeClass::Time::date_object_from_what_stored_in_database(options[:value])
@@ -15,19 +18,18 @@ class CckForms::ParameterTypeClass::DateTime
     ('<div class="form-inline">%s</div>' % form_builder.fields_for(:value) { |datetime_builder| datetime_builder.datetime_select '', form_element_options, form_element_html})
   end
 
-  # Формирует строковое представление даты и времени. Если options :символ, это эквивалентно options[:символ] = true,
-  # например:
+  # Options is a :symbol -> options[:symbol] = true:
   #
   #   date_attr.to_s :only_date
-  #   date_attr.to_s :only_date => true # эквивалентно
+  #   date_attr.to_s :only_date => true # equivalent
   #
-  # Ключи options:
+  # options:
   #
-  #   year_obligatory - вывести год, по-умолчанию, он не показывается, если равен текущему
-  #   only_date       - только дату, без времени
-  #   rus_date        - дату по-русски, типа "2 июля"
+  #   year_obligatory - force year in output (by default current year is skipped)
+  #   only_date       - hide time
+  #   rus_date        - Russian date, like "2 июля"
   #
-  # По-умолчанию, вернет строку вида "01.02.2012, 12:49". Если что-то сломалось, вернет пустую строку.
+  # By default: "01.02.2012, 12:49".
   def to_s(options=nil)
     value = if self.value.is_a? Time
               {

data/lib/cck_forms/parameter_type_class/enum.rb

@@ -1,3 +1,5 @@
+# Represents a enum (SELECT).
+#
 class CckForms::ParameterTypeClass::Enum
   include CckForms::ParameterTypeClass::Base
 
@@ -9,11 +11,14 @@ class CckForms::ParameterTypeClass::Enum
     value.presence
   end
 
+  # Current string value from valid_values
   def to_s(options = nil)
     return '' if value.blank?
     valid_values[value].to_s
   end
 
+  # Constructs MongoDB query. If query is a Hash, find all objects where field is any of the hash keys, for which value
+  # is '1'. Otherwise treat query as where(filed => query).
   def search(selectable, field, query)
     if query.is_a? Hash
       query = query.map { |k, v| v == '1' ? k : nil }.compact
@@ -27,6 +32,12 @@ class CckForms::ParameterTypeClass::Enum
     end
   end
 
+  # options:
+  #
+  #   as        - if 'checkboxes', display a set of checkboxes, not SELECT
+  #   only      - leave only these keys (array/string)
+  #   except    - reverse of :only
+  #   required  - HTML required attr
   def build_form(form_builder, options)
 
     if options.is_a? Hash and options[:as] == 'checkboxes'

data/lib/cck_forms/parameter_type_class/file.rb

@@ -1,5 +1,8 @@
+# Represents a single file.
+#
 class CckForms::ParameterTypeClass::File
   include CckForms::ParameterTypeClass::Base
+  include CckForms::NeofilesDenormalize
 
   def self.name
     'Файл'
@@ -13,29 +16,23 @@ class CckForms::ParameterTypeClass::File
     self.class.file_type
   end
 
-  # Если передан Neofiles::File, вернет его идентификатор, если строка - вернет ее, иначе - nil.
+  # Converts Neofiles::File or its ID into denormalized Hash to be stored in MongoDB
   def mongoize
-    case value
-      when file_type then value.id
-      when ::String then value
-    end
+    self.class.neofiles_attrs_or_id value, file_type
   end
 
-  # Попытаемся получить объект Neofiles::File по его идентификатору. Если не получилось, вернем nil.
+  # Converts denormalized attrs hash or ID to Neofiles::File instance (possibly lazy loadable)
   def self.demongoize_value(value, parameter_type_class=nil)
-    file_type.find(value) unless value.blank?
-  rescue Mongoid::Errors::DocumentNotFound
-    nil
+    neofiles_mock_or_load value
   end
 
-  # Строит форму выбора и загрузки 1 картинки.
-  #
-  # Ставит ДИВ и делает аяксовый вызов метода file_compact контроллера Neofiles::AdminController.
+  # Constructs HTML form for image upload & manipulation. Basically, it is a DIV with some ID and a Javascript widget
+  # creation for that DIV.
   #
-  # Ключи options:
-  #
-  #   value          - текущее значение (идентификатор или объект Neofiles::File)
+  # options:
   #
+  #   value     - current value (ID or Neofiles::File)
+  #   with_desc - if true, show the description edit richtext (default false)
   def build_form(form_builder, options)
     set_value_in_hash options
     self.class.create_load_form helper: self,
@@ -45,15 +42,23 @@ class CckForms::ParameterTypeClass::File
                                 with_desc: options[:with_desc]
   end
 
+  # Create image load DIV & script. A separate function to allow other (non-CCK) fields to utilize this functionality.
+  #
+  #   helper    - view context for HTML generation (`self` in views or `view_context` in controllers)
+  #   file      - Neofiles::File or ID
+  #   widget_id - DIV ID
+  #   input_name, append_create, clean_remove, disabled, multiple, with_desc
+  #             - Neofiles arguments, see Neofiles::AdminController
   def self.create_load_form(helper:, file:, input_name:, append_create: false, clean_remove: false, widget_id: nil, disabled: false, multiple: false, with_desc: false)
     cont_id   = 'container_' + (widget_id.presence || form_name_to_id(input_name))
 
     # создаем временное поле, чтобы пока аяксовый ответ не вернется, мы могли все же отправить родительскую форму
     # и не потерять при этом данные из поля
+    file_id = file.is_a?(file_type) ? file.id.to_s : file.to_s
     temp_field, remove_temp_field = '', ''
-    if file.present? && file.is_a?(String)
-      temp_id           = "temp_file_field_#{file}"
-      temp_field        = '<input id="' + temp_id + '" type="hidden" name="' + input_name + '" value="' + file + '">'
+    if file_id.present?
+      temp_id           = "temp_file_field_#{file_id}"
+      temp_field        = '<input id="' + temp_id + '" type="hidden" name="' + input_name + '" value="' + file_id + '">'
       remove_temp_field = '$("#' + temp_id + '").remove();'
     end
 
@@ -62,7 +67,7 @@ class CckForms::ParameterTypeClass::File
 
     <script type="text/javascript">
       $(function() {
-          $("#' + cont_id + '").load("' + helper.neofiles_file_compact_path(id: file, input_name: input_name, widget_id: widget_id, append_create: append_create ? '1' : nil, clean_remove: clean_remove ? '1' : nil, disabled: disabled ? '1' : nil, multiple: multiple ? '1' : nil, with_desc: with_desc ? '1' : nil) + '", null, function() {
+          $("#' + cont_id + '").load("' + helper.neofiles_file_compact_path(id: file_id, input_name: input_name, widget_id: widget_id, append_create: append_create ? '1' : nil, clean_remove: clean_remove ? '1' : nil, disabled: disabled ? '1' : nil, multiple: multiple ? '1' : nil, with_desc: with_desc ? '1' : nil) + '", null, function() {
               $(this).children().unwrap();
               ' + remove_temp_field + '
           });
@@ -70,11 +75,13 @@ class CckForms::ParameterTypeClass::File
     </script>'
   end
 
+  # Returns empty string
   def to_s
     ''
   end
 
+  # Returns a file name
   def to_diff_value(options = {})
-    "Файл: #{self.value.try! :name}"
+    value.try! :name
   end
 end