rubocop-dmp_roadmap 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6e46dd11c9e29a4d65ef6d4cee89566d7a470611a8170a226eaaa9ac275fe69d
+  data.tar.gz: f905a7362e092f04a0046e8c2a022907b5229e077d3a196d5565bc1c1f6286e4
+SHA512:
+  metadata.gz: af5c9a007d7c1b629ba87a54ea74fde12c079b59a30096ca5810687bbbc9daa5be3ae3ac6ccacb9eaac71ec543bfd07c03ac5ceca86e8307dbaa3eb6865becb0
+  data.tar.gz: 8d757c185fb7b1ec342efd6280859456e0d0fd5376049c1cd61a0e86344615e354b9fecae677ceeef1dfedd7b7b30123da7617c2fc8124addc560fe1022879fa

data/README.md

@@ -0,0 +1,56 @@
+# DMP Roadmap Rubocop Style guide
+
+Install this gem in your Ruby project to check your code against DMP Roadmap's style guide using Rubocop.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :development, :test do
+
+  gem 'rubocop-dmp_roadmap', require: false
+
+end
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rubocop-dmp_roadmap
+
+## Usage
+
+If you don't already have a `.rubocop.yml` file, create one in your repo's root directory now:
+
+``` yml
+# .rubocop.yml
+
+require: rubocop/dmp_roadmap
+
+inherit_gem:
+  rubocop-dmp_roadmap:
+    - config/default.yml
+```
+
+## Rationales
+
+This file over-writes some of the default assertions in the `rubocop` gem, and the `rubocop-rails` gem. Over-written cops are defined in the [config directory](https://github.com/DMPRoadmap/rubocop-dmp_roadmap/tree/master/config/).
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/DMPRoadmap/rubocop-dmp_roadmap
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/config/allcops.yml

@@ -0,0 +1,20 @@
+# Global configuration for Rubocop
+#
+AllCops:
+  # Cache the results for faster processing
+  UseCache: true
+  # Show the name of the cops being voilated in the feedback
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  # We're using Ruby 2.4 right now. So force that version or higher.
+  TargetRubyVersion: 2.4
+  # Don't check these files. So many of them are boilerplate code with violations.
+  Exclude:
+    - 'bin/*'
+    - 'lib/tasks/**/*'
+    - 'Gemfile'
+    - 'db/**/*'
+    - 'config/**/*'
+    - 'script/**/*'
+    - '**/Rakefile'
+    - '**/config.ru'

data/config/default.yml

@@ -0,0 +1,13 @@
+inherit_gem:
+  rubocop-rails:
+    - config/rails.yml
+
+inherit_from:
+  - ./allcops.yml
+  - ./lint.yml
+  - ./style.yml
+  - ./metrics.yml
+  - ./layout.yml
+
+Rails:
+  Enabled: true

data/config/layout.yml

@@ -0,0 +1,27 @@
+# Ignore this cop. The Rubocop default is sensible, but the rubocop-rails gem modifies
+# this to position else keywords awkwardly.
+Layout/ElseAlignment:
+  Enabled: false
+
+# Ignore this cop. The Rubocop default is sensible, but the rubocop-rails gem modifies
+# this to position end keywords awkwardly.
+Layout/EndAlignment:
+  Enabled: false
+
+# Force no empty lines at the start or end of a block's body. Ignore specs, since this
+# improves readability within the RSpec blocks.
+Layout/EmptyLinesAroundBlockBody:
+  Exclude:
+    - 'spec/**/*'
+
+# Force a single blank line around a class's body. Adding this whitespace makes code
+# a bit easier to read.
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+  EnforcedStyle: empty_lines
+
+# Force a single blank line around a module's body. Adding this whitespace makes code
+# a bit easier to read.
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: true
+  EnforcedStyle: empty_lines

data/config/lint.yml

@@ -0,0 +1,5 @@
+# Enforce this in the main code but ignore it in specs since the Rspec core methods
+# are defined as potentially ambiguous blocks
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'spec/**/*'

data/config/metrics.yml

@@ -0,0 +1,18 @@
+# Restrict the length of each line of code to 90 characters. Enforcing this is important
+# as many developers are working on smaller screens, or split screens. Having to scroll
+# to read a full line of code makes code harder to read and more frustrating to work with.
+Metrics/LineLength:
+  # I've found that 90 is a suitable limit. Many developers balk at the 80 character
+  # default.
+  Max: 90
+  Exclude:
+    # Excludes the spec helper, since this boilerplate file has comments that are much
+    # longer.
+    - 'spec/spec_helper.rb'
+
+# Restrict the number of lines of code that may be within a block of code. This should
+# force developers to break their code into smaller discrete methods or objects.
+Metrics/BlockLength:
+  # Exclude specs, since those are defined as large blocks of code
+  Exclude:
+    - 'spec/**/*'

data/config/style.yml

@@ -0,0 +1,33 @@
+# This cop enforces the use of boolean and/or "&&" and "||" over "and" "or".
+# Sometimes using "and"/"or" is preferrable, when these are used as control flow.
+#
+# For example:
+#
+#   render text: "Hello world" and return
+#
+Style/AndOr:
+  Enabled: false
+
+# This cop enforces how modules and classes are nested within another module or class.
+# In Rails code (e.g. models and controllers) nesting with a colon is preferrable (e.g.
+# User::Session).
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'app/**/*'
+
+# This cop enforces each class to have documentation at the top. That's not always
+# practical or necessary in Rails apps (e.g. the purpose of helpers is self evident).
+Style/Documentation:
+  Enabled: false
+
+# Enforce double quotes. Don't allow single quotes. This is preferred since double
+# quotes are more useful (they support escaping characters, and interpolation).
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+# Enforce empty methods to be written across two lines, like any normal method would be.
+# This allows for easy modification of the method in future.
+Style/EmptyMethod:
+  Enabled: true
+  EnforcedStyle: expanded

data/lib/rubocop/dmp_roadmap.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "rubocop/dmp_roadmap/version"
+
+module Rubocop
+  module DmpRoadmap
+    # Your code goes here...
+  end
+end

data/lib/rubocop/dmp_roadmap/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Rubocop
+  module DmpRoadmap
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-dmp_roadmap
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Bodacious
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.58.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.58.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.27.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.27.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.16.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 12.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 12.3.1
+description: DMP Roadmap Rubocop style guide checks
+email:
+- bodacious@katanacode.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- config/allcops.yml
+- config/default.yml
+- config/layout.yml
+- config/lint.yml
+- config/metrics.yml
+- config/style.yml
+- lib/rubocop/dmp_roadmap.rb
+- lib/rubocop/dmp_roadmap/version.rb
+homepage: https://github.com/DMPRoadmap/rubocop-DMP_Roadmap
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- config
+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.6
+signing_key: 
+specification_version: 4
+summary: Rubocop style checks for DMP Roadmap projects.
+test_files: []