optimum-energy-rubocop 0.0.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5a6143df05ddd076de8a6ec13b0ae679209f7c054ff77b229b7d5eed04379e92
+  data.tar.gz: c2ef3d5e0fdb194b67e50183b375bda39bb2f9c814a75642ad718607b140ee17
+SHA512:
+  metadata.gz: 6df9b4334fc2945b8c61ccba374795095b2b70db478eea690f12bf90cc6f648425b3109181939ead58fb4080e38438e9665788c498def0d85e0eeb2c52f64406
+  data.tar.gz: e35acc739d6e271adaf3bdc52bce35307a86c0c3ef84c103283a4c838f0c104bfce864606c233a63187892e69a31bf585711f97f7765317d75e6bd34cca47c3a

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: optimum_energy_rubocop.yml

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    optimum-energy-rubocop (0.0.8)
+      rubocop (~> 0.50)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    jaro_winkler (1.5.2)
+    parallel (1.12.1)
+    parser (2.5.3.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rainbow (3.0.0)
+    rubocop (0.62.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
+    unicode-display_width (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  optimum-energy-rubocop!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Landon Schropp
+
+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,28 @@
+# Optimum Energy Rubocop
+
+This is the [shared](https://rubocop.readthedocs.io/en/latest/configuration/) team Rubocop
+configuration for [Optimum Energy](http://optimumenergyco.com/).
+
+
+## Usage
+
+First, add the gem to your Gemfile. We recommend not locking in the version of the gem because we
+regularly update this repo as we come across new rules.
+
+```
+gem 'optimum-energy-rubocop'
+```
+
+Create a `.rubocop.yml` file and add this configuration.
+
+```
+require:
+  - optimum-energy-rubocop
+
+inherit_from:
+  - optimum_energy_rubocop.yml
+```
+
+## Running Rubocop
+
+To run the cops, run `rubocop` from the command line.

data/optimum-energy-rubocop.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |spec|
+  spec.name = 'optimum-energy-rubocop'
+  spec.version = File.read('VERSION.txt')
+  spec.authors = [ 'Optimum Energy' ]
+
+  spec.summary = 'The shared Rubocop configuration for Optimum Energy'
+  spec.homepage = 'https://github.com/optimiumenergyco/optimum-energy-rubocop'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0")
+
+  spec.add_dependency 'rubocop', '~> 0.50'
+end

data/optimum_energy_rubocop.yml

@@ -0,0 +1,161 @@
+# This styleguide is built on top of the default Rubocop styleguide, located here:
+# https://github.com/bbatsov/rubocop/blob/master/config/default.yml.
+
+AllCops:
+  Exclude:
+    - 'db/schema.rb'
+
+Rails:
+  Enabled: true
+
+Metrics/AbcSize:
+  Enabled: false
+
+Layout/AlignHash:
+  Enabled: false
+
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/CaseIndentation:
+  EnforcedStyle: end
+
+# Ideally, I would like to insert empty lines at the beginning on a class definition, but not at the
+# end. https://github.com/bbatsov/rubocop/issues/4812
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Layout/EmptyLineBetweenDefs:
+  AllowAdjacentOneLineDefs: true
+  NumberOfEmptyLines: 1
+
+Layout/EndOfLine:
+  EnforcedStyle: lf
+
+Layout/ExtraSpacing:
+  AllowForAlignment: false
+
+Layout/FirstParameterIndentation:
+  EnforcedStyle: consistent
+
+Layout/IndentArray:
+  EnforcedStyle: consistent
+
+Layout/IndentHash:
+  EnforcedStyle: consistent
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Layout/SpaceInsideArrayLiteralBrackets:
+  EnforcedStyle: space
+
+Layout/SpaceAroundOperators:
+  AllowForAlignment: false
+
+Layout/SpaceBeforeFirstArg:
+  AllowForAlignment: false
+
+Layout/SpaceInsideStringInterpolation:
+  EnforcedStyle: space
+
+Naming/FileName:
+  ExpectMatchingDefinition: true
+  Exclude:
+    - 'config/**/*'
+    - 'bin/**/*'
+    - 'db/**/*'
+    - 'spec/**/*'
+
+Style/ConditionalAssignment:
+  EnforcedStyle: assign_to_condition
+
+Style/Copyright:
+  Enabled: false
+
+# TODO: Consider turning this on for controller methods in the future if we extract Swagger
+# documentation from them.
+Style/Documentation:
+  Enabled: false
+
+Style/FormatString:
+  EnforcedStyle: percent
+
+# This won't be necessary when we upgrade to Ruby 3.0. Until then, rather than adding a comment to
+# every file, we should simply not mutate strings.
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: never
+
+Style/StringLiterals:
+  Exclude:
+    - 'spec/**/*'
+
+Style/ReturnNil:
+  Enabled: true
+
+Style/SymbolArray:
+  MinSize: 3
+
+Style/WordArray:
+  MinSize: 3
+
+Metrics/BlockLength:
+  Enabled: true
+  Max: 100
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/ClassLength:
+  Enabled: true
+  Max: 300
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 50
+
+Metrics/LineLength:
+  Max: 100
+  AllowHeredoc: false
+  AllowURI: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Layout/BlockAlignment:
+  EnforcedStyleAlignWith: start_of_block
+
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: start_of_line
+
+Rails/RequestReferer:
+  EnforcedStyle: referrer
+
+Rails/Date:
+  EnforcedStyle: strict
+
+Rails/TimeZone:
+  EnforcedStyle: flexible
+
+Rails/FilePath:
+  Enabled: false
+
+# TODO: Enable once this is fixed: https://github.com/bbatsov/rubocop/issues/5236
+Rails/InverseOf:
+  Enabled: false
+
+Style/MultilineTernaryOperator:
+  Enabled: false
+
+Rails/NotNullColumn:
+  Enabled: false

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: optimum-energy-rubocop
+version: !ruby/object:Gem::Version
+  version: 0.0.8
+platform: ruby
+authors:
+- Optimum Energy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.50'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.50'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- optimum-energy-rubocop.gemspec
+- optimum_energy_rubocop.yml
+homepage: https://github.com/optimiumenergyco/optimum-energy-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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: The shared Rubocop configuration for Optimum Energy
+test_files: []