kcv 0.4.1 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (14) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/test.yml +32 -0
  3. data/.gitignore +3 -0
  4. data/.rspec +3 -0
  5. data/.standard.yml +1 -0
  6. data/README.md +19 -0
  7. data/bin/standardrb +29 -0
  8. data/kcv.gemspec +24 -18
  9. data/lib/kcv/agent_resolver.rb +1 -1
  10. data/lib/kcv/version.rb +1 -1
  11. data/lib/kcv.rb +1 -1
  12. metadata +83 -29
  13. data/.rubocop.yml +0 -30
  14. data/.travis.yml +0 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f9804dcc3b294470748d275739339cbe092b6f389b6d28f9286bb8eb5b6fb057
4
- data.tar.gz: 6bd6ab5a7939a5af54e9c93bc031cd1d7b24fbdcb8b74dbcfad1fa2ff5bc7030
3
+ metadata.gz: 4235febf17e379560f9dbbb21dbad1921e26175e4e800126865baa2985c39376
4
+ data.tar.gz: ed44b75061cd9e68982745c51a0bae7d5af46c6883fca2d409e8cbc85c9a7877
5
5
  SHA512:
6
- metadata.gz: a401d60f4ca40703d595b7055d3da35682626d54de82be9a2fa35a40b18d723b1ed738d3de591535d3739ff7bb35024a70819c0268a7c4ccae4e7b618b46de43
7
- data.tar.gz: a377d8441cc787169ceafac673c547d5bd8559b5ce2434a345de57a279cf519165d7a3bee61c56e98c446896c4f21d26893567b3312399395fc03b7da250a25e
6
+ metadata.gz: bb30409c0d809bed6bbc1424d393131b8ab658591b2d5e303ee70a2e495d91b39064895bf2d4f5f3272d09c9cca3535509b5f41a4b3b16e8fe426ff45fc92b7a
7
+ data.tar.gz: 311728280cca1444b35de14486e5714df2f102abe664e8ffd2d7f29883b53d7d1d68f5b472f25179561366f86415882f9f279522435fa869b9f2f93c5f38d648
data/.github/workflows/test.yml ADDED
@@ -0,0 +1,32 @@
1
+ name: Tests
2
+
3
+ on:
4
+ push:
5
+ branches: [ main ]
6
+ pull_request:
7
+ branches: [ main ]
8
+
9
+ jobs:
10
+ test:
11
+ strategy:
12
+ matrix:
13
+ os: [ ubuntu-latest ]
14
+ ruby-version: [3.2, 3.3, 3.4, 4.0]
15
+
16
+ runs-on: ${{ matrix.os }}
17
+
18
+ steps:
19
+ - uses: actions/checkout@v6
20
+ - name: Set up Ruby ${{ matrix.ruby-version }}
21
+ uses: ruby/setup-ruby@v1
22
+ with:
23
+ ruby-version: ${{ matrix.ruby-version }}
24
+ bundler-cache: true
25
+ - name: Run linter for Ruby ${{ matrix.ruby-version }} on ${{ matrix.os }}
26
+ run: bin/standardrb
27
+ - name: Run tests for Ruby ${{ matrix.ruby-version }} on ${{ matrix.os }}
28
+ run: bin/rspec
29
+ - name: Report to Coveralls
30
+ uses: coverallsapp/github-action@v2
31
+ with:
32
+ github-token: ${{ secrets.github_token }}
data/.gitignore CHANGED
@@ -9,3 +9,6 @@
9
9
 
10
10
  Gemfile.lock
