grape-swagger-entity 0.5.3 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: add308a25b9c529ea00b8527b3b435738f226a9af7c25e95aac0725c672b714b
-  data.tar.gz: a8e5cc48c165535bc489c8cff7879e5ad6cf4650996a8f9838a073bd1bfc3840
+  metadata.gz: 2acdf9214576f2fd49186e8bf6163382daa19b6842dc08033567d2427aaa5bcc
+  data.tar.gz: 50fa87da0ef94dff6128cea9b5178d3455c831b87457768ea8140bd14f8fc001
 SHA512:
-  metadata.gz: 2fd8fc5aff26713b93abf4290ce6c56054c3e497a860c9873c8a6675b1769807f6a236cdbe62961fae6891a4667fbd250579db4f2c5c82ef2875713d8917e90c
-  data.tar.gz: 54248e88317f33f1a12d2f7ede6b5f897e2b3e5ea21927b1fc4a078358a46cb6d36abff7455cebc11d066c9fd75421b044686dfb1417d76312953f9b6de96b54
+  metadata.gz: 6f7f9ef5026e54fd99035d38e84c358cc8446a117aadeb486f900775ff15a83bc3b5aaa7c0f3c27afbde6a870ec77a3e8e6baf9fcc1c13df024826f1164aecf8
+  data.tar.gz: 89b9bcb8ef9693861bf2042f70147f611b9500c0dda4db5cac5b08af03a156281be02ec14afd71722d23fa498fec28308f1d638997bae066f3db4c07c7d98397

data/.github/workflows/test.yml

@@ -10,7 +10,7 @@ jobs:
     name: RuboCop
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
@@ -24,16 +24,16 @@ jobs:
 
   test:
     env:
-      GRAPE_ENTITY: 0.8.0
+      GRAPE_ENTITY: 1.0.0
 
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        ruby-version: ['3.0', '3.1', '3.2']
+        ruby-version: ['3.0', '3.1', '3.2', '3.3']
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

data/.rubocop_todo.yml

@@ -58,6 +58,7 @@ Metrics/BlockLength:
 # Configuration parameters: CountComments, Max, CountAsOne.
 Metrics/ClassLength:
   Exclude:
+    - 'lib/grape-swagger/entity/attribute_parser.rb'
     - 'lib/grape-swagger/entity/parser.rb'
 
 # Offense count: 2

data/CHANGELOG.md

