docgen-adapter 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5843bd2a380e11e802a39d91839e5daa56ed848ebf3f9c1ec8d4c02a5fe96331
-  data.tar.gz: a1d2955903f75f3b1a5d64cc03cd16b879c7346aab5e5259bdd6a7c376557609
+  metadata.gz: 436def6a7f3f7cf576ee57d20432b0f81598d4e8cf203bd399a55016bbebfdb9
+  data.tar.gz: 2d306870e9a52bda078216596d734b0bb1b8736d647fcf739c8792b06054ba15
 SHA512:
-  metadata.gz: 62f713cb8e3a6047295e8dabf3a2f11d20498e53448dcb2ffa75d5fe1e1b02fd4295b6871aa0a3a28d5910930c5d2202725df36bf3eba77da8d4ab740819e148
-  data.tar.gz: 23d0dd3ac4e4686756df2f0237997b45db796a4c80e0e665d20a6ad1d019156370da7e207c8b0f5f5bca7c7dd7e9e1f837e37342628197e955aa9967539f49ab
+  metadata.gz: a1d79bff9ac3c1d4c846d042a9fb061ea9128a93061346f50a69e4155d4270152830ea77aea7197bd460089e2eb69f99290c11964d2879ab908a037ff5cbd88d
+  data.tar.gz: eeaf82f5f161738451e49cb11c2e5c7c6d0009a12ac3b9f3f282cd7237e1633afa865eb97cc03fec16168f7184a770c021d894bdbc58805479c5afda6f9600cf

data/README.md

@@ -33,26 +33,48 @@ end
 
 ## Использование
 
-Использование с помощью вызова метода `generate` класса `DocgenAdapter`. Например:
+Добавьте класс для документа, вызвав генератор. В качестве аргумента передайте ID документа, в обязательной опции `doc_type` - тип документа (`docx` или `xlsx`).
+
+Например:
+
+```bash
+rails g docgen:document 1 --doc_type=docx
+```
+
+Вызванная команда создаст файл `app/documents/docx/document_01.rb`.
+
+Добавьте тело необходимых параметров в метод `json` сгенерированного класса. Например:
+
+```ruby
+def json(params = {})
+  {
+    DocumentNumber: params[:number],
+    Houses: [
+      {
+        HouseAddress: 'г. Калуга',
+        PersonFIO: 'Иванов ИИ',
+        PersonState: 'электромонтер',
+        PersonPhone: '89171234567',
+        OrganizationName: 'Россети',
+        OrganizationAddress: 'г. Обнинск',
+        OrganizationPhone: '1234567',
+        OrganizationCite: 'https://www.rosseti.ru'
+      }
+    ]
+  }
+end
+```
+
+Задайте название генерируемого файла в `metadata`. Например:
+
+```ruby
+metadata filename: 'контактная информация'
+```
+
+Вызовите генерацию с помощью вызова метода `generate` класса `DocgenAdapter`. Например:
 
 ```ruby
-params = {
-  DocumentNumber: 12345678,
-  Houses: [
-    {
-      HouseAddress: 'г. Калуга',
-      PersonFIO: 'Иванов ИИ',
-      PersonState: 'электромонтер',
-      PersonPhone: '89171234567',
-      OrganizationName: 'Россети',
-      OrganizationAddress: 'г. Обнинск',
-      OrganizationPhone: '1234567',
-      OrganizationCite: 'https://www.rosseti.ru'
-    }
-  ]
-}
-
-DocgenAdapter.new(type: 'docx', doc_id: 1, debug: true).generate(params)
+DocgenAdapter.new(type: 'docx', doc_id: 1, debug: true).generate(number: 123)
 ```
 
 Опции:
@@ -62,3 +84,5 @@ DocgenAdapter.new(type: 'docx', doc_id: 1, debug: true).generate(params)
 - `doc_id` - ID документа
 
 - `debug` - необязательная опция для дебага, при передаче `debug: true` при вызове отображаются формируемые параметры
+
+В качестве аргументов метода `generate` передайте параметры, которые можно подставлять в `json` сгенерированного класса.

data/lib/docgen_adapter.rb

