grape-swagger-entity 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09decfdceca7643d9cf6df2f34843a5643d62a56
-  data.tar.gz: ab8bbcc2c2d29802747f35848165abcf85407a4d
+  metadata.gz: 72459a987fb7696ab9b9af64da1bcbcd6e1b2de3
+  data.tar.gz: 9c401e5bcab37c4fb90af2b3faf4d5226953f5fa
 SHA512:
-  metadata.gz: 5eeada88bb46cdc9b84157c0bc75b207f6f05f99fc9378c8c73a8d03d08ac83192a91d3cefab8a996d60ffb57e3b5ac51d1caee25c8692b845d9068616da9de1
-  data.tar.gz: 6847991544fa81362e9deab7df204f38059fb49dca0f72a84ff94d6179d2f9ce7416262b138f30bc1fce0b3cb2e74439a5ed4f8da88cbafc5a58e328be4a7592
+  metadata.gz: 0df830bd1242402544528d473051715e12d5ee82650849582b1126de32048e2b0547478334394559ef584b7c38e7ebb11fa62e0435f6e2da7e6220e6ff36b0b2
+  data.tar.gz: 0b2c212b1580bba2706ca2e116e7f32b1ef50acb083e92191f2ec77363c6839017ac26705b874f81271a4d2d98d721c8c446e8d670ac500490362500445e5fbd

data/.rubocop.yml

@@ -3,3 +3,18 @@ AllCops:
     - vendor/**/*
 
 inherit_from: .rubocop_todo.yml
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+Metrics/LineLength:
+  Exclude:
+    - spec/**/*
+
+Metrics/MethodLength:
+  Exclude:
+    - spec/**/*
+
+Style/IndentHash:
+  EnforcedStyle: consistent

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-06-08 01:18:12 +0300 using RuboCop version 0.40.0.
+# on 2017-02-02 15:42:44 +0100 using RuboCop version 0.47.1.
 # 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
@@ -8,37 +8,42 @@
 
 # Offense count: 1
 Metrics/AbcSize:
-  Max: 48
+  Max: 45
+
+# Offense count: 8
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 27
 
 # Offense count: 1
 Metrics/CyclomaticComplexity:
-  Max: 16
+  Max: 14
 
-# Offense count: 50
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# Offense count: 11
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:
-  Max: 136
+  Max: 120
 
 # Offense count: 2
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 42
+  Max: 30
 
 # Offense count: 1
 Metrics/PerceivedComplexity:
-  Max: 18
+  Max: 16
 
 # Offense count: 2
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
-    - 'test/**/*'
     - 'lib/grape-swagger/entity.rb'
     - 'lib/grape-swagger/entity/parser.rb'
 
 # Offense count: 1
-# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts.
+# 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
 Style/FileName:
   Exclude:
     - 'lib/grape-swagger-entity.rb'

data/.travis.yml

@@ -1,30 +1,31 @@
-language: ruby
+before_install:
+  - gem update --system
+  - gem install bundler
 
-cache: bundler
+after_success:
+  - bundle exec danger
+
+rvm:
+  - 2.4.0
+  - 2.3.3
+  - 2.2.6
+
+env:
+  - GRAPE_ENTITY=0.5.2
+  - GRAPE_ENTITY=0.6.1
 
 matrix:
+  fast_finish: true
+
   include:
-    - rvm: 2.3.0
-      script:
-        - bundle exec danger
-    - rvm: 2.3.0
-      env:
-        - GRAPE_ENTITY="~> 0.4.0"
-    - rvm: 2.3.0
-      env:
-        - GRAPE_ENTITY="~> 0.5.0"
-    - rvm: 2.3.0
-      env:
-        - GRAPE_ENTITY="~> 0.6.0"
-    - rvm: 2.2
-    - rvm: 2.1
-    - rvm: jruby-9.1.2.0
     - rvm: ruby-head
+      env:
     - rvm: jruby-head
