relaxed-rubocop 2.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d82790bc19a292c1e3e1b28c9532ee04f1ef950f1640c20312cdcda73ee75348
+  data.tar.gz: 5d5313bc2629e3683e3244bab2430ab8ed983cf53594e18b76c9d19329a91778
+SHA512:
+  metadata.gz: e4e31d5ceae30ece1075706b054712c810c7d2ae32ac4edd896b80b2811aeec0bee4c02240d85e95f2592d1924dcd142ec87ba31ba8892949547bc68b1a4cbc4
+  data.tar.gz: cf22f0f795676b2c2a075fa17d3532578204f2e2e23ac8d3c1ee087b7a80a3e939d219690bf43c3ef71ee7140f43f4e1743d4117eafc1d0c91d74db4fabb3bae

data/.rubocop.yml

@@ -0,0 +1,166 @@
+# Relaxed.Ruby.Style
+## Version 2.2
+
+Style/Alias:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylealias
+
+Style/AsciiComments:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleasciicomments
+
+Style/BeginBlock:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylebeginblock
+
+Style/BlockDelimiters:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleblockdelimiters
+
+Style/CommentAnnotation:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylecommentannotation
+
+Style/Documentation:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styledocumentation
+
+Layout/DotPosition:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#layoutdotposition
+
+Style/DoubleNegation:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styledoublenegation
+
+Style/EndBlock:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleendblock
+
+Style/FormatString:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleformatstring
+
+Style/IfUnlessModifier:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleifunlessmodifier
+
+Style/Lambda:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylelambda
+
+Style/ModuleFunction:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylemodulefunction
+
+Style/MultilineBlockChain:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylemultilineblockchain
+
+Style/NegatedIf:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylenegatedif
+
+Style/NegatedWhile:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylenegatedwhile
+
+Style/ParallelAssignment:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleparallelassignment
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylepercentliteraldelimiters
+
+Style/PerlBackrefs:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleperlbackrefs
+
+Style/Semicolon:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylesemicolon
+
+Style/SignalException:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylesignalexception
+
+Style/SingleLineBlockParams:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylesinglelineblockparams
+
+Style/SingleLineMethods:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylesinglelinemethods
+
+Layout/SpaceBeforeBlockBraces:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#layoutspacebeforeblockbraces
+
+Layout/SpaceInsideParens:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#layoutspaceinsideparens
+
+Style/SpecialGlobalVars:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylespecialglobalvars
+
+Style/StringLiterals:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylestringliterals
+
+Style/TrailingCommaInArguments:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styletrailingcommainarguments
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styletrailingcommainarrayliteral
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styletrailingcommainhashliteral
+
+Style/WhileUntilModifier:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylewhileuntilmodifier
+
+Style/WordArray:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylewordarray
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#lintambiguousregexpliteral
+
+Lint/AssignmentInCondition:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#lintassignmentincondition
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+

data/CHANGELOG.md

@@ -0,0 +1,33 @@
+# Change Log
+
+## Version 2.3
+
+- Use HTTPS links everywhere
+- First gem release
+
+## Version 2.2
+
+- Style/TrailingCommaInLiteral split into:
+  - Style/TrailingCommaInArrayLiteral
+  - Style/TrailingCommaInHashLiteral:
+
+## Version 2.1
+
+- Style/DotPosition             -> Layout/DotPosition
+- Style/SpaceBeforeBlockBraces  -> Layout/SpaceBeforeBlockBraces
+- Style/SpaceInsideParens       -> Layout/SpaceInsideParens
+
+## Version 2.0
+
+- Disable Style/AsciiComments
+- Disable Style/CommentAnnotation
+- Disable Style/TrailingCommaInArguments
+- Disable Style/WordArray
+
+## Version 1.1
+
+- TrailingComma -> TrailingCommaInLiteral
+
+## Version 1.0
+
+- Initial Release

data/README.md

