airship-style 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 265bdb4367852cdeeb802a9ff3b2e583ac2dc9ef45f849b4a05e21eff06bfe6e
4
+ data.tar.gz: 83b699c0d4ee47106a1fa4917d778e010a782160298a2ff283a49c2ed3914487
5
+ SHA512:
6
+ metadata.gz: 978b269fa8768ddfb7faaa9f9e7b833ce91070b7bcc239c296c0db5b044926576e1534199d3efa42b9305b43574ca817946e38bc0f2f3bd4382522f18d8d4485
7
+ data.tar.gz: bb391a46f9d677adefcfa6e6bf4eb7afb80f5636d0a3dea139aa67643e6cbf84d1e52ed63be5c58048c1be222a410d20dd93b9f5e63bf01e250510e78013974f
@@ -0,0 +1,84 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6
+
7
+ We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8
+
9
+ ## Our Standards
10
+
11
+ Examples of behavior that contributes to a positive environment for our community include:
12
+
13
+ * Demonstrating empathy and kindness toward other people
14
+ * Being respectful of differing opinions, viewpoints, and experiences
15
+ * Giving and gracefully accepting constructive feedback
16
+ * Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17
+ * Focusing on what is best not just for us as individuals, but for the overall community
18
+
19
+ Examples of unacceptable behavior include:
20
+
21
+ * The use of sexualized language or imagery, and sexual attention or
22
+ advances of any kind
23
+ * Trolling, insulting or derogatory comments, and personal or political attacks
24
+ * Public or private harassment
25
+ * Publishing others' private information, such as a physical or email
26
+ address, without their explicit permission
27
+ * Other conduct which could reasonably be considered inappropriate in a
28
+ professional setting
29
+
30
+ ## Enforcement Responsibilities
31
+
32
+ Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
33
+
34
+ Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
35
+
36
+ ## Scope
37
+
38
+ This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
39
+
40
+ ## Enforcement
41
+
42
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at austin@teamairship.com. All complaints will be reviewed and investigated promptly and fairly.
43
+
44
+ All community leaders are obligated to respect the privacy and security of the reporter of any incident.
45
+
46
+ ## Enforcement Guidelines
47
+
48
+ Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
49
+
50
+ ### 1. Correction
51
+
52
+ **Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
53
+
54
+ **Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
55
+
56
+ ### 2. Warning
57
+
58
+ **Community Impact**: A violation through a single incident or series of actions.
59
+
60
+ **Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
61
+
62
+ ### 3. Temporary Ban
63
+
64
+ **Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
65
+
66
+ **Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
67
+
68
+ ### 4. Permanent Ban
69
+
70
+ **Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
71
+
72
+ **Consequence**: A permanent ban from any sort of public interaction within the community.
73
+
74
+ ## Attribution
75
+
76
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
77
+ available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
78
+
79
+ Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
80
+
81
+ [homepage]: https://www.contributor-covenant.org
82
+
83
+ For answers to common questions about this code of conduct, see the FAQ at
84
+ https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2022 Austin Aldrich
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,43 @@
1
+ # Airship::Style
2
+
3
+ Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/airship/style`. To experiment with that code, run `bin/console` for an interactive prompt.
4
+
5
+ TODO: Delete this and the text above, and describe your gem
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'airship-style'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle install
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install airship-style
22
+
23
+ ## Usage
24
+
25
+ TODO: Write usage instructions here
26
+
27
+ ## Development
28
+
29
+ After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
30
+
31
+ 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
32
+
33
+ ## Contributing
34
+
35
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/airship-style. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/airship-style/blob/master/CODE_OF_CONDUCT.md).
36
+
37
+ ## License
38
+
39
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
40
+
41
+ ## Code of Conduct
42
+
43
+ Everyone interacting in the Airship::Style project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/airship-style/blob/master/CODE_OF_CONDUCT.md).
data/airship-style.yml ADDED
@@ -0,0 +1,376 @@
1
+ # TODO: This has been inherited from Google. We should change these to be Airship styles.
2
+
3
+ # Copyright 2019 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ AllCops:
18
+ NewCops: disable
19
+ SuggestExtensions: false
20
+ TargetRubyVersion: 2.6
21
+
22
+ # Added in Rubocop 1.10
23
+ Gemspec/DateAssignment:
24
+ Enabled: true
25
+
26
+ # Added in Rubocop 1.30
27
+ Gemspec/DeprecatedAttributeAssignment:
28
+ Enabled: true
29
+
30
+ # Disabled for now.
31
+ Gemspec/RequireMFA:
32
+ Enabled: false
33
+
34
+ # Enforcing a blank line often worsens vertical layout.
35
+ Layout/EmptyLineAfterGuardClause:
36
+ Enabled: false
37
+
38
+ # For the extra line between copyright and code.
39
+ Layout/EmptyLines:
40
+ Enabled: false
41
+
42
+ # This tends to be problematic, especially for nested hashes. In many cases,
43
+ # our code adheres to the "table" style, but we do not want to enforce it.
44
+ Layout/HashAlignment:
45
+ Enabled: false
46
+
47
+ # Added in Rubocop 1.18
48
+ Layout/LineEndStringConcatenationIndentation:
49
+ Enabled: true
50
+
51
+ # Our current preferred line length.
52
+ Layout/LineLength:
53
+ Max: 120
54
+
55
+ # Added in Rubocop 1.7
56
+ Layout/SpaceBeforeBrackets:
57
+ Enabled: true
58
+
59
+ # Added in Rubocop 1.7
60
+ Lint/AmbiguousAssignment:
61
+ Enabled: true
62
+
63
+ # Added in Rubocop 1.21
64
+ Lint/AmbiguousOperatorPrecedence:
65
+ Enabled: true
66
+
67
+ # Added in Rubocop 1.19
68
+ Lint/AmbiguousRange:
69
+ Enabled: true
70
+
71
+ # Added in Rubocop 1.8
72
+ Lint/DeprecatedConstants:
73
+ Enabled: true
74
+
75
+ # Added in Rubocop 1.3
76
+ Lint/DuplicateBranch:
77
+ Enabled: true
78
+
79
+ # Added in Rubocop 1.1
80
+ Lint/DuplicateRegexpCharacterClassElement:
81
+ Enabled: true
82
+
83
+ # Added in Rubocop 1.1
84
+ Lint/EmptyBlock:
85
+ Enabled: true
86
+
87
+ # Added in Rubocop 1.3
88
+ Lint/EmptyClass:
89
+ Enabled: true
90
+
91
+ # Added in Rubocop 1.16
92
+ Lint/EmptyInPattern:
93
+ Enabled: true
94
+
95
+ # Added in Rubocop 1.21
96
+ Lint/IncompatibleIoSelectWithFiberScheduler:
97
+ Enabled: true
98
+
99
+ # Added in Rubocop 1.8
100
+ Lint/LambdaWithoutLiteralBlock:
101
+ Enabled: true
102
+
103
+ # Added in Rubocop 1.2
104
+ Lint/NoReturnInBeginEndBlocks:
105
+ Enabled: true
106
+
107
+ # Added in Rubocop 1.9
108
+ Lint/NumberedParameterAssignment:
109
+ Enabled: true
110
+
111
+ # Added in Rubocop 1.9
112
+ Lint/OrAssignmentToConstant:
113
+ Enabled: true
114
+
115
+ # Added in Rubocop 1.8
116
+ Lint/RedundantDirGlobSort:
117
+ Enabled: true
118
+
119
+ # Added in Rubocop 1.27
120
+ Lint/RefinementImportMethods:
121
+ Enabled: true
122
+
123
+ # Added in Rubocop 1.22
124
+ Lint/RequireRelativeSelfPath:
125
+ Enabled: true
126
+
127
+ # Added in Rubocop 1.9
128
+ Lint/SymbolConversion:
129
+ Enabled: true
130
+
131
+ # Added in Rubocop 1.1
132
+ Lint/ToEnumArguments:
133
+ Enabled: true
134
+
135
+ # Added in Rubocop 1.9
136
+ Lint/TripleQuotes:
137
+ Enabled: true
138
+
139
+ # Added in Rubocop 1.5
140
+ Lint/UnexpectedBlockArity:
141
+ Enabled: true
142
+
143
+ # Added in Rubocop 1.1
144
+ Lint/UnmodifiedReduceAccumulator:
145
+ Enabled: true
146
+
147
+ # Added in Rubocop 1.23
148
+ Lint/UselessRuby2Keywords:
149
+ Enabled: true
150
+
151
+ Metrics/AbcSize:
152
+ Max: 30
153
+
154
+ Metrics/CyclomaticComplexity:
155
+ Max: 10
156
+
157
+ Metrics/MethodLength:
158
+ Max: 25
159
+
160
+ # Sometimes problematic for API calls which might have a lot of parameters,
161
+ # and for generated code.
162
+ Metrics/ParameterLists:
163
+ Enabled: false
164
+
165
+ Metrics/PerceivedComplexity:
166
+ Max: 10
167
+
168
+ # Added in Rubocop 1.24
169
+ Naming/BlockForwarding:
170
+ Enabled: true
171
+
172
+ # Does not allow distinguishing verbs (e.g. is vs has). Also causes problems
173
+ # for generated code that might have generated method names.
174
+ Naming/PredicateName:
175
+ Enabled: false
176
+
177
+ # Numbers are occasionally semantically useful in names, and also occasionally
178
+ # appear in generated code.
179
+ Naming/VariableNumber:
180
+ Enabled: false
181
+
182
+ # Added in Rubocop 1.28
183
+ Security/CompoundHash:
184
+ Enabled: true
185
+
186
+ # Added in Rubocop 1.22
187
+ Security/IoMethods:
188
+ Enabled: true
189
+
190
+ # Better to separate accessors for yardoc and type declarations.
191
+ Style/AccessorGrouping:
192
+ EnforcedStyle: separated
193
+
194
+ # Added in Rubocop 1.1
195
+ Style/ArgumentsForwarding:
196
+ Enabled: true
197
+
198
+ # Problematic for generated code which might include unicode in comments.
199
+ Style/AsciiComments:
200
+ Enabled: false
201
+
202
+ # There are cases where we use the === operator as a general interface, e.g.
203
+ # when specifying type checker objects.
204
+ Style/CaseEquality:
205
+ Enabled: false
206
+
207
+ # Added in Rubocop 1.2
208
+ Style/CollectionCompact:
209
+ Enabled: true
210
+
211
+ # Added in Rubocop 1.1
212
+ Style/DocumentDynamicEvalDefinition:
213
+ Enabled: true
214
+
215
+ # We prefer consistent method indentation.
216
+ Style/EmptyMethod:
217
+ EnforcedStyle: expanded
218
+
219
+ # Added in Rubocop 1.8
220
+ Style/EndlessMethod:
221
+ Enabled: true
222
+
223
+ # Added in Rubocop 1.29
224
+ Style/EnvHome:
225
+ Enabled: true
226
+
227
+ # This check is overly paranoid.
228
+ Style/FetchEnvVar:
229
+ Enabled: false
230
+
231
+ # Added in Rubocop 1.24
232
+ Style/FileRead:
233
+ Enabled: true
234
+
235
+ # Added in Rubocop 1.24
236
+ Style/FileWrite:
237
+ Enabled: true
238
+
239
+ # Frozen string literals are no more as of Ruby 3.
240
+ Style/FrozenStringLiteralComment:
241
+ Enabled: false
242
+
243
+ # Added in Rubocop 1.10
244
+ Style/HashConversion:
245
+ Enabled: true
246
+
247
+ # Added in Rubocop 1.7
248
+ Style/HashExcept:
249
+ Enabled: true
250
+
251
+ # It is sometimes preferable to use the non-modifier form even for single-line
252
+ # expressions, for readability.
253
+ Style/IfUnlessModifier:
254
+ Enabled: false
255
+
256
+ # Added in Rubocop 1.9
257
+ Style/IfWithBooleanLiteralBranches:
258
+ Enabled: true
259
+
260
+ # Added in Rubocop 1.16
261
+ Style/InPatternThen:
262
+ Enabled: true
263
+
264
+ # Added in Rubocop 1.30
265
+ Style/MapCompactWithConditionalBlock:
266
+ Enabled: true
267
+
268
+ # Added in Rubocop 1.24
269
+ Style/MapToHash:
270
+ Enabled: true
271
+
272
+ # We adopt Seattle-style paren usage
273
+ Style/MethodCallWithArgsParentheses:
274
+ AllowParenthesesInCamelCaseMethod: true
275
+ AllowParenthesesInChaining: true
276
+ AllowParenthesesInMultilineCall: true
277
+ Enabled: true
278
+ EnforcedStyle: omit_parentheses
279
+
280
+ # We adopt Seattle-style paren usage
281
+ Style/MethodDefParentheses:
282
+ EnforcedStyle: require_no_parentheses
283
+
284
+ # Enable use of the different semantics of module_function and extend self.
285
+ Style/ModuleFunction:
286
+ Enabled: false
287
+
288
+ # Added in Rubocop 1.16
289
+ Style/MultilineInPatternThen:
290
+ Enabled: true
291
+
292
+ # Added in Rubocop 1.2
293
+ Style/NegatedIfElseCondition:
294
+ Enabled: true
295
+
296
+ # Added in Rubocop 1.26
297
+ Style/NestedFileDirname:
298
+ Enabled: true
299
+
300
+ # Added in Rubocop 1.3
301
+ Style/NilLambda:
302
+ Enabled: true
303
+
304
+ # Added in Rubocop 1.22
305
+ Style/NumberedParameters:
306
+ Enabled: true
307
+
308
+ # Added in Rubocop 1.22
309
+ Style/NumberedParametersLimit:
310
+ Enabled: true
311
+
312
+ # Added in Rubocop 1.28
313
+ Style/ObjectThen:
314
+ Enabled: true
315
+
316
+ # Disabled for tests but left enabled for production code.
317
+ # Added in Rubocop 1.23
318
+ Style/OpenStructUse:
319
+ Enabled: true
320
+ Exclude:
321
+ - "test/**/*.rb"
322
+ - "acceptance/**/*.rb"
323
+ - "samples/acceptance/**/*.rb"
324
+
325
+ # Added in Rubocop 1.16
326
+ Style/QuotedSymbols:
327
+ Enabled: true
328
+
329
+ # Added in Rubocop 1.4
330
+ Style/RedundantArgument:
331
+ Enabled: true
332
+
333
+ # Disabled because we prefer to keep begin-end blocks in memoization for
334
+ # readability (see https://github.com/rubocop/rubocop/pull/9602).
335
+ Style/RedundantBegin:
336
+ Enabled: false
337
+
338
+ # Added in Rubocop 1.27
339
+ Style/RedundantInitialize:
340
+ Enabled: true
341
+
342
+ # Added in Rubocop 1.19
343
+ Style/RedundantSelfAssignmentBranch:
344
+ Enabled: true
345
+
346
+ # The idiom is useful in a variety of cases. We prefer to allow it.
347
+ Style/RescueModifier:
348
+ Enabled: false
349
+
350
+ # We disagree with this one. Grep is more specialized than select/reject
351
+ Style/SelectByRegexp:
352
+ Enabled: false
353
+
354
+ # Added in Rubocop 1.12
355
+ Style/StringChars:
356
+ Enabled: true
357
+
358
+ # We prefer standardizing on double-quoted strings for readability.
359
+ Style/StringLiterals:
360
+ EnforcedStyle: double_quotes
361
+
362
+ # Added in Rubocop 1.1
363
+ Style/SwapValues:
364
+ Enabled: true
365
+
366
+ # We prefer traditional bracket style for all arrays.
367
+ Style/SymbolArray:
368
+ EnforcedStyle: brackets
369
+
370
+ # There are some cases where a full method shows intent better than an attr.
371
+ Style/TrivialAccessors:
372
+ Enabled: false
373
+
374
+ # We prefer traditional bracket style for all arrays.
375
+ Style/WordArray:
376
+ EnforcedStyle: brackets
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Airship
4
+ module Style
5
+ VERSION = "0.1.0"
6
+ end
7
+ end
metadata ADDED
@@ -0,0 +1,64 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: airship-style
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Austin Aldrich
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2022-06-23 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: rubocop
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.30'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.30'
27
+ description:
28
+ email:
29
+ - austin@teamairship.com
30
+ executables: []
31
+ extensions: []
32
+ extra_rdoc_files: []
33
+ files:
34
+ - CODE_OF_CONDUCT.md
35
+ - LICENSE.txt
36
+ - README.md
37
+ - airship-style.yml
38
+ - lib/airship/style/version.rb
39
+ homepage: https://teamairship.com
40
+ licenses:
41
+ - MIT
42
+ metadata:
43
+ homepage_uri: https://teamairship.com
44
+ source_code_uri: https://github.com/teamairship/packages
45
+ post_install_message:
46
+ rdoc_options: []
47
+ require_paths:
48
+ - lib
49
+ required_ruby_version: !ruby/object:Gem::Requirement
50
+ requirements:
51
+ - - ">="
52
+ - !ruby/object:Gem::Version
53
+ version: 2.4.0
54
+ required_rubygems_version: !ruby/object:Gem::Requirement
55
+ requirements:
56
+ - - ">="
57
+ - !ruby/object:Gem::Version
58
+ version: '0'
59
+ requirements: []
60
+ rubygems_version: 3.2.22
61
+ signing_key:
62
+ specification_version: 4
63
+ summary: Airship's official rubocop style guide.
64
+ test_files: []