11
11
  /*.gem
12
+
13
+ # rspec failure tracking
14
+ .rspec_status
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
data/.standard.yml ADDED
@@ -0,0 +1 @@
1
+ ruby_version: 3.0.0
data/README.md CHANGED
@@ -1,3 +1,8 @@
1
+ [![Tests](https://github.com/mlibrary/kcv/actions/workflows/test.yml/badge.svg)](https://github.com/mlibrary/kcv/actions/workflows/test.yml)
2
+ [![Coverage Status](https://coveralls.io/repos/github/mlibrary/keycard/badge.svg?branch=main)](https://coveralls.io/github/mlibrary/kcv?branch=main)
3
+ [![User Docs](https://img.shields.io/badge/user_docs-readthedocs-blue.svg)](https://kcv.readthedocs.io/en/latest)
4
+ [![API Docs](https://img.shields.io/badge/API_docs-rubydoc.info-blue.svg)](https://www.rubydoc.info/gems/kcv)
5
+
1
6
  # KCV
2
7
 
3
8
  KCV is a glue gem for making it easy to use [Keycard](https://github.com/mlibrary/keycard),
@@ -23,6 +28,20 @@ And then execute:
23
28
 
24
29
  $ bundle
25
30
 
31
+ ## Compatibility
32
+
33
+ KCV is intended to be compatible with all community-supported Ruby branches (i.e., minor versions), currently:
34
+
35
+ - 3.2
36
+ - 3.3
37
+ - 3.4
38
+ - 4.0
39
+
40
+ We prefer the newest syntax and linting rules that preserve compatibility with the oldest branch in normal maintenance.
41
+ When the security maintenance for a branch expires, Keycard's compatibility should be considered unsupported.
42
+
43
+ See also, [Ruby's branch maintenance policy](https://www.ruby-lang.org/en/downloads/branches/).
44
+
26
45
  ## License
27
46
 
28
47
  Checkpoint is licensed under the BSD-3-Clause license. See [LICENSE.md](LICENSE.md).
data/bin/standardrb ADDED
@@ -0,0 +1,29 @@
1
+ #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
4
+ #
5
+ # This file was generated by Bundler.
6
+ #
7
+ # The application 'standardrb' is installed as part of a gem, and
8
+ # this file is here to facilitate running it.
9
+ #
10
+
11
+ require "pathname"
12
+ ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
13
+ Pathname.new(__FILE__).realpath)
14
+
15
+ bundle_binstub = File.expand_path("../bundle", __FILE__)
16
+
17
+ if File.file?(bundle_binstub)
18
+ if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
19
+ load(bundle_binstub)
20
+ else
21
+ abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
22
+ Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
23
+ end
24
+ end
25
+
26
+ require "rubygems"
27
+ require "bundler/setup"
28
+
29
+ load Gem.bin_path("standard", "standardrb")
data/kcv.gemspec CHANGED
@@ -1,36 +1,42 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- lib = File.expand_path('lib', __dir__)
3
+ lib = File.expand_path("lib", __dir__)
4
4
  $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
5
5
  require "kcv/version"
6
6
 
7
7
  Gem::Specification.new do |spec|
8
- spec.name = "kcv"
9
- spec.version = KCV::VERSION
10
- spec.authors = ["Noah Botimer"]
11
- spec.email = ["botimer@umich.edu"]
8
+ spec.name = "kcv"
9
+ spec.version = KCV::VERSION
10
+ spec.authors = ["Noah Botimer"]
11
+ spec.email = ["botimer@umich.edu"]
12
12
 
13
- spec.summary = 'Glue gem for integration of Keycard, Checkpoint, and Vizier.'
14
- spec.description = <<~DESC
13
+ spec.summary = "Glue gem for integration of Keycard, Checkpoint, and Vizier."
14
+ spec.description = <<~DESC
15
15
  This gem provides utilities for using Keycard, Checkpoint, and Vizier together, which have
16
16
  no direct dependencies on each other. An application could implement any of these, but they
17
17
  provide a standard base implementation for convenience and consistency.
18
18
  DESC
19
- spec.homepage = "https://github.com/mlibrary/kcv"
19
+ spec.homepage = "https://github.com/mlibrary/kcv"
20
20
 
21
- spec.files = `git ls-files -z`.split("\x0").reject do |f|
21
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
22
22
  f.match(%r{^(test|spec|features)/})
23
23
  end
24
- spec.bindir = "exe"
25
- spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
24
+ spec.bindir = "exe"
25
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
26
26
  spec.require_paths = ["lib"]
27
27
 
28
- spec.add_dependency "checkpoint", "~> 1.1.0"
29
- spec.add_dependency "keycard", "~> 0.3.0"
30
- spec.add_dependency "vizier", "~> 0.1.0"
28
+ spec.required_ruby_version = ">= 3.2.0"
31
29
 
32
- spec.add_development_dependency "bundler", "~> 1.16"
33
- spec.add_development_dependency "coveralls", "~> 0.8"
34
- spec.add_development_dependency "rake", "~> 10.0"
35
- spec.add_development_dependency "rspec", "~> 3.7"
30
+ spec.add_dependency "checkpoint", "~> 1.2.0"
31
+ spec.add_dependency "keycard", "~> 0.4.0"
32
+ spec.add_dependency "vizier", "~> 0.2.0"
33
+
34
+ spec.add_development_dependency "bundler"
35
+ spec.add_development_dependency "logger"
36
+ spec.add_development_dependency "ostruct"
37
+ spec.add_development_dependency "simplecov"
38
+ spec.add_development_dependency "simplecov-lcov"
39
+ spec.add_development_dependency "rake", "~> 13.0"
40
+ spec.add_development_dependency "rspec", "~> 3.11"
41
+ spec.add_development_dependency "standard", "~> 1.53"
36
42
  end
data/lib/kcv/agent_resolver.rb CHANGED
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'checkpoint/agent'
3
+ require "checkpoint/agent"
4
4
 
5
5
  module KCV
6
6
  # Base AgentResolver to integrate Keycard and Checkpoint.
data/lib/kcv/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module KCV
4
- VERSION = "0.4.1"
4
+ VERSION = "0.5.0"
5
5
  end
data/lib/kcv.rb CHANGED
@@ -12,4 +12,4 @@ require "kcv/version"
12
12
  module KCV
13
13
  end
14
14
 
15
- require 'kcv/agent_resolver'
15
+ require "kcv/agent_resolver"
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: kcv
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.4.1
4
+ version: 0.5.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Noah Botimer
8
- autorequire:
9
8
  bindir: exe
10
9
  cert_chain: []
11
- date: 2019-03-13 00:00:00.000000000 Z
10
+ date: 1980-01-02 00:00:00.000000000 Z
12
11
  dependencies:
13
12
  - !ruby/object:Gem::Dependency
14
13
  name: checkpoint
@@ -16,98 +15,154 @@ dependencies:
16
15
  requirements:
17
16
  - - "~>"
18
17
  - !ruby/object:Gem::Version
19
- version: 1.1.0
18
+ version: 1.2.0
20
19
  type: :runtime
21
20
  prerelease: false
22
21
  version_requirements: !ruby/object:Gem::Requirement
23
22
  requirements:
24
23
  - - "~>"
25
24
  - !ruby/object:Gem::Version
26
- version: 1.1.0
25
+ version: 1.2.0
27
26
  - !ruby/object:Gem::Dependency
28
27
  name: keycard
29
28
  requirement: !ruby/object:Gem::Requirement
30
29
  requirements:
31
30
  - - "~>"
32
31
  - !ruby/object:Gem::Version
33
- version: 0.3.0
32
+ version: 0.4.0
34
33
  type: :runtime
35
34
  prerelease: false
36
35
  version_requirements: !ruby/object:Gem::Requirement
37
36
  requirements:
38
37
  - - "~>"
39
38
  - !ruby/object:Gem::Version
40
- version: 0.3.0
39
+ version: 0.4.0
41
40
  - !ruby/object:Gem::Dependency
42
41
  name: vizier
43
42
  requirement: !ruby/object:Gem::Requirement
44
43
  requirements:
45
44
  - - "~>"
46
45
  - !ruby/object:Gem::Version
47
- version: 0.1.0
46
+ version: 0.2.0
48
47
  type: :runtime
49
48
  prerelease: false
50
49
  version_requirements: !ruby/object:Gem::Requirement
51
50
  requirements:
52
51
  - - "~>"
53
52
  - !ruby/object:Gem::Version
54
- version: 0.1.0
53
+ version: 0.2.0
55
54
  - !ruby/object:Gem::Dependency
56
55
  name: bundler
57
56
  requirement: !ruby/object:Gem::Requirement
58
57
  requirements:
59
- - - "~>"
58
+ - - ">="
60
59
  - !ruby/object:Gem::Version
61
- version: '1.16'
60
+ version: '0'
62
61
  type: :development
63
62
  prerelease: false
64
63
  version_requirements: !ruby/object:Gem::Requirement
65
64
  requirements:
66
- - - "~>"
65
+ - - ">="
67
66
  - !ruby/object:Gem::Version
68
- version: '1.16'
67
+ version: '0'
69
68
  - !ruby/object:Gem::Dependency
70
- name: coveralls
69
+ name: logger
71
70
  requirement: !ruby/object:Gem::Requirement
72
71
  requirements:
73
- - - "~>"
72
+ - - ">="
74
73
  - !ruby/object:Gem::Version
75
- version: '0.8'
74
+ version: '0'
76
75
  type: :development
77
76
  prerelease: false
78
77
  version_requirements: !ruby/object:Gem::Requirement
79
78
  requirements:
80
- - - "~>"
79
+ - - ">="
80
+ - !ruby/object:Gem::Version
81
+ version: '0'
82
+ - !ruby/object:Gem::Dependency
83
+ name: ostruct
84
+ requirement: !ruby/object:Gem::Requirement
85
+ requirements:
86
+ - - ">="
87
+ - !ruby/object:Gem::Version
88
+ version: '0'
89
+ type: :development
90
+ prerelease: false
91
+ version_requirements: !ruby/object:Gem::Requirement
92
+ requirements:
93
+ - - ">="
94
+ - !ruby/object:Gem::Version
95
+ version: '0'
96
+ - !ruby/object:Gem::Dependency
97
+ name: simplecov
98
+ requirement: !ruby/object:Gem::Requirement
99
+ requirements:
100
+ - - ">="
101
+ - !ruby/object:Gem::Version
102
+ version: '0'
103
+ type: :development
104
+ prerelease: false
105
+ version_requirements: !ruby/object:Gem::Requirement
106
+ requirements:
107
+ - - ">="
81
108
  - !ruby/object:Gem::Version
82
- version: '0.8'
109
+ version: '0'
110
+ - !ruby/object:Gem::Dependency
111
+ name: simplecov-lcov
112
+ requirement: !ruby/object:Gem::Requirement
113
+ requirements:
114
+ - - ">="
115
+ - !ruby/object:Gem::Version
116
+ version: '0'
117
+ type: :development
118
+ prerelease: false
119
+ version_requirements: !ruby/object:Gem::Requirement
120
+ requirements:
121
+ - - ">="
122
+ - !ruby/object:Gem::Version
123
+ version: '0'
83
124
  - !ruby/object:Gem::Dependency
84
125
  name: rake
85
126
  requirement: !ruby/object:Gem::Requirement
86
127
  requirements:
87
128
  - - "~>"
88
129
  - !ruby/object:Gem::Version
89
- version: '10.0'
130
+ version: '13.0'
90
131
  type: :development
91
132
  prerelease: false
92
133
  version_requirements: !ruby/object:Gem::Requirement
93
134
  requirements:
94
135
  - - "~>"
95
136
  - !ruby/object:Gem::Version
96
- version: '10.0'
137
+ version: '13.0'
97
138
  - !ruby/object:Gem::Dependency
98
139
  name: rspec
99
140
  requirement: !ruby/object:Gem::Requirement
100
141
  requirements:
101
142
  - - "~>"
102
143
  - !ruby/object:Gem::Version
103
- version: '3.7'
144
+ version: '3.11'
104
145
  type: :development
105
146
  prerelease: false
106
147
  version_requirements: !ruby/object:Gem::Requirement
107
148
  requirements:
108
149
  - - "~>"
109
150
  - !ruby/object:Gem::Version
110
- version: '3.7'
151
+ version: '3.11'
152
+ - !ruby/object:Gem::Dependency
153
+ name: standard
154
+ requirement: !ruby/object:Gem::Requirement
155
+ requirements:
156
+ - - "~>"
157
+ - !ruby/object:Gem::Version
158
+ version: '1.53'
159
+ type: :development
160
+ prerelease: false
161
+ version_requirements: !ruby/object:Gem::Requirement
162
+ requirements:
163
+ - - "~>"
164
+ - !ruby/object:Gem::Version
165
+ version: '1.53'
111
166
  description: |
112
167
  This gem provides utilities for using Keycard, Checkpoint, and Vizier together, which have
113
168
  no direct dependencies on each other. An application could implement any of these, but they
@@ -119,9 +174,10 @@ extensions: []
119
174
  extra_rdoc_files: []
120
175
  files:
121
176
  - ".envrc"
177
+ - ".github/workflows/test.yml"
122
178
  - ".gitignore"
123
- - ".rubocop.yml"
124
- - ".travis.yml"
179
+ - ".rspec"
180
+ - ".standard.yml"
125
181
  - Gemfile
126
182
  - README.md
127
183
  - Rakefile
@@ -129,6 +185,7 @@ files:
129
185
  - bin/rake
130
186
  - bin/rspec
131
187
  - bin/setup
188
+ - bin/standardrb
132
189
  - kcv.gemspec
133
190
  - lib/kcv.rb
134
191
  - lib/kcv/agent_resolver.rb
@@ -136,7 +193,6 @@ files:
136
193
  homepage: https://github.com/mlibrary/kcv
137
194
  licenses: []
138
195
  metadata: {}
139
- post_install_message:
140
196
  rdoc_options: []
141
197
  require_paths:
142
198
  - lib
@@ -144,16 +200,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
144
200
  requirements:
145
201
  - - ">="
146
202
  - !ruby/object:Gem::Version
147
- version: '0'
203
+ version: 3.2.0
148
204
  required_rubygems_version: !ruby/object:Gem::Requirement
149
205
  requirements:
150
206
  - - ">="
151
207
  - !ruby/object:Gem::Version
152
208
  version: '0'
153
209
  requirements: []
154
- rubyforge_project:
155
- rubygems_version: 2.7.3
156
- signing_key:
210
+ rubygems_version: 4.0.3
157
211
  specification_version: 4
158
212
  summary: Glue gem for integration of Keycard, Checkpoint, and Vizier.
159
213
  test_files: []
data/.rubocop.yml DELETED
@@ -1,30 +0,0 @@
1
- Rails:
2
- Enabled: true
3
-
4
- Rails/Delegate:
5
- Enabled: false
6
-
7
- # inherit_gem:
8
- # rubocop-rails:
9
- # - config/rails.yml
10
-
11
- AllCops:
12
- DisplayCopNames: true
13
- TargetRubyVersion: 2.4
14
- Exclude:
15
- - 'bin/**/*'
16
- - 'vendor/**/*'
17
-
18
- Layout/MultilineMethodDefinitionBraceLayout:
19
- EnforcedStyle: same_line
20
-
21
- Metrics/LineLength:
22
- Max: 110
23
-
24
- Metrics/BlockLength:
25
- Exclude:
26
- - '*.gemspec'
27
- ExcludedMethods: ['describe', 'context']
28
-
29
- Style/StringLiterals:
30
- Enabled: false
data/.travis.yml DELETED
@@ -1,5 +0,0 @@
1
- sudo: false
2
- language: ruby
3
- rvm:
4
- - 2.4.2
5
- before_install: gem install bundler -v 1.16.0