dut 0.0.1
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.
- checksums.yaml +7 -0
- data/.circleci/config.yml +134 -0
- data/.github/CODEOWNERS +2 -0
- data/.github/PULL_REQUEST_TEMPLATE.md +15 -0
- data/.gitignore +8 -0
- data/.rubocop.yml +17 -0
- data/.ruby-version +1 -0
- data/CHANGELOG.md +5 -0
- data/CONTRIBUTING.md +245 -0
- data/Gemfile +6 -0
- data/Gemfile.lock +85 -0
- data/LICENSE.txt +201 -0
- data/README.md +16 -0
- data/Rakefile +23 -0
- data/dut.gemspec +34 -0
- data/lib/dut/version.rb +5 -0
- data/lib/dut.rb +3 -0
- data/spec/rubocop_spec.rb +9 -0
- data/spec/spec_helper.rb +4 -0
- data/tasks/ci.rake +16 -0
- data/vendor/cache/activesupport-7.0.3.gem +0 -0
- data/vendor/cache/ast-2.4.2.gem +0 -0
- data/vendor/cache/concurrent-ruby-1.1.10.gem +0 -0
- data/vendor/cache/diff-lcs-1.5.0.gem +0 -0
- data/vendor/cache/i18n-1.10.0.gem +0 -0
- data/vendor/cache/minitest-5.15.0.gem +0 -0
- data/vendor/cache/parallel-1.22.1.gem +0 -0
- data/vendor/cache/parser-3.1.2.0.gem +0 -0
- data/vendor/cache/psych-4.0.4.gem +0 -0
- data/vendor/cache/rack-2.2.3.gem +0 -0
- data/vendor/cache/rainbow-3.1.1.gem +0 -0
- data/vendor/cache/rake-11.3.0.gem +0 -0
- data/vendor/cache/rdoc-6.4.0.gem +0 -0
- data/vendor/cache/regexp_parser-2.4.0.gem +0 -0
- data/vendor/cache/rexml-3.2.5.gem +0 -0
- data/vendor/cache/rspec-3.11.0.gem +0 -0
- data/vendor/cache/rspec-core-3.11.0.gem +0 -0
- data/vendor/cache/rspec-expectations-3.11.0.gem +0 -0
- data/vendor/cache/rspec-mocks-3.11.1.gem +0 -0
- data/vendor/cache/rspec-support-3.11.0.gem +0 -0
- data/vendor/cache/rspec_junit_formatter-0.5.1.gem +0 -0
- data/vendor/cache/rubocop-1.30.0.gem +0 -0
- data/vendor/cache/rubocop-ast-1.18.0.gem +0 -0
- data/vendor/cache/rubocop-rails-2.14.2.gem +0 -0
- data/vendor/cache/ruby-progressbar-1.11.0.gem +0 -0
- data/vendor/cache/sdoc-2.4.0.gem +0 -0
- data/vendor/cache/stringio-3.0.2.gem +0 -0
- data/vendor/cache/tzinfo-2.0.4.gem +0 -0
- data/vendor/cache/unicode-display_width-2.1.0.gem +0 -0
- metadata +207 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: bd9f20373355d4e361156aeff57feebff793bef7b580adce65db1a7a2a1ef9d3
|
|
4
|
+
data.tar.gz: 42dbab45d107aaf4c5650b7d88cff2bb8cce6562bf971a2b4b8fbeeb126e50b8
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: e15830034534b0df35c4c372bc7f482d56c3673d9e90a3dfc946a9e24fa9691ad1d3923670039862b0ea128bfee9cf44fda77af7895f21b3750a8705572471fa
|
|
7
|
+
data.tar.gz: 42a399e3144c5f8d0617a2493e78c21a67c2c181d0bacccdcc335ef5e27756b692a71d50c9803f732c5c879a3b13ac2fdd963da445a9d13bdc2b088cee2945b1
|
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
version: 2.1
|
|
2
|
+
|
|
3
|
+
orbs:
|
|
4
|
+
gem: doximity/gem-publisher@0
|
|
5
|
+
|
|
6
|
+
executors:
|
|
7
|
+
ruby-latest:
|
|
8
|
+
resource_class: small
|
|
9
|
+
docker:
|
|
10
|
+
- image: circleci/ruby:latest
|
|
11
|
+
environment:
|
|
12
|
+
BUNDLE_VERSION: "~> 2.3"
|
|
13
|
+
|
|
14
|
+
# yaml anchor filters
|
|
15
|
+
master_only: &master_only
|
|
16
|
+
filters:
|
|
17
|
+
branches:
|
|
18
|
+
only: master
|
|
19
|
+
tags:
|
|
20
|
+
ignore: /.*/
|
|
21
|
+
|
|
22
|
+
pr_only: &pr_only
|
|
23
|
+
filters:
|
|
24
|
+
branches:
|
|
25
|
+
ignore: master
|
|
26
|
+
tags:
|
|
27
|
+
ignore: /.*/
|
|
28
|
+
|
|
29
|
+
version_tags_only: &version_tags_only
|
|
30
|
+
filters:
|
|
31
|
+
branches:
|
|
32
|
+
ignore: /.*/
|
|
33
|
+
tags:
|
|
34
|
+
only: /^v.*/
|
|
35
|
+
|
|
36
|
+
jobs:
|
|
37
|
+
build:
|
|
38
|
+
executor: ruby-latest
|
|
39
|
+
steps:
|
|
40
|
+
- checkout
|
|
41
|
+
- run:
|
|
42
|
+
name: Install Bundler specific version
|
|
43
|
+
command: |
|
|
44
|
+
gem install bundler --version "${BUNDLE_VERSION}" --force
|
|
45
|
+
bundle config set --local path 'vendor/bundle'
|
|
46
|
+
bundle config set --local frozen 'true'
|
|
47
|
+
bundle config set --local jobs '4'
|
|
48
|
+
bundle config set --local retry '3'
|
|
49
|
+
- restore_cache:
|
|
50
|
+
keys:
|
|
51
|
+
- v1-bundle-{{ checksum "Gemfile.lock" }}-
|
|
52
|
+
- run:
|
|
53
|
+
name: Install Ruby Dependencies
|
|
54
|
+
command: bundle install --local
|
|
55
|
+
- save_cache:
|
|
56
|
+
key: v1-bundle-{{ checksum "Gemfile.lock" }}-
|
|
57
|
+
paths:
|
|
58
|
+
- vendor/bundle
|
|
59
|
+
- run:
|
|
60
|
+
name: Run Rubocop
|
|
61
|
+
command: bundle exec rake ci:rubocop
|
|
62
|
+
- run:
|
|
63
|
+
name: Run Tests
|
|
64
|
+
command: bundle exec rake ci:specs
|
|
65
|
+
- store_test_results:
|
|
66
|
+
name: Store test results
|
|
67
|
+
path: tmp/test-results
|
|
68
|
+
- run:
|
|
69
|
+
name: Build documentation
|
|
70
|
+
command: bundle exec rake ci:doc
|
|
71
|
+
- store_artifacts:
|
|
72
|
+
name: Saves documentation
|
|
73
|
+
path: doc
|
|
74
|
+
- persist_to_workspace:
|
|
75
|
+
root: .
|
|
76
|
+
paths:
|
|
77
|
+
- vendor/bundle
|
|
78
|
+
|
|
79
|
+
workflows:
|
|
80
|
+
version: 2
|
|
81
|
+
|
|
82
|
+
trunk:
|
|
83
|
+
jobs:
|
|
84
|
+
- build:
|
|
85
|
+
<<: *master_only
|
|
86
|
+
- gem/build:
|
|
87
|
+
<<: *master_only
|
|
88
|
+
executor: ruby-latest
|
|
89
|
+
name: gem-build
|
|
90
|
+
requires:
|
|
91
|
+
- build
|
|
92
|
+
|
|
93
|
+
pull-requests:
|
|
94
|
+
jobs:
|
|
95
|
+
- build:
|
|
96
|
+
<<: *pr_only
|
|
97
|
+
- gem/build:
|
|
98
|
+
<<: *pr_only
|
|
99
|
+
executor: ruby-latest
|
|
100
|
+
name: gem-build
|
|
101
|
+
requires:
|
|
102
|
+
- build
|
|
103
|
+
- pre-release-approval:
|
|
104
|
+
<<: *pr_only
|
|
105
|
+
type: approval
|
|
106
|
+
requires:
|
|
107
|
+
- gem-build
|
|
108
|
+
- gem/publish:
|
|
109
|
+
<<: *pr_only
|
|
110
|
+
name: gem-publish
|
|
111
|
+
to_rubygems: true
|
|
112
|
+
pre_release: true
|
|
113
|
+
requires:
|
|
114
|
+
- pre-release-approval
|
|
115
|
+
context: artifact_publishing
|
|
116
|
+
|
|
117
|
+
final-release:
|
|
118
|
+
jobs:
|
|
119
|
+
- build:
|
|
120
|
+
<<: *version_tags_only
|
|
121
|
+
- gem/build:
|
|
122
|
+
<<: *version_tags_only
|
|
123
|
+
executor: ruby-latest
|
|
124
|
+
name: gem-build
|
|
125
|
+
requires:
|
|
126
|
+
- build
|
|
127
|
+
- gem/publish:
|
|
128
|
+
<<: *version_tags_only
|
|
129
|
+
name: gem-publish
|
|
130
|
+
to_rubygems: true
|
|
131
|
+
pre_release: false
|
|
132
|
+
requires:
|
|
133
|
+
- gem-build
|
|
134
|
+
context: artifact_publishing
|
data/.github/CODEOWNERS
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
Overview
|
|
2
|
+
--------
|
|
3
|
+
|
|
4
|
+
<!-- High-level description of what is being changed and why. -->
|
|
5
|
+
|
|
6
|
+
Technical Details
|
|
7
|
+
-----------------
|
|
8
|
+
|
|
9
|
+
<!-- Explain non-obvious technical changes, the reasoning behind them, any compromises involved, etc.
|
|
10
|
+
(Remove this section if you have nothing to add here.) -->
|
|
11
|
+
|
|
12
|
+
Testing Instructions
|
|
13
|
+
---------------
|
|
14
|
+
|
|
15
|
+
<!-- Please replace this with testing instructions. -->
|
data/.gitignore
ADDED
data/.rubocop.yml
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
require:
|
|
2
|
+
- rubocop-rails
|
|
3
|
+
|
|
4
|
+
Style/StringLiterals:
|
|
5
|
+
Enabled: false
|
|
6
|
+
|
|
7
|
+
Metrics/BlockLength:
|
|
8
|
+
Enabled: false
|
|
9
|
+
|
|
10
|
+
Naming/FileName:
|
|
11
|
+
Enabled: false
|
|
12
|
+
|
|
13
|
+
Naming/MethodParameterName:
|
|
14
|
+
Enabled: false
|
|
15
|
+
|
|
16
|
+
Rails/RakeEnvironment:
|
|
17
|
+
Enabled: false
|
data/.ruby-version
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
2.7.5
|
data/CHANGELOG.md
ADDED
data/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,245 @@
|
|
|
1
|
+
# Contributing
|
|
2
|
+
|
|
3
|
+
This document lists the current best the practices adopted by the team to provide a consistent workflow that contributes
|
|
4
|
+
to high quality code, improves communication of behaviors, reduce noise and helps automate common activities.
|
|
5
|
+
|
|
6
|
+
Please read this with attention and respect the suggestions when contributing.
|
|
7
|
+
|
|
8
|
+
## Table of Contents
|
|
9
|
+
|
|
10
|
+
1. [Code, Architecture and APIs](#code-architecture-and-apis)
|
|
11
|
+
2. [Development, Refactoring and Tests](#development-refactoring-and-tests)
|
|
12
|
+
1. [Good Practices](#good-practices)
|
|
13
|
+
2. [Test (As a living documentation)](#test-as-a-living-documentation)
|
|
14
|
+
3. [Git](#git)
|
|
15
|
+
1. [Workflow](#workflow)
|
|
16
|
+
2. [Commit Style Guide](#commit-style-guide)
|
|
17
|
+
3. [Template](#template)
|
|
18
|
+
4. [Changelog Types](#changelog-types)
|
|
19
|
+
5. [Branch Style Guide](#branch-style-guide)
|
|
20
|
+
4. [Visual Changes](#visual-changes)
|
|
21
|
+
5. [Debug and bug report](#debug-and-bug-report)
|
|
22
|
+
|
|
23
|
+
## Code, Architecture and APIs
|
|
24
|
+
|
|
25
|
+
We embrace the principles of Domain Driven Design[^ddd] and Hexagonal Architecture[^hexagonal-architecture] because we
|
|
26
|
+
believe they provide a strong foundation in terms of communication of internal behaviors and the decoupling of components
|
|
27
|
+
of the system using layers.
|
|
28
|
+
One of the values of the team is to improve the _User Experience (UX)_ and _Developer Experience (DevEx)_ of the users
|
|
29
|
+
and developers using the system by providing solutions that are easy to adopt and easy to understand, independently of
|
|
30
|
+
previous experience. Therefore we direct the development and the acceptance of Pull Requests to align to these premisses.
|
|
31
|
+
This aims to permit that product and stream-aligned teams focus solely in the core subject of their systems and do not
|
|
32
|
+
waste time on setup and understanding of platforms and support systems.
|
|
33
|
+
|
|
34
|
+
[^ddd]: https://www.amazon.com/Domain-Driven-Design-Tackling-Complexity-Software/dp/0321125215/ref=sr_1_1?crid=3CKS9W9SZNMXM&keywords=domain+driven+design&qid=1644428951&sprefix=domain+driven+desig%2Caps%2C205&sr=8-1
|
|
35
|
+
[^hexagonal-architecture]: https://en.wikipedia.org/wiki/Hexagonal_architecture_(software)
|
|
36
|
+
|
|
37
|
+
## Development, Refactoring and Tests
|
|
38
|
+
|
|
39
|
+
We apply _Test Driven Development_[^tdd][^tdd-better-software] and expect any contribution to do the same, following the
|
|
40
|
+
_red-green-refactor_ cycle. To improve immediate feedback on the changes and minimize long unsaved changes that might
|
|
41
|
+
break behavior, run `guard` with the provided `Guardfile` so that the specs for the code under development are run as
|
|
42
|
+
soon as the file is saved.
|
|
43
|
+
Save after every line change ideally[^sandy-books].
|
|
44
|
+
|
|
45
|
+
It is possible to run `guard` for an app with or without `*-test` container or for a gem:
|
|
46
|
+
|
|
47
|
+
#### App with no test container
|
|
48
|
+
|
|
49
|
+
dox-do bundle exec guard
|
|
50
|
+
|
|
51
|
+
#### App with test container
|
|
52
|
+
|
|
53
|
+
dox-dc exec dox-dut-service-test bundle exec guard
|
|
54
|
+
|
|
55
|
+
#### Gem (from any light app, `foundation` in this case)
|
|
56
|
+
|
|
57
|
+
dox-dc exec foundation bash -c "cd /opt/dox-gems/dox-messaging && BUNDLE_GEMFILE=\`pwd\`/Gemfile bundle exec guard"
|
|
58
|
+
|
|
59
|
+
### Good Practices
|
|
60
|
+
|
|
61
|
+
**FAVOR**: Make concepts explicit and clear to users of the system
|
|
62
|
+
**FAVOR**: Use _interfaces_ over implementation
|
|
63
|
+
**FAVOR**: Keep implementation details in deeper layers
|
|
64
|
+
**FAVOR**: Leave the code better than you found
|
|
65
|
+
**FAVOR**: _Refactor_ judiciously during development
|
|
66
|
+
**FAVOR**: _Object_, _Methods_ and _Composition_ instead of class methods
|
|
67
|
+
**FAVOR**: Use explicit method declarations instead of meta-programming
|
|
68
|
+
|
|
69
|
+
By using the above suggestion of TDD this will be natural as _Class_ methods and meta-programming are harder to test,
|
|
70
|
+
harder to use, harder to debug and ultimately less communicative.
|
|
71
|
+
|
|
72
|
+
Follow **CUPID**[^cupid] properties:
|
|
73
|
+
- [**C**omposable](https://dannorth.net/2022/02/10/cupid-for-joyful-coding/#composable): plays well with others
|
|
74
|
+
- [**U**nix philosophy](https://dannorth.net/2022/02/10/cupid-for-joyful-coding/#unix-philosophy): does one thing well
|
|
75
|
+
- [**P**redictable](https://dannorth.net/2022/02/10/cupid-for-joyful-coding/#predictable): does what you expect
|
|
76
|
+
- [**I**diomatic](https://dannorth.net/2022/02/10/cupid-for-joyful-coding/#idiomatic): feels natural
|
|
77
|
+
- [**D**omain-based](https://dannorth.net/2022/02/10/cupid-for-joyful-coding/#domain-based): the solution domain models the problem domain in language and structure
|
|
78
|
+
|
|
79
|
+
**AVOID**: the use _meta-programming_ and procedural code hidden in non-concept related "object" objects like the _Rails
|
|
80
|
+
Service Object_ (which is not a service from the DDD definition[^ddd]). Consider a more object oriented approach and
|
|
81
|
+
consult good references for it regarding naming, responsibilities, methods, etc, like the following:
|
|
82
|
+
[Your coding conventions are hurting you](http://www.carlopescio.com/2011/04/your-coding-conventions-are-hurting-you.html),
|
|
83
|
+
[Enough With the Service Objects Already](https://avdi.codes/service-objects/),
|
|
84
|
+
[Beware of “service objects” in Rails](https://www.codewithjason.com/rails-service-objects/)
|
|
85
|
+
|
|
86
|
+
[^tdd]: https://en.wikipedia.org/wiki/Test-driven_development#Test-driven_development_cycle
|
|
87
|
+
[^tdd-better-software]: https://www.youtube.com/watch?v=fSvQNG7Rz-8
|
|
88
|
+
[^sandy-books]: https://sandimetz.com/products
|
|
89
|
+
[^cupid]: https://dannorth.net/2022/02/10/cupid-for-joyful-coding/
|
|
90
|
+
|
|
91
|
+
### Test (As a living documentation)
|
|
92
|
+
|
|
93
|
+
We apply _BDD (Behavioral Driven Design)_ with _Rspec_ as our preferred tool to test and they provide the best
|
|
94
|
+
combination of easy to write and powerful specs and clear communication of intent via behavior description.
|
|
95
|
+
_BDD_ is focused on the behavior of the system or part of it, not methods. Secondly, Unit test refers to a system's unit,
|
|
96
|
+
not a method as well. So a Car class, for instance, is a Unit in the system and its unit tests mock all its dependencies
|
|
97
|
+
and test its behavior in isolation.
|
|
98
|
+
Therefore, we do not use _method_ names in specs and clearly define the behavior so intent is clearly documented for future
|
|
99
|
+
developers. For a longer description with examples, consult a
|
|
100
|
+
[response to BetterSpecs](https://github.com/betterspecs/betterspecs/issues/2#issuecomment-894498097)
|
|
101
|
+
Focus on the **WHAT** and not in the **HOW**[^bdd-what].
|
|
102
|
+
|
|
103
|
+
[^bdd-what]: https://www.youtube.com/watch?v=YAZr3LsCzn0
|
|
104
|
+
|
|
105
|
+
## Git
|
|
106
|
+
|
|
107
|
+
### Workflow
|
|
108
|
+
|
|
109
|
+
The workflow follows four simple rules:
|
|
110
|
+
|
|
111
|
+
1. (main|master) is always deployable (no broken commits / with failing specs)
|
|
112
|
+
2. always rebase (`git pull --rebase`)
|
|
113
|
+
3. short-lived branches
|
|
114
|
+
1. aim for 1 day maximum and avoid keeping branches alive for more than 2-3 days
|
|
115
|
+
4. rebase branch over (main|master) before Merge Request (`git rebase master` from inside the branch)
|
|
116
|
+
1. avoid automatic generated merges in the branch direction
|
|
117
|
+
|
|
118
|
+
We prefer a trunk-based workflow and branch by abstraction with feature flags[^ci-vs-branches][^ci-feature-branching]
|
|
119
|
+
and do not use `git-flow` or similar as they hinder quality by delaying integration[^no-gitflow]. We accept some
|
|
120
|
+
limitations of `Github-flow`[^github-flow] given the remote nature of the company, but prefer _rebase_ over _merge_ to
|
|
121
|
+
get a cleaner history of branches when they are to be merge to main/master.
|
|
122
|
+
**DO NOT** squash[^no-squash] when merging. If needed be, use `--squash` or `--fixup` options for minor fixes to
|
|
123
|
+
commits on branches.
|
|
124
|
+
|
|
125
|
+
[^ci-vs-branches]: https://www.youtube.com/watch?v=v4Ijkq6Myfc
|
|
126
|
+
[^ci-feature-branching]: https://www.youtube.com/watch?v=lXQEi1O5IOI
|
|
127
|
+
[^no-gitflow]: https://www.youtube.com/watch?v=_w6TwnLCFwA
|
|
128
|
+
[^github-flow]: https://githubflow.github.io/
|
|
129
|
+
[^no-squash]: https://blog.ploeh.dk/2020/10/05/fortunately-i-dont-squash-my-commits/
|
|
130
|
+
|
|
131
|
+
### Commit Style Guide
|
|
132
|
+
|
|
133
|
+
The commit style follow good practices listed in ["What makes a good commit message"](https://dev.to/cvortmann/what-makes-a-good-commit-message-181i)
|
|
134
|
+
and related post. These practices were turned into a template[^message-template] that is used whenever you
|
|
135
|
+
`git commit` and setup via git config[^template-config] (See below).
|
|
136
|
+
This template also uses git trailer information (after the ---) to avoid clogging the message with non important
|
|
137
|
+
information and reduce unnecessary noise.
|
|
138
|
+
Use trailer information for any extra information like Jira card number, Pivotal ticket, Changelog, etc. The Jira card
|
|
139
|
+
number is automatically infered from the branch name when using the [format below](#branch-style-guid).
|
|
140
|
+
**AVOID** using these references on the title of the commit as well as the body when not necessary (like a link).
|
|
141
|
+
**AVOID** emojis in the title or body of commit, restrict them to the Github UI.
|
|
142
|
+
|
|
143
|
+
To setup the template and hooks use the following:
|
|
144
|
+
|
|
145
|
+
.config/git/setup
|
|
146
|
+
|
|
147
|
+
The two main trailers are:
|
|
148
|
+
- Jira-issue *or* Github-issue (when applied)
|
|
149
|
+
- Changelog
|
|
150
|
+
|
|
151
|
+
Specifying the [Changelog type](#changelog-types) correctly also helps to create more atomic commit with single
|
|
152
|
+
responsibility instead of adding everything in one commit.
|
|
153
|
+
The correct analogy to a commit is a `release` that would go directly to production instead of a `save button` that
|
|
154
|
+
adds all the changes at once.
|
|
155
|
+
Use `git add -p` to add just the needed changes and review them with `git diff --staged`.
|
|
156
|
+
Our end goal is to create high quality commit in branch as they were going directly to (main|master).
|
|
157
|
+
For a style checker you can use this hook[^hook] and this setup[^hook-setup] to make it available to all repos.
|
|
158
|
+
This is not enforced today, but might be automated in the future.
|
|
159
|
+
|
|
160
|
+
[^message-template]: https://github.com/jvortmann/dots/blob/main/git/message
|
|
161
|
+
[^template-config]: https://github.com/jvortmann/dots/blob/85d1798cf6145a36196909e4cf3898a44c159e91/git/config#L43
|
|
162
|
+
[^hook]: https://github.com/jvortmann/dots/blob/main/git/hooks/commit-msg
|
|
163
|
+
[^hook-setup]: https://github.com/jvortmann/dots/blob/85d1798cf6145a36196909e4cf3898a44c159e91/git/config#L40
|
|
164
|
+
|
|
165
|
+
#### References
|
|
166
|
+
|
|
167
|
+
- <http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html>
|
|
168
|
+
- <https://dev.to/cvortmann/what-makes-a-good-commit-message-181i>
|
|
169
|
+
- <http://karma-runner.github.io/0.10/dev/git-commit-msg.html>
|
|
170
|
+
- <https://github.com/agis-/git-style-guide>
|
|
171
|
+
|
|
172
|
+
### Template
|
|
173
|
+
|
|
174
|
+
Summarize changes in around 50 characters or less
|
|
175
|
+
|
|
176
|
+
More detailed explanatory text, if necessary. Wrap it to about 72
|
|
177
|
+
characters or so. In some contexts, the first line is treated as the
|
|
178
|
+
subject of the commit and the rest of the text as the body. The
|
|
179
|
+
blank line separating the summary from the body is critical (unless
|
|
180
|
+
you omit the body entirely); various tools like `log`, `shortlog`
|
|
181
|
+
and `rebase` can get confused if you run the two together.
|
|
182
|
+
|
|
183
|
+
Explain the problem that this commit is solving. Focus on why you
|
|
184
|
+
are making this change as opposed to how (the code explains that).
|
|
185
|
+
Are there side effects or other unintuitive consequences of this
|
|
186
|
+
change? Here's the place to explain them.
|
|
187
|
+
|
|
188
|
+
Further paragraphs come after blank lines.
|
|
189
|
+
|
|
190
|
+
- Bullet points are okay, too
|
|
191
|
+
|
|
192
|
+
- Typically a hyphen or asterisk is used for the bullet, preceded
|
|
193
|
+
by a single space, with blank lines in between, but conventions
|
|
194
|
+
vary here
|
|
195
|
+
|
|
196
|
+
---
|
|
197
|
+
|
|
198
|
+
Jira-issue: MS-414
|
|
199
|
+
Github-action: close|fix|resolve #414
|
|
200
|
+
Changelog: feature|refactor|fix|doc|style|test|chore
|
|
201
|
+
Refactoring: removeDeadCode
|
|
202
|
+
See-also: 6ed2658fb9c4a9e93e3216f32071c030f14d7d28
|
|
203
|
+
|
|
204
|
+
Commit examples: [310aa9](https://github.com/doximity/dox-messaging/commit/310aa913d95ef465d17fc5886e719ebf2efb3192),
|
|
205
|
+
[7bb4b5](https://github.com/doximity/dox-messaging/commit/7bb4b5ed2ddfbea3705101d26023a63d2fc085d4),
|
|
206
|
+
[b9e069](https://github.com/doximity/dox-messaging/commit/b9e06944251963cfdb7cb02cc0232f2f3994a024),
|
|
207
|
+
[5f84d7](https://github.com/doximity/dox-messaging/commit/5f84d7c160888b4c6ca8b5b8db361537c2ea0e61),
|
|
208
|
+
[667a50](https://github.com/doximity/dox-messaging/commit/667a50a46659ae20721efc6e8be4ff9e3768a7d7).
|
|
209
|
+
|
|
210
|
+
### Changelog Types
|
|
211
|
+
|
|
212
|
+
- `feature`: Change behavior, interface or adds new functionality
|
|
213
|
+
- `fix`: Fix bugs
|
|
214
|
+
- `doc`: Change to documentation, README, CHANGELOG etc
|
|
215
|
+
- `style`: Format, missing semi colons, changes in whitespace, coding style in general
|
|
216
|
+
- `refactor`: Refactor production code, no functionality or behavior change, move method, rename variables
|
|
217
|
+
- `test`: Add missing tests, improve tests; no production code change
|
|
218
|
+
- `chore`: Update gems; no production code change
|
|
219
|
+
|
|
220
|
+
Check the existing commits for examples of each type.
|
|
221
|
+
|
|
222
|
+
### Branch Style Guide
|
|
223
|
+
|
|
224
|
+
The branches use the following template:
|
|
225
|
+
|
|
226
|
+
{jira-issue-number}/{dash-separated-card-title}
|
|
227
|
+
|
|
228
|
+
Example: `git switch -c MS-414/add-contributing-document`
|
|
229
|
+
|
|
230
|
+
## Visual changes
|
|
231
|
+
|
|
232
|
+
When opening a merge request that contains visual changes, it is recommended to add an image, video or GIF of the change.
|
|
233
|
+
Giphy Capture can be used: <https://giphy.com/apps/giphycapture>
|
|
234
|
+
|
|
235
|
+
## Debug and bug report
|
|
236
|
+
|
|
237
|
+
Rely on error messages to identify potential issues or direct a debugging session.
|
|
238
|
+
When opening a bug report, provide
|
|
239
|
+
all information possible, like:
|
|
240
|
+
- gem version
|
|
241
|
+
- ruby version
|
|
242
|
+
- full stack-trace
|
|
243
|
+
- log entries
|
|
244
|
+
- steps to reproduce
|
|
245
|
+
|
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
PATH
|
|
2
|
+
remote: .
|
|
3
|
+
specs:
|
|
4
|
+
dut (0.0.1)
|
|
5
|
+
|
|
6
|
+
GEM
|
|
7
|
+
remote: https://rubygems.org/
|
|
8
|
+
specs:
|
|
9
|
+
activesupport (7.0.3)
|
|
10
|
+
concurrent-ruby (~> 1.0, >= 1.0.2)
|
|
11
|
+
i18n (>= 1.6, < 2)
|
|
12
|
+
minitest (>= 5.1)
|
|
13
|
+
tzinfo (~> 2.0)
|
|
14
|
+
ast (2.4.2)
|
|
15
|
+
concurrent-ruby (1.1.10)
|
|
16
|
+
diff-lcs (1.5.0)
|
|
17
|
+
i18n (1.10.0)
|
|
18
|
+
concurrent-ruby (~> 1.0)
|
|
19
|
+
minitest (5.15.0)
|
|
20
|
+
parallel (1.22.1)
|
|
21
|
+
parser (3.1.2.0)
|
|
22
|
+
ast (~> 2.4.1)
|
|
23
|
+
psych (4.0.4)
|
|
24
|
+
stringio
|
|
25
|
+
rack (2.2.3)
|
|
26
|
+
rainbow (3.1.1)
|
|
27
|
+
rake (11.3.0)
|
|
28
|
+
rdoc (6.4.0)
|
|
29
|
+
psych (>= 4.0.0)
|
|
30
|
+
regexp_parser (2.4.0)
|
|
31
|
+
rexml (3.2.5)
|
|
32
|
+
rspec (3.11.0)
|
|
33
|
+
rspec-core (~> 3.11.0)
|
|
34
|
+
rspec-expectations (~> 3.11.0)
|
|
35
|
+
rspec-mocks (~> 3.11.0)
|
|
36
|
+
rspec-core (3.11.0)
|
|
37
|
+
rspec-support (~> 3.11.0)
|
|
38
|
+
rspec-expectations (3.11.0)
|
|
39
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
|
40
|
+
rspec-support (~> 3.11.0)
|
|
41
|
+
rspec-mocks (3.11.1)
|
|
42
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
|
43
|
+
rspec-support (~> 3.11.0)
|
|
44
|
+
rspec-support (3.11.0)
|
|
45
|
+
rspec_junit_formatter (0.5.1)
|
|
46
|
+
rspec-core (>= 2, < 4, != 2.12.0)
|
|
47
|
+
rubocop (1.30.0)
|
|
48
|
+
parallel (~> 1.10)
|
|
49
|
+
parser (>= 3.1.0.0)
|
|
50
|
+
rainbow (>= 2.2.2, < 4.0)
|
|
51
|
+
regexp_parser (>= 1.8, < 3.0)
|
|
52
|
+
rexml (>= 3.2.5, < 4.0)
|
|
53
|
+
rubocop-ast (>= 1.18.0, < 2.0)
|
|
54
|
+
ruby-progressbar (~> 1.7)
|
|
55
|
+
unicode-display_width (>= 1.4.0, < 3.0)
|
|
56
|
+
rubocop-ast (1.18.0)
|
|
57
|
+
parser (>= 3.1.1.0)
|
|
58
|
+
rubocop-rails (2.14.2)
|
|
59
|
+
activesupport (>= 4.2.0)
|
|
60
|
+
rack (>= 1.1)
|
|
61
|
+
rubocop (>= 1.7.0, < 2.0)
|
|
62
|
+
ruby-progressbar (1.11.0)
|
|
63
|
+
sdoc (2.4.0)
|
|
64
|
+
rdoc (>= 5.0)
|
|
65
|
+
stringio (3.0.2)
|
|
66
|
+
tzinfo (2.0.4)
|
|
67
|
+
concurrent-ruby (~> 1.0)
|
|
68
|
+
unicode-display_width (2.1.0)
|
|
69
|
+
|
|
70
|
+
PLATFORMS
|
|
71
|
+
x86_64-darwin-21
|
|
72
|
+
x86_64-linux
|
|
73
|
+
|
|
74
|
+
DEPENDENCIES
|
|
75
|
+
bundler (~> 2.3.12)
|
|
76
|
+
dut!
|
|
77
|
+
rake (~> 11.2, >= 11.2.2)
|
|
78
|
+
rspec (~> 3.11)
|
|
79
|
+
rspec_junit_formatter
|
|
80
|
+
rubocop (~> 1.30)
|
|
81
|
+
rubocop-rails (~> 2.14, >= 2.14.2)
|
|
82
|
+
sdoc (~> 2.4)
|
|
83
|
+
|
|
84
|
+
BUNDLED WITH
|
|
85
|
+
2.3.14
|
data/LICENSE.txt
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2022 Doximity
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
data/README.md
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# DUT
|
|
2
|
+
Data Update Tool facilitates efficient bulk-updating of data in Ruby applications
|
|
3
|
+
|
|
4
|
+
## Installation
|
|
5
|
+
..
|
|
6
|
+
## Usage
|
|
7
|
+
..
|
|
8
|
+
|
|
9
|
+
## Contributing
|
|
10
|
+
Please read the full [Contributing Guide](CONTRIBUTING.md) with attention and respect the suggestions as well as the
|
|
11
|
+
guidelines from the [Code of Conduct](CODE_OF_CONDUCT.md) when contributing.
|
|
12
|
+
|
|
13
|
+
[](CODE_OF_CONDUCT.md)
|
|
14
|
+
|
|
15
|
+
## License
|
|
16
|
+
The gem is licensed under an Apache 2 license. Contributors are required to sign a contributor license agreement. See [LICENSE.txt](./LICENSE.txt) and [CONTRIBUTING.md](./CONTRIBUTING.md) for more information.
|
data/Rakefile
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require File.join("bundler", "gem_tasks")
|
|
4
|
+
require File.join("rspec", "core", "rake_task")
|
|
5
|
+
require "sdoc"
|
|
6
|
+
|
|
7
|
+
FileList["tasks/*.rake"].each { |task| load task }
|
|
8
|
+
|
|
9
|
+
RSpec::Core::RakeTask.new(:spec)
|
|
10
|
+
|
|
11
|
+
task default: :spec
|
|
12
|
+
|
|
13
|
+
RDoc::Task.new do |rdoc|
|
|
14
|
+
rdoc.main = "README.md"
|
|
15
|
+
rdoc.markup = "tomdoc"
|
|
16
|
+
rdoc.options << "--format=sdoc"
|
|
17
|
+
rdoc.options << "--github --encoding=UTF-8"
|
|
18
|
+
rdoc.rdoc_dir = "doc"
|
|
19
|
+
rdoc.rdoc_files.exclude("vendor", "tmp")
|
|
20
|
+
rdoc.rdoc_files.include("README.md", "lib", "*.rb")
|
|
21
|
+
rdoc.template = "rails"
|
|
22
|
+
rdoc.title = "omniauth-doximity Documentation"
|
|
23
|
+
end
|
data/dut.gemspec
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require 'English'
|
|
4
|
+
require File.expand_path('lib/dut/version', __dir__)
|
|
5
|
+
|
|
6
|
+
Gem::Specification.new do |spec|
|
|
7
|
+
spec.name = "dut"
|
|
8
|
+
spec.version = Dut::VERSION
|
|
9
|
+
spec.authors = ["Carlos Gabaldon"]
|
|
10
|
+
spec.email = ["cgabaldon@doximity.com"]
|
|
11
|
+
spec.description = 'Data Update Tool facilitates efficient bulk-updating of data in Ruby applications'
|
|
12
|
+
spec.summary = 'Data Update Tool'
|
|
13
|
+
spec.homepage = "https://github.com/doximity/dut.git"
|
|
14
|
+
spec.license = "Apache-2.0"
|
|
15
|
+
|
|
16
|
+
spec.required_ruby_version = Gem::Requirement.new(">= 2.7.5")
|
|
17
|
+
|
|
18
|
+
spec.metadata["homepage_uri"] = spec.homepage
|
|
19
|
+
spec.metadata["source_code_uri"] = spec.homepage
|
|
20
|
+
spec.metadata["changelog_uri"] = "https://github.com/doximity/dut/blob/master/CHANGELOG.md"
|
|
21
|
+
|
|
22
|
+
spec.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
|
|
23
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
|
24
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
|
25
|
+
spec.require_paths = ["lib"]
|
|
26
|
+
|
|
27
|
+
spec.add_development_dependency "bundler", "~> 2.3.12"
|
|
28
|
+
spec.add_development_dependency "rake", '~> 11.2', '>= 11.2.2'
|
|
29
|
+
spec.add_development_dependency "rspec", '~> 3.11'
|
|
30
|
+
spec.add_development_dependency "rspec_junit_formatter" # required for the ci raketask
|
|
31
|
+
spec.add_development_dependency "rubocop", '~> 1.30'
|
|
32
|
+
spec.add_development_dependency "rubocop-rails", '~> 2.14', '>= 2.14.2'
|
|
33
|
+
spec.add_development_dependency "sdoc", '~> 2.4'
|
|
34
|
+
end
|
data/lib/dut/version.rb
ADDED
data/lib/dut.rb
ADDED
data/spec/spec_helper.rb
ADDED
data/tasks/ci.rake
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
namespace :ci do
|
|
4
|
+
desc "Run tests"
|
|
5
|
+
task :specs do
|
|
6
|
+
sh "bundle exec rspec --color spec --format progress"
|
|
7
|
+
end
|
|
8
|
+
|
|
9
|
+
desc "Run rubocop"
|
|
10
|
+
task :rubocop do
|
|
11
|
+
sh "bundle exec rubocop --display-cop-names --extra-details --display-style-guide"
|
|
12
|
+
end
|
|
13
|
+
|
|
14
|
+
desc "Build documentation"
|
|
15
|
+
task doc: :rdoc
|
|
16
|
+
end
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
metadata
ADDED
|
@@ -0,0 +1,207 @@
|
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
|
2
|
+
name: dut
|
|
3
|
+
version: !ruby/object:Gem::Version
|
|
4
|
+
version: 0.0.1
|
|
5
|
+
platform: ruby
|
|
6
|
+
authors:
|
|
7
|
+
- Carlos Gabaldon
|
|
8
|
+
autorequire:
|
|
9
|
+
bindir: bin
|
|
10
|
+
cert_chain: []
|
|
11
|
+
date: 2022-05-26 00:00:00.000000000 Z
|
|
12
|
+
dependencies:
|
|
13
|
+
- !ruby/object:Gem::Dependency
|
|
14
|
+
name: bundler
|
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
|
16
|
+
requirements:
|
|
17
|
+
- - "~>"
|
|
18
|
+
- !ruby/object:Gem::Version
|
|
19
|
+
version: 2.3.12
|
|
20
|
+
type: :development
|
|
21
|
+
prerelease: false
|
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
23
|
+
requirements:
|
|
24
|
+
- - "~>"
|
|
25
|
+
- !ruby/object:Gem::Version
|
|
26
|
+
version: 2.3.12
|
|
27
|
+
- !ruby/object:Gem::Dependency
|
|
28
|
+
name: rake
|
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
|
30
|
+
requirements:
|
|
31
|
+
- - "~>"
|
|
32
|
+
- !ruby/object:Gem::Version
|
|
33
|
+
version: '11.2'
|
|
34
|
+
- - ">="
|
|
35
|
+
- !ruby/object:Gem::Version
|
|
36
|
+
version: 11.2.2
|
|
37
|
+
type: :development
|
|
38
|
+
prerelease: false
|
|
39
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
40
|
+
requirements:
|
|
41
|
+
- - "~>"
|
|
42
|
+
- !ruby/object:Gem::Version
|
|
43
|
+
version: '11.2'
|
|
44
|
+
- - ">="
|
|
45
|
+
- !ruby/object:Gem::Version
|
|
46
|
+
version: 11.2.2
|
|
47
|
+
- !ruby/object:Gem::Dependency
|
|
48
|
+
name: rspec
|
|
49
|
+
requirement: !ruby/object:Gem::Requirement
|
|
50
|
+
requirements:
|
|
51
|
+
- - "~>"
|
|
52
|
+
- !ruby/object:Gem::Version
|
|
53
|
+
version: '3.11'
|
|
54
|
+
type: :development
|
|
55
|
+
prerelease: false
|
|
56
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
57
|
+
requirements:
|
|
58
|
+
- - "~>"
|
|
59
|
+
- !ruby/object:Gem::Version
|
|
60
|
+
version: '3.11'
|
|
61
|
+
- !ruby/object:Gem::Dependency
|
|
62
|
+
name: rspec_junit_formatter
|
|
63
|
+
requirement: !ruby/object:Gem::Requirement
|
|
64
|
+
requirements:
|
|
65
|
+
- - ">="
|
|
66
|
+
- !ruby/object:Gem::Version
|
|
67
|
+
version: '0'
|
|
68
|
+
type: :development
|
|
69
|
+
prerelease: false
|
|
70
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
71
|
+
requirements:
|
|
72
|
+
- - ">="
|
|
73
|
+
- !ruby/object:Gem::Version
|
|
74
|
+
version: '0'
|
|
75
|
+
- !ruby/object:Gem::Dependency
|
|
76
|
+
name: rubocop
|
|
77
|
+
requirement: !ruby/object:Gem::Requirement
|
|
78
|
+
requirements:
|
|
79
|
+
- - "~>"
|
|
80
|
+
- !ruby/object:Gem::Version
|
|
81
|
+
version: '1.30'
|
|
82
|
+
type: :development
|
|
83
|
+
prerelease: false
|
|
84
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
85
|
+
requirements:
|
|
86
|
+
- - "~>"
|
|
87
|
+
- !ruby/object:Gem::Version
|
|
88
|
+
version: '1.30'
|
|
89
|
+
- !ruby/object:Gem::Dependency
|
|
90
|
+
name: rubocop-rails
|
|
91
|
+
requirement: !ruby/object:Gem::Requirement
|
|
92
|
+
requirements:
|
|
93
|
+
- - "~>"
|
|
94
|
+
- !ruby/object:Gem::Version
|
|
95
|
+
version: '2.14'
|
|
96
|
+
- - ">="
|
|
97
|
+
- !ruby/object:Gem::Version
|
|
98
|
+
version: 2.14.2
|
|
99
|
+
type: :development
|
|
100
|
+
prerelease: false
|
|
101
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
102
|
+
requirements:
|
|
103
|
+
- - "~>"
|
|
104
|
+
- !ruby/object:Gem::Version
|
|
105
|
+
version: '2.14'
|
|
106
|
+
- - ">="
|
|
107
|
+
- !ruby/object:Gem::Version
|
|
108
|
+
version: 2.14.2
|
|
109
|
+
- !ruby/object:Gem::Dependency
|
|
110
|
+
name: sdoc
|
|
111
|
+
requirement: !ruby/object:Gem::Requirement
|
|
112
|
+
requirements:
|
|
113
|
+
- - "~>"
|
|
114
|
+
- !ruby/object:Gem::Version
|
|
115
|
+
version: '2.4'
|
|
116
|
+
type: :development
|
|
117
|
+
prerelease: false
|
|
118
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
119
|
+
requirements:
|
|
120
|
+
- - "~>"
|
|
121
|
+
- !ruby/object:Gem::Version
|
|
122
|
+
version: '2.4'
|
|
123
|
+
description: Data Update Tool facilitates efficient bulk-updating of data in Ruby
|
|
124
|
+
applications
|
|
125
|
+
email:
|
|
126
|
+
- cgabaldon@doximity.com
|
|
127
|
+
executables: []
|
|
128
|
+
extensions: []
|
|
129
|
+
extra_rdoc_files: []
|
|
130
|
+
files:
|
|
131
|
+
- ".circleci/config.yml"
|
|
132
|
+
- ".github/CODEOWNERS"
|
|
133
|
+
- ".github/PULL_REQUEST_TEMPLATE.md"
|
|
134
|
+
- ".gitignore"
|
|
135
|
+
- ".rubocop.yml"
|
|
136
|
+
- ".ruby-version"
|
|
137
|
+
- CHANGELOG.md
|
|
138
|
+
- CONTRIBUTING.md
|
|
139
|
+
- Gemfile
|
|
140
|
+
- Gemfile.lock
|
|
141
|
+
- LICENSE.txt
|
|
142
|
+
- README.md
|
|
143
|
+
- Rakefile
|
|
144
|
+
- dut.gemspec
|
|
145
|
+
- lib/dut.rb
|
|
146
|
+
- lib/dut/version.rb
|
|
147
|
+
- spec/rubocop_spec.rb
|
|
148
|
+
- spec/spec_helper.rb
|
|
149
|
+
- tasks/ci.rake
|
|
150
|
+
- vendor/cache/activesupport-7.0.3.gem
|
|
151
|
+
- vendor/cache/ast-2.4.2.gem
|
|
152
|
+
- vendor/cache/concurrent-ruby-1.1.10.gem
|
|
153
|
+
- vendor/cache/diff-lcs-1.5.0.gem
|
|
154
|
+
- vendor/cache/i18n-1.10.0.gem
|
|
155
|
+
- vendor/cache/minitest-5.15.0.gem
|
|
156
|
+
- vendor/cache/parallel-1.22.1.gem
|
|
157
|
+
- vendor/cache/parser-3.1.2.0.gem
|
|
158
|
+
- vendor/cache/psych-4.0.4.gem
|
|
159
|
+
- vendor/cache/rack-2.2.3.gem
|
|
160
|
+
- vendor/cache/rainbow-3.1.1.gem
|
|
161
|
+
- vendor/cache/rake-11.3.0.gem
|
|
162
|
+
- vendor/cache/rdoc-6.4.0.gem
|
|
163
|
+
- vendor/cache/regexp_parser-2.4.0.gem
|
|
164
|
+
- vendor/cache/rexml-3.2.5.gem
|
|
165
|
+
- vendor/cache/rspec-3.11.0.gem
|
|
166
|
+
- vendor/cache/rspec-core-3.11.0.gem
|
|
167
|
+
- vendor/cache/rspec-expectations-3.11.0.gem
|
|
168
|
+
- vendor/cache/rspec-mocks-3.11.1.gem
|
|
169
|
+
- vendor/cache/rspec-support-3.11.0.gem
|
|
170
|
+
- vendor/cache/rspec_junit_formatter-0.5.1.gem
|
|
171
|
+
- vendor/cache/rubocop-1.30.0.gem
|
|
172
|
+
- vendor/cache/rubocop-ast-1.18.0.gem
|
|
173
|
+
- vendor/cache/rubocop-rails-2.14.2.gem
|
|
174
|
+
- vendor/cache/ruby-progressbar-1.11.0.gem
|
|
175
|
+
- vendor/cache/sdoc-2.4.0.gem
|
|
176
|
+
- vendor/cache/stringio-3.0.2.gem
|
|
177
|
+
- vendor/cache/tzinfo-2.0.4.gem
|
|
178
|
+
- vendor/cache/unicode-display_width-2.1.0.gem
|
|
179
|
+
homepage: https://github.com/doximity/dut.git
|
|
180
|
+
licenses:
|
|
181
|
+
- Apache-2.0
|
|
182
|
+
metadata:
|
|
183
|
+
homepage_uri: https://github.com/doximity/dut.git
|
|
184
|
+
source_code_uri: https://github.com/doximity/dut.git
|
|
185
|
+
changelog_uri: https://github.com/doximity/dut/blob/master/CHANGELOG.md
|
|
186
|
+
post_install_message:
|
|
187
|
+
rdoc_options: []
|
|
188
|
+
require_paths:
|
|
189
|
+
- lib
|
|
190
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
|
191
|
+
requirements:
|
|
192
|
+
- - ">="
|
|
193
|
+
- !ruby/object:Gem::Version
|
|
194
|
+
version: 2.7.5
|
|
195
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
196
|
+
requirements:
|
|
197
|
+
- - ">="
|
|
198
|
+
- !ruby/object:Gem::Version
|
|
199
|
+
version: '0'
|
|
200
|
+
requirements: []
|
|
201
|
+
rubygems_version: 3.2.32
|
|
202
|
+
signing_key:
|
|
203
|
+
specification_version: 4
|
|
204
|
+
summary: Data Update Tool
|
|
205
|
+
test_files:
|
|
206
|
+
- spec/rubocop_spec.rb
|
|
207
|
+
- spec/spec_helper.rb
|