grape-starter 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d9f7ca7efc30bff48e6f765786b43a6cfd6d2c1c68d93063bbab89c4042bb5d
-  data.tar.gz: 1ecd2c9a8ce6eeebd94ed79a5e08bb81328c327a361750ca6ae1aff8578281ef
+  metadata.gz: 3120d80bd3930bf6d8760f03ef07a3b9ca9330fb2413705fc2330a2120c7a258
+  data.tar.gz: 33efe62100801cc5def02818625b7c6e336449009bab66d4ef61f0dfc4b6b45f
 SHA512:
-  metadata.gz: baa02a26a233adc4f6edd6afe687356b99d29ef59071a170cf6183fb257be59254d7c2bb2e04bcf63bd67e8978e46c6a261cbb71319340ebeedacee3a8427f22
-  data.tar.gz: 43a5e2557d01d84bccc0cf91e5d7c52446b86572a2343d19ce2d905172b01b5c83bbf085d04d646e7cf6faf01b5466e0f47912323c32433981b693b5ff1bfad1
+  metadata.gz: 60074684dfe1773666cf6c24c373edcd009eec3ab9d0b33c13caa05c5a1f57cb263160f21c28aacefcc0f63c82f0ed4df077bc095dea17f90398319e6d247e83
+  data.tar.gz: 9b57425801bce4d43f439fe93600764e5e37d1f3cc08d2c0ce6a5a1298e2304352eb2850ef082a7d23f899e4740c2c0c97dd324e8de28fab86563039cbd2a49e

data/CHANGELOG.md

@@ -2,9 +2,13 @@
 
 - contributions
 
+### v2.1.0 / 2023-10-21 Imports OApi specs
+
+- [(#41)](https://github.com/LeFnord/grape-starter/pull/41) Adds generating of desc block [LeFnord](https://github.com/LeFnord)
+
 ### v2.0.0 / 2023-10-21 Imports OApi specs
 
-- [(#38)](https://github.com/LeFnord/grape-starter/pull/38) Handles nested body [LeFnord](https://github.com/LeFnord)
+- [(#39)](https://github.com/LeFnord/grape-starter/pull/39) Handles nested body [LeFnord](https://github.com/LeFnord)
 - [(#38)](https://github.com/LeFnord/grape-starter/pull/38) Handle parameters from request body [LeFnord](https://github.com/LeFnord)
 - [(#37)](https://github.com/LeFnord/grape-starter/pull/37) Ignores possible version segments in path [LeFnord](https://github.com/LeFnord)
 - Sets min ruby to 3.1 [LeFnord](https://github.com/LeFnord)

data/lib/starter/importer/description.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: false
+
+module Starter
+  module Importer
+    class Description
+      attr_accessor :content
+
+      def initialize(content:)
+        @content = content
+      end
+
+      def to_s
+        return if content.blank?
+
+        desc = content['summary'] || name
+
+        entry = "desc '#{desc}' do\n"
+        entry << "  detail '#{content['description']}'\n" if content.key?('description')
+        entry << "  tags #{content['tags']}\n" if content.key?('tags')
+        entry << 'end'
+
+        entry
+      end
+    end
+  end
+end

data/lib/starter/importer/namespace.rb

@@ -1,3 +1,4 @@
+# rubocop:disable Metrics/AbcSize
 # frozen_string_literal: false
 
 module Starter
@@ -39,10 +40,13 @@ module Starter
           verbs.keys.each_with_object([]) do |verb, memo|
             next unless allowed_verbs.include?(verb)
 
+            memo << verbs[verb]['describe'].to_s if verbs[verb]['describe'].present?
+
             if (parameters = verbs[verb]['parameters'].presence)
               params_block = params_block(parameters)
               memo << params_block
             end
+
             memo << "#{verb} '#{segment}' do\n  # your code comes here\nend\n"
           end
         end
@@ -71,3 +75,5 @@ module Starter
     end
   end
 end
+
+# rubocop:enable Metrics/AbcSize

data/lib/starter/importer/parameter.rb

@@ -145,6 +145,8 @@ module Starter
         entry = definition['required'] ? 'requires' : 'optional'
         entry << " :#{name}"
         entry << ", type: #{type}"
+        entry << ", default: '#{definition['default']}'" if definition.key?('default') && definition['default'].present?
+        entry << ", values: #{definition['enum'].map(&:to_s)}" if definition.key?('enum')
         doc = documentation
         entry << ", #{doc}" if doc
 

data/lib/starter/importer/specification.rb

@@ -58,7 +58,9 @@ module Starter
           memo[verb] = content
           next unless content.key?('parameters') || content.key?('requestBody') || path_params
 
-          parameters = ((content['parameters'] || path_params || []) + [content['requestBody']]).compact
+          parameters = ((content.delete('parameters') || path_params || []) + [content.delete('requestBody')]).compact
+
+          memo[verb]['describe'] = Description.new(content: content.except('responses'))
 
           memo[verb]['parameters'] = parameters.each_with_object({}) do |definition, para|
             parameter = Parameter.new(definition:, components:)

data/lib/starter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Starter
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-starter
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - LeFnord
@@ -118,6 +118,7 @@ files:
 - lib/starter/config.rb
 - lib/starter/file_ops.rb
 - lib/starter/import.rb
+- lib/starter/importer/description.rb
 - lib/starter/importer/namespace.rb
 - lib/starter/importer/nested_params.rb
 - lib/starter/importer/parameter.rb