bemer 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 16debb87f2467a03c58ce016590f7a8782f8058b
-  data.tar.gz: 106a22bbfb569721d22b9cde7d9f4518ede99ec2
+SHA256:
+  metadata.gz: bcd184e6311cfaf5b2e13259388684f7060d3a2dcadb82ee746f0535554700c5
+  data.tar.gz: 294e3d815a456c4dff418bd8d2afbf221a43a0f78bfb0f90a1cbb1581eb76259
 SHA512:
-  metadata.gz: e01fb9646706fa961e6183bd8ab7bf13a558b9712c6cf2a1bc71fe02869b8f2aaffefff031573c17dcdb4f614afd78b2071d1705cc9039ce63f208f7efa8704f
-  data.tar.gz: 0e0e17a046595b5b0531e8f1f106bdf4f8895dcef75f3c68e49f6773ef100db3a10bcad819424b3f1665e92882447b15d65074496e1df4bc2bf1643741873095
+  metadata.gz: b2e40d1341a003a9755ac895cf0a032b516c30afefa9bf13cc811512188401b32d243022f1a534b2cdb801627b9d366333a1ef95841e9885d548882de1bf8b23
+  data.tar.gz: 1e81f6b5e9e76e58a8e90679816277318deadd39182e117b9231f94eb9a4bae647d58fac9e34ba0b91097bedb2f74aeceaeefef3847ef83f3d9b969544c8f251

data/{LICENSE → LICENSE.txt}

@@ -1,4 +1,4 @@
-The MIT License (MIT)
+MIT License
 
 Copyright (c) 2017-2018 Alexander Grigorev
 
@@ -9,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,27 +1,58 @@
 # Bemer
 