@@ -1,12 +1,20 @@
-### Next
+### 0.5.5 (2024/09/09)
+
+#### Fixes
+
+* [#72](https://github.com/ruby-grape/grape-swagger-entity/pull/72): Ensure inherited nested exposures are merged - [@pirhoo](https://github.com/pirhoo).
+* [#71](https://github.com/ruby-grape/grape-swagger-entity/pull/71): Fix regression for enum values in array attributes - [@Jell](https://github.com/Jell).
+
+### 0.5.4 (2024/04/19)
 
 #### Features
 
-* Your contribution here.
+* [#69](https://github.com/ruby-grape/grape-swagger-entity/pull/69): Add support for minimum and maximum - [@storey](https://github.com/storey).
 
 #### Fixes
 
-* Your contribution here.
+* [#67](https://github.com/ruby-grape/grape-swagger-entity/pull/67): Various build updates - [@mscrivo](https://github.com/mscrivo).
+* [#68](https://github.com/ruby-grape/grape-swagger-entity/pull/68): Properly render `example` for array exposure done using another entity - [@magni-](https://github.com/magni-).
 
 ### 0.5.3 (2024/02/02)
 

data/Gemfile

@@ -21,7 +21,7 @@ end
 gem 'grape-swagger', git: 'https://github.com/ruby-grape/grape-swagger.git'
 
 group :test do
-  gem 'grape-entity', ENV.fetch('GRAPE_ENTITY', '0.6.1')
+  gem 'grape-entity', ENV.fetch('GRAPE_ENTITY', '1.0.0')
   gem 'ruby-grape-danger', '~> 0.2.1', require: false
   gem 'simplecov', require: false
 end

data/RELEASING.md

@@ -29,7 +29,7 @@ Remove the line with "Your contribution here.", since there will be no more cont
 Commit your changes.
 
 ```
-git add CHANGELOG.md lib/grape-swagger-entity/version.rb
+git add CHANGELOG.md lib/grape-swagger/entity/version.rb CHANGELOG.md
 git commit -m "Preparing for release, 0.1.1."
 git push origin master
 ```

data/grape-swagger-entity.gemspec

@@ -19,8 +19,8 @@ Gem::Specification.new do |s|
   s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.required_ruby_version = '>= 2.4'
-  s.add_runtime_dependency 'grape-entity', '>= 0.6.0'
-  s.add_runtime_dependency 'grape-swagger', '>= 1.2.0'
+  s.required_ruby_version = '>= 3.0'
+  s.add_runtime_dependency 'grape-entity', '~> 1'
+  s.add_runtime_dependency 'grape-swagger', '~> 2'
   s.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/grape-swagger/entity/attribute_parser.rb

@@ -10,41 +10,26 @@ module GrapeSwagger
       end
 
       def call(entity_options)
-        documentation = entity_options[:documentation]
-        entity_model = model_from(entity_options)
-
-        if entity_model
-          name = GrapeSwagger::Entity::Helper.model_name(entity_model, endpoint)
-
-          entity_model_type = entity_model_type(name, entity_options)
-          return entity_model_type unless documentation
-
-          add_extension_documentation(entity_model_type, documentation)
-          add_array_documentation(entity_model_type, documentation) if documentation[:is_array]
-
-          entity_model_type
-        else
-          param = data_type_from(entity_options)
-          return param unless documentation
+        param = if (entity_model = model_from(entity_options))
+                  name = GrapeSwagger::Entity::Helper.model_name(entity_model, endpoint)
+                  entity_model_type(name, entity_options)
+                else
+                  data_type_from(entity_options)
+                end
 
-          if (values = documentation[:values]) && values.is_a?(Array)
-            param[:enum] = values
-          end
+        documentation = entity_options[:documentation]
+        return param if documentation.nil?
 
-          if documentation[:is_array]
-            param = { type: :array, items: param }
-            add_array_documentation(param, documentation)
-          end
+        add_array_documentation(param, documentation) if documentation[:is_array]
 
-          add_attribute_sample(param, documentation, :default)
-          add_attribute_sample(param, documentation, :example)
+        add_attribute_sample(param, documentation, :default)
+        add_attribute_sample(param, documentation, :example)
 
-          add_attribute_documentation(param, documentation)
+        add_attribute_documentation(param, documentation)
 
-          add_extension_documentation(param, documentation)
-          add_discriminator_extension(param, documentation)
-          param
-        end
+        add_extension_documentation(param, documentation)
+        add_discriminator_extension(param, documentation)
+        param
       end
 
       private
@@ -73,13 +58,22 @@ module GrapeSwagger
           !type == Array
       end
 
-      def data_type_from(documentation)
-        documented_type = documentation[:type]
-        documented_type ||= documentation[:documentation] && documentation[:documentation][:type]
+      def data_type_from(entity_options)
+        documentation = entity_options[:documentation] || {}
+        documented_type = entity_options[:type] || documentation[:type]
 
         data_type = GrapeSwagger::DocMethods::DataType.call(documented_type)
 
-        document_data_type(documentation[:documentation], data_type)
+        documented_data_type = document_data_type(documentation, data_type)
+
+        if documentation[:is_array]
+          {
+            type: :array,
+            items: documented_data_type
+          }
+        else
+          documented_data_type
+        end
       end
 
       def document_data_type(documentation, data_type)
@@ -89,7 +83,12 @@ module GrapeSwagger
                else
                  { type: data_type }
                end
-        type[:format] = documentation[:format] if documentation&.key?(:format)
+
+        type[:format] = documentation[:format] if documentation.key?(:format)
+
+        if (values = documentation[:values]) && values.is_a?(Array)
+          type[:enum] = values
+        end
 
         type
       end
@@ -117,6 +116,15 @@ module GrapeSwagger
       end
 
       def add_attribute_documentation(param, documentation)
+        param[:minimum] = documentation[:minimum] if documentation.key?(:minimum)
+        param[:maximum] = documentation[:maximum] if documentation.key?(:maximum)
+
+        values = documentation[:values]
+        if values&.is_a?(Range)
+          param[:minimum] = values.begin if values.begin.is_a?(Numeric)
+          param[:maximum] = values.end if values.end.is_a?(Numeric)
+        end
+
         param[:minLength] = documentation[:min_length] if documentation.key?(:min_length)
         param[:maxLength] = documentation[:max_length] if documentation.key?(:max_length)
       end

data/lib/grape-swagger/entity/parser.rb

@@ -101,19 +101,22 @@ module GrapeSwagger
       end
 
       def parse_nested(entity_name, entity_options, parent_model = nil)
-        nested_entity = if parent_model.nil?
-                          model.root_exposures.find_by(entity_name)
-                        else
-                          parent_model.nested_exposures.find_by(entity_name)
-                        end
-
-        params = nested_entity.nested_exposures.each_with_object({}) do |value, memo|
+        nested_entities = if parent_model.nil?
+                            model.root_exposures.select_by(entity_name)
+                          else
+                            parent_model.nested_exposures.select_by(entity_name)
+                          end
+
+        params = nested_entities
+                 .map(&:nested_exposures)
+                 .flatten
+                 .each_with_object({}) do |value, memo|
           memo[value.attribute] = value.send(:options)
         end
 
-        properties, required = parse_grape_entity_params(params, nested_entity)
-        is_a_collection = entity_options[:documentation].is_a?(Hash) &&
-                          entity_options[:documentation][:type].to_s.casecmp('array').zero?
+        properties, required = parse_grape_entity_params(params, nested_entities.last)
+        documentation = entity_options[:documentation]
+        is_a_collection = documentation.is_a?(Hash) && documentation[:type].to_s.casecmp('array').zero?
 
         if is_a_collection
           {

data/lib/grape-swagger/entity/version.rb

@@ -2,6 +2,6 @@
 
 module GrapeSwagger
   module Entity
-    VERSION = '0.5.3'
+    VERSION = '0.5.5'
   end
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger-entity
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.5
 platform: ruby
 authors:
 - Kirill Zaitsev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-02 00:00:00.000000000 Z
+date: 2024-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape-entity
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: grape-swagger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '2'
 description:
 email:
 - kirik910@gmail.com
@@ -80,14 +80,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Grape swagger adapter to support grape-entity object parsing