+      env:
     - rvm: rbx-2
+      env:
+
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head
     - rvm: rbx-2
-
-before_install: gem install bundler -v 1.12.1

data/CHANGELOG.md

@@ -8,6 +8,13 @@
 
 * Your contribution here.
 
+### 0.1.6 (February 3, 2017)
+
+#### Features
+
+* [#21](https://github.com/ruby-grape/grape-swagger-entity/pull/21): Adds support for own format - [@LeFnord](https://github.com/LeFnord).
+* [#19](https://github.com/ruby-grape/grape-swagger-entity/pull/19): Adds support for default value - [@LeFnord](https://github.com/LeFnord).
+
 ### 0.1.5 (November 21, 2016)
 
 #### Features

data/Gemfile

@@ -3,11 +3,21 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in grape-swagger-entity.gemspec
 gemspec
 
-gem 'grape-entity', ENV.fetch('GRAPE_ENTITY', '0.5.0')
-gem 'grape-swagger', github: 'ruby-grape/grape-swagger'
-gem 'ruby-grape-danger', '~> 0.1.0', require: false
+group :development, :test do
+  gem 'bundler'
+  gem 'pry', platforms: [:mri]
+  gem 'pry-byebug', platforms: [:mri]
+  gem 'rack'
+  gem 'rack-cors'
+  gem 'rack-test'
+  gem 'rake'
+  gem 'rdoc'
+  gem 'rspec', '~> 3.0'
+  gem 'rubocop', '~> 0.46'
+end
 
-if RUBY_VERSION < '2.2.2'
-  gem 'rack', '<2.0.0'
-  gem 'activesupport', '<5.0.0'
+group :test do
+  gem 'grape-entity', ENV.fetch('GRAPE_ENTITY', '0.6.1')
+  gem 'ruby-grape-danger', '~> 0.1.1', require: false
+  gem 'simplecov', require: false
 end

data/Rakefile

@@ -1,6 +1,18 @@
-require 'bundler/gem_tasks'
+require 'rubygems'
+require 'bundler'
+
+Bundler.setup(:default, :development)
+
+require 'rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+
+task default: [:spec, :rubocop]

data/grape-swagger-entity.gemspec

@@ -18,17 +18,7 @@ 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.2.6'
   s.add_runtime_dependency 'grape-swagger', '>= 0.20.4'
   s.add_runtime_dependency 'grape-entity'
-
-  s.add_development_dependency 'bundler', '~> 1.12'
-  s.add_development_dependency 'rake', '~> 10.0'
-  s.add_development_dependency 'rspec', '~> 3.0'
-  s.add_development_dependency 'rack-test'
-  s.add_development_dependency 'rack-cors'
-  s.add_development_dependency 'rubocop', '0.40.0'
-  s.add_development_dependency 'redcarpet' unless RUBY_PLATFORM.eql?('java') || RUBY_ENGINE.eql?('rbx')
-  s.add_development_dependency 'rouge' unless RUBY_PLATFORM.eql?('java') || RUBY_ENGINE.eql?('rbx')
-  s.add_development_dependency 'pry' unless RUBY_PLATFORM.eql?('java') || RUBY_ENGINE.eql?('rbx')
-  s.add_development_dependency 'pry-byebug' unless RUBY_PLATFORM.eql?('java') || RUBY_ENGINE.eql?('rbx')
 end

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

@@ -12,6 +12,7 @@ module GrapeSwagger
       def call
         # TODO: this should only be a temporary hack ;)
         if ::GrapeEntity::VERSION =~ /0\.4\.\d/
+          warn 'usage of grape-entity <0.5.0 is deprecated'
           parameters = model.exposures ? model.exposures : model.documentation
         else
           parameters = model.root_exposures.each_with_object({}) do |value, memo|
@@ -31,43 +32,23 @@ module GrapeSwagger
           next if entity_options.fetch(:documentation, {}).fetch(:in, nil).to_s == 'header'
 
           entity_name = entity_options[:as] if entity_options[:as]
-          model = entity_options[:using] if entity_options[:using].present?
-
-          if entity_options[:documentation] && could_it_be_a_model?(entity_options[:documentation])
-            model ||= entity_options[:documentation][:type]
-          end
+          documentation = entity_options[:documentation]
+          model = model_from(entity_options)
 
           if model
             name = endpoint.nil? ? model.to_s.demodulize : endpoint.send(:expose_params_from_model, model)
             memo[entity_name] = entity_model_type(name, entity_options)
           else
-            documented_type = entity_options[:type]
-
-            if entity_options[:documentation]
-              documented_type ||= entity_options[:documentation][:type]
-            end
-
-            data_type = GrapeSwagger::DocMethods::DataType.call(documented_type)
-
-            if GrapeSwagger::DocMethods::DataType.primitive?(data_type)
-              data = GrapeSwagger::DocMethods::DataType.mapping(data_type)
+            memo[entity_name] = data_type_from(entity_options)
+            next unless documentation
 
-              memo[entity_name] = {
-                type: data.first,
-                format: data.last
-              }
-            else
-              memo[entity_name] = {
-                type: data_type
-              }
-            end
+            memo[entity_name][:default] = documentation[:default] if documentation[:default]
 
-            if entity_options[:documentation] && entity_options[:documentation][:values]
-              values = entity_options[:documentation][:values]
+            if (values = documentation[:values])
               memo[entity_name][:enum] = values if values.is_a?(Array)
             end
 
-            if entity_options[:documentation] && entity_options[:documentation][:is_array]
+            if documentation[:is_array]
               memo[entity_name] = {
                 type: :array,
                 items: memo.delete(entity_name)
@@ -75,13 +56,22 @@ module GrapeSwagger
             end
           end
 
-          if entity_options[:documentation] && entity_options[:documentation][:desc]
-            memo[entity_name][:description] = entity_options[:documentation][:desc]
-          end
+          memo[entity_name][:description] = documentation[:desc] if documentation && documentation[:desc]
         end
       end
 
+      def model_from(entity_options)
+        model = entity_options[:using] if entity_options[:using].present?
+
+        if could_it_be_a_model?(entity_options[:documentation])
+          model ||= entity_options[:documentation][:type]
+        end
+
+        model
+      end
+
       def could_it_be_a_model?(value)
+        return false if value.nil?
         direct_model_type?(value[:type]) || ambiguous_model_type?(value[:type])
       end
 
@@ -96,6 +86,27 @@ module GrapeSwagger
           !type == Array
       end
 
+      def data_type_from(documentation)
+        documented_type = documentation[:type]
+        documented_type ||= (documentation[:documentation] && documentation[:documentation][:type])
+
+        data_type = GrapeSwagger::DocMethods::DataType.call(documented_type)
+
+        document_data_type(documentation[:documentation], data_type)
+      end
+
+      def document_data_type(documentation, data_type)
+        type = if GrapeSwagger::DocMethods::DataType.primitive?(data_type)
+                 data = GrapeSwagger::DocMethods::DataType.mapping(data_type)
+                 { type: data.first, format: data.last }
+               else
+                 { type: data_type }
+               end
+        type[:format] = documentation[:format] if documentation && documentation.key?(:format)
+
+        type
+      end
+
       def entity_model_type(name, entity_options)
         if entity_options[:documentation] && entity_options[:documentation][:is_array]
           {

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

@@ -1,5 +1,5 @@
 module GrapeSwagger
   module Entity
-    VERSION = '0.1.5'.freeze
+    VERSION = '0.1.6'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger-entity
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Kirill Zaitsev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-21 00:00:00.000000000 Z
+date: 2017-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape-swagger
@@ -38,146 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.12'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rack-test
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rack-cors
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.40.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.40.0
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rouge
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: 
 email:
 - kirik910@gmail.com
@@ -215,7 +75,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.6
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="