Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
".": "0.1.0-alpha.9"
".": "0.1.0-alpha.10"
}
296 changes: 153 additions & 143 deletions .rubocop.yml
Original file line number Diff line number Diff line change
@@ -1,196 +1,206 @@
# Just to be safe, ensure nobody is mutating our internal strings.
Style/FrozenStringLiteralComment:
EnforcedStyle: always
Exclude:
- '**/*.rbi'
---

# And/or have confusing precedence, avoid them.
Style/AndOr:
EnforcedStyle: always
# Explicitly disable pending cops for now. This is the default behaviour but
# this avoids a large warning every time we run it.
# Stop RuboCop nagging about rubocop-rake.
# Ensure that RuboCop validates according to the lowest version of Ruby that we support.
AllCops:
Exclude:
- "bin/*"
NewCops: enable
SuggestExtensions: false
TargetRubyVersion: 3.0.0

# Prefer double quotes so that interpolation can be easily added.
Style/StringLiterals:
EnforcedStyle: double_quotes
# Don't require this extra line break, it can be excessive.
Layout/EmptyLineAfterGuardClause:
Enabled: false

# Most common style in Ruby.
Style/RegexpLiteral:
EnforcedStyle: slashes
# Don't leave complex assignment values hanging off to the right.
Layout/EndAlignment:
EnforcedStyleAlignWith: variable

# Prefer explicit symbols for clarity; you can search for `:the_symbol`.
Style/SymbolArray:
EnforcedStyle: brackets
Layout/FirstArrayElementLineBreak:
Enabled: true

# Prefer consistency in method calling syntax
Style/MethodCallWithArgsParentheses:
Layout/FirstHashElementLineBreak:
Enabled: true
Exclude:
- '**/*.gemspec'
AllowedMethods:
- raise

# Nothing wrong with inline private methods
Style/AccessModifierDeclarations:
Layout/FirstMethodArgumentLineBreak:
Enabled: true

Layout/FirstMethodParameterLineBreak:
Enabled: true

# Set a reasonable line length; rely on other cops to correct long lines.
Layout/LineLength:
AllowedPatterns:
- "^\\s*#.*$"
- ^require(_relative)?
- "Orb::(Models|Resources)::"
Max: 110

Layout/MultilineArrayLineBreaks:
Enabled: true

# Start the assignment on the same line variable is mentioned.
Layout/MultilineAssignmentLayout:
EnforcedStyle: same_line

Layout/MultilineHashKeyLineBreaks:
Enabled: true

Layout/MultilineMethodArgumentLineBreaks:
Enabled: true

Layout/MultilineMethodParameterLineBreaks:
Enabled: true

# Prefer compact hash literals.
Layout/SpaceInsideHashLiteralBraces:
EnforcedStyle: no_space

Lint/ConstantDefinitionInBlock:
Exclude:
- "lib/**/*"

Lint/MissingSuper:
Exclude:
- "**/*.rbi"

Metrics/AbcSize:
Enabled: false

# Nothing wrong with clear if statements.
Style/IfUnlessModifier:
Metrics/ClassLength:
Enabled: false

# Unless is not necessarily clearer.
Style/NegatedIf:
Metrics/CyclomaticComplexity:
Enabled: false

# We use these sparingly, where we anticipate future branches for the
# inner conditional.
Style/SoleNestedConditional:
Metrics/MethodLength:
Enabled: false

# Allow explicit empty elses, for clarity.
Style/EmptyElse:
Metrics/ParameterLists:
Enabled: false

# Allow explicit ifs, especially for imperative use.
Style/SafeNavigation:
Metrics/PerceivedComplexity:
Enabled: false

# We commonly use ENV['KEY'], it's OK.
Style/FetchEnvVar:
Naming/MethodParameterName:
Exclude:
- "**/*.rbi"

Naming/VariableNumber:
Enabled: false

# Nothing wrong with inline private methods.
Style/AccessModifierDeclarations:
Enabled: false

Style/AccessorGrouping:
Exclude:
- "**/*.rbi"

# Behaviour of alias_method is more predictable.
Style/Alias:
EnforcedStyle: prefer_alias_method

# And/or have confusing precedence, avoid them.
Style/AndOr:
EnforcedStyle: always

