grape-swagger-representable 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4cc53d3a9f4691c61f82404cbb1bc1eb22244f15
-  data.tar.gz: a035996a8b63edd7ed75da0c228e1bb3317bbf1f
+SHA256:
+  metadata.gz: 44362c5a48cb9109ec550ebc8d2face95801d9e0464929856454ac6309c81218
+  data.tar.gz: eb9f6e0962aee963907d9953b7b8aba9d9b5caaff24a78a370459f2f6b4fcbc1
 SHA512:
-  metadata.gz: 8d12ba65e634f56961439ad6c1f0846a1e98e13dcac097b94b3f9b6f241f6490ad5471f4cd40cb33a52b4907bac6c98f8cba9745be4f14deb4a251e10696863d
-  data.tar.gz: e29651950c2d4c52472719423ee3940ba9a5d6aa5d72ca242c5fb3e293a06375815b413e4def3daebc1bc90475adeda21f8b6e501e648f1cb6690ffc92d98583
+  metadata.gz: 2be378bd6bdc2b8963373a83efa30f408979572376fd3f460d5495b92306315b007b3f837f4ef8dc6e2883772a0ef78935a1e30fcecf02f0ee670b8137e46132
+  data.tar.gz: 65dadaa81529fed71e46898f9078aab0d1ce6c3d448cfb6ac9e074adffee0a0b0ba553bd1ee2c15af701ba077f11b68dbedaa3aef6f27034f22d0c8fb3ba6cd1

data/.editorconfig

@@ -0,0 +1,14 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+max_line_length = 120
+
+[*.md]
+indent_style = space
+indent_size = 4

data/.github/workflows/danger-comment.yml

@@ -0,0 +1,16 @@
+name: Danger Comment
+
+on:
+  workflow_run:
+    workflows: [Danger]
+    types: [completed]
+
+permissions:
+  contents: read
+  actions: read
+  issues: write
+  pull-requests: write
+
+jobs:
+  comment:
+    uses: numbata/danger-pr-comment/.github/workflows/danger-comment.yml@v0.1.0

data/.github/workflows/danger.yml

@@ -0,0 +1,15 @@
+name: Danger
+
+on:
+  pull_request:
+    types: [opened, reopened, edited, synchronize]
+
+permissions:
+  contents: read
+
+jobs:
+  danger:
+    uses: numbata/danger-pr-comment/.github/workflows/danger-run.yml@v0.1.0
+    with:
+      ruby-version: '3.4'
+      bundler-cache: true

data/.github/workflows/rubocop.yml

@@ -0,0 +1,17 @@
+name: RuboCop
+on: [push, pull_request]
+permissions:
+  contents: read
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '4.0'
+          bundler-cache: true
+      - run: bundle exec rubocop

data/.github/workflows/test.yml

@@ -0,0 +1,48 @@
+name: Tests
+on: [push, pull_request]
+permissions:
+  contents: read
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - { ruby: '3.1', grape: '~> 2.4', representable: '~> 3.2.0' }
+          - { ruby: '3.3', grape: '~> 2.4', representable: '~> 3.3' }
+          - { ruby: '3.3', grape: '~> 3.0', representable: '~> 3.3' }
+          - { ruby: '3.4', grape: '~> 4.0', representable: '~> 3.3' }
+          - { ruby: '4.0', grape: '~> 4.0', representable: '~> 3.3' }
+    name: Ruby ${{ matrix.ruby }} / Grape ${{ matrix.grape }}
+    env:
+      GRAPE_VERSION: ${{ matrix.grape }}
+      REPRESENTABLE_VERSION: ${{ matrix.representable }}
+    steps:
+      - uses: actions/checkout@v7
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake spec
+      - name: Coveralls
+        uses: coverallsapp/github-action@v2
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          file: coverage/lcov.info
+          format: lcov
+          flag-name: ruby-${{ matrix.ruby }}-grape-${{ strategy.job-index }}
+          parallel: true
+  finish:
+    name: Finish Coveralls
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: coverallsapp/github-action@v2
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          parallel-finished: true

data/.rspec

@@ -1,2 +1,4 @@
+--require spec_helper.rb
 --format documentation
 --color
+--warnings

data/.rubocop.yml

@@ -1,16 +1,20 @@
 AllCops:
+  NewCops: enable
   Exclude:
     - vendor/**/*
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 3.1
 
 inherit_from: .rubocop_todo.yml
 
 Layout/EmptyLinesAroundArguments:
   Enabled: false
 
-Layout/IndentHash:
+Layout/FirstHashElementIndentation:
   EnforcedStyle: consistent
 
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
 Metrics/BlockLength:
   Exclude:
     - spec/**/*
@@ -18,7 +22,7 @@ Metrics/BlockLength:
 Metrics/ClassLength:
   Max: 300
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 120
   Exclude:
     - spec/**/*

data/.rubocop_todo.yml

@@ -17,7 +17,7 @@ Metrics/CyclomaticComplexity:
 # Offense count: 2
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
-Metrics/LineLength:
+Layout/LineLength:
   Max: 130
 
 # Offense count: 2

data/.simplecov

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'simplecov-lcov'
+
+SimpleCov::Formatter::LcovFormatter.config.report_with_single_file = true
+SimpleCov::Formatter::LcovFormatter.config.single_report_path = 'coverage/lcov.info'
+SimpleCov.formatter = ENV['CI'] ? SimpleCov::Formatter::LcovFormatter : SimpleCov::Formatter::HTMLFormatter
+
+SimpleCov.configure do
+  enable_coverage :branch
+  add_filter '/spec/'
+  track_files 'lib/**/*.rb'
+end

data/CHANGELOG.md