-Build reusable UI components for Rails applications using the [BEM methodology](https://en.bem.info/methodology/).
+**ВАЖНО**. *Для работы с UI компонентами не обязательно использовать методологию БЭМ.*
 
-## Installation
+1. Позволяет создавать переиспользуемые UI компоненты для приложений на Ruby on Rails.
+1. Предоставляет функционал для разработки приложений на Ruby on Rails с использованием методологии БЭМ.
 
-Add this line to your application's Gemfile:
+## Дополнительно
 
-```ruby
-gem 'bemer'
-```
-
-And then execute:
-
-    $ bundle
+1. Статья на Хабре - [Переиспользуемые UI компоненты в приложениях на Ruby on Rails](https://habrahabr.ru/post/352938/).
+1. [bemer-bootstrap](https://github.com/vill/bemer-bootstrap) - переиспользуемые компоненты Bootstrap v3.
+1. [Пример приложения](https://github.com/vill/bemer-example) с использованием `bemer` и [bemer-bootstrap](https://github.com/vill/bemer-bootstrap).
 
-Or install it yourself as:
+## Установка
 
-    $ gem install bemer
+Добавить в `Gemfile`:
 
-## Usage
+```ruby
+gem 'bemer', '~> 0.1.0'
+```
 
-TODO: Write usage instructions here
+Выполнить в терминале команду:
 
-## Contributing
+    $ bundle
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/vill/bemer.
+## Использование
+
+1. [Файловая структура](docs/%D0%A4%D0%B0%D0%B8%CC%86%D0%BB%D0%BE%D0%B2%D0%B0%D1%8F-%D1%81%D1%82%D1%80%D1%83%D0%BA%D1%82%D1%83%D1%80%D0%B0.md)
+1. [Конфигурация](docs/%D0%9A%D0%BE%D0%BD%D1%84%D0%B8%D0%B3%D1%83%D1%80%D0%B0%D1%86%D0%B8%D1%8F.md)
+1. [Создание и использование UI компонент](docs/%D0%A1%D0%BE%D0%B7%D0%B4%D0%B0%D0%BD%D0%B8%D0%B5-%D0%B8-%D0%B8%D1%81%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5-UI-%D0%BA%D0%BE%D0%BC%D0%BF%D0%BE%D0%BD%D0%B5%D0%BD%D1%82.md)
+1. Хелперы для работы с компонентами
+    1. [`define_component`](docs/%D0%A5%D0%B5%D0%BB%D0%BF%D0%B5%D1%80-define_component.md)
+    1. [`define_templates`](docs/%D0%A5%D0%B5%D0%BB%D0%BF%D0%B5%D1%80-define_templates.md)
+    1. [`render_component`](docs/%D0%A5%D0%B5%D0%BB%D0%BF%D0%B5%D1%80-render_component.md)
+    1. [`refine_component`](docs/%D0%A5%D0%B5%D0%BB%D0%BF%D0%B5%D1%80-refine_component.md)
+    1. [`component_pack`](docs/%D0%A5%D0%B5%D0%BB%D0%BF%D0%B5%D1%80-component_pack.md)
+    1. [`component_asset_path`](docs/%D0%A5%D0%B5%D0%BB%D0%BF%D0%B5%D1%80-component_asset_path.md)
+    1. [`component_partial_path`](docs/%D0%A5%D0%B5%D0%BB%D0%BF%D0%B5%D1%80-component_partial_path.md)
+1. Дополнительные хелперы для БЭМ методологии
+    1. [`bem_mix`](docs/%D0%A5%D0%B5%D0%BB%D0%BF%D0%B5%D1%80-bem_mix.md)
+    1. [`bem_mods`](docs/%D0%A5%D0%B5%D0%BB%D0%BF%D0%B5%D1%80-bem_mods.md)
+    1. [`block_tag`](docs/%D0%A5%D0%B5%D0%BB%D0%BF%D0%B5%D1%80-block_tag.md)
+    1. [`elem_tag`](docs/%D0%A5%D0%B5%D0%BB%D0%BF%D0%B5%D1%80-elem_tag.md)
+1. [BEMHTML](docs/BEMHTML.md)
+    1. [Шаблоны](docs/%D0%A8%D0%B0%D0%B1%D0%BB%D0%BE%D0%BD%D1%8B.md)
+    1. [Контекст узла](docs/%D0%9A%D0%BE%D0%BD%D1%82%D0%B5%D0%BA%D1%81%D1%82-%D1%83%D0%B7%D0%BB%D0%B0.md)
+    1. [Предикаты](docs/%D0%9F%D1%80%D0%B5%D0%B4%D0%B8%D0%BA%D0%B0%D1%82%D1%8B.md)
+    1. [Режимы](docs/%D0%A0%D0%B5%D0%B6%D0%B8%D0%BC%D1%8B.md)
+
+## Ссылки
+
+1. https://ru.bem.info/methodology/
+1. https://github.com/bem/bem-xjst
+1. https://github.com/bem-site/bem-forum-content-ru/issues
+
+## Лицензия
+
+Copyright (c) 2017 - 2018 Александр Григорьев. Более подробную информацию о лицензии можно получить в файле [LICENSE.txt](LICENSE.txt).

data/docs/BEMHTML.md

@@ -0,0 +1,5 @@
+# BEMHTML
+
+**ВАЖНО**. *Только для компонент, [структура (дерево) которых была создана](Создание-и-использование-UI-компонент.md) с помощью [хелпера `define_component`](Хелпер-define_component.md) доступно использование [BEMHTML шаблонов](Шаблоны.md).*
+
+Текущая реализация BEMHTML позволяет преобразовывать данные, полученные при использовании хелперов [`block_tag`](Хелпер-block_tag.md), [`elem_tag`](Хелпер-elem_tag.md) и [`define_component`](Хелпер-define_component.md) в выходной HTML код.

data/docs//320/232/320/276/320/275/321/202/320/265/320/272/321/201/321/202-/321/203/320/267/320/273/320/260.md

@@ -0,0 +1,275 @@
+# Контекст узла
+
+**ВАЖНО**. *Методы `apply` и `apply_next` доступны ТОЛЬКО в теле шаблона*.
+
+**ВАЖНО**. *Методы `ctx` и `content` доступны ТОЛЬКО в теле шаблона при режимах `replace` и `content`*.
+
+Контекст текущего узла доступен в предикате и теле шаблона, если они являются `Proc`, `lambda` или `&block`.
+
+## Список основных методов доступных в предикате и теле шаблона
+
+`attrs`, `bem`, `bem_cascade`, `block`, `cls`, `elem`, `first?`, `js`, `last?`, `mix`, `mods`, `name`, `params`, `position`, `tag`.
+
+### Метод `attrs`
+
+Возвращает список атрибутов в виде хеша (`Hash`) ключи которого ВСЕГДА имеют тип `Symbol`.
+
+Добавить `key: :value` к изначальным атрибутам блока с названием `alert`:
+```slim
+/ Эквивалентные записи
+= render_component :alert do |template|
+  = template.block(:alert).attrs ->(node) { { **node.attrs, key: :value } }
+
+= render_component :alert do |template|
+  = template.block(:alert).attrs ->(node) { node.attrs.merge!(key: :value) }
+```
+Добавить css класс `css-class` если текущая сущность является блоком с названием `alert` и имеет атрибут с названием `:role`:
+```slim
+= render_component :alert do |template|
+  = template.block(:alert, ->(node) { node.attrs.key?(:role) }).add_cls :css_class
+```
+### Метод `bem`
+
+Возвращает значение параметра `bem`. Если параметр не был передан, тогда возвращаемое значение будет `nil`.
+
+### Метод `bem_cascade`
+
+Возвращает значение параметра `bem_cascade`. Если параметр не был передан, тогда возвращаемое значение будет `nil`.
+
+### Метод `block`
+
+Возвращает значение параметра `block`. Если параметр не был передан, тогда возвращаемое значение будет пустая строка `''`.
+
+### Метод `cls`
+
+Возвращает нормализованный список css классов ввиде массива (`Array`) строк (`String`).
+
+В шаблоне и предикате метод `cls` вернет: `['css-class1', 'css-class2']`:
+```slim
+/ Содержимое файла index.html.slim компонента simple_component
+= define_component do |component|
+  = component.block :block1, cls: 'css-class1 css-class2'
+```
+Добавить css класс `css-class` если текущая сущность является блоком с названием `block1` и имеет css класс `css-class1`:
+```slim
+= render_component :simple_component do |template|
+  = template.block(:block1, ->(node) { node.cls.include?('css-class1') }).add_cls :css_class
+```
+Добавить css класс `css-class` к изначальным css классам блока с названием `block1`:
+```slim
+/ Эквивалентные записи
+= render_component :simple_component do |template|
+  = template.block(:block1).cls ->(node) { [node.cls, :css_class] }
+
+= render_component :simple_component do |template|
+  = template.block(:block1).cls ->(node) { node.cls << :css_class }
+```
+
+### Метод `elem`
+
+Возвращает значение параметра `elem`, если сущность является блоком, тогда значение будет `nil`, если сущность является элементом и параметр не был передан, тогда возвращаемое значение будет пустая строка `''`.
+
+### Метод `first?`
+
+Возвращает `true` если текущий узел среди своих братьев/сестер (siblings) занимает первую позицию, если это не так, возвращает `false`.
+
+```slim
+= render_component :menu do |template|
+  = template.elem(:item, ->(node) { node.first? }).add_cls :first
+```
+
+### Метод `js`
+
+Возвращает значение параметра `js`.
+
+### Метод `last?`
+
+Возвращает `true` если текущий узел среди своих братьев/сестер (siblings) занимает последнюю позицию, если это не так, возвращает `false`.
+
+```slim
+= render_component :menu do |template|
+  = template.elem(:item, ->(node) { node.last? }).add_cls :last
+```
+
+### Метод `mix`
+
+Возвращает нормализованный список миксов ввиде массива (`Array`) строк (`String`).
+
+В шаблоне и предикате метод `mix` вернет `['block', 'block2__elem1', 'block2__elem2']`:
+```slim
+/ Содержимое файла index.html.slim компонента simple_component
+= define_component do |component|
+  = component.block :block1, mix: [:block, block2: [:elem1, :elem2]]
+```
+
+### Метод `mods`
+
+Возвращает нормализованный список модификаторов в виде хеша ([`ActiveSupport::HashWithIndifferentAccess`](http://api.rubyonrails.org/v5.0/classes/ActiveSupport/HashWithIndifferentAccess.html)) со строковыми `String` и `true` значениями.
+
+В шаблоне и предикате метод `mods` вернет `{'enabled' => true, 'theme' => 'green-islands'}`:
+```slim
+/ Содержимое файла index.html.slim компонента simple_component
+= define_component do |component|
+  = component.block :block1, mods: [:enabled, theme: :green_islands]]
+```
+HTML тег изменить на `span` если текущая сущность является блоком с названием `block1` и имеет модификатор с названием `theme` и любым значением этого модификатора:
+```slim
+= render_component :simple_component do |template|
+  = template.block(:block1, ->(node) { node.mods.key?(:theme) }).tag :span
+```
+HTML тег изменить на `small` если текущая сущность является блоком с названием `block1` и имеет модификатор с названием `theme` и значением `green-islands` этого модификатора:
+```slim
+= render_component :simple_component do |template|
+  = template.block(:block1, mods: { theme: :green_islands }).tag :small
+```
+
+### Метод `name`
+
+**ВАЖНО**. *При формирование названия сущности, действуют [правила преобразования знаков нижнего подчеркивания `_` в тире `-` для `Symbol` и `String`](%D0%A5%D0%B5%D0%BB%D0%BF%D0%B5%D1%80-block_tag.md#%D0%9D%D0%B0%D0%B7%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5-%D1%81%D1%83%D1%89%D0%BD%D0%BE%D1%81%D1%82%D0%B8)*
+
+Возвращает название сущности.
+
+Для блока без названия метод `name` вернет пустую строку `''`:
+```slim
+/ Содержимое файла index.html.slim компонента simple_component
+= define_component do |component|
+  = component.block
+```
+Для элемента без названия метод `name` вернет указанный в [конфиге разделитель между блоком и элементом `'__'`](%D0%9A%D0%BE%D0%BD%D1%84%D0%B8%D0%B3%D1%83%D1%80%D0%B0%D1%86%D0%B8%D1%8F.md#%D0%9F%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80-element_name_separator):
+```slim
+/ Содержимое файла index.html.slim компонента simple_component
+= define_component do |component|
+  = component.elem
+```
+
+Для элемента без указания блока метод `name` вернет `'__elem-name'`:
+```slim
+/ Содержимое файла index.html.slim компонента simple_component
+= define_component do |component|
+  = component.elem '', :elem_name
+```
+Для элемента с указанием только блока метод `name` вернет `'block-name__'`:
+```slim
+/ Содержимое файла index.html.slim компонента simple_component
+= define_component do |component|
+  = component.elem :block_name
+```
+
+### Метод `params`
+
+Хеш (`Hash`) содержит данные которые были переданы при вызове методов `ctx`, `content`, `apply` и `apply_next`.
+
+### Метод `position`
+
+Возвращает порядковый номер узла, который он занимает среди своих братьев/сестер (siblings), нумерация начинается с 1.
+
+### Метод `tag`
+
+Возвращает нормализованное значение параметра `tag` как `Symbol` (все значения с типом `Symbol` возвращаются как есть а не пустые строки `String` преобразуются с помощью `to_sym`), `''` (для `false` и пустой строки `''`) или `nil`.
+
+## Список дополнительных методов доступных в теле шаблона
+
+`apply`, `apply_next`, `ctx`, `content`.
+
+### Метод `apply(mode, **params)`
+
+**ВАЖНО**. *Методы `apply` и `apply_next` доступны ТОЛЬКО в теле шаблона*.
+
+Позволяет вызвать любой основной режим (`Symbol`) в контексте текущего узла, дополнительно можно передать параметры которые будут доступны в `params`.
+
+```slim
+/ Содержимое файла index.bemhtml.slim компонента alert
+= define_templates do |template|
+  = template.block(:alert).add_cls ->(node) { "alert-#{node.params.fetch(:type, :info)}" }
+```
+Вызов компонента `alert` с указанием значения `type` в `params`:
+```slim
+= render_component :alert do |template|
+  = template.block(:alert).cls ->(node) { node.apply(:cls, type: :success) }
+```
+
+### Метод `apply_next(**params)`
+
+**ВАЖНО**. *Методы `apply` и `apply_next` доступны ТОЛЬКО в теле шаблона*.
+
+Позволяет вызвать следующий по очередности шаблон для текущего режима, дополнительно можно передать параметры которые будут доступны в `params`.
+
+```slim
+/ Содержимое файла index.bemhtml.slim компонента alert
+= define_templates do |template|
+  = template.block(:alert).add_cls ->(node) { "alert-#{node.params.fetch(:type, :info)}" }
+```
+Вызов компонента `alert` с указанием значения `type` в `params`:
+```slim
+= render_component :alert do |template|
+  = template.block(:alert) do |alert|
+    = alert.cls ->(node) { node.apply(:cls, type: node.params.fetch(:type, :success)) }
+    = alert.cls ->(node) { node.apply_next(type: :danger) }
+```
+
+### Метод `ctx(**params)`
+
+**ВАЖНО**. *Методы `ctx` и `content` доступны ТОЛЬКО в теле шаблона при режимах `replace` и `content`*.
+
+Ссылка на текущий узел, дополнительно можно передать параметры которые будут доступны в `params` у самого узла и всех его дочерних узлов.
+
+Заменить блок `alert` на самого себя:
+
+```slim
+/ Эквивалентный результат
+= render_component :alert do |template|
+  = template.block(:alert).replace do |node|
+    = node.ctx
+
+= render_component :alert
+```
+
+Обернуть блок `alert` в дополнительный блок и элемент:
+
+```slim
+= render_component :alert do |template|
+  = template.block(:alert).replace do |node, builder|
+    = builder.block :top_block do |top_block|
+      = top_block.elem :elem_name
+        = node.ctx
+```
+
+### Метод `content(**params)`
+
+**ВАЖНО**. *Методы `ctx` и `content` доступны ТОЛЬКО в теле шаблона при режимах `replace` и `content`*.
+
+Ссылка на содержимое текущего узла, дополнительно можно передать параметры которые будут доступны в `params` у всех дочерних узлов.
+
+Заменить содержимое блока `alert` на само себя:
+
+```slim
+/ Эквивалентный результат
+= render_component :alert do |template|
+  = template.block(:alert).content do |node|
+    = node.content
+
+= render_component :alert
+```
+
+Обернуть содержимое блока `alert` в дополнительный блок и элемент:
+
+```slim
+= render_component :alert do |template|
+  = template.block(:alert).content do |node, builder|
+    = builder.block :top_block do |top_block|
+      = top_block.elem :elem_name
+        = node.content
+```
+
+Заменить блок `alert` его содержимым:
+
+```slim
+/ Эквивалентный результат
+= render_component :alert do |template|
+  = template.block(:alert).replace do |node|
+    = node.content
+
+/ Будет быстрее
+= render_component :alert do |template|
+  = template.block(:alert).tag false
+```

data/docs//320/232/320/276/320/275/321/204/320/270/320/263/321/203/321/200/320/260/321/206/320/270/321/217.md

@@ -0,0 +1,158 @@
+# Конфигурация
+
+Для изменения настроек, необходимо создать файл `config/initializers/bemer.rb` и переопределить параметры по умолчанию:
+
+```ruby
+# Параметры по умолчанию
+Bemer.setup do |config|
+  config.bem                      = false
+  config.default_block_tag        = :div
+  config.default_element_tag      = :div
+  config.default_path_prefix      = nil
+  config.element_name_separator   = '__'
+  config.modifier_name_separator  = '_'
+  config.modifier_value_separator = '_'
+  config.path                     = 'app/bemer_components'
+  config.prepend_asset_paths      = true
+end
+```
+
+## Параметр `bem`
+
+Глобально включает или выключает генерацию данных связанных с БЭМ методологией, используется только в [хелпере `define_component`](Хелпер-define_component.md). Порядок применения параметра `bem`:
+```slim
+/ config.bem = false
+
+= define_component do |component|
+  = component.block :block
+
+/ => <div></div>
+```
+```slim
+/ config.bem = true
+
+= define_component do |component|
+  = component.block :block
+
+/ => <div class="block"></div>
+```
+```slim
+/ config.bem = false                        # Самый низкий приоритет
+
+= define_component bem: true do |component| # `config.bem` переопределен
+  = component.block :block
+
+/ => <div class="block"></div>
+```
+```slim
+/ config.bem = true                          # Самый низкий приоритет
+
+= define_component bem: false do |component| # `config.bem` переопределен
+  = component.block :block
+
+/ => <div></div>
+```
+```slim
+/ config.bem = false                         # Самый низкий приоритет
+
+= define_component bem: false do |component| # Следующий приоритет после `config.bem`
+  = component.block :block, bem: true        # Самый высокий приоритет
+
+/ => <div class="block"></div>
+```
+```slim
+/ config.bem = true                         # Самый низкий приоритет
+
+= define_component bem: true do |component| # Следующий приоритет после `config.bem`
+  = component.block :block, bem: false      # Самый высокий приоритет
+
+/ => <div></div>
+```
+
+## Параметр `default_block_tag`
+
+Устанавливает тег по умолчанию для сущностей типа блок, используется когда у сущности не указан (равен `nil`) HTML тег:
+
+```ruby
+config.default_block_tag = :span
+```
+
+## Параметр `default_element_tag`
+
+Устанавливает тег по умолчанию для сущностей типа элемент, используется когда у сущности не указан (равен `nil`) HTML тег:
+
+```ruby
+config.default_element_tag = :span
+```
+
+## Параметр `default_path_prefix`
+
+Добавляет префикс к пути/названию всех компонент, может быть `Symbol`, `String`, `false`, `nil` а также `Proc` и `lambda` которые должны возвращать `Symbol`, `String`, `false` или `nil`:
+
+```ruby
+# Эквивалентные записи
+config.default_path_prefix = 'common'
+config.default_path_prefix = :common
+config.default_path_prefix = proc { :common }
+config.default_path_prefix = ->(path, view) { :common }
+```
+Если `default_path_prefix` является `Proc` или `lambda` тогда, при вызове будут переданы указанный путь/название компонента (как `String`) и представление (экземпляр Action View):
+```ruby
+config.default_path_prefix = proc { |path| path.start_with?('admin') ? '' : :user }
+```
+```ruby
+config.default_path_prefix = lambda { |path, view|
+  view.controller.instance_of?(Admin::ApplicationController) ? :admin : :user
+}
+```
+```ruby
+config.default_path_prefix = lambda { |path, view|
+  view.controller.class.name.deconstantize.underscore
+}
+```
+При вызове `render_component`, `refine_component` параметр `default_path_prefix` будет использоваться:
+```ruby
+# Эквивалентные записи
+render_component(:modal)
+refine_component(:modal, prefix: true)
+```
+параметр `default_path_prefix` не будет использоваться и путь/название компонента будет иметь следующие значения:
+```ruby
+# Эквивалентные записи
+render_component(:modal, prefix: '')    # => 'modal'
+refine_component(:modal, prefix: false) # => 'modal'
+refine_component(:modal, prefix: nil)   # => 'modal'
+```
+```ruby
+# Эквивалентные записи
+render_component(:modal, prefix: :common)       # => 'common/modal'
+render_component(:modal, prefix: 'common')      # => 'common/modal'
+refine_component('common/modal', prefix: false) # => 'common/modal'
+```
+
+## Параметр `element_name_separator`
+
+Устанавливает разделитель [между названием блока и названием элемента](https://ru.bem.info/methodology/naming-convention/).
+
+## Параметр `modifier_name_separator`
+
+Устанавливает разделитель [между названием модификатора и названием блока или элемента](https://ru.bem.info/methodology/naming-convention/):
+```ruby
+config.modifier_name_separator = '--' # block__elem--modifier-name
+```
+
+## Параметр `modifier_value_separator`
+
+Устанавливает разделитель [между названием модификатора и значением модификатора](https://ru.bem.info/methodology/naming-convention/).
+
+## Параметр `path`
+
+Устанавливает каталог в котором будут храниться все компоненты приложения, например если используется [Webpacker](https://github.com/rails/webpacker), тогда можно указать подкаталог в его каталоге:
+
+```ruby
+config.path = Webpacker.config.source_path.join('components')
+```
+
+## Параметр `prepend_asset_paths`
+
+Разрешает или запрещает добавлять пути до каталогов с компонентами в начало списка `assets.paths`, актуально только если приложение использует Sprockets.