@@ -1,5 +1,6 @@
 require 'docgen_adapter/configuration'
 require 'redis'
+require 'docgen_subject'
 
 class DocgenAdapter
 
@@ -9,10 +10,6 @@ class DocgenAdapter
     @doc_id = doc_id
     @debug = Rails.env.development? && debug
     @task_id = SecureRandom.uuid
-
-    # формирование названия генерируемого файла
-    dir = Dir.mktmpdir
-    @filename = "#{dir}/#{@task_id}_#{@doc_id}.#{@type}"
   end
 
   # выполнение генерации документа
@@ -32,11 +29,26 @@ class DocgenAdapter
     redis.publish('TASKS', @service_params)
 
     # путь до сгенерированного файла в ответе
-    @filename
+    filename
   end
 
   private
 
+  def document_class
+    @document_class ||=
+      case @type
+      when 'docx'
+        "Docx::Document#{format('%02d', @doc_id)}".constantize
+      when 'xlsx'
+        "Xlsx::Document#{format('%02d', @doc_id)}".constantize
+      end
+  end
+
+  # формирование названия генерируемого файла
+  def filename
+    @filename ||= "#{Dir.mktmpdir}/#{document_class.metadata_opts[:filename]}.#{@type}"
+  end
+
   # соединение с микросервисом через Redis
   def redis
     @redis ||= Redis.new(
@@ -71,7 +83,7 @@ class DocgenAdapter
       ИдентификаторДокумента: @doc_id,
       ТипДокумента: @type,
       Md5ДополнительныхФайлов: [],
-      ПараметрыДокумента: params
+      ПараметрыДокумента: document_class.new.json(params)
     }.to_json
   end
 
@@ -106,7 +118,7 @@ class DocgenAdapter
   # обработка бинарных данных файла документа
   def handle_doc_file(message)
     # запись бинарных данных в файл
-    File.write @filename, message.force_encoding('utf-8')
+    File.write filename, message.force_encoding('utf-8')
 
     # сообщение с файлом приходит последним - отписка от канала Redis
     redis.unsubscribe

data/lib/docgen_subject.rb

@@ -0,0 +1,10 @@
+class DocgenSubject
+
+  # метод для сбора метаданных
+  def self.metadata(options = {})
+    # опции кешинга
+    class_attribute :metadata_opts
+    self.metadata_opts = options
+  end
+
+end

data/lib/generators/docgen/document_generator.rb

@@ -0,0 +1,21 @@
+module Docgen
+  module Generators
+    class DocumentGenerator < Rails::Generators::NamedBase
+
+      class_option :doc_type, type: :string
+
+      source_root File.expand_path('../templates', __dir__)
+
+      def create_document_file
+        # добавляем 0 для ИД задания спереди для значений от 1 до 10
+        @file_doc_id = "%02d" % file_name.to_i
+        @doc_type = options['doc_type']
+        dir_name = "app/documents/#{@doc_type}"
+        filename = "document_#{@file_doc_id}.rb"
+
+        template 'document.rb', File.join(dir_name, filename)
+      end
+
+    end
+  end
+end

data/lib/generators/templates/document.rb.tt

@@ -0,0 +1,10 @@
+class <%= @doc_type.capitalize %>::Document<%= @file_doc_id %> < DocgenSubject
+
+  metadata filename: ''
+
+  def json(params = {})
+    {
+    }
+  end
+
+end

metadata

@@ -1,35 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: docgen-adapter
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Павел Бабин
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-16 00:00:00.000000000 Z
+date: 2024-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.3'
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.3.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.3'
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.3.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
 description: Адаптер собственного сервиса генерации документов
 email: babin359@gmail.com
 executables: []
@@ -40,6 +40,9 @@ files:
 - lib/docgen-adapter.rb
 - lib/docgen_adapter.rb
 - lib/docgen_adapter/configuration.rb
+- lib/docgen_subject.rb
+- lib/generators/docgen/document_generator.rb
+- lib/generators/templates/document.rb.tt
 homepage:
 licenses:
 - MIT
@@ -60,7 +63,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.0.6
 signing_key:
 specification_version: 4
 summary: Адаптер собственного сервиса генерации документов