hubbado-style 1.5.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7fce73af7b3fefe07c51128ac107739cd3f0aa238efd8546fee05c470ef0bddb
+  data.tar.gz: 6fcf8ba3195d54cdcab133a02a768bcf55e55fdf23dd67e6f292cdd54644d1e0
+SHA512:
+  metadata.gz: 68362a17deb80c7cf67deb787f45b1fc6f57071a7280b9a5fc4bf0b8ce74e4271b82b902f5469ef8b0b1924cbeb21daacfb90810e267a104215bf0544619bc04
+  data.tar.gz: 5acd8173c2c8dc5be7ab7c0d9cea015f2860bc4d973872041355ef5fbd76dab6563e888720f0ffa186ae21a08f3c6d86ea14373e9bc7f8181ff270ee9f1851c3

data/CHANGELOG.md

@@ -0,0 +1,36 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+# [1.5.0 - 2025-04-11]
+## Changed
+- Style/IfUnlessModifier disabled
+- Target ruby version 3.4
+
+# [1.4.0 - 2023-04-17]
+## Added
+- Disable Metrics/ParameterLists
+
+# [1.3.0 - 2023-04-05]
+## Changed
+- Added EnforcedShorthandSyntax: never to Style/HashSyntax
+- Target ruby version 3.2
+
+# [1.2.0 - 2023-01-24]
+## Changed
+- Target ruby version 3.1
+
+# [1.1.0 - 2020-03-16]
+## Changed
+- Do not report on Metrics/AbcSize, Metrics/BlockLength,
+  Metrics/CyclomaticComplexity or Metrics/PerceivedComplexity
+
+# [1.0.1 - 2021-04-10]
+## Fixed
+- Don't scan the gems directory
+
+# [1.0.0 - 2021-04-10]
+## Added
+- Fix version of this gem, using our Rails monolith Rubocop configuration as a base

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Hubbado
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,114 @@
+# hubbado-style
+
+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/hubbado/style`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+
+group :test, :development do
+  gem 'hubbado-style'
+end
+```
+
+Or, for a Ruby library, add this to your gemspec:
+
+```ruby
+spec.add_development_dependency 'hubbado-style'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hubbado-style
+
+## Usage
+
+Create a `.rubocop.yml` with the following directives:
+
+```yaml
+inherit_gem:
+  hubbado-style:
+    - default.yml
+```
+
+The inherited rubocop canfiguration can be overridden in the `.rubocop.yml` but this is discouraged.
+
+Now, run:
+
+```bash
+$ bundle exec rubocop
+```
+
+You do not need to include rubocop directly in your application's dependencies. Hubbado-style will include a specific version of `rubocop` and `rubocop-rspec` that is shared across all projects.
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hubbado/hubbado-style.
+
+## Styleguide
+
+The Rubocop configuration should guide you most of the way, but there are somethings that we haven't been able to configure in Rubocop, which are detailed below.
+
+### Long lists of arguments
+
+If a  list of related arguments cannot fit on a single line, then each argument should be placed on it's own line.
+
+Rationale: A mixture of related horizontal and vertical information is harder to scan.
+
+```ruby
+# bad
+some_method(
+  long_argument1: value1, long_argument2: value2, long_argument3: value3, long_argument4: value4,
+  long_argument5: value5
+)
+
+# good
+some_method(
+  long_argument1: value1,
+  long_argument2: value2,
+  long_argument3: value3,
+  long_argument4: value4,
+  long_argument5: value5
+)
+```
+
+### Multiline bracketed method calls 
+
+Do not place method arguments next to the opening bracket if all the arguments do not fit on one line.
+
+Rationale: A mixture of related horizontal and vertical information is harder to scan.
+
+
+```ruby
+# bad
+some_method(arg1,
+  arg2, arg3, arg4)
+
+#good
+some_method(
+  arg1, arg2, arg3, arg4
+)
+```
+
+### Methods calls without brackets
+
+If the method call does not use brackets, different types of arguments can be placed one different lines. If the full set of related arguments does not fit on one line they should be placed one per line.
+
+For example, in the following method calls the first method argument is the principle, and most important argument.
+
+```ruby
+cell Somecell, model,
+  option_one: value_one, option_two: value_two, ...
+```
+
+```ruby
+instance_double SomeObject,
+  property_one: some_value,
+  property_two: some_other_value
+```

data/default.yml

@@ -0,0 +1,129 @@
+AllCops:
+  Include:
+    - '**/*.rb'
+    - Rakefile
+    - config.ru
+  Exclude:
+    - gems/**/*
+    - db/**
+    - config/**
+    - script/**
+  TargetRubyVersion: 3.4
+  NewCops: enable
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Naming/PredicateName:
+  ForbiddenPrefixes:
+    - is_
+
+Style/AccessorGrouping:
+  Enabled: false
+
+Style/BlockDelimiters:
+  EnforcedStyle: line_count_based
+  Exclude:
+    - 'spec/**/*'
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/HashSyntax:
+  EnforcedShorthandSyntax: never
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+Style/LambdaCall:
+  Enabled: false
+
+Style/NestedParenthesizedCalls:
+  Enabled: false
+
+# We don't consider .positive? etc to be that readable
+Style/NumericPredicate:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/BlockEndNewline:
+  Enabled: false
+
+Layout/CaseIndentation:
+  IndentOneStep: true
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+Layout/MultilineBlockLayout:
+  Exclude:
+    - 'spec/**/*'
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+  IndentationWidth: 2
+
+Layout/LineLength:
+  Max: 100
+
+# Disabled so that we can write .to_not change { } in Rspec
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'spec/**/*'
+
+Lint/UselessAccessModifier:
+  MethodCreatingMethods:
+    - delegate
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/AndOr:
+  EnforcedStyle: conditionals
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/CollectionMethods:
+  Enabled: true
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/FormatString:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/StringConcatenation:
+  Enabled: false

data/hubbado-style.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.name = "hubbado-style"
+  s.version = "1.5.1"
+  s.summary = "Hubbado style guides and shared style configs."
+
+  s.authors = ["Hubbado Devs"]
+  s.email = ["devs@hubbado.com"]
+  s.homepage = "https://github.com/hubbado/hubbado-style"
+  s.license  = "MIT"
+
+  s.require_paths = ["lib"]
+
+  s.files = Dir.glob(%w[
+    default.yml
+    *.gemspec
+    LICENSE*
+    README*
+    CHANGELOG*
+  ])
+
+  s.add_dependency "rubocop"
+
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: hubbado-style
+version: !ruby/object:Gem::Version
+  version: 1.5.1
+platform: ruby
+authors:
+- Hubbado Devs
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+email:
+- devs@hubbado.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- default.yml
+- hubbado-style.gemspec
+homepage: https://github.com/hubbado/hubbado-style
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Hubbado style guides and shared style configs.
+test_files: []