Style/BisectedAttrAccessor:
Exclude:
- "**/*.rbi"

# Fairly useful in tests for pattern matching.
Style/CaseEquality:
Exclude:
- "test/**/*"

# We prefer nested modules in lib/, but are currently using compact style for tests.
Style/ClassAndModuleChildren:
Exclude:
- test/**/*
Exclude:
- "test/**/*"

# Perfectly fine
Style/MultipleComparison:
# We should go back and add these docs, but ignore for now.
Style/Documentation:
Enabled: false

# Rubocop is pretty bad about mangling single line lambdas
Style/Lambda:
# Allow explicit empty elses, for clarity.
Style/EmptyElse:
Enabled: false

# Not all parameters should be named
Style/NumberedParameters:
Style/EmptyMethod:
Exclude:
- "**/*.rbi"

# We commonly use ENV['KEY'], it's OK.
Style/FetchEnvVar:
Enabled: false

# Fairly useful in tests for pattern matching
Style/CaseEquality:
Exclude:
- test/**/*
# Just to be safe, ensure nobody is mutating our internal strings.
Style/FrozenStringLiteralComment:
EnforcedStyle: always
Exclude:
- "**/*.rbi"

# Reasonable to use brackets for errors with long messages.
Style/RaiseArgs:
# Nothing wrong with clear if statements.
Style/IfUnlessModifier:
Enabled: false

# Reasonable for a library to define dynamic type-aliases depending on sorbet-runtime availability
Lint/ConstantDefinitionInBlock:
Exclude:
- 'lib/**/*'
# Rubocop is pretty bad about mangling single line lambdas.
Style/Lambda:
Enabled: false

# Sorbet files should be excluded from some style considerations
Style/AccessorGrouping:
Exclude:
- '**/*.rbi'
Style/EmptyMethod:
Exclude:
- '**/*.rbi'
Style/RedundantInitialize:
Exclude:
- '**/*.rbi'
Lint/MissingSuper:
Exclude:
- '**/*.rbi'
Style/BisectedAttrAccessor:
Exclude:
- '**/*.rbi'
Naming/MethodParameterName:
Exclude:
- '**/*.rbi'
Style/MutableConstant:
Exclude:
- '**/*.rbi'
# Prefer consistency in method calling syntax.
Style/MethodCallWithArgsParentheses:
AllowedMethods:
- raise
Enabled: true
Exclude:
- "**/*.gemspec"

# Literally nothing wrong with `symbol_1`
Naming/VariableNumber:
# Perfectly fine.
Style/MultipleComparison:
Enabled: false

# Set a reasonable line length; rely on other cops to correct long lines.
Layout/LineLength:
Max: 110
AllowedPatterns:
- '^(\s*#)' # Comments for YARD docs: @param and similar.
- '= Orb::Resources::\S+\.new\(client: (self|client)\)$' # Instantiating resources.
- '^\s*(-> { )?Orb::Models::[a-zA-Z0-9:]+( })?$' # Line is entirely a reference to a fully-qualified Model.
Style/MutableConstant:
Exclude:
- "**/*.rbi"

# Start the assignment on the same line variable is mentioned.
Layout/MultilineAssignmentLayout:
EnforcedStyle: same_line
# Not all parameters should be named.
Style/NumberedParameters:
Enabled: false

# Don't leave complex assignment values hanging off to the right.
Layout/EndAlignment:
EnforcedStyleAlignWith: variable
# Reasonable to use brackets for errors with long messages.
Style/RaiseArgs:
Enabled: false

# Don't require this extra line break, it can be excessive.
Layout/EmptyLineAfterGuardClause:
# Be explicit about `RuntimeError`s.
Style/RedundantException:
Enabled: false

# For arrays, hashes, method arguments, and method params, if they are broken onto multiple lines:
# * Should have one element per line.
# * Should have a line break before the first element.
Layout/MultilineArrayLineBreaks:
Enabled: true
Layout/FirstArrayElementLineBreak:
Enabled: true
Layout/MultilineHashKeyLineBreaks:
Enabled: true
Layout/FirstHashElementLineBreak:
Enabled: true
Layout/MultilineMethodArgumentLineBreaks:
Enabled: true
Layout/FirstMethodArgumentLineBreak:
Enabled: true
Layout/MultilineMethodParameterLineBreaks:
Enabled: true
Layout/FirstMethodParameterLineBreak:
Enabled: true
Style/RedundantInitialize:
Exclude:
- "**/*.rbi"

