Dutchie-Style 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d6b2a358d911c4029b29bca907108565f063310fdbafb8943d2e26280ae6f244
+  data.tar.gz: 4b4773a79dc3816ec0b91ea449843ac8318718e727aabcff1d6c4727e9bc40c0
+SHA512:
+  metadata.gz: 1af2412d988306af579894d663732726d86e5569702e06321266fbea13b59bf1c3970d6700e7c82c44e564f01800ac251ee18db45c4514cef6bfc1e3d4ce1194
+  data.tar.gz: da5b2893cfb5b3b555313606eedabb48f932b861435d8425f778355e121fe0540616bc57a90db7ec843a9073c07b4cafc13eb17e93e66761d30f5529afe91c9c

data/.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

data/.gitignore

@@ -0,0 +1,32 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Package Managers
+/.bundle
+node_modules/
+yarn-error.log
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+.byebug_history
+
+# Ignore master key for decrypting credentials and more.
+/config/master.key
+
+.env
+
+# Emacs droppings
+*~
+
+# Mac OS noise
+.DS_Store
+
+# SimpleCov output dir
+coverage

data/Dutchie-Style.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/Dutchie/Style/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "Dutchie-Style"
+  spec.version       = Dutchie::Style::VERSION
+  spec.authors       = ["Christopher Ostrowski"]
+  spec.email         = ["chris@dutchie.com"]
+
+  spec.summary       = %q{Rubocop Settings for all dutchie Ruby Apps}
+  spec.description   = %q{Rubocop Settings for all dutchie Ruby Apps}
+  spec.homepage      = "https://github.com/GetDutchie/Dutchie-Style"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/GetDutchie/Dutchie-Style"
+  spec.metadata["changelog_uri"] = "https://github.com/GetDutchie/Dutchie-Style/releases"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rubocop", "~> 0.80.0"
+end

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in Dutchie-Style.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 0.80"

data/README.md

