grape-swagger-entity 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 05c52de504600d57fb8bb41dff26265beb90d32e
-  data.tar.gz: 6b829aae12775c2f27521cf08be88f56298158d5
+SHA256:
+  metadata.gz: 9cbc9a4f5350f907024319ec60d6bebcf58c1d9a9fbe0a87157eb521f5d90c27
+  data.tar.gz: d70650e560a98a5c8e6299136146796d87bb8e124944c2b09603ddcab415085a
 SHA512:
-  metadata.gz: 9dc4d2973ef5f678eddce41c1c5a393f26267cf177b6f2973fd804d278adaa0c5c065cd4ac7b5a8006d561a896350064f96f10043f144071d51e1b402279dcc9
-  data.tar.gz: a5b0c18af91a1c16c6f8c2d834950dcc82885e375c29b3b6c3547d7481718c31b59fb157aa233e0a49ad6eb9e292001c6a241e2a1e933e092ea872120dd1f16d
+  metadata.gz: 4fffce9cc2ae49583807c9e02a5ed6d0c6fdbd1e3acc2f4816868b292fb8ae0e77161bd4736dcb2d91e30633a814cd8fd31c2f21af9fec12cc4cec8243bb5ce1
+  data.tar.gz: 2c5cdf2184fefbd92fda6b7f65d95d31f0c331e225be2439b5fa2f6d711a7754890271b7a41b06cdd36c44d3bcace9b836cd727c93b21892e6ae9651badb712a

data/.gitignore

@@ -7,3 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+.ruby-gemset
+.ruby-version

data/.rubocop.yml

@@ -18,8 +18,8 @@ Metrics/MethodLength:
   Exclude:
     - spec/**/*
 
-Style/FileName:
+Naming/FileName:
   Enabled: false
 
-Style/IndentHash:
+Layout/IndentFirstHashElement:
   EnforcedStyle: consistent

data/.travis.yml

@@ -10,18 +10,19 @@ after_success:
   - bundle exec danger
 
 rvm:
-  - 2.4.2
-  - 2.3.5
+  - 2.4.5
+  - 2.5.3
+  - 2.6.0
 
 env:
-  - GRAPE_ENTITY=0.5.2
   - GRAPE_ENTITY=0.6.1
+  - GRAPE_ENTITY=0.7.1
 
 matrix:
   fast_finish: true
 
   include:
-    - rvm: 2.2.8
+    - rvm: 2.3.8
       env:
     - rvm: ruby-head
       env:
@@ -31,7 +32,7 @@ matrix:
       env:
 
   allow_failures:
-    - rvm: 2.2.8
+    - rvm: 2.3.8
     - rvm: ruby-head
     - rvm: jruby-head
     - rvm: rbx-2

data/CHANGELOG.md

@@ -4,10 +4,45 @@
 
 * Your contribution here.
 
-#### Fixes
+#### Features
 
 * Your contribution here.
 
