yml_builder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b10e44faa9d509c11bbe34e4e0add97bb5956f15
+  data.tar.gz: 9e7634b0d218b487480bb242a404e9705d5a7991
+SHA512:
+  metadata.gz: 14847041d19be93067fb9f0c2ca4cab96030115071191841b55bfcd0fbe0057c90b598140be1db47fad77018bb5551568271881b182f1a276559425d2b217f8f
+  data.tar.gz: 1239542340171ddf325f154722a8678787e06d50e19731c699c656ad4180c200522545b05d23043599b37424a32d7ae0e7c817a73624f78d7979378848a7e7df

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0 (2015-05-11)
+
+* Начальная версия

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Stan Zhuravlev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+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 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.

data/README.md

@@ -0,0 +1,300 @@
+# YmlBuilder
+
+Библиотека YmlBuilder предназначена для формирования прайс-листов в формате Яндекс.Маркет. Библиотека обеспечивает формирвоание
+прайс-листов с учетом правил Yandex (названия секций, ключей, порядок следования ключей и пр.), а также валидацию
+большинства ошибок, связанных с генерацией прайс-листов.
+
+## Установка
+
+Добавить в Gemfile:
+
+```ruby
+gem 'yml_builder'
+```
+
+Установить гем cредствами Bundler:
+
+    $ bundle
+
+Или установить его отдельно:
+
+    $ gem install yml_builder
+
+# Зависимости
+
+Для работы гема требуется Ruby не младше версии 2.2.1. Также для работы необходим гем StTools (https://github.com/StanZhuravlev/st_tools).
+
+## Использование
+
+Библиотека работает с кодировкой UTF-8, однако формирование прайс-листа осуществляется в соответствии с рекомендациями,
+в кодировке windows-1251. Все работа строится на базе двух основных классов - YmlBuilder::Yml и YmlBuilder::Offer.
+Остальные классы являются вспомогательными, и в пользовательских приложениях использоваться не должны. Использование
+классов продемонстрировано ниже на базе примеров. Все примеры можно найти в папке /test
+
+В соответствии со спецификацией Yandex.Market, все значения в прайс-листе делятся на две группы: обязательные и опциональные.
+Если при формировании прайс-листа не заданы какие-либо обязательные параметры, то будет вызвано исключение с детальным
+описанием причин.
+
+_Ограничения библиотеки: поскольку она писалась под конкретный проект, в ней реализован только один тип товара - упрощенный.
+В библиотеке заложены возможности расширения под дугие типы, но такое расширение будет создаваться только по необходимости.
+Пишите, если требуется подержка других карточек, сделаю_
+
+### Пример 1 - Создание прайс-листа и настройка магазина
+
+Первым шагом необходимо создать прайс-лист, и настроить параметры Интернет-магазина.
+
+```ruby
+price = YmlBuilder::Yml.new
+price.shop.name = 'Магазин ТЕСТ'
+price.shop.company = "ООО 'Рога & Копыта'"
+price.shop.url = 'http://example-site.ru'
+price.shop.phone = '+7 (123) 456-7890'
+price.shop.platform = 'OpenCart'
+price.shop.version = '2.0'
+puts price.to_yml
+```
+
+Результатом данного кода будет являться сгенерированная XML-сруктура следующего вида.
+
+```xml
+<?xml version="1.0" encoding="windows-1251"?>
+<!DOCTYPE yml_catalog SYSTEM "shops.dtd">
+<yml_catalog date="2015-05-11 14:07">
+  <shop>
+    <name>Магазин ТЕСТ</name>
+    <company>ООО &apos;Рога &amp; Копыта&apos;</company>
+    <url>http://example-site.ru</url>
+    <phone>+7 (123) 456-7890</phone>
+    <platform>OpenCart</platform>
+    <version>2.0</version>
+    <currencies>
+    </currencies>
+    <categories>
+    </categories>
+    <offers>
+    </offers>
+  </shop>
+</yml_catalog>
+```
+
+Также будет сгенерировано два предупреждения
+
+```txt
+Предупреждение: не указано ни одной валюты в секции 'currencies'
+Предупреждение: не указано ни одной категории в секции 'categories'
+```
+
+### Пример 2 - Добавление валют и категорий
+
+На втором шаге, осуществляется добавление необходимых валют из числа поддерживаемых Яндекс.Маркет, а также категорий
+в которых будут размещены товары.
+
+```ruby
+price = YmlBuilder::Yml.new
+price.shop.name = 'Магазин ТЕСТ'
+price.shop.company = "ООО 'Рога & Копыта'"
+price.shop.url = 'http://example-site.ru'
+price.shop.phone = '+7 (123) 456-7890'
+price.shop.platform = 'OpenCart'
+price.shop.version = '2.0'
+
+price.currencies.rub = 1
+price.currencies.usd = 55.04
+price.currencies.eur = :cbrf
+
+price.categories.add(id: 1, name: "Игрушки")
+price.categories.add(id: 2, name: "Одежда")
+price.categories.add(id: 4, name: "Игрушки для девочек", parent_id: 1)
+price.categories.add(id: 5, name: "Игрушки для мальчиков", parent_id: 1)
+price.categories.add(id: 3, name: "Книги")
+
+puts price.to_yml
+```
+
+Результатом данного кода будет являться сгенерированная XML-сруктура следующего вида.
+
+```xml
+<?xml version="1.0" encoding="windows-1251"?>
+<!DOCTYPE yml_catalog SYSTEM "shops.dtd">
+<yml_catalog date="2015-05-11 14:28">
+  <shop>
+    <name>Магазин ТЕСТ</name>
+    <company>ООО &apos;Рога &amp; Копыта&apos;</company>
+    <url>http://example-site.ru</url>
+    <phone>+7 (123) 456-7890</phone>
+    <platform>OpenCart</platform>
+    <version>2.0</version>
+    <currencies>
+      <currency id="RUB" rate="1"/>
+      <currency id="USD" rate="55.04"/>
+      <currency id="EUR" rate="CBRF"/>
+    </currencies>
+    <categories>
+      <category id="1">Игрушки</category>
+      <category id="2">Одежда</category>
+      <category id="3">Книги</category>
+      <category id="4" parentId="1">Игрушки для девочек</category>
+      <category id="5" parentId="1">Игрушки для мальчиков</category>
+    </categories>
+    <offers>
+    </offers>
+  </shop>
+</yml_catalog>
+```
+
+### Пример 3 - Добавление товаров
+
+Затем необходимо сформировать информацию о оферах, и добавить их в список товаров (offers). Офферы создаются через вызов
+отдельного класса - YmlBuilder.Offer. На самом деле, это "рамочный" класс, который на самом деле вернет экземпляры
+классов, соответствующих типам товаров Yandex.Market. Напрмиер, ```ruby YmlBuilder::Offer.new('simple')``` создает
+описание урощенной карточки товара. Если вместо simple указать любой другой тип, то в данной версии библиотеки
+будет вызвано исключение.
+
+Кроме того, через вызов ```ruby offer.add_picture``` добавляются ссылки на картинки, описывающие товар. Каждый вызов метода
+добавляет ссылку на фотографю товара в конце списка picture. При этом контролируется, чтобы размер списка изображений
+не превышал 10. При превышении массив фотографий всегда обрезается до 10. Чтобы добавить основную фотографию товара
+необходимо вызвать метод ```ruby offer.add_cover_picture```. Данный метод просто добавляет картинку в начало списка
+фотографий. Если вызвать данный метод два раза, то список фотографий будет выглядеть как две основные фотографии.
+
+Через вызов ```ruby offer.add_param``` добавляются различные вспомогательные параметры - вес, продолжительность записи,
+размеры одежды и прочая информация.
+
+```ruby
+item = YmlBuilder::Offer.new('simple')
+item.id = 6
+item.available = true
+item.currency_id = 'RUR'
+item.delivery = true
+item.category_id = 1
+item.name = 'Товар №6'
+item.url = 'http://example-site.ru/items/6'
+item.price = 300.90
+item.add_picture('http://example-site.ru/image1')
+item.add_picture('http://example-site.ru/image2')
+item.add_cover_picture('http://example-site.ru/image_cover')
+item.add_param(name: 'Обложка', value: 'Мягкая')
+item.add_param(name: 'Страниц', value: 10, unit: 'шт.')
+
+price.offers.add(item)
+
+item = YmlBuilder::Offer.new('simple')
+item.id = 3
+item.available = false
+item.currency_id = 'RUR'
+item.delivery = true
+item.category_id = 2
+item.name = 'Товар №3'
+item.url = 'http://example-site.ru/items/3'
+item.price = 100
+item.add_picture('http://example-site.ru/image1')
+item.add_picture('http://example-site.ru/image2')
+item.add_cover_picture('http://example-site.ru/image_cover')
+item.add_param(name: 'Обложка', value: 'Мягкая')
+item.add_param(name: 'Страниц', value: 10, unit: 'шт.')
+
+price.offers.add(item)
+```
+
+Результатом данного кода будет являться сгенерированная XML-сруктура следующего вида.
+
+```xml
+<?xml version="1.0" encoding="windows-1251"?>
+<!DOCTYPE yml_catalog SYSTEM "shops.dtd">
+<yml_catalog date="2015-05-11 14:40">
+  <shop>
+    <name>Магазин ТЕСТ</name>
+    <company>ООО &apos;Рога &amp; Копыта&apos;</company>
+    <url>http://example-site.ru</url>
+    <phone>+7 (123) 456-7890</phone>
+    <platform>OpenCart</platform>
+    <version>2.0</version>
+    <currencies>
+      <currency id="RUB" rate="1"/>
+      <currency id="USD" rate="55.04"/>
+      <currency id="EUR" rate="CBRF"/>
+    </currencies>
+    <categories>
+      <category id="1">Игрушки</category>
+      <category id="2">Одежда</category>
+      <category id="3">Книги</category>
+      <category id="4" parentId="1">Игрушки для девочек</category>
+      <category id="5" parentId="1">Игрушки для мальчиков</category>
+    </categories>
+    <offers>
+      <offer id="3" available="false">
+        <url>http://nosite/items/3</url>
+        <price>100</price>
+        <currencyId>RUR</currencyId>
+        <categoryId>2</categoryId>
+        <picture>http://example-site.ru/image_cover</picture>
+        <picture>http://example-site.ru/image1</picture>
+        <picture>http://example-site.ru/image2</picture>
+        <delivery>true</delivery>
+        <name>Товар №3</name>
+        <param name="Обложка">Мягкая</param>
+        <param name="Страниц" unit="шт.">10</param>
+      </offer>
+      <offer id="6" available="true">
+        <url>http://nosite/items/6</url>
+        <price>300.9</price>
+        <currencyId>RUR</currencyId>
+        <categoryId>1</categoryId>
+        <picture>http://example-site.ru/image_cover</picture>
+        <picture>http://example-site.ru/image1</picture>
+        <picture>http://example-site.ru/image2</picture>
+        <delivery>true</delivery>
+        <name>Товар №6</name>
+        <param name="Обложка">Мягкая</param>
+        <param name="Страниц" unit="шт.">10</param>
+      </offer>
+    </offers>
+  </shop>
+</yml_catalog>
+```
+
+### Дополнительные возможности
+
+В ряде случаев (размещение в тематических прайс-агрегаторах, ограничение показа товаров в Яндекс.Маркет) необходимо
+генерировать различные прайс-листы. При использовании бибилиотеки YmlBuild это можно сделать через указание допустимых
+категорий в методе filter. Вызов данного метода должен быть осуществлен до добавления первой категории или товара.
+
+```ruby
+price.categories.filter = [1, 10, 12, 20]
+```
+
+Для указания в соответствии с требованиями Yandex цены доставки в место локации магазина, необходимо использовать
+метод local_delivery_cost.
+
+```ruby
+price.local_delivery_cost = 300
+```
+
+Метод to_yml формирует выходную строку в формате utf-8. Для записи прайс-листа рекомендуется использовать метод save,
+передава ему имя файла для записи.
+
+```ruby
+price.save('price.xml')
+```
+
+Узнать статистику по экпорту прайс-листа (общее число товаров, число товаров в наличии, общая стоимость товаров в
+наличии (без учета количества)) можно через вызов метода ```ruby price.stats```. Результатом работы метода является
+структура следующего вида
+
+```ruby
+{
+  :categories => 5,
+  :total => 2,
+  :available => 1,
+  :price => 300.9
+}
+```
+
+
+
+## Contributing
+
+1. Fork it ( https://github.com/StanZhuravlev/yml_builder/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "yml_builder"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/yml_builder/categories.rb

@@ -0,0 +1,72 @@
+module YmlBuilder
+  class Categories
+    # Переменная содержит список id категорий, для которых необходимо формировать прайс-лист.
+    # Если переменная пуста, то включаются все категории
+    attr_reader :filter
+
+    def initialize(stats)
+      @stats = stats
+      init_class
+    end
+
+    def add(opts = {})
+      return false unless can_add?(opts[:id])
+      allow = [:id, :parent_id, :name]
+      raise "Ошибка: для добавления категории используйте ключи #{allow.inspect}" if (opts.keys - allow).count > 0
+      raise "Ошибка: не указан 'id' для добавления категории" if opts[:id].nil?
+      raise "Ошибка: не указан 'name' для добавления категории" if opts[:name].nil?
+      @params[opts[:id]] = { parent_id: opts[:parent_id], name: opts[:name] }
+      @params = Hash[ @params.sort_by { |id, data| id } ]
+      @stats.add(:categories, 1)
+      true
+    end
+
+    # Метод проверяет необходимость добавления категории или товара в прайс-лист
+    # с учетом выставленных в значении filter настроек.
+    #
+    # @param [Object] id идентифкатор категории товара
+    # @return [Boolean] true, если данный id категории указан в filter как допустимый для включения в прайс-лист
+    def can_add?(id)
+      @filter.count == 0 ? true : @filter.include?(id)
+    end
+
+    # Метод позволяет огарничить формирование прайс-листа только категориями, указанными в данном поле
+    # Filter может принимать значения nil или [], тогда считается, что допустимо включение в прайс-лист
+    # всех товаров.
+    # @param [Array] allow массив id категорий, который должны попадать в результирующий прайс-лист
+    def filter=(allow)
+      @filter = allow || Array.new
+    end
+
+    # Метод формирует фрагмент YML файла каталога Яндекс.Маркет, содержащий список категорий
+    #
+    # @param [Integer] ident отступ от левого края в символах
+    # @return [String] фрагмент YML файла каталога Яндекс.Маркет, содержащий список категорий
+    def to_yml(ident = 4)
+      out = Array.new
+      out << '<categories>'
+
+      @params.each do |id, value|
+        if value[:parent_id].nil?
+          out << "  <category id=#{id.to_s.inspect}>#{::YmlBuilder::Common.encode_special_chars(value[:name])}</category>"
+        else
+          out << "  <category id=#{id.to_s.inspect} parentId=#{value[:parent_id].to_s.inspect}>#{::YmlBuilder::Common.encode_special_chars(value[:name])}</category>"
+        end
+      end
+      warn "Предупреждение: не указано ни одной категории в секции 'categories'" if out.count == 1
+
+      out << '</categories>'
+
+      out.map! { |line| line = ' '.rjust(ident, ' ') + line }
+      out.join("\n")
+    end
+
+    private
+
+    def init_class
+      @params = Hash.new
+      self.filter = nil
+    end
+
+  end
+end

data/lib/yml_builder/common.rb

@@ -0,0 +1,19 @@
+module YmlBuilder
+  class Common
+
+    def self.encode_special_chars(out)
+      return out.to_s.gsub(/[\"\&\>\<\']/, '"' => '&quot;',
+                                           '&' => '&amp;',
+                                           '>' => '&gt;',
+                                           '<' => '&lt;',
+                                           "'" => '&apos;')
+    end
+
+    def self.convert_key(key)
+      return 'currencyId' if key == :currency_id
+      return 'categoryId' if key == :category_id
+      key.to_s
+    end
+
+  end
+end

data/lib/yml_builder/common_offer.rb

@@ -0,0 +1,135 @@
+module YmlBuilder
+  class CommonOffer
+    attr_accessor :id
+    attr_accessor :type
+    attr_accessor :available
+    attr_accessor :bid
+
+    attr_accessor :mandatories
+
+    def initialize
+      init_class
+    end
+
+    def init_class
+      @params = Hash.new
+      @meta = Hash.new
+      @picture = Array.new
+
+      @id = 0
+      @type = 'unknown'
+      @available = false
+      @bid = nil
+
+      @mandatories = Array.new
+    end
+
+    def add_picture(url)
+      @picture << url
+      @picture.uniq!
+      warn "Предупреждение: число картинок превышает 10 (offer_id=#{@id}). Сокращаем до 10" if @picture.count > 10
+      @picture = @picture[0,9]
+    end
+
+    def add_cover_picture(url)
+      @picture.unshift(url)
+      @picture.uniq!
+      warn "Предупреждение: число картинок превышает 10 (offer_id=#{@id}). Сокращаем до 10" if @picture.count > 10
+      @picture = @picture[0,9]
+    end
+
+    def add_param(name:, unit: nil, value:)
+      @meta[name] = { unit: unit, value: value}
+    end
+
+    def method_missing(method_sym, *arguments, &block)
+      if @params.include?(method_sym.to_s.gsub(/=$/, '').to_sym)
+        processing_method(method_sym, arguments.first)
+      else
+        super
+      end
+    end
+
+    def processing_method(method_sym, value)
+      if method_sym.to_s.match(/=$/)
+        key = method_sym.to_s.gsub(/=$/, '')
+        warn "Предупреждение: url не должен превышать 512 символов" if key == 'url' && value.length > 512
+        warn "Предупреждение: price не может быть равен нулю" if key == 'price' && value.to_f == 0
+        warn "Предупреждение: weight не может быть равен нулю" if key == 'weight' && value.to_f == 0
+        @params[key.to_sym] = value
+      else
+        @params[method_sym.to_s.gsub(/=$/, '').to_sym]
+      end
+    end
+
+    def header_line
+      out = Array.new
+      out << "id=#{@id.to_s.inspect}"
+      out << "type=#{@type.to_s.inspect}" if @type != 'simple'
+      out << "available=\"#{@available.inspect}\""
+      out << "bid=#{@bid.inspect}" unless @bid.nil?
+      "<offer #{out.join (' ')}>"
+    end
+
+    def footer_line
+      '</offer>'
+    end
+
+    def param_line(name, data)
+      if data[:unit].nil?
+        "<param name=#{::YmlBuilder::Common.encode_special_chars(name.to_s).inspect}>#{::YmlBuilder::Common.encode_special_chars(data[:value].to_s)}</param>"
+      else
+        "<param name=#{::YmlBuilder::Common.encode_special_chars(name.to_s).inspect} unit=#{::YmlBuilder::Common.encode_special_chars(data[:unit]).inspect}>#{::YmlBuilder::Common.encode_special_chars(data[:value].to_s)}</param>"
+      end
+    end
+
+    def to_yml_subsections(key)
+      out = Array.new
+
+      if key == :picture
+        @picture.each do |url|
+          out << "  <picture>#{url}</picture>"
+        end
+      else
+        @meta.each do |name, data|
+          out << "  #{param_line(name, data)}"
+        end
+      end
+
+      out
+    end
+
+    def to_yml_mandatories(key, value)
+      raise "Ошибка секции 'offer': не заполнено обязательное значение #{key.to_s.inspect}" if (value.nil? || value.to_s == '')
+      key_xml = ::YmlBuilder::Common.convert_key(key)
+      "  <#{key_xml}>#{::YmlBuilder::Common.encode_special_chars(value)}</#{key_xml}>"
+    end
+
+    def to_yml_optional(key, value)
+      return nil if value.nil?
+      key_xml = ::YmlBuilder::Common.convert_key(key)
+      "  <#{key_xml}>#{::YmlBuilder::Common.encode_special_chars(value)}</#{key_xml}>"
+    end
+
+    def to_yml(ident = 4)
+      out = Array.new
+      out << header_line
+
+      @params.each do |key, value|
+        if [:picture, :param].include?(key)
+          out += to_yml_subsections(key)
+        elsif @mandatories.include?(key)
+          out << to_yml_mandatories(key, value)
+        else
+          out << to_yml_optional(key, value)
+        end
+      end
+      out.compact!
+
+      out << footer_line
+      out.map! { |line| ' '.rjust(ident, ' ') + line }
+      out.join("\n")
+    end
+
+  end
+end

data/lib/yml_builder/currencies.rb

@@ -0,0 +1,63 @@
+module YmlBuilder
+  class Currencies
+
+    def initialize
+      init_class
+    end
+
+    def init_class
+      @params = Hash.new
+
+      @params[:rur] = nil
+      @params[:rub] = nil
+      @params[:usd] = nil
+      @params[:eur] = nil
+      @params[:uah] = nil
+      @params[:kzt] = nil
+    end
+
+    def method_missing(method_sym, *arguments, &block)
+      if @params.include?(method_sym.to_s.gsub(/=$/, '').to_sym)
+        processing_method(method_sym, arguments.first)
+      else
+        super
+      end
+    end
+
+    def valid?(method_sym, allow, value)
+      return true if value.to_s.match(/^\s*[+-]?((\d+_?)*\d+(\.(\d+_?)*\d+)?|\.(\d+_?)*\d+)(\s*|([eE][+-]?(\d+_?)*\d+)\s*)$/)
+      return true if allow.include?(value)
+      warn "Предупреждение: значение валюты #{method_sym.to_s.upcase} может быть цифрой или значением из #{allow.inspect}"
+      false
+    end
+
+    def processing_method(method_sym, value)
+      if method_sym.to_s.match(/=$/)
+        key = method_sym.to_s.gsub(/=$/, '')
+        allow = [:cbrf, :nbu, :nbk, :cb]
+        valid?(key.to_s, allow, value)
+
+        @params[key.to_sym] = value
+      else
+        @params[method_sym.to_s.gsub(/=$/, '').to_sym]
+      end
+    end
+
+    def to_yml(ident = 4)
+      out = Array.new
+      out << '<currencies>'
+
+      @params.each do |key, value|
+        out << "  <currency id=#{key.to_s.upcase.inspect} rate=#{value.to_s.upcase.inspect}/>" unless value.nil?
+      end
+      warn "Предупреждение: не указано ни одной валюты в секции 'currencies'" if out.count == 1
+
+      out << '</currencies>'
+
+      out.map! { |line| line = ' '.rjust(ident, ' ') + line }
+
+      out.join("\n")
+    end
+
+  end
+end

data/lib/yml_builder/offer.rb

@@ -0,0 +1,14 @@
+module YmlBuilder
+  class Offer
+
+    def self.new(type)
+      case type.downcase
+        when 'simple'
+          ::YmlBuilder::OfferSimple.new
+        else
+          raise "Ошибка: неизвестный тип оффера (#{type})"
+      end
+    end
+
+  end
+end

data/lib/yml_builder/offer_simple.rb

@@ -0,0 +1,33 @@
+module YmlBuilder
+  class OfferSimple < YmlBuilder::CommonOffer
+
+    def initialize
+      super
+      @type = 'simple'
+
+      @params = Hash.new
+      @params[:url] = nil
+      @params[:price] = nil
+      @params[:currency_id] = nil
+      @params[:category_id] = nil
+      @params[:market_category] = nil
+      @params[:picture] = nil
+      @params[:store] = nil
+      @params[:pickup] = nil
+      @params[:delivery] = nil
+      @params[:local_delivery_cost] = nil
+      @params[:name] = nil
+      @params[:vendor] = nil
+      @params[:vendor_code] = nil
+      @params[:description] = nil
+      @params[:country_of_origin] = nil
+      @params[:adult] = nil
+      @params[:param] = nil
+      @params[:weight] = nil
+      @params[:dimensions] = nil
+
+      @mandatories = [:url, :price, :currency_id, :category_id, :delivery, :name]
+    end
+
+  end
+end

data/lib/yml_builder/offer_vendor_model.rb

@@ -0,0 +1,32 @@
+module YmlBuilder # :nodoc:
+  class OfferVendorModel < YmlBuilder::CommonOffer
+
+    def initialize
+      super
+
+      @type = 'vendor.model'
+
+      @params[:m] = Hash.new
+      @params[:m][:url] = nil
+      @params[:m][:price] = nil
+      @params[:m][:currency_id] = nil
+      @params[:m][:category_id] = nil
+      @params[:m][:delivery] = nil
+      @params[:m][:vendor] = nil
+      @params[:m][:model] = nil
+
+      @params[:o] = Hash.new
+      @params[:o][:local_delivery_cost] = nil
+      @params[:o][:type_prefix] = nil
+      @params[:o][:vendor_code] = nil
+      @params[:o][:description] = nil
+      @params[:o][:manufacturer_warranty] = nil
+      @params[:o][:country_of_origin] = nil
+      @params[:o][:available] = nil
+      @params[:o][:sales_notes] = nil
+      @params[:o][:downloadable] = nil
+      @params[:o][:adult] = nil
+    end
+
+  end
+end

data/lib/yml_builder/offers.rb

@@ -0,0 +1,42 @@
+module YmlBuilder
+  class Offers
+
+    def initialize(stats, categories)
+      @stats = stats
+      @categories = categories
+      init_class
+    end
+
+    def init_class
+      @offers = Hash.new
+    end
+
+    def add(offer)
+      return false unless @categories.can_add?(offer.category_id)
+      @offers[offer.id] = offer
+
+      # Формируем статистику
+      @stats.add(:total, 1)
+      if offer.available
+        @stats.add(:available, 1)
+        @stats.add(:price, (offer.price || 0))
+      end
+      true
+    end
+
+    def to_yml(ident = 4)
+      @offers = @offers.sort_by { |id, offer| id }
+
+      out = Array.new
+      out << "<offers>"
+      @offers.each do |id, offer|
+        out += offer.to_yml(2).split(/[\n\r]/)
+      end
+      out << "</offers>"
+
+      out.map! { |line| ' '.rjust(ident, ' ') + line }
+      out.join("\n")
+    end
+
+  end
+end

data/lib/yml_builder/shop.rb

@@ -0,0 +1,71 @@
+module YmlBuilder
+  class Shop
+
+    def initialize
+      init_class
+    end
+
+    def init_class
+      @params = Hash.new
+
+      @params[:m] = Hash.new
+      @params[:m][:name] = ''
+      @params[:m][:company] = ''
+      @params[:m][:url] = ''
+
+      @params[:o] = Hash.new
+      @params[:o][:phone] = nil
+      @params[:o][:platform] = nil
+      @params[:o][:version] = nil
+      @params[:o][:agency] = nil
+      @params[:o][:email] = nil
+      @params[:o][:adult] = nil
+      @params[:o][:cpa] = nil
+    end
+
+    def method_missing(method_sym, *arguments, &block)
+      if @params[:m].include?(method_sym.to_s.gsub(/=$/, '').to_sym)
+        processing_method(:m, method_sym, arguments.first)
+      elsif @params[:o].include?(method_sym.to_s.gsub(/=$/, '').to_sym)
+        processing_method(:o, method_sym, arguments.first)
+      else
+        super
+      end
+    end
+
+    def processing_method(part, method_sym, value)
+      if method_sym.to_s.match(/=$/)
+        key = method_sym.to_s.gsub(/=$/, '')
+        warn "Предупреждение: название магазина не должно быть больше 20 символов" if key == 'name' && value.length > 20
+        @params[part][key.to_sym] = value
+      else
+        @params[part][method_sym.to_s.gsub(/=$/, '').to_sym]
+      end
+    end
+
+    def to_yml
+      out = Array.new
+      out << '  <shop>'
+
+      @params[:m].each do |key, value|
+        raise "Ошибка секции 'company': не заполнено значение для обязательного ключа #{key.to_s.inspect}" if value == ''
+        out << "    <#{key}>#{::YmlBuilder::Common.encode_special_chars(value)}</#{key}>"
+      end
+
+      @params[:o].each do |key, value|
+        unless value.nil?
+          out << "    <#{key}>#{::YmlBuilder::Common.encode_special_chars(value)}</#{key}>"
+        end
+      end
+
+      out << '    {replace_currencies}'
+      out << '    {replace_categories}'
+      out << '    {replace_local_delivery_cost}'
+      out << '    {replace_offers}'
+      out << '  </shop>'
+      out.join("\n")
+    end
+
+
+  end
+end

data/lib/yml_builder/stats.rb

@@ -0,0 +1,22 @@
+module YmlBuilder # :nodoc:
+  class Stats
+    attr_reader :stats
+
+    def initialize
+      init_class
+    end
+
+    def init_class
+      @stats = Hash.new
+      @stats[:categories] = 0
+      @stats[:total] = 0
+      @stats[:available] = 0
+      @stats[:price] = 0
+    end
+
+    def add(key, value)
+      @stats[key] += value
+    end
+
+  end
+end

data/lib/yml_builder/version.rb

@@ -0,0 +1,3 @@
+module YmlBuilder # :nodoc:
+  VERSION = "0.1.0"
+end

data/lib/yml_builder/yml.rb

@@ -0,0 +1,83 @@
+# Базовый класс для управления формированием прайс-листа. Содержит ссылки на различные секции:
+# shop, currencies, categories, offers
+
+module YmlBuilder
+  class Yml
+    # Ссылка на класс, описывающий контакты Интернет-магазина
+    attr_reader :shop
+    # Ссылка на класс, описывающий категории
+    attr_reader :categories
+    # Ссылка на класс, описывающий валюты
+    attr_reader :currencies
+    # Ссылка на класс, управляющий товарами (офферами)
+    attr_reader :offers
+    # Переменая, хранящая стоимость доставки в локации расположения Интернет-магазина
+    attr_reader :local_delivery_cost
+
+
+    def initialize
+      @stats = ::YmlBuilder::Stats.new
+      @shop = ::YmlBuilder::Shop.new
+      @currencies = ::YmlBuilder::Currencies.new
+      @categories = ::YmlBuilder::Categories.new(@stats)
+      @offers = ::YmlBuilder::Offers.new(@stats, @categories)
+      @local_delivery_cost = nil
+    end
+
+    # Метод устанавливает стоимость доставки в месте локации магазина. Например, если магазин находится в Москве,
+    #  то при указанни данной стоимости, она будет показана покупателям в этом же районе.
+    #
+    # @param [Float] value стоимость доставки в месте локации магазина
+    # @return [None] нет
+    def local_delivery_cost=(value)
+      @local_delivery_cost = value
+    end
+
+    # Метод возвращает статистику по результатам генерации прайс-листа: всего товаров, товаров в наличии, стоимость
+    #  товаров в наличии (без учета количества)
+    #
+    # @return [None] нет
+    def stats
+      @stats.stats
+    end
+
+    # Метод возвращает текстовую строку с прайс-листом в формате Яндекс.Маркет
+    #
+    # @return [String] строка с прайс-листом в формате utf-8
+    def to_yml
+      out = @shop.to_yml
+      out.gsub!(/^\s{0,100}\{replace\_currencies\}/, @currencies.to_yml)
+      out.gsub!(/^\s{0,100}\{replace\_categories\}/, @categories.to_yml)
+      out.gsub!(/^\s{0,100}\{replace\_local\_delivery\_cost\}[\n\r]/, lds_to_yml)
+      out.gsub!(/^\s{0,100}\{replace\_offers\}/, @offers.to_yml)
+
+      add_header_footer(out)
+    end
+
+    # Метод для записи прайслиста в файл. Запись осущесствится в кодировке windows-1251
+    #
+    # @param [String] filename название файла для записи прайс-листа
+    # @return [None] нет
+    def save(filename)
+      File.open(filename, 'w:windows-1251') {|f| f.write(to_yml) }
+    end
+
+    private
+
+    def add_header_footer(text)
+      out = Array.new
+      out << "<?xml version=\"1.0\" encoding=\"windows-1251\"?>"
+      out << "<!DOCTYPE yml_catalog SYSTEM \"shops.dtd\">"
+      out << "<yml_catalog date=#{::Time.now.strftime("%Y-%m-%d %H:%M").inspect}>"
+      out << text
+      out << "</yml_catalog>"
+      out.join("\n")
+    end
+
+    def lds_to_yml(ident = 4)
+      return "" if @local_delivery_cost.nil?
+      ' '.rjust(ident, ' ') + "<local_delivery_cost>#{@local_delivery_cost}</local_delivery_cost>\n"
+    end
+
+  end
+end

data/lib/yml_builder.rb

@@ -0,0 +1,18 @@
+# coding: utf-8
+lib = File.expand_path('..', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "yml_builder/version"
+
+module YmlBuilder # :nodoc:
+  require "yml_builder/stats"
+  require "yml_builder/common"
+  require "yml_builder/shop"
+  require "yml_builder/currencies"
+  require "yml_builder/categories"
+  require "yml_builder/common_offer"
+  require "yml_builder/offer_simple"
+  require "yml_builder/offer_vendor_model"
+  require "yml_builder/offers"
+  require "yml_builder/offer"
+  require "yml_builder/yml"
+end

data/test/example_1_spec.rb

@@ -0,0 +1,17 @@
+require 'rspec'
+require 'yml_builder'
+
+describe 'Пример 1 - Инициация прайс-листа и магазина' do
+
+  it 'Test' do
+    price = YmlBuilder::Yml.new
+    price.shop.name = 'Магазин ТЕСТ'
+    price.shop.company = "ООО 'Рога & Копыта'"
+    price.shop.url = 'http://example-site.ru'
+    price.shop.phone = '+7 (123) 456-7890'
+    price.shop.platform = 'OpenCart'
+    price.shop.version = '2.0'
+    puts price.to_yml
+
+  end
+end

data/test/example_2_spec.rb

@@ -0,0 +1,28 @@
+require 'rspec'
+require 'yml_builder'
+
+describe 'Пример 2 - Валюта и категории' do
+
+  it 'Test' do
+    price = YmlBuilder::Yml.new
+    price.shop.name = 'Магазин ТЕСТ'
+    price.shop.company = "ООО 'Рога & Копыта'"
+    price.shop.url = 'http://example-site.ru'
+    price.shop.phone = '+7 (123) 456-7890'
+    price.shop.platform = 'OpenCart'
+    price.shop.version = '2.0'
+
+    price.currencies.rub = 1
+    price.currencies.usd = 55.04
+    price.currencies.eur = :cbrf
+
+    price.categories.add(id: 1, name: "Игрушки")
+    price.categories.add(id: 2, name: "Одежда")
+    price.categories.add(id: 4, name: "Игрушки для девочек", parent_id: 1)
+    price.categories.add(id: 5, name: "Игрушки для мальчиков", parent_id: 1)
+    price.categories.add(id: 3, name: "Книги")
+
+    puts price.to_yml
+
+  end
+end

data/test/example_3_spec.rb

@@ -0,0 +1,64 @@
+require 'rspec'
+require 'yml_builder'
+
+describe 'Пример 3 - Добавление товара' do
+
+  it 'Test' do
+    price = YmlBuilder::Yml.new
+    price.shop.name = 'Магазин ТЕСТ'
+    price.shop.company = "ООО 'Рога & Копыта'"
+    price.shop.url = 'http://example-site.ru'
+    price.shop.phone = '+7 (123) 456-7890'
+    price.shop.platform = 'OpenCart'
+    price.shop.version = '2.0'
+
+    price.currencies.rub = 1
+    price.currencies.usd = 55.04
+    price.currencies.eur = :cbrf
+
+    price.categories.add(id: 1, name: "Игрушки")
+    price.categories.add(id: 2, name: "Одежда")
+    price.categories.add(id: 4, name: "Игрушки для девочек", parent_id: 1)
+    price.categories.add(id: 5, name: "Игрушки для мальчиков", parent_id: 1)
+    price.categories.add(id: 3, name: "Книги")
+
+    item = YmlBuilder::Offer.new('simple')
+    item.id = 6
+    item.type = 'simple'
+    item.available = true
+    item.currency_id = 'RUR'
+    item.delivery = true
+    item.category_id = 1
+    item.name = 'Товар №6'
+    item.url = 'http://example-site.ru/items/6'
+    item.price = 300.90
+    item.add_picture('http://example-site.ru/image1')
+    item.add_picture('http://example-site.ru/image2')
+    item.add_cover_picture('http://example-site.ru/image_cover')
+    item.add_param(name: 'Обложка', value: 'Мягкая')
+    item.add_param(name: 'Страниц', value: 10, unit: 'шт.')
+
+    price.offers.add(item)
+
+    item = YmlBuilder::Offer.new('simple')
+    item.id = 3
+    item.type = 'simple'
+    item.available = false
+    item.currency_id = 'RUR'
+    item.delivery = true
+    item.category_id = 2
+    item.name = 'Товар №3'
+    item.url = 'http://example-site.ru/items/3'
+    item.price = 100
+    item.add_picture('http://example-site.ru/image1')
+    item.add_picture('http://example-site.ru/image2')
+    item.add_cover_picture('http://example-site.ru/image_cover')
+    item.add_param(name: 'Обложка', value: 'Мягкая')
+    item.add_param(name: 'Страниц', value: 10, unit: 'шт.')
+
+    price.offers.add(item)
+
+    puts price.to_yml
+
+  end
+end

data/test/example_full_spec.rb

@@ -0,0 +1,68 @@
+require 'rspec'
+require 'yml_builder'
+
+describe 'Проверка формирования файла' do
+
+  it 'Test' do
+    price = YmlBuilder::Yml.new
+    price.shop.name = 'Магазин ТЕСТ'
+    price.shop.company = "ООО 'Рога & Копыта'"
+    price.shop.url = 'http://nosite.ru'
+    price.shop.phone = '+7 (123) 456-7890'
+    price.shop.platform = 'OpenCart'
+    price.shop.version = '2.0'
+
+    price.currencies.rub = 1
+    price.currencies.usd = 55.04
+    price.currencies.eur = :cbrf
+
+    price.categories.add(id: 1, name: "Игрушки")
+    price.categories.add(id: 2, name: "Одежда")
+    price.categories.add(id: 4, name: "Игрушки для девочек", parent_id: 1)
+    price.categories.add(id: 5, name: "Игрушки для мальчиков", parent_id: 1)
+    price.categories.add(id: 3, name: "Книги")
+
+    price.local_delivery_cost = 350
+
+    item = YmlBuilder::Offer.new('simple')
+    item.id = 6
+    item.type = 'simple'
+    item.available = true
+    item.currency_id = 'RUR'
+    item.delivery = true
+    item.category_id = 1
+    item.name = 'Товар №6'
+    item.url = 'http://nosite/items/6'
+    item.price = 300.90
+    item.add_picture('http://nosite.ru/image1')
+    item.add_picture('http://nosite.ru/image2')
+    item.add_cover_picture('http://nosite.ru/image_cover')
+    item.add_param(name: 'Обложка', value: 'Мягкая')
+    item.add_param(name: 'Страниц', value: 10, unit: 'шт.')
+
+    price.offers.add(item)
+
+    item = YmlBuilder::Offer.new('simple')
+    item.id = 3
+    item.type = 'simple'
+    item.available = false
+    item.currency_id = 'RUR'
+    item.delivery = true
+    item.category_id = 2
+    item.name = 'Товар №3'
+    item.url = 'http://nosite/items/3'
+    item.price = 100
+    item.add_picture('http://nosite.ru/image1')
+    item.add_picture('http://nosite.ru/image2')
+    item.add_cover_picture('http://nosite.ru/image_cover')
+    item.add_param(name: 'Обложка', value: 'Мягкая')
+    item.add_param(name: 'Страниц', value: 10, unit: 'шт.')
+
+    price.offers.add(item)
+
+    puts price.to_yml
+    price.save('test_yml.yml')
+    puts price.stats.inspect
+
+  end
+end

data/test/test_yml.yml

@@ -0,0 +1,53 @@
+<?xml version="1.0" encoding="windows-1251"?>
+<!DOCTYPE yml_catalog SYSTEM "shops.dtd">
+<yml_catalog date="2015-05-11 14:57">
+  <shop>
+    <name>������� ����</name>
+    <company>��� &apos;���� &amp; ������&apos;</company>
+    <url>http://nosite.ru</url>
+    <phone>+7 (123) 456-7890</phone>
+    <platform>OpenCart</platform>
+    <version>2.0</version>
+    <currencies>
+      <currency id="RUB" rate="1"/>
+      <currency id="USD" rate="55.04"/>
+      <currency id="EUR" rate="CBRF"/>
+    </currencies>
+    <categories>
+      <category id="1">�������</category>
+      <category id="2">������</category>
+      <category id="3">�����</category>
+      <category id="4" parentId="1">������� ��� �������</category>
+      <category id="5" parentId="1">������� ��� ���������</category>
+    </categories>
+    <local_delivery_cost>350</local_delivery_cost>
+    <offers>
+      <offer id="3" available="false">
+        <url>http://nosite/items/3</url>
+        <price>100</price>
+        <currencyId>RUR</currencyId>
+        <categoryId>2</categoryId>
+        <picture>http://nosite.ru/image_cover</picture>
+        <picture>http://nosite.ru/image1</picture>
+        <picture>http://nosite.ru/image2</picture>
+        <delivery>true</delivery>
+        <name>����� �3</name>
+        <param name="�������">������</param>
+        <param name="�������" unit="��.">10</param>
+      </offer>
+      <offer id="6" available="true">
+        <url>http://nosite/items/6</url>
+        <price>300.9</price>
+        <currencyId>RUR</currencyId>
+        <categoryId>1</categoryId>
+        <picture>http://nosite.ru/image_cover</picture>
+        <picture>http://nosite.ru/image1</picture>
+        <picture>http://nosite.ru/image2</picture>
+        <delivery>true</delivery>
+        <name>����� �6</name>
+        <param name="�������">������</param>
+        <param name="�������" unit="��.">10</param>
+      </offer>
+    </offers>
+  </shop>
+</yml_catalog>

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: yml_builder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stan Zhuravlev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: |-
+  Библиотека содержит набор классов для формирования и валидации прайс-листов
+                            в формате Яндекс YAML (Яндекс.Маркет).
+                            Текущая версия поддерживает только упрощенные товарные карточки.
+email:
+- stan@post-api.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- bin/console
+- bin/setup
+- lib/yml_builder.rb
+- lib/yml_builder/categories.rb
+- lib/yml_builder/common.rb
+- lib/yml_builder/common_offer.rb
+- lib/yml_builder/currencies.rb
+- lib/yml_builder/offer.rb
+- lib/yml_builder/offer_simple.rb
+- lib/yml_builder/offer_vendor_model.rb
+- lib/yml_builder/offers.rb
+- lib/yml_builder/shop.rb
+- lib/yml_builder/stats.rb
+- lib/yml_builder/version.rb
+- lib/yml_builder/yml.rb
+- test/example_1_spec.rb
+- test/example_2_spec.rb
+- test/example_3_spec.rb
+- test/example_full_spec.rb
+- test/test_yml.yml
+homepage: https://github.com/StanZhuravlev/yml_builder
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- lib/yml_builder
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: 2.2.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: "Набор классов для формирования прайс-листов в формате Яндекс YAML"
+test_files: []