api_scaffolding 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8ea73f9ae8761072733f737b76e27e785e32a955380e0ebe4c734e845a98044
-  data.tar.gz: 007fb499bae3ee21f29435ef492daef2e429a44914f5e438232aae4fc60e4a8b
+  metadata.gz: '08c5ec74d829c952e8a2ceb573f4730efad6a959079353cc1b7d64ff04fced97'
+  data.tar.gz: 17aac17e0026af1f9aa8edb11606c4abf8e6817dc77720c45b183cbaeb890b7b
 SHA512:
-  metadata.gz: f752009ed927514fcea94d4a45c8ad3e894d2f6afe89f473ed5df7dce7e43eb5289ebb5abaac08d2e63f14dbd8c1c69fdf43fdd576678fc5b100b1a7f7798c2a
-  data.tar.gz: 194aeba80d5c89ce5e32baad5d56dcfd4d6ca5c2b326c57e4bd95c7a0172de6993512e18661a5dc61c859768c10caa94d3486a6ac2e080b22be04a16155306eb
+  metadata.gz: ba57f6f99006c3933af779cfd849e491a64392bd053a6b18b1bd215723c52c762d3b3d2de3634b233d285a0aef0931b3d0ac83030765e3384130e9417ca693ef
+  data.tar.gz: 84caddd41decc1abced9faf367ec2f75dc32651d967e2d475b958b7987717ea6e634751b2c8632229739b1f72a774ca293d85eddea8ab16cc95ad16934ccf4ce

data/lib/generators/api_scaffold/api_scaffold_generator.rb

@@ -14,7 +14,7 @@ module ApiScaffold
       def generate_files
         generate "api_scaffold:entity #{class_name} --entity_dir=#{options['entity_dir']}"
         generate "api_scaffold:params_concern #{class_name} --api_version=#{options['api_version']}"
-        generate "api_scaffold:controller #{class_name} --api_version=#{options['api_version']} --no_params=#{options['no_params']} --no_entity=#{options['no_entity']}"
+        generate "api_scaffold:controller #{class_name} --api_version=#{options['api_version']} --no_params=#{options['no_params']} --no_entity=#{options['no_entity']} --entity_dir=#{options['entity_dir']}"
         generate "api_scaffold:modify_api_root #{class_name} --api_version=#{options['api_version']}"
       end
 

data/lib/generators/api_scaffold/controller_generator.rb

@@ -9,6 +9,7 @@ module ApiScaffold
       class_option :api_version, type: :string, default: ApiScaffolding.config.default_api_version
       class_option :no_params, type: :boolean, default: false
       class_option :no_entity, type: :boolean, default: false
+      class_option :entity_dir, type: :string, default: nil
 
       source_root File.expand_path('../templates', __dir__)
 

data/lib/generators/api_scaffold/entity_generator.rb

@@ -24,24 +24,12 @@ module ApiScaffold
 
       private
 
-      def entity_class_name
-        entity_module_with_prefix + entity_class
-      end
-
-      def entity_module_with_prefix
-        dir = options['entity_dir']
-        value = ApiScaffolding.config.api_version_modules[dir]
-        return '' if dir.blank? || class_name.starts_with?(value)
-
-        "#{value}::"
-      end
-
       def list_fields
         # предполагается, что поля определенные поля должны быть на списке по умолчанию
         model.columns.map do |column|
           next if %w[name].exclude?(column.name)
 
-          entity_field(column)
+          entity_field(column).force_encoding(Encoding::BINARY)
         end.compact.join(fields_separator)
       end
 
@@ -50,29 +38,40 @@ module ApiScaffold
         model.columns.map do |column|
           next if ApiScaffolding.config.entity_fields_exclusions.include?(column.name)
 
-          entity_field(column)
+          entity_field(column).force_encoding(Encoding::BINARY)
         end.compact.join(fields_separator)
       end
 
       def fields_separator
         # разделение полей в генерируемом файле
-        "\n" + (' ' * 4)
+        "\n\n" + (' ' * 4)
       end
 
       def entity_field(column)
+        # разделение для форматирования поля
+        separator = "\n" + (' ' * 11)
+
+        # описание поля
+        desc = column.comment
+        if column.type == :enum
+          desc += " (enum: #{column.sql_type})"
+        end
+
         case column.type
-        when :string, :enum
-          "expose :#{column.name}"
+        when :string
+          "expose :#{column.name},#{separator}documentation: { desc: '#{desc}' }"
+        when :enum
+          "expose :#{column.name},#{separator}documentation: { values: #{model}.#{column.name.pluralize}.values, desc: '#{desc}' }"
         when :integer
-          "expose :#{column.name}, documentation: { type: 'Integer' }"
+          "expose :#{column.name},#{separator}documentation: { type: 'Integer', desc: '#{desc}' }"
         when :float
-          "expose :#{column.name}, documentation: { type: 'Float' }"
+          "expose :#{column.name},#{separator}documentation: { type: 'Float', desc: '#{desc}' }"
         when :decimal
-          "expose :#{column.name}, documentation: { type: 'Float', values: [#{decimal_example(column)}] }"
+          "expose :#{column.name},#{separator}documentation: { type: 'Float', values: [#{decimal_example(column)}], desc: '#{desc}' }"
         when :date
-          "expose :#{column.name}, documentation: { type: 'Date' }"
+          "expose :#{column.name},#{separator}documentation: { type: 'Date', desc: '#{desc}' }"
         when :boolean