# Prefer compact hash literals.
Layout/SpaceInsideHashLiteralBraces:
EnforcedStyle: no_space
# Prefer slashes for regex literals.
Style/RegexpLiteral:
EnforcedStyle: slashes

# These cops are not as applicable to generated code.
Metrics/ParameterLists:
Enabled: false
Metrics/MethodLength:
Enabled: false
Metrics/ClassLength:
# Allow explicit ifs, especially for imperative use.
Style/SafeNavigation:
Enabled: false

# These cops are too aggressive for us or now, but we may want to address them
# later.
Metrics/CyclomaticComplexity:
Enabled: false
Metrics/PerceivedComplexity:
Enabled: false
Metrics/AbcSize:
# We use these sparingly, where we anticipate future branches for the
# inner conditional.
Style/SoleNestedConditional:
Enabled: false

# We should go back and add these docs, but ignore for now.
Style/Documentation:
Enabled: false
# Prefer double quotes so that interpolation can be easily added.
Style/StringLiterals:
EnforcedStyle: double_quotes

# Explicitly disable pending cops for now. This is the default behaviour but
# this avoids a large warning every time we run it.
# Stop RuboCop nagging about rubocop-rake.
# Ensure that RuboCop validates according to the lowest version of Ruby that we support.
AllCops:
Exclude:
- bin/*
NewCops: enable
SuggestExtensions: false
TargetRubyVersion: 3.0.0
# Prefer explicit symbols for clarity; you can search for `:the_symbol`.
Style/SymbolArray:
EnforcedStyle: brackets
2 changes: 1 addition & 1 deletion .stats.yml
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
configured_endpoints: 103
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-4dede72b827939939b5386cda07c3bc1fa2eea79901819792c1820e8531718d6.yml
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-7791652a23b1ed216bba0b8fa77798252f78b0525fbd77cc29ee92c6d5739c5a.yml
17 changes: 17 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,22 @@
# Changelog

## 0.1.0-alpha.10 (2025-02-20)

Full Changelog: [v0.1.0-alpha.9...v0.1.0-alpha.10](https://github.com/orbcorp/orb-ruby/compare/v0.1.0-alpha.9...v0.1.0-alpha.10)

### Features

* **api:** api update ([#51](https://github.com/orbcorp/orb-ruby/issues/51)) ([19b3ac2](https://github.com/orbcorp/orb-ruby/commit/19b3ac2be442d35c0ce83f284f1b8783b237eb32))


### Chores

* bump lockfile ([#49](https://github.com/orbcorp/orb-ruby/issues/49)) ([3a0849b](https://github.com/orbcorp/orb-ruby/commit/3a0849b4d7b9dfa147a020cba70d19199dcd3fab))
* clean up client tests ([#47](https://github.com/orbcorp/orb-ruby/issues/47)) ([809ff79](https://github.com/orbcorp/orb-ruby/commit/809ff79703568188c692a227f3dfff77b9529b94))
* **internal:** formatting ([#48](https://github.com/orbcorp/orb-ruby/issues/48)) ([ad2f4de](https://github.com/orbcorp/orb-ruby/commit/ad2f4de8fd380b7aa46fa9d2d516ab32b3b3b1dc))
* **internal:** version bump ([#45](https://github.com/orbcorp/orb-ruby/issues/45)) ([4206454](https://github.com/orbcorp/orb-ruby/commit/4206454c3173411199eb6167fe53fedc44e58ce5))
* rename internal type aliases ([#50](https://github.com/orbcorp/orb-ruby/issues/50)) ([ffe0640](https://github.com/orbcorp/orb-ruby/commit/ffe0640993d3b9784ec3e97250ec6c02e7899522))

## 0.1.0-alpha.9 (2025-02-18)

Full Changelog: [v0.1.0-alpha.8...v0.1.0-alpha.9](https://github.com/orbcorp/orb-ruby/compare/v0.1.0-alpha.8...v0.1.0-alpha.9)
Expand Down
Loading
Loading