@@ -0,0 +1,17 @@
+![Dutchie](https://cl.ly/360R2A3q1D31/icon.png)
+
+# Dutchie-Style
+
+## About This Repo
+
+This repo contains all shared linter configs and style guides used by dutchie engineering.
+
+It is available as a rubygem as well as an NPM package.
+
+[Join Us! We're Hiring!](https://dutchie.com/careers)
+
+Includes:
+
+* RuboCop Config
+* Eslint Config
+* Prettier Config

data/default.yml

@@ -0,0 +1,217 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  EnabledByDefault: true
+  DisplayCopNames: true
+  Exclude:
+    - 'bin/**/*'
+    - 'db/**/*'
+    - 'vendor/**/*'
+    - 'config/**/*'
+    - 'docs/**/*'
+    - 'spec/**/*'
+    - 'app/channels/**/*'
+    - 'script/**/*'
+    - 'lib/assets/**/*'
+    - 'Rakefile'
+    - 'Gemfile'
+    - 'Guardfile'
+    - '*.yml'
+    - '.pryrc'
+
+# Commonly used screens these days easily fit more than 80 characters.
+Layout/LineLength:
+  Max: 120
+
+# No space makes the method definition shorter and differentiates
+# from a regular assignment.
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+# Most readable form.
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+# Indenting the chained dots beneath each other is not supported by this cop,
+# see https://github.com/bbatsov/rubocop/issues/1633
+Layout/MultilineOperationIndentation:
+  Enabled: false
+
+# Suppressing exceptions can be perfectly fine, and be it to avoid to
+# explicitly type nil into the rescue since that's what you want to return,
+# or suppressing LoadError for optional dependencies
+Lint/SuppressedException:
+  Enabled: false
+
+Layout/SpaceInsideBlockBraces:
+  # The space here provides no real gain in readability while consuming
+  # horizontal space that could be used for a better parameter name.
+  # Also {| differentiates better from a hash than { | does.
+  SpaceBeforeBlockParameters: false
+
+# No trailing space differentiates better from the block:
+# foo} means hash, foo } means block.
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+# Too short methods lead to extraction of single-use methods, which can make
+# the code easier to read (by naming things), but can also clutter the class
+Metrics/MethodLength:
+  Max: 20
+
+# The guiding principle of classes is SRP, SRP can't be accurately measured by LoC
+Metrics/ClassLength:
+  Max: 1500
+
+# Check with yard instead.
+Style/DocumentationMethod:
+  Enabled: false
+
+Style/Copyright:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+# We are using DateTime extensively.
+Style/DateTime:
+  Enabled: false
+
+# We do not need to support Ruby 1.9, so this is good to use.
+Style/SymbolArray:
+  Enabled: true
+
+# https://www.rubydoc.info/gems/rubocop/RuboCop/Cop/Style/MissingElse
+Style/MissingElse:
+  Enabled: false
+
+# https://www.rubydoc.info/gems/rubocop/RuboCop/Cop/Style/StringHashKeys
+Style/StringHashKeys:
+  Enabled: false
+
+# Single quotes being faster is hardly measurable and only affects parse time.
+# Enforcing double quotes reduces the times where you need to change them
+# when introducing an interpolation. Use single quotes only if their semantics
+# are needed.
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+# Mixing the styles looks just silly.
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+
+Style/HashEachMethods:
+  Enabled: false
+
+Style/HashTransformKeys:
+  Enabled: false
+
+Style/HashTransformValues:
+  Enabled: false
+
+# has_key? and has_value? are far more readable than key? and value?
+Style/PreferredHashMethods:
+  Enabled: false
+
+# https://docs.rubocop.org/rubocop/cops_style.html#styledisablecopswithinsourcecodedirective
+Style/DisableCopsWithinSourceCodeDirective:
+  Enabled: false
+
+# String#% is by far the least verbose and only object oriented variant.
+Style/FormatString:
+  EnforcedStyle: percent
+
+Style/CollectionMethods:
+  Enabled: true
+  PreferredMethods:
+    # inject seems more common in the community.
+    reduce: "inject"
+
+# Either allow this style or don't. Marking it as safe with parenthesis
+# is silly. Let's try to live without them for now.
+Style/ParenthesesAroundCondition:
+  AllowSafeAssignment: false
+
+# https://github.com/rubocop-hq/rubocop/blob/master/config/default.yml#L3095
+# https://getdutchie.slack.com/archives/CJQCWSWQ4/p1592860363429600
+# Optional inline and required multi
+Style/MethodCallWithArgsParentheses:
+  Description: 'Use parentheses for method calls with arguments.'
+  StyleGuide: '#method-invocation-parens'
+  Enabled: false
+  VersionAdded: '0.47'
+  VersionChanged: '0.61'
+  IgnoreMacros: true
+  IgnoredMethods: []
+  IgnoredPatterns: []
+  IncludedMacros: []
+  AllowParenthesesInMultilineCall: false
+  AllowParenthesesInChaining: false
+  AllowParenthesesInCamelCaseMethod: false
+  EnforcedStyle: require_parentheses
+  SupportedStyles:
+    - require_parentheses
+    - omit_parentheses
+
+Style/MethodCallWithoutArgsParentheses:
+  Description: 'Do not use parentheses for method calls with no arguments.'
+  StyleGuide: '#method-invocation-parens'
+  Enabled: true
+  IgnoredMethods: []
+  VersionAdded: '0.47'
+  VersionChanged: '0.55'
+
+# A specialized exception class will take one or more arguments and construct the message from it.
+# So both variants make sense.
+Style/RaiseArgs:
+  Enabled: false
+
+  # Fail is an alias of raise. Avoid aliases, it's more cognitive load for no gain.
+# The argument that fail should be used to abort the program is wrong too,
+# there's Kernel#abort for that.
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+# { ... } for multi-line blocks is okay, follow Weirichs rule instead:
+# https://web.archive.org/web/20140221124509/http://onestepback.org/index.cgi/Tech/Ruby/BraceVsDoEnd.rdoc
+Style/BlockDelimiters:
+  Enabled: false
+
+# do / end blocks should be used for side effects,
+# methods that run a block for side effects and have
+# a useful return value are rare, assign the return
+# value to a local variable for those cases.
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+
+# Enforcing the names of variables? To single letter ones? Just no.
+Style/SingleLineBlockParams:
+  Enabled: false
+
+# Style preference
+Style/MethodDefParentheses:
+  Enabled: false
+
+# Shadowing outer local variables with block parameters is often useful
+# to not reinvent a new name for the same thing, it highlights the relation
+# between the outer variable and the parameter. The cases where it's actually
+# confusing are rare, and usually bad for other reasons already, for example
+# because the method is too long.
+Lint/ShadowingOuterLocalVariable:
+  Enabled: false
+
+# There are valid cases, for example debugging Cucumber steps,
+# also they'll fail CI anyway
+Lint/Debugger:
+  Enabled: false
+
+Lint/AssignmentInCondition:
+  AllowSafeAssignment: false
+
+# https://www.rubydoc.info/gems/rubocop/RuboCop/Cop/Lint/NumberConversion
+Lint/NumberConversion:
+  Enabled: false
+
+# This is just silly. Calling the argument `other` in all cases makes no sense.
+Naming/BinaryOperatorParameterName:
+  Enabled: false

data/lib/Dutchie/Style.rb

@@ -0,0 +1,8 @@
+require "Dutchie/Style/version"
+
+module Dutchie
+  module Style
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

data/lib/Dutchie/Style/version.rb

@@ -0,0 +1,5 @@
+module Dutchie
+  module Style
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: Dutchie-Style
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Christopher Ostrowski
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.80.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.80.0
+description: Rubocop Settings for all dutchie Ruby Apps
+email:
+- chris@dutchie.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- Dutchie-Style.gemspec
+- Gemfile
+- README.md
+- default.yml
+- lib/Dutchie/Style.rb
+- lib/Dutchie/Style/version.rb
+homepage: https://github.com/GetDutchie/Dutchie-Style
+licenses: []
+metadata:
+  homepage_uri: https://github.com/GetDutchie/Dutchie-Style
+  source_code_uri: https://github.com/GetDutchie/Dutchie-Style
+  changelog_uri: https://github.com/GetDutchie/Dutchie-Style/releases
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Rubocop Settings for all dutchie Ruby Apps
+test_files: []