-          "expose :#{column.name}, documentation: { type: 'Boolean' }"
+          "expose :#{column.name},#{separator}documentation: { type: 'Boolean', desc: '#{desc}' }"
         end
       end
 

data/lib/generators/api_scaffold/helper.rb

@@ -32,6 +32,18 @@ module ApiScaffold
         "#{class_name}Entity"
       end
 
+      def entity_class_name
+        entity_module_with_prefix + entity_class
+      end
+
+      def entity_module_with_prefix
+        dir = options['entity_dir']
+        value = ApiScaffolding.config.api_version_modules[dir]
+        return '' if dir.blank? || class_name.starts_with?(value)
+
+        "#{value}::"
+      end
+
       def api_address
         controller_class.underscore
       end

data/lib/generators/api_scaffold/params_concern_generator.rb

@@ -37,11 +37,16 @@ module ApiScaffold
           when :decimal
             'Float'
           else
-            column.type.capitalize
+            column.type.to_s.capitalize
           end
 
         # базовая строка
-        line = "optional :#{column.name}, type: #{type}"
+        line = "optional :#{column.name}"
+
+        # добавление типа
+        if type != 'String'
+          line += ", type: #{type}"
+        end
 
         # добавление возможных значений enum
         if column.type == :enum

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

@@ -16,7 +16,7 @@ module API<%= api_version_module_with_prefix %>
       <%- if @no_entity -%>
       desc '<%= api_description %> - список'
       <%- else -%>
-      desc '<%= api_description %> - список', entity: <%= entity_class %>::List
+      desc '<%= api_description %> - список', entity: <%= entity_class_name %>::List
       <%- end -%>
       oauth2
       <%- unless @no_params -%>
@@ -35,7 +35,7 @@ module API<%= api_version_module_with_prefix %>
       <%- if @no_entity -%>
       desc '<%= api_description %> - получение записи'
       <%- else -%>
-      desc '<%= api_description %> - получение записи', entity: <%= entity_class %>::Entry
+      desc '<%= api_description %> - получение записи', entity: <%= entity_class_name %>::Entry
       <%- end -%>
       oauth2
       <%- if @abilities_check -%>
@@ -47,14 +47,14 @@ module API<%= api_version_module_with_prefix %>
         <%= class_name %>.find(params[:id])
         <%- else -%>
         record = <%= class_name %>.find(params[:id])
-        present record, with: <%= entity_class %>::Entry
+        present record, with: <%= entity_class_name %>::Entry
         <%- end -%>
       end
 
       <%- if @no_entity -%>
       desc '<%= api_description %> - создание'
       <%- else -%>
-      desc '<%= api_description %> - создание', entity: <%= entity_class %>::Entry
+      desc '<%= api_description %> - создание', entity: <%= entity_class_name %>::Entry
       <%- end -%>
       oauth2
       <%- unless @no_params -%>
@@ -72,7 +72,7 @@ module API<%= api_version_module_with_prefix %>
         <%= class_name %>.create!(attrs)
         <%- else -%>
         record = <%= class_name %>.create!(attrs)
-        present record, with: <%= entity_class %>::Entry
+        present record, with: <%= entity_class_name %>::Entry
         <%- end -%>
       end
       <%- if @restoration_required -%>
@@ -80,7 +80,7 @@ module API<%= api_version_module_with_prefix %>
       <%- if @no_entity -%>
       desc '<%= api_description %> - восстановление записи'
       <%- else -%>
-      desc '<%= api_description %> - восстановление записи', entity: <%= entity_class %>::Entry
+      desc '<%= api_description %> - восстановление записи', entity: <%= entity_class_name %>::Entry
       <%- end -%>
       oauth2
       <%- if @abilities_check -%>
@@ -92,7 +92,7 @@ module API<%= api_version_module_with_prefix %>
         <%- if @no_entity -%>
         record.restore(recursive: true)
         <%- else -%>
-        present record.restore(recursive: true), with: <%= entity_class %>::Entry
+        present record.restore(recursive: true), with: <%= entity_class_name %>::Entry
         <%- end -%>
       end
       <%- end -%>
@@ -100,7 +100,7 @@ module API<%= api_version_module_with_prefix %>
       <%- if @no_entity -%>
       desc '<%= api_description %> - редактирование'
       <%- else -%>
-      desc '<%= api_description %> - редактирование', entity: <%= entity_class %>::Entry
+      desc '<%= api_description %> - редактирование', entity: <%= entity_class_name %>::Entry
       <%- end -%>
       oauth2
       <%- unless @no_params -%>
@@ -120,7 +120,7 @@ module API<%= api_version_module_with_prefix %>
         <%- if @no_entity -%>
         record
         <%- else -%>
-        present record, with: <%= entity_class %>::Entry
+        present record, with: <%= entity_class_name %>::Entry
         <%- end -%>
       end
 

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: api_scaffolding
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Павел Бабин
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-08 00:00:00.000000000 Z
+date: 2024-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '6.0'
 - !ruby/object:Gem::Dependency
@@ -31,6 +31,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.7.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -38,6 +41,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.7.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: grape-entity
   requirement: !ruby/object:Gem::Requirement
@@ -45,6 +51,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -52,18 +61,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 description: Генерация контроллеров API и модулей с параметрами Grape и Grape Entity