grape-swagger-representable 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a32638e1d76f204f7fedca553383f47649cf8b99
-  data.tar.gz: ed4d7d8e9334ed7eeea881178b624b72406508a1
+  metadata.gz: 16bed46317a7ff343cc6c63c61b53ed61e569b34
+  data.tar.gz: b65dd960b7ea15d0daa0ab3a1efcee5baa03e792
 SHA512:
-  metadata.gz: 439da9af2778912cd95009a3352b91113bee8d04e94b36bfce3fe0586e1b1dc989f384389968669251eca0c0db46cf2bfe3cb3afe72f55c9ae02514a976b801a
-  data.tar.gz: 63a8711f3ef43c7f786c52d103f9a9d635ad7c6f26b02e911a7202256974def908a8aa8fbd6819a0cf56577dbd2fffb0961a28ed4748bec6d1ff6377da7f5837
+  metadata.gz: 5d9c600e84a70795644fa23e80a7a620d77da1490bda16b7f858f1bc14355779163e821846e3459c768101fc99459b6c1317fe4d2956d463cdca7f3760edf9f2
+  data.tar.gz: 37d417d8eaf1a7a57a397095d2d4978f4a11a369734d566263c4efb689b80492a5ecab2392dfeb7716532913916e36c5201aa971ec72af19ca31f29f2bd14b44

data/.rubocop.yml

@@ -1,5 +1,34 @@
 AllCops:
   Exclude:
     - vendor/**/*
+  TargetRubyVersion: 2.4
 
 inherit_from: .rubocop_todo.yml
+
+Layout/EmptyLinesAroundArguments:
+  Enabled: false
+
+Layout/IndentHash:
+  EnforcedStyle: consistent
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+Metrics/ClassLength:
+  Max: 300
+
+Metrics/LineLength:
+  Max: 120
+  Exclude:
+    - spec/**/*
+
+Metrics/MethodLength:
+  Exclude:
+    - spec/**/*
+
+Naming:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false

data/.rubocop_todo.yml

@@ -1,34 +1,29 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2017-11-19 22:40:01 +0200 using RuboCop version 0.51.0.
+# on 2018-08-21 15:46:20 +0300 using RuboCop version 0.58.2.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 2
+# Offense count: 3
 Metrics/AbcSize:
-  Max: 34
-
-# Offense count: 8
-# Configuration parameters: CountComments, ExcludedMethods.
-Metrics/BlockLength:
-  Max: 132
+  Max: 39
 
 # Offense count: 2
 Metrics/CyclomaticComplexity:
-  Max: 15
+  Max: 19
 
-# Offense count: 67
+# Offense count: 2
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:
-  Max: 160
+  Max: 130
 
 # Offense count: 2
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 36
+  Max: 35
 
 # Offense count: 1
 # Configuration parameters: CountKeywordArgs.
@@ -37,14 +32,7 @@ Metrics/ParameterLists:
 
 # Offense count: 2
 Metrics/PerceivedComplexity:
-  Max: 18
-
-# Offense count: 1
-# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts, AllowedAcronyms.
-# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
-Naming/FileName:
-  Exclude:
-    - 'lib/grape-swagger-representable.rb'
+  Max: 21
 
 # Offense count: 2
 Style/Documentation:

data/Gemfile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in grape-swagger-representable.gemspec
 gemspec
 
-gem 'grape-swagger', github: 'ruby-grape/grape-swagger'
+gem 'grape-swagger', git: 'https://github.com/ruby-grape/grape-swagger.git'

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/bin/pry

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'grape-swagger/representable'

data/grape-swagger-representable.gemspec

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'grape-swagger/representable/version'
 
@@ -18,7 +19,7 @@ Gem::Specification.new do |s|
   s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.add_runtime_dependency 'grape-swagger', '>= 0.20.4'
+  s.add_runtime_dependency 'grape-swagger', '>= 0.31.0'
   s.add_runtime_dependency 'representable'
 
   s.add_development_dependency 'bundler', '~> 1.12'

data/lib/grape-swagger-representable.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'grape-swagger/representable'

data/lib/grape-swagger/representable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'grape-swagger'
 require 'representable'
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GrapeSwagger
   module Representable
     class Parser
@@ -75,33 +77,60 @@ module GrapeSwagger
             }
           end
         else
-          attributes = parse_representer(representer)
-          attributes = attributes.deep_merge!(parse_representer(nested)) if nested
+          attributes, required = combine(representer, nested)
 
           if is_a_collection
             {
               type: :array,
-              items: {
+              items: with_required({
                 type: :object,
                 properties: attributes
-              },
+              }, required),
               description: documentation[:desc] || property[:desc] || ''
             }
           else
-            {
+            with_required({
               type: :object,
               properties: attributes,
               description: documentation[:desc] || property[:desc] || ''
-            }
+            }, required)
           end
         end
       end
 
       def parse_representer(representer)
-        representer.map.each_with_object({}) do |value, property|
+        properties = representer.map.each_with_object({}) do |value, property|
           property_name = value[:as].try(:call) || value.name
           property[property_name] = parse_representer_property(value)
         end
+
+        required = representer.map
+                              .select { |value| value[:documentation] && value[:documentation][:required] }
+                              .map { |value| value[:as] || value.name }
+
+        [properties, required]
+      end
+
+      def combine(representer, nested)
+        attributes, required = parse_representer(representer)
+        return [attributes, required] unless nested
+
+        nested_attributes, nested_required = parse_representer(nested) if nested
+        final_attributes = attributes.deep_merge!(nested_attributes)
+
+        overrided = (attributes.keys & nested_attributes.keys)
+
+        final_required = (required + nested_required)
+                         .uniq
+                         .select { |k| (overrided.include?(k) && nested_required.include?(k)) || !overrided.include?(k) }
+
+        [final_attributes, final_required]
+      end
+
+      def with_required(hash, required)
+        return hash if required.empty?
+        hash[:required] = required
+        hash
       end
     end
   end

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

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module GrapeSwagger
   module Representable
-    VERSION = '0.1.6'.freeze
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger-representable
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - Kirill Zaitsev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-14 00:00:00.000000000 Z
+date: 2018-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape-swagger
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.20.4
+        version: 0.31.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.20.4
+        version: 0.31.0
 - !ruby/object:Gem::Dependency
   name: representable
   requirement: !ruby/object:Gem::Requirement