+### 0.4.0 (May 30, 2020)
+
+#### Features
+
+* [#49](https://github.com/ruby-grape/grape-swagger-entity/pull/49): Bumped minimal required version of grape-swagger to 1.0.0 - [@Bugagazavr](https://github.com/Bugagazavr).
+* [#48](https://github.com/ruby-grape/grape-swagger-entity/pull/48): Add support for extensions - [@MaximeRDY](https://github.com/MaximeRDY).
+
+#### Fixes
+
+* [#46](https://github.com/ruby-grape/grape-swagger-entity/pull/46): Fixed issue where a boolean example value of false would not display in swagger file - [@drewnichols](https://github.com/drewnichols).
+
+### 0.3.4 (January 9, 2020)
+
+#### Features
+
+* [#40](https://github.com/ruby-grape/grape-swagger-entity/pull/40): Add support for minLength and maxLength - [@fotos](https://github.com/fotos).
+
+### 0.3.3 (Fabruary 22, 2019)
+
+#### Features
+
+* [#39](https://github.com/ruby-grape/grape-swagger-entity/pull/39): Fix to avoid conflict with polymorphic model - [@kinoppyd](https://github.com/kinoppyd).
+
+### 0.3.2 (January 15, 2019)
+
+#### Features
+
+* [#38](https://github.com/ruby-grape/grape-swagger-entity/pull/38): Added support for hidden option for documentation - [@vitoravelino](https://github.com/vitoravelino).
+
+### 0.3.1 (November 26, 2018)
+
+#### Features
+
+* [#37](https://github.com/ruby-grape/grape-swagger-entity/pull/37): Add support for minItems, maxItems and uniqueItems - [@fotos](https://github.com/fotos).
+
 ### 0.3.0 (August 22, 2018)
 
 #### Features

data/Gemfile

@@ -13,7 +13,7 @@ group :development, :test do
   gem 'rake'
   gem 'rdoc'
   gem 'rspec', '~> 3.0'
-  gem 'rubocop', '~> 0.48'
+  gem 'rubocop', '~> 0.68.1'
 end
 
 gem 'grape-swagger', git: 'https://github.com/ruby-grape/grape-swagger.git'

data/README.md

@@ -26,7 +26,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/grape-swagger-entity.
+Bug reports and pull requests are welcome on GitHub at https://github.com/ruby-grape/grape-swagger-entity.
 
 ## License
 

data/grape-swagger-entity.gemspec

@@ -19,5 +19,5 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.2.6'
   s.add_runtime_dependency 'grape-entity', '>= 0.5.0'
-  s.add_runtime_dependency 'grape-swagger', '>= 0.31.0'
+  s.add_runtime_dependency 'grape-swagger', '>= 1.0.0'
 end

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

@@ -13,19 +13,33 @@ module GrapeSwagger
 
         if entity_model
           name = endpoint.nil? ? entity_model.to_s.demodulize : endpoint.send(:expose_params_from_model, entity_model)
-          return entity_model_type(name, entity_options)
+
+          entity_model_type = entity_model_type(name, entity_options)
+          return entity_model_type unless 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[:default] = documentation[:default] if documentation[:default]
-          add_attribute_example(param, documentation[:example])
+          add_attribute_sample(param, documentation, :default)
+          add_attribute_sample(param, documentation, :example)
 
           if (values = documentation[:values])
             param[:enum] = values if values.is_a?(Array)
           end
 
-          param = { type: :array, items: param } if documentation[:is_array]
+          if documentation[:is_array]
+            param = { type: :array, items: param }
+            add_array_documentation(param, documentation)
+          end
+
+          add_attribute_documentation(param, documentation)
+
+          add_extension_documentation(param, documentation)
+
           param
         end
       end
@@ -42,6 +56,7 @@ module GrapeSwagger
 
       def could_it_be_a_model?(value)
         return false if value.nil?
+
         direct_model_type?(value[:type]) || ambiguous_model_type?(value[:type])
       end
 
@@ -92,9 +107,26 @@ module GrapeSwagger
         end
       end
 
-      def add_attribute_example(attribute, example)
-        return unless example
-        attribute[:example] = example.is_a?(Proc) ? example.call : example
+      def add_attribute_sample(attribute, hash, key)
+        value = hash[key]
+        return if value.nil?
+
+        attribute[key] = value.is_a?(Proc) ? value.call : value
+      end
+
+      def add_attribute_documentation(param, documentation)
+        param[:minLength] = documentation[:min_length] if documentation.key?(:min_length)
+        param[:maxLength] = documentation[:max_length] if documentation.key?(:max_length)
+      end
+
+      def add_array_documentation(param, documentation)
+        param[:minItems] = documentation[:min_items] if documentation.key?(:min_items)
+        param[:maxItems] = documentation[:max_items] if documentation.key?(:max_items)
+        param[:uniqueItems] = documentation[:unique_items] if documentation.key?(:unique_items)
+      end
+
+      def add_extension_documentation(param, documentation)
+        GrapeSwagger::DocMethods::Extensions.add_extensions_to_root(documentation, param)
       end
     end
   end

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

@@ -17,6 +17,14 @@ module GrapeSwagger
 
       private
 
+      class Alias
+        attr_reader :original, :renamed
+        def initialize(original, renamed)
+          @original = original
+          @renamed = renamed
+        end
+      end
+
       def extract_params(exposure)
         exposure.root_exposures.each_with_object({}) do |value, memo|
           if value.for_merge && (value.respond_to?(:entity_class) || value.respond_to?(:using_class_name))
@@ -25,7 +33,8 @@ module GrapeSwagger
             extracted_params = extract_params(entity_class)
             memo.merge!(extracted_params)
           else
-            memo[value.attribute] = value.send(:options)
+            opts = value.send(:options)
+            opts[:as] ? memo[Alias.new(value.attribute, opts[:as])] = opts : memo[value.attribute] = opts
           end
         end
       end
@@ -34,8 +43,12 @@ module GrapeSwagger
         return unless params
 
         parsed = params.each_with_object({}) do |(entity_name, entity_options), memo|
-          next if entity_options.fetch(:documentation, {}).fetch(:in, nil).to_s == 'header'
+          documentation_options = entity_options.fetch(:documentation, {})
+          in_option = documentation_options.fetch(:in, nil).to_s
+          hidden_option = documentation_options.fetch(:hidden, nil)
+          next if in_option == 'header' || hidden_option == true
 
+          entity_name = entity_name.original if entity_name.is_a?(Alias)
           final_entity_name = entity_options.fetch(:as, entity_name)
           documentation = entity_options[:documentation]
 
@@ -46,6 +59,7 @@ module GrapeSwagger
                                     end
 
           next unless documentation
+
           memo[final_entity_name][:readOnly] = documentation[:read_only].to_s == 'true' if documentation[:read_only]
           memo[final_entity_name][:description] = documentation[:desc] if documentation[:desc]
         end
@@ -92,6 +106,7 @@ module GrapeSwagger
 
       def with_required(hash, required)
         return hash if required.empty?
+
         hash[:required] = required
         hash
       end

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

@@ -1,5 +1,5 @@
 module GrapeSwagger
   module Entity
-    VERSION = '0.3.0'.freeze
+    VERSION = '0.4.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger-entity
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Kirill Zaitsev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-22 00:00:00.000000000 Z
+date: 2020-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape-entity
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.31.0
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.31.0
+        version: 1.0.0
 description: 
 email:
 - kirik910@gmail.com
@@ -83,8 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Grape swagger adapter to support grape-entity object parsing