grape-starter 2.0.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d9f7ca7efc30bff48e6f765786b43a6cfd6d2c1c68d93063bbab89c4042bb5d
-  data.tar.gz: 1ecd2c9a8ce6eeebd94ed79a5e08bb81328c327a361750ca6ae1aff8578281ef
+  metadata.gz: 88f7a549c78c1741a4c0ff18077722f2fb62d3d8b557cc6549c964de83487c2a
+  data.tar.gz: cdf6fa7b945c98c173b5c64d1d49423fbc004856b65951f00cc3ace640761ed6
 SHA512:
-  metadata.gz: baa02a26a233adc4f6edd6afe687356b99d29ef59071a170cf6183fb257be59254d7c2bb2e04bcf63bd67e8978e46c6a261cbb71319340ebeedacee3a8427f22
-  data.tar.gz: 43a5e2557d01d84bccc0cf91e5d7c52446b86572a2343d19ce2d905172b01b5c83bbf085d04d646e7cf6faf01b5466e0f47912323c32433981b693b5ff1bfad1
+  metadata.gz: 6a5e7ab35998625f88a216f9313ab7a155a1a2df30a8da690eb96ba75e1bc3cf26c1ed2d830a2b0761dd8c7e4554796bec064c9707de3048532502a53ae7ff20
+  data.tar.gz: 73569bbbd944855371b5121bf1d28c1d3dadfa848b3dddb856781785ea82a328204ef2cb97631a037ac4bf9f1ae3633513100b067b6e3103ff01472f31e287c4

data/CHANGELOG.md

@@ -2,9 +2,17 @@
 
 - contributions
 
+### v2.1.1 / 2023-10-24
+
+- [(#43)](https://github.com/LeFnord/grape-starter/pull/43) Fixes desc generation if now useful prop is in content [LeFnord](https://github.com/LeFnord)
+
+### 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/README.md

@@ -144,7 +144,7 @@ to create an API based on the spec.
   - [x] specify it
 - [x] handle query parameter -> check it
 - [x] handle body parameter -> check it
-- [ ] add description block
+- [x] add description block
 
 
 ### Remove a resource

data/lib/starter/importer/description.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: false
+
+module Starter
+  module Importer
+    class Description
+      attr_accessor :content
+
+      def initialize(content:)
+        @content = content
+      end
+
+      def to_s # rubocop:disable Metrics/AbcSize
+        return if content.blank?
+
+        desc = content['summary'] || content['operationId']
+        entry = "desc '#{desc}'\n"
+
+        return entry unless block_keys.intersect?(content.keys)
+
+        entry.sub!("\n", " do\n")
+        entry << "  detail '#{content['description']}'\n" if content.key?('description')
+        entry << "  tags #{content['tags']}\n" if content.key?('tags')
+        entry << 'end'
+
+        entry
+      end
+
+      def block_keys
+        %w[
+          description
+          tags
+        ]
+      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.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-starter
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.1
 platform: ruby
 authors:
 - LeFnord
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-22 00:00:00.000000000 Z
+date: 2023-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli
@@ -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
@@ -176,7 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.17
+rubygems_version: 3.4.21
 signing_key:
 specification_version: 4
 summary: Creates a Grape Rack skeleton