@@ -0,0 +1,46 @@
+### 0.3.0 (2026/10/27)
+
+* [#14](https://github.com/ruby-grape/grape-swagger-representable/pull/14): Modernize dependencies, gem metadata, and specifications - [@AlexWayfer](https://github.com/AlexWayfer).
+* [#14](https://github.com/ruby-grape/grape-swagger-representable/pull/14): Require Ruby 3.1 or newer, support Ruby 4.0, and replace Travis with GitHub Actions testing Grape 2/3/4 and Representable 3.2/latest 3.x with Coveralls coverage - [@dblock](https://github.com/dblock).
+* [#15](https://github.com/ruby-grape/grape-swagger-representable/pull/15): Add a changelog and tokenless Danger checks for pull request changelog entries - [@dblock](https://github.com/dblock).
+* Add release preparation and publication instructions in `RELEASING.md` - [@dblock](https://github.com/dblock).
+
+### 0.2.2 (2018/09/22)
+
+* [#13](https://github.com/ruby-grape/grape-swagger-representable/pull/13): Support hidden properties - [@onemanstartup](https://github.com/onemanstartup).
+
+### 0.2.1 (2018/09/01)
+
+* [#12](https://github.com/ruby-grape/grape-swagger-representable/pull/12): Support Procs for enum values - [@onemanstartup](https://github.com/onemanstartup).
+
+### 0.2.0 (2018/08/22)
+
+* [#11](https://github.com/ruby-grape/grape-swagger-representable/pull/11): Document required properties, including nested representers - [@kzaitsev](https://github.com/kzaitsev).
+
+### 0.1.6 (2018/03/14)
+
+* [#9](https://github.com/ruby-grape/grape-swagger-representable/pull/9): Honor property aliases specified with `:as` - [@jpsikorra](https://github.com/jpsikorra).
+
+### 0.1.5 (2017/11/21)
+
+* [#7](https://github.com/ruby-grape/grape-swagger-representable/pull/7): Support property examples - [@yewton](https://github.com/yewton).
+
+### 0.1.4 (2017/03/10)
+
+* [#4](https://github.com/ruby-grape/grape-swagger-representable/pull/4): Use property attributes when the corresponding documentation attributes are absent - [@Kris-LIBIS](https://github.com/Kris-LIBIS).
+
+### 0.1.3 (2016/05/16)
+
+* [#3](https://github.com/ruby-grape/grape-swagger-representable/pull/3): Update the minimum grape-swagger version - [@kzaitsev](https://github.com/kzaitsev).
+
+### 0.1.2 (2016/05/11)
+
+* Version-only release - [@kzaitsev](https://github.com/kzaitsev).
+
+### 0.1.1 (2016/05/11)
+
+* [#1](https://github.com/ruby-grape/grape-swagger-representable/pull/1): Add autoload support - [@kzaitsev](https://github.com/kzaitsev).
+
+### 0.1.0 (2016/05/11)
+
+* Initial public release - [@kzaitsev](https://github.com/kzaitsev).

data/Dangerfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+danger.import_dangerfile(gem: 'danger-pr-comment')
+
+if git.added_files.include?('CHANGELOG.md')
+  # Allow the initial changelog to document previously released versions.
+  changelog.check!(unreleased_heading: nil)
+else
+  changelog.check!
+end

data/Gemfile

@@ -5,4 +5,21 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in grape-swagger-representable.gemspec
 gemspec
 
-gem 'grape-swagger', git: 'https://github.com/ruby-grape/grape-swagger.git'
+gem 'grape', ENV.fetch('GRAPE_VERSION', '>= 2.1')
+gem 'grape-swagger', ENV.fetch('GRAPE_SWAGGER_VERSION', '>= 0')
+gem 'json', '< 3' if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('3.2')
+gem 'multi_json'
+gem 'pry'
+gem 'rack-test'
+gem 'rake'
+gem 'representable', ENV.fetch('REPRESENTABLE_VERSION', '>= 0')
+gem 'rspec', '~> 3.0'
+gem 'rubocop'
+gem 'simplecov', require: false
+gem 'simplecov-lcov', require: false
+
+group :danger do
+  gem 'danger', require: false
+  gem 'danger-changelog', require: false
+  gem 'danger-pr-comment', '~> 0.1.0', require: false
+end

data/README.md

@@ -1,6 +1,9 @@
-# GrapeSwagger::Representable [![Build Status](https://travis-ci.org/ruby-grape/grape-swagger-representable.svg)](https://travis-ci.org/ruby-grape/grape-swagger-representable)
+# GrapeSwagger::Representable
 
-A simple grape-swagger adapter to allow parse representers as response model
+[![Tests](https://github.com/ruby-grape/grape-swagger-representable/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/ruby-grape/grape-swagger-representable/actions/workflows/test.yml)
+[![Coverage Status](https://coveralls.io/repos/github/ruby-grape/grape-swagger-representable/badge.svg?branch=master)](https://coveralls.io/github/ruby-grape/grape-swagger-representable?branch=master)
+
+A [grape-swagger](https://github.com/ruby-grape/grape-swagger) adapter that documents [Representable](https://github.com/trailblazer/representable) decorators as Swagger response models.
 
 ## Installation
 
@@ -20,15 +23,24 @@ Or install it yourself as:
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec` to run the tests. You can also run `bin/pry` for an interactive prompt that will allow you to experiment.
+Requires Ruby 3.1 or newer, grape-swagger 2.x, and Representable 3.2 or newer within the 3.x series. After checking out the repo, run `bin/setup` to install dependencies. Run `bundle exec rake spec` for tests and `bundle exec rubocop` for lint. You can also run `bin/pry` for an interactive prompt.
+
+GitHub Actions tests Ruby 3.1, 3.3, 3.4, and 4.0 across Grape 2, 3, and 4, including Representable 3.2 and the latest 3.x. Dependencies resolve from released gems rather than grape-swagger's development branch. Ruby 3.1 uses JSON 2.x for compatibility with its supported MultiJson versions.
+
+To select dependencies locally, run, for example, `GRAPE_VERSION='~> 2.4' REPRESENTABLE_VERSION='~> 3.2.0' bundle update`, and set the same variables when running tests. `GRAPE_SWAGGER_VERSION` can select a particular supported grape-swagger release.
+
+SimpleCov starts before loading the library and tracks all Ruby files under `lib/`. Local reports are written to `coverage/index.html`; CI uploads `coverage/lcov.info` to Coveralls using parallel matrix flags and a completion job.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. Follow [RELEASING.md](RELEASING.md) to prepare and publish a release.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/grape-swagger-representable.
+Bug reports and pull requests are welcome on GitHub at https://github.com/ruby-grape/grape-swagger-representable.
 
-## License
+Add a pull request entry to the next release section of [CHANGELOG.md](CHANGELOG.md), including the PR link, a short description, and author attribution. Leave the `Your contribution here.` placeholder for the next contributor.
+
+Danger checks changelog updates on pull requests. Its read-only workflow generates a report, and a separate workflow posts the report as a PR comment using GitHub's built-in token; no personal access token or repository secret is required.
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+## License
 
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/RELEASING.md

@@ -0,0 +1,80 @@
+# Releasing Grape-Swagger-Representable
+
+Publishing requires push access to the canonical repository, RubyGems ownership, and RubyGems multi-factor authentication.
+
+## Prepare the release
+
+Start with a clean checkout whose `origin` points to `ruby-grape/grape-swagger-representable`, not a fork:
+
+```sh
+git remote get-url origin
+git switch master
+git pull --ff-only origin master
+git status --short
+```
+
+Set `GrapeSwagger::Representable::VERSION` in [lib/grape-swagger/representable/version.rb](lib/grape-swagger/representable/version.rb). Use a patch version for fixes and a minor version for new features or breaking changes while the gem is below 1.0.
+
+Change the next-release heading in [CHANGELOG.md](CHANGELOG.md) to the release version and date, and remove `Your contribution here.`:
+
+```markdown
+### 0.3.0 (2026/10/27)
+```
+
+Review compatibility changes before publishing. Version 0.3.0 requires Ruby 3.1 or newer, grape-swagger 2.x, and Representable 3.2 or newer within the 3.x series.
+
+Resolve dependencies if needed, then run lint and specs:
+
+```sh
+bundle install
+bundle exec rubocop
+bundle exec rake spec
+```
+
+Commit and push the release preparation normally:
+
+```sh
+git add CHANGELOG.md README.md RELEASING.md lib/grape-swagger/representable/version.rb
+git commit -m "Prepare grape-swagger-representable 0.3.0"
+git push origin master
+```
+
+Wait for the [test matrix](https://github.com/ruby-grape/grape-swagger-representable/actions/workflows/test.yml) and [RuboCop](https://github.com/ruby-grape/grape-swagger-representable/actions/workflows/rubocop.yml) to pass for that exact commit. Danger runs on pull requests, not direct release-preparation pushes to `master`.
+
+## Publish
+
+Confirm that the worktree is clean and that the version is not already published. Bundler's release task builds the gem, creates and pushes the version tag, and publishes to RubyGems:
+
+```sh
+bundle exec rake release
+```
+
+Supply a fresh RubyGems one-time password when requested. Never write credentials or one-time passwords to repository files. If publishing fails after pushing the tag, diagnose the failure and resume with `gem push pkg/grape-swagger-representable-0.3.0.gem`; do not move an existing release tag.
+
+Verify the published gem's version and SHA256 against the local artifact, and confirm the remote tag points to the release commit:
+
+```sh
+gem specification pkg/grape-swagger-representable-0.3.0.gem version
+shasum -a 256 pkg/grape-swagger-representable-0.3.0.gem
+curl --fail https://rubygems.org/api/v2/rubygems/grape-swagger-representable/versions/0.3.0.json
+git ls-remote origin 'refs/tags/v0.3.0*'
+```
+
+Create a non-draft GitHub release from that existing tag, using the matching changelog section for its notes:
+
+```sh
+gh release create v0.3.0 --repo ruby-grape/grape-swagger-representable \
+  --verify-tag --title "grape-swagger-representable 0.3.0" --notes-file /path/to/release-notes.txt
+```
+
+## Prepare the next development version
+
+After confirming publication, bump the version to the next patch development iteration and add a fresh changelog section. For example, after 0.3.0, set the version to `0.3.1` and prepend:
+
+```markdown
+### 0.3.1 (Next)
+
+* Your contribution here.
+```
+
+Commit the version and changelog changes, and push `master` normally. Never force-push `master`, overwrite a published gem, or move an existing release tag.

data/bin/pry

@@ -2,14 +2,10 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
-require 'grape-swagger/representable'
+require_relative '../lib/grape-swagger/representable'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
 require 'pry'
 Pry.start

data/grape-swagger-representable.gemspec

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'grape-swagger/representable/version'
+require_relative 'lib/grape-swagger/representable/version'
 
 Gem::Specification.new do |s|
   s.name          = 'grape-swagger-representable'
@@ -11,7 +9,6 @@ Gem::Specification.new do |s|
   s.email         = ['kirik910@gmail.com']
 
   s.summary       = 'Grape swagger adapter to support representable object parsing'
-  s.homepage      = 'https://github.com/Bugagazavr/grape-swagger-representable'
   s.license       = 'MIT'
 
   s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
@@ -19,18 +16,21 @@ 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.31.0'
-  s.add_runtime_dependency 'representable'
-
-  s.add_development_dependency 'bundler', '~> 1.12'
-  s.add_development_dependency 'multi_json'
-  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')
-  s.add_development_dependency 'rack-cors'
-  s.add_development_dependency 'rack-test'
-  s.add_development_dependency 'rake', '~> 10.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 'rspec', '~> 3.0'
-  s.add_development_dependency 'rubocop'
+  github_uri = "https://github.com/ruby-grape/#{s.name}"
+
+  s.homepage = github_uri
+
+  s.metadata = {
+    'rubygems_mfa_required' => 'true',
+    'bug_tracker_uri' => "#{github_uri}/issues",
+    'changelog_uri' => "#{github_uri}/blob/master/CHANGELOG.md",
+    'documentation_uri' => "https://www.rubydoc.info/gems/#{s.name}/#{s.version}",
+    'homepage_uri' => s.homepage,
+    'source_code_uri' => github_uri
+  }
+
+  s.required_ruby_version = '>= 3.1'
+
+  s.add_dependency 'grape-swagger', '~> 2.0'
+  s.add_dependency 'representable', '~> 3.2'
 end

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

@@ -3,8 +3,7 @@
 module GrapeSwagger
   module Representable
     class Parser
-      attr_reader :model
-      attr_reader :endpoint
+      attr_reader :model, :endpoint
 
       def initialize(model, endpoint)
         @model = model
@@ -22,33 +21,19 @@ module GrapeSwagger
         documentation = property[:documentation] ? property[:documentation].dup : {}
 
         if property[:decorator] && property[:nested]
-          representer_mapping(property[:decorator], documentation, property, is_a_collection, false, property[:nested])
+          representer_mapping(
+            property[:decorator], documentation, property,
+            is_a_collection: is_a_collection, nested: property[:nested]
+          )
         elsif property[:decorator]
-          representer_mapping(property[:decorator], documentation, property, is_a_collection, true)
+          representer_mapping(
+            property[:decorator], documentation, property,
+            is_a_collection: is_a_collection, is_a_decorator: true
+          )
         elsif property[:nested]
-          representer_mapping(property[:nested], documentation, property, is_a_collection)
+          representer_mapping(property[:nested], documentation, property, is_a_collection: is_a_collection)
         else
-          memo = {
-            description: documentation[:desc] || property[:desc] || ''
-          }
-
-          data_type = GrapeSwagger::DocMethods::DataType.call(documentation[:type] || property[:type])
-          if GrapeSwagger::DocMethods::DataType.primitive?(data_type)
-            data = GrapeSwagger::DocMethods::DataType.mapping(data_type)
-            memo[:type] = data.first
-            memo[:format] = data.last
-          else
-            memo[:type] = data_type
-          end
-
-          default_value = documentation[:default] || property[:default] || nil
-          memo[:default] = default_value unless default_value.nil?
-
-          values = documentation[:values] || property[:values] || nil
-          memo[:enum] = values.is_a?(Proc) ? values.call : values if values
-
-          example = documentation[:example] || property[:example] || nil
-          memo[:example] = example.is_a?(Proc) ? example.call : example if example
+          memo = primitive_mapping(property, documentation)
 
           if is_a_collection || documentation[:is_array]
             memo = {
@@ -61,7 +46,31 @@ module GrapeSwagger
         end
       end
 
-      def representer_mapping(representer, documentation, property, is_a_collection = false, is_a_decorator = false, nested = nil)
+      def primitive_mapping(property, documentation)
+        memo = { description: documentation[:desc] || property[:desc] || '' }
+        data_type = GrapeSwagger::DocMethods::DataType.call(documentation[:type] || property[:type])
+        if GrapeSwagger::DocMethods::DataType.primitive?(data_type)
+          data = GrapeSwagger::DocMethods::DataType.mapping(data_type)
+          memo[:type] = data.first
+          memo[:format] = data.last
+        else
+          memo[:type] = data_type
+        end
+
+        default_value = documentation[:default] || property[:default] || nil
+        memo[:default] = default_value unless default_value.nil?
+
+        values = documentation[:values] || property[:values] || nil
+        memo[:enum] = values.is_a?(Proc) ? values.call : values if values
+
+        example = documentation[:example] || property[:example] || nil
+        memo[:example] = example.is_a?(Proc) ? example.call : example if example
+        memo
+      end
+
+      def representer_mapping(
+        representer, documentation, property, is_a_collection: false, is_a_decorator: false, nested: nil
+      )
         if nested.nil? && is_a_decorator
           name = endpoint.send(:expose_params_from_model, representer)
 
@@ -105,13 +114,17 @@ module GrapeSwagger
         properties = representer.map.each_with_object({}) do |value, property|
           property_name = value[:as].try(:call) || value.name
           hidden_property = value[:documentation]&.[](:hidden)
+
           next if hidden_property && (hidden_property.is_a?(Proc) ? hidden_property.call : hidden_property)
+
           property[property_name] = parse_representer_property(value)
         end
 
-        required = representer.map
-                              .select { |value| value[:documentation] && value[:documentation][:required] }
-                              .map { |value| value[:as] || value.name }
+        required =
+          representer
+            .map
+            .select { |value| value[:documentation] && value[:documentation][:required] }
+            .map { |value| value[:as] || value.name }
 
         [properties, required]
       end
@@ -125,15 +138,17 @@ module GrapeSwagger
 
         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_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

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

@@ -2,6 +2,6 @@
 
 module GrapeSwagger
   module Representable
-    VERSION = '0.2.2'
+    VERSION = '0.3.0'
   end
 end

data/lib/grape-swagger/representable.rb

@@ -3,12 +3,12 @@
 require 'grape-swagger'
 require 'representable'
 
-require 'grape-swagger/representable/version'
-require 'grape-swagger/representable/parser'
+require_relative 'representable/version'
+require_relative 'representable/parser'
 
 module GrapeSwagger
   module Representable
   end
 end
 
-GrapeSwagger.model_parsers.register(::GrapeSwagger::Representable::Parser, ::Representable::Decorator)
+GrapeSwagger.model_parsers.register(GrapeSwagger::Representable::Parser, Representable::Decorator)

data/lib/grape-swagger-representable.rb

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

metadata

@@ -1,212 +1,64 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger-representable
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Kirill Zaitsev
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-22 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape-swagger
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.31.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.31.0
-- !ruby/object:Gem::Dependency
-  name: representable
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !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: multi_json
-  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'
-- !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: 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: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
+        version: '2.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.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'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: representable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
+        version: '3.2'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  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: 
+        version: '3.2'
 email:
 - kirik910@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
+- ".github/workflows/danger-comment.yml"
+- ".github/workflows/danger.yml"
+- ".github/workflows/rubocop.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
-- ".travis.yml"
+- ".simplecov"
+- CHANGELOG.md
+- Dangerfile
 - Gemfile
 - LICENSE.txt
 - README.md
+- RELEASING.md
 - Rakefile
 - bin/pry
 - bin/setup
@@ -215,11 +67,16 @@ files:
 - lib/grape-swagger/representable.rb
 - lib/grape-swagger/representable/parser.rb
 - lib/grape-swagger/representable/version.rb
-homepage: https://github.com/Bugagazavr/grape-swagger-representable
+homepage: https://github.com/ruby-grape/grape-swagger-representable
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+  bug_tracker_uri: https://github.com/ruby-grape/grape-swagger-representable/issues
+  changelog_uri: https://github.com/ruby-grape/grape-swagger-representable/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/grape-swagger-representable/0.3.0
+  homepage_uri: https://github.com/ruby-grape/grape-swagger-representable
+  source_code_uri: https://github.com/ruby-grape/grape-swagger-representable
 rdoc_options: []
 require_paths:
 - lib
@@ -227,16 +84,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Grape swagger adapter to support representable object parsing
 test_files: []

data/.travis.yml

@@ -1,30 +0,0 @@
-language: ruby
-
-sudo: false
-
-before_install:
-  - gem update --system
-  - gem install bundler
-
-rvm:
-  - 2.4.2
-  - 2.3.5
-
-matrix:
-  fast_finish: true
-
-  include:
-    - rvm: 2.2.8
-      env:
-    - rvm: ruby-head
-      env:
-    - rvm: jruby-head
-      env:
-    - rvm: rbx-2
-      env:
-
-  allow_failures:
-    - rvm: 2.2.8
-    - rvm: ruby-head
-    - rvm: jruby-head
-    - rvm: rbx-2