Skip to content

Commit 407afcb

Browse files
mscrivomscrivo
authored
Migrate from Travis to GHA (#61)
* Add GHA * Get building * Remove Ruby 2.6 * Remove Ruby 2.7 too * Add lint job and remove travis config * Fix rubocop config and autocorrect * Fix tests * Update rubucop_todo.yml * Use newer ruby for rubocop * More rubocop fixes * Add danger workflow * Update badges and rename workflow from ruby to test * Update CHANGELOG
1 parent ca79820 commit 407afcb

16 files changed

+200
-92
lines changed

‎.github/workflows/danger.yml

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: danger
2+
on: pull_request
3+
4+
jobs:
5+
danger:
6+
runs-on: ubuntu-latest
7+
steps:
8+
- uses: actions/checkout@v3
9+
with:
10+
fetch-depth: 100
11+
- name: Set up Ruby
12+
uses: ruby/setup-ruby@v1
13+
with:
14+
ruby-version: 3.2
15+
bundler-cache: true
16+
rubygems: latest
17+
- name: Run Danger
18+
run: |
19+
# the token is public, has public_repo scope and belongs to the grape-bot user owned by @dblock, this is ok
20+
TOKEN=$(echo -n Z2hwX2lYb0dPNXNyejYzOFJyaTV3QUxUdkNiS1dtblFwZTFuRXpmMwo= | base64 --decode)
21+
DANGER_GITHUB_API_TOKEN=$TOKEN bundle exec danger --verbose

‎.github/workflows/test.yml

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: test
2+
3+
on: [push, pull_request]
4+
5+
permissions:
6+
contents: read
7+
8+
jobs:
9+
lint:
10+
name: RuboCop
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v3
14+
15+
- name: Set up Ruby
16+
uses: ruby/setup-ruby@v1
17+
with:
18+
ruby-version: 3.2
19+
bundler-cache: true
20+
rubygems: latest
21+
22+
- name: Run RuboCop
23+
run: bundle exec rubocop
24+
25+
test:
26+
env:
27+
GRAPE_ENTITY: 0.8.0
28+
29+
runs-on: ubuntu-latest
30+
strategy:
31+
fail-fast: false
32+
matrix:
33+
ruby-version: ['3.0', '3.1', '3.2']
34+
35+
steps:
36+
- uses: actions/checkout@v3
37+
- name: Set up Ruby
38+
uses: ruby/setup-ruby@v1
39+
with:
40+
ruby-version: ${{ matrix.ruby-version }}
41+
bundler-cache: true
42+
- name: Run tests
43+
run: bundle exec rake spec

‎.gitignore

+2-1
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,5 @@
88
/spec/reports/
99
/tmp/
1010
.ruby-gemset
11-
.ruby-version
11+
.ruby-version
12+
/.idea

‎.rubocop.yml

+1-12
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,12 @@
11
AllCops:
2+
NewCops: enable
23
Exclude:
34
- vendor/**/*
45
TargetRubyVersion:
56
2.7
67

78
inherit_from: .rubocop_todo.yml
89

9-
Metrics/BlockLength:
10-
Exclude:
11-
- spec/**/*
12-
13-
Metrics/LineLength:
14-
Exclude:
15-
- spec/**/*
16-
17-
Metrics/MethodLength:
18-
Exclude:
19-
- spec/**/*
20-
2110
Naming/FileName:
2211
Enabled: false
2312

‎.rubocop_todo.yml

+71-13
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,106 @@
11
# This configuration was generated by
2-
# `rubocop --auto-gen-config`
3-
# on 2020-06-29 22:12:50 UTC using RuboCop version 0.86.0.
2+
# `rubocop --auto-gen-config --auto-gen-only-exclude --exclude-limit 5000`
3+
# on 2023-07-06 17:02:48 UTC using RuboCop version 1.42.0.
44
# The point is for the user to remove these configuration records
55
# one by one as the offenses are removed from the code base.
66
# Note that changes in the inspected code, or installation of new
77
# versions of RuboCop, may require this file to be generated again.
88

99
# Offense count: 1
10-
# Configuration parameters: Include.
10+
# Configuration parameters: Severity, Include.
1111
# Include: **/*.gemspec
1212
Gemspec/RequiredRubyVersion:
1313
Exclude:
1414
- 'grape-swagger-entity.gemspec'
1515

16+
# Offense count: 3
17+
# Configuration parameters: AllowedMethods.
18+
# AllowedMethods: enums
19+
Lint/ConstantDefinitionInBlock:
20+
Exclude:
21+
- 'spec/grape-swagger/entities/response_model_spec.rb'
22+
- 'spec/support/shared_contexts/inheritance_api.rb'
23+
- 'spec/support/shared_contexts/this_api.rb'
24+
25+
# Offense count: 1
26+
# Configuration parameters: AllowComments, AllowEmptyLambdas.
27+
Lint/EmptyBlock:
28+
Exclude:
29+
- 'spec/grape-swagger/entity/attribute_parser_spec.rb'
30+
31+
# Offense count: 1
32+
# This cop supports unsafe autocorrection (--autocorrect-all).
33+
# Configuration parameters: AllowedMethods.
34+
# AllowedMethods: instance_of?, kind_of?, is_a?, eql?, respond_to?, equal?
35+
Lint/RedundantSafeNavigation:
36+
Exclude:
37+
- 'lib/grape-swagger/entity/attribute_parser.rb'
38+
1639
# Offense count: 4
17-
# Configuration parameters: IgnoredMethods.
40+
# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods, CountRepeatedAttributes, Max.
1841
Metrics/AbcSize:
19-
Max: 30
42+
Exclude:
43+
- 'lib/grape-swagger/entity/attribute_parser.rb'
44+
- 'lib/grape-swagger/entity/parser.rb'
45+
46+
# Offense count: 13
47+
# Configuration parameters: CountComments, Max, CountAsOne, ExcludedMethods, AllowedMethods, AllowedPatterns, IgnoredMethods.
48+
# AllowedMethods: refine
49+
Metrics/BlockLength:
50+
Exclude:
51+
- '**/*.gemspec'
52+
- 'spec/grape-swagger/entities/response_model_spec.rb'
53+
- 'spec/grape-swagger/entity/attribute_parser_spec.rb'
54+
- 'spec/grape-swagger/entity/parser_spec.rb'
55+
- 'spec/support/shared_contexts/this_api.rb'
2056

2157
# Offense count: 1
22-
# Configuration parameters: CountComments.
58+
# Configuration parameters: CountComments, Max, CountAsOne.
2359
Metrics/ClassLength:
24-
Max: 111
60+
Exclude:
61+
- 'lib/grape-swagger/entity/parser.rb'
2562

2663
# Offense count: 2
27-
# Configuration parameters: IgnoredMethods.
64+
# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods, Max.
2865
Metrics/CyclomaticComplexity:
29-
Max: 11
66+
Exclude:
67+
- 'lib/grape-swagger/entity/attribute_parser.rb'
68+
- 'lib/grape-swagger/entity/parser.rb'
3069

3170
# Offense count: 5
32-
# Configuration parameters: CountComments, ExcludedMethods.
71+
# Configuration parameters: CountComments, Max, CountAsOne, ExcludedMethods, AllowedMethods, AllowedPatterns, IgnoredMethods.
3372
Metrics/MethodLength:
34-
Max: 25
73+
Exclude:
74+
- 'lib/grape-swagger/entity/attribute_parser.rb'
75+
- 'lib/grape-swagger/entity/parser.rb'
3576

3677
# Offense count: 2
37-
# Configuration parameters: IgnoredMethods.
78+
# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods, Max.
3879
Metrics/PerceivedComplexity:
39-
Max: 12
80+
Exclude:
81+
- 'lib/grape-swagger/entity/attribute_parser.rb'
82+
- 'lib/grape-swagger/entity/parser.rb'
83+
84+
# Offense count: 2
85+
# Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers, AllowedPatterns.
86+
# SupportedStyles: snake_case, normalcase, non_integer
87+
# AllowedIdentifiers: capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339
88+
Naming/VariableNumber:
89+
Exclude:
90+
- 'spec/grape-swagger/entities/response_model_spec.rb'
4091

4192
# Offense count: 4
93+
# Configuration parameters: AllowedConstants.
4294
Style/Documentation:
4395
Exclude:
4496
- 'spec/**/*'
4597
- 'test/**/*'
4698
- 'lib/grape-swagger/entity.rb'
4799
- 'lib/grape-swagger/entity/attribute_parser.rb'
48100
- 'lib/grape-swagger/entity/parser.rb'
101+
102+
# Offense count: 4
103+
Style/OpenStructUse:
104+
Exclude:
105+
- 'spec/grape-swagger/entities/response_model_spec.rb'
106+
- 'spec/support/shared_contexts/this_api.rb'

‎.travis.yml

-36
This file was deleted.

‎CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66

77
#### Fixes
88

9+
* [#61](https://github.com/ruby-grape/grape-swagger-entity/pull/61): Migrate from Travis to GHA for CI - [@mscrivo](https://github.com/mscrivo).
910
* Your contribution here.
1011

1112
### 0.5.1 (June 30, 2020)

‎Gemfile

+3-3
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@ group :development, :test do
1414
gem 'rack-test'
1515
gem 'rake'
1616
gem 'rdoc'
17-
gem 'rspec', '~> 3.9'
18-
gem 'rubocop', '~> 0.85'
17+
gem 'rspec'
18+
gem 'rubocop'
1919
end
2020

2121
gem 'grape-swagger', git: 'https://github.com/ruby-grape/grape-swagger.git'
2222

2323
group :test do
2424
gem 'grape-entity', ENV.fetch('GRAPE_ENTITY', '0.6.1')
25-
gem 'ruby-grape-danger', '~> 0.1.1', require: false
25+
gem 'ruby-grape-danger', '~> 0.2.0', require: false
2626
gem 'simplecov', require: false
2727
end

‎README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# GrapeSwagger::Entity [![Build Status](https://travis-ci.org/ruby-grape/grape-swagger-entity.svg)](https://travis-ci.org/ruby-grape/grape-swagger-entity)
1+
# GrapeSwagger::Entity
2+
3+
[![Gem Version](https://badge.fury.io/rb/grape-swagger-entity.svg)](https://badge.fury.io/rb/grape-swagger-entity)
4+
[![Build Status](https://github.com/ruby-grape/grape-swagger-entity/workflows/test/badge.svg?branch=master)](https://github.com/ruby-grape/grape-swagger-entity/actions)
25

36
A simple grape-swagger adapter to allow parse representers as response model
47

‎grape-swagger-entity.gemspec

+1
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,5 @@ Gem::Specification.new do |s|
2222
s.required_ruby_version = '>= 2.4'
2323
s.add_runtime_dependency 'grape-entity', '>= 0.6.0'
2424
s.add_runtime_dependency 'grape-swagger', '>= 1.2.0'
25+
s.metadata['rubygems_mfa_required'] = 'true'
2526
end

‎lib/grape-swagger/entity.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ module Entity
1313
end
1414
end
1515

16-
GrapeSwagger.model_parsers.register(::GrapeSwagger::Entity::Parser, ::Grape::Entity)
16+
GrapeSwagger.model_parsers.register(GrapeSwagger::Entity::Parser, Grape::Entity)

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ def call(entity_options)
2929
add_attribute_sample(param, documentation, :default)
3030
add_attribute_sample(param, documentation, :example)
3131

32-
if (values = documentation[:values])
33-
param[:enum] = values if values.is_a?(Array)
32+
if (values = documentation[:values]) && values.is_a?(Array)
33+
param[:enum] = values
3434
end
3535

3636
if documentation[:is_array]

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

+1-3
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,7 @@
33
module GrapeSwagger
44
module Entity
55
class Parser
6-
attr_reader :model
7-
attr_reader :endpoint
8-
attr_reader :attribute_parser
6+
attr_reader :model, :endpoint, :attribute_parser
97

108
def initialize(model, endpoint)
119
@model = model

0 commit comments

Comments
 (0)