inspire-ruby-style 4.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 34706559b4e82faeed6bf7e86536556eec845bb5c30d29120eede77a93da468b
+  data.tar.gz: c1fc08ee9b3abdd08bfe7bffdf4b231b21e3b651c4a2dd66adcb3f6549dd3c3e
+SHA512:
+  metadata.gz: b7e0239c972c8d9487465861bb665a290359e349f4e4f934ab524bb99dfe678dd4a4930a811cf7a574a3bb79ee403124591f88a8ad689eb5976825fd8526e949
+  data.tar.gz: 1ecc9495c5aedc513870ebe9be8c687954c6b1632a8a20a8e1cb74550d3c9ae0044b681291120fc8f03413dfdc94daa52cba75828ac8a972d20e6167231fb16a

data/.circleci/config.yml

@@ -0,0 +1,47 @@
+version: 2
+jobs:
+  build:
+    working_directory: ~/ruby-style
+    docker:
+      - image: circleci/ruby:2.5.1
+        environment:
+          BUNDLE_JOBS: 3
+          BUNDLE_RETRY: 3
+          BUNDLE_PATH: vendor/bundle
+
+    steps:
+      - checkout
+
+      # Which version of bundler?
+      - run:
+          name: Which bundler?
+          command: bundle -v
+
+      # Restore bundle cache
+      - restore_cache:
+          keys:
+            - ruby-style-bundle-v2-{{ checksum "Gemfile.lock" }}
+            - ruby-style-bundle-v2-
+
+      - run:
+          name: Bundle Install
+          command: bundle check || bundle install
+
+      # Store bundle cache
+      - save_cache:
+          key: ruby-style-bundle-v2-{{ checksum "Gemfile.lock" }}
+          paths:
+            - vendor/bundle
+
+      # Run rspec in parallel
+      - type: shell
+        command: |
+          bundle exec rspec --profile 10 \
+                            --format RspecJunitFormatter \
+                            --out test_results/rspec.xml \
+                            --format progress \
+                            $(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)
+
+      # Save test results for timing analysis
+      - store_test_results:
+          path: test_results

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+/.config
+/.yardoc/
+/_yardoc/
+/coverage/
+/doc/
+/rdoc/
+/InstalledFiles
+/pkg/
+/spec/reports
+/tmp/
+
+# RSpec failure tracking
+.rspec_status
+
+## Environment normalization:
+.ruby-gemset
+.ruby-version
+/.bundle/
+/lib/bundler/man/
+/vendor/bundle
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,6 @@
+inherit_from: default.yml
+
+# This gem does not have any classes or modules that could be tested. Instead,
+# the specs describe general concepts.
+RSpec/DescribeClass:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,56 @@
+# Changelog
+
+All notable changes to the style guide will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/),
+but please note that the style guide does **not** follow [SemVer](https://semver.org).
+
+## [Unreleased]
+
+### Added
+
+-
+
+### Changed
+
+-
+
+### Removed
+
+-
+
+### Security
+
+-
+
+## [v4]
+
+- Disable `Lint/AmbiguousBlockAssociation` for specs
+
+## [v3]
+
+### Changed
+
+- Prefix paths with a wildcard to match nested directories
+
+## [v2]
+
+### Added
+
+- Enable [rubocop-rspec](https://github.com/rubocop-hq/rubocop-rspec) by default.
+
+## [v1]
+
+### Added
+
+- Migrate style guides from developers manual to gem
+
+### Removed
+
+- `Naming/MemoizedInstanceVariableName` (project-specific)
+
+[Unreleased]: https://github.com/InspireNL/inspire-ruby-style/compare/v4...HEAD
+[v4]: https://github.com/InspireNL/inspire-ruby-style/tree/v4
+[v3]: https://github.com/InspireNL/inspire-ruby-style/tree/v3
+[v2]: https://github.com/InspireNL/inspire-ruby-style/tree/v2
+[v1]: https://github.com/InspireNL/inspire-ruby-style/tree/v1

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in inspire-ruby-style.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Inspire Innovation BV
+
+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,67 @@
+# Inspire's Ruby Style
+
+[![CircleCI branch](https://img.shields.io/circleci/project/github/InspireNL/inspire-ruby-style/master.svg)](https://circleci.com/gh/InspireNL/inspire-ruby-style)
+
+This gem packages [Inspire]'s [Rubocop] configuration so that it can easily be
+used in multiple projects. Projects can inherit the global configuration, and
+easily add or overwrite rules as necessary.
+
+The gem additionally declares Rubocop as a dependency. Since different versions
+of Rubocop have different default rules, it is important to run the same version
+in all projects to achieve the same Ruby style. Nonetheless, projects can opt-in
+to newer Rubocop versions by adding Rubocop as a dependency in their `Gemfile`
+with the newer version. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "inspire-ruby-style", github: "inspirenl/inspire-ruby-style", tag: "v4"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install inspire-ruby-style
+
+## Usage
+
+After installing the gem, create a `.rubocop.yml` file in the project root with
+the following contents:
+
+```yaml
+inherit_gem:
+  inspire-ruby-style:
+    - default.yml
+```
+
+Individual rules can be overwritten for each project as needed. For example, it
+might make sense to disable the Rails rules for gems:
+
+```yaml
+Rails:
+  Enabled: false
+```
+
+## Releases
+
+This gem does **not** follow [SemVer](https://semver.org), since any change to
+the style guide must be considered a breaking change. When making any changes to
+the style guide, increase the version number in the `gemspec`.  
+
+Document all changes in the `CHANGELOG`, so that it is easy to check if specific
+rules need to be overwritten in a projec.t When changes to the guide are merged
+into `master`, create a new release on GitHub and tag it with the new version
+number.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).
+
+[inspire]: https://inspire.nl
+[rubocop]: https://github.com/rubocop-hq/rubocop

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "inspire/ruby/style"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/default.yml

@@ -0,0 +1,146 @@
+require: rubocop-rspec
+
+AllCops:
+  Exclude:
+    - "**/bin/**/*"
+    - "**/db/**/*"
+    - "**/lib/generators/**/*"
+    - "**/node_modules/**/*"
+    - "**/vendor/ruby/**/*"
+  TargetRubyVersion: 2.5
+
+Layout/AlignHash:
+  EnforcedLastArgumentHashStyle: ignore_implicit
+
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/ClassStructure:
+  Enabled: true
+  Categories:
+    module_inclusion:
+      - include
+      - prepend
+      - extend
+    scopes:
+      - default_scope
+      - scope
+    attributes:
+      - attr_accessor
+      - attr_reader
+      - attr_writer
+      - attribute
+    associations:
+      - belongs_to
+      - has_many
+      - has_one
+    validations:
+      - validates
+      - validate
+    hooks:
+      - after_commit
+      - after_create
+      - after_destroy
+      - after_rollback
+      - after_save
+      - after_update
+      - after_validation
+      - around_create
+      - around_destroy
+      - around_save
+      - around_update
+      - before_create
+      - before_destroy
+      - before_save
+      - before_update
+      - before_validation
+  ExpectedOrder:
+    - module_inclusion
+    - scopes
+    - constants
+    - attributes
+    - associations
+    - validations
+    - hooks
+    - public_class_methods
+    - initializer
+    - public_methods
+    - protected_methods
+    - private_methods
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Layout/SpaceBeforeFirstArg:
+  Enabled: false
+
+# This cop is incompatible with RSpec's idiom to use blocks as arguments for
+# many methods. Read more: https://github.com/rubocop-hq/rubocop/issues/4222
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - "**/spec/**/*"
+
+Metrics/AbcSize:
+  Max: 25
+  Exclude:
+    - "**/spec/**/*"
+
+Metrics/BlockLength:
+  Exclude:
+    - "**/config/environments/*"
+    - "**/config/routes.rb"
+    - "**/lib/tasks/**/*"
+    - "**/spec/**/*"
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/LineLength:
+  Enabled: true
+  Exclude:
+    - "**/config/**/*"
+  Max: 125
+
+Metrics/MethodLength:
+  Max: 25
+  Exclude:
+    - "**/spec/**/*"
+
+Naming/FileName:
+  Enabled: false
+
+Rails:
+  Enabled: true
+
+Rails/Validation:
+  Include:
+    - "**/app/forms/**/*.rb"
+    - "**/app/models/**/*.rb"
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: nested
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Style/FormatString:
+  EnforcedStyle: sprintf
+
+Style/RegexpLiteral:
+  EnforcedStyle: mixed
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: single_quotes
+
+Style/TrivialAccessors:
+  AllowPredicates: true
+  AllowDSLWriters: true

data/inspire-ruby-style.gemspec

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name     = "inspire-ruby-style"
+  spec.version  = "4.0.0"
+  spec.authors  = ["Inspire Innovation BV"]
+  spec.email    = ["info@inspire.nl"]
+
+  spec.summary  = "Inspire's shared style guides for Ruby."
+  spec.homepage = "https://github.com/InspireNL/inspire-ruby-style"
+  spec.license  = "MIT"
+
+  spec.files    = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.add_dependency "rubocop", "~> 0.58"
+  spec.add_dependency "rubocop-rspec", "~> 1.29"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec_junit_formatter"
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: inspire-ruby-style
+version: !ruby/object:Gem::Version
+  version: 4.0.0
+platform: ruby
+authors:
+- Inspire Innovation BV
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-18 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.58'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.29'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.29'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  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'
+description: 
+email:
+- info@inspire.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- default.yml
+- inspire-ruby-style.gemspec
+homepage: https://github.com/InspireNL/inspire-ruby-style
+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.6
+signing_key: 
+specification_version: 4
+summary: Inspire's shared style guides for Ruby.
+test_files: []