@@ -0,0 +1,239 @@
+# [Relaxed Ruby Style](https://relaxed.ruby.style)
+
+## Version 2.3
+
+A more liberal style guide for [RuboCop](https://github.com/bbatsov/rubocop). It comes
+with a [config file](https://relaxed.ruby.style/rubocop.yml) that deactivates some of
+RuboCop's features. It is meant as a less restrictive foundation that you can use
+directly or base your style discussions on.
+
+### Motivation
+
+RuboCop is an amazing tool, still some of its default rules feel overly strict. This
+might distract you from the helpful messages.
+
+**Warning:** Does include opinionated style advice.
+
+### How to Read this Style Guide
+
+This is not a stand-alone style guide, but a patch applied to
+[bbatsov/ruby-style-guide](https://github.com/bbatsov/ruby-style-guide)
+(the style guide RuboCop is based on).
+
+### Usage
+
+Use, copy or inherit from [rubocop.yml](https://relaxed.ruby.style/rubocop.yml).
+One way is to add the following lines to your `.rubocop.yml`:
+
+    inherit_from:
+    - https://relaxed.ruby.style/rubocop.yml
+
+You could also get the styleguide via rubygems. Add to your `Gemfile`:
+
+    gem "relaxed-rubocop"
+
+And in your `.rubocop.yml`:
+
+    inherit_gem:
+      relaxed-rubocop: .rubocop.yml
+
+## Disabled Cops & Relaxed Style Recommendations
+
+### Style/Alias
+
+[Disabled rule](https://github.com/bbatsov/ruby-style-guide#alias-method). Feel free to
+use the `alias` keyword when appropriate.
+
+### Style/AsciiComments
+
+You are free to use your source encoding in code comments. For example, if your source
+encoding is UTF-8, you can use UTF-8 characters in comments.
+
+### Style/BeginBlock
+
+[Disabled rule](https://github.com/bbatsov/ruby-style-guide#no-BEGIN-blocks). Use `BEGIN`
+blocks when you need its functionality.
+
+### Style/BlockDelimiters
+
+[Disabled rule](https://github.com/bbatsov/ruby-style-guide#single-line-blocks).
+Consider [using `{}` for multi-line blocks](https://github.com/chneukirchen/styleguide/blob/e60de37b478d3f892f6985a58d573016f33f0269/RUBY-STYLE#L63-L67).
+
+### Style/CommentAnnotation
+
+[Disabled rule](https://github.com/bbatsov/ruby-style-guide#annotate-keywords). It is
+totally optional to put a colon and a space behind **TODO**s and **FIXME**s
+
+### Style/Documentation
+
+Document your code and/or write a good ReadMe. And good specs. Choose descriptive
+method and variable names!
+
+### Layout/DotPosition
+
+[Disabled rule](https://github.com/bbatsov/ruby-style-guide#consistent-multi-line-chains).
+When chaining methods on multiple lines, it is a good idea to put the dots at the end of
+the lines to indicate that the expression continues on the next line.
+
+### Style/DoubleNegation
+
+[Disabled rule](https://github.com/bbatsov/ruby-style-guide#no-bang-bang). Use `!!variable`
+to get the boolean value of a variable.
+
+### Style/EndBlock
+
+[Disabled rule](https://github.com/bbatsov/ruby-style-guide#no-END-blocks). Use `END`
+blocks or `Kernel#at_exit` for code that should be executed when the program quits.
+
+### Style/FormatString
+
+[Disabled rule](https://github.com/bbatsov/ruby-style-guide#sprintf). Creating format
+string should be done using the [`String#%` method](https://idiosyncratic-ruby.com/49-what-the-format.html).
+
+### Style/IfUnlessModifier
+
+[Disabled rule](https://github.com/bbatsov/ruby-style-guide#if-as-a-modifier). Use or
+don't use `if`/`unless` in modifier style whenever you think it improves code readability.
+
+### Style/Lambda
+
+[Disabled rule](https://github.com/bbatsov/ruby-style-guide#lambda-multi-line). It does
+not matter if you use `->(){}` or `lambda{}` to create lambdas.
+
+### Style/ModuleFunction
+
+[Disabled rule](https://github.com/bbatsov/ruby-style-guide#module-function). Prefer
+`extend self` over `module_function`. It uses Ruby's inheritance chain, instead of
+copying all methods. Less magic!
+[More info](https://idiosyncratic-ruby.com/8-self-improvement.html).
+
+### Style/MultilineBlockChain
+
+[Disabled rule](https://github.com/bbatsov/ruby-style-guide#single-line-blocks). Chain
+multiple blocks when it makes sense, this promotes a functional programming mindset.
+
+### Style/NegatedIf
+
+[Disabled rule](https://github.com/bbatsov/ruby-style-guide#unless-for-negatives). Always
+use `if !condition` for complex conditions with negations. For simple conditions, for
+which it also unlikely that an else clause will be added at some later point, it is also
+OK to use `unless condition`.
+
+### Style/NegatedWhile
+
+[Disabled rule](https://github.com/bbatsov/ruby-style-guide#until-for-negatives). Always
+use `while !condition` for complex conditions with negations. For simple conditions,
+it is also OK to use `until condition`.
+
+### Style/ParallelAssignment
+
+[Disabled rule](https://github.com/bbatsov/ruby-style-guide#parallel-assignment).
+Parallel assignment can sometimes express the intented logic better than sequential
+assignment. It is also [faster](https://github.com/JuanitoFatas/fast-ruby#parallel-assignment-vs-sequential-assignment-code).
+
+### Style/PercentLiteralDelimiters
+
+[Disabled rule](https://github.com/bbatsov/ruby-style-guide#percent-literal-braces). When
+creating literals with the `%` syntax, choose any delimiters that don't interfere with
+the literal's content.
+
+### Style/PerlBackrefs
+
+[Disabled rule](https://github.com/bbatsov/ruby-style-guide#no-perl-regexp-last-matchers).
+It is fine to use the special **local** variables `$1` - `$9` to access the contents of
+your last matched regex groups.
+
+### Style/Semicolon
+
+[Disabled rule](https://github.com/bbatsov/ruby-style-guide#no-semicolon). Usage of
+semicolons to separate multiple statements is OK.
+
+### Style/SignalException
+
+*(Dropped from RuboCop style guide)*. You are free to choose if you want to raise
+exceptions with `raise` or `fail`.
+
+### Style/SingleLineBlockParams
+
+*(Dropped from RuboCop style guide)*. Don't give your block parameters bad names.
+
+### Style/SingleLineMethods
+
+[Disabled rule](https://github.com/bbatsov/ruby-style-guide#no-single-line-methods).
+Single-line methods can be useful for short getter- or setter-like methods, when
+`attr_reader` / `attr_accessor` / `attr_writer` are not enough anymore.
+
+### Layout/SpaceBeforeBlockBraces
+
+It is not important if there is a space between a method call and a passed block.
+
+### Layout/SpaceInsideParens
+
+[Disabled rule](https://github.com/bbatsov/ruby-style-guide#no-spaces-braces). Avoid
+putting spaces inside parentheses, but do it when it improves readability.
+For example, when using RSpec's `expect` method.
+
+### Style/SpecialGlobalVars
+
+[Disabled rule](https://github.com/bbatsov/ruby-style-guide#no-cryptic-perlisms).
+Refering to [two-letter version of special global variables](https://idiosyncratic-ruby.com/9-globalization.html#list-of-all-special-global-variables) is OK, although not very polite.
+
+### Style/StringLiterals
+
+[Disabled rule](https://github.com/bbatsov/ruby-style-guide#consistent-string-literals).
+Deliberately use single or double quoted strings!
+
+### Style/TrailingCommaInArguments
+
+[Disabled rule](https://github.com/bbatsov/ruby-style-guide#no-trailing-params-comma).
+Use trailing commas in multi-line argument lists. It makes manipulating the params easier
+(reordering, appending, removing) and leads to smaller git diffs. Consider using RuboCop's
+`EnforcedStyleForMultiline: consistent_comma` option.
+
+### Style/TrailingCommaInLiteral
+
+[Disabled rule](https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas).
+Use trailing commas in multi-line literals. It makes manipulating the literal easier
+(reordering, appending, removing) and leads to smaller git diffs. Consider using RuboCop's
+`EnforcedStyleForMultiline: consistent_comma` option.
+
+### Style/WordArray
+
+[Word arrays using the percent syntax](https://en.wikibooks.org/wiki/Ruby_Programming/Syntax/Literals#The_.25_Notation)
+make for a good and concise way to create an array of strings, especially if creating lots
+of strings. However, it it should be considered a good option, instead of being mandatory
+to use.
+
+### Style/WhileUntilModifier
+
+[Disabled rule](https://github.com/bbatsov/ruby-style-guide#while-as-a-modifier). Use or
+don't use `while`/`until` in modifier style whenever you think it improves code
+readability.
+
+### Lint/AmbiguousRegexpLiteral
+
+Use regex normally.
+
+### Lint/AssignmentInCondition
+
+[Disabled rule](https://github.com/bbatsov/ruby-style-guide#safe-assignment-in-condition).
+Use `=` for assignments in conditions. Use `==` for comparisons in conditions.
+
+### Metrics
+
+RuboCop's code complexity metrics can be very useful indications, however, they should
+be discussed, tweaked and activated individually.
+
+## Other Ruby Style Guides
+
+* [Leah Neukirchen](https://github.com/chneukirchen/styleguide/blob/master/RUBY-STYLE)
+* [Fast Ruby](https://github.com/JuanitoFatas/fast-ruby)
+* [Ruby Style Guide (Rubocop)](https://github.com/bbatsov/ruby-style-guide/)
+  * [GitHub](https://github.com/styleguide/ruby)
+  * [Airbnb](https://github.com/airbnb/ruby)
+  * [Shopify](https://shopify.github.io/ruby-style-guide/)
+
+## Also See
+
+* [Idiosyncratic Ruby](https://idiosyncratic-ruby.com)
+* [Standard Gems](https://stdgems.org)

data/Rakefile

@@ -0,0 +1,21 @@
+# # #
+# Get gemspec info
+
+gemspec_file = Dir["*.gemspec"].first
+gemspec = eval File.read(gemspec_file), binding, gemspec_file
+info = "#{gemspec.name} | #{gemspec.version} | " \
+       "#{gemspec.runtime_dependencies.size} dependencies | " \
+       "#{gemspec.files.size} files"
+
+# # #
+# Gem build and install task
+
+desc info
+task :gem do
+  puts info + "\n\n"
+  print "  "; sh "gem build #{gemspec_file}"
+  FileUtils.mkdir_p "pkg"
+  FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", "pkg"
+  puts; sh %{gem install --no-document pkg/#{gemspec.name}-#{gemspec.version}.gem}
+end
+

data/relaxed-rubocop.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.name          = "relaxed-rubocop"
+  gem.version       = "2.3"
+  gem.summary       = "A relaxed style guide for RuboCop"
+  gem.description   = "A relaxed style guide for RuboCop. Although RuboCop is an amazing tool, some of its default rules feel overly strict. This might distract you from the helpful messages."
+  gem.authors       = ["Jan Lelis"]
+  gem.email         = ["mail@janlelis.de"]
+  gem.homepage      = "https://github.com/janlelis/relaxed-rubocop"
+  gem.license       = "MIT"
+
+  gem.files         = Dir["{**/}{.*,*}"].select{ |path| File.file?(path) && path !~ /^(?:pkg|build)/ }
+  gem.require_paths = ["lib"]
+
+  gem.required_ruby_version = "~> 2.0"
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: relaxed-rubocop
+version: !ruby/object:Gem::Version
+  version: '2.3'
+platform: ruby
+authors:
+- Jan Lelis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-11 00:00:00.000000000 Z
+dependencies: []
+description: A relaxed style guide for RuboCop. Although RuboCop is an amazing tool,
+  some of its default rules feel overly strict. This might distract you from the helpful
+  messages.
+email:
+- mail@janlelis.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- README.md
+- Rakefile
+- relaxed-rubocop.gemspec
+homepage: https://github.com/janlelis/relaxed-rubocop
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A relaxed style guide for RuboCop
+test_files: []