api_scaffolding 1.0.2 → 1.0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18212ce104518b32a3b4b252161d47c91501e599a7982a704b573fa6745bab24
-  data.tar.gz: aa0a3d7c1ddd955e586dd4248f010c3465a00176e37d0c5a7d38d94e2f624480
+  metadata.gz: 9cf16a7cedbb1200b634e5b8c4e1a73c6b47931d6902bfebe6d95f54464de262
+  data.tar.gz: 8bc2cead74432092c135b3f25ac0be29671b4cf8b311ef00b374c3b9f3483f44
 SHA512:
-  metadata.gz: ff92cd603d95135cddce3443c0e9a0c0dd0554656aed89586b8d0c56201f9bcb2b3f1d621149524e293b01290006eac81696f8abd9cf15d537a268e509cd93c9
-  data.tar.gz: be967475a4cf3768f9d106824ce624a4a8132bdc01bf81b1ff35e2e6842ee1801da42d5c9e17b9df796ab216a6c5324482d3e257103b926f113f91ef31d3ce90
+  metadata.gz: f86d9eafb4a861573437f01e3b6230022da1d6ff97ccb0fe3806b04a7f0547d760a07970e81731acc410870f8379ad0177aa4d9c037dc140a14e07b43fac1d42
+  data.tar.gz: 88c3120719bbcaf1ae49c5753b19ada845425f7c70bde3a9cd64fb7be58ec7e1d362389fedcbfe6eb3736b13abde8c1b439b718beab9988c4860dc501bb05cc8

data/README.md

@@ -1,4 +1,5 @@
 # API Scaffolding
+[![Gem Version](https://badge.fury.io/rb/api_scaffolding.svg)](https://badge.fury.io/rb/api_scaffolding)
 
 Генерация контроллеров API и модулей с параметрами Grape и Grape Entity.
 

data/lib/api_scaffolding/configuration.rb

@@ -7,7 +7,9 @@ module ApiScaffolding
                   :params_fields_exclusions,
                   :entity_fields_exclusions,
                   :abilities_check,
-                  :abilities_authorize_opts
+                  :abilities_authorize_opts,
+                  :entity_list_parent_class,
+                  :entity_entry_parent_class
 
     def default_api_version
       @default_api_version || ''
@@ -36,6 +38,14 @@ module ApiScaffolding
     def abilities_authorize_opts
       @abilities_authorize_opts || ''
     end
+
+    def entity_list_parent_class
+      @entity_list_parent_class || 'Grape::Entity'
+    end
+
+    def entity_entry_parent_class
+      @entity_entry_parent_class || 'Grape::Entity'
+    end
   end
 
   def self.configure

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,18 +24,6 @@ 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|

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/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
 

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

@@ -32,6 +32,11 @@ if defined?(ApiScaffold)
     #   deleted_at
     # ]
 
+    # классы наследования Grape Entity (по умолчанию - Grape::Entity)
+    #
+    # config.entity_list_parent_class = ''
+    # config.entity_entry_parent_class = ''
+
     # список исключений, для которых не будут добавляться поля в классе entity
     #
     # config.entity_fields_exclusions = %w[]

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

@@ -2,12 +2,12 @@
 class <%= entity_class_name %>
 
   # список
-  class List < BaseEntities::List
+  class List < <%= ApiScaffolding.config.entity_list_parent_class %>
     <%= list_fields %>
   end
 
   # запись
-  class Entry < BaseEntities::Entry
+  class Entry < <%= ApiScaffolding.config.entity_entry_parent_class %>
     <%= entry_fields %>
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_scaffolding
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3.1
 platform: ruby
 authors:
 - Павел Бабин
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-07 00:00:00.000000000 Z
+date: 2024-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails